kinetic_cafe_error 1.4.1 → 1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3b2150c91bd7c20a1915ba1f68ec3ac50dc20bf
-  data.tar.gz: a44989aafb6044dcbe837a3d808e3c3bda6400dd
+  metadata.gz: 685467959030041afef309c2d80dee6de147f013
+  data.tar.gz: 0a56fd7578757bb16eabed95380d65a4e6b6e9e1
 SHA512:
-  metadata.gz: 3f730616093adfc5fe2730af14749eafa0333881d04640518a2b75f9dcb53e01b6d636e512e45158de16163a26cac6799301386bb4572cd51cfbf910e3cfc8c1
-  data.tar.gz: 4f8ecaa344b865a66c0d4544940703bc643b41a22b4d7f7c1a19bc26b3e7c92cea72706172d6c709828f875aadf26407b7fad59e144c3dfa716602e991ea0fd8
+  metadata.gz: ff170e4595486ceb5b125626acaa21397e0ea8663d8d86e27444dc058ca3b7584c93b1ed6929c2e6d80d6e351a4fdbc26b39712d93ac44463127b66055a7e430
+  data.tar.gz: c709887413f3535270948786c73fb5641a7038a8d4363adf83afc2151a752f046502d78bb5feb28ec17adfa1d1a42be86e0a746d67e86278b6c06d9bbcc46d3f

data/.travis.yml

@@ -6,8 +6,7 @@ rvm:
   - 2.0.0
   - 1.9.3
   - jruby-1.7
-  - jruby-9.0.0.0.pre2
-  - jruby-19mode
+  - jruby-9.0.0.0
   - jruby-head
   - ruby-head
   - rbx-2
@@ -15,7 +14,6 @@ matrix:
   allow_failures:
     - rvm: rbx-2
     - rvm: jruby-head
-    - rvm: jruby-9.0.0.0.pre2
     - rvm: ruby-head
 gemfile:
   - Gemfile

data/History.rdoc

@@ -1,3 +1,22 @@
+=== 1.5 / 2015-07-28
+
+* 2 bug fixes:
+
+  * Handle error causes correctly for Ruby 2.1 or later, where <tt>raise
+    Exception, cause: RuntimeError.new</tt> does not pass the +cause+ the
+    exception constructor, but it still sets the cause correctly on the
+    exception. These changes make this correct for both +raise+ construction
+    and normal construction.
+
+  * The RSpec helpers did not work because they spelled the class +Rspec+, not
+    +RSpec+. This has been fixed.
+
+* 2 development changes:
+
+  * Fixed some test typos.
+
+  * Add i18n-tasks for CSV exports.
+
 === 1.4.1 / 2015-07-08
 
 * 1 bug fix

data/Rakefile

@@ -35,6 +35,8 @@ spec = Hoe.spec 'kinetic_cafe_error' do
   extra_dev_deps << ['minitest-stub-const', '~> 0.4']
   extra_dev_deps << ['rack-test', '~> 0.6']
   extra_dev_deps << ['rake', '~> 10.0']
+  extra_dev_deps << ['i18n-tasks', '~> 0.8']
+  extra_dev_deps << ['i18n-tasks-csv', '~> 1.0']
   extra_dev_deps << ['rubocop', '~> 0.32']
   extra_dev_deps << ['simplecov', '~> 0.7']
   extra_dev_deps << ['coveralls', '~> 0.8']

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

@@ -28,7 +28,7 @@ module KineticCafe::ErrorHandler
     def kinetic_cafe_error_handler_log_locale(locale = nil)
       self.__kinetic_cafe_error_handler_log_locale = locale if locale
       self.__kinetic_cafe_error_handler_log_locale ||= I18n.default_locale
-      self.__kinetic_cafe_error_handler_log_locale
+      __kinetic_cafe_error_handler_log_locale
     end
   end
 

data/config/i18n-tasks.yml.erb

@@ -109,3 +109,11 @@ ignore_eq_base:
 ## Ignore these keys completely:
 # ignore:
 #  - kaminari.*
+
+<% require 'i18n-tasks-csv' %>
+
+csv:
+  export:
+    - tmp/i18n-export/kinetic_cafe_error.csv
+  import:
+    - tmp/i18n-export/kinetic_cafe_error.csv

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

data/lib/kinetic_cafe/error_module.rb

@@ -9,8 +9,25 @@ module KineticCafe # :nodoc:
     # Extra data relevant to recipients of the exception, provided on
     # construction.
     attr_reader :extra
-    # The exception that caused this exception; provided on construction.
-    attr_reader :cause
+    ##
+    # :attr_reader:
+    # The exception that caused this exception. Provided on exception
+    # construction or automatically through Ruby’s standard exception
+    # mechanism.
+    def cause
+      unless @initialized_cause
+        begin
+          initialize_cause(super) if !@initialized_cause && super
+        rescue NoMethodError
+          # We are suppressing this error because Exception#cause was
+          # implemented in Ruby 2.1.
+          @initialized_cause = true
+          @cause = nil
+        end
+      end
+
+      @cause
+    end
 
     # Create a new error with the given parameters.
     #
@@ -25,7 +42,8 @@ module KineticCafe # :nodoc:
     # +i18n_params+:: The parameters to be sent to I18n.translate with the
     #                 #i18n_key.
     # +cause+:: The exception that caused this error. Used to wrap an earlier
-    #           exception.
+    #           exception. This is only necessary for Ruby before 2.1 or when
+    #           directly initializing the exception.
     # +extra+:: Extra data to be returned in the API representation of this
     #           exception.
     # +query+:: A hash of parameters added to +i18n_params+, typically from
@@ -53,14 +71,13 @@ module KineticCafe # :nodoc:
       @status      = options.delete(:status) || default_status
       @i18n_params = options.delete(:i18n_params) || {}
       @extra       = options.delete(:extra)
-      @cause       = options.delete(:cause)
 
-      @i18n_params.update(cause: cause.message) if cause
+      @initialized_cause = false
+      initialize_cause(options.delete(:cause)) if options.key?(:cause)
 
       query = options.delete(:query)
       @i18n_params.merge!(query: stringify(query)) if query
       @i18n_params.merge!(options)
-      @i18n_params.freeze
     end
 
     # The message associated with this exception. If not provided, defaults to
@@ -161,6 +178,20 @@ module KineticCafe # :nodoc:
         "cause=#{cause}>"
     end
 
+    private
+
+    def initialize_cause(cause)
+      return if cause.nil?
+
+      unless cause.kind_of? Exception
+        fail ArgumentError, 'cause must be an Exception'
+      end
+
+      @initialized_cause = true
+      @cause = cause
+      @i18n_params.update(cause: @cause.message)
+    end
+
     class << self
       ##
       # The base for I18n key resolution. Defaults to 'kcerrors'.

data/lib/kinetic_cafe/error_rspec.rb

@@ -5,8 +5,8 @@ module KineticCafe
   # these with:
   #
   #   require 'kinetic_cafe/error_rspec'
-  #   Rspec.configure do |c|
-  #     c.include KineticCafe::ErrorRspec
+  #   RSpec.configure do |c|
+  #     c.include KineticCafe::ErrorRSpec
   #   end
   #
   # +be_json_for+:: Verifies that the expected value is a JSON representation
@@ -20,8 +20,8 @@ module KineticCafe
   #
   # +be_kc_error_html+:: Verifies that the rendered HTML matches the output of
   #                      KineticCafe::Error.
-  module ErrorRspec
-    extend ::Rspec::Matchers::DSL
+  module ErrorRSpec
+    extend ::RSpec::Matchers::DSL
 
     matcher :be_json_for do |expected|
       match do |actual|

data/test/test_kinetic_cafe_error.rb

@@ -13,7 +13,7 @@ describe KineticCafe::Error do
       end
     end
 
-    describe '#messsage and #i18n_message' do
+    describe '#message 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
@@ -145,4 +145,33 @@ describe KineticCafe::Error do
       assert_empty KineticCafe::Error.i18n_params
     end
   end
+
+  describe 'handles causing exceptions' do
+    before do
+      begin
+        begin
+          fail 'causing'
+        rescue => ex
+          @causing_exception = ex
+          raise KineticCafe::Error, cause: @causing_exception,
+            message: 'wrapping'
+        end
+      rescue => ex
+        @wrapping_exception = ex
+      end
+    end
+
+    it 'captures the causting exception' do
+      refute_nil @wrapping_exception.cause, 'No exception captured'
+      assert_equal @causing_exception, @wrapping_exception.cause
+    end
+
+    it 'puts the cause message in i18n_params when the cause is requested' do
+      refute_nil @wrapping_exception.cause, 'No exception captured'
+      assert_equal(
+        { cause: 'causing' },
+        @wrapping_exception.instance_variable_get(:@i18n_params)
+      )
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kinetic_cafe_error
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: '1.5'
 platform: ruby
 authors:
 - Austin Ziegler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-08 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -206,6 +206,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: i18n-tasks
+  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: i18n-tasks-csv
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -343,7 +371,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: kinetic_cafe_error provides an API-smart error base class and a DSL for defining