vanity 3.0.2 → 4.0.1

data/lib/vanity/metric/google_analytics.rb

@@ -1,6 +1,5 @@
 module Vanity
   class Metric
-
     # Use Google Analytics metric. Note: you must +require "garb"+ before
     # vanity.
     #
@@ -17,13 +16,13 @@ module Vanity
     # @see Vanity::Metric::GoogleAnalytics
     def google_analytics(web_property_id, *args)
       require "garb"
-      options = Hash === args.last ? args.pop : {}
+      options = args.last.is_a?(Hash) ? args.pop : {}
       metric = args.shift || :pageviews
       @ga_resource = Vanity::Metric::GoogleAnalytics::Resource.new(web_property_id, metric)
-      @ga_mapper = options[:mapper] ||= lambda { |entry| entry.send(@ga_resource.metrics.elements.first).to_i }
+      @ga_mapper = options[:mapper] ||= ->(entry) { entry.send(@ga_resource.metrics.elements.first).to_i }
       extend GoogleAnalytics
     rescue LoadError
-      fail LoadError, "Google Analytics metrics require Garb, please gem install garb first"
+      raise LoadError, "Google Analytics metrics require Garb, please gem install garb first"
     end
 
     # Calling google_analytics method on a metric extends it with these modules,
@@ -31,19 +30,18 @@ module Vanity
     #
     # @since 1.3.0
     module GoogleAnalytics
-
       # Returns values from GA using parameters specified by prior call to
       # google_analytics.
       def values(from, to)
-        data = @ga_resource.results(from, to).inject({}) do |hash,entry|
-          hash.merge(entry.date=>@ga_mapper.call(entry))
+        data = @ga_resource.results(from, to).inject({}) do |hash, entry|
+          hash.merge(entry.date => @ga_mapper.call(entry))
         end
         (from..to).map { |day| data[day.strftime('%Y%m%d')] || 0 }
       end
 
       # Hooks not supported for GA metrics.
       def hook
-        fail "Cannot use hooks with Google Analytics methods"
+        raise "Cannot use hooks with Google Analytics methods"
       end
 
       # Garb report.
@@ -77,7 +75,6 @@ module Vanity
           Garb::ReportResponse.new(send_request_for_body).results
         end
       end
-
     end
   end
 end

data/lib/vanity/metric/remote.rb

@@ -3,7 +3,6 @@ require "cgi"
 
 module Vanity
   class Metric
-
     # Specifies the base URL to use for a remote metric. For example:
     #   metric :sandbox do
     #     remote "http://api.vanitydash.com/metrics/sandbox"
@@ -26,9 +25,9 @@ module Vanity
     # - Set values by their index using +values[0]+, +values[1]+, etc or
     # - Set values by series name using +values[foo]+, +values[bar]+, etc.
     module Remote
-
       def track!(args = nil)
         return unless @playground.collecting?
+
         timestamp, identity, values = track_args(args)
         params = ["metric=#{CGI.escape @id.to_s}", "timestamp=#{CGI.escape timestamp.httpdate}"]
         params << "identity=#{CGI.escape identity.to_s}" if identity
@@ -36,9 +35,9 @@ module Vanity
         params << @remote_url.query if @remote_url.query
         @mutex.synchronize do
           @http ||= Net::HTTP.start(@remote_url.host, @remote_url.port)
-          @http.request Net::HTTP::Post.new(@remote_url.path, "Content-Type"=>"application/x-www-form-urlencoded"), params.join("&")
+          @http.request Net::HTTP::Post.new(@remote_url.path, "Content-Type" => "application/x-www-form-urlencoded"), params.join("&")
         end
-      rescue Timeout::Error, StandardError
+      rescue Timeout::Error, StandardError # rubocop:todo Lint/ShadowedException
         @playground.logger.error "Error sending data for metric #{name}: #{$!}"
         @http = nil
       ensure
@@ -47,7 +46,6 @@ module Vanity
 
       # "Don't worry, be crappy. Revolutionary means you ship and then test."
       # -- Guy Kawazaki
-
     end
   end
 end

data/lib/vanity/playground.rb

@@ -81,7 +81,7 @@ module Vanity
     # @deprecated
     # @see Configuration#add_participant_route=
     def add_participant_path=(path)
-      Vanity.configuration.add_participant_route=path
+      Vanity.configuration.add_participant_route = path
     end
 
     # @since 1.9.0
@@ -183,7 +183,6 @@ module Vanity
       experiments[id.to_sym] or raise NoExperimentError, "No experiment #{id}"
     end
 
-
     # -- Participant Information --
 
     # Returns an array of all experiments this participant is involved in, with their assignment.
@@ -193,9 +192,7 @@ module Vanity
       participant_array = []
       experiments.values.sort_by(&:name).each do |e|
         index = connection.ab_assigned(e.id, participant_id)
-        if index
-          participant_array << [e, e.alternatives[index.to_i]]
-        end
+        participant_array << [e, e.alternatives[index.to_i]] if index
       end
       participant_array
     end
@@ -203,7 +200,7 @@ module Vanity
     # @since 1.4.0
     # @deprecated
     # @see Vanity::Connection
-    def establish_connection(spec=nil)
+    def establish_connection(spec = nil)
       disconnect!
       Vanity.connect!(spec)
     end

data/lib/vanity/vanity.rb

@@ -8,7 +8,7 @@ module Vanity
   #
   # @see Vanity::Configuration
   # @since 2.0.0
-  def self.configuration(set_if_needed=true)
+  def self.configuration(set_if_needed = true)
     if defined?(@configuration) && @configuration
       @configuration
     elsif set_if_needed
@@ -77,7 +77,7 @@ module Vanity
   # Returns the current connection. Establishes new connection is necessary.
   #
   # @since 2.0.0
-  def self.connection(connect_if_needed=true)
+  def self.connection(connect_if_needed = true)
     if defined?(@connection) && @connection
       @connection
     elsif connect_if_needed
@@ -91,7 +91,7 @@ module Vanity
   #
   # @since 2.0.0
   # @see Vanity::Connection
-  def self.connect!(spec_or_nil=nil)
+  def self.connect!(spec_or_nil = nil)
     spec_or_nil ||= configuration.connection_params
 
     # Legacy special config variables permitted in connection spec
@@ -100,15 +100,11 @@ module Vanity
     # 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
+      spec_or_nil = redis_url if redis_url
     end
 
     # Legacy connection url fallback
-    if configuration.connection_url
-      spec_or_nil = configuration.connection_url
-    end
+    spec_or_nil = configuration.connection_url if configuration.connection_url
 
     @connection = Connection.new(spec_or_nil)
   end
@@ -117,7 +113,7 @@ module Vanity
   #
   # @since 2.0.0
   def self.disconnect!
-    if @connection
+    if @connection # rubocop:todo Style/GuardClause
       @connection.disconnect!
       @connection = nil
     end
@@ -135,7 +131,7 @@ module Vanity
   # The playground instance.
   #
   # @see Vanity::Playground
-  def self.playground(load_if_needed=true)
+  def self.playground(load_if_needed = true)
     if @playground
       @playground
     elsif load_if_needed
@@ -184,4 +180,4 @@ module Vanity
       configuration.collecting = spec_or_nil[:collecting] if spec_or_nil.has_key?(:collecting)
     end
   end
-end
+end

data/lib/vanity/version.rb

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

data/test/adapters/active_record_adapter_test.rb

@@ -3,7 +3,6 @@ require 'vanity/adapters/active_record_adapter'
 require 'adapters/shared_tests'
 
 describe Vanity::Adapters::ActiveRecordAdapter do
-
   def specification
     Vanity::Connection::Specification.new(VanityTestHelpers::DATABASE_OPTIONS["active_record"])
   end
@@ -12,8 +11,5 @@ describe Vanity::Adapters::ActiveRecordAdapter do
     Vanity::Adapters::ActiveRecordAdapter.new(specification.to_h)
   end
 
-  if ENV["DB"] == "active_record"
-    include Vanity::Adapters::SharedTests
-  end
-
+  include Vanity::Adapters::SharedTests if ENV["DB"] == "active_record"
 end

data/test/adapters/mock_adapter_test.rb

@@ -2,7 +2,6 @@ require 'test_helper'
 require 'adapters/shared_tests'
 
 describe Vanity::Adapters::MockAdapter do
-
   def specification
     Vanity::Connection::Specification.new(VanityTestHelpers::DATABASE_OPTIONS["mock"])
   end
@@ -12,5 +11,4 @@ describe Vanity::Adapters::MockAdapter do
   end
 
   include Vanity::Adapters::SharedTests
-
 end

data/test/adapters/mongodb_adapter_test.rb

@@ -3,7 +3,6 @@ require 'vanity/adapters/mongodb_adapter'
 require 'adapters/shared_tests'
 
 describe Vanity::Adapters::MongodbAdapter do
-
   def specification
     Vanity::Connection::Specification.new(VanityTestHelpers::DATABASE_OPTIONS["mongodb"])
   end
@@ -12,8 +11,5 @@ describe Vanity::Adapters::MongodbAdapter do
     Vanity::Adapters::MongodbAdapter.new(specification.to_h)
   end
 
-  if ENV["DB"] == "mongodb"
-    include Vanity::Adapters::SharedTests
-  end
-
+  include Vanity::Adapters::SharedTests if ENV["DB"] == "mongodb"
 end

data/test/adapters/redis_adapter_test.rb

@@ -31,14 +31,14 @@ describe Vanity::Adapters::RedisAdapter do
   def stub_redis
     Vanity.playground.failover_on_datastore_error!
     mocked_redis = stub("Redis")
-    redis_adapter = Vanity::Adapters::RedisAdapter.new(:redis => mocked_redis)
+    redis_adapter = Vanity::Adapters::RedisAdapter.new(redis: mocked_redis)
 
     [redis_adapter, mocked_redis]
   end
 
   it "connects to existing redis" do
     mocked_redis = stub("Redis")
-    adapter = Vanity::Adapters.redis_connection(:redis => mocked_redis)
+    adapter = Vanity::Adapters.redis_connection(redis: mocked_redis)
     assert_equal mocked_redis, adapter.redis
   end
 
@@ -131,5 +131,4 @@ describe Vanity::Adapters::RedisAdapter do
       redis_adapter.ab_add_conversion("price_options", 0, "3ff62e2fb51f0b22646a342a2d357aec")
     end
   end
-
 end

data/test/adapters/shared_tests.rb

@@ -1,7 +1,6 @@
 require 'time'
 
 module Vanity::Adapters::SharedTests
-
   DummyAlternative = Struct.new(:id)
 
   def identity
@@ -124,7 +123,7 @@ module Vanity::Adapters::SharedTests
 
             refute(@subject.experiment_persisted?(experiment))
             assert_equal(
-              { :participants => 0, :converted => 0, :conversions => 0 },
+              { participants: 0, converted: 0, conversions: 0 },
               @subject.ab_counts(experiment, alternative)
             )
           end
@@ -132,13 +131,11 @@ module Vanity::Adapters::SharedTests
 
         describe '#is_experiment_enabled?' do
           def with_experiments_start_enabled(enabled)
-            begin
-              original_value = Vanity.configuration.experiments_start_enabled
-              Vanity.configuration.experiments_start_enabled = enabled
-              yield
-            ensure
-              Vanity.configuration.experiments_start_enabled = original_value
-            end
+            original_value = Vanity.configuration.experiments_start_enabled
+            Vanity.configuration.experiments_start_enabled = enabled
+            yield
+          ensure
+            Vanity.configuration.experiments_start_enabled = original_value
           end
 
           describe 'when experiments start enabled' do
@@ -193,7 +190,7 @@ module Vanity::Adapters::SharedTests
             @subject.ab_add_conversion(experiment, alternative, identity, 1, true)
 
             assert_equal(
-              {:participants => 1, :conversions => 1, :converted => 1},
+              { participants: 1, conversions: 1, converted: 1 },
               @subject.ab_counts(experiment, alternative)
             )
           end
@@ -204,7 +201,7 @@ module Vanity::Adapters::SharedTests
             @subject.ab_add_participant(experiment, alternative, identity)
 
             assert_equal(
-              {:participants => 1, :conversions => 0, :converted => 0},
+              { participants: 1, conversions: 0, converted: 0 },
               @subject.ab_counts(experiment, alternative)
             )
           end
@@ -287,7 +284,7 @@ module Vanity::Adapters::SharedTests
             run_experiment
 
             assert_equal(
-              {:participants => 2, :conversions => 2, :converted => 1},
+              { participants: 2, conversions: 2, converted: 1 },
               @subject.ab_counts(experiment, alternative)
             )
           end

data/test/autoconnect_test.rb

@@ -15,7 +15,7 @@ describe Vanity::Autoconnect do
     end
 
     it "returns false if in assets:precompile rake task" do
-      Rake.expects(:application).returns(stub(:top_level_tasks => ['assets:precompile']))
+      Rake.expects(:application).returns(stub(top_level_tasks: ['assets:precompile']))
       autoconnect = Vanity::Autoconnect.should_connect?
       assert autoconnect == false
     end
@@ -23,8 +23,8 @@ describe Vanity::Autoconnect do
 
   describe ".schema_relevant?" do
     it "returns true for database tasks" do
-      Rake.expects(:application).returns(stub(:top_level_tasks => ['db:migrate']))
+      Rake.expects(:application).returns(stub(top_level_tasks: ['db:migrate']))
       assert_equal true, Vanity::Autoconnect.schema_relevant?
     end
   end
-end
+end

data/test/cli_test.rb

@@ -1,7 +1,6 @@
 require "test_helper"
 
 describe "bin/vanity" do
-
   before do
     not_collecting!
   end

data/test/configuration_test.rb

@@ -3,7 +3,7 @@ require "test_helper"
 describe Vanity::Configuration do
   let(:config) do
     config = Vanity::Configuration.new
-    config.logger = $logger
+    config.logger = $logger # rubocop:todo Style/GlobalVars
     config
   end
 
@@ -31,9 +31,7 @@ describe Vanity::Configuration do
     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
+        File.write("./config/vanity.yml", VanityTestHelpers::VANITY_CONFIGS["vanity.yml.mock"])
 
         mock_connection_hash = { adapter: "mock" }
         assert_equal mock_connection_hash, config.connection_params
@@ -42,9 +40,7 @@ describe Vanity::Configuration do
 
     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
+      File.write("./config/vanity.yml", VanityTestHelpers::VANITY_CONFIGS["vanity.yml.mock"])
 
       mock_connection_hash = { adapter: "mock" }
       assert_equal mock_connection_hash, config.connection_params("vanity.yml")
@@ -52,9 +48,7 @@ describe Vanity::Configuration do
 
     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
+      File.write("./config/redis.yml", VanityTestHelpers::VANITY_CONFIGS["redis.yml.url"])
 
       mock_connection_string = "localhost:6379/15"
       assert_equal mock_connection_string, config.connection_params("redis.yml")
@@ -64,9 +58,7 @@ describe Vanity::Configuration do
       connection_config = VanityTestHelpers::VANITY_CONFIGS["vanity.yml.redis"]
 
       FileUtils.mkpath "./config"
-      File.open("./config/vanity.yml", "w") do |f|
-        f.write(connection_config)
-      end
+      File.write("./config/vanity.yml", connection_config)
 
       assert_equal "redis://:p4ssw0rd@10.0.1.1:6380/15", config.connection_url
     end
@@ -76,9 +68,7 @@ describe Vanity::Configuration do
       ENV["VANITY_TEST_REDIS_URL"] = "redis://:p4ssw0rd@10.0.1.1:6380/15"
 
       FileUtils.mkpath "./config"
-      File.open("./config/vanity.yml", "w") do |f|
-        f.write(connection_config)
-      end
+      File.write("./config/vanity.yml", connection_config)
 
       connection_hash = { adapter: "redis", url: "redis://:p4ssw0rd@10.0.1.1:6380/15" }
       assert_equal connection_hash, config.connection_params
@@ -91,21 +81,17 @@ describe Vanity::Configuration do
 
     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
+      File.write("./config/vanity.yml", VanityTestHelpers::VANITY_CONFIGS["vanity.yml.mock"])
 
       config.environment = "staging"
-      assert_raises(Vanity::Configuration::MissingEnvironment) {
+      assert_raises(Vanity::Configuration::MissingEnvironment) do
         config.connection_params
-      }
+      end
     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
+      File.write("./config/vanity.yml", VanityTestHelpers::VANITY_CONFIGS["vanity.yml.activerecord"])
 
       ar_connection_values = [:adapter, :active_record_adapter]
       assert_equal ar_connection_values, config.connection_params.keys
@@ -114,18 +100,16 @@ describe Vanity::Configuration do
 
   describe "setup_locales" do
     it "adds vanity locales to the I18n gem" do
-      begin
-        original_load_path = I18n.load_path
+      original_load_path = I18n.load_path
 
-        config.setup_locales
+      config.setup_locales
 
-        assert_includes(
-          I18n.load_path,
-          File.expand_path(File.join(__FILE__, '..', '..', 'lib/vanity/locales/vanity.en.yml'))
-        )
-      ensure
-        I18n.load_path = original_load_path
-      end
+      assert_includes(
+        I18n.load_path,
+        File.expand_path(File.join(__FILE__, '..', '..', 'lib/vanity/locales/vanity.en.yml'))
+      )
+    ensure
+      I18n.load_path = original_load_path
     end
   end
 end

data/test/connection_test.rb

@@ -32,9 +32,9 @@ describe Vanity::Connection do
     end
 
     it "raises an error for invalid specification hashes" do
-      assert_raises(Vanity::Connection::InvalidSpecification) {
+      assert_raises(Vanity::Connection::InvalidSpecification) do
         Vanity::Connection.new("adapter" => "mock")
-      }
+      end
     end
 
     it "allows a redis connection to be specified" do
@@ -43,4 +43,4 @@ describe Vanity::Connection do
       Vanity::Connection.new(redis: redis)
     end
   end
-end
+end

data/test/dummy/Rakefile

@@ -1,7 +1,7 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require File.expand_path('config/application', __dir__)
 require 'rake'
 
 Dummy::Application.load_tasks

data/test/dummy/app/controllers/use_vanity_controller.rb

@@ -9,30 +9,34 @@ class UseVanityController < ActionController::Base
 
   def index
     text = Vanity.ab_test(:pie_or_cake)
-    render :plain=>text, :text=>text
+    render plain: text, text: text
   end
 
   def js
     Vanity.ab_test(:pie_or_cake)
-    render :inline => "<%= vanity_js -%>"
+    render inline: "<%= vanity_js -%>"
   end
 
   def view_helper_ab_test_js
-    render :inline => <<-EOS
+    # rubocop:todo Naming/HeredocDelimiterNaming
+    render inline: <<-EOS
     <% ab_test(:pie_or_cake) %>
     <%= vanity_js -%>
-EOS
+    EOS
+    # rubocop:enable Naming/HeredocDelimiterNaming
   end
 
   def global_ab_test_js
-    render :inline => <<-EOS
+    # rubocop:todo Naming/HeredocDelimiterNaming
+    render inline: <<-EOS
     <% Vanity.ab_test(:pie_or_cake) %>
     <%= vanity_js -%>
-EOS
+    EOS
+    # rubocop:enable Naming/HeredocDelimiterNaming
   end
 
   def model_js
     TestModel.new.test_method
-    render :inline => "<%= vanity_js -%>"
+    render inline: "<%= vanity_js -%>"
   end
-end
+end

data/test/dummy/app/mailers/vanity_mailer.rb

@@ -6,16 +6,16 @@ class VanityMailer < ActionMailer::Base
   def ab_test_subject(user)
     use_vanity_mailer user
 
-    mail :subject =>ab_test(:pie_or_cake).to_s, :body => ""
+    mail subject: ab_test(:pie_or_cake).to_s, body: ""
   end
 
   def ab_test_content(user)
     use_vanity_mailer user
 
-    image_html = view_context.vanity_tracking_image(Vanity.context.vanity_identity, :open, :host => "127.0.0.1:3000")
+    image_html = view_context.vanity_tracking_image(Vanity.context.vanity_identity, :open, host: "127.0.0.1:3000")
 
     mail do |format|
-      format.html { render :html=>image_html.html_safe }
+      format.html { render html: image_html.html_safe }
     end
   end
 end

data/test/dummy/config/application.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../boot', __FILE__)
+require File.expand_path('boot', __dir__)
 
 require "active_model/railtie"
 require "active_record/railtie"

data/test/dummy/config/boot.rb

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

data/test/dummy/config/environment.rb

@@ -1,5 +1,5 @@
 # Load the rails application
-require File.expand_path('../application', __FILE__)
+require File.expand_path('application', __dir__)
 
 # Initialize the rails application
 Dummy::Application.initialize!

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

@@ -23,4 +23,3 @@ Dummy::Application.configure do
   # Only use best-standards-support built into browsers
   config.action_dispatch.best_standards_support = :builtin
 end
-

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

@@ -18,7 +18,7 @@ Dummy::Application.configure do
   config.action_dispatch.show_exceptions = false
 
   # Disable request forgery protection in test environment
-  config.action_controller.allow_forgery_protection    = false
+  config.action_controller.allow_forgery_protection = false
 
   # Tell Action Mailer not to deliver emails to the real world.
   # The :test delivery method accumulates sent emails in the

data/test/dummy/config/initializers/session_store.rb

@@ -1,6 +1,6 @@
 # Be sure to restart your server when you modify this file.
 
-Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
 
 # Use the database for sessions instead of the cookie-based default,
 # which shouldn't be used to store highly confidential information

data/test/dummy/config/initializers/vanity.rb

@@ -0,0 +1,3 @@
+Vanity.configure do |config|
+  config.config_path = Rails.root.join('config')
+end

data/test/dummy/config/vanity.yml

@@ -0,0 +1,7 @@
+default: &default
+  some_key: true
+
+test:
+  <<: *default
+  adapter: mock
+  collecting: false

data/test/dummy/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path('config/environment', __dir__)
 run Dummy::Application