easy_ab 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c7eddf36ea57f8a4c34fa66755ad8d93a55aeca
-  data.tar.gz: e25036d29777b725fdc401bd5315fadeee044523
+  metadata.gz: be25942ed3b823b7bf8b4445eee642f884d6cff2
+  data.tar.gz: dc77331ec7b69a4a4c0f3cca37e3d7cd46b922bc
 SHA512:
-  metadata.gz: afcc1ccfa3b319b894223e85997107dc1df50fbd2ba57fb70b7c1d0bb9d0886889c46a8e00694a4eb535923e116b1dfa2bc4564f4aa1bc7f375e120739ffc56e
-  data.tar.gz: 78e202157604d52dd71f90a3aab4905c32ab70bc4cfc4f19042568336350897c6d10138c1226df3e1c5923113ffda7d2a84a9ecf4c9e6855f84afe7f8b8ce400
+  metadata.gz: 780ccb7138c2e6d0671fe6d2b1eda79cd04b68e517c941e22ce4fab91a89b31a937297a0e5f103e947db5c6d3e23fcdd3f33b0262f890039a6d90118d2674920
+  data.tar.gz: 11c2df2ef9ab91699e7c52b05894aff91fcaeb273d82a4adccee60849a943824f8b6cd2e42323501d8ef6f33ff059b61b604da29563b0cfeb0c93b2420403822

data/CHANGELOG.md

@@ -1,2 +1,5 @@
+# 0.1.0
+* Support winner
+
 # 0.0.3
 * Add new API `all_participated_experiments` to list current user's all participated experiments

data/README.md

@@ -7,8 +7,7 @@ Easy, flexible A/B testing tool for Rails.
 * Grouping your users to your predefined variants with very easy and flexible way:
   * Random with equal weightings.
   * Random with predefined weightings.
-  * Define Proc(s) to setup your rules. Something like "sign up for 1 month to variant A, others to variant B", "user with odd id to variant A, with even id to variant B", ...
-  Example of using proc to define rules:
+  * Define Proc(s) to setup your rules. Something like "sign up for 1 month to variant A, others to variant B", "user with odd id to variant A, with even id to variant B", ..., etc. Example of using proc to define rules:
 
   ```ruby
   # Example 1
@@ -30,9 +29,10 @@ Easy, flexible A/B testing tool for Rails.
   * check your view for different variants
   * output all experiments and the corresponding variants for your users. It's very useful when sending data to analytics services like Google Anayltics, Mixpanel, Kissmetrics, ...
 * No DSL, just setup your rules with pure Ruby (and Rails) :)
+* Supports Rails 4 and 5
 
-# Notice
-Easy AB is under development and is in beta phase. Be sure to test before integrating with your production app.
+# Changelog
+[Click me](https://github.com/icarus4/easy_ab/blob/master/CHANGELOG.md)
 
 # Installation & Setup
 
@@ -69,7 +69,7 @@ EasyAb.experiments do |experiment|
 end
 ```
 
-Then you will be able to use the following helpers in controller or view:
+Then you will be able to use `ab_test` helpers in controller or view:
 
 ```ruby
 color = ab_test(:button_color)
@@ -79,7 +79,7 @@ or pass a block
 
 ```erb
 <% ab_test(:button_color) do |color| %>
-  <h1 class="<%= color %>">Welcome!</h1>
+  <button class="<%= color %>">Click Me!</button>
 <% end %>
 ```
 
@@ -114,13 +114,38 @@ EasyAb.experiments do |experiment|
 end
 ```
 
+NOTICE: rules are executed in the order you defined in `config/initializers/easy_ab.rb`. If there are intersections among your rules, the former rule will be applied. For example:
+
+```ruby
+EasyAb.experiments do |experiment|
+  experiment.define :extra_vip_duration,
+    variants: ['90', '30']
+    rules: [
+      -> { current_user.id <= 20 },
+      -> { current_user.id > 10 }
+    ]
+
+# Users with id between 11 to 20 matches both lambdas, will get variant '90'
+```
+
 Keep in mind that `ab_test()` helper always returns String. You have to handle the type conversion by yourself.
 
-```erb
+```ruby
 # In controller
 @extra_vip_duration = ab_test(:extra_vip_duration).to_i.days
 ```
 
+
+When an experiment is finished, you can remove the experiment from `easy_ab.rb`, or specify the winner. `ab_test()` always returns the winner:
+
+```ruby
+EasyAb.experiments do |experiment|
+  experiment.define :button_color,
+    variants: ['red', 'blue', 'green'],
+    winner: 'red'
+end
+```
+
 You can dump experiment data of current user to analytics services (Mixpanel, Google Analytics, etc.) by `all_participated_experiments`
 
 ```erb
@@ -134,7 +159,7 @@ You can dump experiment data of current user to analytics services (Mixpanel, Go
 </script>
 ```
 
-The return format of `all_participated_experiments`
+The return format of `all_participated_experiments`:
 
 ```ruby
 {
@@ -189,4 +214,7 @@ ab_test(:button_color).class # => String
 # Todo
 * Add comparisons with existing A/B testing gems
 * Convertion rate
-* Test code
+* Test code
+
+# Copyright
+MIT License © 2017 Gary Chu (icarus4).

data/lib/easy_ab/experiment.rb

@@ -1,17 +1,19 @@
 module EasyAb
   class Experiment
-    attr_reader :name, :variants, :weights, :rules
+    attr_reader :name, :variants, :weights, :rules, :winner
 
     def initialize(name, options = {})
-      @name = name.to_s
-      @variants = options[:variants]
-      @weights = options[:weights]
-      @rules = options[:rules]
+      @name     = name.to_s
+      @variants = options[:variants].map(&:to_s)
+      @weights  = options[:weights]
+      @rules    = options[:rules]
+      @winner   = options[:winner].nil? ? nil : options[:winner].to_s
 
       raise ArgumentError, 'Please define variants' if @variants.blank?
       raise ArgumentError, 'Number of variants and weights should be identical' if @weights.present? && @weights.size != @variants.size
       raise ArgumentError, 'Number of variants and rules should be identical' if @rules.present? && @rules.size != @variants.size
       raise ArgumentError, 'All rules should be a Proc' if @rules.present? && @rules.any? { |rule| !rule.is_a?(Proc) }
+      raise ArgumentError, 'winner should be one of variants' if @winner && !@variants.include?(@winner)
     end
 
     def self.find_by_name!(experiment_name)
@@ -22,10 +24,12 @@ module EasyAb
     end
 
     def assign_variant(user_recognition, options = {})
+      return winner if winner
+
       grouping = find_grouping_by_user_recognition(user_recognition) || ::EasyAb::Grouping.new(experiment: name, user_id: user_recognition[:id], cookie: user_recognition[:cookie])
 
-      if options[:variant] && variants.include?(options[:variant])
-        grouping.variant = options[:variant]
+      if options[:variant] && variants.include?(options[:variant].to_s)
+        grouping.variant = options[:variant].to_s
       else
         grouping.variant ||= flexible_variant(options[:contexted_rules])
       end

data/lib/easy_ab/version.rb

@@ -1,3 +1,3 @@
 module EasyAb
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

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

@@ -11,14 +11,14 @@ EasyAb.configure do |config|
 end
 
 EasyAb.experiments do |experiment|
-  experiment.define :button_color,
-    variants: ['red', 'blue', 'yellow'],
-    weights:  [8, 1, 1]
+  # experiment.define :button_color,
+  #   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 }
-  ]
+  # 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_ab
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Gary Chu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-08 00:00:00.000000000 Z
+date: 2017-08-09 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: icarus4.chu@gmail.com