vanity 1.8.4 → 1.9.0.beta

data/lib/vanity/experiment/alternative.rb

@@ -5,10 +5,10 @@ module Vanity
     class Alternative
 
       def initialize(experiment, id, value) #, participants, converted, conversions)
-      	@experiment = experiment
-      	@id = id
-      	@name = "option #{(@id + 65).chr}"
-      	@value = value
+        @experiment = experiment
+        @id = id
+        @name = "option #{(@id + 65).chr}"
+        @value = value
       end
 
       # Alternative id, only unique for this experiment.
@@ -25,22 +25,22 @@ module Vanity
 
       # Number of participants who viewed this alternative.
       def participants
-      	load_counts unless @participants
-      	@participants
+        load_counts unless @participants
+        @participants
       end
 
       # Number of participants who converted on this alternative (a
       # participant is counted only once).
       def converted
-      	load_counts unless @converted
-      	@converted
+        load_counts unless @converted
+        @converted
       end
 
       # Number of conversions for this alternative (same participant may be
       # counted more than once).
       def conversions
-      	load_counts unless @conversions
-      	@conversions
+        load_counts unless @conversions
+        @conversions
       end
 
       # Z-score for this alternative, related to 2nd-best performing
@@ -56,37 +56,37 @@ module Vanity
 
       # Conversion rate calculated as converted/participants
       def conversion_rate
-      	@conversion_rate ||= (participants > 0 ? converted.to_f/participants.to_f  : 0.0)
+        @conversion_rate ||= (participants > 0 ? converted.to_f/participants.to_f  : 0.0)
       end
 
       # The measure we use to order (sort) alternatives and decide which one
       # is better (by calculating z-score). Defaults to conversion rate.
       def measure
-      	conversion_rate
+        conversion_rate
       end
 
       def <=>(other)
-      	measure <=> other.measure
+        measure <=> other.measure
       end
 
       def ==(other)
-      	other && id == other.id && experiment == other.experiment
+        other && id == other.id && experiment == other.experiment
       end
 
       def to_s
-      	name
+        name
       end
 
       def inspect
-      	"#{name}: #{value} #{converted}/#{participants}"
+        "#{name}: #{value} #{converted}/#{participants}"
       end
 
       def load_counts
-      	if @experiment.playground.collecting?
-      	  @participants, @converted, @conversions = @experiment.playground.connection.ab_counts(@experiment.id, id).values_at(:participants, :converted, :conversions)
-      	else
-      	  @participants = @converted = @conversions = 0
-      	end
+        if @experiment.playground.collecting?
+          @participants, @converted, @conversions = @experiment.playground.connection.ab_counts(@experiment.id, id).values_at(:participants, :converted, :conversions)
+        else
+          @participants = @converted = @conversions = 0
+        end
       end
     end
   end

data/lib/vanity/experiment/base.rb

@@ -67,7 +67,7 @@ module Vanity
         self.class.type
       end
 
-      # Defines how we obtain an identity for the current experiment.  Usually
+      # Defines how we obtain an identity for the current experiment. Usually
       # Vanity gets the identity form a session object (see use_vanity), but
       # there are cases where you want a particular experiment to use a
       # different identity.
@@ -95,8 +95,8 @@ module Vanity
       #     end
       #   end
       def on_assignment(&block)
-      	fail "Missing block" unless block
-      	@on_assignment_block = block
+        fail "Missing block" unless block
+        @on_assignment_block = block
       end
 
       # -- Reporting --
@@ -115,7 +115,7 @@ module Vanity
 
       # -- Experiment completion --
 
-      # Define experiment completion condition.  For example:
+      # Define experiment completion condition. For example:
       #   complete_if do
       #     !score(95).chosen.nil?
       #   end
@@ -184,7 +184,7 @@ module Vanity
       end
 
       # Returns key for this experiment, or with an argument, return a key
-      # using the experiment as the namespace.  Examples:
+      # using the experiment as the namespace. Examples:
       #   key => "vanity:experiments:green_button"
       #   key("participants") => "vanity:experiments:green_button:participants"
       def key(name = nil)

data/lib/vanity/experiment/bayesian_bandit_score.rb

@@ -8,85 +8,85 @@ module Vanity
       DEFAULT_PROBABILITY = 90
 
       def initialize(alternatives, outcome)
-      	@alternatives = alternatives
-      	@outcome = outcome
-      	@method = :bayes_bandit_score
+        @alternatives = alternatives
+        @outcome = outcome
+        @method = :bayes_bandit_score
       end
 
       def calculate!(probability=DEFAULT_PROBABILITY)
-      	# sort by conversion rate to find second best
-      	@alts = @alternatives.sort_by(&:measure)
-      	@base = @alts[-2]
+        # sort by conversion rate to find second best
+        @alts = @alternatives.sort_by(&:measure)
+        @base = @alts[-2]
 
-      	assign_alternatives_bayesian_probability(@alts)
+        assign_alternatives_bayesian_probability(@alts)
 
-      	@least = assign_alternatives_difference(@alts)
+        @least = assign_alternatives_difference(@alts)
 
-      	# best alternative is one with highest conversion rate (best shot).
-      	@best = @alts.last if @alts.last.measure > 0.0
-      	# choice alternative can only pick best if we have high probability (>90%).
-      	@choice = outcome_or_best_probability(@alternatives, @outcome, @best, probability)
-      	self
+        # best alternative is one with highest conversion rate (best shot).
+        @best = @alts.last if @alts.last.measure > 0.0
+        # choice alternative can only pick best if we have high probability (>90%).
+        @choice = outcome_or_best_probability(@alternatives, @outcome, @best, probability)
+        self
       end
 
       protected
 
       def outcome_or_best_probability(alternatives, outcome, best, probability)
-      	if outcome
-      	  alternatives[@outcome.id]
-      	elsif best && best.probability >= probability
-      	  best
-      	else
-      	  nil
-      	end
+        if outcome
+          alternatives[@outcome.id]
+        elsif best && best.probability >= probability
+          best
+        else
+          nil
+        end
       end
 
       # Assign each alternative's bayesian probability of being the best
       # alternative to alternative#probability.
       def assign_alternatives_bayesian_probability(alternatives)
-      	alternative_posteriors = calculate_alternative_posteriors(alternatives)
-      	alternatives.each_with_index do |alternative, i|
-      	  alternative.probability = 100 * probability_alternative_is_best(alternative_posteriors[i], alternative_posteriors)
-      	end
+        alternative_posteriors = calculate_alternative_posteriors(alternatives)
+        alternatives.each_with_index do |alternative, i|
+          alternative.probability = 100 * probability_alternative_is_best(alternative_posteriors[i], alternative_posteriors)
+        end
       end
 
       def calculate_alternative_posteriors(alternatives)
-      	alternatives.map do |alternative|
-      	  x = alternative.converted
-      	  n = alternative.participants
-      	  Rubystats::BetaDistribution.new(x+1, n-x+1)
-      	end
+        alternatives.map do |alternative|
+          x = alternative.converted
+          n = alternative.participants
+          Rubystats::BetaDistribution.new(x+1, n-x+1)
+        end
       end
 
       def probability_alternative_is_best(alternative_being_examined, all_alternatives)
-      	Integration.integrate(0, 1, :tolerance=>1e-4) do |z|
-      	  pdf_alternative_is_best(z, alternative_being_examined, all_alternatives)
-      	end
+        Integration.integrate(0, 1, :tolerance=>1e-4) do |z|
+          pdf_alternative_is_best(z, alternative_being_examined, all_alternatives)
+        end
       end
 
       def pdf_alternative_is_best(z, alternative_being_examined, all_alternatives)
-      	# get the pdf for this alternative at z
-      	pdf = alternative_being_examined.pdf(z)
-      	# now multiply by the probability that all the other alternatives are lower
-      	all_alternatives.each do |alternative|
-      	  if alternative != alternative_being_examined
-      	    pdf = pdf * alternative.cdf(z)
-      	  end
-      	end
-      	pdf
+        # get the pdf for this alternative at z
+        pdf = alternative_being_examined.pdf(z)
+        # now multiply by the probability that all the other alternatives are lower
+        all_alternatives.each do |alternative|
+          if alternative != alternative_being_examined
+            pdf = pdf * alternative.cdf(z)
+          end
+        end
+        pdf
       end
 
       def assign_alternatives_difference(alternatives)
-      	# difference is measured from least performant
-      	least = alternatives.find { |alternative| alternative.measure > 0 }
-      	if least
-      	  alternatives.each do |alternative|
-      	    if alternative.measure > least.measure
-      	      alternative.difference = (alternative.measure - least.measure) / least.measure * 100
-      	    end
-      	  end
-      	end
-      	least
+        # difference is measured from least performant
+        least = alternatives.find { |alternative| alternative.measure > 0 }
+        if least
+          alternatives.each do |alternative|
+            if alternative.measure > least.measure
+              alternative.difference = (alternative.measure - least.measure) / least.measure * 100
+            end
+          end
+        end
+        least
       end
     end
   end

data/lib/vanity/experiment/definition.rb

@@ -1,8 +1,8 @@
 module Vanity
   module Experiment
     # These methods are available from experiment definitions (files located in
-    # the experiments directory, automatically loaded by Vanity).  Use these
-    # methods to define you experiments, for example:
+    # the experiments directory, automatically loaded by Vanity). Use these
+    # methods to define your experiments, for example:
     #   ab_test "New Banner" do
     #     alternatives :red, :green, :blue
     #     metrics :signup
@@ -14,17 +14,17 @@ module Vanity
       # Defines a new experiment, given the experiment's name, type and
       # definition block.
       def define(name, type, options = nil, &block)
-      	fail "Experiment #{@experiment_id} already defined in playground" if playground.experiments[@experiment_id]
-      	klass = Experiment.const_get(type.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase })
-      	experiment = klass.new(playground, @experiment_id, name, options)
-      	experiment.instance_eval &block
-      	experiment.save
-      	playground.experiments[@experiment_id] = experiment
+        fail "Experiment #{@experiment_id} already defined in playground" if playground.experiments[@experiment_id]
+        klass = Experiment.const_get(type.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase })
+        experiment = klass.new(playground, @experiment_id, name, options)
+        experiment.instance_eval &block
+        experiment.save
+        playground.experiments[@experiment_id] = experiment
       end
 
       def new_binding(playground, id)
-      	@playground, @experiment_id = playground, id
-      	binding
+        @playground, @experiment_id = playground, id
+        binding
       end
 
     end

data/lib/vanity/frameworks/rails.rb

@@ -7,7 +7,7 @@ module Vanity
       # Do this at the very end of initialization, allowing you to change
       # connection adapter, turn collection on/off, etc.
       ::Rails.configuration.after_initialize do
-        Vanity.playground.load!
+        Vanity.playground.load! if Vanity.playground.connected?
       end
     end
 
@@ -17,7 +17,8 @@ module Vanity
       # Defines the vanity_identity method and the set_identity_context filter.
       #
       # Call with the name of a method that returns an object whose identity
-      # will be used as the Vanity identity.  Confusing?  Let's try by example:
+      # will be used as the Vanity identity if the user is not already
+      # cookied. Confusing?  Let's try by example:
       #
       #   class ApplicationController < ActionController::Base
       #     use_vanity :current_user
@@ -28,11 +29,12 @@ module Vanity
       #   end
       #
       # If that method (current_user in this example) returns nil, Vanity will
-      # set the identity for you (using a cookie to remember it across
-      # requests).  It also uses this mechanism if you don't provide an
-      # identity object, by calling use_vanity with no arguments.
+      # look for a vanity cookie. If there is none, it will create an identity
+      # (using a cookie to remember it across requests). It also uses this
+      # mechanism if you don't provide an identity object, by calling
+      # use_vanity with no arguments.
       #
-      # Of course you can also use a block:
+      # You can also use a block:
       #   class ProjectController < ApplicationController
       #     use_vanity { |controller| controller.params[:project_id] }
       #   end
@@ -42,12 +44,20 @@ module Vanity
         else
           define_method :vanity_identity do
             return @vanity_identity if @vanity_identity
-            if symbol && object = send(symbol)
-              @vanity_identity = object.id
-            elsif request.get? && params[:_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_id"] = { :value=>@vanity_identity, :expires=>1.month.from_now }
               @vanity_identity
+            elsif cookies["vanity_id"]
+              @vanity_identity = cookies["vanity_id"]
+            elsif symbol && object = send(symbol)
+              @vanity_identity = object.id
             elsif response # everyday use
               #conditional for Rails2 support
               secure_random = defined?(SecureRandom) ? SecureRandom : ActiveSupport::SecureRandom
@@ -95,7 +105,7 @@ module Vanity
     end
 
 
-    # Vanity needs these filters.  They are includes in ActionController and
+    # Vanity needs these filters. They are includes in ActionController and
     # automatically added when you use #use_vanity in your controller.
     module Filters
       # Around filter that sets Vanity.context to controller.
@@ -110,9 +120,9 @@ module Vanity
       # parameter.
       #
       # Each alternative has a unique fingerprint (run vanity list command to
-      # see them all).  A request with the _vanity query parameter is
+      # see them all). A request with the _vanity query parameter is
       # intercepted, the alternative is chosen, and the user redirected to the
-      # same request URL sans _vanity parameter.  This only works for GET
+      # same request URL sans _vanity parameter. This only works for GET
       # requests.
       #
       # For example, if the user requests the page
@@ -137,14 +147,14 @@ module Vanity
         end
       end
 
-      # Before filter to reload Vanity experiments/metrics.  Enabled when
+      # Before filter to reload Vanity experiments/metrics. Enabled when
       # cache_classes is false (typically, testing environment).
       def vanity_reload_filter
         Vanity.playground.reload!
       end
 
-      # Filter to track metrics
-      # pass _track param along to call track! on that alternative
+      # Filter to track metrics. Pass _track param along to call track! on that
+      # alternative.
       def vanity_track_filter
         if request.get? && params[:_track]
           track! params[:_track]
@@ -155,7 +165,7 @@ module Vanity
     end
 
 
-    # Introduces ab_test helper (controllers and views).  Similar to the generic
+    # Introduces ab_test helper (controllers and views). Similar to the generic
     # ab_test method, with the ability to capture content (applicable to views,
     # see examples).
     module Helpers
@@ -263,7 +273,8 @@ module Vanity
 
       def setup_experiment(name)
         @_vanity_experiments ||= {}
-        @_vanity_experiments[name] ||= Vanity.playground.experiment(name.to_sym).choose
+        request = respond_to?(:request) ? self.request : nil
+        @_vanity_experiments[name] ||= Vanity.playground.experiment(name.to_sym).choose(request)
         @_vanity_experiments[name].value
       end
 
@@ -281,11 +292,14 @@ module Vanity
     # Step 3: Open your browser to http://localhost:3000/vanity
     module Dashboard
       def index
-        render :file=>Vanity.template("_report"), :content_type=>Mime::HTML, :layout=>false
+        @experiments = Vanity.playground.experiments
+        @experiments_persisted = Vanity.playground.experiments_persisted?
+        @metrics = Vanity.playground.metrics
+        render :file=>Vanity.template("_report"), :content_type=>Mime::HTML
       end
 
       def participant
-        render :file=>Vanity.template("_participant"), :locals=>{:participant_id => params[:id], :participant_info => Vanity.playground.participant_info(params[:id])}, :content_type=>Mime::HTML, :layout=>false
+        render :file=>Vanity.template("_participant"), :locals=>{:participant_id => params[:id], :participant_info => Vanity.playground.participant_info(params[:id])}, :content_type=>Mime::HTML
       end
 
       def complete
@@ -308,13 +322,14 @@ module Vanity
         render :file=>Vanity.template("_experiment"), :locals=>{:experiment=>exp}
       end
 
+      # JS callback action used by vanity_js
       def add_participant
-      	if params[:e].nil? || params[:e].empty?
-      	  render :status => 404, :nothing => true
-      	  return
-      	end
+        if params[:e].nil? || params[:e].empty?
+          render :status => 404, :nothing => true
+          return
+        end
         exp = Vanity.playground.experiment(params[:e].to_sym)
-        exp.chooses(exp.alternatives[params[:a].to_i].value)
+        exp.chooses(exp.alternatives[params[:a].to_i].value, request)
         render :status => 200, :nothing => true
       end
     end
@@ -337,18 +352,6 @@ if defined?(ActionController)
     include Vanity::Rails::Filters
     helper Vanity::Rails::Helpers
   end
-
-  module ActionController
-    class TestCase
-      alias :setup_controller_request_and_response_without_vanity :setup_controller_request_and_response
-      # Sets Vanity.context to the current controller, so you can do things like:
-      #   experiment(:simple).chooses(:green)
-      def setup_controller_request_and_response
-        setup_controller_request_and_response_without_vanity
-        Vanity.context = @controller
-      end
-    end
-  end
 end
 
 if defined?(ActionMailer)