vanity 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0456d4b28fe4ce9c097421b2b808846d4347b1f09221224b971d887ac426d118
-  data.tar.gz: 8b1af8dbe98eee9d186940c402228d7ba80463b3c6f141c8bee6efa0901c1b3b
+  metadata.gz: c54611b7ef436ec37192b30fa8451ab592b7117df14f3d3937747484b8b9a299
+  data.tar.gz: 7601b961767d868205a68bf02f5a44447c01f01083f5d53d4a8d7ab242c0f0fc
 SHA512:
-  metadata.gz: 1f5a94133798c016357e41cc3c57edafc4b74402b54803531074c10ee7595d8218cbb02d34adf911c32e82265d3ee3215201bd8fb6a880e7b51d85784e080330
-  data.tar.gz: 59e988be523633654f628e212f5953d1a92d140f9e2e2dc1ecfe827b48475814f6690f0f399e6511396ca7c81e4d206fb392698778ff3674907cacdd2bb4b5d7
+  metadata.gz: 60f112ca86a32c938d762699cfc40e24ccb662294ac4059ff12035af6785a3ed294f56ffb2c99c1519bb254fab438062f39cd7b62b87f6df452180066c3d515a
+  data.tar.gz: 382f2fc0afcc52d375594d2586bb41a46f7bc6f3812d242de725cf9828bbb4c82938daf1e8a29e61ddcdfa82844433f8d5d9dec05d5c960d4a01c4eccf8de203

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 3.1.0 (2022-01-29)
+
+* Invoke on_assignment callback after assignment is stored in database; add global on_assignment callback (@frostmark)
+
 == 3.0.2 (2022-01-27)
 
 * Fix AbTest#alternative_for to always prefer persisted participants (@tgrathwell)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vanity (3.0.2)
+    vanity (3.1.0)
       i18n
 
 GEM

data/gemfiles/rails42.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (3.0.2)
+    vanity (3.1.0)
       i18n
 
 GEM

data/gemfiles/rails42_protected_attributes.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (3.0.2)
+    vanity (3.1.0)
       i18n
 
 GEM

data/gemfiles/rails51.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (3.0.2)
+    vanity (3.1.0)
       i18n
 
 GEM

data/gemfiles/rails52.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (3.0.2)
+    vanity (3.1.0)
       i18n
 
 GEM

data/gemfiles/rails60.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (3.0.2)
+    vanity (3.1.0)
       i18n
 
 GEM

data/gemfiles/rails61.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (3.0.2)
+    vanity (3.1.0)
       i18n
 
 GEM

data/lib/vanity/configuration.rb

@@ -49,6 +49,7 @@ module Vanity
       on_datastore_error: ->(error, klass, method, arguments) {
         default_on_datastore_error(error, klass, method, arguments)
       },
+      on_assignment: nil,
       request_filter: ->(request) { default_request_filter(request) },
       templates_path: File.expand_path(File.join(File.dirname(__FILE__), 'templates')),
       use_js: false,
@@ -181,6 +182,9 @@ module Vanity
     # Cookie path. If true, cookie will not be available to JS. By default false.
     attr_writer :cookie_httponly
 
+    # Default callback on assigment
+    attr_writer :on_assignment
+
     # We independently list each attr_accessor to includes docs, otherwise
     # something like DEFAULTS.each { |key, value| attr_accessor key } would be
     # shorter.

data/lib/vanity/experiment/ab_test.rb

@@ -617,13 +617,15 @@ module Vanity
       # Saves the assignment of an alternative to a person and performs the
       # necessary housekeeping. Ignores repeat identities and filters using
       # Playground#request_filter.
-      def save_assignment(identity, index, request)
+      def save_assignment(identity, index, _request)
         return if index == connection.ab_showing(@id, identity)
+        return if connection.ab_seen @id, identity, index
 
-        call_on_assignment_if_available(identity, index)
         rebalance_if_necessary!
 
         connection.ab_add_participant(@id, index, identity)
+        call_on_assignment_if_available(identity, index)
+
         check_completion!
       end
 
@@ -633,13 +635,18 @@ module Vanity
       end
 
       def call_on_assignment_if_available(identity, index)
+        assignment = alternatives[index]
+
         # if we have an on_assignment block, call it on new assignments
         if defined?(@on_assignment_block) && @on_assignment_block
-          assignment = alternatives[index]
-          if !connection.ab_seen @id, identity, index
-            @on_assignment_block.call(Vanity.context, identity, assignment, self)
-          end
+          @on_assignment_block.call(Vanity.context, identity, assignment, self)
+
+          return
         end
+
+        return unless Vanity.configuration.on_assignment.is_a?(Proc)
+
+        Vanity.configuration.on_assignment.call(Vanity.context, identity, assignment, self)
       end
 
       def rebalance_if_necessary!
@@ -688,10 +695,8 @@ module Vanity
         # We're really only interested in 90%, 95%, 99% and 99.9%.
         Z_TO_PROBABILITY = [90, 95, 99, 99.9].map { |pct| [norm_dist.find { |x,a| a >= pct }.first, pct] }.reverse
       end
-
     end
 
-
     module Definition
       # Define an A/B test with the given name. For example:
       #   ab_test "New Banner" do
@@ -701,6 +706,5 @@ module Vanity
         define name, :ab_test, &block
       end
     end
-
   end
 end

data/lib/vanity/version.rb

@@ -1,5 +1,5 @@
 module Vanity
-  VERSION = "3.0.2"
+  VERSION = "3.1.0"
 
   module Version
     version = VERSION.to_s.split(".").map { |i| i.to_i }

data/test/experiment/ab_test.rb

@@ -520,6 +520,46 @@ class AbTestTest < ActionController::TestCase
     end
   end
 
+  def test_calls_default_on_assignment
+    on_assignment_called_times = 0
+
+    Vanity.configuration.on_assignment = proc do |_controller, _identity, _assignment|
+      on_assignment_called_times += 1
+    end
+
+    new_ab_test :foobar do
+      alternatives "foo", "bar"
+      default "foo"
+      identify { "6e98ec" }
+      metrics :coolness
+    end
+
+    2.times { experiment(:foobar).chooses("foo") }
+    assert_equal 1, on_assignment_called_times
+  end
+
+  def test_calls_on_assignment_defined_in_experiment
+    expected_value = 0
+
+    Vanity.configuration.on_assignment = proc do |_controller, _identity, _assignment|
+      expected_value = 1
+    end
+
+    new_ab_test :foobar do
+      alternatives "foo", "bar"
+      default "foo"
+      identify { "6e98ec" }
+      metrics :coolness
+
+      on_assignment do |_controller, _identity, _assignment|
+        expected_value = 20
+      end
+    end
+
+    2.times { experiment(:foobar).chooses("foo") }
+    assert_equal 20, expected_value
+  end
+
   # -- ab_assigned --
 
   def test_ab_assigned

data/test/playground_test.rb

@@ -130,5 +130,4 @@ describe Vanity::Playground do
       assert_equal [[Vanity.playground.experiment(:foobar), alt]], Vanity.playground.participant_info("abcdef")
     end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vanity
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Assaf Arkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -295,7 +295,7 @@ metadata: {}
 post_install_message: To get started run vanity --help
 rdoc_options:
 - "--title"
-- Vanity 3.0.2
+- Vanity 3.1.0
 - "--main"
 - README.md
 - "--webcvs"