kinetic_cafe_error 1.10 → 1.11

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'active_support/concern'
 
 # A controller concern for KineticCafe::Error that rescues from
@@ -71,13 +72,17 @@ module KineticCafe::ErrorHandler
 
     kinetic_cafe_error_log_error(error)
 
-    respond_to do |format|
-      format.html do
-        kinetic_cafe_error_render_html(error)
-      end
-      format.json do
-        kinetic_cafe_error_render_json(error)
+    if respond_to?(:respond_to)
+      respond_to do |format|
+        format.html do
+          kinetic_cafe_error_render_html(error)
+        end
+        format.json do
+          kinetic_cafe_error_render_json(error)
+        end
       end
+    else
+      kinetic_cafe_error_render_json(error)
     end
 
     kinetic_cafe_error_handle_post_error(error)
@@ -88,7 +93,7 @@ module KineticCafe::ErrorHandler
   # to <tt>error.status</tt>.
   def kinetic_cafe_error_render_html(error)
     render template: 'kinetic_cafe_error/page', locals: { error: error },
-      status: error.status
+           status: error.status
   end
 
   # Render the +error+ as JSON. If it is KineticCafe::Error#header_only?, only

data/lib/kinetic_cafe/error.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'error_module'
 
 module KineticCafe # :nodoc:
@@ -25,7 +26,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.10' # :nodoc:
+    VERSION = '1.11' # :nodoc:
 
     # Get the KineticCafe::Error functionality.
     include KineticCafe::ErrorModule

data/lib/kinetic_cafe/error/minitest.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Minitest #:nodoc:
   # Add assertions to Minitest for testing KineticCafe::Error objects.
   module KineticCafeErrorAssertions
@@ -20,8 +21,8 @@ module Minitest #:nodoc:
         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)
+        actual.instance_variable_get(:@i18n_params).tap do |hash|
+          hash.delete(:cause)
         end
       end
 

data/lib/kinetic_cafe/error_dsl.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 module KineticCafe
   # Make defining new children of KineticCafe::Error easy. Adds the
   # #define_error method.
@@ -17,7 +18,7 @@ module KineticCafe
         name.underscore.freeze
       else
         name.dup.tap { |n|
-          n.gsub!(/[[:upper:]]/) { "_#$&".downcase }
+          n.gsub!(/[[:upper:]]/) do "_#{$&}".downcase end
           n.sub!(/^_/, '')
         }.freeze
       end
@@ -46,7 +47,7 @@ module KineticCafe
       if name.respond_to?(:camelize)
         name.camelize.freeze
       else
-        "_#{name}".gsub(/_([a-z])/i) { $1.upcase }.freeze
+        "_#{name}".gsub(/_([a-z])/i) { Regexp.last_match(1).upcase }.freeze
       end
     end
 
@@ -87,9 +88,7 @@ module KineticCafe
 
       klass = options.delete(:class)
       if klass
-        if options.key?(:key)
-          fail ArgumentError, ":key conflicts with class:#{klass}"
-        end
+        fail ArgumentError, ":key conflicts with class:#{klass}" if options.key?(:key)
 
         key = if status.kind_of?(Symbol) || status.kind_of?(String)
                 "#{klass}_#{KineticCafe::ErrorDSL.namify(status)}"
@@ -112,8 +111,8 @@ module KineticCafe
 
       error_name = KineticCafe::ErrorDSL.camelize(key)
       i18n_key_base = respond_to?(:i18n_key_base) && self.i18n_key_base ||
-        'kcerrors'.freeze
-      i18n_key = "#{i18n_key_base}.#{key}".freeze
+        'kcerrors'
+      i18n_key = "#{i18n_key_base}.#{key}"
 
       if const_defined?(error_name)
         message = "key:#{key} already exists as #{error_name}"
@@ -152,8 +151,6 @@ module KineticCafe
       const_set(error_name, error)
     end
 
-    private
-
     ##
     def self.included(_mod)
       fail "#{self} cannot be included"

data/lib/kinetic_cafe/error_engine.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module KineticCafe
   # If Rails is defined, KineticCafe::ErrorEngine will be loaded automatically,
   # providing access to the KineticCafe::ErrorHandler.

data/lib/kinetic_cafe/error_module.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module KineticCafe # :nodoc:
   # The core functionality provided by a KineticCafe::Error, extracted to a
   # module to ensure that exceptions that are made hosts of error hierarchies
@@ -83,7 +84,7 @@ module KineticCafe # :nodoc:
       initialize_cause(options.delete(:cause)) if options.key?(:cause)
 
       query = options.delete(:query)
-      @i18n_params.merge!(query: stringify(query)) if query
+      @i18n_params[:query] = stringify(query) if query
       @i18n_params.merge!(options)
     end
 
@@ -103,19 +104,17 @@ module KineticCafe # :nodoc:
       @i18n_key ||= if self.class.respond_to? :i18n_key
                       self.class.i18n_key
                     else
-                      [
-                        i18n_key_base, (name)
-                      ].join('.').freeze
+                      [ i18n_key_base, name ].join('.').freeze
                     end
     end
-    alias_method :code, :i18n_key
+    alias code i18n_key
 
     # Indicates that this error should *not* have its details rendered to the
     # user, but should use the +head+ method.
     def header?
       false
     end
-    alias_method :header_only?, :header?
+    alias header_only? header?
 
     # Indicates that this error should be rendered to the client, but clients
     # are advised *not* to display the message to the user.
@@ -163,7 +162,7 @@ module KineticCafe # :nodoc:
         extra:        extra
       }.delete_if { |_, v| v.nil? || (v.respond_to?(:empty?) && v.empty?) }
     end
-    alias_method :as_json, :api_error
+    alias as_json api_error
 
     # An error result that can be passed as a response body.
     def error_result
@@ -176,7 +175,7 @@ module KineticCafe # :nodoc:
     def json_result
       { status: status, json: error_result, layout: false }
     end
-    alias_method :render_json_for_rails, :json_result
+    alias render_json_for_rails json_result
 
     # Nice debugging version of a KineticCafe::Error
     def inspect
@@ -191,9 +190,7 @@ module KineticCafe # :nodoc:
     def initialize_cause(cause)
       return if cause.nil?
 
-      unless cause.kind_of? Exception
-        fail ArgumentError, 'cause must be an Exception'
-      end
+      fail ArgumentError, 'cause must be an Exception' unless cause.kind_of? Exception
 
       @initialized_cause = true
       @cause = cause
@@ -212,7 +209,7 @@ module KineticCafe # :nodoc:
     end
 
     def stringify_hash(hash, namespace)
-      hash.collect do |key, value|
+      hash.map do |key, value|
         key = namespace ? "#{namespace}[#{key}]" : key
         case value
         when Hash
@@ -231,7 +228,7 @@ module KineticCafe # :nodoc:
       if array.empty?
         stringify_value(key, [])
       else
-        array.collect { |value| stringify(value, key) }.join(', ')
+        array.map { |value| stringify(value, key) }.join(', ')
       end
     end
 
@@ -268,7 +265,7 @@ module KineticCafe # :nodoc:
       ##
       def included(mod)
         default_singleton_method mod, :i18n_key_base do
-          'kcerrors'.freeze
+          'kcerrors'
         end
 
         default_singleton_method mod, :i18n_params do

data/lib/kinetic_cafe/error_rspec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rspec/expectations'
 
 module KineticCafe
@@ -45,8 +46,8 @@ module KineticCafe
           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)
+          actual.instance_variable_get(:@i18n_params).tap do |hash|
+            hash.delete(:cause)
           end
         end
 

data/lib/kinetic_cafe/error_tasks.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 module KineticCafe
-  module ErrorTasks
+  # Tasks to assist with managing kinetic_cafe_error classes in Rake.
+  module ErrorTasks #:nodoc:
     extend Rake::DSL
   end
 end
 
-module KineticCafe::ErrorTasks
+##
+module KineticCafe::ErrorTasks #:nodoc:
   require 'kinetic_cafe_error'
 
   namespace :kcerror do
     desc 'Show defined errors.'
     task :defined, [ :params ] => 'kcerror:find' do |_, args|
-      show_params = args.params =~ /^y/i
-
       display = ->(root, prefix: '', show_params: false) {
         line = "#{prefix}- #{root}"
 
         if !root.i18n_params.empty? && show_params
-          line << " (" << root.i18n_params.join(', ') << ")"
+          line << ' (' << root.i18n_params.join(', ') << ')'
         end
 
         puts line
@@ -34,6 +36,8 @@ module KineticCafe::ErrorTasks
         end
       }
 
+      show_params = args.params =~ /^y/i
+
       if @descendants[StandardError]
         @descendants[StandardError].sort_by(&:to_s).each { |d|
           display.(d, show_params: show_params)
@@ -53,9 +57,9 @@ module KineticCafe::ErrorTasks
         params = root.i18n_params.map { |param| "%{#{param}}" }.join(' ')
 
         if params.empty?
-          translation[name] = %Q(Translation for #{name} with no params.)
+          translation[name] = "Translation for #{name} with no params."
         else
-          translation[name] = %Q(Translation for #{name} with #{params}.)
+          translation[name] = "Translation for #{name} with #{params}."
         end
 
         if @descendants[root]
@@ -64,19 +68,19 @@ module KineticCafe::ErrorTasks
       }
 
       if @descendants[StandardError]
-        @descendants[StandardError].sort_by(&:to_s).each { |d| traverse.(d) }
+        @descendants[StandardError].sort_by(&:to_s).each do |d| traverse.(d) end
 
         # Normal YAML dump does not match the pattern that we want to compare
         # against. Therefore, we are going to write this file manually.
         text = 'kc:'
 
-        translations.keys.sort.each { |group|
+        translations.keys.sort.each do |group|
           text << "\n  #{group}:"
 
           translations[group].keys.sort.each { |k|
             text << "\n    #{k}: >-\n      #{translations[group][k]}"
           }
-        }
+        end
 
         if args.output
           File.open(args.output, 'w') { |f| f.puts text }

data/lib/kinetic_cafe_error.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 require 'kinetic_cafe/error'

data/test/test_helper.rb

@@ -1,4 +1,5 @@
 # -*- ruby encoding: utf-8 -*-
+# frozen_string_literal: true
 
 gem 'minitest'
 require 'minitest/autorun'

data/test/test_kinetic_cafe_error.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 describe KineticCafe::Error do
@@ -156,8 +157,7 @@ describe KineticCafe::Error do
           fail 'causing'
         rescue => ex
           @causing_exception = ex
-          raise KineticCafe::Error, cause: @causing_exception,
-            message: 'wrapping'
+          raise KineticCafe::Error, cause: @causing_exception, message: 'wrapping'
         end
       rescue => ex
         @wrapping_exception = ex

data/test/test_kinetic_cafe_error_dsl.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 require 'rack/test'
 
@@ -262,9 +263,9 @@ describe KineticCafe::ErrorDSL do
 
   describe 'when Rack::Utils is defined' do
     it 'defines .not_found by default' do
-      base = Class.new(StandardError) do
+      base = Class.new(StandardError) {
         extend KineticCafe::ErrorDSL
-      end
+      }
       assert base.respond_to?(:not_found)
 
       child = base.not_found class: :child
@@ -272,20 +273,20 @@ describe KineticCafe::ErrorDSL do
     end
 
     it 'defines NotFound by default' do
-      base = Class.new(StandardError) do
+      base = Class.new(StandardError) {
         extend KineticCafe::ErrorDSL
-      end
+      }
       assert base.const_defined?(:NotFound)
     end
 
     it 'respects the method __rack_status if defined' do
-      base = Class.new(StandardError) do
+      base = Class.new(StandardError) {
         def self.__rack_status
           { methods: true, errors: false }
         end
 
         extend KineticCafe::ErrorDSL
-      end
+      }
 
       assert base.respond_to?(:not_found)
       refute base.const_defined?(:NotFound)
@@ -294,14 +295,13 @@ describe KineticCafe::ErrorDSL do
     it 'protects against badly named Rack status symbols' do
       begin
         Rack::Utils::SYMBOL_TO_STATUS_CODE[:"another_(silly)_love_song"] = 999
-        base = Class.new(StandardError) do
+        base = Class.new(StandardError) {
           extend KineticCafe::ErrorDSL
-        end
+        }
         assert base.respond_to?(:another_silly_love_song)
         assert base.const_defined?(:AnotherSillyLoveSong)
       ensure
         Rack::Utils::SYMBOL_TO_STATUS_CODE.delete(:"another_(silly)_love_song")
-        $debugme = false
       end
     end
   end
@@ -309,9 +309,9 @@ describe KineticCafe::ErrorDSL do
   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
+        base = Class.new(StandardError) {
           extend KineticCafe::ErrorDSL
-        end
+        }
 
         refute base.respond_to?(:not_found)
       end
@@ -319,9 +319,9 @@ describe KineticCafe::ErrorDSL do
 
     it 'does not define NotFound' do
       Rack.stub_remove_const(:Utils) do
-        base = Class.new(StandardError) do
+        base = Class.new(StandardError) {
           extend KineticCafe::ErrorDSL
-        end
+        }
 
         refute base.const_defined?(:NotFound)
       end
@@ -329,13 +329,13 @@ describe KineticCafe::ErrorDSL do
 
     it 'ignores __rack_status if defined' do
       Rack.stub_remove_const(:Utils) do
-        base = Class.new(StandardError) do
+        base = Class.new(StandardError) {
           def self.__rack_status
             { methods: true, errors: false }
           end
 
           extend KineticCafe::ErrorDSL
-        end
+        }
 
         refute base.respond_to?(:not_found)
         refute base.const_defined?(:NotFound)

data/test/test_kinetic_cafe_error_hierarchy.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 require 'rack/test'
 
@@ -92,7 +93,7 @@ describe KineticCafe::Error, '.hierarchy' do
       end
 
       it 'can handle a query parameter (issue #9)' do
-        expected = { query: "id: 1" }
+        expected = { query: 'id: 1' }
         actual = My.new(query: { id: 1 }).instance_variable_get(:@i18n_params)
         assert_equal expected, actual
       end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: kinetic_cafe_error
 version: !ruby/object:Gem::Version
-  version: '1.10'
+  version: '1.11'
 platform: ruby
 authors:
 - Austin Ziegler
 - Jero Sutlovic
+- Ravi Desai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-25 00:00:00.000000000 Z
+date: 2016-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -17,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
+        version: '5.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
+        version: '5.9'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -211,16 +212,22 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: i18n-tasks
   requirement: !ruby/object:Gem::Requirement
@@ -297,14 +304,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.15'
 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
@@ -318,24 +325,19 @@ description: |-
 email:
 - aziegler@kineticcafe.com
 - jsutlovic@kineticcafe.com
+- rdesai@kineticcafe.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- Contributing.rdoc
-- History.rdoc
-- Licence.rdoc
+- Contributing.md
+- History.md
+- Licence.md
 - Manifest.txt
 - README.rdoc
 files:
-- ".autotest"
-- ".gemtest"
-- ".rubocop.yml"
-- ".travis.yml"
-- Appraisals
-- Contributing.rdoc
-- Gemfile
-- History.rdoc
-- Licence.rdoc
+- Contributing.md
+- History.md
+- Licence.md
 - Manifest.txt
 - README.rdoc
 - Rakefile
@@ -353,8 +355,6 @@ files:
 - config/locales/kinetic_cafe_error.en.yml
 - config/locales/kinetic_cafe_error.fr-CA.yml
 - config/locales/kinetic_cafe_error.fr.yml
-- gemfiles/rack_1.6.gemfile
-- gemfiles/rack_2.gemfile
 - lib/kinetic_cafe/error.rb
 - lib/kinetic_cafe/error/minitest.rb
 - lib/kinetic_cafe/error_dsl.rb
@@ -380,7 +380,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -390,7 +390,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: kinetic_cafe_error provides an API-smart error base class and a DSL for defining