easy_ab 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb6587e7ae47d2f3743e6dc6e6c053e40f993ac2
-  data.tar.gz: f74132d722d8dbb9f7dc275748770ecef6e406b1
+  metadata.gz: 50e5179b65bec859cfb55ecec25e5fd7698619ff
+  data.tar.gz: a938f51b36faa0c46cf31a02d0a831ecef4e8c9e
 SHA512:
-  metadata.gz: 7c88e4fd12e3c20de12c8a00cae041ca279080501b0f57869b345f651b7b83cb695d21d02ad6b940ed5f9501993afa92e3eb52eb8dafd2fc52718ddb1ff45456
-  data.tar.gz: 2e0014482e2275c87bcabeb39cbc90f78012d6338ddf2075e4c22de991c90a7554580c7d4a8f052cc65457724355606c8951c88d7c717c693307cfda92a6184a
+  metadata.gz: aa8c33658ef5294a3de560dcffe5fb085c9746382dbd60b00e7b1f9d223f7801fc55c81372032601e7136a25946ccfbeb3428afd45ce2861c053a1b3dc347fcb
+  data.tar.gz: 87e59b21a23a6748434bc3fe288edf83aab6e2150d4323915a5286232e78b876252aecf40cf3a2c384b2f987c214e3f62a6ef53ac117e93d6bf3c06f2c94cdec

data/README.md

@@ -41,15 +41,12 @@ Easy AB is under development. Currently don't use in your production app.
 ### Flipper
 ### ...
 
-# Installation
+# Installation & Setup
 
 * Add `gem 'easy_ab'` to your application's Gemfile and run `bundle install`.
 * Run `bin/rails g easy_ab:install`. Migration file and initializer will copy to your app folder.
 * Run `bin/rake db:migrate`
-
-# Setup
-
-Edit `config/initializers/easy_ab.rb` to setup basic configurations.
+* Edit `config/initializers/easy_ab.rb` to setup basic configurations.
 
 ```ruby
 EasyAb.configure do |config|
@@ -65,30 +62,30 @@ EasyAb.configure do |config|
 end
 ```
 
-# Getting Started
+# Usage
 
-Setup your experiments in `config/initializers/easy_ab.rb`
+Define your experiments in `config/initializers/easy_ab.rb`
 
-Say, if you have an experiment named 'button color', with three equal weighted variants: red, blue, green.
+Say, if you have an experiment named 'button_color', with three equal weighted variants: red, blue, green.
 
 Define your experiment as follows:
 
 ``` ruby
 EasyAb.experiments do |experiment|
-  experiment.define :title_color, variants: ['red', 'blue', 'green']
+  experiment.define :button_color, variants: ['red', 'blue', 'green']
 end
 ```
 
 Then you will be able to use the following helpers in controller or view:
 
 ```ruby
-color = ab_test(:title_color)
+color = ab_test(:button_color)
 ```
 
 or pass a block
 
 ```erb
-<% ab_test(:title_color) do |color| %>
+<% ab_test(:button_color) do |color| %>
   <h1 class="<%= color %>">Welcome!</h1>
 <% end %>
 ```
@@ -96,5 +93,79 @@ or pass a block
 For admin, specify a variant with url parameters makes debugging super easy:
 
 ```
-?ab_test[title_color]=blue
+?ab_test[button_color]=blue
+```
+
+You can specify weightings of each variant:
+
+``` ruby
+EasyAb.experiments do |experiment|
+  experiment.define :button_color,
+    variants: ['red', 'blue', 'green'],
+    weights:  [8, 1, 1] # Weights of variants can be any positive integers
+end
+```
+
+Then 80% of your users will see red button, and 10% for blue and green respectively.
+
+Also, by specifying rules with Proc or lambda, you can split users with more flexible way. For example, for the first 100 signed up users, if you wanna provide extra 90 days of paid features for them whenever they subscribe your service, and other users for extra 30 days:
+
+```ruby
+EasyAb.experiments do |experiment|
+  experiment.define :extra_vip_duration,
+    variants: ['90', '30'], # Variants are stored as string, you have handle the type conversion by yourself
+    rules: [
+      -> { current_user.id <= 100 },
+      -> { current_user.id > 100 }
+    ]
+end
+```
+
+Keep in mind that `ab_test()` helper always returns String. You have to handle the type conversion by yourself.
+
+```erb
+# In controller
+@extra_vip_duration = ab_test(:extra_vip_duration).to_i.days
+```
+
+# Others
+## Type of experiments
+Both String and Symbol are valid when defining experiment or passing to `ab_test`.
+
+```ruby
+# Define experiment as symbol (recommended)
+EasyAb.experiments do |experiment|
+  experiment.define :button_color,
+    variants: ['red', 'blue', 'green']
+end
+
+# In view/controller
+ab_test(:button_color)  # OK (recommended)
+ab_test('button_color') # OK
+```
+
+```ruby
+# Define experiment as String
+EasyAb.experiments do |experiment|
+  experiment.define 'button_color',
+    variants: ['red', 'blue', 'green']
+end
+
+# In view/controller
+ab_test(:button_color)  # OK
+ab_test('button_color') # OK
+```
+
+## Type of variants
+You can define variants as Symbol, but `ab_test()` always returns String
+
+```ruby
+# Define variants as symbol
+EasyAb.experiments do |experiment|
+  experiment.define :button_color,
+    variants: [:red, :blue, :green]
+end
+
+# In view/controller
+ab_test(:button_color).class # => String
 ```

data/lib/easy_ab/version.rb

@@ -1,3 +1,3 @@
 module EasyAb
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/generators/easy_ab/templates/easy_ab.rb

@@ -12,15 +12,13 @@ end
 
 EasyAb.experiments do |experiment|
   experiment.define :button_color,
-                    variants: ['red', 'blue', 'yellow'],
-                    weights:  [10, 3, 1]
-
-  experiment.define :title,
-                    variants: ['hello', 'welcome', 'yo'],
-                    rules: [
-                      -> { (1..100).cover?(current_user.id) },
-                      -> { current_user.id.odd? },
-                      -> { current_user.id.even? },
-                    ]
+    variants: ['red', 'blue', 'yellow'],
+    weights:  [8, 1, 1]
 
+  experiment.define :extra_vip_duration,
+  variants: ['90', '30'], # Variants stored as String, you must handle the conversion in your app by yourself
+  rules: [
+    -> { current_user.id <= 100 },
+    -> { current_user.id > 100 }
+  ]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_ab
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Gary Chu