rails-hush 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28eb5448f9a28b437d7cb46cbba086fc16c891df1a8083a694ed12fba56bcd32
-  data.tar.gz: c4b6f533e00e33e1b85c08abffe2fa863bdadbbe55e6709fefd522160e40fc0c
+  metadata.gz: 2a9c38ec9eb1c74c7be0f5be8400851ff7b4e18d09cf13f45d78dc0a661e91a5
+  data.tar.gz: fdefce31691aab5c96c685ee6a4688545d11d9fd66a926ac15845d593df23033
 SHA512:
-  metadata.gz: c2cca48d9b7558a79a5421f709c25277a670abcf19f46ab2b5c0a6ecc4bd7ce49e08276eeb381b5bc7ed34fe56c41b0354652edb1fa11a2569f0bf46697c249c
-  data.tar.gz: b900f8c397cf312c16347746333311dcd0f8ad2e22daf935c6d953cd4c0e400cb34e0eebbbdedd3172fbf3d06016113d5bbd43965f6c009c45e22bf7fe68b80c
+  metadata.gz: 8beddfa617f90cb92c7860bc1b23498738d5f722f2467c2c80f81c43e57464184abe6df3a00f0889edcd1a210df3b55a70bfe58c6ed968eefe7f8439923d8612
+  data.tar.gz: 527686f8e8edc9accdeff52175fc737752bea3ef7b44ef8932f8a530c1a0bc6e71da8f2cb3bf543552a342f0a457968149ece42b714cf7588d3ccb44b807f881

data/README.md

@@ -42,9 +42,9 @@ RailsHush does support a couple of configuration options:
 To disable automatic loading of middleware:
 
     # Phase one (early) middleware
-    config.rails_hush.use_one  = true
+    config.rails_hush.use_one  = false
     # Phase two (late) middleware
-    config.rails_hush.use_two  = true
+    config.rails_hush.use_two  = false
 
 Then add the middleware on your own:
 
@@ -78,7 +78,7 @@ Rails' default "test" environment settings are quite different than "production"
 
 ## Contributing
 
-Contributions welcome. Please use standard Github Pull Requests.
+Contributions welcome. Please use standard GitHub Pull Requests.
 
 
 ## License

data/lib/rails_hush/middleware/hush_one.rb

@@ -1,5 +1,6 @@
 module RailsHush
   class HushOne
+    include ShowExceptions
     include SimpleRenderer
 
     def initialize(app, renderer=nil)
@@ -9,7 +10,7 @@ module RailsHush
 
     def call(env)
       request = ActionDispatch::Request.new env
-      if request.show_exceptions? && !request.get_header("action_dispatch.show_detailed_exceptions")
+      if show_exceptions?(request) && !request.get_header("action_dispatch.show_detailed_exceptions")
         begin
           @app.call(env)
         rescue ActionController::UnknownHttpMethod

data/lib/rails_hush/middleware/hush_two.rb

@@ -1,5 +1,6 @@
 module RailsHush
   class HushTwo
+    include ShowExceptions
     include SimpleRenderer
 
     def initialize(app, renderer=nil)
@@ -9,7 +10,7 @@ module RailsHush
 
     def call(env)
       request = ActionDispatch::Request.new env
-      if request.show_exceptions? && !request.get_header("action_dispatch.show_detailed_exceptions")
+      if show_exceptions?(request) && !request.get_header("action_dispatch.show_detailed_exceptions")
         begin
           _, headers, body = response = @app.call(env)
           if headers['X-Cascade'] == 'pass'

data/lib/rails_hush/middleware/show_exceptions.rb

@@ -0,0 +1,24 @@
+module RailsHush
+  module ShowExceptions
+
+    # actionpack treats missing/invalid values as :all/true. since railties (eg: a full rails
+    # app) defaults to :all, skipping the invalid value case here to improve code clarity.
+    # since rails-hush intentionally overrides certain exceptions, treat :rescuable the same
+    # as :all. there's no need to be dynamic here.
+    SHOWABLE = [
+      :all,       # rails 7.1+
+      true,       # rails 7.0-
+      nil,        # equiv to :all,true
+      :rescuable  # rails 7.1+
+    ]
+
+    def show_exceptions?(request, exception=nil)
+      if Rails.version >= '7.1'
+        SHOWABLE.include? request.get_header("action_dispatch.show_exceptions")
+      else
+        request.show_exceptions?
+      end
+    end
+
+  end
+end

data/lib/rails_hush/middleware/simple_renderer.rb

@@ -1,38 +1,40 @@
-module SimpleRenderer
+module RailsHush
+  module SimpleRenderer
 
-  def log_request(status, request)
-    payload = {
-      params: (request.filtered_parameters rescue {}),
-      headers: request.headers,
-      format: (request.format.ref rescue :text),
-      method: (request.request_method rescue 'INVALID'),
-      path: request.fullpath,
-      status: status
-    }
-    ActiveSupport::Notifications.instrument "process_action.action_controller", payload
-  end
+    def log_request(status, request)
+      payload = {
+        params: (request.filtered_parameters rescue {}),
+        headers: request.headers,
+        format: (request.format.ref rescue :text),
+        method: (request.request_method rescue 'INVALID'),
+        path: request.fullpath,
+        status: status
+      }
+      ActiveSupport::Notifications.instrument "process_action.action_controller", payload
+    end
 
-  def render(status, request, error=nil)
-    begin
-      content_type = request.formats.first
-    rescue Mime::Type::InvalidMimeType
-      content_type = Mime[:text]
+    def render(status, request, error=nil)
+      begin
+        content_type = request.formats.first
+      rescue Mime::Type::InvalidMimeType
+        content_type = Mime[:text]
+      end
+      error ||= Rack::Utils::HTTP_STATUS_CODES.fetch(status, Rack::Utils::HTTP_STATUS_CODES[500])
+      @renderer.call(status, content_type, error)
     end
-    error ||= Rack::Utils::HTTP_STATUS_CODES.fetch(status, Rack::Utils::HTTP_STATUS_CODES[500])
-    @renderer.call(status, content_type, error)
-  end
 
-  def default_renderer(status, content_type, error)
-    body = { status: status, error: error }
-    format = "to_#{content_type.to_sym}" if content_type
-    if format && body.respond_to?(format)
-      body = body.public_send(format)
-    else
-      content_type = 'application/json'
-      body = body.to_json
+    def default_renderer(status, content_type, error)
+      body = { status: status, error: error }
+      format = "to_#{content_type.to_sym}" if content_type
+      if format && body.respond_to?(format)
+        body = body.public_send(format)
+      else
+        content_type = 'application/json'
+        body = body.to_json
+      end
+      [status, { "Content-Type" => "#{content_type}; charset=#{ActionDispatch::Response.default_charset}",
+                "Content-Length" => body.bytesize.to_s }, [body]]
     end
-    [status, { "Content-Type" => "#{content_type}; charset=#{ActionDispatch::Response.default_charset}",
-              "Content-Length" => body.bytesize.to_s }, [body]]
-  end
 
+  end
 end

data/lib/rails_hush/version.rb

@@ -1,3 +1,3 @@
 module RailsHush
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

data/lib/rails_hush.rb

@@ -1,4 +1,4 @@
-%w(simple_renderer hush_one hush_two).each do |f|
+%w(show_exceptions simple_renderer hush_one hush_two).each do |f|
   require "rails_hush/middleware/#{f}"
 end
 require 'rails_hush/railtie'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-hush
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - thomas morgan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-10 00:00:00.000000000 Z
+date: 2023-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +19,7 @@ dependencies:
         version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +73,7 @@ files:
 - lib/rails_hush.rb
 - lib/rails_hush/middleware/hush_one.rb
 - lib/rails_hush/middleware/hush_two.rb
+- lib/rails_hush/middleware/show_exceptions.rb
 - lib/rails_hush/middleware/simple_renderer.rb
 - lib/rails_hush/railtie.rb
 - lib/rails_hush/version.rb