inertia_rails 3.2.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76a7152d32edba5a140ed16b25efe25a6766a7d53c955f39f6b5efb2b5fc0d12
-  data.tar.gz: c1dc0d2bf09b2f3c71e4729a26dc6c24c78dc0fe4c5b8d09484bacee18543953
+  metadata.gz: 58d0616b3504cdbe3a0002ea2568b8af2bf8ab442882115109c1c4fcd636fbf2
+  data.tar.gz: ad704410b5c41f0c75a6dc6b2029e9e3742ec16539ab607414f86d0c63a7a397
 SHA512:
-  metadata.gz: 70ff7787dd839a58c652ffe5fa402be2baa2036ea54b86b2b033ecaf2062304a4f5e8433316eea192ab25009d6c5e8b1cf45dfeba71dc6f8775b361cb3055f50
-  data.tar.gz: 9e9072c293cd62385df9e8be3f464c7b688acc665ad4ce40daea5fd29c0414c18ba5c9f72967edfc3c7963974867d2791486e78714cea98ac212c64f38144ccb
+  metadata.gz: b19bade9694bad666820b90e25727658679ce057c06c501f95344d70cbced198ed217d5f965d8146eb303ae48794675e93da9cd371c012afb8965533cf8c9eba
+  data.tar.gz: 1a1ce123b90feecc66c211ea38cbcd4a3db6d2696ec0807a0e196baad99b32901d205fefae38497db2eba22d8da7f7dbc8b2923c20474f6626d639e7c033a99d

data/CHANGELOG.md

@@ -4,6 +4,23 @@ 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.4.0] - 2024-11-02
+
+* Inertia Rails documentation (@skryukov)
+* Add specs for config refactor (#139)
+* New feature: if/unless/only/except options for inertia_share. Enables per-action sharing! (#137, @skryukov)
+* Bugfix: for inertia errors when using message_pack to serialize cookies. (#143, @BenMorganMY)
+* Test Rails 7.2 in CI/CD (#145, @skryukov)
+* Bring redirect behavior in line with Rails 7.0 behavior (#146, @skryukov)
+* Gemspec cleanup (#149, @skryukov)
+
+## [3.3.0] - 2024-10-27
+
+* Refactor Inertia configuration into a controller class method. Thanks @ElMassimo!
+* Documentation updates. Thanks @osbre and @austenmadden!
+* Further fixes to the `Vary` header. Thanks @skryukov!
+* Add configuration option for the component path in the renderer.
+
 ## [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!

data/README.md

@@ -7,14 +7,26 @@
 
 ### Backend
 
-Just add the inertia rails gem to your Gemfile
+Add the `inertia_rails` gem to your Gemfile.
+
 ```ruby
 gem 'inertia_rails'
 ```
 
+For more instructions, see [Server-side setup](https://inertia-rails.netlify.app/guide/server-side-setup.html).
+
 ### Frontend
 
-Rails 7 specific frontend docs coming soon. For now, check out the official Inertia docs at https://inertiajs.com/ or see an example using React/Vite [here](https://github.com/BrandonShar/inertia-rails-template)
+We are discussing on bringing official docs for Inertia Rails to this repo, as
+the [official docs](https://inertiajs.com/client-side-setup) are specific to Laravel.
+
+In the meantime, you can refer to the community-maintained [Client-side setup](https://inertia-rails.netlify.app/guide/client-side-setup.html).
+
+Examples:
+
+- [React/Vite](https://github.com/BrandonShar/inertia-rails-template)
+- [React/Vite + SSR](https://github.com/ElMassimo/inertia-rails-ssr-template)
+- [PingCRM with Vue and Vite](https://github.com/ledermann/pingcrm)
 
 ## Usage
 
@@ -63,12 +75,24 @@ end
 In order to use instance props, you must call `use_inertia_instance_props` on the controller (or a base controller it inherits from). If any props are provided manually, instance props
 are automatically disabled for that response. Instance props are only included if they are defined after the before filter is set from `use_inertia_instance_props`.
 
-Automatic component name is also opt in, you must set the `default_render` config value to `true`. Otherwise, you can simply `render inertia: true` for the same behavior explicitly. 
+Automatic component name is also opt in, you must set the [`default_render`](#default_render) config value to `true`. Otherwise, you can simply `render inertia: true` for the same behavior explicitly.
+
+If the default component path doesn't match your convention, you can define a method to resolve it however you like via the `component_path_resolver` config value. The value of this should be callable and will receive the path and action and should return a string component path.
+
+```ruby
+inertia_config(
+  component_path_resolver: ->(path:, action:) do
+    "Storefront/#{path.camelize}/#{action.camelize}"
+  end
+)
+
+```
+
+
 
 ### Layout 
 
-Inertia layouts use the rails layout convention and can be set or changed in the same way. The original `layout` config option is still functional, but will likely be deprecated in the future in favor
-of using rails layouts.
+Inertia layouts use the rails layout convention and can be set or changed in the same way.
 
 ```ruby
 class EventsController < ApplicationController
@@ -133,20 +157,14 @@ end
 }
 ```
 
-Deep merging can be set as the project wide default via the InertiaRails configuration:
+Deep merging can be configured using the [`deep_merge_shared_data`](#deep_merge_shared_data) configuration option.
 
-```ruby
-# config/initializers/some_initializer.rb
-InertiaRails.configure do |config|
-  config.deep_merge_shared_data = true
-end
-
-```
-
-If deep merging is enabled by default, it's possible to opt out within the action:
+If deep merging is enabled, you can still opt-out within the action:
 
 ```ruby
 class CrazyScorersController < ApplicationController
+  inertia_config(deep_merge_shared_data: true)
+
   inertia_share do
     {
       basketball_data: {
@@ -163,7 +181,7 @@ class CrazyScorersController < ApplicationController
   end
 end
 
-# Even if deep merging is set by default, since the renderer has `deep_merge: false`, it will send a shallow merge to the frontend:
+# `deep_merge: false` overrides the default:
 {
   basketball_data: {
     points: 100,
@@ -177,6 +195,9 @@ On the front end, Inertia supports the concept of "partial reloads" where only t
 
 ```ruby
   inertia_share some_data: InertiaRails.lazy(lambda { some_very_slow_method })
+
+  # Using a Ruby block syntax
+  inertia_share some_data: InertiaRails.lazy { some_very_slow_method }
 ```
 
 ### Routing
@@ -187,34 +208,85 @@ If you don't need a controller to handle a static component, you can route direc
 inertia 'about' => 'AboutComponent'
 ```
 
-### SSR
+### SSR _(experimental)_
+
+Enable SSR via the configuration options for [`ssr_enabled`](#ssr_enabled-experimental) and [`ssr_url`](#ssr_url-experimental).
+
+When using SSR, don't forget to add `<%= inertia_ssr_head %>` to the `<head>` of your layout (i.e. `application.html.erb`).
 
-Enable SSR via the config settings for `ssr_enabled` and `ssr_url`.
+## Configuration ⚙️
 
-When using SSR, don't forget to add `<%= inertia_headers %>` to the `<head>` of your `application.html.erb`.
+Inertia Rails can be configured globally or in a specific controller (and subclasses).
 
-## Configuration
+### Global Configuration
 
-Inertia Rails has a few different configuration options that can be set anywhere, but the most common location is from within an initializer.
+If using global configuration, we recommend you place the code inside an initializer:
 
-The default config is shown below
 ```ruby
+# config/initializers/inertia.rb
+
 InertiaRails.configure do |config|
-  
-  # set the current version for automatic asset refreshing. A string value should be used if any.
-  config.version = nil
-  # enable default inertia rendering (warning! this will override rails default rendering behavior)
-  config.default_render = true
-  
-  # ssr specific options
-  config.ssr_enabled = false
-  config.ssr_url = 'http://localhost:13714'
+  # Example: force a full-reload if the deployed assets change.
+  config.version = ViteRuby.digest
+end
+```
 
-  config.deep_merge_shared_data = false
-  
+The default configuration can be found [here](https://github.com/inertiajs/inertia-rails/blob/master/lib/inertia_rails/configuration.rb#L5-L22).
+
+### Local Configuration
+
+Use `inertia_config` in your controllers to override global settings:
+
+```ruby
+class EventsController < ApplicationController
+  inertia_config(
+    version: "events-#{InertiaRails.configuration.version}",
+    ssr_enabled: -> { action_name == "index" },
+  )
 end
 ```
 
+### Configuration Options
+
+#### `version` _(recommended)_
+
+  This allows Inertia to detect if the app running in the client is oudated,
+  forcing a full page visit instead of an XHR visit on the next request.
+
+  See [assets versioning](https://inertiajs.com/asset-versioning).
+
+  __Default__: `nil`
+
+#### `deep_merge_shared_data`
+
+  When enabled, props will be deep merged with shared data, combining hashes
+  with the same keys instead of replacing them.
+
+  __Default__: `false`
+
+#### `default_render`
+
+  Overrides Rails default rendering behavior to render using Inertia by default.
+
+  __Default__: `false`
+
+#### `ssr_enabled` _(experimental)_
+
+  Whether to use a JavaScript server to pre-render your JavaScript pages,
+  allowing your visitors to receive fully rendered HTML when they first visit
+  your application.
+
+  Requires a JS server to be available at `ssr_url`. [_Example_](https://github.com/ElMassimo/inertia-rails-ssr-template)
+
+  __Default__: `false`
+
+#### `ssr_url` _(experimental)_
+
+  The URL of the JS server that will pre-render the app using the specified
+  component and props.
+
+  __Default__: `"http://localhost:13714"`
+
 ## Testing
 
 If you're using Rspec, Inertia Rails comes with some nice test helpers to make things simple. 

data/lib/inertia_rails/action_filter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+#
+# Based on AbstractController::Callbacks::ActionFilter
+# https://github.com/rails/rails/blob/v7.2.0/actionpack/lib/abstract_controller/callbacks.rb#L39
+module InertiaRails
+  class ActionFilter
+    def initialize(conditional_key, actions)
+      @conditional_key = conditional_key
+      @actions = Array(actions).map(&:to_s).to_set
+    end
+
+    def match?(controller)
+      missing_action = @actions.find { |action| !controller.available_action?(action) }
+      if missing_action
+        message = <<~MSG
+          The #{missing_action} action could not be found for the :inertia_share
+          callback on #{controller.class.name}, but it is listed in the controller's
+          #{@conditional_key.inspect} option.
+        MSG
+
+        raise AbstractController::ActionNotFound.new(message, controller, missing_action)
+      end
+
+      @actions.include?(controller.action_name)
+    end
+  end
+end

data/lib/inertia_rails/configuration.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module InertiaRails
+  class Configuration
+    DEFAULTS = {
+      # Whether to combine hashes with the same keys instead of replacing them.
+      deep_merge_shared_data: false,
+
+      # Overrides Rails default rendering behavior to render using Inertia by default.
+      default_render: false,
+
+      # Allows the user to hook into the default rendering behavior and change it to fit their needs
+      component_path_resolver: ->(path:, action:) { "#{path}/#{action}" },
+
+      # DEPRECATED: Let Rails decide which layout should be used based on the
+      # controller configuration.
+      layout: true,
+
+      # SSR options.
+      ssr_enabled: false,
+      ssr_url: 'http://localhost:13714',
+
+      # Used to detect version drift between server and client.
+      version: nil,
+    }.freeze
+
+    OPTION_NAMES = DEFAULTS.keys.freeze
+
+    protected attr_reader :controller
+    protected attr_reader :options
+
+    def initialize(controller: nil, **attrs)
+      @controller = controller
+      @options = attrs.extract!(*OPTION_NAMES)
+
+      unless attrs.empty?
+        raise ArgumentError, "Unknown options for #{self.class}: #{attrs.keys}"
+      end
+    end
+
+    def bind_controller(controller)
+      Configuration.new(**@options, controller: controller)
+    end
+
+    def freeze
+      @options.freeze
+      super
+    end
+
+    def merge!(config)
+      @options.merge!(config.options)
+      self
+    end
+
+    def merge(config)
+      Configuration.new(**@options.merge(config.options))
+    end
+
+    # Internal: Finalizes the configuration for a specific controller.
+    def with_defaults(config)
+      @options = config.options.merge(@options)
+      freeze
+    end
+
+    def component_path_resolver(path:, action:)
+      @options[:component_path_resolver].call(path:, action:)
+    end
+
+    OPTION_NAMES.each do |option|
+      define_method(option) {
+        evaluate_option @options[option]
+      } unless method_defined?(option)
+      define_method("#{option}=") { |value|
+        @options[option] = value
+      }
+    end
+
+    def self.default
+      new(**DEFAULTS)
+    end
+
+  private
+
+    def evaluate_option(value)
+      return value unless value.respond_to?(:call)
+      return value.call unless controller
+      controller.instance_exec(&value)
+    end
+  end
+end

data/lib/inertia_rails/controller.rb

@@ -1,37 +1,42 @@
 require_relative "inertia_rails"
+require_relative "helper"
+require_relative "action_filter"
 
 module InertiaRails
   module Controller
     extend ActiveSupport::Concern
 
     included do
-      helper_method :inertia_headers
-
-      before_action do
-        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 !protect_against_forgery?
+        cookies['XSRF-TOKEN'] = form_authenticity_token if protect_against_forgery?
       end
     end
 
     module ClassMethods
-      def inertia_share(hash = nil, &block)
-        before_action do
-          @_inertia_shared_plain_data = @_inertia_shared_plain_data.merge(hash) if hash
-          @_inertia_shared_blocks = @_inertia_shared_blocks + [block] if block_given?
+      def inertia_share(hash = nil, **props, &block)
+        options = extract_inertia_share_options(props)
+        return push_to_inertia_share(**(hash || props), &block) if options.empty?
+
+        push_to_inertia_share do
+          next unless options[:if].all? { |filter| instance_exec(&filter) } if options[:if]
+          next unless options[:unless].none? { |filter| instance_exec(&filter)  } if options[:unless]
+
+          next hash unless block
+
+          res = instance_exec(&block)
+          hash ? hash.merge(res) : res
+        end
+      end
+
+      def inertia_config(**attrs)
+        config = InertiaRails::Configuration.new(**attrs)
+
+        if @inertia_config
+          @inertia_config.merge!(config)
+        else
+          @inertia_config = config
         end
       end
 
@@ -41,55 +46,108 @@ module InertiaRails
           @_inertia_skip_props = view_assigns.keys + ['_inertia_skip_props']
         end
       end
-    end
 
-    def inertia_headers
-      @_inertia_html_headers.join.html_safe
-    end
+      def _inertia_configuration
+        @_inertia_configuration ||= begin
+          config = superclass.try(:_inertia_configuration) || ::InertiaRails.configuration
+          @inertia_config&.with_defaults(config) || config
+        end
+      end
+
+      def _inertia_shared_data
+        @_inertia_shared_data ||= begin
+          shared_data = superclass.try(:_inertia_shared_data)
+
+          if @inertia_share && shared_data.present?
+            shared_data + @inertia_share.freeze
+          else
+            @inertia_share || shared_data || []
+          end.freeze
+        end
+      end
+
+      private
+
+      def push_to_inertia_share(**attrs, &block)
+        @inertia_share ||= []
+        @inertia_share << attrs.freeze unless attrs.empty?
+        @inertia_share << block if block
+      end
+
+      def extract_inertia_share_options(props)
+        options = props.slice(:if, :unless, :only, :except)
+
+        return options if options.empty?
+
+        if props.except(:if, :unless, :only, :except).any?
+          raise ArgumentError, "You must not mix shared data and [:if, :unless, :only, :except] options, pass data as a hash or a block."
+        end
+
+        transform_inertia_share_option(options, :only, :if)
+        transform_inertia_share_option(options, :except, :unless)
+
+        options.transform_values! do |filters|
+          Array(filters).map!(&method(:filter_to_proc))
+        end
+
+        options
+      end
+
+      def transform_inertia_share_option(options, from, to)
+        if (from_value = options.delete(from))
+          filter = InertiaRails::ActionFilter.new(from, from_value)
+          options[to] = Array(options[to]).unshift(filter)
+        end
+      end
 
-    def inertia_headers=(value)
-      @_inertia_html_headers = value
+      def filter_to_proc(filter)
+        case filter
+        when Symbol
+          -> { send(filter) }
+        when Proc
+          filter
+        when InertiaRails::ActionFilter
+          -> { filter.match?(self) }
+        else
+          raise ArgumentError, "You must pass a symbol or a proc as a filter."
+        end
+      end
     end
 
     def default_render
-      if InertiaRails.default_render?
+      if inertia_configuration.default_render
         render(inertia: true)
       else
         super
       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)
+      super
     end
 
-    def redirect_back(fallback_location:, allow_other_host: true, **options)
-      capture_inertia_errors(options)
-      super(
-        fallback_location: fallback_location,
-        allow_other_host: allow_other_host,
-        **options,
-      )
-    end
+    private
 
     def inertia_view_assigns
       return {} unless @_inertia_instance_props
       view_assigns.except(*@_inertia_skip_props)
     end
 
-    private
+    def inertia_configuration
+      self.class._inertia_configuration.bind_controller(self)
+    end
 
-    def inertia_layout
-      layout = ::InertiaRails.layout
+    def inertia_shared_data
+      initial_data = session[:inertia_errors].present? ? {errors: session[:inertia_errors]} : {}
 
-      # When the global configuration is not set, let Rails decide which layout
-      # should be used based on the controller configuration.
-      layout.nil? ? true : layout
+      self.class._inertia_shared_data.filter_map { |shared_data|
+        if shared_data.respond_to?(:call)
+          instance_exec(&shared_data)
+        else
+          shared_data
+        end
+      }.reduce(initial_data, &:merge)
     end
 
     def inertia_location(url)
@@ -99,12 +157,8 @@ module InertiaRails
 
     def capture_inertia_errors(options)
       if (inertia_errors = options.dig(:inertia, :errors))
-        session[:inertia_errors] = inertia_errors
+        session[:inertia_errors] = inertia_errors.to_hash
       end
     end
-
-    def evaluated_blocks
-      (@_inertia_shared_blocks || []).map { |block| instance_exec(&block) }.reduce(&:merge) || {}
-    end
   end
 end

data/lib/inertia_rails/helper.rb

@@ -0,0 +1,14 @@
+require_relative 'inertia_rails'
+
+module InertiaRails::Helper
+  def inertia_ssr_head
+    controller.instance_variable_get("@_inertia_ssr_head")
+  end
+
+  def inertia_headers
+    InertiaRails.deprecator.warn(
+      "`inertia_headers` is deprecated and will be removed in InertiaRails 4.0, use `inertia_ssr_head` instead."
+    )
+    inertia_ssr_head
+  end
+end

data/lib/inertia_rails/inertia_rails.rb

@@ -1,52 +1,20 @@
 # Needed for `thread_mattr_accessor`
 require 'active_support/core_ext/module/attribute_accessors_per_thread'
 require 'inertia_rails/lazy'
+require 'inertia_rails/configuration'
 
 module InertiaRails
-  def self.configure
-    yield(Configuration)
-  end
-
-  def self.version
-    Configuration.evaluated_version
-  end
-
-  def self.layout
-    Configuration.layout
-  end
-
-  def self.ssr_enabled?
-    Configuration.ssr_enabled
-  end
+  CONFIGURATION = Configuration.default
 
-  def self.ssr_url
-    Configuration.ssr_url
-  end
-
-  def self.default_render?
-    Configuration.default_render
+  def self.configure
+    yield(CONFIGURATION)
   end
 
-  def self.deep_merge_shared_data?
-    Configuration.deep_merge_shared_data
+  def self.configuration
+    CONFIGURATION
   end
 
   def self.lazy(value = nil, &block)
     InertiaRails::Lazy.new(value, &block)
   end
-
-  private
-
-  module Configuration
-    mattr_accessor(:layout) { nil }
-    mattr_accessor(:version) { nil }
-    mattr_accessor(:ssr_enabled) { false }
-    mattr_accessor(:ssr_url) { 'http://localhost:13714' }
-    mattr_accessor(:default_render) { false }
-    mattr_accessor(:deep_merge_shared_data) { false }
-
-    def self.evaluated_version
-      self.version.respond_to?(:call) ? self.version.call : self.version
-    end
-  end
 end

data/lib/inertia_rails/middleware.rb

@@ -5,8 +5,7 @@ module InertiaRails
     end
 
     def call(env)
-      InertiaRailsRequest.new(@app, env)
-                         .response
+      InertiaRailsRequest.new(@app, env).response
     end
 
     class InertiaRailsRequest
@@ -58,11 +57,15 @@ module InertiaRails
         request_method == 'GET'
       end
 
+      def controller
+        @env["action_controller.instance"]
+      end
+
       def request_method
         @env['REQUEST_METHOD']
       end
 
-      def inertia_version
+      def client_version
         @env['HTTP_X_INERTIA_VERSION']
       end
 
@@ -71,17 +74,15 @@ module InertiaRails
       end
 
       def version_stale?
-        sent_version != saved_version
+        coerce_version(client_version) != coerce_version(server_version)
       end
 
-      def sent_version
-        return nil if inertia_version.nil?
-
-        InertiaRails.version.is_a?(Numeric) ? inertia_version.to_f : inertia_version
+      def server_version
+        controller&.send(:inertia_configuration)&.version
       end
 
-      def saved_version
-        InertiaRails.version.is_a?(Numeric) ? InertiaRails.version.to_f : InertiaRails.version
+      def coerce_version(version)
+        server_version.is_a?(Numeric) ? version.to_f : version
       end
 
       def force_refresh(request)

data/lib/inertia_rails/renderer.rb

@@ -1,52 +1,74 @@
+require 'net/http'
+require 'json'
 require_relative "inertia_rails"
 
 module InertiaRails
   class Renderer
-    attr_reader :component, :view_data
+    attr_reader(
+      :component,
+      :configuration,
+      :controller,
+      :props,
+      :view_data,
+    )
 
     def initialize(component, controller, request, response, render_method, props: nil, view_data: nil, deep_merge: nil)
-      @component = component.is_a?(TrueClass) ? "#{controller.controller_path}/#{controller.action_name}" : component
       @controller = controller
+      @configuration = controller.__send__(:inertia_configuration)
+      @component = resolve_component(component)
       @request = request
       @response = response
       @render_method = render_method
-      @props = props ? props : controller.inertia_view_assigns
+      @props = props || controller.__send__(:inertia_view_assigns)
       @view_data = view_data || {}
-      @deep_merge = !deep_merge.nil? ? deep_merge : InertiaRails.deep_merge_shared_data?
+      @deep_merge = !deep_merge.nil? ? deep_merge : configuration.deep_merge_shared_data
     end
 
     def render
+      if @response.headers["Vary"].blank?
+        @response.headers["Vary"] = 'X-Inertia'
+      else
+        @response.headers["Vary"] = "#{@response.headers["Vary"]}, X-Inertia"
+      end
       if @request.headers['X-Inertia']
-        @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
-        return render_ssr if ::InertiaRails.ssr_enabled? rescue nil
-        @render_method.call template: 'inertia', layout: layout, locals: (view_data).merge({page: page})
+        return render_ssr if configuration.ssr_enabled rescue nil
+        @render_method.call template: 'inertia', layout: layout, locals: view_data.merge(page: page)
       end
     end
 
     private
 
     def render_ssr
-      uri = URI("#{::InertiaRails.ssr_url}/render")
+      uri = URI("#{configuration.ssr_url}/render")
       res = JSON.parse(Net::HTTP.post(uri, page.to_json, 'Content-Type' => 'application/json').body)
 
-      @controller.inertia_headers = res['head']
-      @render_method.call html: res['body'].html_safe, layout: layout, locals: (view_data).merge({page: page})
+      controller.instance_variable_set("@_inertia_ssr_head", res['head'].join.html_safe)
+      @render_method.call html: res['body'].html_safe, layout: layout, locals: view_data.merge(page: page)
     end
 
     def layout
-      @controller.send(:inertia_layout)
+      layout = configuration.layout
+      layout.nil? ? true : layout
+    end
+
+    def shared_data
+      controller.__send__(:inertia_shared_data)
+    end
+
+    # Cast props to symbol keyed hash before merging so that we have a consistent data structure and
+    # avoid duplicate keys after merging.
+    #
+    # 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.
+    def merge_props(shared_data, props)
+      shared_data.deep_symbolize_keys.send(@deep_merge ? :deep_merge : :merge, props.deep_symbolize_keys)
     end
 
     def computed_props
-      # Cast props to symbol keyed hash before merging so that we have a consistent data structure and
-      # avoid duplicate keys after merging.
-      #
-      # 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 = @controller.shared_data.merge.deep_symbolize_keys.send(prop_merge_method, @props.deep_symbolize_keys).select do |key, prop|
+      _props = merge_props(shared_data, props).select do |key, prop|
         if rendering_partial_component?
           key.in? partial_keys
         else
@@ -57,7 +79,7 @@ module InertiaRails
       deep_transform_values(
         _props,
         lambda do |prop|
-          prop.respond_to?(:call) ? @controller.instance_exec(&prop) : prop
+          prop.respond_to?(:call) ? controller.instance_exec(&prop) : prop
         end
       )
     end
@@ -67,7 +89,7 @@ module InertiaRails
         component: component,
         props: computed_props,
         url: @request.original_fullpath,
-        version: ::InertiaRails.version,
+        version: configuration.version,
       }
     end
 
@@ -85,8 +107,10 @@ module InertiaRails
       @request.inertia_partial? && @request.headers['X-Inertia-Partial-Component'] == component
     end
 
-    def prop_merge_method
-      @deep_merge ? :deep_merge : :merge
+    def resolve_component(component)
+      return component unless component.is_a? TrueClass
+
+      configuration.component_path_resolver(path: controller.controller_path, action: controller.action_name)
     end
   end
 end

data/lib/inertia_rails/rspec.rb

@@ -25,9 +25,16 @@ module InertiaRails
       protected
     
       def set_values(params)
-        @view_data = params[:locals].except(:page)
-        @props = params[:locals][:page][:props]
-        @component = params[:locals][:page][:component]
+        if params[:locals].present?
+          @view_data = params[:locals].except(:page)
+          @props = params[:locals][:page][:props]
+          @component = params[:locals][:page][:component]
+        else
+          # Sequential Inertia request
+          @view_data = {}
+          @props = params[:json][:props]
+          @component = params[:json][:component]
+        end
       end
     end
 

data/lib/inertia_rails/version.rb

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

data/lib/inertia_rails.rb

@@ -21,4 +21,8 @@ end
 
 module InertiaRails
   class Error < StandardError; end
+
+  def self.deprecator # :nodoc:
+    @deprecator ||= ActiveSupport::Deprecation.new
+  end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: inertia_rails
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Brian Knoles
 - Brandon Shar
 - Eugene Granovsky
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -18,135 +18,29 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   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
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: rails-controller-testing
-  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: sqlite3
-  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
-    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: debug
-  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'
-description:
+        version: '6'
+description: Quickly build modern single-page React, Vue and Svelte apps using classic
+  server-side routing and controllers.
 email:
-- brain@bellawatt.com
+- brian@bellawatt.com
 - brandon@bellawatt.com
 - eugene@bellawatt.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/push.yml"
-- ".gitignore"
-- ".rspec"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - app/controllers/inertia_rails/static_controller.rb
 - app/views/inertia.html.erb
-- bin/console
-- bin/setup
-- inertia_rails.gemspec
 - lib/generators/inertia_rails/install/controller.rb
 - lib/generators/inertia_rails/install/react/InertiaExample.jsx
 - lib/generators/inertia_rails/install/react/inertia.jsx
@@ -156,8 +50,11 @@ files:
 - lib/generators/inertia_rails/install/vue/inertia.js
 - lib/generators/inertia_rails/install_generator.rb
 - lib/inertia_rails.rb
+- lib/inertia_rails/action_filter.rb
+- lib/inertia_rails/configuration.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
@@ -175,9 +72,12 @@ homepage: https://github.com/inertiajs/inertia-rails
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/inertiajs/inertia-rails/issues
+  changelog_uri: https://github.com/inertiajs/inertia-rails/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/inertiajs/inertia-rails/blob/master/README.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/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -193,8 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: Inertia adapter for Rails
+summary: Inertia.js adapter for Rails
 test_files: []

data/.github/workflows/push.yml

@@ -1,33 +0,0 @@
-name: Testing
-
-on: [push, pull_request]
-
-jobs:
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        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@v4
-
-      - name: Setup System
-        run: sudo apt-get install libsqlite3-dev
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-        env:
-          RAILS_VERSION:  ${{ matrix.rails }}
-
-      - name: Run tests
-        run: bundle exec rake
-        env:
-          RAILS_VERSION: ${{ matrix.rails }}

data/.gitignore

@@ -1,22 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/Gemfile.lock
-
-/spec/dummy/db/*.sqlite3
-/spec/dummy/db/*.sqlite3-journal
-/spec/dummy/db/log/*.log
-/spec/dummy/tmp/
-/spec/dummy/.sass-cache
-/spec/dummy/log/
-
-# rspec failure tracking
-.rspec_status
-
-# Appraisal
-gemfiles/*.gemfile.lock

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require rails_helper

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at TODO: Write your email address. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "inertia_rails/rails"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/inertia_rails.gemspec

@@ -1,37 +0,0 @@
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "inertia_rails/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "inertia_rails"
-  spec.version       = InertiaRails::VERSION
-  spec.authors       = ["Brian Knoles", "Brandon Shar", "Eugene Granovsky"]
-  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.license       = "MIT"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "railties", '>= 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-controller-testing"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "responders"
-  spec.add_development_dependency "debug"
-end