easy_ab 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1eeea1cbf4338159b42eb100e86cf1bae045b7a
-  data.tar.gz: dbdb41940f2da5113a705c30bc290934219666b7
+  metadata.gz: 6a56efe571167899ce6a67e013c3815c3ac9bd8b
+  data.tar.gz: 8a3b0357ce34f6e420e7aa10276afc3a09eb1266
 SHA512:
-  metadata.gz: 4b2465ffa608c615f52c9f2a3c153323848d2a5d5c8871a906e33492ba927da27a6890b6c1baf524f72e02045907d67906f2619d36e78559e3720af7900f939d
-  data.tar.gz: 00525589553175a0feac4fc7cf4f2b1c7936885792009f08e82393f988638723c9d593b31db63f9ef1ed27bdaecd3ed72266928beddd51ecc7275f280bd74c6a
+  metadata.gz: 1315a89fd9ad3cb5e1fede3ab862c6608222cbe5faba02b2604a8eff3cd3b66c875a90d95ca4a89db687f56a3fb408dedbed7ee8b47c66f5915901171b02536b
+  data.tar.gz: 5e40c5b8f23e94a782e2a9b9dcb9f66711384be59b734bff18281e5adb1eeb25ca85db7dd0465d7eb36942dbb401e02be3c23eebfe18d519b0546afbca8f9ccf

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# HEAD
+* Supports scope in config to define whether a user can join an experiment or not.
+
 # 0.2.0 (2017-08-15)
 * **API change**: If all rules failed, `ab_test` returns nil, instead of the first variant.
 

data/lib/easy_ab/experiment.rb

@@ -1,18 +1,20 @@
 module EasyAb
   class Experiment
-    attr_reader :name, :variants, :weights, :rules, :winner
+    attr_reader :name, :variants, :weights, :rules, :winner, :scope
 
     def initialize(name, options = {})
       @name     = name.to_s
       @variants = options[:variants].map(&:to_s)
       @weights  = options[:weights]
       @rules    = options[:rules]
+      @scope    = options[:scope]
       @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, 'Scope should be a Proc' if @scope.present? && !@scope.is_a?(Proc)
       raise ArgumentError, 'winner should be one of variants' if @winner && !@variants.include?(@winner)
     end
 
@@ -23,14 +25,24 @@ module EasyAb
       exp
     end
 
+    # Priority:
+    # 1. winner
+    # 2. url parameter or assign variant (ex: ab_test(:experiment, variant: 'variant A'))
+    # 3. scope
+    # 4. rules/weights
     def assign_variant(user_recognition, options = {})
+      # 1. winner
       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])
 
+      # 2. url parameter or assign variant
       if options[:variant] && variants.include?(options[:variant].to_s)
         grouping.variant = options[:variant].to_s
       else
+        # 3. scope
+        return nil if options[:scope] && !options[:scope].call
+        # 4. rules/weights
         grouping.variant ||= flexible_variant(options[:contexted_rules])
         return nil if grouping.variant.nil?
       end

data/lib/easy_ab/helpers.rb

@@ -15,11 +15,18 @@ module EasyAb
 
       experiment = EasyAb::Experiment.find_by_name!(experiment_name)
 
+      # Obtain context
       if experiment.rules.present?
         @rules_with_current_context ||= experiment.rules.map { |rule| Proc.new { instance_exec(&rule)} }
         options[:contexted_rules] = @rules_with_current_context
       end
 
+      # Obtain context
+      if experiment.scope.present?
+        @scope ||= Proc.new { instance_exec(&experiment.scope) }
+        options[:scope] = @scope
+      end
+
       @variant_cache ||= {}
       @variant_cache[experiment_name] ||= experiment.assign_variant(user_recognition, options)
       block_given? ? yield(@variant_cache[experiment_name]) : @variant_cache[experiment_name]

data/lib/easy_ab/version.rb

@@ -1,3 +1,3 @@
 module EasyAb
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_ab
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gary Chu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-15 00:00:00.000000000 Z
+date: 2017-08-16 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: icarus4.chu@gmail.com