inertia_rails 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85021602526f07e26abfe34c9fec6e2a6e7dfd30723c5a95691c5973a28960cc
-  data.tar.gz: 8e57db120b7b33f1205b06793baf7c6dfce435f006b70ab8b6f9a9a3b6d48921
+  metadata.gz: 0536ef39b6fe79eef541a105295cd99516701bc54feb5d0b1e323d58e28da62e
+  data.tar.gz: 219c6c1b1109edca4282233e94b2b429827f1c88da172d90084c8d02b0c5ef74
 SHA512:
-  metadata.gz: 7f4c8715da18542911ef0dea66e97935b8c3322d28d497c655ef62b2372394f4c4eb392dbdafafd5212c0e6fb2e92eb8980e444223de84f888673e32057780a7
-  data.tar.gz: c23988c55e8ce4b454bfdfe77b8c7f6e31e0fa6fe0260aa11f73e8051f5e0673828ff4b91ce26184b85b85891698d0bfbd067433a9e0e062f95fe2a43a1ff4dd
+  metadata.gz: 13fab1b82e088b1917748c5d2547c59723680a253e9268b9f29753afac8b83df89fe952cc4125ad0ccfea8ec2c6b848a901207596fcbb94ee7563c09c7a5d91b
+  data.tar.gz: 024b161f76d4cced631537f3454092b53cf5ee48e72723a6825a9aa20bdf2ad59eaeeef72537d1971889ebac8652e6b29c8a9ed9bcd4123b11736814a39d08cf

data/CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.2.2] - 2020-01-21
+
+### Fixed
+
+* Added patches to allow Rails errors to show properly in the inertia modal
+* Fixed a middleware issue caused by a breaking change in Rack v2.1.*
+
 ## [1.2.1] - 2019-12-6
 
 ### Fixed

data/lib/inertia_rails/middleware.rb

@@ -40,7 +40,7 @@ module InertiaRails
   
     def force_refresh(request)
       request.flash.keep
-      Rack::Response.new('', 409, {'X-Inertia-Location' => request.original_url})
+      Rack::Response.new('', 409, {'X-Inertia-Location' => request.original_url}).finish
     end
   end
 end

data/lib/inertia_rails/version.rb

@@ -1,3 +1,3 @@
 module InertiaRails
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/lib/inertia_rails.rb

@@ -1,6 +1,9 @@
 require 'inertia_rails/renderer'
 require 'inertia_rails/engine'
 
+require 'patches/debug_exceptions'
+require 'patches/better_errors'
+
 ActionController::Renderers.add :inertia do |component, options|
   InertiaRails::Renderer.new(
     component,

data/lib/patches/better_errors.rb

@@ -0,0 +1,17 @@
+# Patch BetterErrors::Middleware to render HTML for Inertia requests
+#
+# Original source:
+# https://github.com/BetterErrors/better_errors/blob/v2.5.1/lib/better_errors/middleware.rb
+#
+
+if defined?(BetterErrors)
+  BetterErrors::Middleware.class_eval do
+    prepend(InertiaBetterErrors = Module.new do
+      def text?(env)
+        return false if env["HTTP_X_INERTIA"]
+
+        super
+      end
+    end)
+  end
+end

data/lib/patches/debug_exceptions/patch-4-1.rb

@@ -0,0 +1,41 @@
+# Patch ActionDispatch::DebugExceptions to render HTML for Inertia requests
+#
+# Original source:
+# https://github.com/rails/rails/blob/4-1-stable/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb
+#
+
+ActionDispatch::DebugExceptions.class_eval do
+  prepend(InertiaDebugExceptions = Module.new do
+    def render_exception(env, exception)
+      wrapper = ExceptionWrapper.new(env, exception)
+      log_error(env, wrapper)
+
+      if env['action_dispatch.show_detailed_exceptions']
+        request = Request.new(env)
+        template = ActionView::Base.new([RESCUES_TEMPLATE_PATH],
+          request: request,
+          exception: wrapper.exception,
+          application_trace: wrapper.application_trace,
+          framework_trace: wrapper.framework_trace,
+          full_trace: wrapper.full_trace,
+          routes_inspector: routes_inspector(exception),
+          source_extract: wrapper.source_extract,
+          line_number: wrapper.line_number,
+          file: wrapper.file
+        )
+        file = "rescues/#{wrapper.rescue_template}"
+
+        if request.xhr? && !request.headers['X-Inertia'] # <<<< this line is changed only
+          body = template.render(template: file, layout: false, formats: [:text])
+          format = "text/plain"
+        else
+          body = template.render(template: file, layout: 'rescues/layout')
+          format = "text/html"
+        end
+        render(wrapper.status_code, body, format)
+      else
+        raise exception
+      end
+    end
+  end)
+end

data/lib/patches/debug_exceptions/patch-4-2.rb

@@ -0,0 +1,52 @@
+# Patch ActionDispatch::DebugExceptions to render HTML for Inertia requests
+#
+# Original source:
+# https://github.com/rails/rails/blob/4-2-stable/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb
+#
+
+ActionDispatch::DebugExceptions.class_eval do
+  prepend(InertiaDebugExceptions = Module.new do
+    def render_exception(env, exception)
+      wrapper = ExceptionWrapper.new(env, exception)
+      log_error(env, wrapper)
+
+      if env['action_dispatch.show_detailed_exceptions']
+        request = Request.new(env)
+        traces = wrapper.traces
+
+        trace_to_show = 'Application Trace'
+        if traces[trace_to_show].empty? && wrapper.rescue_template != 'routing_error'
+          trace_to_show = 'Full Trace'
+        end
+
+        if source_to_show = traces[trace_to_show].first
+          source_to_show_id = source_to_show[:id]
+        end
+
+        template = ActionView::Base.new([RESCUES_TEMPLATE_PATH],
+          request: request,
+          exception: wrapper.exception,
+          traces: traces,
+          show_source_idx: source_to_show_id,
+          trace_to_show: trace_to_show,
+          routes_inspector: routes_inspector(exception),
+          source_extracts: wrapper.source_extracts,
+          line_number: wrapper.line_number,
+          file: wrapper.file
+        )
+        file = "rescues/#{wrapper.rescue_template}"
+
+        if request.xhr? && !request.headers['X-Inertia'] # <<<< this line is changed only
+          body = template.render(template: file, layout: false, formats: [:text])
+          format = "text/plain"
+        else
+          body = template.render(template: file, layout: 'rescues/layout')
+          format = "text/html"
+        end
+        render(wrapper.status_code, body, format)
+      else
+        raise exception
+      end
+    end
+  end)
+end

data/lib/patches/debug_exceptions/patch-5-0.rb

@@ -0,0 +1,23 @@
+# Patch ActionDispatch::DebugExceptions to render HTML for Inertia requests
+#
+# Original source:
+# https://github.com/rails/rails/blob/5-0-stable/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb
+#
+
+ActionDispatch::DebugExceptions.class_eval do
+  prepend(InertiaDebugExceptions = Module.new do
+    def render_for_default_application(request, wrapper)
+      template = create_template(request, wrapper)
+      file = "rescues/#{wrapper.rescue_template}"
+
+      if request.xhr? && !request.headers['X-Inertia'] # <<<< this line is changed only
+        body = template.render(template: file, layout: false, formats: [:text])
+        format = "text/plain"
+      else
+        body = template.render(template: file, layout: 'rescues/layout')
+        format = "text/html"
+      end
+      render(wrapper.status_code, body, format)
+    end
+  end)
+end

data/lib/patches/debug_exceptions/patch-5-1.rb

@@ -0,0 +1,26 @@
+# Patch ActionDispatch::DebugExceptions to render HTML for Inertia requests
+#
+# Original source (unchanged since Rails 5.1):
+# https://github.com/rails/rails/blob/5-1-stable/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb
+# https://github.com/rails/rails/blob/5-2-stable/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb
+# https://github.com/rails/rails/blob/6-0-stable/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb
+#
+
+ActionDispatch::DebugExceptions.class_eval do
+  prepend(InertiaDebugExceptions = Module.new do
+    def render_for_browser_request(request, wrapper)
+      template = create_template(request, wrapper)
+      file = "rescues/#{wrapper.rescue_template}"
+
+      if request.xhr? && !request.headers['X-Inertia'] # <<<< this line is changed only
+        body = template.render(template: file, layout: false, formats: [:text])
+        format = "text/plain"
+      else
+        body = template.render(template: file, layout: "rescues/layout")
+        format = "text/html"
+      end
+
+      render(wrapper.status_code, body, format)
+    end
+  end)
+end

data/lib/patches/debug_exceptions.rb

@@ -0,0 +1,23 @@
+# Patch ActionDispatch::DebugExceptions to render HTML for Inertia requests
+#
+# Rails has introduced text rendering for XHR requests with Rails 4.1 and
+# changed the implementation in 4.2, 5.0 and 5.1 (unchanged since then).
+#
+# The original source needs to be patched, so that Inertia requests are
+# NOT responded with plain text, but with HTML.
+
+if defined?(ActionDispatch::DebugExceptions)
+  if ActionPack.version.to_s >= '5.1'
+    require 'patches/debug_exceptions/patch-5-1'
+  elsif ActionPack.version.to_s >= '5.0'
+    require 'patches/debug_exceptions/patch-5-0'
+  elsif ActionPack.version.to_s >= '4.2'
+    require 'patches/debug_exceptions/patch-4-2'
+  elsif ActionPack.version.to_s >= '4.1'
+    require 'patches/debug_exceptions/patch-4-1'
+  else
+    # No patch required, because text rendering for
+    # XHR requests was introduced with Rails 4.1:
+    # https://github.com/rails/rails/pull/11960
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inertia_rails
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Brian Knoles
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-06 00:00:00.000000000 Z
+date: 2020-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,6 +126,12 @@ files:
 - lib/inertia_rails/renderer.rb
 - lib/inertia_rails/rspec.rb
 - lib/inertia_rails/version.rb
+- lib/patches/better_errors.rb
+- lib/patches/debug_exceptions.rb
+- lib/patches/debug_exceptions/patch-4-1.rb
+- lib/patches/debug_exceptions/patch-4-2.rb
+- lib/patches/debug_exceptions/patch-5-0.rb
+- lib/patches/debug_exceptions/patch-5-1.rb
 homepage: https://github.com/inertiajs/inertia-rails/
 licenses:
 - MIT