yanalytics-firebase-ios: A Swift repository from Code and Theory

A Firebase implementation of Y—Analytics' AnalyticsEngine protocol.

This framework links the Firebase iOS SDK to implement a Firebase version of Y—Analytics' AnalyticsEngine protocol.

Licensing

Y—Analytics Firebase is licensed under the Apache 2.0 license.

Firebase iOS SDK is licensed under the Apache 2.0 license

Documentation

Documentation is automatically generated from source code comments and rendered as a static website hosted via GitHub Pages at: https://yml-org.github.io/yanalytics-firebase-ios/

Usage

`FirebaseAnalyticsEngine`

FirebaseAnalyticsEngine implements the AnalyticsEngine protocol, and in its track(event:) method it maps the AnalyticsEvent enum to the appropriate Firebase methods.

Internally the Firebase SDK is just using singleton objects, but the goal of Y—Analytics is to use Dependency Injection of a generic wrapper. This allows your project code to be loosely coupled to your choice of analytics provider. It also facilitates unit testing and a healthy app architecture.

Just be aware that even if you declare multiple instances of FirebaseAnalyticsEngine, that they all reference the same Firebase SDK singleton.

When unit testing various components of your project, you should inject an instance of MockAnalyticsEngine instead of the Firebase engine. This allows your unit tests to run without any Firebase dependency and allows you to verify which events are tracked and when.

Simple use case: GoogleService-Info.plist file

If you include the standard Google plist file in your project, you may initialize FirebaseAnalyticsEngine like this:

import YAnalyticsFirebase

final class AppCoordinator {
    let engine: AnalyticsEngine = FirebaseAnalyticsEngine()

    func trackSomething(someData: [String: Any]?) {
        engine.track(
            event: .event(name: "Something", parameters: someData)
        )
    }
}

Configuration

The Firebase iOS SDK lets you initialize using three methods:

options
name and options
neither (GoogleService-Info.plist)

FirebaseAnalyticsEngineConfiguration supports the same three matching options.

import FirebaseCore
import YAnalyticsFirebase

final class AppCoordinator {
    let engine: AnalyticsEngine = {
        let options: FirebaseOptions = ...
        let config = FirebaseAnalyticsConfiguration(options: options)
        return FirebaseAnalyticsEngine(configuration: config)
    }()
}

Dependencies

Y—AnalyticsFirebase depends upon our Y—Analytics framework (which is also open source and Apache 2.0 licensed).

Installation

You can add Y—Analytics Firebase to an Xcode project by adding it as a package dependency.

From the File menu, select Add Packages...
Enter "https://github.com/yml-org/yanalytics-firebase-ios" into the package repository URL text field
Click Add Package

Contributing to Y—Analytics Firebase

Requirements

SwiftLint (linter)

brew install swiftlint

Jazzy (documentation)

sudo gem install jazzy

Setup

Clone the repo and open Package.swift in Xcode.

Versioning strategy

We utilize semantic versioning.

{major}.{minor}.{patch}

e.g.

1.0.5

Branching strategy

We utilize a simplified branching strategy for our frameworks.

main (and development) branch is main
both feature (and bugfix) branches branch off of main
feature (and bugfix) branches are merged back into main as they are completed and approved.
main gets tagged with an updated version # for each release

Branch naming conventions:

feature/{ticket-number}-{short-description}
bugfix/{ticket-number}-{short-description}

e.g.

feature/CM-44-button
bugfix/CM-236-textview-color

Pull Requests

Prior to submitting a pull request you should:

Compile and ensure there are no warnings and no errors.
Run all unit tests and confirm that everything passes.
Check unit test coverage and confirm that all new / modified code is fully covered.
Run swiftlint from the command line and confirm that there are no violations.
Run jazzy from the command line and confirm that you have 100% documentation coverage.
Consider using git rebase -i HEAD~{commit-count} to squash your last {commit-count} commits together into functional chunks.
If HEAD of the parent branch (typically main) has been updated since you created your branch, use git rebase main to rebase your branch.
- Never merge the parent branch into your branch.
- Always rebase your branch off of the parent branch.

When submitting a pull request:

Use the provided pull request template and populate the Introduction, Purpose, and Scope fields at a minimum.
If you're submitting before and after screenshots, movies, or GIF's, enter them in a two-column table so that they can be viewed side-by-side.

When merging a pull request:

Make sure the branch is rebased (not merged) off of the latest HEAD from the parent branch. This keeps our git history easy to read and understand.
Make sure the branch is deleted upon merge (should be automatic).

Releasing new versions

Tag the corresponding commit with the new version (e.g. 1.0.5)
Push the local tag to remote

Generating Documentation (via Jazzy)

You can generate your own local set of documentation directly from the source code using the following command from Terminal:

jazzy

This generates a set of documentation under /docs. The default configuration is set in the default config file .jazzy.yaml file.

To view additional documentation options type:

jazzy --help

A GitHub Action automatically runs each time a commit is pushed to main that runs Jazzy to generate the documentation for our GitHub page at: https://yml-org.github.io/yanalytics-firebase-ios/

codeandtheory/yanalytics-firebase-ios