inertia_rails 3.4.0 → 3.6.0

data/lib/inertia_rails/inertia_rails.rb

@@ -1,20 +1,42 @@
-# Needed for `thread_mattr_accessor`
-require 'active_support/core_ext/module/attribute_accessors_per_thread'
-require 'inertia_rails/lazy'
+require 'inertia_rails/base_prop'
+require 'inertia_rails/ignore_on_first_load_prop'
+require 'inertia_rails/always_prop'
+require 'inertia_rails/lazy_prop'
+require 'inertia_rails/optional_prop'
+require 'inertia_rails/defer_prop'
+require 'inertia_rails/merge_prop'
 require 'inertia_rails/configuration'
 
 module InertiaRails
-  CONFIGURATION = Configuration.default
+  class << self
+    CONFIGURATION = Configuration.default
 
-  def self.configure
-    yield(CONFIGURATION)
-  end
+    def configure
+      yield(CONFIGURATION)
+    end
 
-  def self.configuration
-    CONFIGURATION
-  end
+    def configuration
+      CONFIGURATION
+    end
+
+    def lazy(value = nil, &block)
+      LazyProp.new(value, &block)
+    end
+
+    def optional(&block)
+      OptionalProp.new(&block)
+    end
+
+    def always(&block)
+      AlwaysProp.new(&block)
+    end
+
+    def merge(&block)
+      MergeProp.new(&block)
+    end
 
-  def self.lazy(value = nil, &block)
-    InertiaRails::Lazy.new(value, &block)
+    def defer(group: nil, merge: nil, &block)
+      DeferProp.new(group: group, merge: merge, &block)
+    end
   end
 end

data/lib/inertia_rails/lazy_prop.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module InertiaRails
+  class LazyProp < IgnoreOnFirstLoadProp
+    def initialize(value = nil, &block)
+      raise ArgumentError, 'You must provide either a value or a block, not both' if value && block
+
+      InertiaRails.deprecator.warn(
+        '`lazy` is deprecated and will be removed in InertiaRails 4.0, use `optional` instead.'
+      )
+
+      @value = value
+      @block = block
+    end
+
+    def call(controller)
+      value.respond_to?(:call) ? controller.instance_exec(&value) : value
+    end
+
+    def value
+      @value.nil? ? @block : @value
+    end
+  end
+end

data/lib/inertia_rails/merge_prop.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module InertiaRails
+  class MergeProp < BaseProp
+    def initialize(*)
+      super
+      @merge = true
+    end
+
+    def merge?
+      @merge
+    end
+  end
+end

data/lib/inertia_rails/middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InertiaRails
   class Middleware
     def initialize(app)
@@ -20,7 +22,10 @@ module InertiaRails
         request = ActionDispatch::Request.new(@env)
 
         # Inertia errors are added to the session via redirect_to
-        request.session.delete(:inertia_errors) unless keep_inertia_errors?(status)
+        unless keep_inertia_session_options?(status)
+          request.session.delete(:inertia_errors)
+          request.session.delete(:inertia_clear_history)
+        end
 
         status = 303 if inertia_non_post_redirect?(status)
 
@@ -29,7 +34,7 @@ module InertiaRails
 
       private
 
-      def keep_inertia_errors?(status)
+      def keep_inertia_session_options?(status)
         redirect_status?(status) || stale_inertia_request?
       end
 

data/lib/inertia_rails/optional_prop.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module InertiaRails
+  class OptionalProp < IgnoreOnFirstLoadProp
+  end
+end

data/lib/inertia_rails/renderer.rb

@@ -1,18 +1,25 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'json'
-require_relative "inertia_rails"
+require_relative 'inertia_rails'
 
 module InertiaRails
   class Renderer
+    KEEP_PROP = :keep
+    DONT_KEEP_PROP = :dont_keep
+
     attr_reader(
       :component,
       :configuration,
       :controller,
       :props,
       :view_data,
+      :encrypt_history,
+      :clear_history
     )
 
-    def initialize(component, controller, request, response, render_method, props: nil, view_data: nil, deep_merge: nil)
+    def initialize(component, controller, request, response, render_method, props: nil, view_data: nil, deep_merge: nil, encrypt_history: nil, clear_history: nil)
       @controller = controller
       @configuration = controller.__send__(:inertia_configuration)
       @component = resolve_component(component)
@@ -22,6 +29,8 @@ module InertiaRails
       @props = props || 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
+      @clear_history = clear_history || controller.session[:inertia_clear_history] || false
     end
 
     def render
@@ -64,47 +73,95 @@ 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.
     def merge_props(shared_data, props)
-      shared_data.deep_symbolize_keys.send(@deep_merge ? :deep_merge : :merge, props.deep_symbolize_keys)
+      if @deep_merge
+        shared_data.deep_symbolize_keys.deep_merge!(props.deep_symbolize_keys)
+      else
+        shared_data.symbolize_keys.merge(props.symbolize_keys)
+      end
     end
 
     def computed_props
-      _props = merge_props(shared_data, props).select do |key, prop|
-        if rendering_partial_component?
-          key.in? partial_keys
+      _props = merge_props(shared_data, props)
+
+      deep_transform_props _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.is_a?(InertiaRails::Lazy)
+          prop
         end
-      end
 
-      deep_transform_values(
-        _props,
-        lambda do |prop|
-          prop.respond_to?(:call) ? controller.instance_exec(&prop) : prop
-        end
-      )
+        [KEEP_PROP, transformed_prop]
+      end
     end
 
     def page
-      {
+      default_page = {
         component: component,
         props: computed_props,
         url: @request.original_fullpath,
         version: configuration.version,
+        encryptHistory: encrypt_history,
+        clearHistory: clear_history,
       }
+
+      deferred_props = deferred_props_keys
+      default_page[:deferredProps] = deferred_props if deferred_props.present?
+
+      merge_props = merge_props_keys
+      default_page[:mergeProps] = merge_props if merge_props.present?
+
+      default_page
+    end
+
+    def deep_transform_props(props, parent_path = [], &block)
+      props.reduce({}) do |transformed_props, (key, prop)|
+        current_path = parent_path + [key]
+
+        if prop.is_a?(Hash) && prop.any?
+          nested = deep_transform_props(prop, current_path, &block)
+          transformed_props.merge!(key => nested) unless nested.empty?
+        else
+          action, transformed_prop = block.call(prop, current_path)
+          transformed_props.merge!(key => transformed_prop) if action == KEEP_PROP
+        end
+
+        transformed_props
+      end
     end
 
-    def deep_transform_values(hash, proc)
-      return proc.call(hash) unless hash.is_a? Hash
+    def deferred_props_keys
+      return if rendering_partial_component?
+
+      @props.each_with_object({}) do |(key, prop), result|
+        (result[prop.group] ||= []) << key if prop.is_a?(DeferProp)
+      end
+    end
 
-      hash.transform_values {|value| deep_transform_values(value, proc)}
+    def merge_props_keys
+      @props.each_with_object([]) do |(key, prop), result|
+        result << key if prop.try(:merge?) && reset_keys.exclude?(key)
+      end
     end
 
     def partial_keys
-      (@request.headers['X-Inertia-Partial-Data'] || '').split(',').compact.map(&:to_sym)
+      @partial_keys ||= (@request.headers['X-Inertia-Partial-Data'] || '').split(',').compact
+    end
+
+    def reset_keys
+      (@request.headers['X-Inertia-Reset'] || '').split(',').compact.map(&:to_sym)
+    end
+
+    def partial_except_keys
+      (@request.headers['X-Inertia-Partial-Except'] || '').split(',').compact
     end
 
     def rendering_partial_component?
-      @request.inertia_partial? && @request.headers['X-Inertia-Partial-Component'] == component
+      @request.headers['X-Inertia-Partial-Component'] == component
     end
 
     def resolve_component(component)
@@ -112,5 +169,34 @@ module InertiaRails
 
       configuration.component_path_resolver(path: controller.controller_path, action: controller.action_name)
     end
+
+    def keep_prop?(prop, path)
+      return true if prop.is_a?(AlwaysProp)
+
+      if rendering_partial_component?
+        path_with_prefixes = path_prefixes(path)
+        return false if excluded_by_only_partial_keys?(path_with_prefixes)
+        return false if excluded_by_except_partial_keys?(path_with_prefixes)
+      end
+
+      # Precedence: Evaluate IgnoreOnFirstLoadProp only after partial keys have been checked
+      return false if prop.is_a?(IgnoreOnFirstLoadProp) && !rendering_partial_component?
+
+      true
+    end
+
+    def path_prefixes(parts)
+      (0...parts.length).map do |i|
+        parts[0..i].join('.')
+      end
+    end
+
+    def excluded_by_only_partial_keys?(path_with_prefixes)
+      partial_keys.present? && (path_with_prefixes & partial_keys).empty?
+    end
+
+    def excluded_by_except_partial_keys?(path_with_prefixes)
+      partial_except_keys.present? && (path_with_prefixes & partial_except_keys).any?
+    end
   end
 end

data/lib/inertia_rails/version.rb

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

data/lib/inertia_rails.rb

@@ -16,6 +16,8 @@ ActionController::Renderers.add :inertia do |component, options|
     props: options[:props],
     view_data: options[:view_data],
     deep_merge: options[:deep_merge],
+    encrypt_history: options[:encrypt_history],
+    clear_history: options[:clear_history],
   ).render
 end
 

data/lib/patches/better_errors.rb

@@ -4,14 +4,16 @@
 # https://github.com/BetterErrors/better_errors/blob/v2.5.1/lib/better_errors/middleware.rb
 #
 
-if defined?(BetterErrors)
-  BetterErrors::Middleware.class_eval do
-    prepend(InertiaBetterErrors = Module.new do
-      def text?(env)
-        return false if env["HTTP_X_INERTIA"]
+module InertiaRails
+  module InertiaBetterErrors
+    def text?(env)
+      return false if env["HTTP_X_INERTIA"]
 
-        super
-      end
-    end)
+      super
+    end
   end
 end
+
+if defined?(BetterErrors)
+  BetterErrors::Middleware.include InertiaRails::InertiaBetterErrors
+end

data/lib/patches/debug_exceptions/patch-5-0.rb

@@ -4,8 +4,8 @@
 # https://github.com/rails/rails/blob/5-0-stable/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb
 #
 
-ActionDispatch::DebugExceptions.class_eval do
-  prepend(InertiaDebugExceptions = Module.new do
+module InertiaRails
+  module InertiaDebugExceptions
     def render_for_default_application(request, wrapper)
       template = create_template(request, wrapper)
       file = "rescues/#{wrapper.rescue_template}"
@@ -19,5 +19,9 @@ ActionDispatch::DebugExceptions.class_eval do
       end
       render(wrapper.status_code, body, format)
     end
-  end)
+  end
+end
+
+if defined?(ActionDispatch::DebugExceptions)
+  ActionDispatch::DebugExceptions.prepend InertiaRails::InertiaDebugExceptions
 end

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

@@ -6,8 +6,8 @@
 # https://github.com/rails/rails/blob/6-0-stable/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb
 #
 
-ActionDispatch::DebugExceptions.class_eval do
-  prepend(InertiaDebugExceptions = Module.new do
+module InertiaRails
+  module InertiaDebugExceptions
     def render_for_browser_request(request, wrapper)
       template = create_template(request, wrapper)
       file = "rescues/#{wrapper.rescue_template}"
@@ -22,5 +22,9 @@ ActionDispatch::DebugExceptions.class_eval do
 
       render(wrapper.status_code, body, format)
     end
-  end)
+  end
+end
+
+if defined?(ActionDispatch::DebugExceptions)
+  ActionDispatch::DebugExceptions.prepend InertiaRails::InertiaDebugExceptions
 end

data/lib/patches/mapper.rb

@@ -1,8 +1,12 @@
-ActionDispatch::Routing::Mapper.class_eval do
-  def inertia(args, &block)
-    route = args.keys.first
-    component = args.values.first
+module InertiaRails
+  module InertiaMapper
+    def inertia(args, &block)
+      route = args.keys.first
+      component = args.values.first
 
-    get(route => 'inertia_rails/static#static', defaults: {component: component})
+      get(route => 'inertia_rails/static#static', defaults: { component: component })
+    end
   end
 end
+
+ActionDispatch::Routing::Mapper.include InertiaRails::InertiaMapper

data/lib/patches/request.rb

@@ -1,9 +1,13 @@
-ActionDispatch::Request.class_eval do
-  def inertia?
-    key? 'HTTP_X_INERTIA'
-  end
+module InertiaRails
+  module InertiaRequest
+    def inertia?
+      key? 'HTTP_X_INERTIA'
+    end
 
-  def inertia_partial?
-    key? 'HTTP_X_INERTIA_PARTIAL_DATA'
+    def inertia_partial?
+      key?('HTTP_X_INERTIA_PARTIAL_COMPONENT')
+    end
   end
 end
+
+ActionDispatch::Request.include InertiaRails::InertiaRequest