kinetic_cafe_error 1.2 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f729db0dc8d7bd5d7299f904a9731348d5d22d0
-  data.tar.gz: 5f2cca7f8b42a6cfb4cc6cb45b6f4bc8602ac762
+  metadata.gz: 210985e1268b5a3d32fb0a46c69d854eb5523073
+  data.tar.gz: 0b2185f4a90efb887bf48af8a435646a79fe1900
 SHA512:
-  metadata.gz: 2172f4681a2163199a49c1a099d84a50d6853db13db34e3462df7944239d8922c4e4e25c066ad170d8b82b4331d8ad9a33af00aae8da9b31a6b1e4449d84bb82
-  data.tar.gz: a134be803972f943ee5189ac97530f15c5bda8756b146d2c3996d4e89f99a9e72bd34733dc8bdc2a0860b1c92a78619d8064a4767d1859648d330dbbf8f0ea59
+  metadata.gz: 8627e47d35629f7a6c8c6b58bb71036cf5cb0c2474cc752e4c033c3d8c678b2c22029ccc80552f5e98688f1e131863481d0e1391257d2f9f1a084e3e940639c4
+  data.tar.gz: 4e0d19ba153eb3d6f3ee7367ad6eeaecac5ac9abf0e7e26b3ae11db16e00042603c0bedcbcadbe10edba9fd99fa449fd0198a307062fe7d0ad60fc511ecd00ac

data/History.rdoc

@@ -1,3 +1,29 @@
+=== 1.3 / 2015-06-18
+
+* 3 minor enhancements
+
+  * Added a controller method, kinetic_cafe_error_handler_log_error, in
+    KineticCafe::ErrorHandler that will log the given error in the default
+    logging language, and its cause, if any.
+
+  * Added a controller class method to change the default logging language for
+    kinetic_cafe_error_handler_log_error. A locale may be provided with
+    kinetic_cafe_error_handler_log_locale. Fixes
+    [#2]{https://github.com/KineticCafe/kinetic_cafe_error/issues/2}.
+
+  * Added an optional +locale+ parameter to KineticCafe::ErrorModule#message
+    and KineticCafe::ErrorModule::#i18n_message. If I18n is present and
+    +locale+ is provided, the translation will *not* be cached and the
+    translation will be performed using the provided locale.
+
+* 1 bug fixed
+
+  * The Minitest assertion, assert_kc_error, could not work because it was
+    looking for descendants of KineticCafe::ErrorDSL, not
+    KineticCafe::ErrorModule. Reported by @richardsondx as
+    [#3]{https://github.com/KineticCafe/kinetic_cafe_error/issues/3} during a
+    pairing session.
+
 === 1.2 / 2015-06-08
 
 * 1 major enhancement

data/README.rdoc

@@ -60,6 +60,10 @@ automatically injected, which enables the following functionality:
 
   #kinetic_cafe_error_handler distinguishes between HTML and JSON contexts.
 
+  The error will be logged in a single language, with a configuration option
+  that can be provided with the kinetic_cafe_error_handler_log_locale helper
+  method.
+
 === Using with Minitest
 
 KineticCafe::Error provides a number of assertions that can help testing that

data/Rakefile

@@ -32,6 +32,7 @@ spec = Hoe.spec "kinetic_cafe_error" do
   extra_dev_deps << ['hoe-travis', '~> 1.2']
   extra_dev_deps << ['minitest', '~> 5.4']
   extra_dev_deps << ['minitest-autotest', '~> 1.0']
+  extra_dev_deps << ['minitest-bonus-assertions', '~> 1.0']
   extra_dev_deps << ['minitest-focus', '~> 1.1']
   extra_dev_deps << ['minitest-moar', '~> 0.0']
   extra_dev_deps << ['minitest-stub-const', '~> 0.4']

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

@@ -17,20 +17,29 @@ module KineticCafe::ErrorHandler
     def kinetic_cafe_error_handler_for(klass)
       rescue_from klass, with: :kinetic_cafe_error_handler
     end
+
+    # Logging should be done in a single language, not many languages. By
+    # default, KineticCafe::Error will log errors received in the locale
+    # specified by I18n.default_locale. This method can be used to change the
+    # common logging locale for KineticCafe::Error handling without changing
+    # I18n.default_locale.
+    def kinetic_cafe_error_handler_log_locale(locale = nil)
+      @@kinetic_cafe_error_handler_log_locale = locale if locale
+      @@kinetic_cafe_error_handler_log_locale ||= I18n.default_locale
+      @@kinetic_cafe_error_handler_log_locale
+    end
   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.
+  # logging as +error+, it will render to HTML or JSON. The received error is
+  # logged using the value of #kinetic_cafe_error_handler_log_locale.
   #
   # 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)
-    if error.cause
-      Rails.logger.error(t('kinetic_cafe_error.cause', error.cause.message))
-    end
+    kinetic_cafe_error_log_error(error)
 
     respond_to do |format|
       format.html do
@@ -68,4 +77,21 @@ module KineticCafe::ErrorHandler
       render error.json_result
     end
   end
+
+  # Write the provided error to the Rails log using the value of
+  # #kinetic_cafe_error_handler_log_locale. If the error has a cause, log
+  # that as well.
+  def kinetic_cafe_error_log_error(error)
+    locale = self.class.kinetic_cafe_error_handler_log_locale
+    Rails.logger.error(error.message(locale))
+    if error.cause
+      Rails.logger.error(
+        t(
+          'kinetic_cafe_error.cause',
+          message: error.cause.message,
+          locale: locale
+        )
+      )
+    end
+  end
 end

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.2' # :nodoc:
+    VERSION = '1.3' # :nodoc:
 
     # Get the KineticCafe::Error functionality.
     include KineticCafe::ErrorModule

data/lib/kinetic_cafe/error/minitest.rb

@@ -7,7 +7,7 @@ module Minitest #:nodoc:
     def assert_kc_error expected, actual, params = {}, msg = nil
       msg, params = params, {} if msg.nil? && params.kind_of?(String)
 
-      assert_kind_of KineticCafe::ErrorDSL, actual,
+      assert_kind_of KineticCafe::ErrorModule, actual,
         msg || "Expected #{actual} to be #{expected}, but it was not."
 
       assert_kind_of expected, actual,

data/lib/kinetic_cafe/error_module.rb

@@ -64,9 +64,9 @@ module KineticCafe # :nodoc:
     end
 
     # The message associated with this exception. If not provided, defaults to
-    # #i18n_message.
-    def message
-      @message || i18n_message
+    # #i18n_message, which is passed the optional +locale+.
+    def message(locale = nil)
+      @message || i18n_message(locale)
     end
 
     # The name of the error class.
@@ -99,14 +99,28 @@ module KineticCafe # :nodoc:
       false
     end
 
-    # The I18n translation of the message. If I18n.translate is defined,
-    # returns #i18n_key and the I18n parameters.
-    def i18n_message
-      @i18n_message ||= if defined?(I18n.translate)
-                          I18n.translate(i18n_key, @i18n_params).freeze
-                        else
-                          [ i18n_key, @i18n_params ].freeze
-                        end
+    # The I18n translation of the message. If I18n.translate is not defined,
+    # returns #i18n_key and the I18n parameters as an array.
+    #
+    # If I18n is provided, the translation will be performed using the default
+    # locale. The message will be cached unless +locale+ is provided, which
+    # selects a specific locale for translation.
+    #
+    # +locale+ may be provided as a bare locale (<tt>:en</tt>) or as a hash
+    # value (<tt>locale: :en</tt>).
+    def i18n_message(locale = nil)
+      if defined?(I18n.translate)
+        case locale
+        when Hash
+          I18n.translate(i18n_key, @i18n_params.merge(locale))
+        when nil
+          @i18n_message ||= I18n.translate(i18n_key, @i18n_params).freeze
+        else
+          I18n.translate(i18n_key, @i18n_params.merge(locale: locale))
+        end
+      else
+        @i18n_message ||= [ i18n_key, @i18n_params ].freeze
+      end
     end
 
     # The details of this error as a hash. Values that are empty or nil are

data/test/test_helper.rb

@@ -5,6 +5,7 @@ require 'minitest/autorun'
 require 'minitest/focus'
 require 'minitest/moar'
 require 'minitest/stub_const'
+require 'minitest-bonus-assertions'
 require 'rack/test'
 require 'kinetic_cafe_error'
 

data/test/test_kinetic_cafe_error.rb

@@ -13,9 +13,77 @@ describe KineticCafe::Error do
       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
+    describe '#messsage and #i18n_message' do
+      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 'encodes the :query parameter specially for I18n parameters' do
+        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; c[][d]: 1; c[][e]: 2; f[]: []" }
+            ],
+            exception.i18n_message
+          )
+        end
+      end
+
+      it 'calls I18n.translate if defined' do
+        matcher = ->(key, options) {
+          assert_equal 'kcerrors.error', key
+          assert_kind_of Hash, options
+          assert_missing_keys options, :locale
+        }
+
+        stub I18n, :translate, matcher do
+          exception.i18n_message
+        end
+      end
+
+      it 'calls I18n.translate with a bare locale if given one' do
+        matcher = ->(key, options) {
+          assert_equal 'kcerrors.error', key
+          assert_kind_of Hash, options
+          assert_has_keys options, :locale
+          assert_equal :kc, options[:locale]
+        }
+
+        stub I18n, :translate, matcher do
+          exception.i18n_message(:kc)
+        end
+      end
+
+      it 'calls I18n.translate with a hash locale if given one' do
+        matcher = ->(key, options) {
+          assert_equal 'kcerrors.error', key
+          assert_kind_of Hash, options
+          assert_has_keys options, :locale
+          assert_equal :kc, options[:locale]
+        }
+
+        stub I18n, :translate, matcher do
+          exception.i18n_message(locale: :kc)
+        end
+      end
+
+      it '#message fowards to #i18n_message if no @message' do
+        stub exception, :i18n_message do
+          exception.message
+        end
+
+        assert_instance_called exception, :i18n_message
       end
     end
 
@@ -65,26 +133,6 @@ describe KineticCafe::Error do
       )
     end
 
-    it 'encodes the :query parameter specially for I18n parameters' do
-      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; c[][d]: 1; c[][e]: 2; f[]: []" }
-          ],
-          exception.i18n_message
-        )
-      end
-    end
-
     it 'is not #header? by default' do
       refute exception.header?
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kinetic_cafe_error
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.3'
 platform: ruby
 authors:
 - Austin Ziegler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-08 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-bonus-assertions
+  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