inertia_rails 3.6.1 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d06f57228ce3ff3b4dba1d2b7bdf99deaa110c8b85c474c106baa989dd1bf8c
-  data.tar.gz: ec01c88da7419b8dbf1cc1243eced6fd38c10a7fba1c21d75def08ae1516cf01
+  metadata.gz: 0f5f574a84809fccf65c7db0f58d34cb622b2ea4d403d05519736d2c44865f69
+  data.tar.gz: f62406133f1fa0698a8d2d24418a98f75e01d0400de356e879b86bbb4f657317
 SHA512:
-  metadata.gz: 6506c7ae154865ed78172e6f6bc2f28ff09cc8ee00faf25cb9d687f53143c9cbe7e105dbc297c028ceb29189070e63ba5484ecdf4c7217115b2d46b090389321
-  data.tar.gz: 7891ba539d642509920d1ab0d17c7c79e6bfbb1399c93c1c298a1ed20367b5a758352c644fc2794ea2309053a452643d807a26a1167b67a93e68febeabe9170e
+  metadata.gz: 691824db56620d1812c14db827f9dbffb2e6da89ba4c46f688ef8aa177afa8dc8db1e08a329559fc07e395d22adef18e30ead862e422a4a32001999767b3429f
+  data.tar.gz: e2331144a98cafd06a09e6019477265915638d328ac006868e3ea2922f513330af5241e28702d4aeb0b52a4e4cb077a77788954c924fcdcccde86bd18198f52d

data/CHANGELOG.md

@@ -4,6 +4,13 @@ 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.7.0] - 2025-03-17
+
+* Docs updates
+* Configuration via ENV variables (#196, @skryukov)
+* Routing improvements for the inertia routes helper (#195, @skryukov)
+* When automatically determining the component path, the component name can now be omitted, instead of requiring `render inertia: true` (#199, @skryukov)
+
 ## [3.6.1] - 2025-02-04
 
 * Install generator tweaks @skryukov

data/lib/inertia_rails/configuration.rb

@@ -29,6 +29,23 @@ module InertiaRails
 
     OPTION_NAMES = DEFAULTS.keys.freeze
 
+    class << self
+      def default
+        new(**DEFAULTS, **env_options)
+      end
+
+      private
+
+      def env_options
+        DEFAULTS.keys.each_with_object({}) do |key, hash|
+          value = ENV.fetch("INERTIA_#{key.to_s.upcase}", nil)
+          next if value.nil?
+
+          hash[key] = %w[true false].include?(value) ? value == 'true' : value
+        end
+      end
+    end
+
     protected attr_reader :controller
     protected attr_reader :options
 
@@ -36,9 +53,9 @@ module InertiaRails
       @controller = controller
       @options = attrs.extract!(*OPTION_NAMES)
 
-      unless attrs.empty?
-        raise ArgumentError, "Unknown options for #{self.class}: #{attrs.keys}"
-      end
+      return if attrs.empty?
+
+      raise ArgumentError, "Unknown options for #{self.class}: #{attrs.keys}"
     end
 
     def bind_controller(controller)
@@ -56,7 +73,7 @@ module InertiaRails
     end
 
     def merge(config)
-      Configuration.new(**@options.merge(config.options))
+      Configuration.new(**@options, **config.options)
     end
 
     # Internal: Finalizes the configuration for a specific controller.
@@ -70,23 +87,22 @@ module InertiaRails
     end
 
     OPTION_NAMES.each do |option|
-      define_method(option) {
-        evaluate_option @options[option]
-      } unless method_defined?(option)
-      define_method("#{option}=") { |value|
+      unless method_defined?(option)
+        define_method(option) do
+          evaluate_option options[option]
+        end
+      end
+      define_method("#{option}=") do |value|
         @options[option] = value
-      }
-    end
-
-    def self.default
-      new(**DEFAULTS)
+      end
     end
 
-  private
+    private
 
     def evaluate_option(value)
       return value unless value.respond_to?(:call)
       return value.call unless controller
+
       controller.instance_exec(&value)
     end
   end

data/lib/inertia_rails/renderer.rb

@@ -19,31 +19,41 @@ module InertiaRails
       :clear_history
     )
 
-    def initialize(component, controller, request, response, render_method, props: nil, view_data: nil, deep_merge: nil, encrypt_history: nil, clear_history: nil)
+    def initialize(component, controller, request, response, render_method, props: nil, view_data: nil,
+                   deep_merge: nil, encrypt_history: nil, clear_history: nil)
+      if component.is_a?(Hash) && !props.nil?
+        raise ArgumentError,
+              'Parameter `props` is not allowed when passing a Hash as the first argument'
+      end
+
       @controller = controller
       @configuration = controller.__send__(:inertia_configuration)
       @component = resolve_component(component)
       @request = request
       @response = response
       @render_method = render_method
-      @props = props || controller.__send__(:inertia_view_assigns)
+      @props = props || (component.is_a?(Hash) ? component : controller.__send__(:inertia_view_assigns))
       @view_data = view_data || {}
-      @deep_merge = !deep_merge.nil? ? deep_merge : configuration.deep_merge_shared_data
-      @encrypt_history = !encrypt_history.nil? ? encrypt_history : configuration.encrypt_history
+      @deep_merge = deep_merge.nil? ? configuration.deep_merge_shared_data : deep_merge
+      @encrypt_history = encrypt_history.nil? ? configuration.encrypt_history : encrypt_history
       @clear_history = clear_history || controller.session[:inertia_clear_history] || false
     end
 
     def render
-      if @response.headers["Vary"].blank?
-        @response.headers["Vary"] = 'X-Inertia'
-      else
-        @response.headers["Vary"] = "#{@response.headers["Vary"]}, X-Inertia"
-      end
+      @response.headers['Vary'] = if @response.headers['Vary'].blank?
+                                    'X-Inertia'
+                                  else
+                                    "#{@response.headers['Vary']}, X-Inertia"
+                                  end
       if @request.headers['X-Inertia']
         @response.set_header('X-Inertia', 'true')
         @render_method.call json: page.to_json, status: @response.status, content_type: Mime[:json]
       else
-        return render_ssr if configuration.ssr_enabled rescue nil
+        begin
+          return render_ssr if configuration.ssr_enabled
+        rescue StandardError
+          nil
+        end
         @render_method.call template: 'inertia', layout: layout, locals: view_data.merge(page: page)
       end
     end
@@ -54,13 +64,13 @@ module InertiaRails
       uri = URI("#{configuration.ssr_url}/render")
       res = JSON.parse(Net::HTTP.post(uri, page.to_json, 'Content-Type' => 'application/json').body)
 
-      controller.instance_variable_set("@_inertia_ssr_head", res['head'].join.html_safe)
+      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
       layout = configuration.layout
-      layout.nil? ? true : layout
+      layout.nil? || layout
     end
 
     def shared_data
@@ -81,19 +91,19 @@ module InertiaRails
     end
 
     def computed_props
-      _props = merge_props(shared_data, props)
+      merged_props = merge_props(shared_data, props)
 
-      deep_transform_props _props do |prop, path|
+      deep_transform_props merged_props do |prop, path|
         next [DONT_KEEP_PROP] unless keep_prop?(prop, path)
 
         transformed_prop = case prop
-        when BaseProp
-          prop.call(controller)
-        when Proc
-          controller.instance_exec(&prop)
-        else
-          prop
-        end
+                           when BaseProp
+                             prop.call(controller)
+                           when Proc
+                             controller.instance_exec(&prop)
+                           else
+                             prop
+                           end
 
         [KEEP_PROP, transformed_prop]
       end
@@ -119,7 +129,7 @@ module InertiaRails
     end
 
     def deep_transform_props(props, parent_path = [], &block)
-      props.reduce({}) do |transformed_props, (key, prop)|
+      props.each_with_object({}) do |(key, prop), transformed_props|
         current_path = parent_path + [key]
 
         if prop.is_a?(Hash) && prop.any?
@@ -129,8 +139,6 @@ module InertiaRails
           action, transformed_prop = block.call(prop, current_path)
           transformed_props.merge!(key => transformed_prop) if action == KEEP_PROP
         end
-
-        transformed_props
       end
     end
 
@@ -165,9 +173,11 @@ module InertiaRails
     end
 
     def resolve_component(component)
-      return component unless component.is_a? TrueClass
-
-      configuration.component_path_resolver(path: controller.controller_path, action: controller.action_name)
+      if component == true || component.is_a?(Hash)
+        configuration.component_path_resolver(path: controller.controller_path, action: controller.action_name)
+      else
+        component
+      end
     end
 
     def keep_prop?(prop, path)

data/lib/inertia_rails/version.rb

@@ -1,3 +1,3 @@
 module InertiaRails
-  VERSION = "3.6.1"
+  VERSION = "3.7.0"
 end

data/lib/inertia_rails.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'inertia_rails/renderer'
 require 'inertia_rails/engine'
 
@@ -17,7 +19,7 @@ ActionController::Renderers.add :inertia do |component, options|
     view_data: options[:view_data],
     deep_merge: options[:deep_merge],
     encrypt_history: options[:encrypt_history],
-    clear_history: options[:clear_history],
+    clear_history: options[:clear_history]
   ).render
 end
 

data/lib/patches/mapper.rb

@@ -1,10 +1,25 @@
 module InertiaRails
   module InertiaMapper
-    def inertia(args, &block)
-      route = args.keys.first
-      component = args.values.first
+    def inertia(*args, **options)
+      path = args.any? ? args.first : options
+      route, component = extract_route_and_component(path)
+      scope module: nil do
+        get(route, to: 'inertia_rails/static#static', defaults: { component: component }, **options)
+      end
+    end
+
+    private
 
-      get(route => 'inertia_rails/static#static', defaults: { component: component })
+    def extract_route_and_component(path)
+      if path.is_a?(Hash)
+        path.first
+      elsif resource_scope?
+        [path, InertiaRails.configuration.component_path_resolver(path: [@scope[:module], @scope[:controller]].compact.join('/'), action: path)]
+      elsif @scope[:module].blank?
+        [path, path]
+      else
+        [path, InertiaRails.configuration.component_path_resolver(path: @scope[:module], action: path)]
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inertia_rails
 version: !ruby/object:Gem::Version
-  version: 3.6.1
+  version: 3.7.0
 platform: ruby
 authors:
 - Brian Knoles
@@ -9,7 +9,7 @@ authors:
 - Eugene Granovsky
 bindir: bin
 cert_chain: []
-date: 2025-02-05 00:00:00.000000000 Z
+date: 2025-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties