errational 0.7.1 → 0.8.16

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+.bundle/
+test/tmp

data/Gemfile

@@ -4,6 +4,6 @@ source "http://rubygems.org"
 gemspec
 
 gem "rake", "0.8.7"
-gem "rails", "3.0.7"
+gem "rails", "~> 3.0"
 gem "mocha", '0.9.12', :require => false
 

data/README.md

@@ -0,0 +1,137 @@
+# errational
+
+Supports Rails 3 only
+
+## Summary
+
+This gem will create custom Exception classes for your rails app,
+rescue from them whenever they are raised, and display a nice message to the user.
+
+## Install
+
+Add to your Gemfile:
+
+```ruby
+gem 'errational'
+```
+
+## Run Generators
+
+```bash
+$ rails generate errational:install <app_name>
+```
+
+This will generate three files, there is documentation within the generated files:
+> lib/errational/<app_name>_error.rb
+> lib/errational/<app_name>_exception.rb
+> config/initializers/errational_configuration.rb
+
+## Usage
+
+This gem will generate exception classes based on the error constants defined in the generated
+<app_name>_error.rb file.  It will also rescue from these custom exceptions and use the custom defined method of displaying
+the string of the constant to the user.   It also rescues from all Exceptions and if the exception is not one of the
+custom exception classes, it will display the message from the ApplicationError::General::UNEXPECTED constant.
+
+This module contains modules of error constants, from each constant an exception class will be generated.
+Each submodule will be created as a class; it will be used as an intermediate ancestor between the exception class
+and the application exception class. All error constants must be within a module.
+
+The constant General::UNEXPECTED is special.  This is the message that will be used for all exceptions that are caught
+that are not from the custom exception classes.
+
+The module Loggable is a special case.  All error constants defined under Loggable (they can be within submodules)
+will be logged using the Logger defined in the configuration.
+
+For example, where Application is the name of the application:
+
+```ruby
+ module ApplicationError
+
+   module General
+     UNEXPECTED = "An error has occurred in the application. Please try again."
+   end
+
+   module Loggable
+     SERVICE_FAULT = "The response from the service cannot be processed. Please try again"
+   end
+
+   module Serious
+     BAD_PROBLEM = "The server is on fire, please call the fire department"
+   end
+ end
+
+ class FirstController < ApplicationController
+    def index
+      raise ApplicationException::ServiceFault # Will automatically be handled by the error handling gem with corresponding message.
+    end
+
+    def create
+      raise RuntimeError  # Will automatically be handled by error handling gem with UNEXPECTED message.
+    end
+
+    def update
+      raise ApplicationException::BadProblem
+      rescue ApplicationException::Parent => e  # Will rescue any of the exceptions generated by the plugin.
+        if(e.is_a? ApplicationException::Serious)  # Sub modules are created as ancestor classes of exceptions, useful for special casing.
+          call_lead_developer
+        end
+     end
+  end
+```
+The exception module generated into lib/errational/<app_name>_exception.rb is where you can override the default
+behavior of exception classes or add other exception classes. The default behavior of the exception classes is to
+create an exception with the message of the constant. Exception classes that override generated exception classes
+must be defined as children of their parent module's generated class.
+
+
+Example:
+
+```ruby
+ module ApplicationException
+   include Errationalify
+
+   class ServiceFault < Loggable
+     def initialize(service_name)
+       message = sprintf(ApplicationError::SERVICE_FAULT, service_name)
+     end
+   end
+ end
+ module ApplicationError
+   module General
+     UNEXPECTED = "An error has occurred in the application. Please try again."
+   end
+   module Loggable
+     SERVICE_FAULT = "The response from %s cannot be processed. Please try again"
+   end
+ end
+```
+
+## Configuration
+
+In the file generated into config/initializers/errational_configuration.rb you will find several values that are
+configurable.
+
+The error partial is the path to the partial that will be rendered as the result of xhr actions that result in an
+exception being thrown.  The default error dialog requires jQuery >= 1.5 and jQuery UI >= 1.8.9.  The error dialog will
+be created with an id of errational_error_dialog and a class of errational_class.  These can be styled.
+
+Example:
+
+``` ruby
+Errational.setup do |config|
+  # Namespace for name of exception and error modules, based on the name given at install time.
+  # Note, if changing, change the module names in lib/namespace_error.rb and lib/namespace_exception.rb,
+  # , as well as the filenames
+  config.namespace = "Application"
+
+  # The response code given for exceptions that are handled.
+  config.error_response_code = 203
+
+  # The partial to be used for exceptions handled as the result of xhr actions
+  config.error_partial = '/errational/error_dialog'
+
+  # The logger to be used for NamespaceException::Loggable exceptions and unexpected exceptions
+  config.logger = Rails.logger
+end
+```

data/errational.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["errational@surrationale.net"]
   s.summary     = %q{A gem for nice exception handling.}
   s.description = %q{Nice error handling}
+  s.homepage    = "https://github.com/kategengler/errational"
 
   s.rubyforge_project = "errational"
 

data/lib/errational/errationality.rb

@@ -15,7 +15,17 @@ module Errationality
     if request.xhr?
       render :partial => Errational.error_partial, :status => Errational.error_response_code, :locals => {:message => message}
     else
-      render :text => message, :status => Errational.error_response_code
+      respond_to do |format|
+        format.text do
+          render :text => message, :status => Errational.error_response_code
+        end
+        format.html do
+          render :text => message, :status => Errational.error_response_code
+        end
+        format.json do
+          render :json => message, :status => Errational.error_response_code
+        end
+      end
     end
   end
 

data/lib/errational/version.rb

@@ -1,3 +1,3 @@
 module Errational
-  VERSION = "0.7.1"
+  VERSION = "0.8.16"
 end

data/lib/generators/templates/_error_dialog.js.erb

@@ -6,7 +6,7 @@
  */
 jQuery('body').append('<div id="errational_error_dialog"></div>');
 jQuery('#errational_error_dialog')
-        .html('<%%= message %>')
+        .html('<%%= message.html_safe %>')
         .dialog(
             {
                 minHeight: 'auto',
@@ -17,4 +17,4 @@ jQuery('#errational_error_dialog')
                 resizable: false,
                 width: 450
             }
-        );
+        );

data/lib/generators/templates/exception_module.rb

@@ -3,7 +3,7 @@
 # Exception classes that override generated exception classes must be defined as children of their parent module's generated class.
 # Example:
 # module ApplicationException
-#   include ErrorHandlingClass
+#   include Errationalify
 #
 #   class ServiceFault < Loggable
 #     def initialize(service_name)

data/test/errational_test.rb

@@ -13,11 +13,11 @@ class ErrationalTest < ActiveSupport::TestCase
   end
 
   def test_error_base_name
-    assert_equal Errational.error_base_name, "RailsAppError"
+    assert_equal "RailsAppError", Errational.error_base_name
   end
 
   def test_exception_base_name
-    assert_equal Errational.exception_base_name, "RailsAppException"
+    assert_equal "RailsAppException", Errational.exception_base_name
   end
 
   def test_error_base
@@ -48,4 +48,4 @@ class ErrationalTest < ActiveSupport::TestCase
     end
   end
 
-end
+end

data/test/errationality_test.rb

@@ -9,7 +9,15 @@ class TestApplicationController < ApplicationController
   end
 
   def index
-    render :text => "hello"
+    respond_to do |format|
+      format.text do
+        render :text => "hello"
+      end
+
+      format.json do
+        render :json => {:blah =>'foo'}
+      end
+    end
   end
 end
 
@@ -34,6 +42,12 @@ class ErrationalityTest < ActionController::TestCase
     assert_match /#{Errational.error_base::UNEXPECTED}/, @response.body
   end
 
+  def test_should_render_error_in_format_requested
+    @controller.stubs(:blah).raises(RuntimeError)
+    get :index, :format => :json
+    assert_equal("application/json", @response.content_type)
+  end
+
   def test_should_have_error_response_code_for_full_request
     @controller.stubs(:blah).raises(RuntimeError)
     get :index
@@ -49,7 +63,7 @@ class ErrationalityTest < ActionController::TestCase
   def test_handle_exception_renders_error_dialog_partial
     @controller.stubs(:blah).raises(RuntimeError)
     xhr :get, :index
-    assert_match /new ErrorDialog.*#{Errational.error_base::UNEXPECTED}/, @response.body
+    assert_match /#{Errational.error_base::UNEXPECTED}/, @response.body
   end
 
   def test_handle_unexpected_exception_handles_general_exceptions_raises_tac_retry_message_and_logs
@@ -59,6 +73,13 @@ class ErrationalityTest < ActionController::TestCase
     @controller.send(:handle_unexpected_exception, new_exception)
   end
 
+  def test_messages_are_html_safe_as_default
+    new_exception = RailsAppException::HtmlMessage
+    @controller.stubs(:blah).raises(new_exception)
+    xhr :get, :index
+    assert_match /#{RailsAppError::HTML_MESSAGE}/, @response.body
+  end
+
   private
 
   def assert_controller_handles_exception_with(exception, method)
@@ -66,4 +87,4 @@ class ErrationalityTest < ActionController::TestCase
     @controller.stubs(:blah).raises(exception, "a message")
     xhr :get, :index
   end
-end
+end

data/test/generators/install_generator_test.rb

@@ -4,7 +4,10 @@ class InstallGeneratorTest < Rails::Generators::TestCase
   tests Errational::Generators::InstallGenerator
   destination File.expand_path("../../tmp", __FILE__)
 
-  setup :prepare_destination
+  def setup
+    $stderr.stubs(:write)
+    prepare_destination
+  end
 
   def test_assert_all_files_are_properly_created
     run_generator ["RailsApp"]
@@ -13,4 +16,4 @@ class InstallGeneratorTest < Rails::Generators::TestCase
     assert_file "lib/errational/rails_app_exception.rb"
     assert_file "app/views/errational/_error_dialog.js.erb"
   end
-end
+end

data/test/{tmp → rails_app}/app/views/errational/_error_dialog.js.erb

@@ -6,7 +6,7 @@
  */
 jQuery('body').append('<div id="errational_error_dialog"></div>');
 jQuery('#errational_error_dialog')
-        .html('<%= message %>')
+        .html('<%= message.html_safe %>')
         .dialog(
             {
                 minHeight: 'auto',
@@ -17,4 +17,4 @@ jQuery('#errational_error_dialog')
                 resizable: false,
                 width: 450
             }
-        );
+        );

data/test/rails_app/config/initializers/errational_configuration.rb

@@ -1,6 +1,18 @@
+#TODO is this the best place for this line?
+ActiveSupport::Dependencies.autoload_paths << "#{Rails.root}/lib/errational"
+
 Errational.setup do |config|
+  # Namespace for name of exception and error modules, based on the name given at install time.
+  # Note, if changing, change the module names in lib/namespace_error.rb and lib/namespace_exception.rb,
+  # , as well as the filenames
   config.namespace = "RailsApp"
+
+  # The response code given for exceptions that are handled.
   config.error_response_code = 203
-  config.error_partial = '/error_dialog'
+
+  # The partial to be used for exceptions handled as the result of xhr actions
+  config.error_partial = '/errational/error_dialog'
+
+  # The logger to be used for NamespaceException::Loggable exceptions and unexpected exceptions
   config.logger = Rails.logger
 end

data/test/{tmp → rails_app}/lib/errational/rails_app_error.rb

@@ -42,6 +42,7 @@ module RailsAppError
 
   #Errors in this special module will be logged
   module Loggable
+    HTML_MESSAGE = "A<br />message<br />with<br />html<br />!"
   end
 
 

data/test/{tmp → rails_app}/lib/errational/rails_app_exception.rb

@@ -3,7 +3,7 @@
 # Exception classes that override generated exception classes must be defined as children of their parent module's generated class.
 # Example:
 # module ApplicationException
-#   include ErrorHandlingClass
+#   include Errationalify
 #
 #   class ServiceFault < Loggable
 #     def initialize(service_name)

metadata

@@ -1,29 +1,40 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: errational
-version: !ruby/object:Gem::Version
-  version: 0.7.1
+version: !ruby/object:Gem::Version 
+  hash: 31
   prerelease: 
+  segments: 
+  - 0
+  - 8
+  - 16
+  version: 0.8.16
 platform: ruby
-authors:
+authors: 
 - Kate Gengler
 - Brian Olore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-26 00:00:00.000000000 -07:00
+
+date: 2011-08-16 00:00:00 -04:00
 default_executable: 
 dependencies: []
+
 description: Nice error handling
-email:
+email: 
 - errational@surrationale.net
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
+- .gitignore
 - Gemfile
-- Gemfile.lock
-- README
+- README.md
 - Rakefile
+- errational-0.7.1.gem
 - errational.gemspec
 - lib/errational.rb
 - lib/errational/errationalify.rb
@@ -44,7 +55,7 @@ files:
 - test/rails_app/Rakefile
 - test/rails_app/app/controllers/application_controller.rb
 - test/rails_app/app/helpers/application_helper.rb
-- test/rails_app/app/views/_error_dialog.js.erb
+- test/rails_app/app/views/errational/_error_dialog.js.erb
 - test/rails_app/app/views/layouts/application.html.erb
 - test/rails_app/config.ru
 - test/rails_app/config/application.rb
@@ -64,8 +75,8 @@ files:
 - test/rails_app/config/routes.rb
 - test/rails_app/db/seeds.rb
 - test/rails_app/doc/README_FOR_APP
-- test/rails_app/lib/rails_app_error.rb
-- test/rails_app/lib/rails_app_exception.rb
+- test/rails_app/lib/errational/rails_app_error.rb
+- test/rails_app/lib/errational/rails_app_exception.rb
 - test/rails_app/lib/tasks/.gitkeep
 - test/rails_app/public/404.html
 - test/rails_app/public/422.html
@@ -85,36 +96,41 @@ files:
 - test/rails_app/test/test_helper.rb
 - test/rails_app/vendor/plugins/.gitkeep
 - test/test_helper.rb
-- test/tmp/app/views/errational/_error_dialog.js.erb
-- test/tmp/config/initializers/errational_configuration.rb
-- test/tmp/lib/errational/rails_app_error.rb
-- test/tmp/lib/errational/rails_app_exception.rb
 has_rdoc: true
-homepage: 
+homepage: https://github.com/kategengler/errational
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: errational
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A gem for nice exception handling.
-test_files:
+test_files: 
 - test/errational_test.rb
 - test/errationalify_test.rb
 - test/errationality_test.rb
@@ -124,7 +140,7 @@ test_files:
 - test/rails_app/Rakefile
 - test/rails_app/app/controllers/application_controller.rb
 - test/rails_app/app/helpers/application_helper.rb
-- test/rails_app/app/views/_error_dialog.js.erb
+- test/rails_app/app/views/errational/_error_dialog.js.erb
 - test/rails_app/app/views/layouts/application.html.erb
 - test/rails_app/config.ru
 - test/rails_app/config/application.rb
@@ -144,8 +160,8 @@ test_files:
 - test/rails_app/config/routes.rb
 - test/rails_app/db/seeds.rb
 - test/rails_app/doc/README_FOR_APP
-- test/rails_app/lib/rails_app_error.rb
-- test/rails_app/lib/rails_app_exception.rb
+- test/rails_app/lib/errational/rails_app_error.rb
+- test/rails_app/lib/errational/rails_app_exception.rb
 - test/rails_app/lib/tasks/.gitkeep
 - test/rails_app/public/404.html
 - test/rails_app/public/422.html
@@ -165,7 +181,3 @@ test_files:
 - test/rails_app/test/test_helper.rb
 - test/rails_app/vendor/plugins/.gitkeep
 - test/test_helper.rb
-- test/tmp/app/views/errational/_error_dialog.js.erb
-- test/tmp/config/initializers/errational_configuration.rb
-- test/tmp/lib/errational/rails_app_error.rb
-- test/tmp/lib/errational/rails_app_exception.rb

data/Gemfile.lock

@@ -1,80 +0,0 @@
-PATH
-  remote: .
-  specs:
-    errational (0.7.1)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    abstract (1.0.0)
-    actionmailer (3.0.7)
-      actionpack (= 3.0.7)
-      mail (~> 2.2.15)
-    actionpack (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.5.0)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.14)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.7)
-      activesupport (= 3.0.7)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activerecord (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
-      arel (~> 2.0.2)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
-    activesupport (3.0.7)
-    arel (2.0.10)
-    builder (2.1.2)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    i18n (0.5.0)
-    mail (2.2.19)
-      activesupport (>= 2.3.6)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.16)
-    mocha (0.9.12)
-    polyglot (0.3.1)
-    rack (1.2.3)
-    rack-mount (0.6.14)
-      rack (>= 1.0.0)
-    rack-test (0.5.7)
-      rack (>= 1.0)
-    rails (3.0.7)
-      actionmailer (= 3.0.7)
-      actionpack (= 3.0.7)
-      activerecord (= 3.0.7)
-      activeresource (= 3.0.7)
-      activesupport (= 3.0.7)
-      bundler (~> 1.0)
-      railties (= 3.0.7)
-    railties (3.0.7)
-      actionpack (= 3.0.7)
-      activesupport (= 3.0.7)
-      rake (>= 0.8.7)
-      thor (~> 0.14.4)
-    rake (0.8.7)
-    thor (0.14.6)
-    treetop (1.4.9)
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.29)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  errational!
-  mocha (= 0.9.12)
-  rails (= 3.0.7)
-  rake (= 0.8.7)

data/test/rails_app/app/views/_error_dialog.js.erb

@@ -1 +0,0 @@
-new ErrorDialog({"message": "<%= message %>"});

data/test/rails_app/lib/rails_app_error.rb

@@ -1,54 +0,0 @@
-# This module contains modules of error constants, from each constant an exception class will be generated.
-# Each submodule will be created as a class; it will be used as an intermediate ancestor between the exception class
-# and the application exception class.
-# For example, where Application is the name of the application:
-# module ApplicationError
-#   module General
-#     UNEXPECTED = "An error has occured in the application. Please try again."
-#   end
-#   module Loggable
-#     SERVICE_FAULT = "The response from the service cannot be processed. Please try again"
-#   end
-#   module Serious
-#     BAD_PROBLEM = "The server is on fire, please call the fire department"
-#   end
-# end
-#
-# class FirstController < ApplicationController
-#    def index
-#      raise ApplicationException::ServiceFault # Will automatically be handled by the error handling gem with corresponding message.
-#    end
-#
-#    def create
-#      raise RuntimeError  # Will automatically be handled by error handling gem with UNEXPECTED message.
-#    end
-#
-#    def update
-#     raise ApplicationException::BadProblem
-#     rescue ApplicationException::Parent => e  # Will rescue any of the exceptions generated by the plugin.
-#       if(e.is_a? ApplicationException::Serious)  # Sub modules are created as ancestor classes of exceptions, useful for special casing.
-#         call_lead_developer
-#       end
-#    end
-# end
-#
-module RailsAppError
-
-  module General
-    # Default message for all general exceptions.
-    # Unexpected exceptions (ones without specific exception classes) will be logged.
-    UNEXPECTED = "An error has occurred with your last request. Please try again."
-  end
-
-  #Errors in this module will be logged
-  module Loggable
-    LOG_THIS = "This is a really bad error. Tell someone!"
-  end
-
-
-  def self.include_all_of_own_modules
-    constants.map { |c| const_get(c) }.select { |c| Module === c }.each { |c| include c }
-  end
-
-  include_all_of_own_modules
-end

data/test/rails_app/lib/rails_app_exception.rb

@@ -1,25 +0,0 @@
-# This module is where you can override the default behavior of exception classes or add other exception classes.
-# The default behavior of the exception classes is to create an exception with the message of the constant.
-# Exception classes that override generated exception classes must be defined as children of their parent module's generated class.
-# Example:
-# module ApplicationException
-#   include ErrorHandlingClass
-#
-#   class ServiceFault < Loggable
-#     def initialize(service_name)
-#       message = sprintf(ApplicationError::SERVICE_FAULT, service_name)
-#     end
-#   end
-# end
-# module ApplicationError
-#   module General
-#     UNEXPECTED = "An error has occured in the application. Please try again."
-#   end
-#   module Loggable
-#     SERVICE_FAULT = "The response from %s cannot be processed. Please try again"
-#   end
-# end
-
-module RailsAppException
-  include Errationalify
-end

data/test/tmp/config/initializers/errational_configuration.rb

@@ -1,18 +0,0 @@
-#TODO is this the best place for this line?
-ActiveSupport::Dependencies.autoload_paths << "#{Rails.root}/lib/errational"
-
-Errational.setup do |config|
-  # Namespace for name of exception and error modules, based on the name given at install time.
-  # Note, if changing, change the module names in lib/namespace_error.rb and lib/namespace_exception.rb,
-  # , as well as the filenames
-  config.namespace = "RailsApp"
-
-  # The response code given for exceptions that are handled.
-  config.error_response_code = 203
-
-  # The partial to be used for exceptions handled as the result of xhr actions
-  config.error_partial = '/errational/error_dialog'
-
-  # The logger to be used for NamespaceException::Loggable exceptions and unexpected exceptions
-  config.logger = Rails.logger
-end