errational 0.7.1

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in errational.gemspec
+gemspec
+
+gem "rake", "0.8.7"
+gem "rails", "3.0.7"
+gem "mocha", '0.9.12', :require => false
+

data/Gemfile.lock

@@ -0,0 +1,80 @@
+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/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Run Errational unit tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/errational.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "errational/version"
+
+Gem::Specification.new do |s|
+  s.name        = "errational"
+  s.version     = Errational::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kate Gengler", "Brian Olore"]
+  s.email       = ["errational@surrationale.net"]
+  s.summary     = %q{A gem for nice exception handling.}
+  s.description = %q{Nice error handling}
+
+  s.rubyforge_project = "errational"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+end

data/lib/errational.rb

@@ -0,0 +1,34 @@
+require 'rails'
+require 'rails/generators'
+require 'active_support/dependencies'
+require 'errational/errationality'
+require 'errational/errationalify'
+require 'generators/errational/install_generator'
+
+module Errational
+
+  def self.setup
+    yield self
+  end
+
+  mattr_accessor :namespace
+  mattr_accessor :error_response_code
+  mattr_accessor :error_partial
+  mattr_accessor :logger
+
+  def self.error_base_name
+    "#{Errational.namespace}Error"
+  end
+
+  def self.exception_base_name
+    "#{Errational.namespace}Exception"
+  end
+
+  def self.error_base
+    Kernel.const_get(Errational.error_base_name)
+  end
+
+  def self.exception_base
+    Kernel.const_get(Errational.exception_base_name)
+  end
+end

data/lib/errational/errationalify.rb

@@ -0,0 +1,86 @@
+module Errationalify
+
+  class Parent < RuntimeError;
+  end
+
+  class Loggable < Parent
+    def initialize(message = "")
+      super(message)
+    end
+  end
+
+  def self.included(module_that_has_included_this_module)
+    create_classes_from_constants_in_modules_within_error_module
+  end
+
+
+  def self.error_class(message = "", parent = Parent, &block)
+    block ||= Proc.new do
+      define_method(:initialize) { super(message) }
+    end
+    Class.new(parent, &block)
+  end
+
+  def self.intermediate_class
+    lambda {
+      error_class do
+        def initialize(message = "")
+          super(message)
+        end
+      end
+    }
+  end
+
+  def self.create_classes_from_constants_in_modules_within_error_module
+    sub_modules = modules_in(Errational.error_base)
+    sub_modules.each do |module_name|
+      current_module = Errational.error_base.const_get(module_name)
+      create_classes_from_constants_in(current_module)
+    end
+  end
+
+  def self.create_classes_from_constants_in(current_module)
+    current_module.constants.each do |constant_name|
+      error_constant = current_module.const_get(constant_name)
+      error_class_name = classify_name(constant_name)
+      parent_class = parent_class_for(current_module)
+      create_error_class_with(error_class_name, error_constant, parent_class)
+    end
+  end
+
+  def self.parent_class_for(current_module)
+    parent_class_name = name_of(current_module)
+
+    if already_a_class_on_the_class_that_has_included_this_module?(parent_class_name)
+      parent_class = Errational.exception_base.const_get(parent_class_name)
+    else
+      parent_class = Errational.exception_base.const_set(parent_class_name, intermediate_class.call)
+    end
+    parent_class
+  end
+
+  def self.already_a_class_on_the_class_that_has_included_this_module?(module_name)
+    included_in_constants?(Errational.exception_base, module_name) && defined?(Errational.exception_base.const_get(module_name)) && Errational.exception_base.const_get(module_name).is_a?(Class)
+  end
+
+  def self.name_of(current_module)
+    current_module.name.split("::").second
+  end
+
+  def self.create_error_class_with(class_name, constant, parent)
+    Errational.exception_base.const_set(class_name, error_class(constant, parent))
+  end
+
+  def self.classify_name(constant_name)
+    constant_name.to_s.downcase.camelize
+  end
+
+  def self.included_in_constants?(mod, constant_name)
+    mod.constants.include? constant_name
+  end
+
+  def self.modules_in(mod)
+    mod.constants.select { |name| mod.const_get(name).is_a? Module }
+  end
+
+end

data/lib/errational/errationality.rb

@@ -0,0 +1,37 @@
+module Errationality
+  private
+
+  def handle_unexpected_exception(exception)
+    log_exception(exception)
+    handle_exception(Errational.error_base::UNEXPECTED)
+  end
+
+  def handle_exception(exception_or_message)
+    log_exception(exception_or_message) if (exception_or_message.is_a? Errational.exception_base::Loggable)
+    render_error(exception_or_message.to_s)
+  end
+
+  def render_error(message)
+    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
+    end
+  end
+
+  def log_exception(exception)
+    Errational.logger.info "An exception occurred and was handled #{exception.class} : #{exception.to_s}"
+    Errational.logger.info exception.backtrace[0, 15].join("\n")
+  end
+end
+
+
+# Note:
+# When using rescue_from, assert_raises no longer works
+# Test for the results of the exception handling or expect exception handlers to be called
+ActiveSupport.on_load(:action_controller) do
+  include Errationality
+
+  rescue_from Exception, :with => :handle_unexpected_exception
+  rescue_from Errational.exception_base::Parent, :with => :handle_exception
+end

data/lib/errational/test_helpers.rb

@@ -0,0 +1,11 @@
+module Errational
+  module TestHelpers
+    def assert_renders_error_message(error)
+      assert_match @response.body, /#{error}/
+    end
+
+    def expect_no_error
+      @controller.expects(:handle_exception).never
+    end
+  end
+end

data/lib/errational/version.rb

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

data/lib/generators/errational/install_generator.rb

@@ -0,0 +1,34 @@
+module Errational
+  module Generators
+    class InstallGenerator < Rails::Generators::NamedBase
+
+      desc "This generator will create the necessary exception and error files in the lib/errational directory"
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def print_message
+        puts "Installing errational..."
+      end
+
+      def create_error_file
+        @error_module_name = "#{class_name}Error"
+        template("error_module.rb", "lib/errational/#{file_name}_error.rb")
+      end
+
+      def create_exception_file
+        @exception_module_name = "#{class_name}Exception"
+        template("exception_module.rb", "lib/errational/#{file_name}_exception.rb")
+      end
+
+      def create_configuration_file
+        @namespace = class_name
+        template("errational_configuration.rb", "config/initializers/errational_configuration.rb")
+      end
+
+      def create_partial_file
+        template("_error_dialog.js.erb", "app/views/errational/_error_dialog.js.erb")
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+/*
+ * This is the partial to be used for exceptions handled as the result of xhr actions
+ *
+ * where 'message' is the text from <%=file_name%>_error.rb
+ *
+ */
+jQuery('body').append('<div id="errational_error_dialog"></div>');
+jQuery('#errational_error_dialog')
+        .html('<%%= message %>')
+        .dialog(
+            {
+                minHeight: 'auto',
+                height: 'auto',
+                modal: true,
+                dialogClass: 'errational_class',
+                title: 'Error!',
+                resizable: false,
+                width: 450
+            }
+        );

data/lib/generators/templates/errational_configuration.rb

@@ -0,0 +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 = "<%= @namespace %>"
+
+  # 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/lib/generators/templates/error_module.rb

@@ -0,0 +1,53 @@
+# 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 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
+#
+module <%= @error_module_name %>
+
+  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 special module will be logged
+  module Loggable
+  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/lib/generators/templates/exception_module.rb

@@ -0,0 +1,25 @@
+# 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 occurred in the application. Please try again."
+#   end
+#   module Loggable
+#     SERVICE_FAULT = "The response from %s cannot be processed. Please try again"
+#   end
+# end
+
+module <%= @exception_module_name %>
+  include Errationalify
+end