wrangler 0.1.4 → 0.1.5

data/README

@@ -247,3 +247,19 @@ To build:
      cd .../wrangler
      rake gemspec
      rake build
+
+To test:
+Now at least, wrangler testing is all manual, which is bad (see TODO). So to
+test, try at least some of the following cases:
+* enable/disable local exception handling
+* enable/disable local notification
+* enable/disable delayed_job notification
+* raise an exception with a status_code
+* raise an exception without a status_code
+* raise an exception explicitly set to result in notification
+* raise an exception with ancestor class set to result in notification
+* raise an exception with error status code set to result in notification
+* raise an exception with explicit class mapping to error page
+* raise an exception with ancestor class mapping to error page
+* raise an exception with status_code mapping to error page
+* raise an ADDITIONAL exception inside the exception handling code...

data/lib/wrangler/exception_handler.rb

@@ -203,27 +203,30 @@ module Wrangler
     status_code = Wrangler::ExceptionHandler.status_code_for_exception(exception)
     request_data = request_data_from_request(request) unless request.nil?
 
+    log_exception(exception, request_data, status_code)
+
     if notify_on_exception?(exception, status_code)
       if notify_with_delayed_job?
         # don't pass in request as it contains not-easily-serializable stuff
+        log_error
         Wrangler::ExceptionNotifier.send_later(:deliver_exception_notification,
                                               exception,
+                                              exception.to_str,
                                               proc_name,
                                               exception.backtrace,
                                               status_code,
                                               request_data)
       else
         Wrangler::ExceptionNotifier.deliver_exception_notification(exception,
-                                                         proc_name,
-                                                         exception.backtrace,
-                                                         status_code,
-                                                         request_data,
-                                                         request)
+                                         exception.to_str,
+                                         proc_name,
+                                         exception.backtrace,
+                                         status_code,
+                                         request_data,
+                                         request)
       end
     end
 
-    log_exception(exception, request_data, status_code)
-
     if render_errors
       render_error_template(exception, status_code)
     end

data/lib/wrangler/exception_notifier.rb

@@ -68,7 +68,10 @@ module Wrangler
     #              be nil and MUST be nil if calling this method with
     #              delayed_job. Optional.
     #---------------------------------------------------------------------------
-    def exception_notification(exception, proc_name, backtrace,
+    def exception_notification(exception,
+                               exception_message,
+                               proc_name,
+                               backtrace,
                                status_code = nil,
                                request_data = nil,
                                request = nil)
@@ -90,6 +93,7 @@ module Wrangler
 
       body_hash =
         { :exception =>    exception,
+          :exception_message => exception_message,
           :backtrace =>    backtrace,
           :status_code =>  status_code,
           :request_data => request_data,
@@ -102,7 +106,7 @@ module Wrangler
       subject      "[#{proc_name + (proc_name ? ' ' : '')}" +
                    "#{config[:subject_prefix]}] " +
                    "#{exception.class.name}: " +
-                   "#{exception.message.inspect}"
+                   "#{exception_message}"
       body         body_hash
       sent_on      Time.now
       content_type 'text/plain'

data/lib/wrangler/wrangler_helper.rb

@@ -11,7 +11,8 @@ module Wrangler
   # http://ruby-doc.org/core/classes/Module.html#M001642
   module_function
 
-  # utility to determine if a class has another class as its ancestor. 
+
+  # utility to determine if a class has another class as its ancestor.
   #
   # returns the ancestor class (if any) that is found to be the ancestor
   # of klass (will return the nearest ancestor in other_klasses).
@@ -54,14 +55,15 @@ module Wrangler
     return nil
   end
 
+
   # log the exception using logger if available. if object does not have a
   # logger, will just puts()
   #-----------------------------------------------------------------------------
   def log_exception(exception, request_data = nil, status_code = nil)
     msgs = []
-
     msgs << "An exception was caught (#{exception.class.name}):"
-    msgs << exception.message
+    msgs << exception.to_str
+
     unless request_data.blank?
       msgs <<  "Request params were:"
       msgs <<  request_data.inspect
@@ -76,6 +78,7 @@ module Wrangler
     log_error msgs
   end
 
+
   # handles logging error messages, using logger if available and puts otherwise
   #-----------------------------------------------------------------------------
   def log_error(msgs)
@@ -92,6 +95,7 @@ module Wrangler
     end
   end
 
+
   # shorthand access to the exception handling config
   #-----------------------------------------------------------------------------
   def config

data/views/wrangler/exception_notifier/exception_notification.text.plain.erb

@@ -1,4 +1,4 @@
-<%#
+<%
   # NOTE: be very careful pulling data out of request in the view...it is
   # NOT cleaned, and may contain private data (e.g. passwords), so 
   # scrutinize any use of @request in the views!
@@ -9,7 +9,7 @@
 <% end -%>
 
 A <%= @exception.class %> occurred:
- * <%= @exception.inspect %>
+ * <%= @exception_message %>
 in <%= @backtrace.first %>
 
 <% unless @backtrace.blank? -%>

data/wrangler.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wrangler}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Percival"]
-  s.date = %q{2009-11-19}
+  s.date = %q{2009-11-30}
   s.description = %q{A gem for handling exceptions thrown inside your Rails app. If you include the
 gem in your application controller, wrangler will render the error pages you
 configure for each exception or HTTP error code. It will also handle notifying

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wrangler
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Brian Percival
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-19 00:00:00 -08:00
+date: 2009-11-30 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency