kinetic_cafe_error 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4b38a445d6682e36980b4f97aff27e7a6b0c840
+  data.tar.gz: 520d499da38abbdf6bf2fd73bfa842205a9c167c
+SHA512:
+  metadata.gz: ed26cb24789537f5f94e7e71587bd6220acf2f6ed04bbb8d604e6c623dbd132a4f74dc1c260445f3431128b3ed606408ae89861286c9918269591ed6c4d0c8e2
+  data.tar.gz: d0bd5e3fd993033ab84742a62aecd482caf3f95c0933f1fd248d8dbc0e87ffd345570bdf3289c1d3af83e6cf4a2573852b55966666f945bd8d89421c91be433d

data/.autotest

@@ -0,0 +1,35 @@
+# -*- ruby -*-
+
+require 'autotest/bundler'
+require 'autotest/restart'
+require 'autotest/timestamp'
+
+def require_plugin(resource)
+  require resource
+rescue LoadError
+  false
+end
+
+require_plugin 'autotest/clear'
+
+Autotest.add_hook :initialize do |at|
+  # at.testlib = "minitest/unit"
+  #
+  # at.extra_files << "../some/external/dependency.rb"
+  #
+  # at.libs << ":../some/external"
+  #
+  # at.add_exception "vendor"
+  #
+  # at.add_mapping(/dependency.rb/) do |f, _|
+  #   at.files_matching(/test_.*rb$/)
+  # end
+  #
+  # %w(TestA TestB).each do |klass|
+  #   at.extra_class_map[klass] = "test/test_misc.rb"
+  # end
+end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/.gemtest

@@ -0,0 +1 @@
+

data/.travis.yml

@@ -0,0 +1,39 @@
+---
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.1.6
+  - 2.0.0
+  - 1.9.3
+  - jruby-1.7
+  - jruby-9.0.0.0.pre2
+  - jruby-19mode
+  - jruby-head
+  - ruby-head
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+    - rvm: jruby-head
+    - rvm: jruby-9.0.0.0.pre2
+    - rvm: ruby-head
+gemfile:
+  - Gemfile
+before_script:
+  - |
+    case "${TRAVIS_RUBY_VERSION}" in
+      rbx*)
+        gem install psych
+        ;;
+    esac
+  - rake travis:before -t
+script: rake travis
+after_script:
+  - rake travis:after -t
+notifications:
+  email:
+    recipients:
+      - FIX@example.com
+    on_success: change
+    on_failure: always
+sudo: false

data/Contributing.rdoc

@@ -0,0 +1,62 @@
+== Contributing
+
+I value any contribution to kinetic_cafe_error you can provide: a bug report, a
+feature request, or code contributions.
+
+* Changes *will* *not* be accepted without tests. The test suite is written
+  with {Minitest}[https://github.com/seattlerb/minitest].
+* Match my coding style.
+* Use a thoughtfully-named topic branch that contains your change. Rebase your
+  commits into logical chunks as necessary.
+* Use {quality commit messages}[http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html].
+* Do not change the version number; when your patch is accepted and a release
+  is made, the version will be updated at that point.
+* Submit a GitHub pull request with your changes.
+* New behaviours require new or updated documentation.
+
+=== Test Dependencies
+
+kinetic_cafe_error uses Ryan Davis’s {Hoe}[https://github.com/seattlerb/hoe]
+to manage the release process, and it adds a number of rake tasks. You will
+mostly be interested in:
+
+    $ rake
+
+which runs the tests the same way that:
+
+    $ rake test
+    $ rake travis
+
+will do.
+
+To assist with the installation of the development dependencies for
+kinetic_cafe_error, I have provided the simplest possible Gemfile pointing to
+the (generated) +kinetic_cafe_error.gemspec+ file. This will permit you to do:
+
+    $ bundle install
+
+to get the development dependencies. If you aleady have +hoe+ installed, you
+can accomplish the same thing with:
+
+    $ rake newb
+
+This task will install any missing dependencies, run the tests/specs, and
+generate the RDoc.
+
+=== Workflow
+
+Here's the most direct way to get your work merged into the project:
+
+* Fork the project.
+* Clone down your fork (<tt>git clone git://github.com/<username>/kinetic_cafe_error.git</tt>).
+* Create a topic branch to contain your change (<tt>git checkout -b my\_awesome\_feature</tt>).
+* Hack away, add tests. Not necessarily in that order.
+* Make sure everything still passes by running +rake+.
+* If necessary, rebase your commits into logical chunks, without errors.
+* Push the branch up (<tt>git push origin my\_awesome\_feature</tt>).
+* Create a pull request against halostatue/kinetic_cafe_error and describe
+  what your change does and the why you think it should be merged.
+
+=== Contributors
+
+* Austin Ziegler created kinetic_cafe_error.

data/Gemfile

@@ -0,0 +1,9 @@
+# -*- ruby -*-
+
+# NOTE: This file is present to keep Travis CI happy. Edits to it will not
+# be accepted.
+
+source "https://rubygems.org/"
+gemspec
+
+# vim: syntax=ruby

data/History.rdoc

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2015-05-27
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Licence.rdoc

@@ -0,0 +1,27 @@
+== Licence
+
+This software is available under an MIT-style licence.
+
+* Copyright 2015 Austin Ziegler & Kinetic Cafe
+
+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 names of its contributors may not be used to endorse or promote
+  products derived from this software without specific prior written
+  permission.
+
+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/Manifest.txt

@@ -0,0 +1,25 @@
+.autotest
+.gemtest
+.travis.yml
+Contributing.rdoc
+Gemfile
+History.rdoc
+Licence.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+app/controllers/concerns/kinetic_cafe/error_handler.rb
+app/views/kinetic_cafe/error/page.html.erb
+config/locales/kinetic_cafe_error.en.yml
+config/locales/kinetic_cafe_error.en_ca.yml
+config/locales/kinetic_cafe_error.en_uk.yml
+config/locales/kinetic_cafe_error.en_us.yml
+config/locales/kinetic_cafe_error.fr.yml
+config/locales/kinetic_cafe_error.fr_ca.yml
+lib/kinetic_cafe/error.rb
+lib/kinetic_cafe/error_dsl.rb
+lib/kinetic_cafe/error_engine.rb
+lib/kinetic_cafe_error.rb
+test/test_helper.rb
+test/test_kinetic_cafe_error.rb
+test/test_kinetic_cafe_error_dsl.rb

data/README.rdoc

@@ -0,0 +1,32 @@
+= kinetic_cafe_error
+
+code :: https://github.com/KineticCafe/kinetic_cafe_error/
+bugs :: https://github.com/KineticCafe/kinetic_cafe_error/issues
+continuous integration :: {<img src="https://travis-ci.org/KineticCafe/kinetic_cafe_error.png" />}[https://travis-ci.org/KineticCafe/kinetic_cafe_error]
+
+== Description
+
+kinetic_cafe_error provides an API-smart error base class and a DSL for
+defining errors. Under Rails, it also provides a controller concern
+(KineticCafe::ErrorHandler) that has a useful implementation of +rescue_from+
+for KineticCafe::Error types.
+
+== Synopsis
+
+  class MyErrorBase < KineticCafe::Error
+    extend KineticCafe::ErrorDSL
+  
+    not_found class: :user # => MyErrorBase::UserNotFound
+    unauthorized class: :user # => MyErrorBase::UserUnauthorized
+    forbidden class: :user # => MyErrorBase::UserForbidden
+    conflict class: :user# => MyErrorBase::UserConflict
+  end
+
+== Install
+
+Add kinetic_cafe_error to your gemfile:
+
+  gem 'kinetic_cafe_error', '~> 1.0'
+
+:include: Contributing.rdoc
+:include: Licence.rdoc

data/Rakefile

@@ -0,0 +1,67 @@
+# -*- ruby encoding: utf-8 -*-
+
+require 'rubygems'
+require 'hoe'
+require 'rake/clean'
+
+Hoe.plugin :doofus
+Hoe.plugin :gemspec2
+Hoe.plugin :git
+Hoe.plugin :minitest
+Hoe.plugin :travis
+Hoe.plugin :email unless ENV['CI'] or ENV['TRAVIS']
+
+spec = Hoe.spec "kinetic_cafe_error" do
+  # HEY! If you fill these out in ~/.hoe_template/minitest-travis/Rakefile.erb,
+  # you'll never have to touch them again!
+  # (delete this comment too, of course)
+  developer('Austin Ziegler', 'aziegler@kineticcafe.com')
+
+  require_ruby_version '>= 1.9.2'
+
+  self.history_file = 'History.rdoc'
+  self.readme_file = 'README.rdoc'
+  self.extra_rdoc_files = FileList["*.rdoc"].to_a
+
+  license "MIT"
+
+  extra_dev_deps << ['hoe-doofus', '~> 1.0']
+  extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
+  extra_dev_deps << ['hoe-git', '~> 1.6']
+  extra_dev_deps << ['hoe-rubygems', '~> 1.0']
+  extra_dev_deps << ['hoe-travis', '~> 1.2']
+  extra_dev_deps << ['minitest', '~> 5.4']
+  extra_dev_deps << ['minitest-autotest', '~> 1.0']
+  extra_dev_deps << ['minitest-focus', '~> 1.1']
+  extra_dev_deps << ['minitest-moar', '~> 0.0']
+  extra_dev_deps << ['minitest-stub-const', '~> 0.4']
+  extra_dev_deps << ['rack-test', '~> 0.6']
+  extra_dev_deps << ['rake', '~> 10.0']
+  extra_dev_deps << ['simplecov', '~> 0.7']
+  extra_dev_deps << ['coveralls', '~> 0.8']
+end
+
+namespace :test do
+  task :coverage do
+    spec.test_prelude = [
+      'require "simplecov"',
+      'SimpleCov.start("test_frameworks") { command_name "Minitest" }',
+      'gem "minitest"'
+    ].join('; ')
+    Rake::Task['test'].execute
+  end
+
+  task :coveralls do
+    spec.test_prelude = [
+      'require "psych"',
+      'require "simplecov"',
+      'require "coveralls"',
+      'SimpleCov.formatter = Coveralls::SimpleCov::Formatter',
+      'SimpleCov.start("test_frameworks") { command_name "Minitest" }',
+      'gem "minitest"'
+    ].join('; ')
+    Rake::Task['test'].execute
+  end
+end
+
+# vim: syntax=ruby

data/app/controllers/concerns/kinetic_cafe/error_handler.rb

@@ -0,0 +1,60 @@
+require 'active_support/concern'
+
+# A controller concern for KineticCafe::Error that rescues from
+# KineticCafe::Error using #kinetic_cafe_error_handler. This handler can be
+# redefined on a per-controller basis.
+module KineticCafe::ErrorHandler
+  extend ActiveSupport::Concern
+
+  included do
+    rescue_from KineticCafe::Error, with: :kinetic_cafe_error_handler
+  end
+
+  # This method is called with +error+ when Rails catches a KineticCafe::Error
+  # descendant. It logs the message and its cause as severity error. After
+  # logging, it will render to HTML or JSON.
+  #
+  # HTML is rendered with #kinetic_cafe_error_render_html. JSON is rendered
+  # with #kinetic_cafe_error_render_json. Either of these can be overridden in
+  # controllers for different behaviour.
+  def kinetic_cafe_error_handler(error)
+    Rails.logger.error(error.message)
+    Rails.logger.error("^-- caused by: #{error.cause.message}") if error.cause
+
+    respond_to do |format|
+      format.html do
+        kinetic_cafe_error_render_html(error)
+      end
+      format.json do
+        kinetic_cafe_error_render_json(error)
+      end
+    end
+  end
+
+  # Render the +error+ as HTML. Uses the template +kinetic_cafe/error/page+
+  # with +error+ passed as a local of the same name. The render status is set
+  # to <tt>error.status</tt>.
+  def kinetic_cafe_error_render_html(error)
+    render template: 'kinetic_cafe/error/page', locals: { error: error },
+      status: error.status
+  end
+
+  # Render the +error+ as JSON. If it is KineticCafe::Error#header_only?, only
+  # a +head+ of the <tt>error.status</tt> is returned. Otherwise, the render is
+  # done with KineticCafe::Error#json_result.
+  #
+  # If you are overriding this because you want to add or change #json_result,
+  # use #error_result as the value to the +json+ parameter.
+  #
+  #   def kinetic_cafe_error_render_json(error)
+  #     render status: error.status, layout: false, json: error.error_result,
+  #       content_type: 'application/hal+json'
+  #   end
+  def kinetic_cafe_error_render_json(error)
+    if error.header_only?
+      head error.status
+    else
+      render error.json_result
+    end
+  end
+end

data/app/views/kinetic_cafe/error/page.html.erb

@@ -0,0 +1,8 @@
+<h2><%= t('kinetic_cafe_error.page.title') %></h2>
+
+<% unless error.header_only? || error.internal? -%>
+  <blockquote><%= error.i18n_message %></blockquote>
+<% end -%>
+<%= t('kinetic_cafe_error.page.body_html') %>
+<%= t('kinetic_cafe_error.page.error_table_html',
+      status: error.status, code: error.i18n_key) -%>

data/config/locales/kinetic_cafe_error.en.yml

@@ -0,0 +1,21 @@
+en-CA:
+  kinetic_cafe_error:
+    page:
+      title: >-
+        An error occurred.
+      body_html: |
+        <p>The person responsible has been informed.</p>
+        <p>I’m not allowed to say anything else.</p>
+        <p>…</p>
+        <p>OK. Just for you, here’s a bit more:</p>
+      error_table_html: |
+        <table>
+          <tbody>
+            <tr>
+              <th>Status</th><td>&nbsp;</td><td>%{status}</td>
+            </tr>
+            <tr>
+              <th>Code</th><td>&nbsp;</td><td>%{code}</td>
+            </tr>
+          </tbody>
+        </table>

data/config/locales/kinetic_cafe_error.en_ca.yml

@@ -0,0 +1,21 @@
+en-CA:
+  kinetic_cafe_error:
+    page:
+      title: >-
+        An error occurred.
+      body_html: |
+        <p>The person responsible has been informed.</p>
+        <p>I’m not allowed to say anything else.</p>
+        <p>…</p>
+        <p>OK. Just for you, here’s a bit more:</p>
+      error_table_html: |
+        <table>
+          <tbody>
+            <tr>
+              <th>Status</th><td>&nbsp;</td><td>%{status}</td>
+            </tr>
+            <tr>
+              <th>Code</th><td>&nbsp;</td><td>%{code}</td>
+            </tr>
+          </tbody>
+        </table>

data/config/locales/kinetic_cafe_error.en_uk.yml

@@ -0,0 +1,21 @@
+en-UK:
+  kinetic_cafe_error:
+    page:
+      title: >-
+        An error occurred.
+      body_html: |
+        <p>The person responsible has been informed.</p>
+        <p>I’m not allowed to say anything else.</p>
+        <p>…</p>
+        <p>OK. Just for you, here’s a bit more:</p>
+      error_table_html: |
+        <table>
+          <tbody>
+            <tr>
+              <th>Status</th><td>&nbsp;</td><td>%{status}</td>
+            </tr>
+            <tr>
+              <th>Code</th><td>&nbsp;</td><td>%{code}</td>
+            </tr>
+          </tbody>
+        </table>