kinetic_cafe_error 1.0

data/lib/kinetic_cafe/error_engine.rb

@@ -0,0 +1,6 @@
+module KineticCafe
+  # If Rails is defined, KineticCafe::ErrorEngine will be loaded automatically,
+  # providing access to the KineticCafe::ErrorHandler.
+  class ErrorEngine < ::Rails::Engine
+  end
+end

data/lib/kinetic_cafe_error.rb

@@ -0,0 +1,2 @@
+require 'kinetic_cafe/error'
+require 'Kinetic_cafe/error_engine' if defined?(::Rails)

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+# -*- ruby encoding: utf-8 -*-
+
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/stub_const'
+require 'minitest/moar'
+require 'rack/test'
+require 'kinetic_cafe_error'
+
+unless defined? I18n.translate
+  module I18n
+    def self.translate(*)
+    end
+  end
+end

data/test/test_kinetic_cafe_error.rb

@@ -0,0 +1,81 @@
+require 'test_helper'
+
+describe KineticCafe::Error do
+  describe 'defaults' do
+    let(:exception) { @exception = KineticCafe::Error.new }
+
+    it 'defaults correctly' do
+      stub I18n, :translate, 'Untranslatable error' do
+        expected = '#<KineticCafe::Error: name=error ' \
+          "status=bad_request message=\"Untranslatable error\" " \
+          'i18n_key=kcerrors.error i18n_params={} extra=nil cause=>'
+        assert_equal expected, exception.inspect
+      end
+    end
+
+    it 'returns key/params if I18n.translate is not defined' do
+      Object.stub_remove_const(:I18n) do
+        assert_equal [ 'kcerrors.error', {} ], exception.i18n_message
+      end
+    end
+
+    it '#api_error only includes set values' do
+      assert_equal(
+        {
+          status: :bad_request,
+          name: "error",
+          internal: false,
+          i18n_key: "kcerrors.error"
+        },
+        exception.api_error
+      )
+    end
+
+    it '#error_result includes #api_error and #message' do
+      assert_equal(
+        {
+          error: {
+            status: :bad_request,
+            name: "error",
+            internal: false,
+            i18n_key: "kcerrors.error"
+          },
+          message: nil
+        },
+        exception.error_result
+      )
+    end
+
+    it '#json_result includes #status, #error_result, and layout: false' do
+      assert_equal(
+        {
+          status: :bad_request,
+          json: {
+            error: {
+              status: :bad_request,
+              name: "error",
+              internal: false,
+              i18n_key: "kcerrors.error"
+            },
+            message: nil
+          },
+          layout: false
+        },
+        exception.json_result
+      )
+    end
+
+    it 'encodes the :query parameter specially for I18n parameters' do
+      exception = KineticCafe::Error.new(query: { a: 1, b: %w(x y z )})
+      Object.stub_remove_const(:I18n) do
+        assert_equal(
+          [
+            'kcerrors.error',
+            { query: "a: 1; b[]: x, b[]: y, b[]: z" }
+          ],
+          exception.i18n_message
+        )
+      end
+    end
+  end
+end

data/test/test_kinetic_cafe_error_dsl.rb

@@ -0,0 +1,218 @@
+require 'test_helper'
+require 'rack/test'
+
+describe KineticCafe::ErrorDSL do
+  it 'cannot be extended onto a non-exception' do
+    ex = assert_raises RuntimeError do
+      Class.new.send(:extend, KineticCafe::ErrorDSL)
+    end
+    assert_match(/cannot extend.*StandardError/, ex.message)
+  end
+
+  it 'cannot be extended onto a non-StandardError' do
+    ex = assert_raises RuntimeError do
+      Class.new(Exception).send(:extend, KineticCafe::ErrorDSL)
+    end
+    assert_match(/cannot extend.*StandardError/, ex.message)
+  end
+
+  it 'cannot be included' do
+    ex = assert_raises RuntimeError do
+      Class.new.send(:include, KineticCafe::ErrorDSL)
+    end
+    assert_match(/cannot be included/, ex.message)
+  end
+
+  describe 'Descendant of Standard Error' do
+    let(:base) {
+      Class.new(StandardError) do
+        extend KineticCafe::ErrorDSL
+      end
+    }
+    let(:instance) { child.new }
+
+    it 'responds to #define_error' do
+      assert base.respond_to?(:define_error)
+    end
+
+    describe '#define_error' do
+      describe 'fails when' do
+        it 'given bad options' do
+          ex = assert_raises ArgumentError do
+            base.define_error 'bad options'
+          end
+          assert_equal 'invalid options', ex.message
+        end
+
+        it 'given empty options' do
+          ex = assert_raises ArgumentError do
+            base.define_error({})
+          end
+          assert_equal 'define what error?', ex.message
+        end
+
+        it 'provided both :key and :class' do
+          ex = assert_raises ArgumentError do
+            base.define_error key: :bar, class: :bar
+          end
+          assert_equal ':key conflicts with class:bar', ex.message
+        end
+
+        it 'missing both :key and :class' do
+          ex = assert_raises ArgumentError do
+            base.define_error status: 300
+          end
+          assert_equal 'one of :key or :class must be provided', ex.message
+        end
+
+        it 'the exception class already exists' do
+          base.define_error class: :bar, status: :missing
+          ex = assert_raises ArgumentError do
+            base.define_error class: :bar, status: :missing
+          end
+          assert_equal 'key:bar_missing already exists as BarMissing with class:bar',
+            ex.message
+        end
+      end
+
+      describe 'key-based definition' do
+        let(:child) { base.define_error key: :child }
+
+        it 'returns "child" for #name' do
+          refute base.public_instance_methods.include?(:name)
+          assert_equal 'child', instance.name
+        end
+
+        it 'returns "kcerrors.child" for #i18n_key' do
+          refute base.public_instance_methods.include?(:i18n_key)
+          assert_equal 'kcerrors.child', instance.i18n_key
+        end
+
+        it 'returns :bad_request for #default_status (private)' do
+          refute base.private_instance_methods.include?(:default_status)
+          assert_equal :bad_request, instance.send(:default_status)
+        end
+
+        it 'returns 400 for #default_status without Rack::Utils (private)' do
+          Rack.stub_remove_const(:Utils) do
+            refute base.private_instance_methods.include?(:default_status)
+            assert_equal 400, instance.send(:default_status)
+          end
+        end
+      end
+
+      describe 'class-based definition' do
+        describe 'without status' do
+          before do
+            KineticCafe.send(:const_set, :TestError, base)
+          end
+
+          after do
+            KineticCafe.send(:remove_const, :TestError)
+          end
+
+          let(:child) { base.define_error class: :child }
+
+          it 'is called ChildTestError' do
+            assert child && base.const_defined?(:ChildTestError)
+          end
+
+          it 'returns "child_test_error" for #name' do
+            refute base.public_instance_methods.include?(:name)
+            assert_equal 'child_test_error', instance.name
+          end
+
+          it 'returns "kcerrors.child_test_error" for #i18n_key' do
+            refute base.public_instance_methods.include?(:i18n_key)
+            assert_equal 'kcerrors.child_test_error', instance.i18n_key
+          end
+
+          it 'returns :bad_request for #default_status (private)' do
+            refute base.private_instance_methods.include?(:default_status)
+            assert_equal :bad_request, instance.send(:default_status)
+          end
+
+          it 'returns 400 for #default_status without Rack::Utils (private)' do
+            Rack.stub_remove_const(:Utils) do
+              refute base.private_instance_methods.include?(:default_status)
+              assert_equal 400, instance.send(:default_status)
+            end
+          end
+        end
+
+        describe 'with symbol status' do
+          let(:child) {
+            base.define_error class: :child, status: :not_found
+          }
+
+          it 'is called ChildNotFound' do
+            assert child && base.const_defined?(:ChildNotFound)
+          end
+
+          it 'returns "child_not_found" for #name' do
+            refute base.public_instance_methods.include?(:name)
+            assert_equal 'child_not_found', instance.name
+          end
+
+          it 'returns "kcerrors.child_not_found" for #i18n_key' do
+            refute base.public_instance_methods.include?(:i18n_key)
+            assert_equal 'kcerrors.child_not_found', instance.i18n_key
+          end
+
+          it 'returns :not_found for #default_status (private)' do
+            refute base.private_instance_methods.include?(:default_status)
+            assert_equal :not_found, instance.send(:default_status)
+          end
+        end
+
+        describe 'with numeric status' do
+          before do
+            KineticCafe.send(:const_set, :TestError, base)
+          end
+
+          after do
+            KineticCafe.send(:remove_const, :TestError)
+          end
+
+          let(:child) { base.define_error class: :child, status: 400 }
+
+          it 'is called ChildTestError' do
+            assert child && base.const_defined?(:ChildTestError)
+          end
+
+          it 'returns "child_test_error" for #name' do
+            refute base.public_instance_methods.include?(:name)
+            assert_equal 'child_test_error', instance.name
+          end
+
+          it 'returns "kcerrors.child_test_error" for #i18n_key' do
+            refute base.public_instance_methods.include?(:i18n_key)
+            assert_equal 'kcerrors.child_test_error', instance.i18n_key
+          end
+
+          it 'returns 400 for #default_status (private)' do
+            refute base.private_instance_methods.include?(:default_status)
+            assert_equal 400, instance.send(:default_status)
+          end
+        end
+      end
+
+      it 'defines #header_only? if requested' do
+        child = base.define_error key: :foo, header_only: true
+        assert child.new.header_only?
+      end
+
+      it 'squeezes out extra underscores' do
+        base.define_error key: :_foo__bar_
+        assert base.const_defined?(:FooBar)
+      end
+
+      it 'defines a new exception descended from the base, in the base namespace' do
+        refute base.const_defined?(:BarMissing)
+        base.define_error class: :bar, status: :missing
+        assert base.const_defined?(:BarMissing)
+        assert base::BarMissing < base
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,305 @@
+--- !ruby/object:Gem::Specification
+name: kinetic_cafe_error
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Austin Ziegler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe-doofus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hoe-gemspec2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: hoe-git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: hoe-rubygems
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hoe-travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: minitest-autotest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-moar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-stub-const
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+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.
+email:
+- aziegler@kineticcafe.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- Contributing.rdoc
+- History.rdoc
+- Licence.rdoc
+- Manifest.txt
+- README.rdoc
+files:
+- ".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
+homepage: https://github.com/KineticCafe/kinetic_cafe_error/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: kinetic_cafe_error provides an API-smart error base class and a DSL for defining
+  errors
+test_files: []