pboling-super_exception_notifier 1.6.5 → 1.6.6

data/VERSION.yml

@@ -1,4 +1,4 @@
 ---
 :major: 1
 :minor: 6
-:patch: 5
+:patch: 6

data/exception_notification.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = 'super_exception_notifier'
-  s.version = '1.6.5'
-  s.date = '2009-08-12'
+  s.version = '1.6.6'
+  s.date = '2009-08-13'
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
   s.summary = %q{Allows unhandled (and handled!) exceptions to be captured and sent via email}
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
   s.authors = ['Peter Boling', 'Jacques Crocker', 'Jamis Buck']
   s.email = 'peter.boling@gmail.com'
   s.homepage = 'http://github.com/pboling/exception_notification'
+  s.require_paths = ["lib"]
   
   s.has_rdoc = true
 
@@ -50,6 +51,7 @@ Gem::Specification.new do |s|
              "rails/app/views/exception_notifiable/423.html",
              "rails/app/views/exception_notifiable/501.html",
              "rails/app/views/exception_notifiable/503.html",
+             "rails/app/views/exception_notifiable/method_disabled.html.erb",
              "views/exception_notifier/_backtrace.html.erb",
              "views/exception_notifier/_environment.html.erb",
              "views/exception_notifier/_inspect_model.html.erb",

data/lib/exception_notifiable.rb

@@ -16,6 +16,7 @@ module ExceptionNotifiable
     ] if defined?(ActionController)
   end
 
+  # TODO: use ActionController::StatusCodes
   HTTP_ERROR_CODES = { 
     "400" => "Bad Request",
     "403" => "Forbidden",
@@ -141,28 +142,27 @@ module ExceptionNotifiable
       # OTW the error class is listed!
       status_code = status_code_for_exception(exception)
       if status_code == '200'
-        notify_and_render_error_template(status_code, request, exception, exception_to_filename(exception))
+        notify_and_render_error_template(status_code, request, exception, ExceptionNotifier.get_view_path_for_class(exception, self.class.exception_notifier_verbose))
       else
-        notify_and_render_error_template(status_code, request, exception)
+        notify_and_render_error_template(status_code, request, exception, ExceptionNotifier.get_view_path_for_status_code(status_code, self.class.exception_notifier_verbose))
       end
     end
 
-    def notify_and_render_error_template(status_cd, request, exception, file_path = nil)
+    def notify_and_render_error_template(status_cd, request, exception, file_path)
       status = self.class.http_error_codes[status_cd] ? status_cd + " " + self.class.http_error_codes[status_cd] : status_cd
-      file = file_path ? ExceptionNotifier.get_view_path(file_path) : ExceptionNotifier.get_view_path(status_cd)
       data = get_exception_data
       send_email = should_notify_on_exception?(exception, status_cd)
       send_web_hooks = !ExceptionNotifier.config[:web_hooks].empty?
       the_blamed = ExceptionNotifier.config[:git_repo_path].nil? ? nil : lay_blame(exception)
 
       # Debugging output
-      verbose_output(exception, status_cd, file, send_email, send_web_hooks, request, the_blamed) if self.class.exception_notifier_verbose
+      verbose_output(exception, status_cd, file_path, send_email, send_web_hooks, request, the_blamed) if self.class.exception_notifier_verbose
       # Send the email before rendering to avert possible errors on render preventing the email from being sent.
       perform_exception_notify_mailing(exception, data, request, the_blamed) if send_email
       # Send Web Hook requests
       HooksNotifier.deliver_exception_to_web_hooks(ExceptionNotifier.config, exception, self, request, data, the_blamed) if send_web_hooks
       # Render the error page to the end user
-      render_error_template(file, status)
+      render_error_template(file_path, status)
     end
 
     def get_exception_data
@@ -184,16 +184,16 @@ module ExceptionNotifiable
       end
     end
 
-    def verbose_output(exception, status_cd, file, send_email, send_web_hooks, request = nil, the_blamed = nil)
+    def verbose_output(exception, status_cd, file_path, send_email, send_web_hooks, request = nil, the_blamed = nil)
       puts "[EXCEPTION] #{exception}"
       puts "[EXCEPTION CLASS] #{exception.class}"
       puts "[EXCEPTION STATUS_CD] #{status_cd}"
       puts "[ERROR LAYOUT] #{self.class.error_layout}" if self.class.error_layout
       puts "[ERROR VIEW PATH] #{ExceptionNotifier.config[:view_path]}" if !ExceptionNotifier.nil? && !ExceptionNotifier.config[:view_path].nil?
-      puts "[ERROR RENDER] #{file}"
+      puts "[ERROR FILE PATH] #{file_path.inspect}"
       puts "[ERROR EMAIL] #{send_email ? "YES" : "NO"}"
       puts "[ERROR WEB HOOKS] #{send_web_hooks ? "YES" : "NO"}"
-      puts "[COMPAT MODE] #{ExceptionNotifierHelper::COMPAT_MODE ? "Yes" : "No"}"
+      puts "[COMPAT MODE] #{ExceptionNotifierHelper::COMPAT_MODE ? "YES" : "NO"}"
       puts "[THE BLAMED] #{the_blamed}"
       req = request ? " for request_uri=#{request.request_uri} and env=#{request.env.inspect}" : ""
       logger.error("render_error(#{status_cd}, #{self.class.http_error_codes[status_cd]}) invoked#{req}") if !logger.nil?
@@ -227,10 +227,6 @@ module ExceptionNotifiable
       self.class.rails_error_classes[exception.class].nil? ? '500' : self.class.rails_error_classes[exception.class].blank? ? '200' : self.class.rails_error_classes[exception.class]
     end
 
-    def exception_to_filename(exception)
-      exception.to_s.delete(':').gsub( /([A-Za-z])([A-Z])/, '\1' << '_' << '\2' ).downcase
-    end
-
     def lay_blame(exception)
       error = {}
       unless(ExceptionNotifier.config[:git_repo_path].nil?)

data/lib/exception_notifier.rb

@@ -37,16 +37,77 @@ class ExceptionNotifier < ActionMailer::Base
 
   def self.reloadable?() false end
 
-  # What is the path of the file we will render to the user?
-  def self.get_view_path(status_cd)
-    if File.exist?("#{RAILS_ROOT}/public/#{status_cd}.html")
-      "#{RAILS_ROOT}/public/#{status_cd}.html"
-    elsif !config[:view_path].nil? && File.exist?("#{RAILS_ROOT}/#{config[:view_path]}/#{status_cd}.html")
-      "#{RAILS_ROOT}/#{config[:view_path]}/#{status_cd}.html"
-    elsif File.exist?("#{File.dirname(__FILE__)}/../rails/app/views/exception_notifiable/#{status_cd}.html")
-      "#{File.dirname(__FILE__)}/../rails/app/views/exception_notifiable/#{status_cd}.html"
-    else 
-      "#{File.dirname(__FILE__)}/../rails/app/views/exception_notifiable/500.html"
+  # Returns an array of potential filenames to look for
+  # eg. For the Exception Class - SuperExceptionNotifier::CustomExceptionClasses::MethodDisabled
+  # the filename handles are:
+  #   super_exception_notifier_custom_exception_classes_method_disabled
+  #   method_disabled
+  def self.exception_to_filenames(exception)
+    filenames = []
+    e = exception.to_s
+    filenames << ExceptionNotifier.filenamify(e)
+
+    last_colon = e.rindex(':')
+    unless last_colon.nil?
+      filenames << ExceptionNotifier.filenamify(e[(last_colon + 1)..(e.length - 1)])
+    end
+    filenames
+  end
+
+  # Converts Stringified Class Names to acceptable filename handles with underscores
+  def self.filenamify(str)
+    str.delete(':').gsub( /([A-Za-z])([A-Z])/, '\1' << '_' << '\2').downcase
+  end
+
+  # What is the path of the file we will render to the user based on a given status code?
+  def self.get_view_path_for_status_code(status_cd, verbose = false)
+    file_name = ExceptionNotifier.get_view_path(status_cd, verbose)
+    #ExceptionNotifierHelper::COMPAT_MODE ? "#{File.dirname(__FILE__)}/../rails/app/views/exception_notifiable/500.html" : "500.html"
+    file_name.nil? ? self.catch_all(verbose) : file_name
+  end
+
+#  def self.get_view_path_for_files(filenames = [])
+#    filepaths = filenames.map do |file|
+#      ExceptionNotifier.get_view_path(file)
+#    end.compact
+#    filepaths.empty? ? "#{File.dirname(__FILE__)}/../rails/app/views/exception_notifiable/500.html" : filepaths.first
+#  end
+
+  # What is the path of the file we will render to the user based on a given exception class?
+  def self.get_view_path_for_class(exception, verbose = false)
+    return self.catch_all if exception.nil?
+    return self.catch_all unless exception.is_a?(StandardError) || exception.is_a?(Class) # For some reason exception.is_a?(Class) works in console, but not when running in mongrel (ALWAYS returns false)?!?!?
+    filepaths = ExceptionNotifier.exception_to_filenames(exception).map do |file|
+      ExceptionNotifier.get_view_path(file, verbose)
+    end.compact
+    filepaths.empty? ? self.catch_all(verbose) : filepaths.first
+  end
+
+  def self.catch_all(verbose = false)
+    puts "[CATCH ALL INVOKED] #{File.dirname(__FILE__)}/../rails/app/views/exception_notifiable/500.html" if verbose
+    "#{File.dirname(__FILE__)}/../rails/app/views/exception_notifiable/500.html"
+  end
+
+  # Check the usual suspects
+  def self.get_view_path(file_name, verbose = false)
+    if File.exist?("#{RAILS_ROOT}/public/#{file_name}.html")
+      puts "[FOUND FILE] #{RAILS_ROOT}/public/#{file_name}.html" if verbose
+      "#{RAILS_ROOT}/public/#{file_name}.html"
+    elsif !config[:view_path].nil? && File.exist?("#{RAILS_ROOT}/#{config[:view_path]}/#{file_name}.html.erb")
+      puts "[FOUND FILE] #{RAILS_ROOT}/#{config[:view_path]}/#{file_name}.html.erb" if verbose
+      "#{RAILS_ROOT}/#{config[:view_path]}/#{file_name}.html.erb"
+    elsif !config[:view_path].nil? && File.exist?("#{RAILS_ROOT}/#{config[:view_path]}/#{file_name}.html")
+      puts "[FOUND FILE] #{RAILS_ROOT}/#{config[:view_path]}/#{file_name}.html" if verbose
+      "#{RAILS_ROOT}/#{config[:view_path]}/#{file_name}.html"
+    elsif File.exist?("#{File.dirname(__FILE__)}/../rails/app/views/exception_notifiable/#{file_name}.html.erb")
+      puts "[FOUND FILE] #{File.dirname(__FILE__)}/../rails/app/views/exception_notifiable/#{file_name}.html.erb" if verbose
+      "#{File.dirname(__FILE__)}/../rails/app/views/exception_notifiable/#{file_name}.html.erb"
+    elsif File.exist?("#{File.dirname(__FILE__)}/../rails/app/views/exception_notifiable/#{file_name}.html")
+      #ExceptionNotifierHelper::COMPAT_MODE ? "#{File.dirname(__FILE__)}/../rails/app/views/exception_notifiable/#{file_name}.html" : "#{status_cd}.html"
+      puts "[FOUND FILE] #{File.dirname(__FILE__)}/../rails/app/views/exception_notifiable/#{file_name}.html" if verbose
+      "#{File.dirname(__FILE__)}/../rails/app/views/exception_notifiable/#{file_name}.html"
+    else
+      nil
     end
   end
 

data/rails/app/views/exception_notifiable/method_disabled.html.erb

@@ -0,0 +1,6 @@
+<!-- This file lives in gems/super_exception_notifier/rails/app/views/exception_notifiable/method_disabled.html.erb. See Readme for instructions on customizing. -->
+<div class="dialog">
+    <h1>Method Disabled.</h1>
+
+    <p>You attempted to access <%= params[:controller].humanize %> <%= params[:action] %> but that method is currently disabled.  Reloading the page will not help unless and until the method is enabled by the system administrator.</p>
+</div>

data/rails/init.rb

@@ -13,6 +13,9 @@ require "notifiable"
 
 Object.class_eval do include Notifiable end
 
-if ActionController::Base.respond_to?(:append_view_path)
-  ActionController::Base.append_view_path(File.join(File.dirname(__FILE__), 'app', 'views'))
-end
+#It appears that the view path is auto-added by rails... hmmm.
+#if ActionController::Base.respond_to?(:append_view_path)
+#  puts "view path before: #{ActionController::Base.view_paths}"
+#  ActionController::Base.append_view_path(File.join(File.dirname(__FILE__), 'app', 'views','exception_notifiable'))
+#  puts "view path After: #{ActionController::Base.view_paths}"
+#end

data/test/exception_notify_functional_test.rb

@@ -22,21 +22,34 @@ class ExceptionNotifyFunctionalTest < ActionController::TestCase
     end    
   end
 
-  def test_view_path_200; assert_view_path_string("200"); end
-  def test_view_path_400; assert_view_path_string("400"); end
-  def test_view_path_403; assert_view_path_string("403"); end
-  def test_view_path_404; assert_view_path_string("404"); end
-  def test_view_path_405; assert_view_path_string("405"); end
-  def test_view_path_410; assert_view_path_string("410"); end
-  def test_view_path_418; assert_view_path_string("422"); end
-  def test_view_path_422; assert_view_path_string("422"); end
-  def test_view_path_423; assert_view_path_string("423"); end
-  def test_view_path_500; assert_view_path_string("500"); end
-  def test_view_path_501; assert_view_path_string("501"); end
-  def test_view_path_503; assert_view_path_string("503"); end
-  def test_view_path_nil; assert_view_path_string(nil); end
-  def test_view_path_empty; assert_view_path_string(""); end
-  def test_view_path_nonsense; assert_view_path_string("slartibartfarst"); end
+  def test_view_path_200; assert_view_path_for_status_cd_is_string("200"); end
+  def test_view_path_400; assert_view_path_for_status_cd_is_string("400"); end
+  def test_view_path_403; assert_view_path_for_status_cd_is_string("403"); end
+  def test_view_path_404; assert_view_path_for_status_cd_is_string("404"); end
+  def test_view_path_405; assert_view_path_for_status_cd_is_string("405"); end
+  def test_view_path_410; assert_view_path_for_status_cd_is_string("410"); end
+  def test_view_path_418; assert_view_path_for_status_cd_is_string("422"); end
+  def test_view_path_422; assert_view_path_for_status_cd_is_string("422"); end
+  def test_view_path_423; assert_view_path_for_status_cd_is_string("423"); end
+  def test_view_path_500; assert_view_path_for_status_cd_is_string("500"); end
+  def test_view_path_501; assert_view_path_for_status_cd_is_string("501"); end
+  def test_view_path_503; assert_view_path_for_status_cd_is_string("503"); end
+  def test_view_path_nil; assert_view_path_for_status_cd_is_string(nil); end
+  def test_view_path_empty; assert_view_path_for_status_cd_is_string(""); end
+  def test_view_path_nonsense; assert_view_path_for_status_cd_is_string("slartibartfarst"); end
+  def test_view_path_class;
+    exception = SuperExceptionNotifier::CustomExceptionClasses::MethodDisabled
+    assert_view_path_for_class_is_string(exception);
+    assert ExceptionNotifier.get_view_path_for_class(exception).match("/rails/app/views/exception_notifiable/method_disabled.html.erb")
+  end
+  def test_view_path_class_nil; assert_view_path_for_class_is_string(nil); end
+  def test_view_path_class_empty; assert_view_path_for_class_is_string(""); end
+  def test_view_path_class_nonsense; assert_view_path_for_class_is_string("slartibartfarst"); end
+  def test_view_path_class_integer; assert_view_path_for_class_is_string(Integer); end
+
+  def test_exception_to_filenames
+    assert(["super_exception_notifier_custom_exception_classes_method_disabled", "method_disabled"] == ExceptionNotifier.exception_to_filenames(SuperExceptionNotifier::CustomExceptionClasses::MethodDisabled))
+  end
 
   def test_old_style_where_requests_are_local
     ActionController::Base.consider_all_requests_local = true
@@ -81,8 +94,12 @@ class ExceptionNotifyFunctionalTest < ActionController::TestCase
     
   private
 
-  def assert_view_path_string(status)
-    assert(ExceptionNotifier.get_view_path(status).is_a?(String), "View Path is not a string for status code '#{status}'")
+  def assert_view_path_for_status_cd_is_string(status)
+    assert(ExceptionNotifier.get_view_path_for_status_code(status).is_a?(String), "View Path is not a string for status code '#{status}'")
+  end
+
+  def assert_view_path_for_class_is_string(exception)
+    assert(ExceptionNotifier.get_view_path_for_class(exception).is_a?(String), "View Path is not a string for exception '#{exception}'")
   end
 
   def assert_error_mail_contains(text)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pboling-super_exception_notifier
 version: !ruby/object:Gem::Version 
-  version: 1.6.5
+  version: 1.6.6
 platform: ruby
 authors: 
 - Peter Boling
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-12 00:00:00 -07:00
+date: 2009-08-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,6 +55,7 @@ files:
 - rails/app/views/exception_notifiable/423.html
 - rails/app/views/exception_notifiable/501.html
 - rails/app/views/exception_notifiable/503.html
+- rails/app/views/exception_notifiable/method_disabled.html.erb
 - views/exception_notifier/_backtrace.html.erb
 - views/exception_notifier/_environment.html.erb
 - views/exception_notifier/_inspect_model.html.erb