vanity 1.2.0 → 1.3.0

data/test/rails_test.rb

@@ -15,7 +15,7 @@ class UseVanityTest < ActionController::TestCase
   def setup
     super
     metric :sugar_high
-    Vanity.playground.define :pie_or_cake, :ab_test do
+    new_ab_test :pie_or_cake do
       metrics :sugar_high
     end
     UseVanityController.class_eval do
@@ -72,6 +72,134 @@ class UseVanityTest < ActionController::TestCase
     assert_equal "576", @controller.send(:vanity_identity)
   end
 
+  # query parameter filter
+
+  def test_redirects_and_loses_vanity_query_parameter
+    get :index, :foo=>"bar", :_vanity=>"567"
+    assert_redirected_to "/use_vanity?foo=bar"
+  end
+
+  def test_sets_choices_from_vanity_query_parameter
+    first = experiment(:pie_or_cake).alternatives.first
+    # experiment(:pie_or_cake).fingerprint(first)
+    10.times do
+      @controller = nil ; setup_controller_request_and_response
+      get :index, :_vanity=>"aae9ff8081"
+      assert !experiment(:pie_or_cake).choose
+      assert experiment(:pie_or_cake).showing?(first)
+    end
+  end
+
+  def test_does_nothing_with_vanity_query_parameter_for_posts
+    first = experiment(:pie_or_cake).alternatives.first
+    post :index, :foo=>"bar", :_vanity=>"567"
+    assert_response :success
+    assert !experiment(:pie_or_cake).showing?(first)
+  end
+
+
+  # -- Load path --
+
+  def test_load_path
+    assert_equal File.expand_path("tmp/experiments"), load_rails(<<-RB)
+initializer.after_initialize
+$stdout << Vanity.playground.load_path
+    RB
+  end
+
+  def test_settable_load_path
+    assert_equal File.expand_path("tmp/predictions"), load_rails(<<-RB)
+Vanity.playground.load_path = "predictions"
+initializer.after_initialize
+$stdout << Vanity.playground.load_path
+    RB
+  end
+
+  def test_absolute_load_path
+    assert_equal File.expand_path("/tmp/var"), load_rails(<<-RB)
+Vanity.playground.load_path = "/tmp/var"
+initializer.after_initialize
+$stdout << Vanity.playground.load_path
+    RB
+  end
+
+
+  # -- Connection configuration --
+
+  def test_default_connection
+    assert_equal "localhost:6379", load_rails(<<-RB)
+initializer.after_initialize
+$stdout << Vanity.playground.redis.server
+    RB
+  end
+
+  def test_configured_connection
+    assert_equal "127.0.0.1:6379", load_rails(<<-RB)
+Vanity.playground.redis = "127.0.0.1:6379"
+initializer.after_initialize
+$stdout << Vanity.playground.redis.server
+    RB
+  end
+
+  def test_test_connection
+    assert_equal "Vanity::MockRedis", load_rails(<<-RB)
+Vanity.playground.test!
+initializer.after_initialize
+$stdout << Vanity.playground.redis.class
+    RB
+  end
+
+  def test_connection_from_yaml
+    FileUtils.mkpath "tmp/config"
+    yml = File.open("tmp/config/redis.yml", "w")
+    yml << "production: internal.local:6379\n"
+    yml.flush
+    assert_equal "internal.local:6379", load_rails(<<-RB)
+initializer.after_initialize
+$stdout << Vanity.playground.redis.server
+    RB
+  ensure
+    File.unlink yml
+  end
+
+  def test_connection_from_yaml_missing
+    FileUtils.mkpath "tmp/config"
+    yml = File.open("tmp/config/redis.yml", "w")
+    yml << "development: internal.local:6379\n"
+    yml.flush
+    assert_equal "localhost:6379", load_rails(<<-RB)
+initializer.after_initialize
+$stdout << Vanity.playground.redis.server
+    RB
+  ensure
+    File.unlink yml
+  end
+
+
+  def load_rails(code)
+    tmp = Tempfile.open("test.rb")
+    tmp.write <<-RB
+$:.delete_if { |path| path[/gems\\/vanity-\\d/] }
+$:.unshift File.expand_path("../lib")
+RAILS_ROOT = File.expand_path(".")
+RAILS_ENV = "production"
+require "initializer"
+require "active_support"
+Rails.configuration = Rails::Configuration.new
+initializer = Rails::Initializer.new(Rails.configuration)
+initializer.check_gem_dependencies
+require "vanity"
+    RB
+    tmp.write code
+    tmp.flush
+    Dir.chdir "tmp" do
+      open("|ruby #{tmp.path}").read
+    end
+  rescue
+    tmp.close!
+  end
+
+
   def teardown
     super
     UseVanityController.send(:filter_chain).clear

data/test/test_helper.rb

@@ -8,6 +8,7 @@ require "action_controller/test_case"
 require "active_record"
 require "initializer"
 Rails.configuration = Rails::Configuration.new
+require "phusion_passenger/events"
 require "lib/vanity"
 require "timecop"
 
@@ -15,8 +16,6 @@ require "timecop"
 if $VERBOSE
   $logger = Logger.new(STDOUT)
   $logger.level = Logger::DEBUG
-else
-  $logger = Logger.new("/dev/null")
 end
 
 class Test::Unit::TestCase
@@ -36,8 +35,8 @@ class Test::Unit::TestCase
   # 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(:logger=>$logger, :load_path=>"tmp/experiments", :db=>15)
-    Vanity.playground.mock! unless ENV["REDIS"]
+    Vanity.playground = Vanity::Playground.new("::15", :logger=>$logger, :load_path=>"tmp/experiments")
+    #Vanity.playground.mock! unless ENV["REDIS"]
   end
 
   # Defines the specified metrics (one or more names).  Returns metric, or array
@@ -50,6 +49,15 @@ class Test::Unit::TestCase
     names.size == 1 ? metrics.first : metrics
   end
 
+  # Defines an A/B experiment.
+  def new_ab_test(name, &block)
+    id = name.to_s.downcase.gsub(/\W/, "_").to_sym
+    experiment = Vanity::Experiment::AbTest.new(Vanity.playground, id, name)
+    experiment.instance_eval &block
+    experiment.save
+    Vanity.playground.experiments[id] = experiment
+  end
+
   # Returns named experiment.
   def experiment(name)
     Vanity.playground.experiment(name)

data/vanity.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name           = "vanity"
-  spec.version        = "1.2.0"
+  spec.version        = "1.3.0"
   spec.author         = "Assaf Arkin"
   spec.email          = "assaf@labnotes.org"
   spec.homepage       = "http://vanity.labnotes.org"
@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.description    = "Mirror, mirror on the wall ..."
   spec.post_install_message = "To get started run vanity --help"
 
-  spec.files          = Dir["{bin,lib,vendor,test}/**/*", "CHANGELOG", "MIT-LICENSE", "README.rdoc", "vanity.gemspec"]
+  spec.files          = Dir["{bin,lib,vendor,test}/**/*", "CHANGELOG", "MIT-LICENSE", "README.rdoc", "Rakefile", "Gemfile", "vanity.gemspec"]
   spec.executable     = "vanity"
 
   spec.has_rdoc         = true

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: vanity
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  prerelease: false
+  segments: 
+  - 1
+  - 3
+  - 0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Assaf Arkin
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-14 00:00:00 -08:00
+date: 2010-03-01 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -25,18 +30,18 @@ extra_rdoc_files:
 files: 
 - bin/vanity
 - lib/vanity/backport.rb
+- lib/vanity/commands/list.rb
 - lib/vanity/commands/report.rb
 - lib/vanity/commands.rb
 - lib/vanity/experiment/ab_test.rb
 - lib/vanity/experiment/base.rb
+- lib/vanity/frameworks/rails.rb
 - lib/vanity/helpers.rb
-- lib/vanity/metric.rb
+- lib/vanity/metric/active_record.rb
+- lib/vanity/metric/base.rb
+- lib/vanity/metric/google_analytics.rb
 - lib/vanity/mock_redis.rb
 - lib/vanity/playground.rb
-- lib/vanity/rails/dashboard.rb
-- lib/vanity/rails/helpers.rb
-- lib/vanity/rails/testing.rb
-- lib/vanity/rails.rb
 - lib/vanity/templates/_ab_test.erb
 - lib/vanity/templates/_experiment.erb
 - lib/vanity/templates/_experiments.erb
@@ -48,6 +53,38 @@ files:
 - lib/vanity/templates/vanity.css
 - lib/vanity/templates/vanity.js
 - lib/vanity.rb
+- vendor/cache/actionmailer-2.3.5.gem
+- vendor/cache/actionpack-2.3.5.gem
+- vendor/cache/activerecord-2.3.5.gem
+- vendor/cache/activeresource-2.3.5.gem
+- vendor/cache/activesupport-2.3.5.gem
+- vendor/cache/autotest-4.2.7.gem
+- vendor/cache/autotest-fsevent-0.2.1.gem
+- vendor/cache/autotest-growl-0.2.0.gem
+- vendor/cache/bundler-0.9.7.gem
+- vendor/cache/classifier-1.3.1.gem
+- vendor/cache/directory_watcher-1.3.1.gem
+- vendor/cache/fastthread-1.0.7.gem
+- vendor/cache/garb-0.7.0.gem
+- vendor/cache/happymapper-0.3.0.gem
+- vendor/cache/jekyll-0.5.7.gem
+- vendor/cache/libxml-ruby-1.1.3.gem
+- vendor/cache/liquid-2.0.0.gem
+- vendor/cache/maruku-0.6.0.gem
+- vendor/cache/mocha-0.9.8.gem
+- vendor/cache/open4-1.0.1.gem
+- vendor/cache/passenger-2.2.9.gem
+- vendor/cache/rack-1.0.1.gem
+- vendor/cache/rails-2.3.5.gem
+- vendor/cache/rake-0.8.7.gem
+- vendor/cache/RedCloth-4.2.2.gem
+- vendor/cache/rubygems-update-1.3.5.gem
+- vendor/cache/shoulda-2.10.3.gem
+- vendor/cache/sqlite3-ruby-1.2.5.gem
+- vendor/cache/stemmer-1.0.1.gem
+- vendor/cache/syntax-1.0.0.gem
+- vendor/cache/sys-uname-0.8.4.gem
+- vendor/cache/timecop-0.3.4.gem
 - vendor/redis-rb/bench.rb
 - vendor/redis-rb/benchmarking/suite.rb
 - vendor/redis-rb/benchmarking/worker.rb
@@ -78,12 +115,22 @@ files:
 - test/experiments/metrics/yawns.rb
 - test/experiments/null_abc.rb
 - test/metric_test.rb
+- test/myapp/app/controllers/application_controller.rb
+- test/myapp/app/controllers/main_controller.rb
+- test/myapp/config/boot.rb
+- test/myapp/config/environment.rb
+- test/myapp/config/environments/production.rb
+- test/myapp/config/routes.rb
+- test/myapp/log/production.log
+- test/passenger_test.rb
 - test/playground_test.rb
 - test/rails_test.rb
 - test/test_helper.rb
 - CHANGELOG
 - MIT-LICENSE
 - README.rdoc
+- Rakefile
+- Gemfile
 - vanity.gemspec
 has_rdoc: true
 homepage: http://vanity.labnotes.org
@@ -92,7 +139,7 @@ licenses: []
 post_install_message: To get started run vanity --help
 rdoc_options: 
 - --title
-- Vanity 1.2.0
+- Vanity 1.3.0
 - --main
 - README.rdoc
 - --webcvs
@@ -103,18 +150,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Experience Driven Development framework for Rails

data/lib/vanity/rails.rb

@@ -1,22 +0,0 @@
-require "vanity/rails/helpers"
-require "vanity/rails/testing"
-require "vanity/rails/dashboard"
-
-# Include in controller, add view helper methods.
-ActionController::Base.class_eval do
-  extend Vanity::Rails::ClassMethods
-  include Vanity::Rails
-  helper Vanity::Rails
-end
-
-Rails.configuration.after_initialize do
-  # Use Rails logger by default.
-  Vanity.playground.logger ||= ActionController::Base.logger
-  Vanity.playground.load_path = "#{RAILS_ROOT}/experiments"
-
-  # Do this at the very end of initialization, allowing test environment to do
-  # Vanity.playground.mock! before any database access takes place.
-  Rails.configuration.after_initialize do
-    Vanity.playground.load!
-  end
-end

data/lib/vanity/rails/dashboard.rb

@@ -1,24 +0,0 @@
-module Vanity
-  module Rails
-    # Step 1: Add a new resource in config/routes.rb:
-    #   map.vanity "/vanity/:action/:id", :controller=>:vanity
-    #
-    # Step 2: Create a new experiments controller:
-    #   class VanityController < ApplicationController
-    #     include Vanity::Rails::Dashboard
-    #   end
-    #
-    # Step 3: Open your browser to http://localhost:3000/vanity
-    module Dashboard
-      def index
-        render Vanity.template("_report"), :content_type=>Mime::HTML, :layout=>true
-      end
-
-      def chooses
-        exp = Vanity.playground.experiment(params[:e])
-        exp.chooses(exp.alternatives[params[:a].to_i].value)
-        render :partial=>Vanity.template("experiment"), :locals=>{ :experiment=>exp }
-      end
-    end
-  end
-end