codeandtheory / yanalytics-ios Goto Github PK

Hide the Pull Request Template file by moving it to the .github directory.

Rename PULL_REQUEST_TEMPLATE.md to .github/pull_request_template.md
Update link in README under the ### Pull Requests section to reflect the new name and location.

• Add shields.io badges to README for
  • swift version
  • platform compatibility
• In the above order
• Immediately below the banner image but above the italicized tagline

Introduction

Mocks and Spies are both useful tools for testing our products.

Task

1. Move MockAnalyticsEngine from Test to Sources
   a. mark public and fully document
   b. revise to store only a single array of events: [AnalyticsEvents]
   c. if necessary, convert the 3 typed arrays into computed properties that filter events by type and return only the linked values.
2. Create SpyAnalyticsEngine which should be similar to CompoundAnalyticsEngine in that it takes as a parameter an AnalyticsEngine and then combines it with a MockAnalyticsEngine (basically adds a mock engine to any engine).
3. Fully unit test the two new engines.

Otherwise it can't be used outside of the package.

public init()

It doesn't need any parameters, just documentation comments

Add a protocol EventFactory that can be anything that makes an event.

/// Generates an analytics event
public protocol EventFactory {
    /// Event name
    var name: String { get }
    /// Event parameters
    var parameters: Metadata? { get }

    /// The event
    var event: AnalyticsEvent { get }
}

add a track(event: EventFactory) override to AnalyticsEngine and give it a default implementation:

public func track(event factory: EventFactory) { track(event: factory.event }

Release a new version once the PR is merged.