rescue_registry 0.2.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76e7d0f44e4a1b8dc8f91e8b7c33fceac13b70740dfc3452d127a25e59e49be1
-  data.tar.gz: 78f018ba46f97c5fd6ad04883f83b9755e18d653d9a638ebd0d863d23b49ce26
+  metadata.gz: 3575942ac21357ea65531cb89bf233d75a2dc983d220f279cc5c5ebac0c6c3be
+  data.tar.gz: c3c3a52aa8fe8ed34d66fe0b03062282793a24c0df69c456ef92afca1e0e7f8d
 SHA512:
-  metadata.gz: 853839cefe3949aaf86ba208bb6d65b9d0646399f1ca437110e13dd07faf0939f2abf54a17d161831e8faac5362142776dbdcc2906c15ecc79aaec061304cd54
-  data.tar.gz: 697b515d046f7b5033790535158a6ce085d10a69ba694a34ea14054441c5d54a6a4349237a2b32e75dcf9c4b0474314a72773b48a0446125053db75acb93d345
+  metadata.gz: add3e437decc5c77801e74e2a1d3f5330122a142578c6133e57eae884d638323e35a984dcbcfa0e6e3845d21680675e08a0f5f0d82e4f4cfec8afacb76e08842
+  data.tar.gz: 50dc6cc1cdb148cc22590b1854f9f6d285c6a7a693ad4b4fc4e6711e2058632854aad07d0b118e7a0231d514241616faea48296b6c707be71222586e3249c2e2

data/CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ---
 
+## [1.0.0] - 2022-02-03
+### Changed
+- Removed upper version bound to support Ruby 3.1. (thanks @nulldotpro)
+
+## [0.3.0] - 2021-05-11
+### Changed
+- For better JSONAPI spec compliance, errors payloads will not include the `details` key when value is `null`.
+- Error payloads will not include the `meta` key when value is an empty object.
+
+## [0.2.5] - 2021-03-09
+### Added
+- `code` can now be provided as an argument to `register_exception` - #29 (thanks @amaierhofer)
+
+## [0.2.4] - 2021-01-22
+### Fixed
+- Support Ruby 3 (thanks @zvkemp and @ef4)
+
 ## [0.2.3] - 2020-09-01
 ### Fixed
 - Properly handle exceptions for invalid format types - #25 (thanks @shanet)

data/README.md

@@ -58,6 +58,7 @@ class MyController < ActionController::Base
   register_exception MetaProcError, meta: -> (e) { { class_name: e.class.name.upcase } }
   register_exception CustomHandlerError, handler: CustomErrorHandler
   register_exception RailsError, status: 403, handler: RescueRegistry::RailsExceptionHandler
+  register_exception CustomStatusError, status: 422, code: :name_invalid
 end
 ```
 

data/Rakefile

@@ -4,6 +4,7 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
+require 'rails/version'
 require 'yard'
 require 'rspec/core/rake_task'
 require 'bundler/gem_tasks'
@@ -14,7 +15,11 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = "--order random"
 end
 
-APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+if Rails::VERSION::MAJOR < 7
+  APP_RAKEFILE = File.expand_path("spec/rails5/dummy/Rakefile", __dir__)
+else
+  APP_RAKEFILE = File.expand_path("spec/rails7/dummy/Rakefile", __dir__)
+end
 load "rails/tasks/engine.rake"
 
 task default: :spec

data/lib/rescue_registry/exception_handler.rb

@@ -21,6 +21,7 @@ module RescueRegistry
       end
 
       @meta = options[:meta]
+      @code = options[:code]
 
       # TODO: Warn about unrecognized options
     end
@@ -29,7 +30,7 @@ module RescueRegistry
     alias_method :status_code, :status
 
     def error_code
-      error_code_from_status
+      @code.presence || error_code_from_status
     end
 
     def title
@@ -74,14 +75,20 @@ module RescueRegistry
         )
       end
 
+      error_payload = {
+        code: error_code,
+        status: status_code.to_s,
+        title: title
+      }
+
+      if (d = detail)
+        error_payload[:detail] = d
+      end
+
+      error_payload[:meta] = payload_meta if payload_meta.any?
+
       {
-        errors: [
-          code: error_code,
-          status: status_code.to_s,
-          title: title,
-          detail: detail,
-          meta: payload_meta
-        ]
+        errors: [error_payload]
       }
     end
 

data/lib/rescue_registry/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RescueRegistry
-  VERSION = "0.2.3"
+  VERSION = "1.0.0"
 end

data/lib/rescue_registry.rb

@@ -46,6 +46,18 @@ module RescueRegistry
       context.rescue_registry.public_send(method, *args)
     end
   end
+
+  # the Module#ruby2_keywords is added starting at ruby 2.7. It lets us mark
+  # these methods as using ruby2-style keyword argument semantics. This will
+  # keep them working correctly on ruby3, and clears a deprecation that
+  # otherwise fires in 2.7+.
+  if respond_to?(:ruby2_keywords, true)
+    class << self
+      REGISTRY_METHODS.each do |method|
+        ruby2_keywords(method)
+      end
+    end
+  end
 end
 
 ActiveSupport.on_load(:before_initialize) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rescue_registry
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Peter Wagenet
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-01 00:00:00.000000000 Z
+date: 2022-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: 
+description:
 email:
 - peter.wagenet@gmail.com
 executables: []
@@ -114,13 +114,13 @@ metadata:
   bug_tracker_uri: https://github.com/wagenet/rescue_registry/issues
   changelog_uri: https://github.com/wagenet/rescue_registry/CHANGELOG.md
   source_code_uri: https://github.com/wagenet/rescue_registry
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -129,8 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Registry for Rails Exceptions
 test_files: []