vanity 1.8.1 → 1.8.2

data/lib/vanity/adapters/redis_adapter.rb

@@ -130,6 +130,14 @@ module Vanity
         @experiments.sadd "#{experiment}:alts:#{alternative}:participants", identity
       end
 
+      def ab_seen(experiment, identity, alternative)
+	if @experiments.sismember "#{experiment}:alts:#{alternative.id}:participants", identity
+	  return alternative
+	else
+	  return nil
+	end
+      end
+
       def ab_add_conversion(experiment, alternative, identity, count = 1, implicit = false)
         if implicit
           @experiments.sadd "#{experiment}:alts:#{alternative}:participants", identity

data/lib/vanity/autoconnect.rb

@@ -0,0 +1,61 @@
+module Vanity
+  # A singleton responsible for determining if the playground should connect
+  # to the datastore.
+  module Autoconnect
+
+     BLACKLISTED_RAILS_RAKE_TASKS = [
+      'about',
+      'assets:clean',
+      'assets:clobber',
+      'assets:environment',
+      'assets:precompile',
+      'assets:precompile:all',
+      'db:create',
+      'db:drop',
+      'db:fixtures:load',
+      'db:migrate',
+      'db:migrate:status',
+      'db:rollback',
+      'db:schema:cache:clear',
+      'db:schema:cache:dump',
+      'db:schema:dump',
+      'db:schema:load',
+      'db:seed',
+      'db:setup',
+      'db:structure:dump',
+      'db:version',
+      'doc:app',
+      'log:clear',
+      'middleware',
+      'notes',
+      'notes:custom',
+      'rails:template',
+      'rails:update',
+      'routes',
+      'secret',
+      'stats',
+      'time:zones:all',
+      'tmp:clear',
+      'tmp:create'
+    ]
+    ENVIRONMENT_VANITY_DISABLED_FLAG = "VANITY_DISABLED"
+
+    def self.playground_should_autoconnect?
+      !environment_disabled? && !in_blacklisted_rake_task?
+    end
+
+    def self.environment_disabled?
+      !!ENV[ENVIRONMENT_VANITY_DISABLED_FLAG]
+    end
+
+    def self.in_blacklisted_rake_task?
+      !(current_rake_tasks & BLACKLISTED_RAILS_RAKE_TASKS).empty?
+    end
+
+    def self.current_rake_tasks
+      ::Rake.application.top_level_tasks
+    rescue => e
+      []
+    end
+  end
+end

data/lib/vanity/experiment/ab_test.rb

@@ -15,7 +15,7 @@ module Vanity
 
       # Alternative id, only unique for this experiment.
       attr_reader :id
-     
+
       # Alternative name (option A, option B, etc).
       attr_reader :name
 
@@ -48,7 +48,7 @@ module Vanity
 
       # Probability derived from z-score. Populated by AbTest#score.
       attr_accessor :probability
-    
+
       # Difference from least performing alternative. Populated by AbTest#score.
       attr_accessor :difference
 
@@ -64,7 +64,7 @@ module Vanity
       end
 
       def <=>(other)
-        measure <=> other.measure 
+        measure <=> other.measure
       end
 
       def ==(other)
@@ -101,7 +101,7 @@ module Vanity
           end
 
           def friendly_name
-            "A/B Test" 
+            "A/B Test"
           end
 
         end
@@ -112,8 +112,8 @@ module Vanity
 
 
       # -- Metric --
-    
-      # Tells A/B test which metric we're measuring, or returns metric in use. 
+
+      # Tells A/B test which metric we're measuring, or returns metric in use.
       #
       # @example Define A/B test against coolness metric
       #   ab_test "Background color" do
@@ -127,7 +127,6 @@ module Vanity
         @metrics
       end
 
-
       # -- Alternatives --
 
       # Call this method once to set alternative values for this experiment
@@ -139,7 +138,7 @@ module Vanity
       #     metrics :coolness
       #     alternatives "red", "blue", "orange"
       #   end
-      # 
+      #
       # @example Find out which alternatives this test uses
       #   alts = experiment(:background_color).alternatives
       #   puts "#{alts.count} alternatives, with the colors: #{alts.map(&:value).join(", ")}"
@@ -175,7 +174,7 @@ module Vanity
       #
       # @example
       #   ab_test "More bacon" do
-      #     metrics :yummyness 
+      #     metrics :yummyness
       #     false_true
       #   end
       #
@@ -198,13 +197,20 @@ module Vanity
         if @playground.collecting?
           if active?
             identity = identity()
-            index = connection.ab_showing(@id, identity)
-            unless index
-              index = alternative_for(identity)
-              if !@playground.using_js?
-                connection.ab_add_participant @id, index, identity
-                check_completion!
-              end
+      	    index = connection.ab_showing(@id, identity)
+      	    unless index
+      	      index = alternative_for(identity)
+      	      if !@playground.using_js?
+            		# if we have an on_assignment block, call it on new assignments
+            		if @on_assignment_block
+            		  assignment = alternatives[index.to_i]
+            		  if !connection.ab_seen @id, identity, assignment
+            		    @on_assignment_block.call(Vanity.context, identity, assignment, self)
+            		  end
+            		end
+            		connection.ab_add_participant @id, index, identity
+            		check_completion!
+      	      end
             end
           else
             index = connection.ab_get_outcome(@id) || alternative_for(identity)
@@ -225,9 +231,9 @@ module Vanity
         Digest::MD5.hexdigest("#{id}:#{alternative.id}")[-10,10]
       end
 
-      
+
       # -- Testing --
-     
+
       # Forces this experiment to use a particular alternative.  You'll want to
       # use this from your test cases to test for the different alternatives.
       #
@@ -256,8 +262,8 @@ module Vanity
               check_completion!
             end
             raise ArgumentError, "No alternative #{value.inspect} for #{name}" unless index
-            if (connection.ab_showing(@id, identity) && connection.ab_showing(@id, identity) != index) || 
-         alternative_for(identity) != index
+            if (connection.ab_showing(@id, identity) && connection.ab_showing(@id, identity) != index) ||
+              alternative_for(identity) != index
               connection.ab_show @id, identity, index
             end
           end
@@ -294,7 +300,7 @@ module Vanity
       # [:z_score]      Z-score (relative to the base alternative).
       # [:probability]  Probability (z-score mapped to 0, 90, 95, 99 or 99.9%).
       # [:difference]   Difference from the least performant altenative.
-      # 
+      #
       # The choice alternative is set only if its probability is higher or
       # equal to the specified probability (default is 90%).
       def score(probability = 90)
@@ -405,7 +411,7 @@ module Vanity
           begin
             result = @outcome_is.call
             outcome = result.id if Alternative === result && result.experiment == self
-          rescue 
+          rescue
             warn "Error in AbTest#complete!: #{$!}"
           end
         else
@@ -416,7 +422,7 @@ module Vanity
         connection.ab_set_outcome @id, outcome || 0
       end
 
-      
+
       # -- Store/validate --
 
       def destroy

data/lib/vanity/experiment/base.rb

@@ -69,6 +69,7 @@ module Vanity
         @id, @name = id.to_sym, name
         @options = options || {}
         @identify_block = method(:default_identify)
+	@on_assignment_block = nil
       end
 
       # Human readable experiment name (first argument you pass when creating a
@@ -113,6 +114,19 @@ module Vanity
         @identify_block = block
       end
 
+      # Defines any additional actions to take when a new assignment is made for the current experiment
+      #
+      # For example, if you want to use the rails default logger to log whenever an assignment is made:
+      #   ab_test "Project widget" do
+      #     alternatives :small, :medium, :large
+      #     on_assignment do |controller, identity, assignment|
+      #       controller.logger.info "made a split test assignment for #{experiment.name}: #{identity} => #{assignment}"
+      #     end
+      #   end
+      def on_assignment(&block)
+	fail "Missing block" unless block
+	@on_assignment_block = block
+      end
 
       # -- Reporting --
 

data/lib/vanity/frameworks/rails.rb

@@ -182,9 +182,7 @@ module Vanity
       #     <%= count %> features to choose from!
       #   <% end %>
       def ab_test(name, &block)
-        @_vanity_experiments ||= {}
-        @_vanity_experiments[name] ||= Vanity.playground.experiment(name.to_sym).choose
-        value = @_vanity_experiments[name].value
+        value = setup_experiment(name)
 
         if block
           content = capture(value, &block)
@@ -258,8 +256,17 @@ module Vanity
           experiments[name] = alternative.clone
         end
 
-        return experiments
+        experiments
+      end
+
+      protected
+
+      def setup_experiment(name)
+        @_vanity_experiments ||= {}
+        @_vanity_experiments[name] ||= Vanity.playground.experiment(name.to_sym).choose
+        @_vanity_experiments[name].value
       end
+
     end
 
 

data/lib/vanity/playground.rb

@@ -21,6 +21,7 @@ module Vanity
     # - namespace -- Namespace to use
     # - load_path -- Path to load experiments/metrics from
     # - logger -- Logger to use
+    # - redis -- A Redis object that will be used for the connection
     def initialize(*args)
       options = Hash === args.last ? args.pop : {}
       # In the case of Rails, use the Rails logger and collect only for
@@ -39,18 +40,6 @@ module Vanity
       end
 
       @options = defaults.merge(config).merge(options)
-      if @options[:host] == 'redis' && @options.values_at(:host, :port, :db).any?
-        warn "Deprecated: please specify Redis connection as URL (\"redis://host:port/db\")"
-        establish_connection :adapter=>"redis", :host=>@options[:host], :port=>@options[:port], :database=>@options[:db] || @options[:database]
-      elsif @options[:redis]
-        @adapter = RedisAdapter.new(:redis=>@options[:redis])
-      else
-        connection_spec = args.shift || @options[:connection]
-        if connection_spec
-          connection_spec = "redis://" + connection_spec unless connection_spec[/^\w+:/]
-          establish_connection connection_spec
-        end
-      end
 
       warn "Deprecated: namespace option no longer supported directly" if @options[:namespace]
       @load_path = @options[:load_path] || DEFAULTS[:load_path]
@@ -58,12 +47,15 @@ module Vanity
         @logger = Logger.new(STDOUT)
         @logger.level = Logger::ERROR
       end
+
+      autoconnect(@options, args) if Vanity::Autoconnect.playground_should_autoconnect?
+
       @loading = []
       @use_js = false
       self.add_participant_path = DEFAULT_ADD_PARTICIPANT_PATH
       @collecting = !!@options[:collecting]
     end
-   
+
     # Deprecated. Use redis.server instead.
     attr_accessor :host, :port, :db, :password, :namespace
 
@@ -219,7 +211,7 @@ module Vanity
 
 
     # -- Connection management --
- 
+
     # This is the preferred way to programmatically create a new connection (or
     # switch to a new connection). If no connection was established, the
     # playground will create a new one by calling this method with no arguments.
@@ -242,7 +234,7 @@ module Vanity
     #   Vanity.playground.establish_connection :adapter=>:redis,
     #                                          :host=>"redis.local"
     #
-    # @since 1.4.0 
+    # @since 1.4.0
     def establish_connection(spec = nil)
       @spec = spec
       disconnect! if @adapter
@@ -343,6 +335,23 @@ module Vanity
       connection
     end
 
+    protected
+
+    def autoconnect(options, arguments)
+      if options[:host] == 'redis' && options.values_at(:host, :port, :db).any?
+        warn "Deprecated: please specify Redis connection as URL (\"redis://host:port/db\")"
+        establish_connection :adapter=>"redis", :host=>options[:host], :port=>options[:port], :database=>options[:db] || options[:database]
+      elsif options[:redis]
+        @adapter = RedisAdapter.new(:redis=>options[:redis])
+      else
+        connection_spec = arguments.shift || options[:connection]
+        if connection_spec
+          connection_spec = "redis://" + connection_spec unless connection_spec[/^\w+:/]
+          establish_connection connection_spec
+        end
+      end
+    end
+
   end
 
   # In the case of Rails, use the Rails logger and collect only for

data/lib/vanity/version.rb

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

data/test/autoconnect_test.rb

@@ -0,0 +1,25 @@
+require "test/test_helper"
+
+context ".playground_should_autoconnect?" do
+
+  setup do
+  end
+
+  test "returns true by default" do
+    autoconnect = Vanity::Autoconnect.playground_should_autoconnect?
+    assert autoconnect == true
+  end
+
+  test "returns false if environment flag is set" do
+    ENV['VANITY_DISABLED'] = '1'
+    autoconnect = Vanity::Autoconnect.playground_should_autoconnect?
+    assert autoconnect == false
+    ENV['VANITY_DISABLED'] = nil
+  end
+
+  test "returns false if in assets:precompile rake task" do
+    Rake.expects(:application).returns(stub(:top_level_tasks => ['assets:precompile']))
+    autoconnect = Vanity::Autoconnect.playground_should_autoconnect?
+    assert autoconnect == false
+  end
+end

data/test/dummy/config/boot.rb

@@ -1,10 +1,8 @@
 require 'rubygems'
-gemfile = File.expand_path('../../../../Gemfile', __FILE__)
 
-if File.exist?(gemfile)
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler'
-  Bundler.setup
-end
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
 
 $:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/environments/development.rb

@@ -11,7 +11,7 @@ Dummy::Application.configure do
 
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
-  config.action_view.debug_rjs             = true
+  config.action_view.debug_rjs             = true if ActionView::Base.respond_to?(:debug_rjs=)
   config.action_controller.perform_caching = false
 
   # Don't care if the mailer can't send

data/test/experiment/ab_test.rb

@@ -35,6 +35,15 @@ class AbTestTest < ActionController::TestCase
     metric "Coolness"
   end
 
+  def teardown
+    super
+    if RUBY_VERSION == '1.8.7'
+      GC.enable
+      GC.start
+      GC.disable
+    end
+  end
+
   # --  Experiment definition --
 
   def test_requires_at_least_two_alternatives_per_experiment
@@ -53,7 +62,7 @@ class AbTestTest < ActionController::TestCase
       metrics :coolness
     end
   end
-  
+
   def test_returning_alternative_by_value
     new_ab_test :abcd do
       alternatives :a, :b, :c, :d
@@ -137,6 +146,33 @@ class AbTestTest < ActionController::TestCase
     assert_equal 0, alts.map(&:participants).sum
   end
 
+  # -- on_assignment --
+
+  def test_calls_on_assignment_on_new_assignment
+    on_assignment_called_times = 0
+    new_ab_test :foobar do
+      alternatives "foo", "bar"
+      identify { "6e98ec" }
+      metrics :coolness
+      on_assignment { on_assignment_called_times = on_assignment_called_times+1 }
+    end
+    2.times { experiment(:foobar).choose }
+    assert_equal 1, on_assignment_called_times
+  end
+
+  def test_returns_the_same_alternative_consistently_when_on_assignment_is_set
+    new_ab_test :foobar do
+      alternatives "foo", "bar"
+      identify { "6e98ec" }
+      on_assignment {}
+      metrics :coolness
+    end
+    assert value = experiment(:foobar).choose.value
+    assert_match /foo|bar/, value
+    1000.times do
+      assert_equal value, experiment(:foobar).choose.value
+    end
+  end
 
   # -- Running experiment --
 
@@ -288,7 +324,7 @@ class AbTestTest < ActionController::TestCase
 
 
   # -- Testing with tests --
-  
+
   def test_with_given_choice
     new_ab_test :simple do
       alternatives :a, :b, :c
@@ -329,7 +365,7 @@ class AbTestTest < ActionController::TestCase
 
 
   # -- Scoring --
-  
+
   def test_scoring
     new_ab_test :abcd do
       alternatives :a, :b, :c, :d
@@ -601,7 +637,7 @@ This experiment did not run long enough to find a clear winner.
 
 
   # -- Outcome --
-  
+
   def test_completion_outcome
     new_ab_test :quick do
       outcome_is { alternatives[1] }