https://github.com/recruit-mp/ABKit
AB testing framework for iOS
https://github.com/recruit-mp/ABKit
Last synced: 7 months ago
JSON representation
AB testing framework for iOS
- Host: GitHub
- URL: https://github.com/recruit-mp/ABKit
- Owner: recruit-mp
- License: mit
- Created: 2016-02-12T05:29:25.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-11-02T14:23:16.000Z (over 8 years ago)
- Last Synced: 2024-12-03T20:36:48.221Z (over 1 year ago)
- Language: Swift
- Homepage:
- Size: 11.4 MB
- Stars: 112
- Watchers: 183
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - ABKit - AB testing framework for iOS. (Testing / A/B Testing)
- awesome-ios-star - ABKit - AB testing framework for iOS. (Testing / A/B Testing)
- fucking-awesome-ios - ABKit - AB testing framework for iOS. (Testing / A/B Testing)
README
# ABKit
Split Testing for Swift.
ABKit is a library for implementing a simple Split Test that:
- Doesn't require an HTTP client
- written in Pure Swift
# Installation
## CocoaPods
To integrate ABKit into your Xcode project using CocoaPods, specify it in your `Podfile`:
```rb
pod 'ABKit'
```
Then, run the following command:
```
$ pod install
```
# Usage
## A/B Test
```swift
let defaultVersion = Version(name: "A") { version in print("Pattern \(version.name)") }
let test = SplitTest(name: "Sample A/B test", defaultVersion: defaultVersion)
let b = Version(name: "B") { version in print("Pattern \(version.name)") }
test.addVersion(b, weight: 0.5)
test.run() // A(Default Version) = 50%, B = 50%
```
## Split Test with Weighted Probabilities
```swift
let defaultVersion = Version(name: "A") { version in print("Pattern \(version.name)") }
let test = SplitTest(name: "Sample split test", defaultVersion: defaultVersion)
let b = Version(name: "B") { version in print("Pattern \(version.name)") }
test.addVersion(b, weight: 0.2)
let c = Version(name: "C") { version in print("Pattern \(version.name)") }
test.addVersion(c, weight: 0.3)
test.run() // A(Default Version) = 50%, B = 20%, C = 30%
```
## Conditional Test
```swift
let defaultVersion = Version(name: "A") { version in print("Pattern \(version.name)") }
let test = ConditionalTest(name: "Sample conditional test", defaultVersion: defaultVersion)
let b = Version(name: "B") { version in print("Pattern \(version.name)" }
test.addVersion(b) { user in user.age < 20 }
let user = User(name: "naoty", age: 28)
test.run(user) // If user.age < 20 is true, B will be run otherwise A will be run.
```
## Pro Tips
* `ABKit` selects one of the versions using a random number, which is saved in `RandomNumberRepository`. By default, `ABKit` uses `NSUserDefault` as `RandomNumberRepository`. You can save it in any storage by implementing `RandomNumberRepository` protocol.
* You can specify an arbitrary number as the random number using `-setRandomNumber(_:)` and reset a random number using `-deleteRandomNumber()` for `SplitTest`.
## License
ABKit is available under the MIT license. See the LICENSE file for more info.