vanity 2.0.1 → 2.1.0

data/test/experiment/base_test.rb

@@ -9,7 +9,7 @@ describe Vanity::Experiment::Base do
   # -- Defining experiment --
 
   it "can access experiment by id" do
-    exp = new_ab_test(:ice_cream_flavor) { metrics :happiness }
+    exp = new_ab_test(:ice_cream_flavor) { metrics :happiness; default false }
     assert_equal exp, experiment(:ice_cream_flavor)
   end
 
@@ -17,8 +17,10 @@ describe Vanity::Experiment::Base do
     File.open "tmp/experiments/ice_cream_flavor.rb", "w" do |f|
       f.write <<-RUBY
         ab_test "Ice Cream Flavor" do
+          default false
         end
         ab_test "Ice Cream Flavor" do
+          default false
         end
       RUBY
     end
@@ -44,6 +46,7 @@ describe Vanity::Experiment::Base do
           def xmts
             "x"
           end
+          default false
         end
       RUBY
     end
@@ -72,8 +75,8 @@ describe Vanity::Experiment::Base do
   end
 
   it "reloading experiments" do
-    new_ab_test(:ab) { metrics :happiness }
-    new_ab_test(:cd) { metrics :happiness }
+    new_ab_test(:ab) { metrics :happiness; default false }
+    new_ab_test(:cd) { metrics :happiness; default false }
     assert_equal 2, Vanity.playground.experiments.size
     Vanity.playground.reload!
     assert Vanity.playground.experiments.empty?
@@ -83,7 +86,7 @@ describe Vanity::Experiment::Base do
   # -- Attributes --
 
   it "maps the experiment name to id" do
-    experiment = new_ab_test("Ice Cream Flavor/Tastes") { metrics :happiness }
+    experiment = new_ab_test("Ice Cream Flavor/Tastes") { metrics :happiness; default false }
     assert_equal "Ice Cream Flavor/Tastes", experiment.name
     assert_equal :ice_cream_flavor_tastes, experiment.id
   end
@@ -92,15 +95,17 @@ describe Vanity::Experiment::Base do
     File.open "tmp/experiments/ice_cream_flavor.rb", "w" do |f|
       f.write <<-RUBY
         ab_test "Ice Cream Flavor" do
+          default false
         end
       RUBY
     end
     Vanity.unload!
+    metric :happiness
     Vanity.playground.experiment(:ice_cream_flavor)
   end
 
   it "has created timestamp" do
-    new_ab_test(:ice_cream_flavor) { metrics :happiness }
+    new_ab_test(:ice_cream_flavor) { metrics :happiness; default false }
     assert_kind_of Time, experiment(:ice_cream_flavor).created_at
     assert_in_delta experiment(:ice_cream_flavor).created_at.to_i, Time.now.to_i, 1
   end
@@ -108,12 +113,12 @@ describe Vanity::Experiment::Base do
   it "keeps created timestamp across definitions" do
     past = Date.today - 1
     Timecop.freeze past.to_time do
-      new_ab_test(:ice_cream_flavor) { metrics :happiness }
+      new_ab_test(:ice_cream_flavor) { metrics :happiness; default false }
     end
 
     vanity_reset
     metric :happiness
-    new_ab_test(:ice_cream_flavor) { metrics :happiness }
+    new_ab_test(:ice_cream_flavor) { metrics :happiness; default false }
     assert_equal past.to_time.to_i, experiment(:ice_cream_flavor).created_at.to_i
   end
 
@@ -121,13 +126,14 @@ describe Vanity::Experiment::Base do
     new_ab_test :ice_cream_flavor do
       description "Because 31 is not enough ..."
       metrics :happiness
+      default false
     end
     assert_equal "Because 31 is not enough ...", experiment(:ice_cream_flavor).description
   end
 
   it "stores nothing when collection disabled" do
     not_collecting!
-    new_ab_test(:ice_cream_flavor) { metrics :happiness }
+    new_ab_test(:ice_cream_flavor) { metrics :happiness; default false }
     experiment(:ice_cream_flavor).complete!
   end
 
@@ -136,7 +142,7 @@ describe Vanity::Experiment::Base do
   # check_completion is called by derived classes, but since it's
   # part of the base_test I'm testing it here.
   it "handles error in check completion" do
-    new_ab_test(:ab) { metrics :happiness }
+    new_ab_test(:ab) { metrics :happiness; default false }
     e = experiment(:ab)
     e.complete_if { true }
     e.stubs(:complete!).raises(RuntimeError, "A forced error")
@@ -146,7 +152,7 @@ describe Vanity::Experiment::Base do
   end
 
   it "complete updates completed_at" do
-    new_ab_test(:ice_cream_flavor) { metrics :happiness }
+    new_ab_test(:ice_cream_flavor) { metrics :happiness; default false }
 
     time = Time.utc(2008, 9, 1, 12, 0, 0)
     Timecop.freeze(time) do

data/test/frameworks/rails/action_controller_test.rb

@@ -33,6 +33,8 @@ class UseVanityControllerTest < ActionController::TestCase
     metric :sugar_high
     new_ab_test :pie_or_cake do
       metrics :sugar_high
+      alternatives :pie, :cake
+      default :pie
     end
 
     # Class eval this instead of including in the controller to delay
@@ -64,13 +66,13 @@ class UseVanityControllerTest < ActionController::TestCase
   end
 
   def test_chooses_sets_alternatives_for_rails_tests
-    experiment(:pie_or_cake).chooses(true)
+    experiment(:pie_or_cake).chooses(:pie)
     get :index
-    assert_equal 'true', @response.body
+    assert_equal 'pie', @response.body
 
-    experiment(:pie_or_cake).chooses(false)
+    experiment(:pie_or_cake).chooses(:cake)
     get :index
-    assert_equal 'false', @response.body
+    assert_equal 'cake', @response.body
   end
 
   def test_adds_participant_to_experiment
@@ -91,7 +93,7 @@ class UseVanityControllerTest < ActionController::TestCase
     assert_match /vanity_id=[a-f0-9]{32};/, cookie
     expires = cookie[/expires=(.*)(;|$)/, 1]
     assert expires
-    assert_in_delta Time.parse(expires), Time.now + 1.month, 1.day
+    assert_in_delta Time.parse(expires), Time.now + 20 * 365 * 24 * 60 * 60, 1.day
   end
 
   def test_vanity_cookie_default_id
@@ -105,6 +107,12 @@ class UseVanityControllerTest < ActionController::TestCase
     assert_equal "from_last_time",  cookies["vanity_id"]
   end
 
+  def test_vanity_cookie_uses_configuration
+    Vanity.configuration.cookie_name = "new_id"
+    get :index
+    assert cookies["new_id"] =~ /^[a-f0-9]{32}$/
+  end
+
   def test_vanity_identity_set_from_cookie
     @request.cookies["vanity_id"] = "from_last_time"
     get :index
@@ -204,4 +212,4 @@ class UseVanityControllerTest < ActionController::TestCase
     assert_match /domain=.foo.bar/, @response["Set-Cookie"] if ::Rails.respond_to?(:application)
   end
 
-end
+end

data/test/frameworks/rails/action_mailer_test.rb

@@ -28,13 +28,15 @@ class UseVanityMailerTest < ActionMailer::TestCase
     metric :sugar_high
     new_ab_test :pie_or_cake do
       metrics :sugar_high
+      alternatives :pie, :cake
+      default :pie
     end
   end
 
   def test_js_enabled_still_adds_participant
     Vanity.playground.use_js!
     experiment(:pie_or_cake).identify { }
-    experiment(:pie_or_cake).chooses(true)
+    experiment(:pie_or_cake).chooses(:pie)
     VanityMailer.ab_test_subject(nil)
 
 
@@ -45,13 +47,13 @@ class UseVanityMailerTest < ActionMailer::TestCase
   def test_returns_different_alternatives
     experiment(:pie_or_cake).identify { }
 
-    experiment(:pie_or_cake).chooses(true)
+    experiment(:pie_or_cake).chooses(:pie)
     email = VanityMailer.ab_test_subject(nil)
-    assert_equal 'true', email.subject
+    assert_equal 'pie', email.subject
 
-    experiment(:pie_or_cake).chooses(false)
+    experiment(:pie_or_cake).chooses(:cake)
     email = VanityMailer.ab_test_subject(nil)
-    assert_equal 'false', email.subject
+    assert_equal 'cake', email.subject
   end
 
   def test_tracking_image_is_rendered
@@ -59,4 +61,4 @@ class UseVanityMailerTest < ActionMailer::TestCase
     assert email.body =~ /<img/
     assert email.body =~ /_identity=/
   end
-end
+end

data/test/frameworks/rails/action_view_test.rb

@@ -10,6 +10,7 @@ class RailsHelperTest < ActionView::TestCase
       metrics :sugar_high
       identify { '1' }
       alternatives :pie, :cake
+      default :pie
     end
   end
 

data/test/helper_test.rb

@@ -6,6 +6,7 @@ describe Vanity::Helpers do
       metric "Coolness"
       new_ab_test :foobar do
         alternatives "foo", "bar"
+        default "foo"
         metrics :coolness
       end
       Vanity.track!(:coolness, :identity=>'quux')
@@ -17,6 +18,7 @@ describe Vanity::Helpers do
       metric "Coolness"
       new_ab_test :foobar do
         alternatives "foo", "bar"
+        default "foo"
         metrics :coolness
       end
       Vanity.track!(:coolness, :identity=>'quux', :values=>[2])

data/test/metric/active_record_test.rb

@@ -1,7 +1,15 @@
 require "test_helper"
 
+class User < ActiveRecord::Base
+  has_many :skies
+
+  attr_accessible :height if defined?(ProtectedAttributes)
+end
 class Sky < ActiveRecord::Base
+  belongs_to :user
   scope :high, lambda { where("height >= 4") }
+
+  attr_accessible :height if defined?(ProtectedAttributes)
 end
 
 if ENV["DB"] == "active_record"
@@ -9,13 +17,20 @@ if ENV["DB"] == "active_record"
 describe Vanity::Metric::ActiveRecord do
 
   before do
+    User.connection.create_table(:users) do |t|
+      t.timestamps
+    end
     Sky.connection.create_table(:skies) do |t|
+      t.integer :user_id
       t.integer :height
       t.timestamps
     end
   end
 
   after do
+    User.connection.drop_table(:users) if User.connection.table_exists?(User.table_name)
+    User.reset_callbacks(:create)
+    User.reset_callbacks(:save)
     Sky.connection.drop_table(:skies) if Sky.connection.table_exists?(Sky.table_name)
     Sky.reset_callbacks(:create)
     Sky.reset_callbacks(:save)
@@ -235,6 +250,47 @@ describe Vanity::Metric::ActiveRecord do
     assert_equal 2, times
   end
 
+  it "with model identity" do
+    File.open "tmp/experiments/metrics/sky_is_limit.rb", "w" do |f|
+      f.write <<-RUBY
+        metric "Sky is limit" do
+          model Sky, :identity => lambda { |record| record.user_id }
+        end
+      RUBY
+    end
+
+    File.open "tmp/experiments/simple.rb", "w" do |f|
+      f.write <<-RUBY
+        ab_test "simple" do
+          metrics :sky_is_limit
+          alternatives :a, :b
+          identity { "me" }
+        end
+      RUBY
+    end
+
+    user = User.create
+    Vanity.context = stub(vanity_identity: user.id)
+    experiment = Vanity.playground.experiment(:simple)
+    experiment.choose
+
+    Vanity.context = nil
+    # Should count as a conversion for the user in the experiment.
+    user.skies.create
+
+    # Should count as a conversion for the newly created User.
+    User.create.skies.create
+
+    Vanity.context = stub(vanity_identity: "other")
+    experiment.choose
+    # Should count as a conversion for "other"
+    Sky.create
+
+    assert_equal 3, Sky.count
+    assert_equal 2, experiment.alternatives.map(&:participants).sum
+    assert_equal 3, experiment.alternatives.map(&:conversions).sum
+  end
+
   it "do it yourself" do
     File.open "tmp/experiments/metrics/sky_is_limit.rb", "w" do |f|
       f.write <<-RUBY

data/test/playground_test.rb

@@ -19,6 +19,7 @@ describe Vanity::Playground do
       f.write <<-RUBY
         ab_test :foobar do
           metrics :coolness
+          default false
         end
       RUBY
     end
@@ -84,6 +85,7 @@ describe Vanity::Playground do
         alternatives "foo", "bar"
         identify { "abcdef" }
         metrics :coolness
+        default "foo"
       end
 
       assert Vanity.playground.experiments_persisted?
@@ -122,6 +124,7 @@ describe Vanity::Playground do
         alternatives "foo", "bar"
         identify { "abcdef" }
         metrics :coolness
+        default "foo"
       end
       alt = experiment(:foobar).choose
       assert_equal [[Vanity.playground.experiment(:foobar), alt]], Vanity.playground.participant_info("abcdef")

data/test/test_helper.rb

@@ -81,6 +81,23 @@ module VanityTestHelpers
     Vanity.unload!
   end
 
+  # Call this on teardown. It wipes put the playground and any state held in it
+  # (mostly experiments), resets vanity ID, and clears database of all experiments.
+  def nuke_playground
+    Vanity.playground.connection.flushdb
+    new_playground
+  end
+
+  # Call this if you need a new playground, e.g. to re-define the same experiment,
+  # or reload an experiment (saved by the previous playground).
+  def new_playground
+    Vanity.playground = Vanity::Playground.new
+    Vanity.disconnect!
+    ActiveRecord::Base.establish_connection
+    Vanity.connect!(DATABASE)
+  end
+
+
   # Defines the specified metrics (one or more names). Returns metric, or array
   # of metric (if more than one argument).
   def metric(*names)
@@ -92,11 +109,20 @@ module VanityTestHelpers
   end
 
   # Defines an A/B experiment.
-  def new_ab_test(name, &block)
+  # @param [Hash] options Options include:
+  #   [Boolean] enable (default true) - Whether or not to enable this ab_test when it gets instantiated;
+  # this flag is here to simply the testing of experiment features, and also to allow
+  # testing of the default behavior of an experiment when it gets loaded.
+  # Note that :enable => false does NOT mean to set the ab_test to false; it
+  # means to not set enabled at all (the 'actual' behavior).
+  def new_ab_test(name, options = {}, &block)
+    enable = options.fetch(:enable, true)
     id = name.to_s.downcase.gsub(/\W/, "_").to_sym
     experiment = Vanity::Experiment::AbTest.new(Vanity.playground, id, name)
-    experiment.instance_eval(&block)
+    experiment.instance_eval &block if block
     experiment.save
+    # new experiments start off as disabled, enable them for testing
+    experiment.enabled = true if enable
     Vanity.playground.experiments[id] = experiment
   end
 

data/test/web/rails/dashboard_test.rb

@@ -14,12 +14,14 @@ class RailsDashboardTest < ActionController::TestCase
     new_ab_test :food do
       alternatives :apple, :orange
       metrics :sugar_high
+      default :apple
       identify { '1' }
     end
 
     metric :liquidity
     new_ab_test :drink do
       alternatives :tea, :coffee
+      default :tea
       metrics :liquidity
       identify { '1' }
     end

data/vanity.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |spec|
   spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.extra_rdoc_files = "README.rdoc", "CHANGELOG"
-  spec.rdoc_options     = "--title", "Vanity #{spec.version}", "--main", "README.rdoc",
+  spec.extra_rdoc_files = "README.md", "CHANGELOG"
+  spec.rdoc_options     = "--title", "Vanity #{spec.version}", "--main", "README.md",
                           "--webcvs", "http://github.com/assaf/#{spec.name}"
 
   spec.required_ruby_version = ">= 1.9.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vanity
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Assaf Arkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-18 00:00:00.000000000 Z
+date: 2016-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -58,7 +58,7 @@ executables:
 - vanity
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 - CHANGELOG
 files:
 - .autotest
@@ -69,7 +69,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - bin/vanity
 - doc/_config.yml
@@ -99,12 +99,12 @@ files:
 - doc/site.js
 - gemfiles/rails32.gemfile
 - gemfiles/rails32.gemfile.lock
-- gemfiles/rails4.gemfile
-- gemfiles/rails4.gemfile.lock
 - gemfiles/rails41.gemfile
 - gemfiles/rails41.gemfile.lock
 - gemfiles/rails42.gemfile
 - gemfiles/rails42.gemfile.lock
+- gemfiles/rails42_protected_attributes.gemfile
+- gemfiles/rails42_protected_attributes.gemfile.lock
 - lib/generators/templates/vanity_migration.rb
 - lib/generators/vanity/views_generator.rb
 - lib/generators/vanity_generator.rb
@@ -211,9 +211,9 @@ metadata: {}
 post_install_message: To get started run vanity --help
 rdoc_options:
 - --title
-- Vanity 2.0.1
+- Vanity 2.1.0
 - --main
-- README.rdoc
+- README.md
 - --webcvs
 - http://github.com/assaf/vanity
 require_paths: