vanity 3.0.2 → 4.0.1

data/lib/vanity/adapters/redis_adapter.rb

@@ -6,9 +6,10 @@ module Vanity
       # @since 1.4.0
       def redis_connection(spec)
         require "redis"
-        fail "redis >= 2.1 is required" unless valid_redis_version?
+        raise "redis >= 2.1 is required" unless valid_redis_version?
+
         require "redis/namespace"
-        fail "redis-namespace >= 1.1.0 is required" unless valid_redis_namespace_version?
+        raise "redis-namespace >= 1.1.0 is required" unless valid_redis_namespace_version?
 
         RedisAdapter.new(spec)
       end
@@ -28,7 +29,7 @@ module Vanity
     class RedisAdapter < AbstractAdapter
       attr_reader :redis
 
-      def initialize(options)
+      def initialize(options) # rubocop:todo Lint/MissingSuper
         @options = options.clone
         @options[:db] ||= @options[:database] || (@options[:path] && @options.delete(:path).split("/")[1].to_i)
         @options[:thread_safe] = true
@@ -40,9 +41,7 @@ module Vanity
       end
 
       def disconnect!
-        if redis
-          redis.disconnect!
-        end
+        redis.disconnect! if redis
         @redis = nil
       end
 
@@ -53,8 +52,8 @@ module Vanity
 
       def connect!
         @redis = @options[:redis] || Redis.new(@options)
-        @metrics = Redis::Namespace.new("vanity:metrics", :redis=>redis)
-        @experiments = Redis::Namespace.new("vanity:experiments", :redis=>redis)
+        @metrics = Redis::Namespace.new("vanity:metrics", redis: redis)
+        @experiments = Redis::Namespace.new("vanity:experiments", redis: redis)
       end
 
       def to_s
@@ -74,7 +73,7 @@ module Vanity
 
       def metric_track(metric, timestamp, identity, values)
         call_redis_with_failover(metric, timestamp, identity, values) do
-          values.each_with_index do |v,i|
+          values.each_with_index do |v, i|
             @metrics.incrby "#{metric}:#{timestamp.to_date}:value:#{i}", v
           end
           @metrics.set("#{metric}:last_update_at", Time.now.to_i)
@@ -90,7 +89,6 @@ module Vanity
         @metrics.del(*@metrics.keys("#{metric}:*"))
       end
 
-
       # -- Experiments --
 
       def experiment_persisted?(experiment)
@@ -117,7 +115,7 @@ module Vanity
         completed_at && Time.at(completed_at.to_i)
       end
 
-      def is_experiment_completed?(experiment)
+      def is_experiment_completed?(experiment) # rubocop:todo Naming/PredicateName
         call_redis_with_failover do
           @experiments.exists("#{experiment}:completed_at")
         end
@@ -129,7 +127,7 @@ module Vanity
         end
       end
 
-      def is_experiment_enabled?(experiment)
+      def is_experiment_enabled?(experiment) # rubocop:todo Naming/PredicateName
         value = @experiments.get("#{experiment}:enabled")
         if Vanity.configuration.experiments_start_enabled
           value != 'false'
@@ -140,9 +138,9 @@ module Vanity
 
       def ab_counts(experiment, alternative)
         {
-          :participants => @experiments.scard("#{experiment}:alts:#{alternative}:participants").to_i,
-          :converted    => @experiments.scard("#{experiment}:alts:#{alternative}:converted").to_i,
-          :conversions  => @experiments.get("#{experiment}:alts:#{alternative}:conversions").to_i
+          participants: @experiments.scard("#{experiment}:alts:#{alternative}:participants").to_i,
+          converted: @experiments.scard("#{experiment}:alts:#{alternative}:converted").to_i,
+          conversions: @experiments.get("#{experiment}:alts:#{alternative}:conversions").to_i,
         }
       end
 
@@ -174,11 +172,7 @@ module Vanity
       def ab_seen(experiment, identity, alternative_or_id)
         with_ab_seen_deprecation(experiment, identity, alternative_or_id) do |expt, ident, alt_id|
           call_redis_with_failover(expt, ident, alt_id) do
-            if @experiments.sismember "#{expt}:alts:#{alt_id}:participants", ident
-              alt_id
-            else
-              nil
-            end
+            alt_id if @experiments.sismember "#{expt}:alts:#{alt_id}:participants", ident
           end
         end
       end
@@ -187,9 +181,7 @@ module Vanity
       def ab_assigned(experiment, identity)
         call_redis_with_failover do
           Vanity.playground.experiments[experiment].alternatives.each do |alternative|
-            if @experiments.sismember "#{experiment}:alts:#{alternative.id}:participants", identity
-              return alternative.id
-            end
+            return alternative.id if @experiments.sismember "#{experiment}:alts:#{alternative.id}:participants", identity
           end
           nil
         end
@@ -219,7 +211,7 @@ module Vanity
       def destroy_experiment(experiment)
         cursor = nil
 
-        while cursor != "0" do
+        while cursor != "0"
           cursor, keys = @experiments.scan(cursor || "0", match: "#{experiment}:*")
 
           @experiments.del(*keys) unless keys.empty?
@@ -229,11 +221,11 @@ module Vanity
       protected
 
       def call_redis_with_failover(*arguments)
-        calling_method = caller[0][/`.*'/][1..-2]
+        calling_method = caller(1..1).first[/`.*'/][1..-2]
         begin
           yield
-        rescue => e
-          if Vanity.configuration.failover_on_datastore_error
+        rescue StandardError => e
+          if Vanity.configuration.failover_on_datastore_error # rubocop:todo Style/GuardClause
             Vanity.configuration.on_datastore_error.call(e, self.class, calling_method, arguments)
           else
             raise e

data/lib/vanity/adapters.rb

@@ -17,4 +17,4 @@ module Vanity
       end
     end
   end
-end
+end

data/lib/vanity/autoconnect.rb

@@ -2,8 +2,7 @@ module Vanity
   # A singleton responsible for determining if the playground should connect
   # to the datastore.
   module Autoconnect
-
-     BLACKLISTED_RAILS_RAKE_TASKS = [
+    BLACKLISTED_RAILS_RAKE_TASKS = [
       'about',
       'assets:clean',
       'assets:clobber',
@@ -38,7 +37,7 @@ module Vanity
       'stats',
       'time:zones:all',
       'tmp:clear',
-      'tmp:create'
+      'tmp:create',
     ]
     ENVIRONMENT_VANITY_DISABLED_FLAG = "VANITY_DISABLED"
 
@@ -46,10 +45,10 @@ module Vanity
       def should_connect?
         !environment_disabled? && !in_blacklisted_rake_task?
       end
-      alias_method :playground_should_autoconnect?, :should_connect?
+      alias playground_should_autoconnect? should_connect?
 
       def schema_relevant?
-        current_rake_tasks.any? { |task| task =~ /\Adb:/ }
+        current_rake_tasks.any? { |task| task.start_with?('db:') }
       end
 
       def environment_disabled?
@@ -62,9 +61,9 @@ module Vanity
 
       def current_rake_tasks
         ::Rake.application.top_level_tasks
-      rescue
+      rescue StandardError
         []
       end
     end
   end
-end
+end

data/lib/vanity/commands/list.rb

@@ -4,16 +4,16 @@ module Vanity
       # Lists all experiments and metrics.
       def list
         Vanity.playground.experiments.each do |id, experiment|
-          puts "experiment :%-.20s (%-.40s)" % [id, experiment.name]
-          if experiment.respond_to?(:alternatives)
-            experiment.alternatives.each do |alt|
-              hash = experiment.fingerprint(alt)
-              puts "  %s: %-40.40s  (%s)" % [alt.name, alt.value, hash]
-            end
+          puts format("experiment :%-.20s (%-.40s)", id, experiment.name)
+          next unless experiment.respond_to?(:alternatives)
+
+          experiment.alternatives.each do |alt|
+            hash = experiment.fingerprint(alt)
+            puts format("  %s: %-40.40s  (%s)", alt.name, alt.value, hash)
           end
         end
         Vanity.playground.metrics.each do |id, metric|
-          puts "metric :%-.20s (%-.40s)" % [id, metric.name]
+          puts format("metric :%-.20s (%-.40s)", id, metric.name)
         end
       end
     end

data/lib/vanity/commands/report.rb

@@ -2,11 +2,9 @@ require "erb"
 require "cgi"
 
 module Vanity
-
   # Render method available to templates (when used by Vanity command line,
   # outside Rails).
   module Render
-
     # Render the named template. Used for reporting and the dashboard.
     def render(path_or_options, locals = {})
       if path_or_options.respond_to?(:keys)
@@ -29,21 +27,23 @@ module Vanity
     end
 
     class ProxyEmpty < String
-      def method_missing(method, *args, &block); self.class.new end
+      def method_missing(_method, *_args) # rubocop:todo Style/MissingRespondToMissing
+        self.class.new
+      end
     end
 
     # prevent certain url helper methods from failing so we can run erb templates outside of rails for reports.
-    def method_missing(method, *args, &block)
+    def method_missing(method, *args, &block) # rubocop:todo Style/MissingRespondToMissing
       %w(url_for flash).include?(method.to_s) ? ProxyEmpty.new : super
     end
 
     # Dumbed down from Rails' simple_format.
-    def vanity_simple_format(text, options={})
-      open = "<p #{options.map { |k,v| "#{k}=\"#{CGI.escapeHTML v}\"" }.join(" ")}>"
-      text = open + text.gsub(/\r\n?/, "\n").   # \r\n and \r -> \n
-        gsub(/\n\n+/, "</p>\n\n#{open}").       # 2+ newline  -> paragraph
-        gsub(/([^\n]\n)(?=[^\n])/, '\1<br />') + # 1 newline   -> br
-        "</p>"
+    def vanity_simple_format(text, options = {})
+      open = "<p #{options.map { |k, v| "#{k}=\"#{CGI.escapeHTML v}\"" }.join(' ')}>"
+      text = open + text.gsub(/\r\n?/, "\n") # \r\n and \r -> \n # rubocop:todo Lint/UselessAssignment
+                        .gsub(/\n\n+/, "</p>\n\n#{open}") # 2+ newline  -> paragraph
+                        .gsub(/([^\n]\n)(?=[^\n])/, '\1<br />') + # 1 newline   -> br
+             "</p>"
     end
 
     protected
@@ -54,7 +54,7 @@ module Vanity
       struct = Struct.new(*keys)
       struct.send :include, Render
       locals = struct.new(*locals.values_at(*keys))
-      path = "#{Vanity.template(path)}.erb" unless path =~ /\/.*\.erb\z/
+      path = "#{Vanity.template(path)}.erb" unless /\/.*\.erb\z/.match?(path)
       dir, base = File.split(path)
       path = File.join(dir, partialize(base))
       erb = ERB.new(File.read(path), nil, '<>')
@@ -63,10 +63,10 @@ module Vanity
     end
 
     def partialize(template_name)
-      if template_name[0] != '_'
-        "_#{template_name}"
-      else
+      if template_name[0] == '_'
         template_name
+      else
+        "_#{template_name}"
       end
     end
   end
@@ -80,20 +80,16 @@ module Vanity
       # arguments.
       def report(output = nil)
         html = render(Vanity.template("_report.erb"),
-          :experiments=>Vanity.playground.experiments,
-          :experiments_persisted=>Vanity.playground.experiments_persisted?,
-          :metrics=>Vanity.playground.metrics
-        )
+                      experiments: Vanity.playground.experiments,
+                      experiments_persisted: Vanity.playground.experiments_persisted?,
+                      metrics: Vanity.playground.metrics)
         if output
-          File.open output, 'w' do |file|
-            file.write html
-          end
+          File.write(output, html)
           puts "New report available in #{output}"
         else
           $stdout.write html
         end
       end
-
     end
   end
 end

data/lib/vanity/configuration.rb

@@ -7,7 +7,7 @@ module Vanity
     LEGACY_CONNECTION_KEY = :connection
     LEGACY_REDIS_CONFIG_FILE = "redis.yml"
 
-    class<<self
+    class << self
       private
 
       def default_logger # :nodoc:
@@ -30,9 +30,9 @@ module Vanity
       #
       def default_request_filter(request) # :nodoc:
         request &&
-        request.env &&
-        request.env["HTTP_USER_AGENT"] &&
-        request.env["HTTP_USER_AGENT"].match( /(?:https?:\/\/)|(?:bot|spider|crawler)/i )
+          request.env &&
+          request.env["HTTP_USER_AGENT"] &&
+          request.env["HTTP_USER_AGENT"].match(/(?:https?:\/\/)|(?:bot|spider|crawler)/i)
       end
     end
 
@@ -46,9 +46,10 @@ module Vanity
       failover_on_datastore_error: false,
       locales_path: File.expand_path(File.join(File.dirname(__FILE__), 'locales')),
       logger: default_logger,
-      on_datastore_error: ->(error, klass, method, arguments) {
+      on_datastore_error: lambda { |error, klass, method, arguments|
         default_on_datastore_error(error, klass, method, arguments)
       },
+      on_assignment: nil,
       request_filter: ->(request) { default_request_filter(request) },
       templates_path: File.expand_path(File.join(File.dirname(__FILE__), 'templates')),
       use_js: false,
@@ -181,10 +182,13 @@ module Vanity
     # Cookie path. If true, cookie will not be available to JS. By default false.
     attr_writer :cookie_httponly
 
+    # Default callback on assigment
+    attr_writer :on_assignment
+
     # We independently list each attr_accessor to includes docs, otherwise
     # something like DEFAULTS.each { |key, value| attr_accessor key } would be
     # shorter.
-    DEFAULTS.each do |default, value|
+    DEFAULTS.each do |default, _value|
       define_method default do
         self[default]
       end
@@ -204,22 +208,22 @@ module Vanity
     end
 
     # @return nil or a hash of symbolized keys for connection settings
-    def connection_params(file_name=nil)
+    def connection_params(file_name = nil)
       file_name ||= config_file
       file_path = File.join(config_path, file_name)
 
-      if File.exist?(file_path)
-        config = YAML.load(ERB.new(File.read(file_path)).result)
+      if File.exist?(file_path) # rubocop:todo Style/GuardClause
+        config = YAML.safe_load(ERB.new(File.read(file_path)).result, [], [], true)
         config ||= {}
         params_for_environment = config[environment.to_s]
 
-        unless params_for_environment
-          raise MissingEnvironment.new("No configuration for #{environment}")
-        end
+        raise MissingEnvironment, "No configuration for #{environment}" unless params_for_environment
 
         # Symbolize keys if it's a hash.
         if params_for_environment.respond_to?(:inject)
-          params_for_environment.inject({}) { |h,kv| h[kv.first.to_sym] = kv.last ; h }
+          params_for_environment.each_with_object({}) do |kv, h|
+            h[kv.first.to_sym] = kv.last
+          end
         else
           params_for_environment
         end
@@ -234,11 +238,11 @@ module Vanity
 
       connection_url = connection_config[LEGACY_CONNECTION_KEY]
 
-      if connection_url
-        logger.warn(%q{Deprecated: Please specify connection urls using the `url` key with a protocol prefix instead of `connection`. This fallback will be removed in a future version.})
+      if connection_url # rubocop:todo Style/GuardClause
+        logger.warn('Deprecated: Please specify connection urls using the `url` key with a protocol prefix instead of `connection`. This fallback will be removed in a future version.')
 
         # Legacy lack of protocol handling
-        if connection_url =~ /^\w+:/
+        if /^\w+:/.match?(connection_url)
           connection_url
         else
           "redis://" + connection_url
@@ -250,10 +254,10 @@ module Vanity
     def redis_url_from_file
       connection_url = connection_params(LEGACY_REDIS_CONFIG_FILE)
 
-      if connection_url
-        logger.warn(%q{Deprecated: Please specify the vanity config file, the default fallback to "config/redis.yml" may be removed in a future version.})
+      if connection_url # rubocop:todo Style/GuardClause
+        logger.warn('Deprecated: Please specify the vanity config file, the default fallback to "config/redis.yml" may be removed in a future version.')
 
-        if connection_url =~ /^\w+:/
+        if /^\w+:/.match?(connection_url)
           connection_url
         else
           "redis://" + connection_url

data/lib/vanity/connection.rb

@@ -30,12 +30,10 @@ module Vanity
     #     :host=>"redis.local"
     #   )
     # @since 2.0.0
-    def initialize(specification=nil)
+    def initialize(specification = nil)
       @specification = Specification.new(specification || DEFAULT_SPECIFICATION).to_h
 
-      if Autoconnect.playground_should_autoconnect?
-        @adapter = setup_connection(@specification)
-      end
+      @adapter = setup_connection(@specification) if Autoconnect.playground_should_autoconnect?
     end
 
     # Closes the current connection.
@@ -68,16 +66,16 @@ module Vanity
         when String
           @spec = build_specification_hash_from_url(spec)
         when Hash
-          if spec[:redis]
-            @spec = {
-              adapter: :redis,
-              redis: spec[:redis]
-            }
-          else
-            @spec = spec
-          end
+          @spec = if spec[:redis]
+                    {
+                      adapter: :redis,
+                      redis: spec[:redis],
+                    }
+                  else
+                    spec
+                  end
         else
-          raise InvalidSpecification.new("Unsupported connection specification: #{spec.inspect}")
+          raise InvalidSpecification, "Unsupported connection specification: #{spec.inspect}"
         end
 
         validate_specification_hash(@spec)
@@ -104,7 +102,7 @@ module Vanity
           host: uri.host,
           port: uri.port,
           path: uri.path,
-          params: params
+          params: params,
         }
       end
     end