Skip to content

Commit cb7449e

Browse files
sofakingforeversofakingforever
committed
Some class names refactoring
1 parent 46035fe commit cb7449e

File tree

16 files changed

+63
-65
lines changed

16 files changed

+63
-65
lines changed

‎analytics/src/main/java/com/sofakingforever/analytics/Analytics.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ package com.sofakingforever.analytics
22

33
import android.content.Context
44
import android.util.Log
5-
import com.sofakingforever.analytics.events.Event
5+
import com.sofakingforever.analytics.events.base.Event
66

77
/**
88
* The *Analytics* class is in charge of tracking any *Event* implementation.

‎analytics/src/main/java/com/sofakingforever/analytics/AnalyticsDispatcher.kt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
package com.sofakingforever.analytics
22

33
import android.content.Context
4-
import com.sofakingforever.analytics.events.AnalyticsContentView
5-
import com.sofakingforever.analytics.events.AnalyticsEvent
6-
import com.sofakingforever.analytics.events.AnalyticsInviteEvent
7-
import com.sofakingforever.analytics.events.Event
4+
import com.sofakingforever.analytics.events.ContentViewEvent
5+
import com.sofakingforever.analytics.events.CustomEvent
6+
import com.sofakingforever.analytics.events.InviteEvent
7+
import com.sofakingforever.analytics.events.base.Event
88
import com.sofakingforever.analytics.exceptions.UnsupportedEventException
99

1010
/**
@@ -26,11 +26,11 @@ interface AnalyticsDispatcher {
2626
fun initDispatcher(context: Context)
2727

2828

29-
fun trackContentView(contentView: AnalyticsContentView)
29+
fun trackContentView(contentView: ContentViewEvent)
3030

31-
fun trackCustomEvent(event: AnalyticsEvent)
31+
fun trackCustomEvent(event: CustomEvent)
3232

33-
fun trackInviteEvent(inviteEvent: AnalyticsInviteEvent)
33+
fun trackInviteEvent(inviteEvent: InviteEvent)
3434

3535
/**
3636
* This method is called from the parent @Analytics class for each event.
@@ -41,9 +41,9 @@ interface AnalyticsDispatcher {
4141
// track the event only if it is not configured as excluded
4242
when (event) {
4343
// track each type differently
44-
is AnalyticsEvent -> trackCustomEvent(event)
45-
is AnalyticsContentView -> trackContentView(event)
46-
is AnalyticsInviteEvent -> trackInviteEvent(event)
44+
is CustomEvent -> trackCustomEvent(event)
45+
is ContentViewEvent -> trackContentView(event)
46+
is InviteEvent -> trackInviteEvent(event)
4747
// alert developer if this is a customized event implementation
4848
else -> throw UnsupportedEventException(event)
4949
}

‎analytics/src/main/java/com/sofakingforever/analytics/events/AnalyticsContentView.kt renamed to ‎analytics/src/main/java/com/sofakingforever/analytics/events/ContentViewEvent.kt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
package com.sofakingforever.analytics.events
22

33
import com.sofakingforever.analytics.AnalyticsKit
4+
import com.sofakingforever.analytics.events.base.Event
45

5-
interface AnalyticsContentView : Event {
6+
interface ContentViewEvent : Event {
67

78
fun getViewName(kit : AnalyticsKit): String
89

‎analytics/src/main/java/com/sofakingforever/analytics/events/AnalyticsEvent.kt renamed to ‎analytics/src/main/java/com/sofakingforever/analytics/events/CustomEvent.kt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
package com.sofakingforever.analytics.events
22

33
import com.sofakingforever.analytics.AnalyticsKit
4+
import com.sofakingforever.analytics.events.base.Event
45

5-
interface AnalyticsEvent : Event {
6+
interface CustomEvent : Event {
67

78
fun getEventName(kit: AnalyticsKit): String
89

‎analytics/src/main/java/com/sofakingforever/analytics/events/AnalyticsInviteEvent.kt renamed to ‎analytics/src/main/java/com/sofakingforever/analytics/events/InviteEvent.kt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
package com.sofakingforever.analytics.events
22

33
import android.content.Context
4+
import com.sofakingforever.analytics.events.base.Event
45

5-
interface AnalyticsInviteEvent : Event {
6+
interface InviteEvent : Event {
67

78
val context: Context
89
val packageName: String

‎analytics/src/main/java/com/sofakingforever/analytics/events/Event.kt renamed to ‎analytics/src/main/java/com/sofakingforever/analytics/events/base/Event.kt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
package com.sofakingforever.analytics.events
1+
package com.sofakingforever.analytics.events.base
22

33
import com.sofakingforever.analytics.AnalyticsKit
44

5+
/**
6+
* Every event interface (See CustomEvent or ContentViewEvent) should extend this interface.
7+
*/
58
interface Event {
69
fun isConsideredIncluded(kit: AnalyticsKit): Boolean {
710

‎analytics/src/main/java/com/sofakingforever/analytics/exceptions/UnsupportedEventException.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package com.sofakingforever.analytics.exceptions
22

3-
import com.sofakingforever.analytics.events.Event
3+
import com.sofakingforever.analytics.events.base.Event
44

55
class UnsupportedEventException(event: Event) : UnsupportedOperationException() {
66
override val message: String = "couldn't fire \"${event.javaClass.name}\" event"

‎analytics/src/main/java/com/sofakingforever/analytics/kits/logger/LoggerDispatcherImpl.kt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ import android.content.Context
44
import android.util.Log
55
import com.sofakingforever.analytics.AnalyticsDispatcher
66
import com.sofakingforever.analytics.AnalyticsKit
7-
import com.sofakingforever.analytics.events.AnalyticsContentView
8-
import com.sofakingforever.analytics.events.AnalyticsEvent
9-
import com.sofakingforever.analytics.events.AnalyticsInviteEvent
7+
import com.sofakingforever.analytics.events.ContentViewEvent
8+
import com.sofakingforever.analytics.events.CustomEvent
9+
import com.sofakingforever.analytics.events.InviteEvent
1010

1111
/**
1212
* This is just a logger implementation, Use this if you're in DEBUG mode.
@@ -27,15 +27,15 @@ class LoggerDispatcherImpl(override val init: Boolean) : AnalyticsDispatcher {
2727
Log.d(tag, "Init Logger Analytics Dispatcher")
2828
}
2929

30-
override fun trackContentView(contentView: AnalyticsContentView) {
30+
override fun trackContentView(contentView: ContentViewEvent) {
3131
Log.d(tag, "Tracking contentView ${contentView.getViewName(kit)}")
3232
}
3333

34-
override fun trackCustomEvent(event: AnalyticsEvent) {
34+
override fun trackCustomEvent(event: CustomEvent) {
3535
Log.d(tag, "Tracking event ${event.getEventName(kit)}")
3636
}
3737

38-
override fun trackInviteEvent(inviteEvent: AnalyticsInviteEvent) {
38+
override fun trackInviteEvent(inviteEvent: InviteEvent) {
3939
Log.d(tag, "Tracking inviteEvent ${inviteEvent.packageName}")
4040
}
4141

‎app/src/main/java/com/sofakingforever/example/custom/CustomDispatcher.kt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ package com.sofakingforever.example.custom
22

33
import android.content.Context
44
import com.sofakingforever.analytics.AnalyticsDispatcher
5-
import com.sofakingforever.analytics.events.AnalyticsContentView
6-
import com.sofakingforever.analytics.events.AnalyticsEvent
7-
import com.sofakingforever.analytics.events.AnalyticsInviteEvent
5+
import com.sofakingforever.analytics.events.ContentViewEvent
6+
import com.sofakingforever.analytics.events.CustomEvent
7+
import com.sofakingforever.analytics.events.InviteEvent
88
import com.sofakingforever.analytics.AnalyticsKit
99

1010
/**
@@ -20,15 +20,15 @@ class CustomDispatcher(override val init: Boolean) : AnalyticsDispatcher {
2020
// call custom analytics initiation function
2121
}
2222

23-
override fun trackContentView(contentView: AnalyticsContentView) {
23+
override fun trackContentView(contentView: ContentViewEvent) {
2424
// track content view
2525
}
2626

27-
override fun trackCustomEvent(event: AnalyticsEvent) {
27+
override fun trackCustomEvent(event: CustomEvent) {
2828
// track event
2929
}
3030

31-
override fun trackInviteEvent(inviteEvent: AnalyticsInviteEvent) {
31+
override fun trackInviteEvent(inviteEvent: InviteEvent) {
3232
// track invite event
3333
}
3434

‎app/src/main/java/com/sofakingforever/example/events/EventPerKit.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
package com.sofakingforever.example.events
22

3-
import com.sofakingforever.analytics.events.AnalyticsEvent
3+
import com.sofakingforever.analytics.events.CustomEvent
44
import com.sofakingforever.analytics.AnalyticsKit
55

6-
class EventPerKit(private val whatever: Boolean) : AnalyticsEvent {
6+
class EventPerKit(private val whatever: Boolean) : CustomEvent {
77
override fun getEventName(kit: AnalyticsKit): String = when (kit) {
88
is FirebaseKit -> "Event #42 - Firebase"
99
is AnswersKit -> "Event #42 - Answers"

‎app/src/main/java/com/sofakingforever/example/events/MainContentView.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
package com.sofakingforever.example.events
22

3-
import com.sofakingforever.analytics.events.AnalyticsContentView
3+
import com.sofakingforever.analytics.events.ContentViewEvent
44
import com.sofakingforever.analytics.AnalyticsKit
55

6-
class MainContentView : AnalyticsContentView {
6+
class MainContentView : ContentViewEvent {
77
override fun getViewName(kit : AnalyticsKit): String = "Main Screen"
88

99

‎app/src/main/java/com/sofakingforever/example/events/ParameterizedEvent.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
package com.sofakingforever.example.events
22

3-
import com.sofakingforever.analytics.events.AnalyticsEvent
3+
import com.sofakingforever.analytics.events.CustomEvent
44
import com.sofakingforever.analytics.AnalyticsKit
55

6-
class ParameterizedEvent(private val isFirstClick : Boolean, private val timeClicked: Long) : AnalyticsEvent {
6+
class ParameterizedEvent(private val isFirstClick : Boolean, private val timeClicked: Long) : CustomEvent {
77
override fun getEventName(kit: AnalyticsKit): String = "Event With Parameters"
88

99
override fun getParameters(kit: AnalyticsKit): MutableMap<String, Any> {

‎app/src/main/java/com/sofakingforever/example/events/SimpleEvent.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
package com.sofakingforever.example.events
22

3-
import com.sofakingforever.analytics.events.AnalyticsEvent
3+
import com.sofakingforever.analytics.events.CustomEvent
44
import com.sofakingforever.analytics.AnalyticsKit
55

6-
class SimpleEvent : AnalyticsEvent {
6+
class SimpleEvent : CustomEvent {
77
override fun getEventName(kit: AnalyticsKit): String = "Simple Event"
88

99
}

‎kit-answers/src/main/java/com/sofakingforever/analytics/kits/answers/AnswersDispatcherImpl.kt

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,7 @@ package com.sofakingforever.analytics.kits.answers
22

33
import android.content.Context
44
import com.crashlytics.android.answers.Answers
5-
import com.crashlytics.android.answers.ContentViewEvent
6-
import com.crashlytics.android.answers.CustomEvent
7-
import com.crashlytics.android.answers.InviteEvent
85
import com.sofakingforever.analytics.AnalyticsDispatcher
9-
import com.sofakingforever.analytics.events.AnalyticsContentView
10-
import com.sofakingforever.analytics.events.AnalyticsEvent
11-
import com.sofakingforever.analytics.events.AnalyticsInviteEvent
12-
import com.sofakingforever.analytics.events.Event
13-
import com.sofakingforever.analytics.kits.answers.AnswersKit
146
import io.fabric.sdk.android.Fabric
157

168
/**
@@ -27,20 +19,20 @@ class AnswersDispatcherImpl(override val init: Boolean) : AnalyticsDispatcher {
2719
Fabric.with(context, Answers())
2820
}
2921

30-
override fun trackCustomEvent(event: AnalyticsEvent) {
22+
override fun trackCustomEvent(event: com.sofakingforever.analytics.events.CustomEvent) {
3123
Answers.getInstance().logCustom(event.createAnswersAnalyticsEvent())
3224
}
3325

34-
override fun trackContentView(contentView: AnalyticsContentView) {
26+
override fun trackContentView(contentView: com.sofakingforever.analytics.events.ContentViewEvent) {
3527
Answers.getInstance().logContentView(contentView.createAnswersEvent())
3628
}
3729

38-
override fun trackInviteEvent(inviteEvent: AnalyticsInviteEvent) {
30+
override fun trackInviteEvent(inviteEvent: com.sofakingforever.analytics.events.InviteEvent) {
3931
Answers.getInstance().logInvite(inviteEvent.createAnswersInviteEvent())
4032
}
4133

4234

43-
private fun AnalyticsEvent.createAnswersAnalyticsEvent(): CustomEvent {
35+
private fun com.sofakingforever.analytics.events.CustomEvent.createAnswersAnalyticsEvent(): CustomEvent {
4436
return CustomEvent(this.getEventName(kit))
4537
.apply {
4638

@@ -61,11 +53,11 @@ class AnswersDispatcherImpl(override val init: Boolean) : AnalyticsDispatcher {
6153
}
6254

6355

64-
private fun AnalyticsContentView.createAnswersEvent(): ContentViewEvent {
56+
private fun com.sofakingforever.analytics.events.ContentViewEvent.createAnswersEvent(): ContentViewEvent {
6557
return ContentViewEvent().putContentName(this.getViewName(kit))
6658
}
6759

68-
private fun AnalyticsInviteEvent.createAnswersInviteEvent(): InviteEvent {
60+
private fun com.sofakingforever.analytics.events.InviteEvent.createAnswersInviteEvent(): InviteEvent {
6961
return InviteEvent().putMethod(this.getInviteMethod()).putCustomAttribute("shareVia", this.shareVia)
7062
}
7163

‎kit-firebase/src/main/java/com/sofakingforever/analytics/kits/firebase/FirebaseDispatcherImpl.kt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ import android.content.Context
44
import android.os.Bundle
55
import com.google.firebase.analytics.FirebaseAnalytics
66
import com.sofakingforever.analytics.AnalyticsDispatcher
7-
import com.sofakingforever.analytics.events.AnalyticsContentView
8-
import com.sofakingforever.analytics.events.AnalyticsEvent
9-
import com.sofakingforever.analytics.events.AnalyticsInviteEvent
7+
import com.sofakingforever.analytics.events.ContentViewEvent
8+
import com.sofakingforever.analytics.events.CustomEvent
9+
import com.sofakingforever.analytics.events.InviteEvent
1010

1111
class FirebaseDispatcherImpl(override val init: Boolean) : AnalyticsDispatcher {
1212

@@ -22,15 +22,15 @@ class FirebaseDispatcherImpl(override val init: Boolean) : AnalyticsDispatcher {
2222
}
2323

2424

25-
override fun trackCustomEvent(event: AnalyticsEvent) {
25+
override fun trackCustomEvent(event: CustomEvent) {
2626
firebaseAnalytics?.logEvent(event.getEventName(kit).firebaseFriendly(), event.getBundle())
2727
}
2828

29-
override fun trackContentView(contentView: AnalyticsContentView) {
29+
override fun trackContentView(contentView: ContentViewEvent) {
3030
firebaseAnalytics?.logEvent("contentView_" + contentView.getViewName(kit).firebaseFriendly(), Bundle.EMPTY)
3131
}
3232

33-
override fun trackInviteEvent(inviteEvent: AnalyticsInviteEvent) {
33+
override fun trackInviteEvent(inviteEvent: InviteEvent) {
3434
firebaseAnalytics?.logEvent(FirebaseAnalytics.Event.SHARE, inviteEvent.getBundle())
3535
}
3636

@@ -47,7 +47,7 @@ class FirebaseDispatcherImpl(override val init: Boolean) : AnalyticsDispatcher {
4747
}
4848

4949

50-
private fun AnalyticsInviteEvent.getBundle(): Bundle {
50+
private fun InviteEvent.getBundle(): Bundle {
5151
val bundle = Bundle()
5252

5353
bundle.putString("packageName", packageName)
@@ -56,7 +56,7 @@ class FirebaseDispatcherImpl(override val init: Boolean) : AnalyticsDispatcher {
5656
return bundle
5757
}
5858

59-
private fun AnalyticsEvent.getBundle(): Bundle {
59+
private fun CustomEvent.getBundle(): Bundle {
6060
val bundle = Bundle()
6161

6262
getParameters(kit).forEach {

‎kit-flurry/src/main/java/com/sofakingforever/analytics/kits/flurry/FlurryDispatcherImpl.kt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ package com.sofakingforever.analytics.kits.flurry
33
import android.content.Context
44
import com.flurry.android.FlurryAgent
55
import com.sofakingforever.analytics.AnalyticsDispatcher
6-
import com.sofakingforever.analytics.events.AnalyticsContentView
7-
import com.sofakingforever.analytics.events.AnalyticsEvent
8-
import com.sofakingforever.analytics.events.AnalyticsInviteEvent
6+
import com.sofakingforever.analytics.events.ContentViewEvent
7+
import com.sofakingforever.analytics.events.CustomEvent
8+
import com.sofakingforever.analytics.events.InviteEvent
99

1010
class FlurryDispatcherImpl(override val init: Boolean, val apiKey: String) : AnalyticsDispatcher {
1111

@@ -20,22 +20,22 @@ class FlurryDispatcherImpl(override val init: Boolean, val apiKey: String) : Ana
2020

2121
}
2222

23-
override fun trackCustomEvent(event: AnalyticsEvent) {
23+
override fun trackCustomEvent(event: CustomEvent) {
2424

2525

2626
FlurryAgent.logEvent(event.getEventName(kit), event.createFlurryAnalyticsMap())
2727
}
2828

29-
override fun trackContentView(contentView: AnalyticsContentView) {
29+
override fun trackContentView(contentView: ContentViewEvent) {
3030
FlurryAgent.logEvent("contentView_" + contentView.getViewName(kit))
3131
}
3232

33-
override fun trackInviteEvent(inviteEvent: AnalyticsInviteEvent) {
33+
override fun trackInviteEvent(inviteEvent: InviteEvent) {
3434
FlurryAgent.logEvent("inviteEvent_" + inviteEvent.packageName)
3535

3636
}
3737

38-
private fun AnalyticsEvent.createFlurryAnalyticsMap(): MutableMap<String, String> {
38+
private fun CustomEvent.createFlurryAnalyticsMap(): MutableMap<String, String> {
3939
val map: MutableMap<String, String> = mutableMapOf()
4040

4141
this.getParameters(kit).forEach {

0 commit comments

Comments
 (0)