exception_notification-rake 0.1.1 → 0.1.2

data/README.md

@@ -9,7 +9,7 @@ This Ruby gem is an extension of the [exception_notification gem](http://rubygem
 
 If you're using Rails 4 (or you're not using Rails at all), use the latest version of the gem:
 
-    gem 'exception_notification-rake', '~> 0.1.1'
+    gem 'exception_notification-rake', '~> 0.1.2'
 
 If you're using Rails 3, use the 0.0.x line of versions:
 
@@ -30,7 +30,7 @@ Exception notification must be set up in your Rails config files. In general, yo
       # Other configuration here, including ActionMailer config ...
 
       config.middleware.use ExceptionNotification::Rack,
-        :ignore_if => lambda { true },
+	    :ignore_if => lambda { |env, exception| !env[:rake?] }
         :email => {
           :sender_address => %{"notifier" <sender.address@example.com>},
           :exception_recipients => %w{your.email@example.com}
@@ -39,7 +39,7 @@ Exception notification must be set up in your Rails config files. In general, yo
       ExceptionNotifier::Rake.configure
     end
 
-**Note:** This uses `:ignore_if` to suppress all exception notifications triggered by the Rails server itself (as opposed to Rake). If you want those notifications as well, omit the `:ignore_if` option.
+**Note:** This uses `:ignore_if` to suppress all exception notifications not triggered by Rake (identified by the `:rake?` property set in the environment of all Rake failures). If you want to see all notifications (i.e., also those triggered by requests to the Rails server), omit the `:ignore_if` option.
 
 If you are already using `ExceptionNotifier` anyway, you don't need to configure it again and all you need is:
 
@@ -69,6 +69,8 @@ If you are already using `ExceptionNotifier` anyway, you don't need to configure
 	  ExceptionNotifier::Rake.configure
 	end
 
+For complete documentation on the Rails 3.2 version see the [corresponding branch on GitHub](https://github.com/nikhaldi/exception_notification-rake/tree/rails3.2).
+
 
 ### Notification Example
 
@@ -138,7 +140,7 @@ The most likely options you'll want to use are `:email_prefix` and `:exception_r
 
 This will prefix the email subjects of Rake failure notifications with `[Rake Failure]` and will send them to the two given email addresses. Note that if you set the same options when you configure `ExceptionNotifier` mail notifier itself, they will be overridden but for Rake failures only.
 
-`:ignore_if` and `:ignore_exceptions` are also supported.
+`:ignore_if` and `:ignore_exceptions` are also supported. But note that the `:ignore_if` block will be evaluated for all exceptions, not just the ones triggered by Rake (this is unavoidable because of the design of exception_notification). The first argument to the block passed to `:ignore_if` is the environment - for all Rake failures this will be a dictionary with a single `:rake?` key (i.e., `{:rake? => true}`) so that you can distinguish them.
 
 If you want to configure sections, which is unlikely, note that by default the sections `['rake', 'backtrace']` are used (where `rake` is a custom section introduced by this gem).
 

data/lib/exception_notifier/rake/rake.rb

@@ -19,6 +19,16 @@ module ExceptionNotifier
       @notifier_options.merge!(default_notifier_options)
       @notifier_options.merge!(options)
 
+      # There is only a single static list registered ignore_ifs. We make
+      # ignore_ifs passed to just this configuration only effective for exceptions
+      # actually raised through Rake, identified by the :rake? variable in the
+      # environment.
+      if options[:ignore_if]
+        ExceptionNotifier.ignore_if do |exception, passed_options|
+          passed_options[:env][:rake?] && options[:ignore_if].call(passed_options[:env], exception)
+        end
+      end
+
       # Append view path for this gem, assuming that the client is using
       # ActionMailer::Base. This isn't ideal but there doesn't seem to be
       # a different way to extend the path.
@@ -29,6 +39,7 @@ module ExceptionNotifier
     def self.default_notifier_options
       {
         :background_sections => %w(rake backtrace),
+        :env => {:rake? => true},
       }
     end
 
@@ -53,6 +64,7 @@ module ExceptionNotifier
 
     def self.reset_for_test
       @notifier_options = {}
+      ExceptionNotifier.clear_ignore_conditions!
     end
   end
 end

data/lib/exception_notifier/rake/version.rb

@@ -1,5 +1,5 @@
 module ExceptionNotifier
   class Rake
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/test/rake_test.rb

@@ -6,16 +6,32 @@ require 'exception_notifier/rake'
 
 class RakeTest < Test::Unit::TestCase
 
+  class Notifier
+    attr_accessor :exception, :options
+    def call(exception, options)
+      @exception = exception
+      @options = options
+    end
+  end
+
   class IgnoredException < Exception
   end
 
   def setup
     ExceptionNotifier::Rake.reset_for_test
     assert !ExceptionNotifier::Rake.configured?
+    @notifier = Notifier.new
+    ExceptionNotifier.add_notifier 'test_notifier', @notifier
   end
 
-  def expect_delivery(exception, options)
-    ExceptionNotifier.expects(:notify_exception).with(exception, options)
+  def assert_not_notified
+    assert_nil @notifier.exception
+    assert_nil @notifier.options
+  end
+
+  def assert_notified(exception, options)
+    assert_equal exception, @notifier.exception
+    assert_equal options, @notifier.options
   end
 
   def test_configure_only_default_options
@@ -38,13 +54,14 @@ class RakeTest < Test::Unit::TestCase
 
   def test_maybe_deliver_notifications_without_configuration
     ExceptionNotifier::Rake.maybe_deliver_notification(Exception.new)
+    assert_not_notified
   end
 
   def test_maybe_deliver_notifications_with_config
     ExceptionNotifier::Rake.configure
     ex = Exception.new
-    expect_delivery(ex, ExceptionNotifier::Rake.notifier_options)
     ExceptionNotifier::Rake.maybe_deliver_notification(ex)
+    assert_notified ex, ExceptionNotifier::Rake.notifier_options
   end
 
   def test_maybe_deliver_notifications_with_data
@@ -53,23 +70,34 @@ class RakeTest < Test::Unit::TestCase
     options = ExceptionNotifier::Rake.notifier_options
     original_options = options.dup
     ex = Exception.new
-    expect_delivery(ex, options.merge({:data => data}))
     ExceptionNotifier::Rake.maybe_deliver_notification(ex, data)
-    assert_equal(original_options, options)
+    assert_notified ex, options.merge({:data => data})
+    assert_equal original_options, options
   end
 
   def test_maybe_deliver_notifications_with_ignore_if
     ExceptionNotifier::Rake.configure(
-      ignore_if: lambda { |ex, options| true })
+      ignore_if: lambda { |env, exception| true })
     ExceptionNotifier::Rake.maybe_deliver_notification(Exception.new)
+    assert_not_notified
+  end
+
+  def test_maybe_deliver_notifications_with_passing_ignore_if
+    ExceptionNotifier::Rake.configure(
+      ignore_if: lambda { |env, exception| false })
+    ex = Exception.new
+    ExceptionNotifier::Rake.maybe_deliver_notification(ex)
+    assert_notified ex, ExceptionNotifier::Rake.notifier_options
   end
 
   def test_maybe_deliver_notifications_with_ignore_exceptions
     ExceptionNotifier::Rake.configure(
       ignore_exceptions: ['RakeTest::IgnoredException'])
     ExceptionNotifier::Rake.maybe_deliver_notification(IgnoredException.new)
+    assert_not_notified
+
     ex = Exception.new
-    expect_delivery(ex, ExceptionNotifier::Rake.notifier_options)
     ExceptionNotifier::Rake.maybe_deliver_notification(ex)
+    assert_notified ex, ExceptionNotifier::Rake.notifier_options
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exception_notification-rake
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-18 00:00:00.000000000 Z
+date: 2014-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: exception_notification