inertia_rails 1.4.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef2ef33ca24036a92d67ec557bab99829468a7f9546422b68a703624bd52489d
-  data.tar.gz: 6beb16df6b7511813b62e42e91fbb7d0a251264b2e802e0e0345b04bd08700ac
+  metadata.gz: f3300d5a0d8ba1a4a433151b232dc06a2fbbdc337f8c1948b6a1fd52dbc20b4d
+  data.tar.gz: 3a62632643c8761c00fe3b462f2710d094a9adb06df0d7942b516c669eec7515
 SHA512:
-  metadata.gz: 5e2d7527c48047f950207b163fa539b6b4735655d501a573035a782cb623f5973a74789574be6722bbf7bd4088835c5a486d9a8962df02d17473c4c2d42a0012
-  data.tar.gz: 96d8302e0fd851874d14ef2cee34c013278924c9e619d7302a2a66ae2a3c5dbd7c3a5e3a7ee2e01f8849adfbd0f54e65b1661cfeeb27320e8f94b415d8ca5567
+  metadata.gz: 29d82e990a312f2392f14b209c10d6cb198d1f335d0b0e33b2d6821d8bcbc51adeb6d489362fbf2f124bc0b3605d152eb8470221c061eaf6dcae5083f5e86a79
+  data.tar.gz: 44565a5b1b36086a7baf965671fd09d5b1e75f3ed393c7de459e5a3c4a7a2d17bd5f485f0f9b68261631cd47cd371439357cd1a852ed2d6a82aa71268c51aaf8

data/.github/workflows/push.yml

@@ -8,9 +8,10 @@ jobs:
       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 }}
+    name: Test against Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}
 
     steps:
       - uses: actions/checkout@v2
@@ -24,7 +25,10 @@ jobs:
           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,29 @@ 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.7.1] - 2020-11-24
+
+* Fix the definition for InertiaRails::Lazy to avoid an uninitialized constant error when booting an application. 
+
+## [1.7.0] - 2020-11-24
+
+* Add support for "lazy" props while rendering. These are props that never compute on the initial page load. The only render during a partial update that calls for them explicitly.
+
+## [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

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

@@ -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", "~> 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"
+  spec.add_development_dependency "appraisal"
 end

data/lib/inertia_rails/controller.rb

@@ -4,6 +4,13 @@ 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
@@ -12,5 +19,18 @@ module InertiaRails
         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,3 +1,7 @@
+# Needed for `thread_mattr_accessor`
+require 'active_support/core_ext/module/attribute_accessors_per_thread'
+require 'inertia_rails/lazy'
+
 module InertiaRails
   thread_mattr_accessor :threadsafe_shared_plain_data
   thread_mattr_accessor :threadsafe_shared_blocks
@@ -33,31 +37,19 @@ module InertiaRails
     self.shared_blocks = []
   end
 
+  def self.lazy(value = nil, &block)
+    InertiaRails::Lazy.new(value, &block)
+  end
+
   private
 
   module Configuration
-    thread_mattr_accessor :threadsafe_layout
-    thread_mattr_accessor :threadsafe_version
+    mattr_accessor(:layout) { 'application' }
+    mattr_accessor(:version) { nil }
 
     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

data/lib/inertia_rails/lazy.rb

@@ -0,0 +1,28 @@
+module InertiaRails
+  class Lazy
+    def initialize(value = nil, &block)
+      @value = value
+      @block = block
+    end
+
+    def call
+      to_proc.call
+    end
+
+    def to_proc
+      # This is called by controller.instance_exec, which changes self to the
+      # controller instance. That makes the instance variables unavailable to the
+      # proc via closure. Copying the instance variables to local variables before
+      # the proc is returned keeps them in scope for the returned proc.
+      value = @value
+      block = @block
+      if value.respond_to?(:call)
+        value
+      elsif value
+        Proc.new { value }
+      else
+        block
+      end
+    end
+  end
+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
@@ -27,13 +27,13 @@ module InertiaRails
     private
 
     def props
-      only = (@request.headers['X-Inertia-Partial-Data'] || '').split(',').compact.map(&:to_sym)
-
-      _props = ::InertiaRails.shared_data(@controller).merge(@props)
-
-      _props = (only.any? && @request.headers['X-Inertia-Partial-Component'] == component) ?
-        _props.select {|key| key.in? only} :
-        _props
+      _props = ::InertiaRails.shared_data(@controller).merge(@props).select do |key, prop|
+        if rendering_partial_component?
+          key.in? partial_keys
+        else
+          !prop.is_a?(InertiaRails::Lazy)
+        end
+      end
 
       deep_transform_values(_props, lambda {|prop| prop.respond_to?(:call) ? @controller.instance_exec(&prop) : prop })
     end
@@ -52,5 +52,13 @@ module InertiaRails
 
       hash.transform_values {|value| deep_transform_values(value, proc)}
     end
+
+    def partial_keys
+      (@request.headers['X-Inertia-Partial-Data'] || '').split(',').compact.map(&:to_sym)
+    end
+
+    def rendering_partial_component?
+      @request.inertia_partial? && @request.headers['X-Inertia-Partial-Component'] == component
+    end
   end
 end

data/lib/inertia_rails/version.rb

@@ -1,3 +1,3 @@
 module InertiaRails
-  VERSION = "1.4.0"
+  VERSION = "1.7.1"
 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inertia_rails
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.7.1
 platform: ruby
 authors:
 - Brian Knoles
@@ -10,8 +10,22 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2020-11-24 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
@@ -55,7 +69,7 @@ dependencies:
       - !ruby/object:Gem::Version
         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,19 +132,22 @@ 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
 - lib/inertia_rails/engine.rb
 - lib/inertia_rails/inertia_rails.rb
+- lib/inertia_rails/lazy.rb
 - lib/inertia_rails/middleware.rb
 - 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
 - lib/patches/request.rb
@@ -155,7 +173,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