vanity 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 785019e8d6f59f84073d7645a9b8a12c7c07edf0
-  data.tar.gz: 75b44173bbc79629b5c70d6bc545e3cdffb73962
+  metadata.gz: c9f59504780981f9e1f351de1afd9774374ca1d4
+  data.tar.gz: 2a211bbebf1c899a256bbfa81f86a161e91155ed
 SHA512:
-  metadata.gz: a5b228f3a04a5f28db6a9c927b685c211340f3d6f4612e156d533683b35ede1089571c22119ff1db522259cb285948c63fba9d0c1b78ce9624f8c48b85ffb4ba
-  data.tar.gz: 1b337660bc064b51074dfd3979cfa32696b4a103d98ad1adac987e58376f613a8a384a8f58423a317a36b08ec94f39784688477053347281918f5278b19e5a52
+  metadata.gz: d464e14f4116528ffdd94196daadb15a285d20e011262a19cbe91b567c38b822ceae28daf510f759681fd84a0f6d484959d53d8e24706d59674d9a737768107f
+  data.tar.gz: cb0c09bf9293ffbc677fbd2260bc5dc5c19d3daade26fbec926d9f4e17dcfd12a71222fae552b1daa11d4d3a8e285a2d6b176c593d15d394b0ad2135dbe50695

data/.travis.yml

@@ -4,7 +4,7 @@ language: ruby
 before_script:
   - 'echo ''gem: --no-ri --no-rdoc'' > ~/.gemrc' # skip installing docs for gems
 before_install:
-  - gem install bundler -v="1.8.0" # Minimum version of bundler required
+  - gem install bundler -v ">= 1.8.0" # Minimum version of bundler required
 bundler_args: --without development
 script: 'bundle exec rake test'
 services:
@@ -14,6 +14,7 @@ rvm:
   - 2.0.0
   - 2.1.0
   - 2.2.0
+  - 2.3.0
   - jruby-19mode
 env:
   - DB=mongodb

data/Appraisals

@@ -5,6 +5,7 @@ appraise "rails32" do
   gem "minitest_tu_shim", "~> 1.3.3", :platforms => :mri_22
   gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
   gem "passenger", "~>3.0"
+  gem "test-unit", "~> 3.0"
 end
 
 appraise "rails41" do

data/CHANGELOG

@@ -1,3 +1,9 @@
+== 2.1.1 (2015-1-19)
+
+* Allow method passed to `use_vanity` to return NullObjects. (@phillbaker)
+* Add testing support for ruby 2.3. (@phillbaker)
+* Add `reject` method to experiment definition. #290 (@peterkovacs)
+
 == 2.1.0 (2015-1-19)
 
 Add ability to define test alternatives with custom probabilities, #283. (@peterkovacs)

data/Gemfile

@@ -11,7 +11,7 @@ gem "mongo"
 
 # Math libraries
 gem "integration", "<= 0.1.0"
-gem "rubystats"
+gem "rubystats", ">= 0.2.4"
 
 # APIs
 gem "garb", "< 0.9.2", :require => false # API changes at this version

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vanity (2.1.0)
+    vanity (2.1.1)
       i18n
 
 GEM
@@ -93,7 +93,7 @@ GEM
     redis (3.0.6)
     redis-namespace (1.3.2)
       redis (~> 3.0.4)
-    rubystats (0.2.3)
+    rubystats (0.2.4)
     safe_yaml (1.0.4)
     sass (3.4.13)
     sqlite3 (1.3.10)
@@ -118,7 +118,7 @@ DEPENDENCIES
   activerecord-jdbc-adapter
   appraisal (~> 1.0.2)
   bson_ext
-  bundler (>= 1.0.0)
+  bundler (>= 1.8.0)
   fakefs
   garb (< 0.9.2)
   integration (<= 0.1.0)
@@ -130,7 +130,7 @@ DEPENDENCIES
   rake
   redis (>= 2.1)
   redis-namespace (>= 1.1.0)
-  rubystats
+  rubystats (>= 0.2.4)
   sqlite3 (~> 1.3.10)
   timecop
   vanity!

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Assaf Arkin
+Copyright (c) 2009-2016 Assaf Arkin and Contributors 
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -100,10 +100,17 @@ development:
   active_record_adapter: sqlite3
   database: db/development.sqlite3
 test:
-  collecting: false
-production:
   adapter: active_record
   active_record_adapter: default
+  collecting: false
+production:
+  active_record_adapter: postgresql
+  <% uri = URI.parse(ENV['DATABASE_URL']) %>
+  host:     <%= uri.host %>
+  username: <%= uri.username %>
+  password: <%= uri.password %>
+  port:     <%= uri.port %>
+  database: <%= uri.path.sub('/', '') %>
 ```
 
 If you're going to store data in the database, run the generator and
@@ -251,6 +258,9 @@ Here's what's tested and known to work:
     Ruby 2.2
       Persistence: Redis, Mongo, ActiveRecord
       Rails: 3.2, 4.1, 4.2
+    Ruby 2.3
+      Persistence: Redis, Mongo, ActiveRecord
+      Rails: 3.2, 4.1, 4.2
 
 ## Testing
 
@@ -259,6 +269,9 @@ an experiment. This may be done using the `chooses` method. For example:
 
 ```ruby
 Vanity.playground.experiment(:price_options).chooses(19)
+```
+
+See [the docs on testing](http://vanity.labnotes.org/ab_testing.html#test) for more.
 
 ## Updating documentation
 

data/doc/ab_testing.textile

@@ -51,6 +51,9 @@ The other half will see this one:
 <a href="#" style="font:14pt;font-weight:bold">Sign up</a>
 </notextile>
 
+
+h3(#interpret). Interpreting the Results
+
 An A/B test has two parts, we just covered the part which decides which alternative to show.  The second part measures the effectiveness of each alternative.  This happens as result of measuring the metric.
 
 Remember that we're measuring signups, so we already have this in the code:
@@ -65,8 +68,6 @@ end
 </pre>
 
 
-h3(#interpret). Interpreting the Results
-
 We're going to let the experiment run for a while and track the results using "the dashboard":rails.html#dashboard, or by running the command @vanity report@.
 
 Vanity splits the audience randomly -- using "cookies and other mechanisms":identity.html -- and records who got to see each alternative, and how many in each group converted (in our case, signed up).  Dividing conversions by participants gives you the conversion rate.
@@ -137,6 +138,32 @@ end
 <% end %>
 </pre>
 
+h3(#weights). Weighted alternatives & Multi-arm bandits
+
+By default, for n variations, Vanity will assign each of those with a probability of 1/n. If non-uniform weights for alternatives are desired, weights can be assigned to different alternatives. For example:
+
+<pre>
+ab_test "Background color" do
+  metrics :coolness
+  alternatives "red" => 10, "blue" => 5, "orange => 1
+  default "red"
+end
+</pre>
+
+This would make "red" 10 times as likely to appear as orange. (Note that these are weights, not percentanges, so the probability of assigning red above is about 62%, while blue is 31% and orange is 6%.) This is useful, for example, to assign a higher weight to a 'control' variation to ensure that most users continue having the default experience while assigning lower probabilities to test variations.
+
+h4(#bandits). Multi-arm bandits
+
+Another alternative to uniform splits of traffic is called "multi-armed bandits", and the specific implementation included is Bayesian. In this mode, most traffic is sent to the currently best performing alternative (called exploitation). The minority of traffic is split between the available alternatives (called exploration). Since worse performing alternatives receive much less traffic, this leads to higher average conversion rates in bandit-driven experiments than traditional A/B split testing. The disadvantage is that in the worst case scenario, it can take a lot more traffic to declare a conclusion with statistical significance.
+
+This can be enabled in the experiment definition, for example:
+<pre>
+ab_test "noodle_test" do
+  alternatives "spaghetti", "linguine"
+  metrics :signup
+  score_method :bayes_bandit_score
+end
+</pre>
 
 h3(#test).  A/B Testing and Code Testing
 

data/doc/identity.textile

@@ -9,29 +9,45 @@ For effective A/B tests, you want to:
 # Know which alternative you're showing and tracking
 # When running multiple tests at once, keep them independent
 
-Vanity will assign each visitor a unique identifier and store it in a cookie that persists across sessions.  That way, each visitor will get to see the same alternatives on repeating visits.  Assuming they use the same browser on all visits.
+Vanity can assign each visitor a unique identifier and store it in a cookie that persists across sessions. That way, each visitor will get to see the same alternatives on repeating visits. (Assuming they use the same browser on all visits.)
 
-If you have a better way of tracking visitors, e.g. using sign in, you'll want to use that instead.  That way the same person gets treated to the same experiment, even if they switch between machines and browsers.
+If you have a more persistant way of tracking visitors, e.g. using sign in, you'll want to use that instead. That way the same person gets treated to the same experiment, even if they switch between machines and browsers.
 
-You can choose either option using the @use_vanity@ method.  In the first case, just call @use_vanity@ from within the @ApplicationController@.  In the second case, you'll want to pass @use_vanity@ either a block that returns an identity value, or the name of a method that returns an object which provides the identity.
+You can choose either option using the @use_vanity@ method.  In the first case, just call @use_vanity@ from within the @ApplicationController@. In the second case, you'll want to pass @use_vanity@ either a block that returns an identity value, or the name of a method that returns an object which provides the identity when @id@ is called on it. If you pass a method name and it returns @nil@, Vanity will fallback on the persistent cookie mechanism.
 
-Sounds complicated?  These two examples are equivalent:
+Sounds complicated? These two examples are equivalent:
 
 <pre>
 class ApplicationController < ActionController::Base
   use_vanity :current_user
+
+  def current_user
+    User.find(session[:user_id])
+  end
 end
 </pre>
 
 <pre>
 class ApplicationController < ActionController::Base
-  use_vanity { |c| c.current_user && c.current_user.id }
+  use_vanity :current_user
+
+  def current_user
+    user = User.find(session[:user_id])
+
+    user if user && user.id
+  end
 end
 </pre>
 
-If you use either block or method name and they return @nil@, Vanity will fallback on persistent cookie mechanism.
+If @current_user@ does not return @nil@ for non-persisted accounts, e.g. it returns a @NullUser@, the @id@ call should return @nil@.
 
-Note that @current_user@ in this case must return @nil@ for non-persisted accounts.  That is, @current_user.id@ *must* be non-@nil@.
+If you pass a block, it must return a non-nil value. For example:
+
+<pre>
+class ProjectController < ApplicationController
+  use_vanity { |controller| controller.params[:project_id] ||  }
+end
+</pre>
 
 An identity can be anything.  For example, if you're running an experiment to test a new feature that will be available in some projects but not others, you'll want to slice the audience by project identifier, not user ID.
 

data/gemfiles/rails32.gemfile

@@ -7,7 +7,7 @@ gem "redis", ">= 2.1"
 gem "redis-namespace", ">= 1.1.0"
 gem "mongo"
 gem "integration", "<= 0.1.0"
-gem "rubystats"
+gem "rubystats", ">= 0.2.4"
 gem "garb", "< 0.9.2", :require => false
 gem "timecop", :require => false
 gem "webmock", :require => false
@@ -18,6 +18,7 @@ gem "rails", "3.2.22"
 gem "minitest_tu_shim", "~> 1.3.3", :platforms => :mri_22
 gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
 gem "passenger", "~>3.0"
+gem "test-unit", "~> 3.0"
 
 group :development do
   gem "appraisal", "~> 1.0.2"

data/gemfiles/rails32.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (2.1.0)
+    vanity (2.1.1)
       i18n
 
 GEM
@@ -133,6 +133,7 @@ GEM
       rake (>= 0.8.1)
     polyglot (0.3.5)
     posix-spawn (0.3.11)
+    power_assert (0.2.2)
     pygments.rb (0.6.3)
       posix-spawn (~> 0.3.6)
       yajl-ruby (~> 1.2.0)
@@ -168,7 +169,7 @@ GEM
     redis (3.0.6)
     redis-namespace (1.3.2)
       redis (~> 3.0.4)
-    rubystats (0.2.3)
+    rubystats (0.2.4)
     safe_yaml (1.0.4)
     sass (3.4.13)
     sprockets (2.2.3)
@@ -177,6 +178,8 @@ GEM
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
     sqlite3 (1.3.10)
+    test-unit (3.0.9)
+      power_assert
     thor (0.19.1)
     tilt (1.4.1)
     timecop (0.3.5)
@@ -203,7 +206,7 @@ DEPENDENCIES
   activerecord-jdbc-adapter
   appraisal (~> 1.0.2)
   bson_ext
-  bundler (>= 1.0.0)
+  bundler (>= 1.8.0)
   fakefs
   fastthread!
   garb (< 0.9.2)
@@ -220,8 +223,9 @@ DEPENDENCIES
   rake
   redis (>= 2.1)
   redis-namespace (>= 1.1.0)
-  rubystats
+  rubystats (>= 0.2.4)
   sqlite3 (~> 1.3.10)
+  test-unit (~> 3.0)
   timecop
   vanity!
   webmock

data/gemfiles/rails41.gemfile

@@ -7,7 +7,7 @@ gem "redis", ">= 2.1"
 gem "redis-namespace", ">= 1.1.0"
 gem "mongo"
 gem "integration", "<= 0.1.0"
-gem "rubystats"
+gem "rubystats", ">= 0.2.4"
 gem "garb", "< 0.9.2", :require => false
 gem "timecop", :require => false
 gem "webmock", :require => false

data/gemfiles/rails41.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: .././
   specs:
-    vanity (2.1.0)
+    vanity (2.1.1)
       i18n
 
 GEM
@@ -161,7 +161,7 @@ GEM
     redis (3.0.7)
     redis-namespace (1.4.1)
       redis (~> 3.0.4)
-    rubystats (0.2.3)
+    rubystats (0.2.4)
     safe_yaml (1.0.4)
     sass (3.4.13)
     sprockets (2.12.3)
@@ -200,7 +200,7 @@ DEPENDENCIES
   activerecord-jdbc-adapter
   appraisal (~> 1.0.2)
   bson_ext
-  bundler (>= 1.0.0)
+  bundler (>= 1.8.0)
   fakefs
   fastthread!
   garb (< 0.9.2)
@@ -216,7 +216,7 @@ DEPENDENCIES
   rake
   redis (>= 2.1)
   redis-namespace (>= 1.1.0)
-  rubystats
+  rubystats (>= 0.2.4)
   sqlite3 (~> 1.3.10)
   timecop
   vanity!

data/gemfiles/rails42.gemfile

@@ -7,7 +7,7 @@ gem "redis", ">= 2.1"
 gem "redis-namespace", ">= 1.1.0"
 gem "mongo"
 gem "integration", "<= 0.1.0"
-gem "rubystats"
+gem "rubystats", ">= 0.2.4"
 gem "garb", "< 0.9.2", :require => false
 gem "timecop", :require => false
 gem "webmock", :require => false

data/gemfiles/rails42.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (2.1.0)
+    vanity (2.1.1)
       i18n
 
 GEM
@@ -187,7 +187,7 @@ GEM
     redis (3.2.0)
     redis-namespace (1.5.1)
       redis (~> 3.0, >= 3.0.4)
-    rubystats (0.2.3)
+    rubystats (0.2.4)
     safe_yaml (1.0.4)
     sass (3.4.13)
     sprockets (2.12.3)
@@ -226,7 +226,7 @@ DEPENDENCIES
   activerecord-jdbc-adapter
   appraisal (~> 1.0.2)
   bson_ext
-  bundler (>= 1.0.0)
+  bundler (>= 1.8.0)
   fakefs
   fastthread!
   garb (< 0.9.2)
@@ -242,7 +242,7 @@ DEPENDENCIES
   rake
   redis (>= 2.1)
   redis-namespace (>= 1.1.0)
-  rubystats
+  rubystats (>= 0.2.4)
   sqlite3 (~> 1.3.10)
   timecop
   vanity!

data/gemfiles/rails42_protected_attributes.gemfile

@@ -7,7 +7,7 @@ gem "redis", ">= 2.1"
 gem "redis-namespace", ">= 1.1.0"
 gem "mongo"
 gem "integration", "<= 0.1.0"
-gem "rubystats"
+gem "rubystats", ">= 0.2.4"
 gem "garb", "< 0.9.2", :require => false
 gem "timecop", :require => false
 gem "webmock", :require => false

data/gemfiles/rails42_protected_attributes.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ../
   specs:
-    vanity (2.1.0)
+    vanity (2.1.1)
       i18n
 
 GEM
@@ -151,7 +151,7 @@ GEM
     redis-namespace (1.5.2)
       redis (~> 3.0, >= 3.0.4)
     rouge (1.10.1)
-    rubystats (0.2.3)
+    rubystats (0.2.4)
     safe_yaml (1.0.4)
     sass (3.4.20)
     sprockets (3.5.2)
@@ -181,7 +181,7 @@ DEPENDENCIES
   activerecord-jdbc-adapter
   appraisal (~> 1.0.2)
   bson_ext
-  bundler (>= 1.0.0)
+  bundler (>= 1.8.0)
   fakefs
   fastthread!
   garb (< 0.9.2)
@@ -198,7 +198,7 @@ DEPENDENCIES
   rake
   redis (>= 2.1)
   redis-namespace (>= 1.1.0)
-  rubystats
+  rubystats (>= 0.2.4)
   sqlite3 (~> 1.3.10)
   timecop
   vanity!

data/lib/vanity/experiment/ab_test.rb

@@ -58,7 +58,7 @@ module Vanity
       
       # Returns true if experiment is enabled, false if disabled.
       def enabled?
-        !@playground.collecting? || ( active? && connection.is_experiment_enabled?(@id) )
+        !@playground.collecting? || (active? && connection.is_experiment_enabled?(@id))
       end
       
       # Enable or disable the experiment. Only works if the playground is collecting
@@ -187,10 +187,10 @@ module Vanity
         if @playground.collecting?
           if active?
             if enabled?
-              index = alternative_index_for_identity(request)    
+              return assignment_for_identity(request)    
             else
               # Show the default if experiment is disabled. 
-              index = alternatives.index(default)
+              return default
             end
           else
             # If inactive, always show the outcome. Fallback to generation if one can't be found.
@@ -233,7 +233,7 @@ module Vanity
             connection.ab_not_showing @id, identity
           else
             index = @alternatives.index(value)
-            save_assignment_if_valid_visitor(identity, index, request)
+            save_assignment(identity, index, request) unless filter_visitor?(request, identity)
 
             raise ArgumentError, "No alternative #{value.inspect} for #{name}" unless index
             if (connection.ab_showing(@id, identity) && connection.ab_showing(@id, identity) != index) ||
@@ -588,14 +588,18 @@ module Vanity
 
       # Returns the assigned alternative, previously chosen alternative, or
       # alternative_for for a given identity.  
-      def alternative_index_for_identity(request)
+      def assignment_for_identity(request)
         identity = identity()
-        index = connection.ab_showing(@id, identity) || connection.ab_assigned(@id, identity)
-        unless index
-          index = alternative_for(identity).to_i
-          save_assignment_if_valid_visitor(identity, index, request) unless @playground.using_js?
+        if filter_visitor?(request, identity)
+          default
+        else
+          index = connection.ab_showing(@id, identity) || connection.ab_assigned(@id, identity)
+          unless index
+            index = alternative_for(identity).to_i
+            save_assignment(identity, index, request) unless @playground.using_js?
+          end
+          alternatives[index.to_i]
         end
-        index
       end
 
       # Chooses an alternative for the identity and returns its index. This
@@ -618,8 +622,8 @@ 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_if_valid_visitor(identity, index, request)
-        return if index == connection.ab_showing(@id, identity) || filter_visitor?(request)
+      def save_assignment(identity, index, request)
+        return if index == connection.ab_showing(@id, identity)
 
         call_on_assignment_if_available(identity, index)
         rebalance_if_necessary!
@@ -628,8 +632,9 @@ module Vanity
         check_completion!
       end
 
-      def filter_visitor?(request)
-        @playground.request_filter.call(request)
+      def filter_visitor?(request, identity)
+        @playground.request_filter.call(request) || 
+          (@request_filter_block && @request_filter_block.call(request, identity))
       end
 
       def call_on_assignment_if_available(identity, index)
@@ -664,9 +669,9 @@ module Vanity
         @use_probabilities = []
         result = []
         @alternatives = @alternatives.each_with_index.map do |(value, probability), i|
-          result << alternative = Alternative.new( self, i, value )
+          result << alternative = Alternative.new(self, i, value)
           probability = probability.to_f / sum_of_probability
-          @use_probabilities << [ alternative, cumulative_probability += probability ]
+          @use_probabilities << [alternative, cumulative_probability += probability]
           value
         end
 

data/lib/vanity/experiment/base.rb

@@ -158,6 +158,20 @@ module Vanity
         return unless @playground.collecting?
         connection.set_experiment_created_at @id, Time.now
       end
+      
+      # -- Filtering Particpants --
+
+      # Define an experiment specific request filter.  For example:
+      #
+      #   reject do |request|
+      #     true if Vanity.context.cookies["somecookie"]
+      #   end
+      #
+      def reject(&block)
+        fail "Missing block" unless block
+        raise "filter already called on this experiment" if @request_filter_block
+        @request_filter_block = block
+      end
 
     protected
 

data/lib/vanity/frameworks/rails.rb

@@ -16,7 +16,7 @@ module Vanity
     # The use_vanity method will setup the controller to allow testing and
     # tracking of the current user.
     module UseVanity
-      # Defines the vanity_identity method and the set_identity_context filter.
+      # Defines the vanity_identity method and the vanity_context_filter filter.
       #
       # Call with the name of a method that returns an object whose identity
       # will be used as the Vanity identity if the user is not already
@@ -40,55 +40,16 @@ module Vanity
       #   class ProjectController < ApplicationController
       #     use_vanity { |controller| controller.params[:project_id] }
       #   end
-      def use_vanity(symbol = nil, &block)
+      def use_vanity(method_name = nil, &block)
         define_method :vanity_store_experiment_for_js do |name, alternative|
           @_vanity_experiments ||= {}
           @_vanity_experiments[name] ||= alternative
           @_vanity_experiments[name].value
         end
 
-        if block
-          define_method(:vanity_identity) { block.call(self) }
-        else
-          define_method :vanity_identity do
-            return @vanity_identity if @vanity_identity
-
-            cookie = lambda do |value|
-              result = {
-                value: value,
-                expires: Time.now + Vanity.configuration.cookie_expires,
-                path: Vanity.configuration.cookie_path,
-                domain: Vanity.configuration.cookie_domain,
-                secure: Vanity.configuration.cookie_secure,
-                httponly: Vanity.configuration.cookie_httponly
-              }
-              result[:domain] ||= ::Rails.application.config.session_options[:domain]
-              result
-            end
+        define_method(:vanity_identity_block) { block }
+        define_method(:vanity_identity_method) { method_name }
 
-            # With user sign in, it's possible to visit not-logged in, get
-            # cookied and shown alternative A, then sign in and based on
-            # user.id, get shown alternative B.
-            # This implementation prefers an initial vanity cookie id over a
-            # new user.id to avoid the flash of alternative B (FOAB).
-            if request.get? && params[:_identity]
-              @vanity_identity = params[:_identity]
-              cookies[Vanity.configuration.cookie_name] = cookie.call(@vanity_identity)
-              @vanity_identity
-            elsif cookies[Vanity.configuration.cookie_name]
-              @vanity_identity = cookies[Vanity.configuration.cookie_name]
-            elsif symbol && object = send(symbol)
-              @vanity_identity = object.id
-            elsif response # everyday use
-              @vanity_identity = cookies[Vanity.configuration.cookie_name] || SecureRandom.hex(16)
-              cookies[Vanity.configuration.cookie_name] = cookie.call(@vanity_identity)
-              @vanity_identity
-            else # during functional testing
-              @vanity_identity = "test"
-            end
-          end
-        end
-        protected :vanity_identity
         around_filter :vanity_context_filter
         before_filter :vanity_reload_filter unless ::Rails.configuration.cache_classes
         before_filter :vanity_query_parameter_filter
@@ -97,7 +58,65 @@ module Vanity
       protected :use_vanity
     end
 
+    module Identity
+      def vanity_identity # :nodoc:
+        return vanity_identity_block.call(self) if vanity_identity_block
+        return @vanity_identity if @vanity_identity
+
+        # With user sign in, it's possible to visit not-logged in, get
+        # cookied and shown alternative A, then sign in and based on
+        # user.id, get shown alternative B.
+        # This implementation prefers an initial vanity cookie id over a
+        # new user.id to avoid the flash of alternative B (FOAB).
+        if request.get? && params[:_identity]
+          @vanity_identity = params[:_identity]
+          cookies[Vanity.configuration.cookie_name] = build_vanity_cookie(@vanity_identity)
+          @vanity_identity
+        elsif cookies[Vanity.configuration.cookie_name]
+          @vanity_identity = cookies[Vanity.configuration.cookie_name]
+        elsif identity = vanity_identity_from_method(vanity_identity_method)
+          @vanity_identity = identity
+        elsif response # everyday use
+          @vanity_identity = cookies[Vanity.configuration.cookie_name] || SecureRandom.hex(16)
+          cookies[Vanity.configuration.cookie_name] = build_vanity_cookie(@vanity_identity)
+          @vanity_identity
+        else # during functional testing
+          @vanity_identity = "test"
+        end
+      end
+      protected :vanity_identity
+
+      def vanity_identity_from_method(method_name) # :nodoc:
+        return unless method_name
+
+        object = send(method_name)
+        object.try(:id)
+      end
+      private :vanity_identity_from_method
+
+      def build_vanity_cookie(identity) # :nodoc:
+        result = {
+          value: identity,
+          expires: Time.now + Vanity.configuration.cookie_expires,
+          path: Vanity.configuration.cookie_path,
+          domain: Vanity.configuration.cookie_domain,
+          secure: Vanity.configuration.cookie_secure,
+          httponly: Vanity.configuration.cookie_httponly
+        }
+        result[:domain] ||= ::Rails.application.config.session_options[:domain]
+        result
+      end
+      private :build_vanity_cookie
+    end
+
     module UseVanityMailer
+      # Should be called from within the mailer function. For example:
+      #
+      #   def invite_email(user)
+      #     use_vanity_mailer user
+      #     mail to: user.email, subject: ab_test(:invite_subject)
+      #   end
+      #
       def use_vanity_mailer(symbol = nil)
         # Context is the instance of ActionMailer::Base
         Vanity.context = self
@@ -373,7 +392,7 @@ module Vanity
         exp.enabled = false
         render :file=>Vanity.template("_experiment"), :locals=>{:experiment=>exp}
       end
-      
+
       def enable
         exp = Vanity.playground.experiment(params[:e].to_sym)
         exp.enabled = true
@@ -412,6 +431,7 @@ ActiveSupport.on_load(:action_controller) do
   ActionController::Base.class_eval do
     extend Vanity::Rails::UseVanity
     include Vanity::Rails::Filters
+    include Vanity::Rails::Identity
     helper Vanity::Rails::Helpers
   end
 end

data/lib/vanity/version.rb

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

data/test/dummy/app/controllers/use_vanity_controller.rb

@@ -0,0 +1,23 @@
+class UseVanityController < ActionController::Base
+  class TestModel
+    def test_method
+      Vanity.ab_test(:pie_or_cake)
+    end
+  end
+
+  attr_accessor :current_user
+
+  def index
+    render :text=>Vanity.ab_test(:pie_or_cake)
+  end
+
+  def js
+    Vanity.ab_test(:pie_or_cake)
+    render :inline => "<%= vanity_js -%>"
+  end
+
+  def model_js
+    TestModel.new.test_method
+    render :inline => "<%= vanity_js -%>"
+  end
+end

data/test/dummy/app/mailers/vanity_mailer.rb

@@ -0,0 +1,19 @@
+class VanityMailer < ActionMailer::Base
+  include Vanity::Rails::Helpers
+  include ActionView::Helpers::AssetTagHelper
+  include ActionView::Helpers::TagHelper
+
+  def ab_test_subject(user)
+    use_vanity_mailer user
+
+    mail :subject =>ab_test(:pie_or_cake).to_s, :body => ""
+  end
+
+  def ab_test_content(user)
+    use_vanity_mailer user
+
+    mail do |format|
+      format.html { render :text=>view_context.vanity_tracking_image(Vanity.context.vanity_identity, :open, :host => "127.0.0.1:3000") }
+    end
+  end
+end

data/test/experiment/ab_test.rb

@@ -1430,6 +1430,24 @@ This experiment did not run long enough to find a clear winner.
     assert [:a, :b, :c].include?(choice)
     assert_equal choice, experiment(:simple).choose.value
   end
+
+  def test_filter_visitor_always_returns_default
+    exp = new_ab_test :simple do
+      alternatives :a, :b, :c
+      default :b
+      metrics :coolness
+
+      reject do |request, identity|
+        true
+      end
+    end
+
+    results = Set.new
+    100.times do
+      results << exp.choose.value
+    end
+    assert_equal results, [:b].to_set
+  end
   
   # -- Reset --
   

data/test/frameworks/rails/action_controller_test.rb

@@ -1,30 +1,5 @@
 require "test_helper"
 
-# Pages accessible to everyone, e.g. sign in, community search.
-class UseVanityController < ActionController::Base
-  class TestModel
-    def test_method
-      Vanity.ab_test(:pie_or_cake)
-    end
-  end
-
-  attr_accessor :current_user
-
-  def index
-    render :text=>Vanity.ab_test(:pie_or_cake)
-  end
-
-  def js
-    Vanity.ab_test(:pie_or_cake)
-    render :inline => "<%= vanity_js -%>"
-  end
-
-  def model_js
-    TestModel.new.test_method
-    render :inline => "<%= vanity_js -%>"
-  end
-end
-
 class UseVanityControllerTest < ActionController::TestCase
   tests UseVanityController
 
@@ -120,11 +95,17 @@ class UseVanityControllerTest < ActionController::TestCase
   end
 
   def test_vanity_identity_set_from_user
-    @controller.current_user = mock("user", :id=>"user_id")
+    @controller.current_user = stub("user", :id=>"user_id")
     get :index
     assert_equal "user_id", @controller.send(:vanity_identity)
   end
 
+  def test_vanity_identity_with_null_user_falls_back_to_cookie
+    @controller.current_user = stub("user", :id=>nil)
+    get :index
+    assert cookies["vanity_id"] =~ /^[a-f0-9]{32}$/
+  end
+
   def test_vanity_identity_with_no_user_model
     UseVanityController.class_eval do
       use_vanity nil

data/test/frameworks/rails/action_mailer_test.rb

@@ -1,25 +1,5 @@
 require "test_helper"
 
-class VanityMailer < ActionMailer::Base
-  include Vanity::Rails::Helpers
-  include ActionView::Helpers::AssetTagHelper
-  include ActionView::Helpers::TagHelper
-
-  def ab_test_subject(user)
-    use_vanity_mailer user
-
-    mail :subject =>ab_test(:pie_or_cake).to_s, :body => ""
-  end
-
-  def ab_test_content(user)
-    use_vanity_mailer user
-
-    mail do |format|
-      format.html { render :text=>view_context.vanity_tracking_image(Vanity.context.vanity_identity, :open, :host => "127.0.0.1:3000") }
-    end
-  end
-end
-
 class UseVanityMailerTest < ActionMailer::TestCase
   tests VanityMailer
 

data/vanity.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "i18n"
 
-  spec.add_development_dependency "bundler",  ">= 1.0.0"
+  spec.add_development_dependency "bundler",  ">= 1.8.0"
   spec.add_development_dependency "minitest", ">= 4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vanity
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Assaf Arkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2016-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +164,9 @@ files:
 - test/data/vanity.yml.redis-erb
 - test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/use_vanity_controller.rb
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/mailers/vanity_mailer.rb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/config.ru
 - test/dummy/config/application.rb
@@ -211,7 +213,7 @@ metadata: {}
 post_install_message: To get started run vanity --help
 rdoc_options:
 - --title
-- Vanity 2.1.0
+- Vanity 2.1.1
 - --main
 - README.md
 - --webcvs
@@ -248,7 +250,9 @@ test_files:
 - test/data/vanity.yml.redis-erb
 - test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/use_vanity_controller.rb
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/mailers/vanity_mailer.rb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/config.ru
 - test/dummy/config/application.rb