{"id":20878881,"url":"https://github.com/codeandtheory/yanalytics-firebase-ios","last_synced_at":"2026-04-25T13:34:18.454Z","repository":{"id":103293766,"uuid":"604247499","full_name":"codeandtheory/yanalytics-firebase-ios","owner":"codeandtheory","description":"Y—Analytics implementation for Firebase SDK","archived":false,"fork":false,"pushed_at":"2023-05-05T10:07:43.000Z","size":173,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-01-19T09:42:15.041Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codeandtheory.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-02-20T16:40:50.000Z","updated_at":"2023-09-29T07:53:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"4c41de4a-b3d6-4e38-99ef-02d760406b8a","html_url":"https://github.com/codeandtheory/yanalytics-firebase-ios","commit_stats":null,"previous_names":["codeandtheory/yanalytics-firebase-ios"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeandtheory%2Fyanalytics-firebase-ios","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeandtheory%2Fyanalytics-firebase-ios/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeandtheory%2Fyanalytics-firebase-ios/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeandtheory%2Fyanalytics-firebase-ios/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeandtheory","download_url":"https://codeload.github.com/codeandtheory/yanalytics-firebase-ios/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243257801,"owners_count":20262294,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-18T07:14:30.828Z","updated_at":"2025-12-27T17:10:16.787Z","avatar_url":"https://github.com/codeandtheory.png","language":"Swift","readme":"![Y—Analytics Firebase](https://user-images.githubusercontent.com/1037520/220589412-c70b47e6-dcd8-4984-92c8-7cc646deb046.jpeg)\n_A Firebase implementation of Y—Analytics' `AnalyticsEngine` protocol._\n\nThis framework links the [Firebase iOS SDK](https://github.com/firebase/firebase-ios-sdk) to implement a Firebase version of [Y—Analytics](https://github.com/yml-org/yanalytics-ios)' `AnalyticsEngine` protocol.\n\nLicensing\n----------\nY—Analytics Firebase is licensed under the [Apache 2.0 license](LICENSE).\n\nFirebase iOS SDK is licensed under the [Apache 2.0 license](https://github.com/firebase/firebase-ios-sdk/blob/master/LICENSE)\n\nDocumentation\n----------\n\nDocumentation 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/\n\nUsage\n----------\n\n### `FirebaseAnalyticsEngine`\n\n`FirebaseAnalyticsEngine` implements the `AnalyticsEngine` protocol, and in its `track(event:)` method it maps the `AnalyticsEvent` enum to the appropriate Firebase methods.\n\nInternally 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.\n\nJust be aware that even if you declare multiple instances of `FirebaseAnalyticsEngine`, that they all reference the same Firebase SDK singleton.\n\nWhen 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.\n\n#### Simple use case: GoogleService-Info.plist file\nIf you include the standard Google plist file in your project, you may initialize `FirebaseAnalyticsEngine` like this:\n\n```swift\nimport YAnalyticsFirebase\n\nfinal class AppCoordinator {\n    let engine: AnalyticsEngine = FirebaseAnalyticsEngine()\n\n    func trackSomething(someData: [String: Any]?) {\n        engine.track(\n            event: .event(name: \"Something\", parameters: someData)\n        )\n    }\n}\n```\n\n#### Configuration\nThe Firebase iOS SDK lets you initialize using three methods:\n\n1. options\n2. name and options\n3. neither (GoogleService-Info.plist)\n\n`FirebaseAnalyticsEngineConfiguration` supports the same three matching options.\n\n```swift\nimport FirebaseCore\nimport YAnalyticsFirebase\n\nfinal class AppCoordinator {\n    let engine: AnalyticsEngine = {\n        let options: FirebaseOptions = ...\n        let config = FirebaseAnalyticsConfiguration(options: options)\n        return FirebaseAnalyticsEngine(configuration: config)\n    }()\n}\n```\n\nDependencies\n----------\n\nY—AnalyticsFirebase depends upon our [Y—Analytics](https://github.com/yml-org/yanalytics-ios) framework (which is also open source and Apache 2.0 licensed).\n\n\nInstallation\n----------\n\nYou can add Y—Analytics Firebase to an Xcode project by adding it as a package dependency.\n\n1. From the **File** menu, select **Add Packages...**\n2. Enter \"[https://github.com/yml-org/yanalytics-firebase-ios](https://github.com/yml-org/yanalytics-firebase-ios)\" into the package repository URL text field\n3. Click **Add Package**\n\nContributing to Y—Analytics Firebase\n----------\n\n### Requirements\n\n#### SwiftLint (linter)\n```\nbrew install swiftlint\n```\n\n#### Jazzy (documentation)\n```\nsudo gem install jazzy\n```\n\n### Setup\n\nClone the repo and open `Package.swift` in Xcode.\n\n### Versioning strategy\n\nWe utilize [semantic versioning](https://semver.org).\n\n```\n{major}.{minor}.{patch}\n```\n\ne.g.\n\n```\n1.0.5\n```\n\n### Branching strategy\n\nWe utilize a simplified branching strategy for our frameworks.\n\n* main (and development) branch is `main`\n* both feature (and bugfix) branches branch off of `main`\n* feature (and bugfix) branches are merged back into `main` as they are completed and approved.\n* `main` gets tagged with an updated version # for each release\n \n### Branch naming conventions:\n\n```\nfeature/{ticket-number}-{short-description}\nbugfix/{ticket-number}-{short-description}\n```\ne.g.\n```\nfeature/CM-44-button\nbugfix/CM-236-textview-color\n```\n\n### Pull Requests\n\nPrior to submitting a pull request you should:\n\n1. Compile and ensure there are no warnings and no errors.\n2. Run all unit tests and confirm that everything passes.\n3. Check unit test coverage and confirm that all new / modified code is fully covered.\n4. Run `swiftlint` from the command line and confirm that there are no violations.\n5. Run `jazzy` from the command line and confirm that you have 100% documentation coverage.\n6. Consider using `git rebase -i HEAD~{commit-count}` to squash your last {commit-count} commits together into functional chunks.\n7. If HEAD of the parent branch (typically `main`) has been updated since you created your branch, use `git rebase main` to rebase your branch.\n    * _Never_ merge the parent branch into your branch.\n    * _Always_ rebase your branch off of the parent branch.\n\nWhen submitting a pull request:\n\n* Use the [provided pull request template](.github/pull_request_template.md) and populate the Introduction, Purpose, and Scope fields at a minimum.\n* 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.\n\nWhen merging a pull request:\n\n* 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.\n* Make sure the branch is deleted upon merge (should be automatic).\n\n### Releasing new versions\n* Tag the corresponding commit with the new version (e.g. `1.0.5`)\n* Push the local tag to remote\n\nGenerating Documentation (via Jazzy)\n----------\n\nYou can generate your own local set of documentation directly from the source code using the following command from Terminal:\n```\njazzy\n```\nThis generates a set of documentation under `/docs`. The default configuration is set in the default config file `.jazzy.yaml` file.\n\nTo view additional documentation options type:\n```\njazzy --help\n```\nA 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/\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeandtheory%2Fyanalytics-firebase-ios","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeandtheory%2Fyanalytics-firebase-ios","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeandtheory%2Fyanalytics-firebase-ios/lists"}