https://github.com/lengocduy/dlanalytics
Unify and modularize abstract Analytics framework written in Swift
https://github.com/lengocduy/dlanalytics
analytics improvement logging strategic-planning tracking ux-ui
Last synced: 9 months ago
JSON representation
Unify and modularize abstract Analytics framework written in Swift
- Host: GitHub
- URL: https://github.com/lengocduy/dlanalytics
- Owner: lengocduy
- License: mit
- Created: 2020-07-22T08:09:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-29T18:54:50.000Z (over 4 years ago)
- Last Synced: 2025-04-11T23:52:02.712Z (9 months ago)
- Topics: analytics, improvement, logging, strategic-planning, tracking, ux-ui
- Language: Ruby
- Homepage: https://lengocduy.github.io/DLAnalytics/
- Size: 970 KB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# DLAnalytics
[](http://cocoapods.org/pods/DLAnalytics)
[](http://cocoapods.org/pods/DLAnalytics)
[](http://cocoapods.org/pods/DLAnalytics)
[](https://github.com/Carthage/Carthage)
Abstract Analytics Framework supports:
- Unify Analytics.
- Modularize, Centralize Analytics.
- Plugin the new Analytics easier.
- Standadize tracking method and event.
## Requirements
- Xcode 12+
- Swift 5.0+
## How
### Setup
1. Implement your AnalyticsService.
```
class ClientAnalyticsImpl: AnalyticsService {
// Specify whitelist events. Accept all events by default
var allowEvents: Set {
Set(arrayLiteral: "\(InputOTPEvent.self)", "\(CheckoutEvent.self)")
}
func setUserIdentifyProperty(_ property: [String : String]) {
// To support identify the user"
}
func reset() {
// reset all data related to the user e.g user logout"
}
func send(event: AnalyticsEvent) {
// Specific Analytics implementation e.g FireBaseAnalytics, MixPanel, etc.
print("### Send an event name: \(event.name), payload = \(event.payload)")
}
func send(event: AnalyticsEvent, from viewController: DLAnalytics.ViewController) {
print("### Send an event name: \(event.name), controller = \(ViewController.self)" )
}
}
```
2. Declare your custom event.
```
// MARK: - Support dynamic configurable payload for an event
struct InputOTPEvent: AnalyticsEvent {
private(set) var payload: [String: String]
var name: String {
return "InputOTP"
}
static func inputOTPSuccess() -> InputOTPEvent {
return InputOTPEvent(payload: ["OTPValid": "1"])
}
}
// MARK: - Enum support static configurable payload for an event
@frozen
enum CheckoutEvent: String, AnalyticsEvent {
case success = "Checkout_Success"
case error = "Checkout_Error"
internal var payload: [String: Any] {
return [:]
}
var name: String {
return rawValue
}
}
```
3. Register your custom AnalyticsService.
```
let analyticsService = ClientAnalyticsImpl()
Analytics.registerAnalyticsService(analyticsService)
```
### Use
```
/// Simulate tracking event InputOTP success
Analytics.send(event: InputOTPEvent.inputOTPSuccess())
Analytics.send(event: CheckoutEvent.success, from viewController: checkoutVC)
/// Output:
Send an event name: InputOTP, payload = ["OTPValid": "1"]
Send an event name: Checkout_Success, controller = CheckoutViewController
```
## Installation
There are three ways to install `DLAnalytics`
### CocoaPods
Just add to your project's `Podfile`:
```
pod 'DLAnalytics', '~> 2.1'
```
### Carthage
Add following to `Cartfile`:
```
github "lengocduy/DLAnalytics" ~> 2.1
```
- To building platform-independent xcframeworks Xcode 12 and above [here](https://github.com/Carthage/Carthage#building-platform-independent-xcframeworks-xcode-12-and-above)
- To migrating from framework bundles to xcframework [here](https://github.com/Carthage/Carthage#migrating-a-project-from-framework-bundles-to-xcframeworks)
### Swift Package Manager
Create a `Package.swift` file:
```
// swift-tools-version:5.0
import PackageDescription
let package = Package(
name: "TestDLAnalytics",
dependencies: [
.package(url: "https://github.com/lengocduy/DLAnalytics.git", from: "2.1.0"),
],
targets: [
.target(
name: "TestDLAnalytics",
dependencies: ["DLAnalytics"])
]
)
```
## Architecture
## Interaction Flow
## License
DLAnalytics is available under the MIT license. See the [LICENSE](LICENSE) file for more info.