lookout-vanity 1.8.2

data/test/myapp/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/test/myapp/app/controllers/main_controller.rb

@@ -0,0 +1,7 @@
+class MainController < ApplicationController
+  def index
+    render :text=>"#{Vanity.playground.connection}\n#{Vanity.playground.connection.object_id}"
+  rescue Error=>ex
+    puts $!
+  end
+end

data/test/myapp/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        min_version = '1.3.1'
+        require 'rubygems'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/test/myapp/config/environment.rb

@@ -0,0 +1,10 @@
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  config.frameworks -= [ :active_record, :active_resource, :action_mailer ]
+  config.action_controller.session = { :key=>"_myapp_session", :secret=>"Stay hungry. Stay foolish. -- Steve Jobs" }
+  config.after_initialize do
+    $:.unshift File.dirname(__FILE__) + "/../../../lib/"
+    require "vanity"
+  end
+end

data/test/myapp/config/routes.rb

@@ -0,0 +1,3 @@
+ActionController::Routing::Routes.draw do |map|
+  map.connect "/", :controller=>:main, :action=>:index
+end

data/test/passenger_test.rb

@@ -0,0 +1,45 @@
+require "test/test_helper"
+
+#not supported for rails3
+unless defined?(Rails::Railtie)
+require "phusion_passenger/spawn_manager"
+class PassengerTest < Test::Unit::TestCase
+  def setup
+    super
+    ActiveRecord::Base.connection.disconnect! # Otherwise AR metric tests fail
+    @original = Vanity.playground.connection
+    File.unlink "test/myapp/config/vanity.yml" rescue nil
+    File.open("test/myapp/config/vanity.yml", "w") do |io|
+      io.write YAML.dump({ "production"=>DATABASE })
+    end
+    @server = PhusionPassenger::SpawnManager.new
+    @server.start
+    Thread.pass until @server.started?
+    app_root = File.expand_path("myapp", File.dirname(__FILE__))
+    @app = @server.spawn_application "app_root"=>app_root, "spawn_method"=>"smart-lv2"
+  end
+
+  def test_reconnect
+    sleep 0.1
+    case @app.listen_socket_type
+    when "tcp" ; socket = TCPSocket.new(*@app.listen_socket_name.split(":"))
+    when "unix"; socket = UNIXSocket.new(@app.listen_socket_name)
+    else fail
+    end
+    channel = PhusionPassenger::MessageChannel.new(socket)
+    request = {"REQUEST_PATH"=>"/", "REQUEST_METHOD"=>"GET", "QUERY_STRING"=>" "}
+    channel.write_scalar request.to_a.join("\0")
+    response = socket.read.split("\r\n\r\n").last
+    socket.close
+    conn, obj_id = response.split("\n")
+    assert_equal @original.to_s, conn
+    assert_not_equal @original.object_id.to_s, obj_id
+  end
+
+  def teardown
+    super
+    @server.stop
+    File.unlink "test/myapp/config/vanity.yml"
+  end
+end
+end

data/test/playground_test.rb

@@ -0,0 +1,26 @@
+require "test/test_helper"
+
+class PlaygroundTest < Test::Unit::TestCase
+
+  def test_has_one_global_instance
+    assert instance = Vanity.playground
+    assert_equal instance, Vanity.playground
+  end
+
+  def test_be_use_js
+    assert !Vanity.playground.using_js?
+    Vanity.playground.use_js!
+    assert Vanity.playground.using_js?
+  end
+
+  def test_chooses_path_sets_default
+    assert_equal Vanity.playground.add_participant_path, Vanity::Playground::DEFAULT_ADD_PARTICIPANT_PATH
+  end
+
+  def test_reconnects_with_existing_connection
+    Vanity.playground.establish_connection "mock:/"
+    Vanity.playground.reconnect!
+    assert_equal Vanity.playground.connection.to_s, "mock:/"
+  end
+
+end

data/test/rails_dashboard_test.rb

@@ -0,0 +1,37 @@
+require "test/test_helper"
+
+class VanityController < ActionController::Base
+  include Vanity::Rails::Dashboard
+end
+
+# Pages accessible to everyone, e.g. sign in, community search.
+class RailsDashboardTest < ActionController::TestCase
+  tests VanityController
+
+  def setup
+    Vanity.playground.collecting = true
+    metric :sugar_high
+    new_ab_test :food do
+      alternatives :apple, :orange
+      metrics :sugar_high
+      identify { '1' }
+    end
+  end
+
+  def test_add_participant
+    xhr :post, :add_participant, :e => "food", :a => 0
+    assert_response :success
+    assert @response.body.blank?
+  end
+
+  def test_add_participant_no_params
+    xhr :post, :add_participant
+    assert_response :not_found
+    assert @response.body.blank?
+  end
+
+  def test_chooses
+    xhr :post, :chooses, :e => "food", :a => 0
+    assert_response :success
+  end
+end

data/test/rails_helper_test.rb

@@ -0,0 +1,38 @@
+require "test/test_helper"
+
+class RailsHelperTest < ActionView::TestCase
+  include Vanity::Rails::Helpers
+
+  def setup
+    super
+    metric :sugar_high
+    new_ab_test :pie_or_cake do
+      metrics :sugar_high
+      identify { '1' }
+      alternatives :pie, :cake
+    end
+  end
+
+  def test_ab_test_returns_one_of_the_alternatives
+    assert [:pie, :cake].include?(ab_test(:pie_or_cake))
+  end
+
+  def test_ab_test_using_js_returns_the_same_alternative
+    Vanity.playground.use_js!
+    result = ab_test(:pie_or_cake)
+    assert [:pie, :cake].include?(result)
+    10.times do 
+      assert result == ab_test(:pie_or_cake)
+    end
+  end
+  
+  def test_vanity_track_url_for_returns_url_with_identity_and_metrics
+    self.expects(:url_for).with(:controller => "controller", :action => "action", :_identity => '123', :_track => :sugar_high)
+    vanity_track_url_for("123", :sugar_high, :controller => "controller", :action => "action")
+  end
+  
+  def test_vanity_tracking_image
+    self.expects(:url_for).with(:controller => :vanity, :action => :image, :_identity => '123', :_track => :sugar_high).returns("/url")
+    assert_equal image_tag("/url", :width => "1px", :height => "1px", :alt => ""), vanity_tracking_image("123", :sugar_high, options = {})
+  end
+end

data/test/rails_test.rb

@@ -0,0 +1,412 @@
+require "test/test_helper"
+
+class UseVanityController < ActionController::Base
+  attr_accessor :current_user
+
+  def index
+    render :text=>ab_test(:pie_or_cake)
+  end
+
+  def js
+    ab_test(:pie_or_cake)
+    render :inline => "<%= vanity_js -%>"
+  end
+end
+
+# Pages accessible to everyone, e.g. sign in, community search.
+class UseVanityControllerTest < ActionController::TestCase
+  tests UseVanityController
+
+  def setup
+    super
+    metric :sugar_high
+    new_ab_test :pie_or_cake do
+      metrics :sugar_high
+    end
+    UseVanityController.class_eval do
+      use_vanity :current_user
+    end
+    if ::Rails.respond_to?(:application) # Rails 3 configuration
+      ::Rails.application.config.session_options[:domain] = '.foo.bar'
+    end
+  end
+
+  def test_render_js_for_tests
+    Vanity.playground.use_js!
+    get :js
+    assert_match /script.*e=pie_or_cake.*script/m, @response.body
+  end
+
+  def test_chooses_sets_alternatives_for_rails_tests
+    experiment(:pie_or_cake).chooses(true)
+    get :index
+    assert_equal 'true', @response.body
+ 
+    experiment(:pie_or_cake).chooses(false)
+    get :index
+    assert_equal 'false', @response.body
+  end
+
+
+  def test_vanity_cookie_is_persistent
+    get :index
+    cookie = @response["Set-Cookie"].to_s
+    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
+  end
+
+  def test_vanity_cookie_default_id
+    get :index
+    assert cookies['vanity_id'] =~ /^[a-f0-9]{32}$/
+  end
+
+  def test_vanity_cookie_retains_id
+    @request.cookies['vanity_id'] = "from_last_time"
+    get :index
+    assert_equal "from_last_time", cookies['vanity_id']
+  end
+
+  def test_vanity_identity_set_from_cookie
+    @request.cookies['vanity_id'] = "from_last_time"
+    get :index
+    assert_equal "from_last_time", @controller.send(:vanity_identity)
+  end
+
+  def test_vanity_identity_set_from_user
+    @controller.current_user = mock("user", :id=>"user_id")
+    get :index
+    assert_equal "user_id", @controller.send(:vanity_identity)
+  end
+
+  def test_vanity_identity_with_no_user_model
+    UseVanityController.class_eval do
+      use_vanity nil
+    end
+    @controller.current_user = Object.new
+    get :index
+    assert cookies['vanity_id'] =~ /^[a-f0-9]{32}$/
+  end
+
+  def test_vanity_identity_set_with_block
+    UseVanityController.class_eval do
+      attr_accessor :project_id
+      use_vanity { |controller| controller.project_id }
+    end
+    @controller.project_id = "576"
+    get :index
+    assert_equal "576", @controller.send(:vanity_identity)
+  end
+  
+  def test_vanity_identity_set_with_indentity_paramater
+    get :index, :_identity => "id_from_params"
+    assert_equal "id_from_params", @controller.send(:vanity_identity)
+    
+    @request.cookies['vanity_id'] = "old_id"
+    get :index, :_identity => "id_from_params"
+    assert_equal "id_from_params", @controller.send(:vanity_identity)
+    assert cookies['vanity_id'], "id_from_params"
+  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
+    fingerprint = experiment(:pie_or_cake).fingerprint(first)
+    10.times do
+      @controller = nil ; setup_controller_request_and_response
+      get :index, :_vanity => fingerprint
+      assert_equal experiment(:pie_or_cake).choose, experiment(:pie_or_cake).alternatives.first
+      assert experiment(:pie_or_cake).showing?(first)
+    end
+  end
+
+  def test_does_nothing_with_vanity_query_parameter_for_posts
+    experiment(:pie_or_cake).chooses(experiment(:pie_or_cake).alternatives.last.value)
+    first = experiment(:pie_or_cake).alternatives.first
+    fingerprint = experiment(:pie_or_cake).fingerprint(first)
+    post :index, :foo => "bar", :_vanity => fingerprint
+    assert_response :success
+    assert !experiment(:pie_or_cake).showing?(first)
+  end
+
+  def test_track_param_tracks_a_metric
+    get :index, :_identity => "123", :_track => "sugar_high"
+    assert_equal experiment(:pie_or_cake).alternatives[0].converted, 1
+  end
+  
+  def test_cookie_domain_from_rails_configuration
+    get :index
+    assert_match /domain=.foo.bar/, @response["Set-Cookie"] if ::Rails.respond_to?(:application)
+  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 --
+
+  if ENV['DB'] == 'redis'
+    def test_default_connection
+      assert_equal "redis://127.0.0.1:6379/0", load_rails(<<-RB)
+initializer.after_initialize
+$stdout << Vanity.playground.connection
+      RB
+    end
+
+    def test_connection_from_string
+      assert_equal "redis://192.168.1.1:6379/5", load_rails(<<-RB)
+Vanity.playground.establish_connection "redis://192.168.1.1:6379/5"
+initializer.after_initialize
+$stdout << Vanity.playground.connection
+      RB
+    end
+
+    def test_connection_from_yaml
+      FileUtils.mkpath "tmp/config"
+      ENV["RAILS_ENV"] = "production"
+      File.open("tmp/config/vanity.yml", "w") do |io|
+        io.write <<-YML
+production:
+  adapter: redis
+  host: somehost
+  database: 15
+        YML
+      end
+      assert_equal "redis://somehost:6379/15", load_rails(<<-RB)
+initializer.after_initialize
+$stdout << Vanity.playground.connection
+      RB
+    ensure
+      File.unlink "tmp/config/vanity.yml"
+    end
+
+    def test_connection_from_yaml_url
+      FileUtils.mkpath "tmp/config"
+      ENV["RAILS_ENV"] = "production"
+      File.open("tmp/config/vanity.yml", "w") do |io|
+        io.write <<-YML
+production: redis://somehost/15
+        YML
+      end
+      assert_equal "redis://somehost:6379/15", load_rails(<<-RB)
+initializer.after_initialize
+$stdout << Vanity.playground.connection
+      RB
+    ensure
+      File.unlink "tmp/config/vanity.yml"
+    end
+
+    def test_connection_from_yaml_with_erb
+      FileUtils.mkpath "tmp/config"
+      ENV["RAILS_ENV"] = "production"
+      # Pass storage URL through environment like heroku does
+      ENV["REDIS_URL"] = "redis://somehost:6379/15"
+      File.open("tmp/config/vanity.yml", "w") do |io|
+        io.write <<-YML
+production: <%= ENV['REDIS_URL'] %>
+        YML
+      end
+      assert_equal "redis://somehost:6379/15", load_rails(<<-RB)
+initializer.after_initialize
+$stdout << Vanity.playground.connection
+      RB
+    ensure
+      File.unlink "tmp/config/vanity.yml"
+    end
+
+    def test_connection_from_redis_yml
+      FileUtils.mkpath "tmp/config"
+      yml = File.open("tmp/config/redis.yml", "w")
+      yml << "production: internal.local:6379\n"
+      yml.flush
+      assert_equal "redis://internal.local:6379/0", load_rails(<<-RB)
+initializer.after_initialize
+$stdout << Vanity.playground.connection
+      RB
+    ensure
+      File.unlink yml.path
+    end
+  
+
+  end
+
+  if ENV['DB'] == 'mongo'
+    def test_mongo_connection_from_yaml
+      FileUtils.mkpath "tmp/config"
+      File.open("tmp/config/vanity.yml", "w") do |io|
+        io.write <<-YML
+mongodb:
+  adapter: mongodb
+  host: localhost
+  port: 27017
+  database: vanity_test
+        YML
+      end
+
+      assert_equal "mongodb://localhost:27017/vanity_test", load_rails(<<-RB, "mongodb")
+initializer.after_initialize
+$stdout << Vanity.playground.connection
+      RB
+    ensure
+      File.unlink "tmp/config/vanity.yml"
+    end
+
+    unless ENV['CI'] == 'true'
+      def test_mongodb_replica_set_connection
+        FileUtils.mkpath "tmp/config"
+        File.open("tmp/config/vanity.yml", "w") do |io|
+          io.write <<-YML
+mongodb:
+  adapter: mongodb
+  hosts:
+    - localhost
+  port: 27017
+  database: vanity_test
+          YML
+        end
+
+        assert_equal "mongodb://localhost:27017/vanity_test", load_rails(<<-RB, "mongodb")
+initializer.after_initialize
+$stdout << Vanity.playground.connection
+        RB
+
+        assert_equal "Mongo::ReplSetConnection", load_rails(<<-RB, "mongodb")
+initializer.after_initialize
+$stdout << Vanity.playground.connection.mongo.class
+        RB
+      ensure
+        File.unlink "tmp/config/vanity.yml"
+      end
+    end
+  end
+
+  def test_connection_from_yaml_missing
+    FileUtils.mkpath "tmp/config"
+    File.open("tmp/config/vanity.yml", "w") do |io|
+      io.write <<-YML
+production:
+  adapter: redis
+      YML
+    end
+    assert_equal "No configuration for development", load_rails(<<-RB, "development")
+initializer.after_initialize
+$stdout << (Vanity.playground.connection rescue $!.message)
+    RB
+  ensure
+    File.unlink "tmp/config/vanity.yml"
+  end
+
+  def test_collection_from_vanity_yaml
+    FileUtils.mkpath "tmp/config"
+    File.open("tmp/config/vanity.yml", "w") do |io|
+      io.write <<-YML
+production:
+  collecting: false
+      YML
+    end
+    assert_equal "false", load_rails(<<-RB)
+initializer.after_initialize
+$stdout << Vanity.playground.collecting?
+    RB
+  ensure
+    File.unlink "tmp/config/vanity.yml"
+  end
+
+  def test_collection_true_in_production_by_default
+    assert_equal "true", load_rails(<<-RB, "production")
+initializer.after_initialize
+$stdout << Vanity.playground.collecting?
+    RB
+  end
+
+  def test_collection_false_in_production_when_configured
+    assert_equal "false", load_rails(<<-RB, "production")
+Vanity.playground.collecting = false
+initializer.after_initialize
+$stdout << Vanity.playground.collecting?
+    RB
+  end
+
+  def test_collection_false_in_development_by_default
+    assert_equal "false", load_rails(<<-RB, "development")
+initializer.after_initialize
+$stdout << Vanity.playground.collecting?
+    RB
+  end
+
+  def test_collection_true_in_development_when_configured
+    assert_equal "true", load_rails(<<-RB, "development")
+Vanity.playground.collecting = true
+initializer.after_initialize
+$stdout << Vanity.playground.collecting?
+    RB
+  end
+
+  def test_collection_false_after_test!
+    assert_equal "false", load_rails(<<-RB, "production")
+initializer.after_initialize
+Vanity.playground.test!
+$stdout << Vanity.playground.collecting?
+    RB
+  end
+
+  def load_rails(code, env = "production")
+    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 = ENV['RACK_ENV'] = "#{env}"
+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
+    if !rails3?
+      UseVanityController.send(:filter_chain).clear
+    end
+  end
+end