vanity 3.1.0 → 4.0.0

data/test/metric/base_test.rb

@@ -1,7 +1,6 @@
 require "test_helper"
 
 describe "Metric via playground" do
-
   it "knows all loaded metrics" do
     metric "Yawns/sec", "Cheers/sec"
     assert Vanity.playground.metrics.keys.include?(:yawns_sec)
@@ -9,34 +8,28 @@ describe "Metric via playground" do
   end
 
   it "loads metric definitions" do
-    File.open "tmp/experiments/metrics/yawns_sec.rb", "w" do |f|
-      f.write <<-RUBY
+    File.write("tmp/experiments/metrics/yawns_sec.rb", <<-RUBY)
         metric "Yawns/sec" do
           def xmts
             "x"
           end
         end
-      RUBY
-    end
+    RUBY
     assert_equal "x", Vanity.playground.metric(:yawns_sec).xmts
   end
 
   it "bubbles up loaded metrics" do
-    File.open "tmp/experiments/metrics/yawns_sec.rb", "w" do |f|
-      f.write "fail 'yawn!'"
-    end
+    File.write("tmp/experiments/metrics/yawns_sec.rb", "fail 'yawn!'")
     assert_raises NameError do
       Vanity.playground.metric(:yawns_sec)
     end
   end
 
   it "map identifier from file name" do
-    File.open "tmp/experiments/metrics/yawns_sec.rb", "w" do |f|
-      f.write <<-RUBY
+    File.write("tmp/experiments/metrics/yawns_sec.rb", <<-RUBY)
         metric "yawns/hour" do
         end
-      RUBY
-    end
+    RUBY
     assert Vanity.playground.metric(:yawns_sec)
   end
 
@@ -64,19 +57,16 @@ describe "Metric via playground" do
   end
 
   it "bootstraps the metric" do
-    File.open "tmp/experiments/metrics/yawns_sec.rb", "w" do |f|
-      f.write <<-RUBY
+    File.write("tmp/experiments/metrics/yawns_sec.rb", <<-RUBY)
         metric "yawns/hour" do
         end
-      RUBY
-    end
+    RUBY
     Vanity.playground.track!(:yawns_sec)
     Vanity.playground.track!(:yawns_sec)
     assert Vanity.playground.connection.get_metric_last_update_at(:yawns_sec)
   end
 end
 
-
 describe "Metric tracking" do
   it "disabled when metrics are disabled" do
     not_collecting!
@@ -100,7 +90,7 @@ describe "Metric tracking" do
     Timecop.freeze((today - 2).to_time) { 2.times { Vanity.playground.track! :yawns_sec } }
     1.times { Vanity.playground.track! :yawns_sec }
     boredom = Vanity.playground.metric(:yawns_sec).values(today - 5, today)
-    assert_equal [0,4,0,2,0,1], boredom
+    assert_equal [0, 4, 0, 2, 0, 1], boredom
   end
 
   it "with no value" do
@@ -117,7 +107,7 @@ describe "Metric tracking" do
     Timecop.freeze((today - 2).to_time) { Vanity.playground.track! :yawns_sec, 2 }
     Vanity.playground.track! :yawns_sec
     boredom = Vanity.playground.metric(:yawns_sec).values(today - 5, today)
-    assert_equal [0,4,0,2,0,1], boredom
+    assert_equal [0, 4, 0, 2, 0, 1], boredom
   end
 
   it "runs hook" do
@@ -136,7 +126,7 @@ describe "Metric tracking" do
     not_collecting!
     metric "Many Happy Returns"
     total = 0
-    Vanity.playground.metric(:many_happy_returns).hook do |metric_id, timestamp, count|
+    Vanity.playground.metric(:many_happy_returns).hook do |_metric_id, _timestamp, count|
       total += count
     end
     Vanity.playground.track! :many_happy_returns, 6
@@ -162,39 +152,31 @@ describe "Metric tracking" do
   end
 end
 
-
 describe "Metric name" do
   it "can be whatever" do
-    File.open "tmp/experiments/metrics/yawns_sec.rb", "w" do |f|
-      f.write <<-RUBY
+    File.write("tmp/experiments/metrics/yawns_sec.rb", <<-RUBY)
         metric "Yawns per second" do
         end
-      RUBY
-    end
+    RUBY
     assert_equal "Yawns per second", Vanity.playground.metric(:yawns_sec).name
   end
 end
 
-
 describe "Metric description" do
   it "metric with description" do
-    File.open "tmp/experiments/metrics/yawns_sec.rb", "w" do |f|
-      f.write <<-RUBY
+    File.write("tmp/experiments/metrics/yawns_sec.rb", <<-RUBY)
         metric "Yawns/sec" do
           description "Am I that boring?"
         end
-      RUBY
-    end
+    RUBY
     assert_equal "Am I that boring?", Vanity::Metric.description(Vanity.playground.metric(:yawns_sec))
   end
 
   it "metric without description" do
-    File.open "tmp/experiments/metrics/yawns_sec.rb", "w" do |f|
-      f.write <<-RUBY
+    File.write("tmp/experiments/metrics/yawns_sec.rb", <<-RUBY)
         metric "Yawns/sec" do
         end
-      RUBY
-    end
+    RUBY
     assert_nil Vanity::Metric.description(Vanity.playground.metric(:yawns_sec))
   end
 
@@ -204,19 +186,16 @@ describe "Metric description" do
   end
 end
 
-
 describe "Metric bounds" do
   it "metric with bounds" do
-    File.open "tmp/experiments/metrics/sky_is_limit.rb", "w" do |f|
-      f.write <<-RUBY
+    File.write("tmp/experiments/metrics/sky_is_limit.rb", <<-RUBY)
         metric "Sky is limit" do
           def bounds
             [6,12]
           end
         end
-      RUBY
-    end
-    assert_equal [6,12], Vanity::Metric.bounds(Vanity.playground.metric(:sky_is_limit))
+    RUBY
+    assert_equal [6, 12], Vanity::Metric.bounds(Vanity.playground.metric(:sky_is_limit))
   end
 
   it "metric without bounds" do
@@ -230,7 +209,6 @@ describe "Metric bounds" do
   end
 end
 
-
 describe "Metric last_update_at" do
   it "for new metric" do
     metric "Coolness"
@@ -249,7 +227,6 @@ describe "Metric last_update_at" do
   end
 end
 
-
 describe "Metric data" do
   it "explicit dates" do
     metric "Yawns/sec"
@@ -287,15 +264,13 @@ describe "Metric data" do
   end
 
   it "using custom values method" do
-    File.open "tmp/experiments/metrics/hours_in_day.rb", "w" do |f|
-      f.write <<-RUBY
+    File.write("tmp/experiments/metrics/hours_in_day.rb", <<-RUBY)
         metric "Hours in day" do
           def values(from, to)
             (from..to).map { |d| 24 }
           end
         end
-      RUBY
-    end
+    RUBY
     data = Vanity::Metric.data(Vanity.playground.metric(:hours_in_day))
     assert_equal [24] * 90, data.map(&:last)
   end

data/test/metric/google_analytics_test.rb

@@ -2,27 +2,23 @@ require "test_helper"
 
 describe "Google Analytics" do
   before do
-    File.open "tmp/experiments/metrics/ga.rb", "w" do |f|
-      f.write <<-RUBY
+    File.write("tmp/experiments/metrics/ga.rb", <<-RUBY)
         metric "GA" do
           google_analytics "UA2"
         end
-      RUBY
-    end
+    RUBY
   end
 
-  GA_RESULT = Struct.new(:date, :pageviews, :visits)
-  GA_PROFILE = Struct.new(:web_property_id)
+  GA_RESULT = Struct.new(:date, :pageviews, :visits) # rubocop:todo Lint/ConstantDefinitionInBlock
+  GA_PROFILE = Struct.new(:web_property_id) # rubocop:todo Lint/ConstantDefinitionInBlock
 
   it "fail if Garb not available" do
-    File.open "tmp/experiments/metrics/ga.rb", "w" do |f|
-      f.write <<-RUBY
+    File.write("tmp/experiments/metrics/ga.rb", <<-RUBY)
         metric "GA" do
           expects(:require).raises LoadError
           google_analytics "UA2"
         end
-      RUBY
-    end
+    RUBY
     assert_raises LoadError do
       Vanity.playground.metrics
     end
@@ -45,13 +41,11 @@ describe "Google Analytics" do
   end
 
   it "accept other metrics" do
-    File.open "tmp/experiments/metrics/ga.rb", "w" do |f|
-      f.write <<-RUBY
+    File.write("tmp/experiments/metrics/ga.rb", <<-RUBY)
         metric "GA" do
           google_analytics "UA2", :visitors
         end
-      RUBY
-    end
+    RUBY
     Vanity.playground.metrics
     assert_equal [:visitors], metric(:ga).report.metrics.elements
   end
@@ -67,35 +61,33 @@ describe "Google Analytics" do
     Vanity.playground.metrics
     Garb::Profile.expects(:all).returns(Array.new(3) { |i| GA_PROFILE.new("UA#{i + 1}") })
     metric(:ga).report.stubs(:send_request_for_body).returns(nil)
-    Garb::ReportResponse.stubs(:new).returns(mock(:results=>[]))
+    Garb::ReportResponse.stubs(:new).returns(mock(results: []))
     metric(:ga).values(Date.parse("2010-02-10"), Date.parse("2010-02-12"))
     assert_equal "UA2", metric(:ga).report.profile.web_property_id
   end
 
   it "should map results from report" do
     Vanity.playground.metrics
-    today = Date.today
-    response = mock(:results=>Array.new(3) { |i| GA_RESULT.new("2010021#{i}", i + 1) })
+    today = Date.today # rubocop:todo Lint/UselessAssignment
+    response = mock(results: Array.new(3) { |i| GA_RESULT.new("2010021#{i}", i + 1) })
     Garb::Profile.stubs(:all).returns([])
     Garb::ReportResponse.expects(:new).returns(response)
     metric(:ga).report.stubs(:send_request_for_body).returns(nil)
-    assert_equal [1,2,3], metric(:ga).values(Date.parse("2010-02-10"), Date.parse("2010-02-12"))
+    assert_equal [1, 2, 3], metric(:ga).values(Date.parse("2010-02-10"), Date.parse("2010-02-12"))
   end
 
   it "mapping GA metrics to single value" do
-    File.open "tmp/experiments/metrics/ga.rb", "w" do |f|
-      f.write <<-RUBY
+    File.write("tmp/experiments/metrics/ga.rb", <<-RUBY)
         metric "GA" do
           google_analytics "UA2", :mapper=>lambda { |e| e.pageviews * e.visits }
         end
-      RUBY
-    end
+    RUBY
     Vanity.playground.metrics
-    today = Date.today
-    response = mock(:results=>Array.new(3) { |i| GA_RESULT.new("2010021#{i}", i + 1, i + 1) })
+    today = Date.today # rubocop:todo Lint/UselessAssignment
+    response = mock(results: Array.new(3) { |i| GA_RESULT.new("2010021#{i}", i + 1, i + 1) })
     Garb::Profile.stubs(:all).returns([])
     Garb::ReportResponse.expects(:new).returns(response)
     metric(:ga).report.stubs(:send_request_for_body).returns(nil)
-    assert_equal [1,4,9], metric(:ga).values(Date.parse("2010-02-10"), Date.parse("2010-02-12"))
+    assert_equal [1, 4, 9], metric(:ga).values(Date.parse("2010-02-10"), Date.parse("2010-02-12"))
   end
 end

data/test/metric/remote_test.rb

@@ -2,13 +2,11 @@ require "test_helper"
 
 describe "Remote metrics" do
   before do
-    File.open "tmp/experiments/metrics/sandbox.rb", "w" do |f|
-      f.write <<-RUBY
+    File.write("tmp/experiments/metrics/sandbox.rb", <<-RUBY)
         metric "Sandbox" do
           remote "http://api.vanitydash.com/metrics/sandbox"
         end
-      RUBY
-    end
+    RUBY
 
     Dir.chdir "tmp" do
       Vanity.playground.load!
@@ -28,7 +26,6 @@ describe "Remote metrics" do
   end
 end
 
-
 describe "Remote send" do
   before do
     @metric = Vanity::Metric.new(Vanity.playground, :sandbox)
@@ -40,7 +37,7 @@ describe "Remote send" do
   it "remote send in sequence" do
     Vanity.playground.track! :sandbox
     Vanity.playground.track! :sandbox
-    assert_requested(:post, "http://api.vanitydash.com/metrics/sandbox", :times=>2)
+    assert_requested(:post, "http://api.vanitydash.com/metrics/sandbox", times: 2)
   end
 
   it "remote sends url-encoded data" do
@@ -59,7 +56,7 @@ describe "Remote send" do
   end
 
   it "remote sends array of values" do
-    Vanity.playground.track! :sandbox, [1,2,3]
+    Vanity.playground.track! :sandbox, [1, 2, 3]
     assert_requested(:post, /api/) { |request| Rack::Utils.parse_query(request.body)["values[]"] == %w{1 2 3} }
   end
 
@@ -90,7 +87,7 @@ describe "Remote send" do
     Vanity.playground.track! :sandbox
     stub_request(:post, /api/)
     Vanity.playground.track! :sandbox
-    assert_requested(:post, /api/, :times=>2)
+    assert_requested(:post, /api/, times: 2)
   end
 
   it "remote send handles timeout error" do
@@ -98,13 +95,13 @@ describe "Remote send" do
     Vanity.playground.track! :sandbox
     stub_request(:post, /api/)
     Vanity.playground.track! :sandbox
-    assert_requested(:post, /api/, :times=>2)
+    assert_requested(:post, /api/, times: 2)
   end
 
   it "remote does not send when metrics disabled" do
     not_collecting!
     Vanity.playground.track! :sandbox
     Vanity.playground.track! :sandbox
-    assert_requested(:post, /api/, :times=>0)
+    assert_requested(:post, /api/, times: 0)
   end
 end

data/test/playground_test.rb

@@ -1,28 +1,23 @@
 require "test_helper"
 
 describe Vanity::Playground do
-
   it "has one global instance" do
     assert instance = Vanity.playground
     assert_equal instance, Vanity.playground
   end
 
   it "creates metrics hooks on initialization for tracking" do
-    File.open "tmp/experiments/metrics/coolness.rb", "w" do |f|
-      f.write <<-RUBY
+    File.write("tmp/experiments/metrics/coolness.rb", <<-RUBY)
         metric "coolness" do
         end
-      RUBY
-    end
+    RUBY
 
-    File.open "tmp/experiments/foobar.rb", "w" do |f|
-      f.write <<-RUBY
+    File.write("tmp/experiments/foobar.rb", <<-RUBY)
         ab_test :foobar do
           metrics :coolness
           default false
         end
-      RUBY
-    end
+    RUBY
 
     # new_ab_test :foobar do
     #   alternatives "foo", "bar"
@@ -56,7 +51,7 @@ describe Vanity::Playground do
         proc = Vanity.playground.on_datastore_error
         assert proc.respond_to?(:call)
         assert_silent do
-          proc.call(Exception.new("datastore error"), self.class, caller[0][/`.*'/][1..-2], [1, 2, 3])
+          proc.call(Exception.new("datastore error"), self.class, caller(1..1).first[/`.*'/][1..-2], [1, 2, 3])
         end
       end
     end
@@ -105,12 +100,10 @@ describe Vanity::Playground do
 
   describe "#experiments" do
     it "saves experiments exactly once" do
-      File.open "tmp/experiments/foobar.rb", "w" do |f|
-        f.write <<-RUBY
+      File.write("tmp/experiments/foobar.rb", <<-RUBY)
           ab_test :foobar do
           end
-        RUBY
-      end
+      RUBY
       Vanity::Experiment::AbTest.any_instance.expects(:save).once
       Vanity.playground.experiments
     end

data/test/templates_test.rb

@@ -7,7 +7,7 @@ describe Vanity::Templates do
 
   describe "template" do
     it "resolves templates from the configured path" do
-      custom_view_path = File.expand_path(File.join(Rails.root, 'app', 'views', 'vanity'))
+      custom_view_path = File.expand_path(File.join(Rails.root, 'app', 'views', 'vanity')) # rubocop:todo Lint/UselessAssignment
       gem_view_path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'vanity', 'templates'))
       expected = File.join(gem_view_path, 'foo.html')
 
@@ -15,33 +15,29 @@ describe Vanity::Templates do
     end
 
     it "resolves templates from a Rails view directory when configured" do
-      begin
-        custom_view_path = File.expand_path(File.join(Rails.root, 'app', 'views', 'vanity'))
-        Vanity.configuration.templates_path = custom_view_path
+      custom_view_path = File.expand_path(File.join(Rails.root, 'app', 'views', 'vanity'))
+      Vanity.configuration.templates_path = custom_view_path
 
-        expected = File.expand_path(File.join(custom_view_path, 'foo.html'))
+      expected = File.expand_path(File.join(custom_view_path, 'foo.html'))
 
-        FileUtils.mkpath(custom_view_path)
-        File.open(expected, "w")
+      FileUtils.mkpath(custom_view_path)
+      File.open(expected, "w")
 
-        assert_equal expected, Vanity::Templates.new.path('foo.html')
-      ensure
-        FileUtils.rm_rf(custom_view_path)
-      end
+      assert_equal expected, Vanity::Templates.new.path('foo.html')
+    ensure
+      FileUtils.rm_rf(custom_view_path)
     end
 
     it "ignores an empty view directory" do
-      begin
-        custom_view_path = File.expand_path(File.join(Rails.root, 'app', 'views', 'vanity'))
-        FileUtils.mkpath(custom_view_path)
+      custom_view_path = File.expand_path(File.join(Rails.root, 'app', 'views', 'vanity'))
+      FileUtils.mkpath(custom_view_path)
 
-        gem_view_path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'vanity', 'templates'))
-        expected = File.join(gem_view_path, 'foo.html')
+      gem_view_path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'vanity', 'templates'))
+      expected = File.join(gem_view_path, 'foo.html')
 
-        assert_equal expected, Vanity::Templates.new.path('foo.html')
-      ensure
-        FileUtils.rm_rf(custom_view_path)
-      end
+      assert_equal expected, Vanity::Templates.new.path('foo.html')
+    ensure
+      FileUtils.rm_rf(custom_view_path)
     end
   end
 end

data/test/test_helper.rb

@@ -12,10 +12,10 @@ require "active_record"
 
 begin
   require "rails"
-rescue LoadError
+rescue LoadError # rubocop:todo Lint/SuppressedException
 end
 
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require File.expand_path('dummy/config/environment.rb', __dir__)
 require "rails/test_help"
 
 require "vanity"
@@ -27,16 +27,16 @@ require "webmock/minitest"
 # Due to load order differences in Rails boot and test requires we have to
 # manually require these
 
-# TODO wonder if we can load rails only for the rails tests...
+# TODO: wonder if we can load rails only for the rails tests...
 require 'vanity/frameworks/rails'
 Vanity::Rails.load!
 
 if $DEBUG
-  $logger = Logger.new(STDOUT)
-  $logger.level = Logger::DEBUG
+  $logger = Logger.new(STDOUT) # rubocop:todo Style/GlobalVars
+  $logger.level = Logger::DEBUG # rubocop:todo Style/GlobalVars
 else
-  $logger = Logger.new(STDOUT)
-  $logger.level = Logger::FATAL
+  $logger = Logger.new(STDOUT) # rubocop:todo Style/GlobalVars
+  $logger.level = Logger::FATAL # rubocop:todo Style/GlobalVars
 end
 
 module VanityTestHelpers
@@ -46,13 +46,13 @@ module VanityTestHelpers
   DATABASE_OPTIONS = {
     "redis" => "redis://localhost/15",
     "mongodb" => "mongodb://localhost/vanity",
-    "active_record" =>  { :adapter => "active_record", :active_record_adapter =>"default" },
-    "mock" => "mock:/"
+    "active_record" =>  { adapter: "active_record", active_record_adapter: "default" },
+    "mock" => "mock:/",
   }
 
-  DATABASE = DATABASE_OPTIONS[ENV["DB"]] or raise "No support yet for #{ENV["DB"]}"
+  DATABASE = DATABASE_OPTIONS[ENV["DB"]] or raise "No support yet for #{ENV['DB']}"
 
-  TEST_DATA_FILES = Dir[File.expand_path("../data/*",  __FILE__)]
+  TEST_DATA_FILES = Dir[File.expand_path('data/*', __dir__)]
   VANITY_CONFIGS = TEST_DATA_FILES.each.with_object({}) do |path, hash|
     hash[File.basename(path)] = File.read(path)
   end
@@ -73,7 +73,7 @@ module VanityTestHelpers
   # or reload an experiment (saved by the previous playground).
   def vanity_reset
     Vanity.reset!
-    Vanity.configuration.logger = $logger
+    Vanity.configuration.logger = $logger # rubocop:todo Style/GlobalVars
     Vanity.configuration.experiments_path = "tmp/experiments"
 
     Vanity.disconnect!
@@ -99,7 +99,6 @@ module VanityTestHelpers
     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)
@@ -144,9 +143,9 @@ module VanityTestHelpers
   def dummy_request
     # Rails 5 compatibility
     if ActionDispatch::TestRequest.respond_to?(:create)
-      ActionDispatch::TestRequest.create()
+      ActionDispatch::TestRequest.create
     else
-      ActionDispatch::TestRequest.new()
+      ActionDispatch::TestRequest.new
     end
   end
 
@@ -154,13 +153,13 @@ module VanityTestHelpers
   # override the built-in setup/teardown methods, so we alias_method_chain
   # them to run.
   def self.included(klass)
-    klass.class_eval {
-      alias :teardown_before :teardown
-      alias :teardown :teardown_after
+    klass.class_eval do
+      alias_method :teardown_before, :teardown
+      alias_method :teardown, :teardown_after
 
-      alias :setup_before :setup
-      alias :setup :setup_after
-    }
+      alias_method :setup_before, :setup
+      alias_method :setup, :setup_after
+    end
   end
 end
 
@@ -196,7 +195,7 @@ module LegacyTestRequests
     ActiveRecord::VERSION::MAJOR <= 4
   end
 
-  def get(path, params={}, headers={})
+  def get(path, params = {}, headers = {})
     if rails4?
       process(path, 'GET', params, headers)
     else
@@ -204,7 +203,7 @@ module LegacyTestRequests
     end
   end
 
-  def post(path, params={}, headers={})
+  def post(path, params = {}, headers = {})
     if rails4?
       process(path, 'POST', params, headers)
     else
@@ -212,7 +211,7 @@ module LegacyTestRequests
     end
   end
 
-  def put(path, params={}, headers={})
+  def put(path, params = {}, headers = {})
     if rails4?
       process(path, 'PUT', params, headers)
     else
@@ -220,7 +219,7 @@ module LegacyTestRequests
     end
   end
 
-  def delete(path, params={}, headers={})
+  def delete(path, params = {}, headers = {})
     if rails4?
       process(path, 'DELETE', params, headers)
     else
@@ -233,7 +232,7 @@ if defined?(ActionController::TestCase)
   class ActionController::TestCase
     include LegacyTestRequests
 
-    alias :setup_controller_request_and_response_without_vanity :setup_controller_request_and_response
+    alias setup_controller_request_and_response_without_vanity setup_controller_request_and_response
     # Sets Vanity.context to the current controller, so you can do things like:
     #   experiment(:simple).chooses(:green)
     def setup_controller_request_and_response
@@ -244,13 +243,13 @@ if defined?(ActionController::TestCase)
 end
 
 if defined?(ActionDispatch::IntegrationTest)
-  class ActionDispatch::IntegrationTest
+  class ActionDispatch::IntegrationTest # rubocop:todo Lint/EmptyClass
   end
 end
 
 if ENV["DB"] == "active_record"
   ActiveRecord::Base.establish_connection
-  ActiveRecord::Base.logger = $logger
+  ActiveRecord::Base.logger = $logger # rubocop:todo Style/GlobalVars
 
   Vanity.connect!(VanityTestHelpers::DATABASE)
 
@@ -262,7 +261,7 @@ if ENV["DB"] == "active_record"
   require "generators/vanity/migration_generator"
   Rails::Generators.invoke "vanity"
 
-  migrate_path = File.expand_path("../dummy/db/migrate/", __FILE__)
+  migrate_path = File.expand_path('dummy/db/migrate', __dir__)
   if defined?(ActiveRecord::MigrationContext)
     ActiveRecord::MigrationContext.new(migrate_path).migrate
   else