kinetic_cafe_error 1.5 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 685467959030041afef309c2d80dee6de147f013
-  data.tar.gz: 0a56fd7578757bb16eabed95380d65a4e6b6e9e1
+  metadata.gz: 37643698d0f31692802e45814d1ef9fa5dd03bb1
+  data.tar.gz: 91419c4aa9df887087a7629c4b6e4e2a4a140554
 SHA512:
-  metadata.gz: ff170e4595486ceb5b125626acaa21397e0ea8663d8d86e27444dc058ca3b7584c93b1ed6929c2e6d80d6e351a4fdbc26b39712d93ac44463127b66055a7e430
-  data.tar.gz: c709887413f3535270948786c73fb5641a7038a8d4363adf83afc2151a752f046502d78bb5feb28ec17adfa1d1a42be86e0a746d67e86278b6c06d9bbcc46d3f
+  metadata.gz: 5415ff4c3bc5b8b5e75b104bfc1bb453450964ca850a9844b7b0895486826e21dbd6405d64c0e320a7822b9c3412941fb11c2c7d30161b1e10aaa434b706c9a3
+  data.tar.gz: ea8288a297cf85abc62c1420f83f3f6c6bbc68a193e97fc8812845ed6ceb39b92b6d0b8cc57d4d5269b84a0042c8ff4abfe79b9a4005d1a95e3d2fbec3fd7751

data/History.rdoc

@@ -1,4 +1,18 @@
-=== 1.5 / 2015-07-28
+=== 1.6 / 2015-07-30
+
+* 2 minor enhancements:
+
+  * Improve the Minitest and RSpec test helpers so that they ignore the error
+    +cause+ if it is not included as part of the assertion. The specification
+    of the +cause+ is recommended if you have specific values you want to
+    compare.
+
+  * Improve +kinetic_cafe_error_handler+ so that if it is called with an error
+    class instead of an instance of an error, it will construct the error
+    instance with the provided parameters. This makes custom +rescue_from+
+    constructions cleaner.
+
+=== 1.5 / 2015-07-29
 
 * 2 bug fixes:
 

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

@@ -40,7 +40,28 @@ module KineticCafe::ErrorHandler
   # 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)
+  #
+  # As an option, +kinetic_cafe_error_handler+ can also be used in a
+  # +rescue_from+ block with an error class and parameters, and it will
+  # construct the error for handling. The following example assumes that there
+  # is an error called ObjectNotFound.
+  #
+  #   rescue_from ActiveRecord::NotFound do |error|
+  #     kinetic_cafe_error_handler KineticCafe::Error::ObjectNotFound,
+  #       cause: error
+  #   end
+  #
+  # This would be the same as:
+  #
+  #   rescue_from ActiveRecord::NotFound do |error|
+  #     kinetic_cafe_error_handler KineticCafe::Error::ObjectNotFound.new(
+  #       cause: error
+  #     )
+  #   end
+  def kinetic_cafe_error_handler(error, error_params = {})
+    # If the error provided is actually an error class, make an error instance.
+    error.kind_of?(KineticCafe::ErrorDSL) && error = error.new(error_params)
+
     kinetic_cafe_error_log_error(error)
 
     respond_to do |format|

data/lib/kinetic_cafe/error/minitest.rb

@@ -4,6 +4,9 @@ module Minitest #:nodoc:
     # Assert that the +actual+ exception received is the +expected+ descendant
     # of KineticCafe::Error and that it has been constructed with the same
     # +params+ provided.
+    #
+    # If a +cause+ is not provided, any cause on the received error will be
+    # ignored.
     def assert_kc_error expected, actual, params = {}, msg = nil
       msg, params = params, {} if msg.nil? && params.kind_of?(String)
 
@@ -13,6 +16,15 @@ module Minitest #:nodoc:
       assert_kind_of expected, actual,
         msg || "Expected #{actual} to be #{expected}, but it was not."
 
+      unless params.key?(:cause)
+        actual = actual.dup
+        actual.instance_variable_set(:@cause, nil)
+        actual.instance_variable_set(:@initialized_cause, true)
+        actual.instance_variable_get(:@i18n_params).tap do |params|
+          params.delete(:cause)
+        end
+      end
+
       expected = expected.new(params)
       assert_equal expected, actual,
         msg || "Expected #{actual} to be #{expected}, but it was not."
@@ -26,11 +38,26 @@ module Minitest #:nodoc:
     # output is compared, not KineticCafe::Error objects. The JSON for the
     # provided KineticCafe::Error object is generated through
     # KineticCafe::Error#error_json.
+    #
+    # If a +cause+ is not provided, any cause on the received error will be
+    # ignored.
     def assert_kc_error_json expected, actual, params = {}, msg = nil
       msg, params = params, {} if msg.nil? && params.kind_of?(String)
 
       msg ||= "Expected #{actual} to be JSON for #{expected}, but it was not."
       actual = JSON.parse(actual)
+
+      unless params.key?(:cause)
+        actual['error'].tap do |error|
+          error.delete('cause')
+          if error['i18n_params']
+            error['i18n_params'].delete('cause')
+            error.delete('i18n_params') if error['i18n_params'].empty?
+          end
+        end
+        actual
+      end
+
       expected = JSON.parse(expected.new(params).error_result.to_json)
 
       assert_equal expected, actual, msg

data/lib/kinetic_cafe/error.rb

@@ -25,7 +25,7 @@ module KineticCafe # :nodoc:
   # rescue clause and handled there, as is shown in the included
   # KineticCafe::ErrorHandler controller concern for Rails.
   class Error < ::StandardError
-    VERSION = '1.5' # :nodoc:
+    VERSION = '1.6' # :nodoc:
 
     # Get the KineticCafe::Error functionality.
     include KineticCafe::ErrorModule

data/lib/kinetic_cafe/error_module.rb

@@ -73,6 +73,7 @@ module KineticCafe # :nodoc:
       @extra       = options.delete(:extra)
 
       @initialized_cause = false
+      @cause = nil
       initialize_cause(options.delete(:cause)) if options.key?(:cause)
 
       query = options.delete(:query)

data/lib/kinetic_cafe/error_rspec.rb

@@ -40,6 +40,16 @@ module KineticCafe
       match do |actual|
         expect(actual).to be_kind_of(KineticCafe::ErrorModule)
         expect(actual).to be_kind_of(expected)
+
+        unless params.key?(:cause)
+          actual = actual.dup
+          actual.instance_variable_set(:@cause, nil)
+          actual.instance_variable_set(:@initialized_cause, true)
+          actual.instance_variable_get(:@i18n_params).tap do |params|
+            params.delete(:cause)
+          end
+        end
+
         expect(actual).to eq(expected.new(params))
       end
 
@@ -48,6 +58,17 @@ module KineticCafe
 
     matcher :be_kc_error_json do |expected, params = {}|
       match do |actual|
+        unless params.key?(:cause)
+          actual['error'].tap do |error|
+            error.delete('cause')
+            if error['i18n_params']
+              error['i18n_params'].delete('cause')
+              error.delete('i18n_params') if error['i18n_params'].empty?
+            end
+          end
+          actual
+        end
+
         expect(actual).to \
           be_json_for(JSON.parse(expected.new(params).error_result.to_json))
       end

data/test/test_kinetic_cafe_error.rb

@@ -161,7 +161,7 @@ describe KineticCafe::Error do
       end
     end
 
-    it 'captures the causting exception' do
+    it 'captures the causing exception' do
       refute_nil @wrapping_exception.cause, 'No exception captured'
       assert_equal @causing_exception, @wrapping_exception.cause
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kinetic_cafe_error
 version: !ruby/object:Gem::Version
-  version: '1.5'
+  version: '1.6'
 platform: ruby
 authors:
 - Austin Ziegler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-28 00:00:00.000000000 Z
+date: 2015-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest