honeybadger 5.29.1 → 6.0.0

data/lib/honeybadger/config/env.rb

@@ -1,19 +1,19 @@
-require 'set'
+require "set"
 
 module Honeybadger
   class Config
     module Env
-      CONFIG_KEY = /\AHONEYBADGER_(.+)\Z/.freeze
-      CONFIG_MAPPING = Hash[DEFAULTS.keys.map {|k| [k.to_s.upcase.gsub(KEY_REPLACEMENT, '_'), k] }].freeze
+      CONFIG_KEY = /\AHONEYBADGER_(.+)\Z/
+      CONFIG_MAPPING = DEFAULTS.keys.map { |k| [k.to_s.upcase.gsub(KEY_REPLACEMENT, "_"), k] }.to_h.freeze
       ARRAY_VALUES = Regexp.new('\s*,\s*').freeze
       IGNORED_TYPES = Set[Hash]
 
       def self.new(env = ENV)
         hash = {}
 
-        env.each_pair do |k,v|
+        env.each_pair do |k, v|
           next unless k.match(CONFIG_KEY)
-          next unless config_key = CONFIG_MAPPING[$1]
+          next unless (config_key = CONFIG_MAPPING[$1])
           type = OPTIONS[config_key][:type]
           next if IGNORED_TYPES.include?(type)
           hash[config_key] = cast_value(v, type)

data/lib/honeybadger/config/ruby.rb

@@ -12,7 +12,7 @@ module Honeybadger
       def to_hash
         hash.to_hash
       end
-      alias to_h to_hash
+      alias_method :to_h, :to_hash
 
       private
 
@@ -41,25 +41,25 @@ module Honeybadger
       end
 
       def mash?(method)
-        key = [prefix, method.to_s + '.'].compact.join('.')
-        KEYS.any? {|k| k.start_with?(key) }
+        key = [prefix, method.to_s + "."].compact.join(".")
+        KEYS.any? { |k| k.start_with?(key) }
       end
 
       def setter?(method_name)
-        return false unless method_name.to_s =~ /=\z/
+        return false unless method_name.to_s.end_with?("=")
         key = key(method_name)
-        KEYS.any? {|k| k == key }
+        KEYS.any? { |k| k == key }
       end
 
       def getter?(method_name)
         key = key(method_name)
-        KEYS.any? {|k| k == key }
+        KEYS.any? { |k| k == key }
       end
 
       def key(method_name)
-        parts = [prefix, method_name.to_s.chomp('=')]
+        parts = [prefix, method_name.to_s.chomp("=")]
         parts.compact!
-        parts.join('.')
+        parts.join(".")
       end
 
       def get(key)
@@ -89,9 +89,9 @@ module Honeybadger
       def before_notify(action = nil, &block)
         hooks = Array(get(:before_notify)).dup
 
-        if action && validate_before_action(action, 'notify')
+        if action && validate_before_action(action, "notify")
           hooks << action
-        elsif block_given? && validate_before_action(block, 'notify')
+        elsif block_given? && validate_before_action(block, "notify")
           hooks << block
         end
 
@@ -101,9 +101,9 @@ module Honeybadger
       def before_event(action = nil, &block)
         hooks = Array(get(:before_event)).dup
 
-        if action && validate_before_action(action, 'event')
+        if action && validate_before_action(action, "event")
           hooks << action
-        elsif block_given? && validate_before_action(block, 'event')
+        elsif block_given? && validate_before_action(block, "event")
           hooks << block
         end
 
@@ -112,7 +112,7 @@ module Honeybadger
 
       def backtrace_filter(&block)
         if block_given?
-          logger.warn('DEPRECATED: backtrace_filter is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#backtrace_filter')
+          logger.warn("DEPRECATED: backtrace_filter is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#backtrace_filter")
           hash[:backtrace_filter] = block if block_given?
         end
 
@@ -121,7 +121,7 @@ module Honeybadger
 
       def exception_filter(&block)
         if block_given?
-          logger.warn('DEPRECATED: exception_filter is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#exception_filter')
+          logger.warn("DEPRECATED: exception_filter is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#exception_filter")
           hash[:exception_filter] = block
         end
 
@@ -130,7 +130,7 @@ module Honeybadger
 
       def exception_fingerprint(&block)
         if block_given?
-          logger.warn('DEPRECATED: exception_fingerprint is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#exception_fingerprint')
+          logger.warn("DEPRECATED: exception_fingerprint is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#exception_fingerprint")
           hash[:exception_fingerprint] = block
         end
 
@@ -143,15 +143,15 @@ module Honeybadger
         if !action.respond_to?(:call)
           logger.warn(
             "You attempted to add a before #{type} hook that does not respond " \
-            'to #call. We are discarding this hook so your intended behavior ' \
-            'will not occur.'
+            "to #call. We are discarding this hook so your intended behavior " \
+            "will not occur."
           )
           false
         elsif action.arity != 1
           logger.warn(
             "You attempted to add a before #{type} hook that has an arity " \
-            'other than one. We are discarding this hook so your intended ' \
-            'behavior will not occur.'
+            "other than one. We are discarding this hook so your intended " \
+            "behavior will not occur."
           )
           false
         else

data/lib/honeybadger/config/yaml.rb

@@ -1,14 +1,14 @@
-require 'pathname'
-require 'yaml'
-require 'erb'
+require "pathname"
+require "yaml"
+require "erb"
 
 module Honeybadger
   class Config
     module Yaml
-      DISALLOWED_KEYS = [:'config.path'].freeze
+      DISALLOWED_KEYS = [:"config.path"].freeze
 
-      def self.new(path, env = 'production')
-        path = path.kind_of?(Pathname) ? path : Pathname.new(path)
+      def self.new(path, env = "production")
+        path = path.is_a?(Pathname) ? path : Pathname.new(path)
 
         if !path.exist?
           raise ConfigError, "The configuration file #{path} was not found."
@@ -19,7 +19,7 @@ module Honeybadger
         end
 
         yaml = load_yaml(path)
-        yaml.merge!(yaml[env]) if yaml[env].kind_of?(Hash)
+        yaml.merge!(yaml[env]) if yaml[env].is_a?(Hash)
 
         dotify_keys(yaml)
       end
@@ -36,8 +36,8 @@ module Honeybadger
 
           if e.backtrace
             backtrace = e.backtrace.map do |line|
-              if line.start_with?('(erb)'.freeze)
-                line.gsub('(erb)'.freeze, path.to_s)
+              if line.start_with?("(erb)".freeze)
+                line.gsub("(erb)".freeze, path.to_s)
               else
                 line
               end
@@ -60,9 +60,9 @@ module Honeybadger
 
       def self.dotify_keys(hash, key_prefix = nil)
         {}.tap do |new_hash|
-          hash.each_pair do |k,v|
-            k = [key_prefix, k].compact.join('.')
-            if v.kind_of?(Hash)
+          hash.each_pair do |k, v|
+            k = [key_prefix, k].compact.join(".")
+            if v.is_a?(Hash)
               new_hash.update(dotify_keys(v, k))
             else
               next if DISALLOWED_KEYS.include?(k.to_sym)

data/lib/honeybadger/config.rb

@@ -1,16 +1,15 @@
-require 'pathname'
-require 'delegate'
-require 'logger'
-require 'fileutils'
-require 'openssl'
-
-require 'honeybadger/version'
-require 'honeybadger/logging'
-require 'honeybadger/backend'
-require 'honeybadger/config/defaults'
-require 'honeybadger/util/http'
-require 'honeybadger/util/revision'
-require 'honeybadger/logging'
+require "pathname"
+require "delegate"
+require "logger"
+require "fileutils"
+require "openssl"
+
+require "honeybadger/version"
+require "honeybadger/logging"
+require "honeybadger/backend"
+require "honeybadger/config/defaults"
+require "honeybadger/util/http"
+require "honeybadger/util/revision"
 
 module Honeybadger
   # @api private
@@ -25,9 +24,9 @@ module Honeybadger
 
     # Config subclasses have circular dependencies, so they must be loaded
     # after constants are defined.
-    autoload :Env, 'honeybadger/config/env'
-    autoload :Yaml, 'honeybadger/config/yaml'
-    autoload :Ruby, 'honeybadger/config/ruby'
+    autoload :Env, "honeybadger/config/env"
+    autoload :Yaml, "honeybadger/config/yaml"
+    autoload :Ruby, "honeybadger/config/ruby"
 
     KEY_REPLACEMENT = Regexp.new('[^a-z\d_]', Regexp::IGNORECASE).freeze
 
@@ -55,8 +54,8 @@ module Honeybadger
       init_logging!
       init_backend!
 
-      logger.debug(sprintf('Initializing Honeybadger Error Tracker for Ruby. Ship it! version=%s framework=%s', Honeybadger::VERSION, detected_framework))
-      logger.warn('Development mode is enabled. Data will not be reported until you deploy your app.') if warn_development?
+      logger.debug(sprintf("Initializing Honeybadger Error Tracker for Ruby. Ship it! version=%s framework=%s", Honeybadger::VERSION, detected_framework))
+      logger.warn("Development mode is enabled. Data will not be reported until you deploy your app.") if warn_development?
 
       self
     end
@@ -65,7 +64,7 @@ module Honeybadger
       return self if @loaded
       self.framework = framework.freeze
       self.env = Env.new(env).freeze
-      load_config_from_disk {|yaml| self.yaml = yaml.freeze }
+      load_config_from_disk { |yaml| self.yaml = yaml.freeze }
       detect_revision!
       @loaded = true
       self
@@ -81,7 +80,7 @@ module Honeybadger
 
     def backtrace_filter(&block)
       if block_given?
-        warn('DEPRECATED: backtrace_filter is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#backtrace_filter')
+        warn("DEPRECATED: backtrace_filter is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#backtrace_filter")
         self[:backtrace_filter] = block
       end
 
@@ -98,7 +97,7 @@ module Honeybadger
 
     def exception_filter(&block)
       if block_given?
-        warn('DEPRECATED: exception_filter is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#exception_filter')
+        warn("DEPRECATED: exception_filter is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#exception_filter")
         self[:exception_filter] = block
       end
 
@@ -107,7 +106,7 @@ module Honeybadger
 
     def exception_fingerprint(&block)
       if block_given?
-        warn('DEPRECATED: exception_fingerprint is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#exception_fingerprint')
+        warn("DEPRECATED: exception_fingerprint is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#exception_fingerprint")
         self[:exception_fingerprint] = block
       end
 
@@ -124,28 +123,27 @@ module Honeybadger
 
       DEFAULTS[key]
     end
-    alias [] :get
+    alias_method :[], :get
 
     def set(key, value)
       self.ruby = ruby.merge(key => value).freeze
       @logger = @backend = nil
     end
-    alias []= :set
+    alias_method :[]=, :set
 
     def to_hash(defaults = false)
-      hash = [:@ruby, :@env, :@yaml, :@framework].reverse.reduce({}) do |a,e|
+      hash = [:@ruby, :@env, :@yaml, :@framework].reverse.reduce({}) do |a, e|
         a.merge!(instance_variable_get(e))
       end
 
       hash = DEFAULTS.merge(hash) if defaults
 
-      undotify_keys(hash.select {|k,v| DEFAULTS.has_key?(k) })
+      undotify_keys(hash.select { |k, v| DEFAULTS.has_key?(k) })
     end
-    alias to_h to_hash
+    alias_method :to_h, :to_hash
 
     # Internal Helpers
 
-
     def logger
       init_logging! unless @logger
       @logger
@@ -166,7 +164,7 @@ module Honeybadger
     end
 
     def warn_development?
-      dev? && backend.kind_of?(Backend::Null)
+      dev? && backend.is_a?(Backend::Null)
     end
 
     def public?
@@ -180,30 +178,30 @@ module Honeybadger
     end
 
     def log_debug?
-      return debug? if self[:'logging.debug'].nil?
-      !!self[:'logging.debug']
+      return debug? if self[:"logging.debug"].nil?
+      !!self[:"logging.debug"]
     end
 
     def ignored_classes
-      ignore_only = get(:'exceptions.ignore_only')
+      ignore_only = get(:"exceptions.ignore_only")
       return ignore_only if ignore_only
-      return DEFAULTS[:'exceptions.ignore'] unless ignore = get(:'exceptions.ignore')
+      return DEFAULTS[:"exceptions.ignore"] unless (ignore = get(:"exceptions.ignore"))
 
-      DEFAULTS[:'exceptions.ignore'] | Array(ignore)
+      DEFAULTS[:"exceptions.ignore"] | Array(ignore)
     end
 
     def raw_ignored_events
-      ignore_only = get(:'events.ignore_only')
+      ignore_only = get(:"events.ignore_only")
       return ignore_only if ignore_only
-      return DEFAULTS[:'events.ignore'] unless ignore = get(:'events.ignore')
+      return DEFAULTS[:"events.ignore"] unless (ignore = get(:"events.ignore"))
 
-      DEFAULTS[:'events.ignore'] | Array(ignore)
+      DEFAULTS[:"events.ignore"] | Array(ignore)
     end
 
     def ignored_events
       @ignored_events ||= raw_ignored_events.map do |check|
         if check.is_a?(String) || check.is_a?(Regexp)
-          { [:event_type] => check }
+          {[:event_type] => check}
         elsif check.is_a?(Hash)
           flat_hash(check).transform_keys! { |key_array| key_array.map(&:to_sym) }
         end
@@ -211,23 +209,23 @@ module Honeybadger
     end
 
     def ca_bundle_path
-      if self[:'connection.system_ssl_cert_chain'] && File.exist?(OpenSSL::X509::DEFAULT_CERT_FILE)
+      if self[:"connection.system_ssl_cert_chain"] && File.exist?(OpenSSL::X509::DEFAULT_CERT_FILE)
         OpenSSL::X509::DEFAULT_CERT_FILE
-      elsif self[:'connection.ssl_ca_bundle_path']
-        self[:'connection.ssl_ca_bundle_path']
+      elsif self[:"connection.ssl_ca_bundle_path"]
+        self[:"connection.ssl_ca_bundle_path"]
       else
         local_cert_path
       end
     end
 
     def local_cert_path
-      File.expand_path(File.join('..', '..', '..', 'resources', 'ca-bundle.crt'), __FILE__)
+      File.expand_path(File.join("..", "..", "..", "resources", "ca-bundle.crt"), __FILE__)
     end
 
     def connection_port
-      if self[:'connection.port']
-        self[:'connection.port']
-      elsif self[:'connection.secure']
+      if self[:"connection.port"]
+        self[:"connection.port"]
+      elsif self[:"connection.secure"]
         443
       else
         80
@@ -235,10 +233,10 @@ module Honeybadger
     end
 
     def connection_protocol
-      if self[:'connection.secure']
-        'https'
+      if self[:"connection.secure"]
+        "https"
       else
-        'http'
+        "http"
       end
     end
 
@@ -247,35 +245,35 @@ module Honeybadger
     end
 
     def events_max_queue_size
-      self[:'events.max_queue_size']
+      self[:"events.max_queue_size"]
     end
 
     def events_batch_size
-      self[:'events.batch_size']
+      self[:"events.batch_size"]
     end
 
     def events_timeout
-      self[:'events.timeout']
+      self[:"events.timeout"]
     end
 
     def params_filters
-      Array(self[:'request.filter_keys'])
+      Array(self[:"request.filter_keys"])
     end
 
     def excluded_request_keys
       [].tap do |keys|
-        keys << :session  if self[:'request.disable_session']
-        keys << :params   if self[:'request.disable_params']
-        keys << :cgi_data if self[:'request.disable_environment']
-        keys << :url      if self[:'request.disable_url']
+        keys << :session if self[:"request.disable_session"]
+        keys << :params if self[:"request.disable_params"]
+        keys << :cgi_data if self[:"request.disable_environment"]
+        keys << :url if self[:"request.disable_url"]
       end
     end
 
-    def log_level(key = :'logging.level')
+    def log_level(key = :"logging.level")
       case self[key].to_s
       when /\A(0|debug)\z/i then Logger::DEBUG
-      when /\A(1|info)\z/i  then Logger::INFO
-      when /\A(2|warn)\z/i  then Logger::WARN
+      when /\A(1|info)\z/i then Logger::INFO
+      when /\A(2|warn)\z/i then Logger::WARN
       when /\A(3|error)\z/i then Logger::ERROR
       else
         Logger::INFO
@@ -283,13 +281,13 @@ module Honeybadger
     end
 
     def load_plugin?(name)
-      return false if includes_token?(self[:'skipped_plugins'], name)
-      return true unless self[:plugins].kind_of?(Array)
+      return false if includes_token?(self[:skipped_plugins], name)
+      return true unless self[:plugins].is_a?(Array)
       includes_token?(self[:plugins], name)
     end
 
     def insights_enabled?
-      public? && !!self[:'insights.enabled']
+      public? && !!self[:"insights.enabled"]
     end
 
     def cluster_collection?(name)
@@ -328,19 +326,19 @@ module Honeybadger
       return nil if @no_root
 
       root = get(:root).to_s
-      @no_root = true and return nil unless root =~ NOT_BLANK
+      @no_root = true and return nil unless NOT_BLANK.match?(root)
 
-      @root_regexp = Regexp.new("^#{ Regexp.escape(root) }")
+      @root_regexp = Regexp.new("^#{Regexp.escape(root)}")
     end
 
     def detected_framework
-      if self[:framework] =~ NOT_BLANK
+      if NOT_BLANK.match?(self[:framework])
         self[:framework].to_sym
-      elsif defined?(::Rails::VERSION) && ::Rails::VERSION::STRING > '3.0'
+      elsif defined?(::Rails::VERSION) && ::Rails::VERSION::STRING > "3.0"
         :rails
       elsif defined?(::Sinatra::VERSION)
         :sinatra
-      elsif defined?(::Hanami::VERSION) && ::Hanami::VERSION >= '2.0'
+      elsif defined?(::Hanami::VERSION) && ::Hanami::VERSION >= "2.0"
         :hanami
       elsif defined?(::Rack.release)
         :rack
@@ -369,8 +367,8 @@ module Honeybadger
 
     def log_path
       return if log_stdout?
-      return if !self[:'logging.path']
-      locate_absolute_path(self[:'logging.path'], self[:root])
+      return if !self[:"logging.path"]
+      locate_absolute_path(self[:"logging.path"], self[:root])
     end
 
     def config_path
@@ -378,7 +376,7 @@ module Honeybadger
     end
 
     def config_paths
-      Array(ENV['HONEYBADGER_CONFIG_PATH'] || get(:'config.path')).map do |c|
+      Array(ENV["HONEYBADGER_CONFIG_PATH"] || get(:"config.path")).map do |c|
         locate_absolute_path(c, self[:root])
       end
     end
@@ -400,7 +398,7 @@ module Honeybadger
       end
 
       if ruby[:backend]
-        logger.warn(sprintf('Unknown backend: %p; default will be used. Backend must respond to #notify', self[:backend]))
+        logger.warn(sprintf("Unknown backend: %p; default will be used. Backend must respond to #notify", self[:backend]))
       end
 
       @backend = default_backend
@@ -423,7 +421,7 @@ module Honeybadger
     end
 
     def log_stdout?
-      self[:'logging.path'] && self[:'logging.path'].to_s.downcase == 'stdout'
+      self[:"logging.path"] && self[:"logging.path"].to_s.downcase == "stdout"
     end
 
     def build_logger
@@ -431,7 +429,7 @@ module Honeybadger
 
       return build_stdout_logger if log_stdout?
 
-      if path = log_path
+      if (path = log_path)
         FileUtils.mkdir_p(path.dirname) unless path.dirname.writable?
         return build_file_logger(path)
       end
@@ -448,7 +446,7 @@ module Honeybadger
     # Takes an Array and a value and returns true if the value exists in the
     # array in String or Symbol form, otherwise false.
     def includes_token?(obj, value)
-      return false unless obj.kind_of?(Array)
+      return false unless obj.is_a?(Array)
       obj.map(&:to_sym).include?(value.to_sym)
     end
 
@@ -471,7 +469,7 @@ module Honeybadger
 
     def undotify_keys(hash)
       {}.tap do |new_hash|
-        hash.each_pair do |k,v|
+        hash.each_pair do |k, v|
           if k.to_s =~ DOTTED_KEY
             new_hash[$1] ||= {}
             new_hash[$1] = undotify_keys(new_hash[$1].merge({$2 => v}))
@@ -485,9 +483,9 @@ module Honeybadger
     # Converts a nested hash into a single layer where keys become arrays:
     # ex: > flat_hash({ :nested => { :hash => "value" }})
     #     > { [:nested, :hash] => "value" }
-    def flat_hash(h,f=[],g={})
-      return g.update({ f=>h }) unless h.is_a? Hash
-      h.each { |k,r| flat_hash(r,f+[k],g) }
+    def flat_hash(h, f = [], g = {})
+      return g.update({f => h}) unless h.is_a? Hash
+      h.each { |k, r| flat_hash(r, f + [k], g) }
       g
     end
   end

data/lib/honeybadger/const.rb

@@ -1,13 +1,13 @@
-require 'honeybadger/version'
+require "honeybadger/version"
 
 module Honeybadger
   module Rack
     # Autoloading allows middleware classes to be referenced in applications
     # which include the optional Rack dependency without explicitly requiring
     # these files.
-    autoload :ErrorNotifier, 'honeybadger/rack/error_notifier'
-    autoload :UserFeedback, 'honeybadger/rack/user_feedback'
-    autoload :UserInformer, 'honeybadger/rack/user_informer'
+    autoload :ErrorNotifier, "honeybadger/rack/error_notifier"
+    autoload :UserFeedback, "honeybadger/rack/user_feedback"
+    autoload :UserInformer, "honeybadger/rack/user_informer"
   end
 
   # @api private

data/lib/honeybadger/context_manager.rb

@@ -1,4 +1,4 @@
-require 'honeybadger/conversions'
+require "honeybadger/conversions"
 
 module Honeybadger
   # @api private
@@ -20,7 +20,6 @@ module Honeybadger
 
     # Internal helpers
 
-
     def set_context(hash, &block)
       local = block_given?
       @mutex.synchronize do

data/lib/honeybadger/conversions.rb

@@ -2,6 +2,7 @@ module Honeybadger
   # @api private
   module Conversions
     module_function
+
     MAX_CONTEXT_DEPTH = 5
 
     # Convert context into a Hash.
@@ -12,13 +13,15 @@ module Honeybadger
     def Context(object, depth = 1)
       object = object.to_honeybadger_context if object.respond_to?(:to_honeybadger_context)
       object = Hash(object)
-      object = object.transform_values do |value|
-        if value&.respond_to?(:to_honeybadger_context)
-          Context(value, depth + 1)
-        else
-          value
+      if depth < MAX_CONTEXT_DEPTH
+        object = object.transform_values do |value|
+          if value&.respond_to?(:to_honeybadger_context)
+            Context(value, depth + 1)
+          else
+            value
+          end
         end
-      end if depth < MAX_CONTEXT_DEPTH
+      end
       object
     end
   end

data/lib/honeybadger/counter.rb

@@ -1,18 +1,18 @@
-require 'honeybadger/metric'
+require "honeybadger/metric"
 
 module Honeybadger
   class Counter < Metric
-    def count(by=1)
+    def count(by = 1)
       return unless by
 
       @samples += 1
 
       @counter ||= 0
-      @counter = @counter + by
+      @counter += by
     end
 
     def payloads
-      [{ counter: @counter }]
+      [{counter: @counter}]
     end
   end
 end