errational 0.7.1

data/test/rails_app/public/javascripts/rails.js

@@ -0,0 +1,191 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+
+  Ajax.Responders.register({
+    onCreate: function(request) {
+      var csrf_meta_tag = $$('meta[name=csrf-token]')[0];
+
+      if (csrf_meta_tag) {
+        var header = 'X-CSRF-Token',
+            token = csrf_meta_tag.readAttribute('content');
+
+        if (!request.options.requestHeaders) {
+          request.options.requestHeaders = {};
+        }
+        request.options.requestHeaders[header] = token;
+      }
+    }
+  });
+})();

data/test/rails_app/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/test/rails_app/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/test/rails_app/test/test_helper.rb

@@ -0,0 +1,13 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+
+class ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+ENV["RAILS_ENV"] = "test"
+$:.unshift File.dirname(__FILE__)
+require "rails_app/config/environment"
+require "rails/test_help"
+
+# For generators
+require "rails/generators/test_case"
+require File.dirname(__FILE__) + '/../lib/errational'
+require File.dirname(__FILE__) + '/../lib/generators/errational/install_generator'
+

data/test/tmp/app/views/errational/_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 rails_app_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/test/tmp/config/initializers/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 = "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

data/test/tmp/lib/errational/rails_app_error.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 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 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/test/tmp/lib/errational/rails_app_exception.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 RailsAppException
+  include Errationalify
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: errational
+version: !ruby/object:Gem::Version
+  version: 0.7.1
+  prerelease: 
+platform: ruby
+authors:
+- Kate Gengler
+- Brian Olore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-26 00:00:00.000000000 -07:00
+default_executable: 
+dependencies: []
+description: Nice error handling
+email:
+- errational@surrationale.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README
+- Rakefile
+- errational.gemspec
+- lib/errational.rb
+- lib/errational/errationalify.rb
+- lib/errational/errationality.rb
+- lib/errational/test_helpers.rb
+- lib/errational/version.rb
+- lib/generators/errational/install_generator.rb
+- lib/generators/templates/_error_dialog.js.erb
+- lib/generators/templates/errational_configuration.rb
+- lib/generators/templates/error_module.rb
+- lib/generators/templates/exception_module.rb
+- test/errational_test.rb
+- test/errationalify_test.rb
+- test/errationality_test.rb
+- test/generators/install_generator_test.rb
+- test/rails_app/.gitignore
+- test/rails_app/README
+- 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/layouts/application.html.erb
+- test/rails_app/config.ru
+- test/rails_app/config/application.rb
+- test/rails_app/config/boot.rb
+- test/rails_app/config/database.yml
+- test/rails_app/config/environment.rb
+- test/rails_app/config/environments/development.rb
+- test/rails_app/config/environments/production.rb
+- test/rails_app/config/environments/test.rb
+- test/rails_app/config/initializers/backtrace_silencers.rb
+- test/rails_app/config/initializers/errational_configuration.rb
+- test/rails_app/config/initializers/inflections.rb
+- test/rails_app/config/initializers/mime_types.rb
+- test/rails_app/config/initializers/secret_token.rb
+- test/rails_app/config/initializers/session_store.rb
+- test/rails_app/config/locales/en.yml
+- 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/tasks/.gitkeep
+- test/rails_app/public/404.html
+- test/rails_app/public/422.html
+- test/rails_app/public/500.html
+- test/rails_app/public/favicon.ico
+- test/rails_app/public/images/rails.png
+- test/rails_app/public/index.html
+- test/rails_app/public/javascripts/application.js
+- test/rails_app/public/javascripts/controls.js
+- test/rails_app/public/javascripts/dragdrop.js
+- test/rails_app/public/javascripts/effects.js
+- test/rails_app/public/javascripts/prototype.js
+- test/rails_app/public/javascripts/rails.js
+- test/rails_app/public/robots.txt
+- test/rails_app/public/stylesheets/.gitkeep
+- test/rails_app/script/rails
+- 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: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      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/errational_test.rb
+- test/errationalify_test.rb
+- test/errationality_test.rb
+- test/generators/install_generator_test.rb
+- test/rails_app/.gitignore
+- test/rails_app/README
+- 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/layouts/application.html.erb
+- test/rails_app/config.ru
+- test/rails_app/config/application.rb
+- test/rails_app/config/boot.rb
+- test/rails_app/config/database.yml
+- test/rails_app/config/environment.rb
+- test/rails_app/config/environments/development.rb
+- test/rails_app/config/environments/production.rb
+- test/rails_app/config/environments/test.rb
+- test/rails_app/config/initializers/backtrace_silencers.rb
+- test/rails_app/config/initializers/errational_configuration.rb
+- test/rails_app/config/initializers/inflections.rb
+- test/rails_app/config/initializers/mime_types.rb
+- test/rails_app/config/initializers/secret_token.rb
+- test/rails_app/config/initializers/session_store.rb
+- test/rails_app/config/locales/en.yml
+- 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/tasks/.gitkeep
+- test/rails_app/public/404.html
+- test/rails_app/public/422.html
+- test/rails_app/public/500.html
+- test/rails_app/public/favicon.ico
+- test/rails_app/public/images/rails.png
+- test/rails_app/public/index.html
+- test/rails_app/public/javascripts/application.js
+- test/rails_app/public/javascripts/controls.js
+- test/rails_app/public/javascripts/dragdrop.js
+- test/rails_app/public/javascripts/effects.js
+- test/rails_app/public/javascripts/prototype.js
+- test/rails_app/public/javascripts/rails.js
+- test/rails_app/public/robots.txt
+- test/rails_app/public/stylesheets/.gitkeep
+- test/rails_app/script/rails
+- 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