hoptoad_notifier 2.4.8 → 2.4.9

data/CHANGELOG

@@ -1,3 +1,9 @@
+Version 2.4.9 - Wed Mar 30 09:04:53 -0400 2011
+===============================================================================
+
+Jonathan Yurek(1):
+      The User Informer should adhere to only the Rack spec.
+
 Version 2.4.8 - Mon Mar 21 11:11:16 -0400 2011
 ===============================================================================
 
@@ -423,5 +429,6 @@ Nick Quaranto (3):
 
 
 
+
 
 

data/README.md

@@ -228,6 +228,26 @@ To perform custom error processing after Hoptoad has been notified, define the
 instance method #rescue_action_in_public_without_hoptoad(exception) in your
 controller.
 
+Informing the User
+------------------
+
+The Notifier gem is capable of telling the user information about the error that just happened
+via the user_information option. They can give this error number in bug resports, for example.
+By default, if your 500.html contains the text
+
+    <!-- HOPTOAD ERROR -->
+
+then that comment will be replaced with the text "Hoptoad Error [errnum]". You can modify the text
+of the informer by setting config.user_information. The Notifier will replace "{{ error_id }}" with the
+ID of the error that is returned from Hoptoad.
+
+  HoptoadNotifier.configure do |config|
+    ...
+    config.user_information = "<p>Tell the devs that it was <strong>{{ error_id }}</strong>'s fault.</p>"
+  end
+
+You can also turn the middleware completely off by setting config.user_information to false.
+
 Tracking deployments in Hoptoad
 -------------------------------
 

data/lib/hoptoad_notifier/user_informer.rb

@@ -10,11 +10,13 @@ module HoptoadNotifier
 
     def call(env)
       status, headers, body = @app.call(env)
-      if env['hoptoad.error_id']
-        body.each_with_index do |chunk, i|
-          body[i] = chunk.to_s.gsub("<!-- HOPTOAD ERROR -->", replacement(env['hoptoad.error_id']))
+      if env['hoptoad.error_id'] && HoptoadNotifier.configuration.user_information
+        new_body = []
+        body.each do |chunk|
+          new_body << chunk.gsub("<!-- HOPTOAD ERROR -->", replacement(env['hoptoad.error_id']))
         end
-        headers['Content-Length'] = body.sum(&:length).to_s
+        headers['Content-Length'] = new_body.sum(&:length).to_s
+        body = new_body
       end
       [status, headers, body]
     end

data/lib/hoptoad_notifier/version.rb

@@ -1,3 +1,3 @@
 module HoptoadNotifier
-  VERSION = "2.4.8".freeze
+  VERSION = "2.4.9".freeze
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hoptoad_notifier
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 2
   - 4
-  - 8
-  version: 2.4.8
+  - 9
+  version: 2.4.9
 platform: ruby
 authors: 
 - thoughtbot, inc
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-21 00:00:00 -04:00
+date: 2011-03-30 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency