inertia_rails 3.1.3 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73c0eee6bb3d9b70f170fe1af57d20043c907a28f6e37bb2987eecc39d2aecc8
-  data.tar.gz: f91e31fdd2b74126315d6c2ee92fa6e7ff2ec3bb7074e9dca72a51e53c3a325a
+  metadata.gz: 76a7152d32edba5a140ed16b25efe25a6766a7d53c955f39f6b5efb2b5fc0d12
+  data.tar.gz: c1dc0d2bf09b2f3c71e4729a26dc6c24c78dc0fe4c5b8d09484bacee18543953
 SHA512:
-  metadata.gz: bc7fe92ee4b773d360af5887bdf7ea0b445d0a7da3efa316000a5550795eecb587c76c0f36b62d4b98c74ec138fd6aab21367e9d8b7cca444cb44c37c4450460
-  data.tar.gz: e3ded5b185819a1913ed7f4468dafcc0bc19db26778972932886084fc8a199ce85dd910ad2b1853f670c3a644f928d647ffe2f015411a8b9e52adc67ae03ffea
+  metadata.gz: 70ff7787dd839a58c652ffe5fa402be2baa2036ea54b86b2b033ecaf2062304a4f5e8433316eea192ab25009d6c5e8b1cf45dfeba71dc6f8775b361cb3055f50
+  data.tar.gz: 9e9072c293cd62385df9e8be3f464c7b688acc665ad4ce40daea5fd29c0414c18ba5c9f72967edfc3c7963974867d2791486e78714cea98ac212c64f38144ccb

data/.github/workflows/push.yml

@@ -7,17 +7,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.6, 2.7]
-        rails: ['5.1', '5.2', '6.0', '6.1', '7.0']
-        exclude:
-          - rails: '7.0'
-            ruby: 2.6
+        ruby: ['3.1', '3.2', '3.3']
+        rails: ['6.1', '7.0', '7.1']
 
     runs-on: ubuntu-latest
     name: Test against Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Setup System
         run: sudo apt-get install libsqlite3-dev
@@ -26,14 +23,11 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-
-      - name: Install gems
+          bundler-cache: true
         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
+          RAILS_VERSION:  ${{ matrix.rails }}
 
       - name: Run tests
         run: bundle exec rake
+        env:
+          RAILS_VERSION: ${{ matrix.rails }}

data/CHANGELOG.md

@@ -4,6 +4,17 @@ 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).
 
+## [3.2.0] - 2024-06-19
+
+* Refactor the internals of shared Inertia data to use controller instance variables instead of module level variables that run a higher risk of being leaked between requests. Big thanks to @ledermann for the initial work many years ago and to @PedroAugustoRamalhoDuarte for finishing it up!
+* Change the Inertia response to set the `Vary` header to `X-Inertia` instead of `Accept`, Thanks @osbre!
+* Always set the `XSRF-TOKEN` in an `after_action` request instead of only on non-Inertia requests. This fixes a bug where logging out (and resetting the session) via Inertia would create a CSRF token mismatch on a subsequent Inertia request (until you manually hard refreshed the page). Thanks @jordanhiltunen!
+
+## [3.1.4] - 2024-04-28
+
+* Reset Inertia shared data after each RSpec example where `inertia: true` is used. Thanks @coreyaus!
+* Update Github Actions workflows to use currently supported Ruby/Rails versions. Thanks @PedroAugustoRamalhoDuarte!
+
 ## [3.1.3] - 2023-11-03
 
 * Depend on railties instead of rails so that applications which only use pieces of Rails can avoid a full Rails installation. Thanks @BenMorganMY!

data/Gemfile

@@ -2,3 +2,6 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in inertia-rails.gemspec
 gemspec
+
+version = ENV["RAILS_VERSION"] || "7.1"
+gem "rails", "~> #{version}.0"

data/inertia_rails.gemspec

@@ -32,7 +32,6 @@ Gem::Specification.new do |spec|
   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"
   spec.add_development_dependency "responders"
   spec.add_development_dependency "debug"
 end

data/lib/inertia_rails/controller.rb

@@ -1,27 +1,37 @@
 require_relative "inertia_rails"
-require_relative "helper"
 
 module InertiaRails
   module Controller
     extend ActiveSupport::Concern
 
     included do
+      helper_method :inertia_headers
+
       before_action do
-        # :inertia_errors are deleted from the session by the middleware
-        InertiaRails.share(errors: session[:inertia_errors]) if session[:inertia_errors].present?
+        error_sharing = proc do
+          # :inertia_errors are deleted from the session by the middleware
+          if @_request && session[:inertia_errors].present?
+            { errors: session[:inertia_errors] }
+          else
+            {}
+          end
+        end
+
+        @_inertia_shared_plain_data ||= {}
+        @_inertia_shared_blocks ||= [error_sharing]
+        @_inertia_html_headers ||= []
       end
-      helper ::InertiaRails::Helper
 
       after_action do
-        cookies['XSRF-TOKEN'] = form_authenticity_token unless request.inertia? || !protect_against_forgery?
+        cookies['XSRF-TOKEN'] = form_authenticity_token unless !protect_against_forgery?
       end
     end
 
     module ClassMethods
-      def inertia_share(**args, &block)
+      def inertia_share(hash = nil, &block)
         before_action do
-          InertiaRails.share(**args) if args
-          InertiaRails.share_block(block) if block
+          @_inertia_shared_plain_data = @_inertia_shared_plain_data.merge(hash) if hash
+          @_inertia_shared_blocks = @_inertia_shared_blocks + [block] if block_given?
         end
       end
 
@@ -33,6 +43,14 @@ module InertiaRails
       end
     end
 
+    def inertia_headers
+      @_inertia_html_headers.join.html_safe
+    end
+
+    def inertia_headers=(value)
+      @_inertia_html_headers = value
+    end
+
     def default_render
       if InertiaRails.default_render?
         render(inertia: true)
@@ -41,6 +59,10 @@ module InertiaRails
       end
     end
 
+    def shared_data
+      (@_inertia_shared_plain_data || {}).merge(evaluated_blocks)
+    end
+
     def redirect_to(options = {}, response_options = {})
       capture_inertia_errors(response_options)
       super(options, response_options)
@@ -80,5 +102,9 @@ module InertiaRails
         session[:inertia_errors] = inertia_errors
       end
     end
+
+    def evaluated_blocks
+      (@_inertia_shared_blocks || []).map { |block| instance_exec(&block) }.reduce(&:merge) || {}
+    end
   end
 end

data/lib/inertia_rails/inertia_rails.rb

@@ -3,20 +3,10 @@ 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
-  thread_mattr_accessor :threadsafe_html_headers
-
   def self.configure
     yield(Configuration)
   end
 
-  # "Getters"
-  def self.shared_data(controller)
-    shared_plain_data.
-      merge!(evaluated_blocks(controller, shared_blocks))
-  end
-
   def self.version
     Configuration.evaluated_version
   end
@@ -35,35 +25,12 @@ module InertiaRails
 
   def self.default_render?
     Configuration.default_render
-  end 
-
-  def self.html_headers
-    self.threadsafe_html_headers || []
   end
 
   def self.deep_merge_shared_data?
     Configuration.deep_merge_shared_data
   end
 
-  # "Setters"
-  def self.share(**args)
-    self.shared_plain_data = self.shared_plain_data.merge(args)
-  end
-
-  def self.share_block(block)
-    self.shared_blocks = self.shared_blocks + [block]
-  end
-
-  def self.html_headers=(headers)
-    self.threadsafe_html_headers = headers
-  end
-
-  def self.reset!
-    self.shared_plain_data = {}
-    self.shared_blocks = []
-    self.html_headers = []
-  end
-
   def self.lazy(value = nil, &block)
     InertiaRails::Lazy.new(value, &block)
   end
@@ -82,25 +49,4 @@ module InertiaRails
       self.version.respond_to?(:call) ? self.version.call : self.version
     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
 end

data/lib/inertia_rails/middleware.rb

@@ -7,8 +7,6 @@ module InertiaRails
     def call(env)
       InertiaRailsRequest.new(@app, env)
                          .response
-    ensure
-      ::InertiaRails.reset!
     end
 
     class InertiaRailsRequest
@@ -22,7 +20,7 @@ module InertiaRails
         status, headers, body = @app.call(@env)
         request = ActionDispatch::Request.new(@env)
 
-        # Inertia errors are added to the session via redirect_to 
+        # 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)
@@ -97,4 +95,3 @@ module InertiaRails
     end
   end
 end
-

data/lib/inertia_rails/renderer.rb

@@ -1,5 +1,3 @@
-require 'net/http'
-require 'json'
 require_relative "inertia_rails"
 
 module InertiaRails
@@ -19,7 +17,7 @@ module InertiaRails
 
     def render
       if @request.headers['X-Inertia']
-        @response.set_header('Vary', 'Accept')
+        @response.set_header('Vary', 'X-Inertia')
         @response.set_header('X-Inertia', 'true')
         @render_method.call json: page, status: @response.status, content_type: Mime[:json]
       else
@@ -33,8 +31,8 @@ module InertiaRails
     def render_ssr
       uri = URI("#{::InertiaRails.ssr_url}/render")
       res = JSON.parse(Net::HTTP.post(uri, page.to_json, 'Content-Type' => 'application/json').body)
-      
-      ::InertiaRails.html_headers = res['head']
+
+      @controller.inertia_headers = res['head']
       @render_method.call html: res['body'].html_safe, layout: layout, locals: (view_data).merge({page: page})
     end
 
@@ -48,7 +46,7 @@ module InertiaRails
       #
       # Functionally, this permits using either string or symbol keys in the controller. Since the results
       # is cast to json, we should treat string/symbol keys as identical.
-      _props = ::InertiaRails.shared_data(@controller).deep_symbolize_keys.send(prop_merge_method, @props.deep_symbolize_keys).select do |key, prop|
+      _props = @controller.shared_data.merge.deep_symbolize_keys.send(prop_merge_method, @props.deep_symbolize_keys).select do |key, prop|
         if rendering_partial_component?
           key.in? partial_keys
         else

data/lib/inertia_rails/version.rb

@@ -1,3 +1,3 @@
 module InertiaRails
-  VERSION = "3.1.3"
+  VERSION = "3.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inertia_rails
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.2.0
 platform: ruby
 authors:
 - Brian Knoles
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-03 00:00:00.000000000 Z
+date: 2024-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -96,20 +96,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: responders
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +136,6 @@ files:
 - ".github/workflows/push.yml"
 - ".gitignore"
 - ".rspec"
-- Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -161,11 +146,6 @@ files:
 - app/views/inertia.html.erb
 - bin/console
 - bin/setup
-- gemfiles/rails_5.1.gemfile
-- gemfiles/rails_5.2.gemfile
-- gemfiles/rails_6.0.gemfile
-- gemfiles/rails_6.1.gemfile
-- gemfiles/rails_7.0.gemfile
 - inertia_rails.gemspec
 - lib/generators/inertia_rails/install/controller.rb
 - lib/generators/inertia_rails/install/react/InertiaExample.jsx
@@ -178,7 +158,6 @@ files:
 - lib/inertia_rails.rb
 - lib/inertia_rails/controller.rb
 - lib/inertia_rails/engine.rb
-- lib/inertia_rails/helper.rb
 - lib/inertia_rails/inertia_rails.rb
 - lib/inertia_rails/lazy.rb
 - lib/inertia_rails/middleware.rb
@@ -214,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: Inertia adapter for Rails

data/Appraisals

@@ -1,19 +0,0 @@
-appraise "rails-7.0" do
-  gem "rails", "~> 7.0"
-end
-
-appraise "rails-6.1" do
-  gem "rails", "~> 6.1.0"
-end
-
-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

data/gemfiles/rails_5.1.gemfile

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

data/gemfiles/rails_5.2.gemfile

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

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

data/gemfiles/rails_6.1.gemfile

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

data/gemfiles/rails_7.0.gemfile

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

data/lib/inertia_rails/helper.rb

@@ -1,7 +0,0 @@
-require_relative 'inertia_rails'
-
-module InertiaRails::Helper
-  def inertia_headers
-    ::InertiaRails.html_headers.join.html_safe
-  end
-end