inertia_rails 1.3.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 684a3d8e7aa84b71947e75e79b991c9321a1b7dc86b57b3fae25cc1845518d03
-  data.tar.gz: 82d04030486998787f63d998a58ee4b6c3720c2e3424e9b76d937bb26a438f33
+  metadata.gz: b889c5a06cf6c9310b1d64c1e19a5e979aea7ba874c3014867a462386dd28937
+  data.tar.gz: c5e1bf21eb3ff8dc1e14ebadedf43bb82f8b1af6aa46680610ad4b0054d90b3b
 SHA512:
-  metadata.gz: d9fd1e10102a1ab46234b855308c5d7dcb1cf04e956b972760a741b609de9e473a6a56815580ec1c059cc1f13c1b7d65950ca73d707599e5a5e28c6905000f82
-  data.tar.gz: e6fe87e5459eaa6e4309d165b665170ea4bcda4f7d3b4ce8c52ac7a9424d116d1672f2c2033c6ba927edaf9b40dcb5b9c6b84c5eeff64545c89a6ca48fddab93
+  metadata.gz: 65a66ab26b16808a9b88467a6b579074f68ba68877c055b8d2e333422454041f3461ff4ab0a947f2a52572edd8bf1c88d62d6d32ec7a1c8bd6ca776158f756c0
+  data.tar.gz: 724961702c0bd5ffb53e427d8791f1064dcc080c4cbc253297f30207c0017065b0f2c12b4822c5969401582972810c8960fbc494884bebb32fe1df907e6a7d79

data/.github/workflows/push.yml

@@ -1,24 +1,34 @@
 name: Testing
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.6, 2.7]
+        rails: ['5.0', '5.1', '5.2', '6.0']
+
     runs-on: ubuntu-latest
+    name: Test against Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
 
       - name: Setup System
         run: sudo apt-get install libsqlite3-dev
 
-      - name: Set up Ruby 2.6
-        uses: actions/setup-ruby@v1
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.6.x
+          ruby-version: ${{ matrix.ruby }}
 
       - name: Install gems
+        env:
+          MATRIX_RAILS_VERSION: ${{ matrix.rails }}
         run: |
+          export BUNDLE_GEMFILE="${GITHUB_WORKSPACE}/gemfiles/rails_${MATRIX_RAILS_VERSION}.gemfile"
           gem install bundler
           bundle install --jobs 4 --retry 3
 

data/.gitignore

@@ -17,3 +17,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+# Appraisal
+gemfiles/*.gemfile.lock

data/Appraisals

@@ -0,0 +1,15 @@
+appraise "rails-6.0" do
+  gem "rails", "~> 6.0.3", '>= 6.0.3.2'
+end
+
+appraise "rails-5.2" do
+  gem "rails", "~> 5.2.4", '>= 5.2.4.3'
+end
+
+appraise "rails-5.1" do
+  gem "rails", "~> 5.1.7"
+end
+
+appraise "rails-5.0" do
+  gem "rails", "~> 5.0.7", '>= 5.0.7.2'
+end

data/CHANGELOG.md

@@ -4,6 +4,32 @@ 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.6.0] - 2020-11-20
+
+* Built in error sharing across redirects! adding `{ inertia: { errors: 'errors go here' } }` as an option in `redirect_to` will automatically feed an `errors` prop to whatever is rendered after the redirect.
+* Set content type to json for Inertia responses
+* Return the original response status with Inertia responses
+
+## [1.5.0] - 2020-10-07
+
+* Test against multiple Rails versions in Github Actions
+* Add the `inertia_location` controller method that forces a full page refresh
+
+## [1.4.1] - 2020-08-06
+
+* Fixed a bug involving threadsafe versions and layouts
+
+## [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

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/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.0.7", ">= 5.0.7.2"
+
+gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.1.7"
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2.4", ">= 5.2.4.3"
+
+gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.0.3", ">= 6.0.3.2"
+
+gemspec path: "../"

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
@@ -25,10 +25,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "rails", '>= 5'
+
   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 "rails"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec-rails", "~> 4.0"
   spec.add_development_dependency "rails-controller-testing"
   spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "appraisal"
 end

data/lib/inertia_rails/controller.rb

@@ -4,13 +4,33 @@ module InertiaRails
   module Controller
     extend ActiveSupport::Concern
 
+    included do
+      before_action do
+        # :inertia_errors are deleted from the session by the middleware
+        InertiaRails.share(errors: session[:inertia_errors]) if session[:inertia_errors].present?
+      end
+    end
+
     module ClassMethods
       def inertia_share(**args, &block)
         before_action do
-          InertiaRails.share(args) if args
+          InertiaRails.share(**args) if args
           InertiaRails.share_block(block) if block
         end
       end
     end
+
+    def inertia_location(url)
+      headers['X-Inertia-Location'] = url
+      head :conflict
+    end
+
+    def redirect_to(options = {}, response_options = {})
+      if (inertia_errors = response_options.fetch(:inertia, {}).fetch(:errors, nil))
+        session[:inertia_errors] = inertia_errors
+      end
+
+      super(options, response_options)
+    end
   end
 end

data/lib/inertia_rails/inertia_rails.rb

@@ -1,6 +1,9 @@
+# Needed for `thread_mattr_accessor`
+require 'active_support/core_ext/module/attribute_accessors_per_thread'
+
 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 +24,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!
@@ -44,6 +47,23 @@ module InertiaRails
     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)
     blocks.flat_map { |block| controller.instance_exec(&block) }.reduce(&:merge) || {}
   end

data/lib/inertia_rails/middleware.rb

@@ -3,41 +3,78 @@ module InertiaRails
     def initialize(app)
       @app = app
     end
-  
+
     def call(env)
+      @env = env
+
       status, headers, body = @app.call(env)
       request = ActionDispatch::Request.new(env)
 
       ::InertiaRails.reset!
-  
-      return [status, headers, body] unless env['HTTP_X_INERTIA'].present?
-  
-      return force_refresh(request) if stale?(env['REQUEST_METHOD'], env['HTTP_X_INERTIA_VERSION'])
-  
-      if is_redirect_status?(status) &&
-          is_non_get_redirectable_method?(env['REQUEST_METHOD'])
-        status = 303
-      end
-  
-      [status, headers, body]
-    end
-  
+
+      # Inertia errors are added to the session via redirect_to 
+      request.session.delete(:inertia_errors) unless keep_inertia_errors?(status)
+
+      status = 303 if inertia_non_post_redirect?(status)
+
+      return stale_inertia_get? ? force_refresh(request) : [status, headers, body]
+    end
+
     private
-  
-    def is_redirect_status?(status)
+
+    def keep_inertia_errors?(status)
+      redirect_status?(status) || stale_inertia_request?
+    end
+
+    def stale_inertia_request?
+      inertia_request? && version_stale?
+    end
+
+    def redirect_status?(status)
       [301, 302].include? status
     end
-  
-    def is_non_get_redirectable_method?(request_method)
+
+    def non_get_redirectable_method?
       ['PUT', 'PATCH', 'DELETE'].include? request_method
     end
-  
-    def stale?(request_method, inertia_version)
-      sent_version = InertiaRails.version.is_a?(Numeric) ? inertia_version.to_f : inertia_version
-      saved_version = InertiaRails.version.is_a?(Numeric) ? InertiaRails.version.to_f : InertiaRails.version
-      request_method == 'GET' && sent_version != saved_version
+
+    def inertia_non_post_redirect?(status)
+      inertia_request? && redirect_status?(status) && non_get_redirectable_method?
+    end
+
+    def stale_inertia_get?
+      get? && stale_inertia_request?
     end
-  
+
+    def get?
+      request_method == 'GET'
+    end
+
+    def request_method
+      @env['REQUEST_METHOD']
+    end
+
+    def inertia_version
+      @env['HTTP_X_INERTIA_VERSION']
+    end
+
+    def inertia_request?
+      @env['HTTP_X_INERTIA'].present?
+    end
+
+    def version_stale?
+      sent_version != saved_version
+    end
+
+    def sent_version
+      return nil if inertia_version.nil?
+      InertiaRails.version.is_a?(Numeric) ? inertia_version.to_f : inertia_version
+    end
+
+    def saved_version
+      InertiaRails.version.is_a?(Numeric) ? InertiaRails.version.to_f : InertiaRails.version
+    end
+
     def force_refresh(request)
       request.flash.keep
       Rack::Response.new('', 409, {'X-Inertia-Location' => request.original_url}).finish

data/lib/inertia_rails/renderer.rb

@@ -18,7 +18,7 @@ module InertiaRails
       if @request.headers['X-Inertia']
         @response.set_header('Vary', 'Accept')
         @response.set_header('X-Inertia', 'true')
-        @render_method.call json: page, status: 200
+        @render_method.call json: page, status: @response.status, content_type: Mime[:json]
       else
         @render_method.call template: 'inertia', layout: ::InertiaRails.layout, locals: (view_data).merge({page: page})
       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.3.0"
+  VERSION = "1.6.0"
 end

data/lib/patches/debug_exceptions.rb

@@ -11,13 +11,7 @@ if defined?(ActionDispatch::DebugExceptions)
     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
+    # This gem supports Rails 5 or later
   end
 end

data/lib/patches/request.rb

@@ -2,4 +2,8 @@ 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.3.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Brian Knoles
@@ -10,8 +10,22 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-29 00:00:00.000000000 Z
+date: 2020-11-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -32,30 +46,30 @@ 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
+  name: rails-controller-testing
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -69,7 +83,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails-controller-testing
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -83,7 +97,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,6 +122,7 @@ files:
 - ".github/workflows/push.yml"
 - ".gitignore"
 - ".rspec"
+- Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -117,6 +132,10 @@ files:
 - app/views/inertia.html.erb
 - bin/console
 - bin/setup
+- gemfiles/rails_5.0.gemfile
+- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_6.0.gemfile
 - inertia_rails.gemspec
 - lib/inertia_rails.rb
 - lib/inertia_rails/controller.rb
@@ -128,18 +147,16 @@ files:
 - 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
 - lib/patches/request.rb
-homepage: https://github.com/inertiajs/inertia-rails/
+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:
@@ -155,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Inertia adapter for Rails

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

@@ -1,41 +0,0 @@
-# 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

@@ -1,52 +0,0 @@
-# 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