airbrake-ruby 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ee928135214a657c40a9aad39b8c740cf1d7566
-  data.tar.gz: 229d0efea5f76e1f81388f1faacc2b135ccdc17b
+  metadata.gz: ef793e3a5a123860495003999ff322f5272a0eb1
+  data.tar.gz: 8d7e363516e3db624ca4944b4857e1e53038faa5
 SHA512:
-  metadata.gz: 9d645597be22ee917a00fdf16ffa1e0c0fd86718a980c6c4dc3db9fa2aa34889dee0a87b49da33a8a8adf330717e3a54e37108aea4131480ec7b4a688f5d40a1
-  data.tar.gz: 4e18aa4274666b7bf0f106988aed1641f8891ed2dcd9ac5892b76efff6cc0c36d1c531ad195f81274b451fc2e8d88333b072500ba4470d3cbcaed4c272825e3a
+  metadata.gz: f33dab2de0022cd34ee28b3d08746e5136f577af9148fcbbdfb5cf08dbde0f6224e122e8a371b6b145d131fe39d5bcd5fb99bc7a98cdbaef59d5b131c27f2666
+  data.tar.gz: 8119742353a0f1596cff32c453f100d4c3af846bde52183875fc00dadee96ae93d648dce2480d1ae7b6752ca78a92d62e441dbeb4082ced542cc32d2c795943c

data/lib/airbrake-ruby.rb

@@ -97,6 +97,9 @@ module Airbrake
     # @macro see_public_api_method
     def add_filter(_filter = nil, &_block); end
 
+    # @macro see_public_api_method
+    def delete_filter(_filter_class); end
+
     # @macro see_public_api_method
     def build_notice(_exception, _params = {}); end
 
@@ -115,7 +118,7 @@ module Airbrake
     def merge_context(_context); end
 
     # @macro see_public_api_method
-    def notify_request(request_info); end
+    def notify_request(_request_info); end
   end
 
   # A Hash that holds all notifiers. The keys of the Hash are notifier
@@ -247,11 +250,27 @@ module Airbrake
     # @yieldparam [Airbrake::Notice]
     # @yieldreturn [void]
     # @return [void]
-    # @note Once a filter was added, there's no way to delete it
     def add_filter(filter = nil, &block)
       @notifiers[:default].add_filter(filter, &block)
     end
 
+    # Deletes a filter added via {Airbrake#add_filter}.
+    #
+    # @example
+    #   # Add a MyFilter filter (we pass an instance here).
+    #   Airbrake.add_filter(MyFilter.new)
+    #
+    #   # Delete the filter (we pass class name here).
+    #   Airbrake.delete_filter(MyFilter)
+    #
+    # @param [Class] filter_class The class of the filter you want to delete
+    # @return [void]
+    # @since v3.1.0
+    # @note This method cannot delete filters assigned via the Proc form.
+    def delete_filter(filter_class)
+      @notifiers[:default].delete_filter(filter_class)
+    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}.

data/lib/airbrake-ruby/filter_chain.rb

@@ -36,6 +36,16 @@ module Airbrake
       end.reverse!
     end
 
+    # Deletes a filter from the the filter chain.
+    #
+    # @param [Class] filter_class The class of the filter you want to delete
+    # @return [void]
+    # @since v3.1.0
+    def delete_filter(filter_class)
+      index = @filters.index { |f| f.class.name == filter_class.name }
+      @filters.delete_at(index) if index
+    end
+
     # Applies all the filters in the filter chain to the given notice. Does not
     # filter ignored notices.
     #

data/lib/airbrake-ruby/notifier.rb

@@ -5,6 +5,7 @@ module Airbrake
   # @see Airbrake::Config The list of options
   # @since v1.0.0
   # @api private
+  # rubocop:disable Metrics/ClassLength
   class Notifier
     # @return [String] the label to be prepended to the log output
     LOG_LABEL = '**Airbrake:'.freeze
@@ -57,6 +58,11 @@ module Airbrake
       @filter_chain.add_filter(block_given? ? block : filter)
     end
 
+    # @macro see_public_api_method
+    def delete_filter(filter_class)
+      @filter_chain.delete_filter(filter_class)
+    end
+
     # @macro see_public_api_method
     def build_notice(exception, params = {})
       if @async_sender.closed?
@@ -188,4 +194,5 @@ module Airbrake
       clean_bt
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/airbrake-ruby/version.rb

@@ -2,5 +2,5 @@
 # More information: http://semver.org/
 module Airbrake
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '3.0.0'.freeze
+  AIRBRAKE_RUBY_VERSION = '3.1.0'.freeze
 end

data/spec/filter_chain_spec.rb

@@ -47,4 +47,43 @@ RSpec.describe Airbrake::FilterChain do
       subject.refine(notice)
     end
   end
+
+  describe "#delete_filter" do
+    let(:filter) do
+      Class.new do
+        class << self
+          def name
+            'FooFilter'
+          end
+        end
+
+        def initialize(foo)
+          @foo = foo
+        end
+
+        def call(notice)
+          notice[:params][:foo] << @foo
+        end
+      end
+    end
+
+    it "deletes a class filter" do
+      notice[:params][:foo] = []
+
+      f1 = filter.new(1)
+      subject.add_filter(f1)
+
+      foo_filter_mock = double
+      expect(foo_filter_mock).to(
+        receive(:name).at_least(:once).and_return('FooFilter')
+      )
+      subject.delete_filter(foo_filter_mock)
+
+      f2 = filter.new(2)
+      subject.add_filter(f2)
+
+      subject.refine(notice)
+      expect(notice[:params][:foo]).to eq([2])
+    end
+  end
 end

data/spec/notifier_spec/options_spec.rb

@@ -141,6 +141,12 @@ RSpec.describe Airbrake::Notifier do
       after { proxy.stop }
 
       it "is being used if configured" do
+        if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.6.0")
+          skip(
+            "We use Webmock 2, which doesn't support Ruby 2.6+. It's " \
+            "safe to run this test on 2.6+ once we upgrade to Webmock 3.5+"
+          )
+        end
         @airbrake.notify_sync(ex)
 
         proxied_request = requests.pop(true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
+date: 2019-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tdigest