inertia_rails 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdaebfad8721ec7747b79081270577ca65181b95c3351675387ac133645fe392
-  data.tar.gz: ed0d9bf04ab9af128c4cad90c3e2af57d15ae5a92699f28e5893c9340743e3f3
+  metadata.gz: ef2ef33ca24036a92d67ec557bab99829468a7f9546422b68a703624bd52489d
+  data.tar.gz: 6beb16df6b7511813b62e42e91fbb7d0a251264b2e802e0e0345b04bd08700ac
 SHA512:
-  metadata.gz: 4037238f6ba98d8dc82e8c5d852615a471e9d2396ab292be74740a7b40013c904043e92b4c724fac3d0aa9a47ee4f97f340c567ec2119eacf3fdb748b9097261
-  data.tar.gz: 6bef52dadbe2c8bfef33f8b4027e81219e58ed1263615b6c3fb97e3bb759166a115110237b80f4916b02133399b4bb8e60442ec5a5b7aca6b992ca24c6cd6b2d
+  metadata.gz: 5e2d7527c48047f950207b163fa539b6b4735655d501a573035a782cb623f5973a74789574be6722bbf7bd4088835c5a486d9a8962df02d17473c4c2d42a0012
+  data.tar.gz: 96d8302e0fd851874d14ef2cee34c013278924c9e619d7302a2a66ae2a3c5dbd7c3a5e3a7ee2e01f8849adfbd0f54e65b1661cfeeb27320e8f94b415d8ca5567

data/.github/workflows/push.yml

@@ -0,0 +1,32 @@
+name: Testing
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.6, 2.7]
+
+    runs-on: ubuntu-latest
+    name: Test against Ruby ${{ matrix.ruby }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup System
+        run: sudo apt-get install libsqlite3-dev
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install gems
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/Gemfile.lock
 
 /spec/dummy/db/*.sqlite3
 /spec/dummy/db/*.sqlite3-journal

data/CHANGELOG.md

@@ -4,6 +4,37 @@ 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.4.0] - 2020-07-09
+
+* Fixed Ruby 2.7 deprecation warnings
+* Added `inertia_partial?` method
+* Fixed homepage in the gemspec
+* Make the InertiaRails module data threadsafe
+
+## [1.3.1] - 2020-02-20
+
+* Fix a typo in the README (inertia only has 1 t!)
+
+## [1.3.0] - 2020-01-28
+
+### Added
+
+* Added request.inertia? method
+
+## [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
+
+* Change page url to use path instead of url
+* Moved Inertia Share logic to a before_action to ensure it runs on every request
+
 ## [1.2.0] - 2019-11-1
 
 ### Added

data/README.md

@@ -6,7 +6,7 @@ Visit [inertiajs.com](https://inertiajs.com/) to learn more.
 
 The initial version of the gem was named `inertia`; however, that name was not available on Rubygems. 
 
-The 1.0.0 version release on Rubygems is `intertia_rails`.
+The 1.0.0 version release on Rubygems is `inertia_rails`.
 
 The changes required are:
 

data/inertia_rails.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["brain@bellawatt.com", "brandon@bellawatt.com", "eugene@bellawatt.com"]
 
   spec.summary       = %q{Inertia adapter for Rails}
-  spec.homepage      = "https://github.com/inertiajs/inertia-rails/"
+  spec.homepage      = "https://github.com/inertiajs/inertia-rails"
   spec.license       = "MIT"
 
   spec.metadata["homepage_uri"] = spec.homepage
@@ -26,8 +26,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec-rails", "~> 3.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec-rails", "~> 4.0"
   spec.add_development_dependency "rails"
   spec.add_development_dependency "rails-controller-testing"
   spec.add_development_dependency "sqlite3"

data/lib/inertia_rails.rb

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

data/lib/inertia_rails/controller.rb

@@ -6,8 +6,10 @@ module InertiaRails
 
     module ClassMethods
       def inertia_share(**args, &block)
-        InertiaRails.share(args) if args
-        InertiaRails.share_block(block) if block
+        before_action do
+          InertiaRails.share(**args) if args
+          InertiaRails.share_block(block) if block
+        end
       end
     end
   end

data/lib/inertia_rails/inertia_rails.rb

@@ -1,6 +1,6 @@
 module InertiaRails
-  mattr_accessor(:shared_plain_data) { Hash.new }
-  mattr_accessor(:shared_blocks) { [] }
+  thread_mattr_accessor :threadsafe_shared_plain_data
+  thread_mattr_accessor :threadsafe_shared_blocks
 
   def self.configure
     yield(Configuration)
@@ -21,11 +21,11 @@ module InertiaRails
 
   # "Setters"
   def self.share(**args)
-    shared_plain_data.merge!(args)
+    self.shared_plain_data = self.shared_plain_data.merge(args)
   end
 
   def self.share_block(block)
-    shared_blocks.push(block)
+    self.shared_blocks = self.shared_blocks + [block]
   end
 
   def self.reset!
@@ -36,12 +36,45 @@ module InertiaRails
   private
 
   module Configuration
-    mattr_accessor(:layout) { 'application' }
-    mattr_accessor(:version) { nil }
+    thread_mattr_accessor :threadsafe_layout
+    thread_mattr_accessor :threadsafe_version
 
     def self.evaluated_version
       self.version.respond_to?(:call) ? self.version.call : self.version
     end
+
+    def self.layout
+      self.threadsafe_layout || 'application'
+    end
+
+    def self.layout=(val)
+      self.threadsafe_layout = val
+    end
+
+    def self.version
+      self.threadsafe_version
+    end
+
+    def self.version=(val)
+      self.threadsafe_version = val
+    end
+  end
+
+  # Getters and setters to provide default values for the threadsafe attributes
+  def self.shared_plain_data
+    self.threadsafe_shared_plain_data || {}
+  end
+
+  def self.shared_plain_data=(val)
+    self.threadsafe_shared_plain_data = val
+  end
+
+  def self.shared_blocks
+    self.threadsafe_shared_blocks || []
+  end
+
+  def self.shared_blocks=(val)
+    self.threadsafe_shared_blocks = val
   end
 
   def self.evaluated_blocks(controller,  blocks)

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/renderer.rb

@@ -42,7 +42,7 @@ module InertiaRails
       {
         component: component,
         props: props,
-        url: @request.original_url,
+        url: @request.original_fullpath,
         version: ::InertiaRails.version,
       }
     end

data/lib/inertia_rails/rspec.rb

@@ -61,7 +61,7 @@ RSpec.configure do |config|
   config.before(:each, inertia: true) do
     new_renderer = InertiaRails::Renderer.method(:new)
     allow(InertiaRails::Renderer).to receive(:new) do |component, controller, request, response, render, named_args|
-      new_renderer.call(component, controller, request, response, inertia_wrap_render(render), named_args)
+      new_renderer.call(component, controller, request, response, inertia_wrap_render(render), **named_args)
     end
   end
 end

data/lib/inertia_rails/version.rb

@@ -1,3 +1,3 @@
 module InertiaRails
-  VERSION = "1.2.0"
+  VERSION = "1.4.0"
 end

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.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

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/request.rb

@@ -0,0 +1,9 @@
+ActionDispatch::Request.class_eval do
+  def inertia?
+    key? 'HTTP_X_INERTIA'
+  end
+
+  def inertia_partial?
+    key? 'HTTP_X_INERTIA_PARTIAL_DATA'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inertia_rails
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Brian Knoles
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-01 00:00:00.000000000 Z
+date: 2020-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -32,28 +32,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -105,9 +105,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/push.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -126,13 +126,20 @@ files:
 - lib/inertia_rails/renderer.rb
 - lib/inertia_rails/rspec.rb
 - lib/inertia_rails/version.rb
-homepage: https://github.com/inertiajs/inertia-rails/
+- 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
+- lib/patches/request.rb
+homepage: https://github.com/inertiajs/inertia-rails
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/inertiajs/inertia-rails/
-  source_code_uri: https://github.com/inertiajs/inertia-rails/
-  changelog_uri: https://github.com/inertiajs/inertia-rails//CHANGELOG.md
+  homepage_uri: https://github.com/inertiajs/inertia-rails
+  source_code_uri: https://github.com/inertiajs/inertia-rails
+  changelog_uri: https://github.com/inertiajs/inertia-rails/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.3
-before_install: gem install bundler -v 2.0.2