vanity 2.0.0.beta8 → 2.0.0.beta9

data/lib/vanity/vanity.rb

@@ -0,0 +1,166 @@
+#
+# Run time configuration and helpers
+#
+module Vanity
+  # Returns the current configuration.
+  #
+  # @see Vanity::Configuration
+  # @since 2.0.0
+  def self.configuration(set_if_needed=true)
+    if @configuration
+      @configuration
+    elsif set_if_needed
+      configure!
+    end
+  end
+
+  # @since 2.0.0
+  def self.configure!
+    @configuration = Configuration.new
+  end
+
+  # @since 2.0.0
+  def self.reset!
+    @configuration = nil
+    configuration
+  end
+
+  # This is the preferred way to configure Vanity.
+  #
+  # @example
+  #   Vanity.configure do |config|
+  #     config.use_js = true
+  #   end
+  # @since 2.0.0
+  def self.configure
+    yield(configuration)
+  end
+
+  # @since 2.0.0
+  def self.logger
+    configuration.logger
+  end
+
+  # Returns the Vanity context. For example, when using Rails this would be
+  # the current controller, which can be used to get/set the vanity identity.
+  def self.context
+    Thread.current[:vanity_context]
+  end
+
+  # Sets the Vanity context. For example, when using Rails this would be
+  # set by the set_vanity_context before filter (via Vanity::Rails#use_vanity).
+  def self.context=(context)
+    Thread.current[:vanity_context] = context
+  end
+
+  #
+  # Datastore connection management
+  #
+
+  # Returns the current connection. Establishes new connection is necessary.
+  #
+  # @since 2.0.0
+  def self.connection(connect_if_needed=true)
+    if @connection
+      @connection
+    elsif connect_if_needed
+      connect!
+    end
+  end
+
+  # 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.
+  #
+  # @since 2.0.0
+  # @see Vanity::Connection
+  def self.connect!(spec_or_nil=nil)
+    spec_or_nil ||= configuration.connection_params
+
+    # Legacy redis.yml fallback
+    if spec_or_nil.nil?
+      redis_url = configuration.redis_url_from_file
+
+      if redis_url
+        spec_or_nil = redis_url
+      end
+    end
+
+    # Legacy special config variables permitted in connection spec
+    update_configuration_from_connection_params(spec_or_nil)
+
+    @connection = Connection.new(spec_or_nil)
+  end
+
+  # Destroys a connection
+  #
+  # @since 2.0.0
+  def self.disconnect!
+    if @connection
+      @connection.disconnect!
+      @connection = nil
+    end
+  end
+
+  def self.reconnect!
+    disconnect!
+    connect!
+  end
+
+  #
+  # Experiment metadata
+  #
+
+  # The playground instance.
+  #
+  # @see Vanity::Playground
+  def self.playground(load_if_needed=true)
+    if @playground
+      @playground
+    elsif load_if_needed
+      load!
+    end
+  end
+
+  # Loads all metrics and experiments. Called during initialization. In the
+  # case of Rails, use the Rails logger and look for templates at
+  # app/views/vanity.
+  #
+  # @since 2.0.0
+  def self.load!
+    @playground = Playground.new
+  end
+
+  # @since 2.0.0
+  def self.unload!
+    @playground = nil
+  end
+
+  # Reloads all metrics and experiments. Rails calls this for each request in
+  # development mode.
+  #
+  # @since 2.0.0
+  def self.reload!
+    unload!
+    load!
+  end
+
+  class << self
+    # @since 2.0.0
+    attr_writer :configuration
+
+    # @since 2.0.0
+    attr_writer :playground
+
+    # @since 2.0.0
+    attr_writer :connection
+
+    private
+
+    def update_configuration_from_connection_params(spec_or_nil) # # :nodoc:
+      return unless spec_or_nil.respond_to?(:has_key?)
+
+      configuration.collecting = spec_or_nil[:collecting] if spec_or_nil.has_key?(:collecting)
+    end
+  end
+end

data/lib/vanity/version.rb

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

data/test/configuration_test.rb

@@ -0,0 +1,90 @@
+require "test_helper"
+
+describe Vanity::Configuration do
+  let(:config) { Vanity::Configuration.new }
+
+  it "returns default values" do
+    assert_equal Vanity::Configuration.new.collecting, Vanity::Configuration::DEFAULTS[:collecting]
+  end
+
+  describe "overriding defaults" do
+    it "returns overridden values" do
+      config.collecting = true
+      assert_equal config.collecting, true
+    end
+  end
+
+  describe "connection_params" do
+    before do
+      FakeFS.activate!
+    end
+
+    after do
+      FakeFS.deactivate!
+      FakeFS::FileSystem.clear
+    end
+
+    describe "using the default config file & path" do
+      it "returns the connection params" do
+        FileUtils.mkpath "./config"
+        File.open("./config/vanity.yml", "w") do |f|
+          f.write VanityTestHelpers::VANITY_CONFIGS["vanity.yml.mock"]
+        end
+
+        mock_connection_hash = { adapter: "mock" }
+        assert_equal mock_connection_hash, config.connection_params
+      end
+    end
+
+    it "accepts a file name" do
+      FileUtils.mkpath "./config"
+      File.open("./config/vanity.yml", "w") do |f|
+        f.write VanityTestHelpers::VANITY_CONFIGS["vanity.yml.mock"]
+      end
+
+      mock_connection_hash = { adapter: "mock" }
+      assert_equal mock_connection_hash, config.connection_params("vanity.yml")
+    end
+
+    it "returns connection strings" do
+      FileUtils.mkpath "./config"
+      File.open("./config/redis.yml", "w") do |f|
+        f.write VanityTestHelpers::VANITY_CONFIGS["redis.yml.url"]
+      end
+
+      mock_connection_string = "localhost:6379/15"
+      assert_equal mock_connection_string, config.connection_params("redis.yml")
+    end
+
+    it "returns nil if the file doesn't exist" do
+      FileUtils.mkpath "./config"
+      assert_nil config.connection_params
+    end
+
+    it "raises an error if the environment isn't configured" do
+      FileUtils.mkpath "./config"
+      File.open("./config/vanity.yml", "w") do |f|
+        f.write VanityTestHelpers::VANITY_CONFIGS["vanity.yml.mock"]
+      end
+
+      config.environment = "staging"
+      assert_raises(Vanity::Configuration::MissingEnvironment) {
+        config.connection_params
+      }
+    end
+
+    it "symbolizes hash keys" do
+      FileUtils.mkpath "./config"
+      File.open("./config/vanity.yml", "w") do |f|
+        f.write VanityTestHelpers::VANITY_CONFIGS["vanity.yml.activerecord"]
+      end
+
+      ar_connection_values = [:adapter, :active_record_adapter]
+      assert_equal ar_connection_values, config.connection_params.keys
+    end
+  end
+
+  describe "setup_locales" do
+    it "adds vanity locales to the gem"
+  end
+end

data/test/connection_test.rb

@@ -0,0 +1,46 @@
+require "test_helper"
+
+describe Vanity::Connection do
+  describe "#new" do
+    it "establishes connection with default specification" do
+      Vanity::Adapters.expects(:establish_connection).with(adapter: "redis")
+      Vanity::Connection.new
+    end
+
+    it "establishes connection given a connection specification" do
+      Vanity::Adapters.expects(:establish_connection).with(adapter: "mock")
+      Vanity::Connection.new(adapter: "mock")
+    end
+
+    it "can skip connection" do
+      Vanity::Autoconnect.stubs(:playground_should_autoconnect?).returns(false)
+      connection = Vanity::Connection.new(adapter: "mock")
+      assert !connection.connected?
+    end
+
+    it "parses from a string" do
+      Vanity::Adapters.expects(:establish_connection).with(
+        adapter: 'redis',
+        username: 'user',
+        password: 'secrets',
+        host: 'redis.local',
+        port: 6379,
+        path: '/5',
+        params: nil
+      )
+      Vanity::Connection.new("redis://user:secrets@redis.local:6379/5")
+    end
+
+    it "raises an error for invalid specification hashes" do
+      assert_raises(Vanity::Connection::InvalidSpecification) {
+        Vanity::Connection.new("adapter" => "mock")
+      }
+    end
+
+    it "allows a redis connection to be specified" do
+      redis = stub("Redis")
+      Vanity::Adapters.expects(:establish_connection).with(adapter: :redis, redis: redis)
+      Vanity::Connection.new(redis: redis)
+    end
+  end
+end

data/test/data/redis.yml.url

@@ -0,0 +1,2 @@
+development: localhost:6379/0
+test: localhost:6379/15

data/test/data/vanity.yml.activerecord

@@ -0,0 +1,6 @@
+development:
+  adapter: active_record
+  active_record_adapter: default
+test:
+  adapter: active_record
+  active_record_adapter: default

data/test/data/vanity.yml.mock

@@ -0,0 +1,4 @@
+development:
+  adapter: mock
+test:
+  adapter: mock

data/test/data/vanity.yml.redis

@@ -0,0 +1,5 @@
+test:
+  adapter: redis
+  collecting: false
+production:
+  adapter: redis

data/test/data/vanity.yml.redis-erb

@@ -0,0 +1,3 @@
+production:
+  adapter: redis
+  connection: redis://<%= ENV["REDIS_USER"] %>:<%= ENV["REDIS_PASSWORD"] %>@<%= ENV["REDIS_HOST"] %>:<%= ENV["REDIS_PORT"] %>/0

data/test/experiment/ab_test.rb

@@ -138,7 +138,7 @@ class AbTestTest < ActionController::TestCase
   # -- use_js! --
 
   def test_choose_does_not_record_participant_when_using_js
-    Vanity.playground.use_js!
+    Vanity.configuration.use_js = true
     ids = (0...10).to_a
     new_ab_test :foobar do
       alternatives "foo", "bar"

data/test/experiment/base_test.rb

@@ -111,7 +111,7 @@ describe Vanity::Experiment::Base do
       new_ab_test(:ice_cream_flavor) { metrics :happiness }
     end
 
-    new_playground
+    vanity_reset
     metric :happiness
     new_ab_test(:ice_cream_flavor) { metrics :happiness }
     assert_equal past.to_time.to_i, experiment(:ice_cream_flavor).created_at.to_i

data/test/frameworks/rails/rails_test.rb

@@ -1,20 +1,20 @@
 require "test_helper"
 
-describe "Rails load path and connection configuration" do
+describe "deprecated Rails load_path and deprecated connection configuration" do
 
   it "load_path" do
-    assert_equal File.expand_path("tmp/experiments"), load_rails("", <<-RB)
+    assert_equal "./experiments", load_rails("", <<-RB)
 $stdout << Vanity.playground.load_path
     RB
   end
 
-  it "settable_load_path" do
-    assert_equal File.expand_path("tmp/predictions"), load_rails(%Q{\nVanity.playground.load_path = "predictions"\n}, <<-RB)
+  it "settable load_path" do
+    assert_equal "predictions", load_rails(%Q{\nVanity.playground.load_path = "predictions"\n}, <<-RB)
 $stdout << Vanity.playground.load_path
     RB
   end
 
-  it "absolute_load_path" do
+  it "absolute load_path" do
     Dir.mktmpdir do |dir|
       assert_equal dir, load_rails(%Q{\nVanity.playground.load_path = "#{dir}"\n}, <<-RB)
 $stdout << Vanity.playground.load_path
@@ -23,19 +23,19 @@ $stdout << Vanity.playground.load_path
   end
 
   if ENV['DB'] == 'redis'
-    it "default_connection" do
+    it "default connection" do
       assert_equal "redis://127.0.0.1:6379/0", load_rails("", <<-RB)
 $stdout << Vanity.playground.connection
       RB
     end
 
-    it "connection_from_string" do
+    it "connection from string" do
       assert_equal "redis://192.168.1.1:6379/5", load_rails(%Q{\nVanity.playground.establish_connection "redis://192.168.1.1:6379/5"\n}, <<-RB)
 $stdout << Vanity.playground.connection
       RB
     end
 
-    it "connection_from_yaml" do
+    it "connection from yaml" do
       begin
         FileUtils.mkpath "tmp/config"
         @original_env = ENV["RAILS_ENV"]
@@ -57,7 +57,7 @@ $stdout << Vanity.playground.connection
       end
     end
 
-    it "connection_from_yaml_url" do
+    it "connection from yaml url" do
       begin
         FileUtils.mkpath "tmp/config"
         @original_env = ENV["RAILS_ENV"]
@@ -76,7 +76,7 @@ $stdout << Vanity.playground.connection
       end
     end
 
-    it "connection_from_yaml_with_erb" do
+    it "connection from yaml with erb" do
       begin
         FileUtils.mkpath "tmp/config"
         @original_env = ENV["RAILS_ENV"]
@@ -99,13 +99,13 @@ $stdout << Vanity.playground.connection
       end
     end
 
-    it "connection_from_redis_yml" do
+    it "connection from redis yml" do
       begin
         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)
+        assert_match %r{redis://internal.local:6379/0\Z}, load_rails("", <<-RB)
 $stdout << Vanity.playground.connection
         RB
       ensure
@@ -115,7 +115,7 @@ $stdout << Vanity.playground.connection
   end
 
   if ENV['DB'] == 'mongo'
-    it "mongo_connection_from_yaml" do
+    it "mongo connection from yaml" do
       begin
         FileUtils.mkpath "tmp/config"
         File.open("tmp/config/vanity.yml", "w") do |io|
@@ -136,8 +136,8 @@ $stdout << Vanity.playground.connection
       end
     end
 
-    unless ENV['CI'] == 'true' #TODO this doesn't get tested on CI
-      it "mongodb_replica_set_connection" do
+    unless ENV['CI'] == 'true' # See http://docs.travis-ci.com/user/environment-variables/#Default-Environment-Variables
+      it "mongodb replica set connection" do
         begin
           FileUtils.mkpath "tmp/config"
           File.open("tmp/config/vanity.yml", "w") do |io|
@@ -165,7 +165,7 @@ $stdout << Vanity.playground.connection.mongo.class
     end
   end
 
-  it "connection_from_yaml_missing" do
+  it "connection from yaml missing" do
     begin
       FileUtils.mkpath "tmp/config"
       File.open("tmp/config/vanity.yml", "w") do |io|
@@ -176,7 +176,7 @@ production:
       end
 
        assert_equal "No configuration for development", load_rails("\nbegin\n", <<-RB, "development")
-rescue RuntimeError => e
+rescue => e
   $stdout << e.message
 end
       RB
@@ -185,7 +185,7 @@ end
     end
   end
 
-  it "collection_from_vanity_yaml" do
+  it "collection from vanity yaml" do
     begin
       FileUtils.mkpath "tmp/config"
       File.open("tmp/config/vanity.yml", "w") do |io|
@@ -203,42 +203,46 @@ $stdout << Vanity.playground.collecting?
     end
   end
 
-  it "collection_true_in_production_by_default" do
+  it "collection true in production by default" do
     assert_equal "true", load_rails("", <<-RB)
 $stdout << Vanity.playground.collecting?
     RB
   end
 
-  it "collection_false_in_production_when_configured" do
+  it "collection false in production when configured" do
     assert_equal "false", load_rails("\nVanity.playground.collecting = false\n", <<-RB)
 $stdout << Vanity.playground.collecting?
     RB
   end
 
-  it "collection_true_in_development_by_default" do
+  it "collection true in development by default" do
     assert_equal "true", load_rails("", <<-RB, "development")
 $stdout << Vanity.playground.collecting?
     RB
   end
 
-  it "collection_true_in_development_when_configured" do
+  it "collection true in development when configured" do
     assert_equal "true", load_rails("\nVanity.playground.collecting = true\n", <<-RB, "development")
 $stdout << Vanity.playground.collecting?
     RB
   end
 
-  it "playground_loads_if_connected" do
+  it "playground loads experiments if connected" do
     assert_equal "{}", load_rails("", <<-RB)
-$stdout << Vanity.playground.instance_variable_get(:@experiments).inspect
+$stdout << Vanity.playground.experiments.inspect
     RB
   end
 
-  it "playground_does_not_load_if_not_connected" do
-    ENV['VANITY_DISABLED'] = '1'
-    assert_equal "nil", load_rails("", <<-RB)
-$stdout << Vanity.playground.instance_variable_get(:@experiments).inspect
-    RB
-    ENV['VANITY_DISABLED'] = nil
+  it "playground does not instantiate connection if disabled" do
+    begin
+      ENV['VANITY_DISABLED'] = '1'
+      assert_equal "false", load_rails("", <<-RB)
+Vanity.playground.experiments.inspect
+$stdout << !!Vanity.playground.connected?
+      RB
+    ensure
+      ENV['VANITY_DISABLED'] = nil
+    end
   end
 
   def load_rails(before_initialize, after_initialize, env="production")