RubyGems - exceptron - Versions diffs - 0.0.2 - Mend

exceptron 0.0.2

Files changed (75) hide show

data/MIT-LICENSE +20 -0
data/README.rdoc +3 -0
data/lib/exceptron.rb +38 -0
data/lib/exceptron/dispatcher.rb +58 -0
data/lib/exceptron/exception.rb +97 -0
data/lib/exceptron/exceptions_controller.rb +19 -0
data/lib/exceptron/helpers.rb +24 -0
data/lib/exceptron/local_exceptions_controller.rb +17 -0
data/lib/exceptron/local_helpers.rb +27 -0
data/lib/exceptron/middleware.rb +27 -0
data/lib/exceptron/railtie.rb +16 -0
data/lib/exceptron/version.rb +3 -0
data/lib/exceptron/views/exceptron/exceptions/internal_server_error.html.erb +26 -0
data/lib/exceptron/views/exceptron/local_exceptions/_request_and_response.erb +27 -0
data/lib/exceptron/views/exceptron/local_exceptions/_trace.erb +26 -0
data/lib/exceptron/views/exceptron/local_exceptions/diagnostics.erb +10 -0
data/lib/exceptron/views/exceptron/local_exceptions/missing_template.erb +2 -0
data/lib/exceptron/views/exceptron/local_exceptions/routing_error.erb +10 -0
data/lib/exceptron/views/exceptron/local_exceptions/template_error.erb +17 -0
data/lib/exceptron/views/exceptron/local_exceptions/unknown_action.erb +2 -0
data/lib/exceptron/views/layouts/exceptron/local_exceptions.erb +31 -0
data/test/dummy/Rakefile +7 -0
data/test/dummy/app/controllers/application_controller.rb +4 -0
data/test/dummy/app/controllers/exceptions_controller.rb +24 -0
data/test/dummy/app/controllers/home_controller.rb +4 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/views/app_exceptions/internal_server_error.html.erb +2 -0
data/test/dummy/app/views/app_exceptions/not_found.html.erb +2 -0
data/test/dummy/app/views/home/index.erb +1 -0
data/test/dummy/app/views/layouts/application.html.erb +14 -0
data/test/dummy/app/views/layouts/exceptions.html.erb +12 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/config/application.rb +49 -0
data/test/dummy/config/boot.rb +10 -0
data/test/dummy/config/database.yml +22 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +25 -0
data/test/dummy/config/environments/production.rb +49 -0
data/test/dummy/config/environments/test.rb +35 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/inflections.rb +10 -0
data/test/dummy/config/initializers/mime_types.rb +5 -0
data/test/dummy/config/initializers/secret_token.rb +7 -0
data/test/dummy/config/initializers/session_store.rb +8 -0
data/test/dummy/config/locales/en.yml +5 -0
data/test/dummy/config/routes.rb +60 -0
data/test/dummy/db/development.sqlite3 +0 -0
data/test/dummy/db/production.sqlite3 +0 -0
data/test/dummy/db/schema.rb +15 -0
data/test/dummy/db/test.sqlite3 +0 -0
data/test/dummy/log/test.log +40506 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/dummy/public/javascripts/application.js +2 -0
data/test/dummy/public/javascripts/controls.js +965 -0
data/test/dummy/public/javascripts/dragdrop.js +974 -0
data/test/dummy/public/javascripts/effects.js +1123 -0
data/test/dummy/public/javascripts/prototype.js +4874 -0
data/test/dummy/public/javascripts/rails.js +118 -0
data/test/dummy/public/stylesheets/exceptions.css +17 -0
data/test/dummy/script/rails +6 -0
data/test/exceptron_local_custom_test.rb +173 -0
data/test/exceptron_local_test.rb +122 -0
data/test/exceptron_public_custom_test.rb +128 -0
data/test/exceptron_public_test.rb +72 -0
data/test/test_helper.rb +48 -0
data/test/views/exceptions_custom/internal_server_error.da.html.erb +1 -0
data/test/views/exceptions_custom/internal_server_error.json +1 -0
data/test/views/exceptions_custom/not_found.html +26 -0
data/test/views/exceptions_custom/not_found.xml +5 -0
data/test/views/exceptions_custom/not_implemented.html.erb +26 -0
data/test/views/layouts/exception_test.html.erb +12 -0
data/test/views/local_exceptions_custom/diagnostics.da.html.erb +1 -0
data/test/views/local_exceptions_custom/not_implemented.html.erb +26 -0
data/test/views/local_exceptions_custom/unknown_action.erb +2 -0
metadata +197 -0

data/MIT-LICENSE ADDED

@@ -0,0 +1,20 @@
+Copyright 2010 JORLHUDA
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc ADDED

@@ -0,0 +1,3 @@
+= Exceptron
+This project rocks and uses MIT-LICENSE.

data/lib/exceptron.rb ADDED

@@ -0,0 +1,38 @@
+require 'exceptron/railtie'
+module Exceptron
+  autoload :Dispatcher,                'exceptron/dispatcher'
+  autoload :Exception,                 'exceptron/exception'
+  autoload :ExceptionsController,      'exceptron/exceptions_controller'
+  autoload :Helpers,                   'exceptron/helpers'
+  autoload :LocalExceptionsController, 'exceptron/local_exceptions_controller'
+  autoload :LocalHelpers,              'exceptron/local_helpers'
+  autoload :Middleware,                'exceptron/middleware'
+  autoload :VERSION,                   'exceptron/version'
+  mattr_reader :rescue_templates
+  @@rescue_templates = Hash.new('diagnostics')
+  @@rescue_templates.update(
+    'ActionView::MissingTemplate'        => 'missing_template',
+    'ActionController::RoutingError'     => 'routing_error',
+    'AbstractController::ActionNotFound' => 'unknown_action',
+    'ActionView::Template::Error'        => 'template_error'
+  )
+  def self.enable!
+    @@enabled = true
+  end
+  def self.disable!
+    @@enabled = false
+  end
+  def self.enabled?
+    @@enabled
+  end
+  class << self
+    attr_accessor :controller, :local_controller
+  end
+end

data/lib/exceptron/dispatcher.rb ADDED

@@ -0,0 +1,58 @@
+module Exceptron
+  class Dispatcher
+    FAILSAFE_RESPONSE = [500, {'Content-Type' => 'text/html'},
+      ["<html><head><title>500 Internal Server Error</title></head>" +
+       "<body><h1>500 Internal Server Error</h1>If you are the administrator of " +
+       "this website, then please read this web application's log file and/or the " +
+       "web server's log file to find out what went wrong.</body></html>"]]
+    def initialize(consider_all_requests_local)
+      @consider_all_requests_local = consider_all_requests_local
+      @exception_actions_cache = {}
+    end
+    def dispatch(env, exception)
+      log_error(exception.wrapped_exception)
+      local = @consider_all_requests_local || ActionDispatch::Request.new(env).local?
+      controller = exception_controller(local)
+      action = exception_action(local, controller, exception)
+      if action
+        controller.action(action).call(env)
+      else
+        FAILSAFE_RESPONSE
+      end
+    rescue Exception => failsafe_error
+      $stderr.puts "Error during failsafe response: #{failsafe_error}"
+      $stderr.puts failsafe_error.backtrace.join("\n")
+      FAILSAFE_RESPONSE
+    end
+    def exception_controller(local)
+      local ? Exceptron.local_controller : Exceptron.controller
+    end
+    def exception_action(local, controller_klass, exception)
+      controller = controller_klass.new
+      @exception_actions_cache[controller_klass] ||= {}
+      @exception_actions_cache[controller_klass][exception.original_exception.class] ||=
+        exception.actions.find { |action| controller.available_action?(action) }
+    end
+    def log_error(exception)
+      return unless logger
+      ActiveSupport::Deprecation.silence do
+        message = "\n#{exception.class} (#{exception.message}):\n"
+        message << exception.annoted_source_code.to_s if exception.respond_to?(:annoted_source_code)
+        message << exception.backtrace.join("\n  ")
+        logger.fatal("#{message}\n\n")
+      end
+    end
+    def logger
+      defined?(Rails.logger) ? Rails.logger : Logger.new($stderr)
+    end
+  end
+end

data/lib/exceptron/exception.rb ADDED

@@ -0,0 +1,97 @@
+class Exceptron::Presenter
+  def initialize(exception)
+    @wrapped_exception = exception
+  end
+  attr_reader :wrapped_exception
+  class << self
+    attr_accessor :statuses
+  end
+  self.statuses = {}
+  def to_xml(options={})
+    _serialize(:xml, options)
+  end
+  def to_json(options={})
+    _serialize(:json, options)
+  end
+  def status_code
+    statuses = self.class.statuses
+    registered_exception = original_exception.class.ancestors.find { |klass| statuses.key? klass }
+    statuses[registered_exception]
+  end
+  def status_message
+    status = Rack::Utils::HTTP_STATUS_CODES[status_code]
+    status.to_s if status
+  end
+  def actions
+    original_exception.class.ancestors.map do |klass|
+      status_code = self.class.statuses[klass]
+      status = Rack::Utils::HTTP_STATUS_CODES[status_code]
+      status.to_s.downcase.gsub(/\s|-/, '_') if status
+    end.compact
+  end
+  def original_exception
+    if wrapped_exception.respond_to?(:original_exception)
+      wrapped_exception.original_exception
+    else
+      wrapped_exception
+    end
+  end
+  protected
+  def _serialize(serializer, options) #:nodoc:
+    hash    = { :status => status_code, :message => status_message }
+    options = { :root => "error" }.merge!(options)
+    hash.send(:"to_#{serializer}", options)
+  end
+end
+class Exception
+  def self.respond_with(status)
+    Exceptron::Presenter.statuses[self] = status
+  end
+  respond_with 500
+end
+ActiveSupport.on_load(:action_controller) do
+  class ActionController::RoutingError
+    respond_with 404
+  end
+  class AbstractController::ActionNotFound
+    respond_with 404
+  end
+  class ActionController::MethodNotAllowed
+    respond_with 405
+  end
+  class ActionController::NotImplemented
+    respond_with 501
+  end
+end
+ActiveSupport.on_load(:active_record) do
+  class ActiveRecord::RecordNotFound
+    respond_with 404
+  end
+  class ActiveRecord::StaleObjectError
+    respond_with 409
+  end
+  class ActiveRecord::RecordInvalid
+    respond_with 422
+  end
+  class ActiveRecord::RecordNotSaved
+    respond_with 422
+  end
+end

data/lib/exceptron/exceptions_controller.rb ADDED

@@ -0,0 +1,19 @@
+module Exceptron
+  class ExceptionsController < ActionController::Base
+    append_view_path File.expand_path("../views", __FILE__)
+    respond_to :html, :xml, :json
+    include Exceptron::Helpers
+    def internal_server_error
+      respond_with exception_presenter
+    end
+    alias not_found internal_server_error
+    alias unprocessable_entity internal_server_error
+    def self.inherited(subclass)
+      super
+      Exceptron.controller = subclass
+    end
+  end
+end

data/lib/exceptron/helpers.rb ADDED

@@ -0,0 +1,24 @@
+module Exceptron
+  module Helpers
+    extend ActiveSupport::Concern
+    included do
+      before_filter :set_status_code
+      helper_method :exception_presenter, :exception
+    end
+    protected
+    def set_status_code
+      self.status = exception_presenter.status_code
+    end
+    def exception_presenter
+      @presenter ||= env["exceptron.presenter"]
+    end
+    def exception
+      @exception ||= exception_presenter.wrapped_exception
+    end
+  end
+end

data/lib/exceptron/local_exceptions_controller.rb ADDED

@@ -0,0 +1,17 @@
+module Exceptron
+  class LocalExceptionsController < ActionController::Base
+    append_view_path File.expand_path("../views", __FILE__)
+    include Exceptron::Helpers
+    helper Exceptron::LocalHelpers
+    def internal_server_error
+      render :action => Exceptron.rescue_templates[exception_presenter.original_exception.class.name]
+    end
+    def self.inherited(subclass)
+      super
+      Exceptron.local_controller = subclass
+    end
+  end
+end

data/lib/exceptron/local_helpers.rb ADDED

@@ -0,0 +1,27 @@
+module Exceptron
+  module LocalHelpers
+    def application_trace
+      clean_backtrace(exception, :silent)
+    end
+    def framework_trace
+      clean_backtrace(exception, :noise)
+    end
+    def full_trace
+      clean_backtrace(exception, :all)
+    end
+    def debug_hash(hash)
+      hash.map { |k, v| "#{k}: #{v.inspect}" }.sort.join("\n")
+    end
+  protected
+    def clean_backtrace(exception, *args)
+      Rails.respond_to?(:backtrace_cleaner) && Rails.backtrace_cleaner ?
+        Rails.backtrace_cleaner.clean(exception.backtrace, *args) :
+        exception.backtrace
+    end
+  end
+end

data/lib/exceptron/middleware.rb ADDED

@@ -0,0 +1,27 @@
+module Exceptron
+  class Middleware
+    def initialize(app, consider_all_requests_local)
+      @app = app
+      @dispatcher = Dispatcher.new(consider_all_requests_local)
+    end
+    def call(env)
+      begin
+        status, headers, body = @app.call(env)
+        exception = nil
+        # Only this middleware cares about RoutingError. So, let's just raise
+        # it here.
+        if headers['X-Cascade'] == 'pass'
+          raise ActionController::RoutingError, "No route matches [#{env['REQUEST_METHOD']}] #{env['PATH_INFO'].inspect}"
+        end
+      rescue Exception => exception
+        raise exception unless Exceptron.enabled?
+        exception = Presenter.new(exception)
+        env["exceptron.presenter"] = exception
+      end
+      exception ? @dispatcher.dispatch(env, exception) : [status, headers, body]
+    end
+  end
+end

data/lib/exceptron/railtie.rb ADDED

@@ -0,0 +1,16 @@
+module Exceptron
+  class Railtie < Rails::Railtie
+    config.exceptron = Exceptron
+    initializer "exceptron.swap_middlewares" do |app|
+      app.middleware.swap "ActionDispatch::ShowExceptions",
+        "Exceptron::Middleware", app.config.consider_all_requests_local
+    end
+    config.after_initialize do
+      config.exceptron.enable!
+      config.exceptron.controller ||= Exceptron::ExceptionsController
+      config.exceptron.local_controller ||= Exceptron::LocalExceptionsController
+    end
+  end
+end

data/lib/exceptron/version.rb ADDED

@@ -0,0 +1,3 @@
+module Exceptron
+  VERSION = "0.0.2".freeze
+end

data/lib/exceptron/views/exceptron/exceptions/internal_server_error.html.erb ADDED

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (<%= exception_presenter.status_code %>)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+    <p>We've been notified about this issue and we'll take a look at it shortly.</p>
+  </div>
+</body>
+</html>

data/lib/exceptron/views/exceptron/local_exceptions/_request_and_response.erb ADDED

@@ -0,0 +1,27 @@
+<% unless exception.blamed_files.blank? %>
+  <% if (hide = exception.blamed_files.length > 8) %>
+    <a href="#" onclick="document.getElementById('blame_trace').style.display='block'; return false;">Show blamed files</a>
+  <% end %>
+  <pre id="blame_trace" <%='style="display:none"' if hide %>><code><%=h exception.describe_blame %></code></pre>
+<% end %>
+<%
+  clean_params = request.filtered_parameters.clone
+  clean_params.delete("action")
+  clean_params.delete("controller")
+  request_dump = clean_params.empty? ? 'None' : clean_params.inspect.gsub(',', ",\n")
+%>
+<h2 style="margin-top: 30px">Request</h2>
+<p><b>Parameters</b>: <pre><%=h request_dump %></pre></p>
+<p><a href="#" onclick="document.getElementById('session_dump').style.display='block'; return false;">Show session dump</a></p>
+<div id="session_dump" style="display:none"><pre><%= debug_hash request.session %></pre></div>
+<p><a href="#" onclick="document.getElementById('env_dump').style.display='block'; return false;">Show env dump</a></p>
+<div id="env_dump" style="display:none"><pre><%= debug_hash request.env.slice(*request.class::ENV_METHODS) %></pre></div>
+<h2 style="margin-top: 30px">Response</h2>
+<p><b>Headers</b>: <pre><%=h defined?(response) ? response.headers.inspect.gsub(',', ",\n") : 'None' %></pre></p>

data/lib/exceptron/views/exceptron/local_exceptions/_trace.erb ADDED

@@ -0,0 +1,26 @@
+<%
+  traces = [
+    ["Application Trace", application_trace],
+    ["Framework Trace", framework_trace],
+    ["Full Trace", full_trace]
+  ]
+  names = traces.collect {|name, trace| name}
+%>
+<p><code>Rails.root: <%= defined?(Rails) && Rails.respond_to?(:root) ? Rails.root : "unset" %></code></p>
+<div id="traces">
+  <% names.each do |name| %>
+    <%
+      show = "document.getElementById('#{name.gsub(/\s/, '-')}').style.display='block';"
+      hide = (names - [name]).collect {|hide_name| "document.getElementById('#{hide_name.gsub(/\s/, '-')}').style.display='none';"}
+    %>
+    <a href="#" onclick="<%= hide.join %><%= show %>; return false;"><%= name %></a> <%= '|' unless names.last == name %>
+  <% end %>
+  <% traces.each do |name, trace| %>
+    <div id="<%= name.gsub(/\s/, '-') %>" style="display: <%= (name == "Application Trace") ? 'block' : 'none' %>;">
+      <pre><code><%=h trace.join "\n" %></code></pre>
+    </div>
+  <% end %>
+</div>