kinetic_cafe_error 1.1 → 1.2

data/test/test_helper.rb

@@ -2,8 +2,9 @@
 
 gem 'minitest'
 require 'minitest/autorun'
-require 'minitest/stub_const'
+require 'minitest/focus'
 require 'minitest/moar'
+require 'minitest/stub_const'
 require 'rack/test'
 require 'kinetic_cafe_error'
 

data/test/test_kinetic_cafe_error.rb

@@ -66,16 +66,35 @@ describe KineticCafe::Error do
     end
 
     it 'encodes the :query parameter specially for I18n parameters' do
-      exception = KineticCafe::Error.new(query: { a: 1, b: %w(x y z )})
+      query = {
+        a: 1,
+        b: %w(x y z),
+        c: [ d: 1, e: 2 ],
+        f: []
+      }
+
+      exception = KineticCafe::Error.new(query: query)
       Object.stub_remove_const(:I18n) do
         assert_equal(
           [
             'kcerrors.error',
-            { query: "a: 1; b[]: x, b[]: y, b[]: z" }
+            { query: "a: 1; b[]: x, b[]: y, b[]: z; c[][d]: 1; c[][e]: 2; f[]: []" }
           ],
           exception.i18n_message
         )
       end
     end
+
+    it 'is not #header? by default' do
+      refute exception.header?
+    end
+
+    it 'is not #internal? by default' do
+      refute exception.internal?
+    end
+
+    it 'has no I18n parameters by default' do
+      assert_empty KineticCafe::Error.i18n_params
+    end
   end
 end

data/test/test_kinetic_cafe_error_dsl.rb

@@ -197,8 +197,15 @@ describe KineticCafe::ErrorDSL do
         end
       end
 
-      it 'defines #header_only? if requested' do
-        child = base.define_error key: :foo, header_only: true
+      it 'defines #header? if requested' do
+        child = base.define_error key: :foo, header: true
+        assert child.new.header?
+        assert child.new.header_only?
+      end
+
+      it 'still recognizes #header_only? requests' do
+        child = base.define_error key: :bar, header_only: true
+        assert child.new.header?
         assert child.new.header_only?
       end
 
@@ -213,6 +220,80 @@ describe KineticCafe::ErrorDSL do
         assert base.const_defined?(:BarMissing)
         assert base::BarMissing < base
       end
+
+      it 'has no I18n parameters by default' do
+        child = base.define_error key: :foo
+        assert_equal [], child.i18n_params
+      end
+    end
+  end
+
+  describe 'when Rack::Utils is defined' do
+    it 'defines .not_found by default' do
+      base = Class.new(StandardError) do
+        extend KineticCafe::ErrorDSL
+      end
+      assert base.respond_to?(:not_found)
+
+      child = base.not_found class: :child
+      assert_equal :not_found, child.new.send(:default_status)
+    end
+
+    it 'defines NotFound by default' do
+      base = Class.new(StandardError) do
+        extend KineticCafe::ErrorDSL
+      end
+      assert base.const_defined?(:NotFound)
+    end
+
+    it 'respects the method __rack_status if defined' do
+      base = Class.new(StandardError) do
+        def self.__rack_status
+          { methods: true, errors: false }
+        end
+
+        extend KineticCafe::ErrorDSL
+      end
+
+      assert base.respond_to?(:not_found)
+      refute base.const_defined?(:NotFound)
+    end
+  end
+
+  describe 'when Rack::Utils is not defined' do
+    it 'does not define .not_found' do
+      Rack.stub_remove_const(:Utils) do
+        base = Class.new(StandardError) do
+          extend KineticCafe::ErrorDSL
+        end
+
+        refute base.respond_to?(:not_found)
+      end
+    end
+
+    it 'does not define NotFound' do
+      Rack.stub_remove_const(:Utils) do
+        base = Class.new(StandardError) do
+          extend KineticCafe::ErrorDSL
+        end
+
+        refute base.const_defined?(:NotFound)
+      end
+    end
+
+    it 'ignores __rack_status if defined' do
+      Rack.stub_remove_const(:Utils) do
+        base = Class.new(StandardError) do
+          def self.__rack_status
+            { methods: true, errors: false }
+          end
+
+          extend KineticCafe::ErrorDSL
+        end
+
+        refute base.respond_to?(:not_found)
+        refute base.const_defined?(:NotFound)
+      end
     end
   end
 end

data/test/test_kinetic_cafe_error_hierarchy.rb

@@ -0,0 +1,147 @@
+require 'test_helper'
+require 'rack/test'
+
+describe KineticCafe::Error, '.hierarchy' do
+  describe '(class: :My)' do
+    def my(&block)
+      KineticCafe::Error.hierarchy(class: :My, &block)
+    end
+
+    it 'creates a new object' do
+      my
+      assert Object.const_defined?(:My)
+    end
+
+    it 'descends from KineticCafe::Error' do
+      my
+      assert My < KineticCafe::Error
+    end
+
+    it 'has been extended with KineticCafe::ErrorDSL' do
+      my
+      assert My.singleton_class < KineticCafe::ErrorDSL
+    end
+
+    it 'yields self if a block with an argument is given' do
+      my do |err|
+        assert_same My, err
+      end
+    end
+
+    it 'runs instance_exec against self if a no-argument block is given' do
+      assert my { My == self }
+    end
+
+    it 'cannot be extended a second time' do
+      my
+      ex = assert_raises do
+        KineticCafe::Error.hierarchy(class: :My)
+      end
+      assert_match(/is already a root hierarchy/, ex.message)
+    end
+
+    after do
+      Object.send(:remove_const, :My) if Object.const_defined?(:My)
+    end
+  end
+
+  describe '(class: :My, namespace: Foo)' do
+    before do
+      Foo = Module.new
+      KineticCafe::Error.hierarchy(class: :My, namespace: Foo)
+    end
+
+    it 'creates a new object' do
+      assert Foo.const_defined?(:My)
+    end
+
+    it 'descends from KineticCafe::Error' do
+      assert Foo::My < KineticCafe::Error
+    end
+
+    it 'has been extended with KineticCafe::ErrorDSL' do
+      assert Foo::My.singleton_class < KineticCafe::ErrorDSL
+    end
+
+    it 'cannot be extended a second time' do
+      ex = assert_raises do
+        KineticCafe::Error.hierarchy(class: :My, namespace: Foo)
+      end
+      assert_match(/is already a root hierarchy/, ex.message)
+    end
+
+    after do
+      Foo.send(:remove_const, :My) if Foo.const_defined?(:My)
+      Object.send(:remove_const, :Foo) if Object.const_defined?(:Foo)
+    end
+  end
+
+  describe '(class: My)' do
+    describe 'when My is a StandardError' do
+      before do
+        My = Class.new(StandardError)
+        KineticCafe::Error.hierarchy(class: My)
+      end
+
+      it 'has been extended with KineticCafe::ErrorDSL' do
+        assert My.singleton_class < KineticCafe::ErrorDSL
+      end
+
+      it 'has KineticCafe::ErrorModule included' do
+        assert My < KineticCafe::ErrorModule
+      end
+
+      it 'cannot be extended a second time' do
+        ex = assert_raises do
+          KineticCafe::Error.hierarchy(class: :My)
+        end
+        assert_match(/is already a root hierarchy/, ex.message)
+      end
+
+      after do
+        Object.send(:remove_const, :My) if Object.const_defined?(:My)
+      end
+    end
+
+    it 'fails if My is not an Exception' do
+      ex = assert_raises do
+        KineticCafe::Error.hierarchy(class: Class.new)
+      end
+      assert_match(/cannot root.*StandardError/, ex.message)
+    end
+
+    it 'fails if My is not a StandardError' do
+      assert_raises do
+        KineticCafe::Error.hierarchy(class: Class.new(Exception))
+      end
+    end
+  end
+
+  describe '(class: :My, rack_status: option)' do
+    def my(option, &block)
+      KineticCafe::Error.hierarchy(class: :My, rack_status: option, &block)
+    end
+
+    it 'disables method and object creation when rack_status: false' do
+      my(false)
+      refute My.const_defined?(:NotFound)
+      refute My.respond_to?(:not_found)
+    end
+
+    it 'disables method creation when rack_status: { methods: false }' do
+      my(methods: false)
+      assert My.const_defined?(:NotFound)
+      refute My.respond_to?(:not_found)
+    end
+
+    it 'disables object creation when rack_status: { errors: false }' do
+      my(errors: false)
+      refute My.const_defined?(:NotFound)
+      assert My.respond_to?(:not_found)
+    end
+
+    after do
+      Object.send(:remove_const, :My) if Object.const_defined?(:My)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kinetic_cafe_error
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.2'
 platform: ruby
 authors:
 - Austin Ziegler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -238,7 +238,12 @@ 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.
+  to handle KineticCafe::Error types.
+
+  Exceptions in a hierarchy can be handled in a uniform manner, including getting
+  an I18n translation message with parameters, standard status values, and
+  meaningful JSON representations that can be used to establish a standard error
+  representations across both clients and servers.
 email:
 - aziegler@kineticcafe.com
 executables: []
@@ -278,11 +283,14 @@ files:
 - lib/kinetic_cafe/error/minitest.rb
 - lib/kinetic_cafe/error_dsl.rb
 - lib/kinetic_cafe/error_engine.rb
+- lib/kinetic_cafe/error_module.rb
 - lib/kinetic_cafe/error_rspec.rb
+- lib/kinetic_cafe/error_tasks.rake
 - lib/kinetic_cafe_error.rb
 - test/test_helper.rb
 - test/test_kinetic_cafe_error.rb
 - test/test_kinetic_cafe_error_dsl.rb
+- test/test_kinetic_cafe_error_hierarchy.rb
 homepage: https://github.com/KineticCafe/kinetic_cafe_error/
 licenses:
 - MIT