kinetic_cafe_error 1.3 → 1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 210985e1268b5a3d32fb0a46c69d854eb5523073
-  data.tar.gz: 0b2185f4a90efb887bf48af8a435646a79fe1900
+  metadata.gz: dbf744127b8dfc1346ed5a2ab19932686592cae4
+  data.tar.gz: 76f1f73098ef8b68b27fcd8833d187af82a547bf
 SHA512:
-  metadata.gz: 8627e47d35629f7a6c8c6b58bb71036cf5cb0c2474cc752e4c033c3d8c678b2c22029ccc80552f5e98688f1e131863481d0e1391257d2f9f1a084e3e940639c4
-  data.tar.gz: 4e0d19ba153eb3d6f3ee7367ad6eeaecac5ac9abf0e7e26b3ae11db16e00042603c0bedcbcadbe10edba9fd99fa449fd0198a307062fe7d0ad60fc511ecd00ac
+  metadata.gz: d91d16627c9cbccf0da1baafef925a2b5dab8ecf30b4ff83e4ac9f670e49e249ee2be60b7e15508182016053729eae20f6b4b16cc426b5115946bdcfc14abbbe
+  data.tar.gz: be7371032f0f7eef3f4e2ea7006ba382b402f7f3a56f4a2b0f9b400d0b216d2bae5062bff5eaaded6117d1ff3fea5bee62e71175a29b93a8c4cd2bcf30f6e274

data/.rubocop.yml

@@ -0,0 +1,132 @@
+---
+# inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/config.rb'
+  Exclude:
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'script/**/*'
+    - 'tmp/**/*'
+  RunRailsCops: true
+  DisplayCopNames: true
+
+Style/AlignHash:
+  EnforcedHashRocketStyle: key
+  EnforcedColonStyle: key
+  EnforcedLastArgumentHashStyle: always_ignore
+
+Style/AlignParameters:
+  EnforcedStyle: with_first_parameter
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Style/Documentation:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/TrailingComma:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+# Style/BlockDelimiters in semantic mode is the only correct choice, but it is
+# too finicky to use reliably.
+Style/BlockDelimiters:
+  Enabled: false
+  EnforcedStyle: semantic
+
+Style/FormatString:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/SpaceInsideBrackets:
+  Enabled: false
+
+Style/CommentAnnotation:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+
+Style/CommandLiteral:
+  EnforcedStyle: percent_x
+
+Style/UnneededPercentQ:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 80
+  Exclude:
+    - test/**/*
+
+Style/MethodDefParentheses:
+  Exclude:
+    - test/**/*
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/MethodDefParentheses:
+  Exclude:
+    - lib/kinetic_cafe/error/minitest.rb
+
+Style/PerlBackrefs:
+  Exclude:
+    - lib/kinetic_cafe/error_dsl.rb
+
+Rails/Output:
+  Exclude:
+    - lib/**/*
+
+Style/LambdaCall:
+  Exclude:
+    - lib/kinetic_cafe/error_tasks.rb

data/History.rdoc

@@ -1,3 +1,25 @@
+=== 1.4 / 2015-07-07
+
+* 2 minor enhancements
+
+  * Changed how kcerror:translations generates the translation YAML for
+    consistent comparison (it no longer uses the YAML library to do this). The
+    file generated will always be for language +kc+ so that this can be used
+    with i18n-tasks.
+
+* 4 bug fixes
+
+  * Task kcerror:defined would error out if there were no defined descendants.
+  * Task kcerror:translations would error out if there were no defined
+    descendants.
+  * Made task loading more reliable and automatic.
+  * Removed some defaulted, unused parameters for assert_response_kc_error_html
+    (Minitest) and bc_kc_error_html (RSpec).
+
+* Notes:
+
+  * Applied Rubocop to enforce the KineticCafe house style.
+
 === 1.3 / 2015-06-18
 
 * 3 minor enhancements

data/Manifest.txt

@@ -1,5 +1,6 @@
 .autotest
 .gemtest
+.rubocop.yml
 .travis.yml
 Contributing.rdoc
 Gemfile
@@ -29,6 +30,7 @@ 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_tasks.rb
 lib/kinetic_cafe_error.rb
 test/test_helper.rb
 test/test_kinetic_cafe_error.rb

data/Rakefile

@@ -9,21 +9,18 @@ Hoe.plugin :gemspec2
 Hoe.plugin :git
 Hoe.plugin :minitest
 Hoe.plugin :travis
-Hoe.plugin :email unless ENV['CI'] or ENV['TRAVIS']
+Hoe.plugin :email unless ENV['CI'] || ENV['TRAVIS']
 
-spec = Hoe.spec "kinetic_cafe_error" do
-  # HEY! If you fill these out in ~/.hoe_template/minitest-travis/Rakefile.erb,
-  # you'll never have to touch them again!
-  # (delete this comment too, of course)
+spec = Hoe.spec 'kinetic_cafe_error' do
   developer('Austin Ziegler', 'aziegler@kineticcafe.com')
 
   require_ruby_version '>= 1.9.2'
 
   self.history_file = 'History.rdoc'
   self.readme_file = 'README.rdoc'
-  self.extra_rdoc_files = FileList["*.rdoc"].to_a
+  self.extra_rdoc_files = FileList['*.rdoc'].to_a
 
-  license "MIT"
+  license 'MIT'
 
   extra_dev_deps << ['hoe-doofus', '~> 1.0']
   extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
@@ -38,6 +35,7 @@ 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 << ['rubocop', '~> 0.32']
   extra_dev_deps << ['simplecov', '~> 0.7']
   extra_dev_deps << ['coveralls', '~> 0.8']
 end
@@ -65,6 +63,4 @@ namespace :test do
   end
 end
 
-load 'lib/kinetic_cafe/error_tasks.rake'
-
 # vim: syntax=ruby

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

@@ -8,6 +8,8 @@ module KineticCafe::ErrorHandler
 
   included do
     kinetic_cafe_error_handler_for KineticCafe::Error
+
+    class_attribute :__kinetic_cafe_error_handler_log_locale # :nodoc:
   end
 
   module ClassMethods
@@ -24,9 +26,9 @@ module KineticCafe::ErrorHandler
     # 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
+      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
     end
   end
 
@@ -84,14 +86,15 @@ module KineticCafe::ErrorHandler
   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
-        )
+
+    return unless 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.3' # :nodoc:
+    VERSION = '1.4' # :nodoc:
 
     # Get the KineticCafe::Error functionality.
     include KineticCafe::ErrorModule
@@ -146,9 +146,10 @@ module KineticCafe # :nodoc:
         base.send(:include, KineticCafe::ErrorModule)
       end
 
-      unless rs_defined = base.respond_to?(:__rack_status)
+      unless (rs_defined = base.respond_to?(:__rack_status))
+        rack_status_default = { errors: true, methods: true }
         base.send :define_singleton_method, :__rack_status do
-          options.fetch(:rack_status, { errors: true, methods: true })
+          options.fetch(:rack_status, rack_status_default)
         end
       end
 
@@ -217,3 +218,5 @@ module KineticCafe # :nodoc:
 end
 
 require_relative 'error_dsl'
+require_relative 'error_engine' if defined?(::Rails)
+require_relative 'error_tasks' if defined?(::Rake)

data/lib/kinetic_cafe/error/minitest.rb

@@ -38,10 +38,7 @@ module Minitest #:nodoc:
 
     # Assert that a reponse body (<tt>@response.body</tt>, useful from
     # ActionController::TestCase) is HTML for the expected error.
-    # convenience wrapper around #assert_kc_error_json.
-    def assert_response_kc_error_html expected, params = {}, msg = nil
-      msg, params = params, {} if msg.nil? && params.kind_of?(String)
-
+    def assert_response_kc_error_html expected, msg = nil
       msg ||= "Expected #{actual} to be HTML for #{expected}, but it was not."
 
       assert_template 'kinetic_cafe_error/page', msg
@@ -57,13 +54,11 @@ module Minitest #:nodoc:
     # #assert_kc_error_html, depending on whether or not the response is HTML
     # or not.
     def assert_response_kc_error expected, params = {}, msg = nil
-      if msg.nil? && params.kind_of?(String)
-        msg, params = params, {}
-      end
+      msg, params = params, {} if msg.nil? && params.kind_of?(String)
       msg ||= "Expected response to be #{expected}, but was not."
 
       if @request.format.html?
-        assert_response_kc_error_html expected, params, msg
+        assert_response_kc_error_html expected, msg
       else
         assert_kc_error_json expected, @response.body, params, msg
       end

data/lib/kinetic_cafe/error_dsl.rb

@@ -87,10 +87,10 @@ module KineticCafe
           fail ArgumentError, ":key conflicts with class:#{klass}"
         end
 
-        key = if status.kind_of?(Symbol) or status.kind_of?(String)
+        key = if status.kind_of?(Symbol) || status.kind_of?(String)
                 "#{klass}_#{KineticCafe::ErrorDSL.namify(status)}"
               else
-                "#{klass}_#{KineticCafe::ErrorDSL.namify(self.name)}"
+                "#{klass}_#{KineticCafe::ErrorDSL.namify(name)}"
               end
       else
         key = options.fetch(:key) {
@@ -168,7 +168,7 @@ module KineticCafe
       end
 
       if defined?(Rack::Utils) && rack_status
-        Rack::Utils::SYMBOL_TO_STATUS_CODE.each do |name, value|
+        Rack::Utils::SYMBOL_TO_STATUS_CODE.each_key do |name|
           if rack_status.fetch(:methods, true)
             base.singleton_class.send :define_method, name do |options = {}|
               define_error(options.merge(status: name))

data/lib/kinetic_cafe/error_module.rb

@@ -181,26 +181,27 @@ module KineticCafe # :nodoc:
 
       ##
       def included(mod)
-        unless mod.respond_to?(:i18n_key_base)
-          mod.send :define_singleton_method, :i18n_key_base do
-            'kcerrors'.freeze
-          end
+        default_singleton_method mod, :i18n_key_base do
+          'kcerrors'.freeze
         end
 
-        unless mod.respond_to?(:i18n_params)
-          mod.send :define_singleton_method, :i18n_params do
-            [].freeze
-          end
+        default_singleton_method mod, :i18n_params do
+          [].freeze
         end
 
-        unless mod.respond_to?(:i18n_key)
-          mod.send :define_singleton_method, :i18n_key do
-            @i18n_key ||= [
-              i18n_key_base, KineticCafe::ErrorDSL.namify(name)
-            ].join('.').freeze
-          end
+        default_singleton_method mod, :i18n_key do
+          @i18n_key ||= [
+            i18n_key_base, KineticCafe::ErrorDSL.namify(name)
+          ].join('.').freeze
         end
       end
+
+      private
+
+      def default_singleton_method(mod, name, &block)
+        return if mod.respond_to? name
+        mod.send :define_singleton_method, name, &block
+      end
     end
   end
 end

data/lib/kinetic_cafe/error_rspec.rb

@@ -55,7 +55,7 @@ module KineticCafe
       diffable
     end
 
-    matcher :be_kc_error_html do |expected, params = {}|
+    matcher :be_kc_error_html do |expected|
       match do |actual|
         expect(actual).to render_template('kinetic_cafe_error/page')
         expect(actual).to render_template('kinetic_cafe_error/_table')

data/lib/kinetic_cafe/error_tasks.rake

@@ -1,59 +1 @@
-namespace :kcerror do
-  desc 'Show defined errors.'
-  task defined: 'kcerror:find' do
-    display = ->(root, prefix = '') {
-      puts "#{prefix}- #{root}"
-
-      if @descendants[root]
-        sorted = @descendants[root].sort_by(&:to_s)
-        sorted.each do |child|
-          s = (child == sorted.last) ? '`' : '|'
-          display.(child, "#{prefix.tr('|`', ' ')}  #{s}")
-        end
-      end
-    }
-
-    @descendants[StandardError].sort_by(&:to_s).each { |d| display.(d) }
-  end
-
-  desc 'Generate a sample translation key file.'
-  task :translations, [ :output ] => 'kcerror:find' do |_, args|
-    translations = {}
-    traverse = ->(root) {
-      translation = (translations[root.i18n_key_base] ||= {})
-      name = KineticCafe::ErrorDSL.namify(root)
-
-      params = root.i18n_params.map { |param| "%{#{param}}" }.join(' ')
-
-      if params.empty?
-        translation[name] = %Q(Translation for #{name} with no params.)
-      else
-        translation[name] = %Q(Translation for #{name} with #{params}.)
-      end
-
-      if @descendants[root]
-        @descendants[root].sort_by(&:to_s).each { |child| traverse.(child) }
-      end
-    }
-
-    @descendants[StandardError].sort_by(&:to_s).each { |d| traverse.(d) }
-
-    require 'yaml'
-    translations = YAML.dump({ 'en' => translations })
-
-    if args.output
-      File.open(args.output, 'w') { |f| f.write translations }
-    else
-      puts translations
-    end
-  end
-
-  task :find do
-    @descendants = {}
-    ObjectSpace.each_object(Class) do |k|
-      next unless k.singleton_class < KineticCafe::ErrorDSL
-
-      (@descendants[k.superclass] ||= []) << k
-    end
-  end
-end
+require 'kinetic_cafe/error_tasks'

data/lib/kinetic_cafe/error_tasks.rb

@@ -0,0 +1,84 @@
+module KineticCafe
+  module ErrorTasks
+    extend Rake::DSL
+  end
+end
+
+module KineticCafe::ErrorTasks
+  require 'kinetic_cafe_error'
+
+  namespace :kcerror do
+    desc 'Show defined errors.'
+    task defined: 'kcerror:find' do
+      display = ->(root, prefix = '') {
+        puts "#{prefix}- #{root}"
+
+        if @descendants[root]
+          sorted = @descendants[root].sort_by(&:to_s)
+          sorted.each do |child|
+            s = (child == sorted.last) ? '`' : '|'
+            display.(child, "#{prefix.tr('|`', ' ')}  #{s}")
+          end
+        end
+      }
+
+      if @descendants[StandardError]
+        @descendants[StandardError].sort_by(&:to_s).each { |d| display.(d) }
+      else
+        puts 'No defined errors.'
+      end
+    end
+
+    desc 'Generate a sample translation key file.'
+    task :translations, [ :output ] => 'kcerror:find' do |_, args|
+      translations = {}
+      traverse = ->(root) {
+        translation = (translations[root.i18n_key_base] ||= {})
+        name = KineticCafe::ErrorDSL.namify(root)
+
+        params = root.i18n_params.map { |param| "%{#{param}}" }.join(' ')
+
+        if params.empty?
+          translation[name] = %Q(Translation for #{name} with no params.)
+        else
+          translation[name] = %Q(Translation for #{name} with #{params}.)
+        end
+
+        if @descendants[root]
+          @descendants[root].sort_by(&:to_s).each { |child| traverse.(child) }
+        end
+      }
+
+      if @descendants[StandardError]
+        @descendants[StandardError].sort_by(&:to_s).each { |d| traverse.(d) }
+
+        # 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|
+          text << "\n  #{group}:"
+
+          translations[group].keys.sort.each { |k|
+            text << "\n    #{k}: >-\n      #{translations[group][k]}"
+          }
+        }
+
+        if args.output
+          File.open(args.output, 'w') { |f| f.puts text }
+        else
+          puts text
+        end
+      end
+    end
+
+    task :find do
+      @descendants = {}
+      ObjectSpace.each_object(Class) do |k|
+        next unless k.singleton_class < KineticCafe::ErrorDSL
+
+        (@descendants[k.superclass] ||= []) << k
+      end
+    end
+  end
+end

data/lib/kinetic_cafe_error.rb

@@ -1,2 +1 @@
 require 'kinetic_cafe/error'
-require 'kinetic_cafe/error_engine' if defined?(::Rails)

data/test/test_kinetic_cafe_error.rb

@@ -33,7 +33,7 @@ describe KineticCafe::Error do
           assert_equal(
             [
               'kcerrors.error',
-              { query: "a: 1; b[]: x, b[]: y, b[]: z; c[][d]: 1; c[][e]: 2; f[]: []" }
+              { query: 'a: 1; b[]: x, b[]: y, b[]: z; c[][d]: 1; c[][e]: 2; f[]: []' }
             ],
             exception.i18n_message
           )
@@ -91,9 +91,9 @@ describe KineticCafe::Error do
       assert_equal(
         {
           status: :bad_request,
-          name: "error",
+          name: 'error',
           internal: false,
-          i18n_key: "kcerrors.error"
+          i18n_key: 'kcerrors.error'
         },
         exception.api_error
       )
@@ -104,9 +104,9 @@ describe KineticCafe::Error do
         {
           error: {
             status: :bad_request,
-            name: "error",
+            name: 'error',
             internal: false,
-            i18n_key: "kcerrors.error"
+            i18n_key: 'kcerrors.error'
           },
           message: nil
         },
@@ -121,9 +121,9 @@ describe KineticCafe::Error do
           json: {
             error: {
               status: :bad_request,
-              name: "error",
+              name: 'error',
               internal: false,
-              i18n_key: "kcerrors.error"
+              i18n_key: 'kcerrors.error'
             },
             message: nil
           },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kinetic_cafe_error
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: '1.4'
 platform: ruby
 authors:
 - Austin Ziegler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-18 00:00:00.000000000 Z
+date: 2015-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -206,6 +206,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.32'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.32'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -271,6 +285,7 @@ extra_rdoc_files:
 files:
 - ".autotest"
 - ".gemtest"
+- ".rubocop.yml"
 - ".travis.yml"
 - Contributing.rdoc
 - Gemfile
@@ -300,6 +315,7 @@ files:
 - lib/kinetic_cafe/error_module.rb
 - lib/kinetic_cafe/error_rspec.rb
 - lib/kinetic_cafe/error_tasks.rake
+- lib/kinetic_cafe/error_tasks.rb
 - lib/kinetic_cafe_error.rb
 - test/test_helper.rb
 - test/test_kinetic_cafe_error.rb