Analytics: Rename all kMXGoogleAnalyticsXxx constant values to kMXAnalyticsXxx

Author: manuroe

CHANGES.rst

@@ -15,6 +15,7 @@ Bug fix:
  * MXMegolmDecryption: Fix unused overridden var.
 
 API break:
+ * Analytics: Rename all kMXGoogleAnalyticsXxx constant values to kMXAnalyticsXxx.
 
 Changes in Matrix iOS SDK in 0.10.11 (2018-05-31)
 =============================================== 

MatrixSDK/MXEnumConstants.h

@@ -185,33 +185,33 @@ typedef enum : NSUInteger
 FOUNDATION_EXPORT NSString *const kMXMatrixDotToUrl;
 
 
-#pragma mark - Google Analytics
+#pragma mark - Analytics
 
 /**
  Timing stats relative to app startup.
  */
-FOUNDATION_EXPORT NSString *const kMXGoogleAnalyticsStartupCategory;
+FOUNDATION_EXPORT NSString *const kMXAnalyticsStartupCategory;
 
 // Duration of the initial /sync request
-FOUNDATION_EXPORT NSString *const kMXGoogleAnalyticsStartupInititialSync;
+FOUNDATION_EXPORT NSString *const kMXAnalyticsStartupInititialSync;
 
 // Duration of the first /sync when resuming the app
-FOUNDATION_EXPORT NSString *const kMXGoogleAnalyticsStartupIncrementalSync;
+FOUNDATION_EXPORT NSString *const kMXAnalyticsStartupIncrementalSync;
 
 // Time to preload data in the MXStore
-FOUNDATION_EXPORT NSString *const kMXGoogleAnalyticsStartupStorePreload;
+FOUNDATION_EXPORT NSString *const kMXAnalyticsStartupStorePreload;
 
-// Time to mount all objects from the store (it includes kMXGoogleAnalyticsStartupStorePreload time)
-FOUNDATION_EXPORT NSString *const kMXGoogleAnalyticsStartupMountData;
+// Time to mount all objects from the store (it includes kMXAnalyticsStartupStorePreload time)
+FOUNDATION_EXPORT NSString *const kMXAnalyticsStartupMountData;
 
 // Duration of the the display of the app launch screen
-FOUNDATION_EXPORT NSString *const kMXGoogleAnalyticsStartupLaunchScreen;
+FOUNDATION_EXPORT NSString *const kMXAnalyticsStartupLaunchScreen;
 
 /**
  Overall stats category.
  */
-FOUNDATION_EXPORT NSString *const kMXGoogleAnalyticsStatsCategory;
+FOUNDATION_EXPORT NSString *const kMXAnalyticsStatsCategory;
 
 // The number of room the user is in
-FOUNDATION_EXPORT NSString *const kMXGoogleAnalyticsStatsRooms;
+FOUNDATION_EXPORT NSString *const kMXAnalyticsStatsRooms;
 

MatrixSDK/MXEnumConstants.m

@@ -67,15 +67,15 @@
 NSString *const kMXMatrixDotToUrl = @"https://matrix.to";
 
 
-#pragma mark - Google Analytics
+#pragma mark - Analytics
 
-NSString *const kMXGoogleAnalyticsStartupCategory = @"startup";
+NSString *const kMXAnalyticsStartupCategory = @"startup";
 
-NSString *const kMXGoogleAnalyticsStartupInititialSync = @"initialSync";
-NSString *const kMXGoogleAnalyticsStartupIncrementalSync = @"incrementalSync";
-NSString *const kMXGoogleAnalyticsStartupStorePreload = @"storePreload";
-NSString *const kMXGoogleAnalyticsStartupMountData = @"mountData";
-NSString *const kMXGoogleAnalyticsStartupLaunchScreen = @"launchScreen";
+NSString *const kMXAnalyticsStartupInititialSync = @"initialSync";
+NSString *const kMXAnalyticsStartupIncrementalSync = @"incrementalSync";
+NSString *const kMXAnalyticsStartupStorePreload = @"storePreload";
+NSString *const kMXAnalyticsStartupMountData = @"mountData";
+NSString *const kMXAnalyticsStartupLaunchScreen = @"launchScreen";
 
-NSString *const kMXGoogleAnalyticsStatsCategory = @"stats";
-NSString *const kMXGoogleAnalyticsStatsRooms = @"rooms";
+NSString *const kMXAnalyticsStatsCategory = @"stats";
+NSString *const kMXAnalyticsStatsRooms = @"rooms";

MatrixSDK/Utils/MXAnalyticsDelegate.h

@@ -26,15 +26,9 @@
  MyAnalyticsDelegate *delegate = [[MyAnalyticsDelegate alloc] init];
  [MXSDKOptions shared].analyticsDelegate = delegate;
  @endcode
- 
- By default, the MatrixSDK uses the MXGoogleAnalytics implementation
- which sends timing events in milliseconds to Google Analytics. If you
- do not have the Google Analytics framework/library included in your client
- project, the MXGoogleAnalytics class does nothing.
- 
- If you are using the Swift-enabled variation of MatrixSDK (named
- "SwiftMatrixSDK"), the MXGoogleAnalytics class will be unavailable and the
- default analyticsDelegate will be nil.
+
+ You can use the sub-pod `MatrixSDK/GoogleAnalytics` to use a default implementation
+ based on Google Analytics. It will send timing events in milliseconds.
  */
 @protocol MXAnalyticsDelegate <NSObject>
 

MatrixSDKExtensions/MXAnalyticsDelegate/GoogleAnalytics/MXGoogleAnalytics.m

@@ -29,37 +29,37 @@ - (void)trackStartupStorePreloadDuration: (NSTimeInterval)duration
 {
     int milliseconds = (duration * 1000);
     id<GAITracker> tracker = [[GAI sharedInstance] defaultTracker];
-    [tracker send:[[GAIDictionaryBuilder createTimingWithCategory:kMXGoogleAnalyticsStartupCategory
+    [tracker send:[[GAIDictionaryBuilder createTimingWithCategory:kMXAnalyticsStartupCategory
                                                          interval:@(milliseconds)
-                                                             name:kMXGoogleAnalyticsStartupStorePreload
+                                                             name:kMXAnalyticsStartupStorePreload
                                                             label:nil] build]];
 }
 
 - (void)trackStartupMountDataDuration: (NSTimeInterval)duration
 {
     int milliseconds = (duration * 1000);
     id<GAITracker> tracker = [[GAI sharedInstance] defaultTracker];
-    [tracker send:[[GAIDictionaryBuilder createTimingWithCategory:kMXGoogleAnalyticsStartupCategory
+    [tracker send:[[GAIDictionaryBuilder createTimingWithCategory:kMXAnalyticsStartupCategory
                                                          interval:@(milliseconds)
-                                                             name:kMXGoogleAnalyticsStartupMountData
+                                                             name:kMXAnalyticsStartupMountData
                                                             label:nil] build]];
 }
 
 - (void)trackStartupSyncDuration: (NSTimeInterval)duration isInitial: (BOOL)isInitial
 {
     int milliseconds = (duration * 1000);
     id<GAITracker> tracker = [[GAI sharedInstance] defaultTracker];
-    [tracker send:[[GAIDictionaryBuilder createTimingWithCategory:kMXGoogleAnalyticsStartupCategory
+    [tracker send:[[GAIDictionaryBuilder createTimingWithCategory:kMXAnalyticsStartupCategory
                                                          interval:@(milliseconds)
-                                                             name:(isInitial ? kMXGoogleAnalyticsStartupInititialSync : kMXGoogleAnalyticsStartupIncrementalSync)
+                                                             name:(isInitial ? kMXAnalyticsStartupInititialSync : kMXAnalyticsStartupIncrementalSync)
                                                             label:nil] build]];
 }
 
 - (void)trackRoomCount: (NSUInteger)roomCount
 {
     id<GAITracker> tracker = [[GAI sharedInstance] defaultTracker];
-    [tracker send:[[GAIDictionaryBuilder createEventWithCategory:kMXGoogleAnalyticsStatsCategory
-                                                          action:kMXGoogleAnalyticsStatsRooms
+    [tracker send:[[GAIDictionaryBuilder createEventWithCategory:kMXAnalyticsStatsCategory
+                                                          action:kMXAnalyticsStatsRooms
                                                            label:nil
                                                            value:@(roomCount)] build]];
 }