kinetic_cafe_error 1.10 → 1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed2b06cb85a613bdd8ac56aa6e8216188f257395
-  data.tar.gz: 7077a564338ef9bb8f885c51e86c36033b975671
+  metadata.gz: 3e59520ae4c59e3bd05ea5222fd800317d735457
+  data.tar.gz: f7e38457bc7b25ec96c4201a7859b55169100a4d
 SHA512:
-  metadata.gz: 94f9b44dbd23fe6ac116dae799503402231d89d7ceb76fdec18cd781c6933d09e7ad471626bc515cfdd324275b25d11cd05981f6a1edb71dde6f530e8ab3840b
-  data.tar.gz: c0c6d9491699c4b9f184774552688b35c8fe0b21514e865d26811a4e488b7c5239329335850ab4fc6c4b42b3ddc26ac8ec1874e4f21ececbf9c0d2489c3b59b2
+  metadata.gz: 2653e7d7e1e214028c91eb1e4ed9ab9249b1cf06f6a24f3fd8f831f07aa942c9259db0a121ac114939705c8eaa0ef21fd752300fd14e1b03109f4018591a09a8
+  data.tar.gz: 398211ce16cfa01a58dd9a105d025ac7c96b4011d9f0caf2b1451afc3a12240da7cfa31367c76d7b38a02dc8bf1b0a08331bbe562f730c27601a86e737945996

data/Contributing.md

@@ -0,0 +1,72 @@
+## Contributing
+
+We value any contribution to kinetic_cafe_error you can provide: a bug report,
+a feature request, or code contributions. kinetic_cafe_error is reasonably
+complex code, so there are a few code guidelines:
+
+*   Changes *will not* be accepted without tests. The test suite is written
+    with [Minitest][].
+*   Match our coding style.
+*   Use a thoughtfully-named topic branch that contains your change. Rebase
+    your commits into logical chunks as necessary.
+*   Use [quality commit messages][].
+*   Do not change the version number; when your patch is accepted and a release
+    is made, the version will be updated at that point.
+*   Submit a GitHub pull request with your changes.
+*   New behaviours require new or updated documentation.
+
+### Test Dependencies
+
+kinetic_cafe_error uses Ryan Davis’s [Hoe][] to manage the release process,
+which adds a number of rake tasks. You will mostly be interested in:
+
+    $ rake
+
+which runs the tests the same way that:
+
+    $ rake test
+    $ rake travis
+
+will do.
+
+To assist with the installation of the development dependencies for
+kinetic_cafe_error, I have provided the simplest possible Gemfile pointing to
+the (generated) `kinetic_cafe_error.gemspec` file. This will permit you to do:
+
+    $ bundle install
+
+to get the development dependencies. If you aleady have `hoe` installed, you
+can accomplish the same thing with:
+
+    $ rake newb
+
+This task will install any missing dependencies, run the tests/specs, and
+generate the RDoc.
+
+### Workflow
+
+Here's the most direct way to get your work merged into the project:
+
+*   Fork the project.
+*   Clone down your fork (`git clone
+    git://github.com/<username>/kinetic_cafe_error.git`).
+*   Create a topic branch to contain your change (`git checkout -b
+    my_awesome_feature`).
+*   Hack away, add tests. Not necessarily in that order.
+*   Make sure everything still passes by running `rake`.
+*   If necessary, rebase your commits into logical chunks, without errors.
+*   Push the branch up (`git push origin my_awesome_feature`).
+*   Create a pull request against halostatue/kinetic_cafe_error and describe
+    what your change does and the why you think it should be merged.
+
+### Contributors
+
+*  Austin Ziegler [@halostatue](https://github.com/halostatue) created
+   kinetic_cafe_error.
+*  Jero Sutlovic [@jsutlovic](https://github.com/jsutlovic)
+*  Ravi Desai [@ravster](https://github.com/ravster)
+
+[Minitest]: https://github.com/seattlerb/minitest
+[quality commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[Hoe]: https://github.com/seattlerb/hoe
+[kccoc]: https://github.com/KineticCafe/code-of-conduct

data/History.md

@@ -0,0 +1,226 @@
+### 1.11 / 2016-05-24
+
+*   1 minor enhancement:
+
+    *   If the controller instance does not respond to the 'respond_to' method,
+        then we want to default to rendering a JSON response.
+
+*   2 minor configuration changes:
+
+    *   Add a .hoerc file so that we don't have errors on Travis CI.
+
+    *   Add dependency_decisions.yml to whitelist dependencies by license.
+
+*   1 governance change:
+
+    *   kinetic_cafe_error is now governed under the Kinetic Cafe Open Source
+        [Code of Conduct][kccoc].
+
+### 1.10 / 2016-03-25
+
+*   1 bug fix:
+
+    *   Protect against names with punctuation in them.
+
+*   1 testing change:
+
+    *   Add Appraisals to test against both Rack 1.6 and Rack 2.0.
+
+### 1.9 / 2015-11-30
+
+*   2 bug fixes:
+
+    *   The #stringify method needed to be moved to KineticCafe::ErrorModule so
+        that hierarchies *not* built from KineticCafe::Error can properly use
+        query parameter parsing.
+
+    *   kinetic_cafe_error has required Ruby 2.1 or higher since version 1.5
+        because of the inclusion of i18n-tasks as a dependency. This is now
+        reflected in the dependencies.
+
+### 1.8.1 / 2015-10-26
+
+*   Re-release because 1.8 was yanked
+
+### 1.8 / 2015-10-26
+
+*   1 minor enhancement:
+
+    *   Add `kinetic_cafe_error_handle_post_error` to allow for capturing or
+        post-processing of errors after logging and handling.
+
+### 1.7 / 2015-08-05
+
+*   1 minor enhancement:
+
+    *   Add a `params` parameter to the `kcerror:defined` task that
+        will show the parameter names the exception expects.
+
+*   1 bug fix:
+
+    *   RubyMine does not fully initialize the project when running RSpec,
+        meaning that while Rake is defined, Rake::DSL is not. As such, we need
+        to prevent the Rake task from loading unless Rake::DSL is present.
+
+### 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:
+
+    *   Handle error causes correctly for Ruby 2.1 or later, where `raise
+        Exception, cause: RuntimeError.new` 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
+
+    *   Fixed an error with loading error_tasks.rake from the Rails engine.
+
+### 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 `be_kc_error_html`
+        (RSpec).
+
+*   Notes:
+
+    *   Applied Rubocop to enforce the KineticCafe house style.
+
+### 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
+
+    *   Changed the preferred way of creating an error hierarchy from just
+        extending the error class with KineticCafe::ErrorDSL to calling
+        KineticCafe.create_hierarchy. Among other options this provides, the
+        automatic creation of helper methods and errors based on Rack::Utils
+        status codes can be controlled.
+
+*   5 minor enhancements
+
+    *   Renamed KineticCafe#header_only? to KineticCafe#header? The old version
+        is still present but deprecated. Similarly, the option to
+        KineticCafe::ErrorDSL#define_error is now called `header`, but
+        `header_only` also works.
+
+    *   Added an option, `i18n_params` to KineticCafe::ErrorDSL#define_error,
+        used to describe the I18n parameters that are expected to be provided
+        to the error for translations. This gets defined as a class method on
+        the new error. This should be passed as an array.
+
+    *   Extracted most of the 'magic' functionality to KineticCafe::ErrorModule
+        so that useful hierarchies can be generated without inheriting directly
+        from KineticCafe::Error.
+
+    *   Added a class method to the Rails controller concern to generate a new
+        rescue_from for a non-KineticCafe::Error-derived exception.
+
+    *   Added a pair of rake tasks, kcerror:defined (shows defined errors) and
+        kcerror:translations (generates a sample translation key file).
+        Automatically inserted for Rails applications.
+
+### 1.1 / 2015-06-05
+
+*   7 minor enhancements
+
+    *   Added Minitest assertions and expectations.
+    *   Added Rspec expectation matchers.
+    *   Changed the error table to be a partial and renamed keys to support
+        this change (kinetic_cafe_error/_table.html.*). Removed the previous
+        key. Now an error is nominally embeddable in your own views without
+        being a full page.
+    *   Added HAML templates.
+    *   Added Slim templates.
+    *   Move error page to `kinetic_cafe_error/page.html.*` instead of
+        `kinetic_cafe/error/page.html.*`. This could be a breaking change, but
+        I consider it low risk.
+    *   Added KineticCafe::Error#code as an alias for KineticCafe::Error#i18n_key.
+
+*   2 minor bugfixes:
+
+    *   The en and fr translation files were reporting en-CA and fr-CA as their
+        locales, which is incorrect.
+
+    *   Renamed locale files to better match their names to their locales. The
+        locale is not en_ca, but en-CA.
+
+### 1.0.1 / 2015-05-27
+
+*   1 minor bugfix
+
+    *   Mac OS X is not case-sensitive and I do not currently have
+        Rails-specific tests.
+
+### 1.0.0 / 2015-05-27
+
+*   1 major enhancement
+
+    *   Birthday!
+
+[kccoc]: https://github.com/KineticCafe/code-of-conduct

data/{Licence.rdoc → Licence.md}

@@ -1,8 +1,8 @@
-== Licence
+## Licence
 
 This software is available under an MIT-style licence.
 
-* Copyright 2015 Austin Ziegler & Kinetic Cafe
+*   Copyright 2015–2016 Austin Ziegler & Kinetic Cafe
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
@@ -11,9 +11,9 @@ use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 of the Software, and to permit persons to whom the Software is furnished to do
 so, subject to the following conditions:
 
-* The names of its contributors may not be used to endorse or promote
-  products derived from this software without specific prior written
-  permission.
+*   The names of its contributors may not be used to endorse or promote
+    products derived from this software without specific prior written
+    permission.
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.

data/Manifest.txt

@@ -1,12 +1,6 @@
-.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
@@ -24,8 +18,6 @@ config/locales/kinetic_cafe_error.en-US.yml
 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

data/README.rdoc

@@ -133,5 +133,10 @@ And require where needed in your application:
 
   require 'kinetic_cafe_error'
 
-:include: Contributing.rdoc
-:include: Licence.rdoc
+== Community and Contributing
+
+kinetic_cafe_error welcomes your contributions as described in
+{Contributing.md}[https://github.com/KineticCafe/kinetic_cafe_error/blob/master/Contributing.md].
+This project, like all Kinetic Cafe {open source
+projects}[https://github.com/KineticCafe], is under the Kinetic Cafe Open
+Source {Code of Conduct}[https://github.com/KineticCafe/code-of-conduct].

data/Rakefile

@@ -1,28 +1,30 @@
-# -*- ruby encoding: utf-8 -*-
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'hoe'
 require 'rake/clean'
 
 Hoe.plugin :doofus
+Hoe.plugin :email unless ENV['CI'] || ENV['TRAVIS']
 Hoe.plugin :gemspec2
 Hoe.plugin :git
 Hoe.plugin :minitest
+Hoe.plugin :rubygems
 Hoe.plugin :travis
-Hoe.plugin :email unless ENV['CI'] || ENV['TRAVIS']
 
 spec = Hoe.spec 'kinetic_cafe_error' do
   developer('Austin Ziegler', 'aziegler@kineticcafe.com')
   developer('Jero Sutlovic', 'jsutlovic@kineticcafe.com')
+  developer('Ravi Desai', 'rdesai@kineticcafe.com')
 
-  require_ruby_version '>= 2.1'
-
-  self.history_file = 'History.rdoc'
+  self.history_file = 'History.md'
   self.readme_file = 'README.rdoc'
-  self.extra_rdoc_files = FileList['*.rdoc'].to_a
 
   license 'MIT'
 
+  ruby21!
+
+
   extra_dev_deps << ['appraisal', '~> 2.1']
   extra_dev_deps << ['hoe-doofus', '~> 1.0']
   extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
@@ -36,7 +38,7 @@ spec = Hoe.spec 'kinetic_cafe_error' do
   extra_dev_deps << ['minitest-moar', '~> 0.0']
   extra_dev_deps << ['minitest-stub-const', '~> 0.4']
   extra_dev_deps << ['rack-test', '~> 0.6']
-  extra_dev_deps << ['rake', '~> 10.0']
+  extra_dev_deps << ['rake', '>= 10.0', '< 12']
   extra_dev_deps << ['i18n-tasks', '~> 0.8']
   extra_dev_deps << ['i18n-tasks-csv', '~> 1.0']
   extra_dev_deps << ['rubocop', '~> 0.32']
@@ -44,27 +46,31 @@ spec = Hoe.spec 'kinetic_cafe_error' do
   extra_dev_deps << ['coveralls', '~> 0.8']
 end
 
+ENV['RUBYOPT'] = '-W0'
+
+module Hoe::Publish #:nodoc:
+  alias __make_rdoc_cmd__errhead__ make_rdoc_cmd
+
+  def make_rdoc_cmd(*extra_args) # :nodoc:
+    spec.extra_rdoc_files.delete_if { |f| f == 'Manifest.txt' }
+    __make_rdoc_cmd__errhead__(*extra_args)
+  end
+end
+
 namespace :test do
-  task :coverage do
-    spec.test_prelude = [
-      'require "simplecov"',
-      'SimpleCov.start("test_frameworks") { command_name "Minitest" }',
-      'gem "minitest"'
-    ].join('; ')
-    Rake::Task['test'].execute
+  if File.exist?('.simplecov-prelude.rb')
+    task :coverage do
+      spec.test_prelude = 'load ".simplecov-prelude.rb"'
+      Rake::Task['test'].execute
+    end
   end
 
   task :coveralls do
-    spec.test_prelude = [
-      'require "psych"',
-      'require "simplecov"',
-      'require "coveralls"',
-      'SimpleCov.formatter = Coveralls::SimpleCov::Formatter',
-      'SimpleCov.start("test_frameworks") { command_name "Minitest" }',
-      'gem "minitest"'
-    ].join('; ')
-    Rake::Task['test'].execute
+    ENV['coveralls'] = '1'
+    Rake::Task['test:coverage'].execute
   end
+
+  CLOBBER << 'coverage'
 end
 
-# vim: syntax=ruby
+CLOBBER << 'tmp'