rescue_registry 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abb4709b529437899b1f600805b3218d82581ba88c03642561d015385776dee3
-  data.tar.gz: 1f3efb50ac2375c0b204bb8af849615922f48d74c2eb06179a72bef6ce101754
+  metadata.gz: 237133f9678393d12439ef50317b1671632606d3d35a7b5f658cf4eab3083bbc
+  data.tar.gz: ffac90b369e7b345fd74de72db7178f420b9577ca30e26d1b8427cf2e58049e4
 SHA512:
-  metadata.gz: b3025ac89186c93d3d16eea9f1aa4039955d4527eefbeccc939f7501753ad3f9ea306ebc3e705009ee06e9bfd928db5521643d159646e54c271642a2c9e358f0
-  data.tar.gz: f3df89c3ea0204a2388b6ccd40deb6d4061586207dc8dca97b2475b07027e28a1db19574741487fb439e7c755bf5d79c9c3f687d4ac20663b5bf2d32b5995b41
+  metadata.gz: 43d1e9755b0333d69646594e28e6caef2219e02b9a18d466fd8bee0b204d4fefdc817628d958899abe8e6391327a5a9f131889ea0ee44ac611e778d5a1f3d70c
+  data.tar.gz: 54dcad7d3ad63eec2dd5c752cafff76ff248832093603f45e1c0c959e10b8e62dcc9102e1823a163b5c6452022ab6fc3f2ed8ac5267cbcc52290916092329b6f

data/CHANGELOG.md

@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ---
 
+## [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)
+
+### Changed
+- Lower minimum Ruby requirement to 2.3 (thanks @elDub)
+
+## [0.2.2] - 2019-06-13
+### Changed
+- Lower minimum Ruby requirement to 2.3 (thanks @elDub)
+
+## [0.2.1] - 2019-05-22
+### Added
+- RescueRegistry::RailsTestingHelpers provides some helpers for easier testing in Rails applications.
+
 ## [0.2.0] - 2019-05-21
 ### Added
 - Support for non-Rails applications.

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/lib/rescue_registry.rb

@@ -9,6 +9,7 @@ module RescueRegistry
   autoload :ExceptionsApp,         "rescue_registry/exceptions_app"
   autoload :ExceptionHandler,      "rescue_registry/exception_handler"
   autoload :RailsExceptionHandler, "rescue_registry/exception_handler"
+  autoload :RailsTestHelpers,      "rescue_registry/rails_test_helpers"
   autoload :Registry,              "rescue_registry/registry"
   autoload :ResetContext,          "rescue_registry/reset_context"
   autoload :ShowExceptions,        "rescue_registry/show_exceptions"
@@ -45,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

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

data/lib/rescue_registry/exceptions_app.rb

@@ -9,12 +9,7 @@ module RescueRegistry
       exception = request.get_header "action_dispatch.exception"
 
       if RescueRegistry.handles_exception?(exception)
-        begin
-          content_type = request.formats.first
-        rescue Mime::Type::InvalidMimeType
-          content_type = Mime[:text]
-        end
-
+        content_type = request.formats.first || Mime[:text]
         response = RescueRegistry.response_for_public(content_type, exception)
       end
 

data/lib/rescue_registry/rails_test_helpers.rb

@@ -0,0 +1,42 @@
+module RescueRegistry
+  # Helpers to improve the ease of testing error handling in Rails tests.
+  # These are not actually specific to RescueRegistry, but will certainly be useful for it.
+  module RailsTestHelpers
+    def handle_request_exceptions(handle = true, &block)
+      set_action_dispatch_property(:show_exceptions, handle, &block)
+    end
+
+    def handle_request_exceptions?
+      Rails.application.config.action_dispatch.show_exceptions
+    end
+
+    def show_detailed_exceptions(show = true, &block)
+      set_action_dispatch_property(:show_detailed_exceptions, show, &block)
+    end
+
+    def show_detailed_exceptions?
+      Rails.application.config.action_dispatch.show_detailed_exceptions
+    end
+
+    private
+
+    def set_action_dispatch_property(key, value)
+      if block_given?
+        original_value = Rails.application.config.action_dispatch.send(key)
+      end
+
+      Rails.application.config.action_dispatch.send("#{key}=", value)
+      # Also set this since it may have been cached
+      Rails.application.env_config["action_dispatch.#{key}"] = value
+
+      if block_given?
+        begin
+          yield
+        ensure
+          Rails.application.env_config["action_dispatch.#{key}"] = original_value
+          Rails.application.config.action_dispatch.send("#{key}=", original_value)
+        end
+      end
+    end
+  end
+end

data/lib/rescue_registry/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rescue_registry
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5
 platform: ruby
 authors:
 - Peter Wagenet
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-21 00:00:00.000000000 Z
+date: 2021-03-09 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: []
@@ -100,6 +100,7 @@ files:
 - lib/rescue_registry/controller.rb
 - lib/rescue_registry/exception_handler.rb
 - lib/rescue_registry/exceptions_app.rb
+- lib/rescue_registry/rails_test_helpers.rb
 - lib/rescue_registry/railtie.rb
 - lib/rescue_registry/registry.rb
 - lib/rescue_registry/reset_context.rb
@@ -113,23 +114,26 @@ 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'
+  - - "<"
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Registry for Rails Exceptions
 test_files: []