Merge pull request #29 from prolificinteractive/feature/swift3

[Feature] Swift3

Author: yoyoyoseob

.swift-version

@@ -1 +1 @@
-2.3
+3.0

Podfile

@@ -29,7 +29,6 @@ post_install do |installer|
             if config.name == "Debug"
                 # Enables unit testing of pods frameworks
                 config.build_settings['ENABLE_TESTABILITY'] = "YES"
-                config.build_settings['SWIFT_VERSION'] = "2.3"
             end
         end
     end

Podfile.lock

@@ -5,11 +5,11 @@ PODS:
   - mParticle-Apple-SDK (6.11.1):
     - mParticle-Apple-SDK/mParticle (= 6.11.1)
   - mParticle-Apple-SDK/mParticle (6.11.1)
-  - Simcoe/Adobe (0.4.0):
+  - Simcoe/Adobe (0.5.1):
     - AdobeMobileSDK (~> 4.13)
     - Simcoe/Core
-  - Simcoe/Core (0.4.0)
-  - Simcoe/mParticle (0.4.0):
+  - Simcoe/Core (0.5.1)
+  - Simcoe/mParticle (0.5.1):
     - mParticle-Apple-SDK (~> 6)
     - Simcoe/Core
 
@@ -26,8 +26,8 @@ EXTERNAL SOURCES:
 SPEC CHECKSUMS:
   AdobeMobileSDK: 52c3fbf43b5b054132393b1486ecbefca0ba01db
   mParticle-Apple-SDK: 8c7dfc195459870aa33be634f006342cb37d6a24
-  Simcoe: 1797e557b41c062ce9c044e52c8dd213bdb269a9
+  Simcoe: 11fe674388e2f4c5b3f90090f165f5150b8aabb8
 
-PODFILE CHECKSUM: ff6f7dfab7642eeaa4022fde98af95982fd9d182
+PODFILE CHECKSUM: eca652a10d5483dbc0b33408738dd00362f29b2c
 
 COCOAPODS: 1.1.1

README.md

@@ -70,18 +70,18 @@ provider changes, simply update your `run()` call with the providers and that's
 
 To facilitate debugging when using multiple providers, Simcoe contains a few options for updating the information logged in the console:
 
-* Verbose
-* Simple
-* None
+* verbose
+* simple
+* none
 
-By default, Simcoe will log all console outputs in detail (*Verbose*) providing one line per item for **each** provider that was specified. *Simple* will output one line per item regardless of how many providers were specified while *None* will disable all console logging. To update the *outputOption,* simply call (update this property after the `run()` command): 
+By default, Simcoe will log all console outputs in detail (*verbose*) providing one line per item for **each** provider that was specified. *simple* will output one line per item regardless of how many providers were specified while *none* will disable all console logging. To update the *outputOption,* simply call (update this property after the `run()` command): 
 
-`Simcoe.engine.tracker.outputOption = .Simple`
+`Simcoe.engine.tracker.outputOption = .simple`
 
 Simcoe providers a base function call for each major analytics action right out of the gate, giving a consistent API to all of your analytics tracking. For instance, to track page views:
 
 ``
-Simcoe.trackPageView("Home Screen")
+Simcoe.track(pageView: "Home Screen")
 ``
 
 That's it! Simcoe will automatically call all of your analytics providers and request that they log that page view. This same method is uniform and consistent, no matter what providers you are using.
@@ -110,19 +110,6 @@ While simply implementing this protocol is all you need for your object to be a
 
 So for your analytics provider to be able to handle page views in the Simcoe framework, your provider should implement the `PageViewTracking` protocol. This plug-and-play API allows you to define what you want your provider to handle at a very granular level. If your provider only needs to implement location tracking and nothing else, then you need only implement the `LocationTracking` protocol (as well as the `AnalyticsTracking` protocol, of course); all other protocols are optional. This allows you full customization as to how your objects respond to Simcoe.
 
-Each provider type defined above maps directly to a Simcoe function that will call that method. These are, respectively:
-
-* `logAddToCart`, `logRemoveFromCart`
-* `trackCheckoutEvent`
-* `logError`
-* `trackEvent`
-* `increaseLifetimeValue`
-* `trackLocation`
-* `trackPageView`
-* `trackPurchaseEvent`
-* `setUserAttribute`
-* `logViewDetail`
-
 #### Additional Tracking
 
 Each analytics implementation is different, and Simcoe doesn't expect to be the be-all, end-all of analytics implementations. What if you need to track something that is not included in the base SDK?

Simcoe.xcodeproj/project.pbxproj

@@ -605,7 +605,7 @@
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
 				PRODUCT_BUNDLE_IDENTIFIER = com.prolificinteractive.SimcoeTests;
 				PRODUCT_NAME = "$(TARGET_NAME)";
-				SWIFT_VERSION = 2.3;
+				SWIFT_VERSION = 3.0;
 			};
 			name = Debug;
 		};
@@ -617,7 +617,7 @@
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
 				PRODUCT_BUNDLE_IDENTIFIER = com.prolificinteractive.SimcoeTests;
 				PRODUCT_NAME = "$(TARGET_NAME)";
-				SWIFT_VERSION = 2.3;
+				SWIFT_VERSION = 3.0;
 			};
 			name = Release;
 		};
@@ -666,6 +666,7 @@
 				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = iphoneos;
 				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
+				SWIFT_VERSION = 3.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				VERSIONING_SYSTEM = "apple-generic";
 				VERSION_INFO_PREFIX = "";
@@ -710,6 +711,7 @@
 				MTL_ENABLE_DEBUG_INFO = NO;
 				SDKROOT = iphoneos;
 				SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule";
+				SWIFT_VERSION = 3.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				VALIDATE_PRODUCT = YES;
 				VERSIONING_SYSTEM = "apple-generic";
@@ -737,7 +739,7 @@
 				SKIP_INSTALL = YES;
 				SWIFT_OBJC_BRIDGING_HEADER = "";
 				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
-				SWIFT_VERSION = 2.3;
+				SWIFT_VERSION = 3.0;
 			};
 			name = Debug;
 		};
@@ -760,7 +762,7 @@
 				PRODUCT_NAME = Simcoe;
 				SKIP_INSTALL = YES;
 				SWIFT_OBJC_BRIDGING_HEADER = "";
-				SWIFT_VERSION = 2.3;
+				SWIFT_VERSION = 3.0;
 			};
 			name = Release;
 		};

Simcoe/Adobe/Adobe.swift

@@ -13,13 +13,13 @@ import CoreLocation
 public class Adobe {
 
     /// The name of the tracker.
-    public let name = "Adobe Omniture"
+    open let name = "Adobe Omniture"
 
     /// The default initializer.
     public init() { }
 
     /// Starts tracking analytics.
-    public func start() {
+    open func start() {
         ADBMobile.collectLifecycleData()
     }
 
@@ -35,34 +35,33 @@ extension Adobe: EventTracking {
     ///   - event: The event to track.
     ///   - properties: The optional additional properties.
     /// - Returns: A tracking result.
-    public func trackEvent(event: String, withAdditionalProperties properties: Properties?) -> TrackingResult {
+    public func track(event: String,
+                    withAdditionalProperties properties: Properties?) -> TrackingResult {
         ADBMobile.trackAction(event, data: properties)
-        return .Success
+        return .success
     }
-    
+
 }
 
 // MARK: - LifetimeValueIncreasing
 
 extension Adobe: LifetimeValueIncreasing {
 
-    /**
-     Increases the lifetime value of the key by the specified amount.
-
-     - parameter amount:     The amount to increase that lifetime value for.
-     - parameter item:       The optional item to extend.
-     - parameter properties: The optional additional properties.
-
-     - returns: A tracking result.
-     */
+    /// Increases the lifetime value of the key by the specified amount.
+    ///
+    /// - Parameters:
+    ///   - amount: The amount to increase that lifetime value for.
+    ///   - item: The optional item to extend.
+    ///   - properties: The optional additional properties.
+    /// - Returns: A tracking result.
     public func increaseLifetimeValue(byAmount amount: Double, forItem item: String?, withAdditionalProperties properties: Properties?) -> TrackingResult {
-        var data = properties ?? [String: AnyObject]()
+        var data = properties ?? Properties()
         if let item = item {
             data[item] = ""
         }
 
-        ADBMobile.trackLifetimeValueIncrease(NSDecimalNumber(double: 1), data: data)
-        return .Success
+        ADBMobile.trackLifetimeValueIncrease(NSDecimalNumber(value: amount), data: data)
+        return .success
     }
 
 }
@@ -71,36 +70,33 @@ extension Adobe: LifetimeValueIncreasing {
 
 extension Adobe: LocationTracking {
 
-    /**
-     Tracks location.
-
-     - parameter location:   The location to track.
-     - parameter properties: The optional additional properties.
-
-     - returns: A tracking result.
-     */
-    public func trackLocation(location: CLLocation,
-                              withAdditionalProperties properties: [String: AnyObject]?) -> TrackingResult {
+    /// Tracks location.
+    ///
+    /// - Parameters:
+    ///   - location: The location to track.
+    ///   - properties: The optional additional properties.
+    /// - Returns: A tracking result.
+    public func track(location: CLLocation,
+                    withAdditionalProperties properties: Properties?) -> TrackingResult {
         ADBMobile.trackLocation(location, data: properties)
-        return .Success
+        return .success
     }
-    
+
 }
 
 // MARK: - PageViewTracking
 
 extension Adobe: PageViewTracking {
 
-    /**
-     Tracks the page view.
-
-     - parameter pageView: The page view to track.
-
-     - returns: A tracking result.
-     */
-    public func trackPageView(pageView: String, withAdditionalProperties properties: Properties?) -> TrackingResult {
+    /// Tracks the page view.
+    ///
+    /// - Parameters:
+    ///   - pageView: The page view to track.
+    ///   - properties: The optional additional properties.
+    /// - Returns: A tracking result.
+    public func track(pageView: String, withAdditionalProperties properties: Properties?) -> TrackingResult {
         ADBMobile.trackState(pageView, data: properties)
-        return .Success
+        return .success
     }
 
 }

Simcoe/Analytics Tracking Protocols/AnalyticsTracking.swift

@@ -6,10 +6,8 @@
 //  Copyright © 2016 Prolific Interactive. All rights reserved.
 //
 
-/**
- Default protocol for an object being trackable for analytics. All analytics items that wish to
- be tracked must, at least, implement this protocol.
- */
+/// Default protocol for an object being trackable for analytics. All analytics items that wish to
+/// be tracked must, at least, implement this protocol.
 public protocol AnalyticsTracking {
 
     /// The name of the tracker. This is used for debugging purposes only, but should
@@ -18,26 +16,23 @@ public protocol AnalyticsTracking {
     /// return "Adobe Omniture".
     var name: String { get }
 
-    /**
-     Starts tracking analytics. This is called on all providers passed to `Simcoe.run`.
-     Your analytics tracker should start tracking lifecycle data or setup anything else
-     that needs to run for the duration of the analytics lifecycle.
 
-     This is an optional value and is implemented by default in an extension to do nothing.
-     */
+    /// Starts tracking analytics. This is called on all providers passed to `Simcoe.run`.
+    /// Your analytics tracker should start tracking lifecycle data or setup anything else
+    /// that needs to run for the duration of the analytics lifecycle.
+    ///
+    /// This is an optional value and is implemented by default in an extension to do nothing.
     func start()
 
 }
 
 public extension AnalyticsTracking {
 
-    /**
-     Starts tracking analytics. This is called on all providers passed to `Simcoe.run`.
-     Your analytics tracker should start tracking lifecycle data or setup anything else
-     that needs to run for the duration of the analytics lifecycle.
-
-     This is an optional value and is implemented by default in an extension to do nothing.
-     */
+    /// Starts tracking analytics. This is called on all providers passed to `Simcoe.run`.
+    /// Your analytics tracker should start tracking lifecycle data or setup anything else
+    /// that needs to run for the duration of the analytics lifecycle.
+    ///
+    /// This is an optional value and is implemented by default in an extension to do nothing.
     func start() {
 
     }

Simcoe/Analytics Tracking Protocols/CartLogging.swift

@@ -6,25 +6,23 @@
 //  Copyright © 2016 Prolific Interactive. All rights reserved.
 //
 
-/**
- *  Defines functionality for logging cart actions.
- */
+/// Defines functionality for logging cart actions.
 public protocol CartLogging: AnalyticsTracking {
 
     /// Logs the addition of a product to the cart.
     ///
-    /// - parameter product:         The SimcoeProductConvertible instance.
-    /// - parameter eventProperties: The event properties.
-    ///
-    /// - returns: A tracking result.
-    func logAddToCart<T: SimcoeProductConvertible>(product: T, eventProperties: Properties?) -> TrackingResult
+    /// - Parameters:
+    ///   - product: The SimcoeProductConvertible instance.
+    ///   - eventProperties: The event properties.
+    /// - Returns: A tracking result.
+    func logAddToCart<T: SimcoeProductConvertible>(_ product: T, eventProperties: Properties?) -> TrackingResult
 
     /// Logs the removal of a product from the cart.
     ///
-    /// - parameter product:         The SimcoeProductConvertible instance.
-    /// - parameter eventProperties: The event properties.
-    ///
-    /// - returns: A tracking result.
-    func logRemoveFromCart<T: SimcoeProductConvertible>(product: T, eventProperties: Properties?) -> TrackingResult
+    /// - Parameters:
+    ///   - product: The SimcoeProductConvertible instance.
+    ///   - eventProperties: The event properties.
+    /// - Returns: A tracking result.
+    func logRemoveFromCart<T: SimcoeProductConvertible>(_ product: T, eventProperties: Properties?) -> TrackingResult
 
 }

Simcoe/Analytics Tracking Protocols/CheckoutTracking.swift

@@ -6,17 +6,15 @@
 //  Copyright © 2016 Prolific Interactive. All rights reserved.
 //
 
-/**
- *  Defines functionality for tracking checkout actions.
- */
+/// Defines functionality for tracking checkout actions.
 public protocol CheckoutTracking: AnalyticsTracking {
 
     /// Tracks a checkout event.
     ///
-    /// - parameter products:        The products.
-    /// - parameter eventProperties: The event properties.
-    ///
-    /// - returns: A tracking result.
-    func trackCheckoutEvent<T: SimcoeProductConvertible>(products: [T], eventProperties: Properties?) -> TrackingResult
+    /// - Parameters:
+    ///   - products: The products.
+    ///   - eventProperties: The event properties.
+    /// - Returns: A tracking result.
+    func trackCheckoutEvent<T: SimcoeProductConvertible>(_ products: [T], eventProperties: Properties?) -> TrackingResult
 
 }

Simcoe/Analytics Tracking Protocols/ErrorLogging.swift

@@ -6,19 +6,15 @@
 //  Copyright © 2016 Prolific Interactive. All rights reserved.
 //
 
-/**
- Defines methods for logging errors to analytics.
- */
+/// Defines methods for logging errors to analytics.
 public protocol ErrorLogging: AnalyticsTracking {
-    
-    /**
-     Logs the error with optional additional properties.
-     
-     - parameter error:      The error to log.
-     - parameter properties: The optional additional properties.
-     
-     - returns: A tracking result.
-     */
-    func logError(error: String, withAdditionalProperties properties: Properties?) -> TrackingResult
+
+    /// Logs the error with optional additional properties.
+    ///
+    /// - Parameters:
+    ///   - error: The error to log.
+    ///   - properties: The optional additional properties.
+    /// - Returns: A tracking result.
+    func log(error: String, withAdditionalProperties properties: Properties?) -> TrackingResult
 
 }