airbrake-ruby 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a9ac80f76081013e1f710824cbe72291d26bda5
-  data.tar.gz: a665035c27cdbbdea9cb7bef43b43931be5266f9
+  metadata.gz: 706d644022c1c9c99dc3e01584d0e405411d2159
+  data.tar.gz: 56b17f05ad9e78e0579e20a58dfbeef86e35ec54
 SHA512:
-  metadata.gz: bc673d309a343d6b15d533e1feb4e202fcc1bb3ca31f2ef79e9af257fedd831614874c0efcfd32b88155a28448cd04affa4117567843972f594fe7a4dda77a80
-  data.tar.gz: 9e92da2e216c266de65d35c309eed96791eadd6f7e89aca0ebd9e643e49630970b0c41e7da94f15e31cafd65c7f6131668b1a7b41174a44caad94a15eaf665a9
+  metadata.gz: 8ee8b4959b41efcc3687f16a5d6ec145644bb8b28b5e3b9fd18dbb9eb729a712708cf082b0afdd0f1ccf12b150974dda5563a535b1a3229e1d8e0ecbd7df7f8b
+  data.tar.gz: dbfbf97c9f39401e42d2cd00438616432e1acf9d87a07742c0aa7b405691debd2289b955779fa76dd5dd86f5656043538e25791af06c040100f07672d5399ad8

data/lib/airbrake-ruby.rb

@@ -24,12 +24,13 @@ require 'airbrake-ruby/filters/system_exit_filter'
 require 'airbrake-ruby/filters/root_directory_filter'
 require 'airbrake-ruby/filters/thread_filter'
 require 'airbrake-ruby/filters/context_filter'
+require 'airbrake-ruby/filters/exception_attributes_filter'
+require 'airbrake-ruby/filters/dependency_filter'
 require 'airbrake-ruby/filter_chain'
 require 'airbrake-ruby/notifier'
 require 'airbrake-ruby/code_hunk'
 require 'airbrake-ruby/file_cache'
 
-##
 # This module defines the Airbrake API. The user is meant to interact with
 # Airbrake via its public class methods. Before using the library, you must to
 # {configure} the default notifier.
@@ -64,44 +65,73 @@ require 'airbrake-ruby/file_cache'
 # @see Airbrake::Notifier
 # @since v1.0.0
 module Airbrake
-  ##
   # The general error that this library uses when it wants to raise.
   Error = Class.new(StandardError)
 
-  ##
   # @return [String] the label to be prepended to the log output
   LOG_LABEL = '**Airbrake:'.freeze
 
-  ##
   # @return [Boolean] true if current Ruby is Ruby 2.0.*. The result is used
   #   for special cases where we need to work around older implementations
   RUBY_20 = RUBY_VERSION.start_with?('2.0')
 
-  ##
   # @return [Boolean] true if current Ruby is JRuby. The result is used for
   #  special cases where we need to work around older implementations
   JRUBY = (RUBY_ENGINE == 'jruby')
 
-  ##
+  # @!macro see_public_api_method
+  #   @see Airbrake.$0
+
+  # NilNotifier is a no-op notifier, which mimics +Airbrake::Notifier+ and
+  # serves only for the purpose of making the library API easier to use.
+  #
+  # @since 2.1.0
+  class NilNotifier
+    # @macro see_public_api_method
+    def notify(_exception, _params = {}, &block); end
+
+    # @macro see_public_api_method
+    def notify_sync(_exception, _params = {}, &block); end
+
+    # @macro see_public_api_method
+    def add_filter(_filter = nil, &_block); end
+
+    # @macro see_public_api_method
+    def build_notice(_exception, _params = {}); end
+
+    # @macro see_public_api_method
+    def close; end
+
+    # @macro see_public_api_method
+    def create_deploy(_deploy_params); end
+
+    # @macro see_public_api_method
+    def configured?
+      false
+    end
+
+    # @macro see_public_api_method
+    def merge_context(_context); end
+  end
+
   # A Hash that holds all notifiers. The keys of the Hash are notifier
   # names, the values are Airbrake::Notifier instances. If a notifier is not
   # assigned to the hash, then it returns a null object (NilNotifier).
   @notifiers = Hash.new(NilNotifier.new)
 
   class << self
-    ##
     # Retrieves configured notifiers.
     #
     # @example
     #   Airbrake[:my_notifier].notify('oops')
     #
-    # @return [Airbrake::Notifier, nil]
+    # @param [Symbol] notifier_name the name of the notifier you want to use
+    # @return [Airbrake::Notifier, NilClass]
     # @since v1.8.0
     def [](notifier_name)
       @notifiers[notifier_name]
     end
 
-    ##
     # Configures a new +notifier+ with the given name. If the name is not given,
     # configures the default notifier.
     #
@@ -138,14 +168,12 @@ module Airbrake
       end
     end
 
-    ##
     # @return [Boolean] true if the notifier was configured, false otherwise
     # @since 2.3.0
     def configured?
       @notifiers[:default].configured?
     end
 
-    ##
     # Sends an exception to Airbrake asynchronously.
     #
     # @example Sending an exception
@@ -171,7 +199,6 @@ module Airbrake
       @notifiers[:default].notify(exception, params, &block)
     end
 
-    ##
     # Sends an exception to Airbrake synchronously.
     #
     # @example
@@ -192,7 +219,6 @@ module Airbrake
       @notifiers[:default].notify_sync(exception, params, &block)
     end
 
-    ##
     # Runs a callback before {.notify} or {.notify_sync} kicks in. This is
     # useful if you want to ignore specific notices or filter the data the
     # notice contains.
@@ -222,7 +248,6 @@ module Airbrake
       @notifiers[:default].add_filter(filter, &block)
     end
 
-    ##
     # Builds an Airbrake notice. This is useful, if you want to add or modify a
     # value only for a specific notice. When you're done modifying the notice,
     # send it with {.notify} or {.notify_sync}.
@@ -241,7 +266,6 @@ module Airbrake
       @notifiers[:default].build_notice(exception, params)
     end
 
-    ##
     # Makes the notifier a no-op, which means you cannot use the {.notify} and
     # {.notify_sync} methods anymore. It also stops the notifier's worker
     # threads.
@@ -255,7 +279,6 @@ module Airbrake
       @notifiers[:default].close
     end
 
-    ##
     # Pings the Airbrake Deploy API endpoint about the occurred deploy. This
     # method is used by the airbrake gem for various integrations.
     #
@@ -270,7 +293,6 @@ module Airbrake
       @notifiers[:default].create_deploy(deploy_params)
     end
 
-    ##
     # Merges +context+ with the current context.
     #
     # The context will be attached to the notice object upon a notify call and
@@ -287,7 +309,7 @@ module Airbrake
     #       Airbrake.notify('fruitception')
     #     end
     #
-    #     def load_veggies
+    #     def load_veggies(veggies)
     #       Airbrake.merge_context(veggies: veggies)
     #     end
     #

data/lib/airbrake-ruby/async_sender.rb

@@ -1,5 +1,4 @@
 module Airbrake
-  ##
   # Responsible for sending notices to Airbrake asynchronously. The class
   # supports an unlimited number of worker threads and an unlimited queue size
   # (both values are configurable).
@@ -8,7 +7,6 @@ module Airbrake
   # @api private
   # @since v1.0.0
   class AsyncSender
-    ##
     # @param [Airbrake::Config] config
     def initialize(config)
       @config = config
@@ -20,7 +18,6 @@ module Airbrake
       @pid = nil
     end
 
-    ##
     # Asynchronously sends a notice to Airbrake.
     #
     # @param [Airbrake::Notice] notice A notice that was generated by the
@@ -33,7 +30,6 @@ module Airbrake
       promise
     end
 
-    ##
     # Closes the instance making it a no-op (it shut downs all worker
     # threads). Before closing, waits on all unsent notices to be sent.
     #
@@ -57,14 +53,12 @@ module Airbrake
       @config.logger.debug("#{LOG_LABEL} closed")
     end
 
-    ##
     # Checks whether the sender is closed and thus usable.
     # @return [Boolean]
     def closed?
       @closed
     end
 
-    ##
     # Checks if an active sender has any workers. A sender doesn't have any
     # workers only in two cases: when it was closed or when all workers
     # crashed. An *active* sender doesn't have any workers only when something

data/lib/airbrake-ruby/backtrace.rb

@@ -1,5 +1,4 @@
 module Airbrake
-  ##
   # Represents a cross-Ruby backtrace from exceptions (including JRuby Java
   # exceptions). Provides information about stack frames (such as line number,
   # file and method) in convenient for Airbrake format.
@@ -15,7 +14,6 @@ module Airbrake
   # @since v1.0.0
   module Backtrace
     module Patterns
-      ##
       # @return [Regexp] the pattern that matches standard Ruby stack frames,
       #   such as ./spec/notice_spec.rb:43:in `block (3 levels) in <top (required)>'
       RUBY = %r{\A
@@ -26,7 +24,6 @@ module Airbrake
         `(?<function>.*)' # Matches "`block (3 levels) in <top (required)>'"
       \z}x
 
-      ##
       # @return [Regexp] the pattern that matches JRuby Java stack frames, such
       #  as org.jruby.ast.NewlineNode.interpret(NewlineNode.java:105)
       JAVA = %r{\A
@@ -44,7 +41,6 @@ module Airbrake
         \)
       \z}x
 
-      ##
       # @return [Regexp] the pattern that tries to assume what a generic stack
       #   frame might look like, when exception's backtrace is set manually.
       GENERIC = %r{\A
@@ -59,7 +55,6 @@ module Airbrake
         )?                       # ... or nothing
       \z}x
 
-      ##
       # @return [Regexp] the pattern that matches exceptions from PL/SQL such as
       #   ORA-06512: at "STORE.LI_LICENSES_PACK", line 1945
       # @note This is raised by https://github.com/kubo/ruby-oci8
@@ -74,7 +69,6 @@ module Airbrake
         )
       \z/x
 
-      ##
       # @return [Regexp] the pattern that matches CoffeeScript backtraces
       #   usually coming from Rails & ExecJS
       EXECJS = /\A
@@ -90,17 +84,14 @@ module Airbrake
         )
       \z/x
 
-      ##
       # @return [Regexp] +EXECJS+ pattern without named captures and
       #   uncommon frames
       EXECJS_SIMPLIFIED = /\A.+ \(.+:\d+:\d+\)\z/
     end
 
-    ##
     # @return [Integer] how many first frames should include code hunks
     CODE_FRAME_LIMIT = 10
 
-    ##
     # Parses an exception's backtrace.
     #
     # @param [Exception] exception The exception, which contains a backtrace to
@@ -111,7 +102,6 @@ module Airbrake
       parse_backtrace(config, exception)
     end
 
-    ##
     # Checks whether the given exception was generated by JRuby's VM.
     #
     # @param [Exception] exception

data/lib/airbrake-ruby/code_hunk.rb

@@ -1,14 +1,11 @@
 module Airbrake
-  ##
   # Represents a small hunk of code consisting of a base line and a couple lines
   # around it
   # @api private
   class CodeHunk
-    ##
     # @return [Integer] the maximum length of a line
     MAX_LINE_LEN = 200
 
-    ##
     # @return [Integer] how many lines should be read around the base line
     NLINES = 2
 
@@ -16,7 +13,6 @@ module Airbrake
       @config = config
     end
 
-    ##
     # @param [String] file The file to read
     # @param [Integer] line The base line in the file
     # @return [Hash{Integer=>String}, nil] lines of code around the base line

data/lib/airbrake-ruby/config.rb

@@ -1,84 +1,88 @@
 module Airbrake
-  ##
   # Represents the Airbrake config. A config contains all the options that you
   # can use to configure an Airbrake instance.
   #
   # @api private
   # @since v1.0.0
   class Config
-    ##
     # @return [Integer] the project identificator. This value *must* be set.
+    # @api public
     attr_accessor :project_id
 
-    ##
     # @return [String] the project key. This value *must* be set.
+    # @api public
     attr_accessor :project_key
 
-    ##
     # @return [Hash] the proxy parameters such as (:host, :port, :user and
     #   :password)
+    # @api public
     attr_accessor :proxy
 
-    ##
     # @return [Logger] the default logger used for debug output
+    # @api public
     attr_reader :logger
 
-    ##
     # @return [String] the version of the user's application
+    # @api public
     attr_accessor :app_version
 
-    ##
+    # @return [Hash{String=>String}] arbitrary versions that your app wants to
+    #   track
+    # @api public
+    # @since v2.10.0
+    attr_accessor :versions
+
     # @return [Integer] the max number of notices that can be queued up
+    # @api public
     attr_accessor :queue_size
 
-    ##
     # @return [Integer] the number of worker threads that process the notice
     #   queue
+    # @api public
     attr_accessor :workers
 
-    ##
     # @return [String] the host, which provides the API endpoint to which
     #   exceptions should be sent
+    # @api public
     attr_accessor :host
 
-    ##
     # @return [String, Pathname] the working directory of your project
+    # @api public
     attr_accessor :root_directory
 
-    ##
     # @return [String, Symbol] the environment the application is running in
+    # @api public
     attr_accessor :environment
 
-    ##
     # @return [Array<String,Symbol,Regexp>] the array of environments that
     #   forbids sending exceptions when the application is running in them.
     #   Other possible environments not listed in the array will allow sending
     #   occurring exceptions.
+    # @api public
     attr_accessor :ignore_environments
 
-    ##
     # @return [Integer] The HTTP timeout in seconds.
+    # @api public
     attr_accessor :timeout
 
-    ##
     # @return [Array<String, Symbol, Regexp>] the keys, which should be
     #   filtered
+    # @api public
     # @since 1.2.0
     attr_accessor :blacklist_keys
 
-    ##
     # @return [Array<String, Symbol, Regexp>] the keys, which shouldn't be
     #   filtered
+    # @api public
     # @since 1.2.0
     attr_accessor :whitelist_keys
 
-    ##
     # @return [Boolean] true if the library should attach code hunks to each
     #   frame in a backtrace, false otherwise
+    # @api public
     # @since v2.5.0
     attr_accessor :code_hunks
 
-    ##
     # @param [Hash{Symbol=>Object}] user_config the hash to be used to build the
     #   config
     def initialize(user_config = {})
@@ -108,10 +112,11 @@ module Airbrake
         Dir.pwd
       )
 
+      self.versions = {}
+
       merge(user_config)
     end
 
-    ##
     # The full URL to the Airbrake Notice API. Based on the +:host+ option.
     # @return [URI] the endpoint address
     def endpoint
@@ -123,14 +128,12 @@ module Airbrake
         end
     end
 
-    ##
     # Sets the logger. Never allows to assign `nil` as the logger.
     # @return [Logger] the logger
     def logger=(logger)
       @logger = logger || @logger
     end
 
-    ##
     # Merges the given +config_hash+ with itself.
     #
     # @example
@@ -142,7 +145,6 @@ module Airbrake
       self
     end
 
-    ##
     # @return [Boolean] true if the config meets the requirements, false
     #   otherwise
     def valid?
@@ -159,7 +161,6 @@ module Airbrake
       @validator.error_message
     end
 
-    ##
     # @return [Boolean] true if the config ignores current environment, false
     #   otherwise
     def ignored_environment?