inertia_rails 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef66baa0e1a57eca72a52421858b7d0f1cc27e6bd0bbf09f53d2c6440b677b94
-  data.tar.gz: 832a854fc9e749a365d3745521d256834eb778693e256cdda2321253eda47332
+  metadata.gz: 1703f19fcb6d8f3d2c580e6e7bd80ff999cda8f55f72f7ea915001279577386c
+  data.tar.gz: d5ff27be81328583e03aa7eb4473f1a4a966139993a3d856c54c0b6ae447b122
 SHA512:
-  metadata.gz: 1dc4a22fe2d2fd31fc1284030f2cc64f292cdc1224b15e37e2370d4f5b081c6240f6ed3340f827ccb9c0ad0b0022acdd51001ca3585c404ca1033b93b2503666
-  data.tar.gz: 9becf43df35016ef9659f0055439b599c88d0a422eec1d6728bbf22b2393cb16bd5b177b697044651a9c79c51be332d5a9564969b6773f0815fada77d6408fae
+  metadata.gz: 9cdd9eebf261e555bc09d237272852c4c59cf08618462f5deb5aaa314e09538e121a8c116e989c9c66632f38d2bcf14617d0d0f6ca9f5fe152e7b646a5a652f3
+  data.tar.gz: 4fea8b1605262d6d80ccec45fe68368b9f62ae4cd96cca7768b58b0b65e5a690877216f6f10f7d4e93915cbba8003b4635b99ea4b3af3f2100bceda8c572cd73

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.6.0] - 2024-12-13
+
+Support for the v2.0 Inertia.js release! It's a minor bump because there are no breaking changes!
+
+Kudos to @skryukov and @PedroAugustoRamalhoDuarte for driving the features in this release!
+
+* InertiaRails.defer for deferred props
+* History encryption
+* InertiaRails.merge for merge props
+* InertiaRails.optional props (replaces lazy props in v2.0, InertiaRails.lazy now has a deprecation warning)
+
 ## [3.5.0] - 2024-11-29
 
 * Add Algolia search for docs (#151, @skryukov)

data/README.md

@@ -188,15 +188,12 @@ end
 }
 ```
 
-### Lazy Props
+### Optional Props
 
-On the front end, Inertia supports the concept of "partial reloads" where only the props requested are returned by the server. Sometimes, you may want to use this flow to avoid processing a particularly slow prop on the intial load. In this case, you can use Lazy props. Lazy props aren't evaluated unless they're specifically requested by name in a partial reload.
+On the frontend, Inertia supports the concept of "partial reloads" where only the props requested are returned by the server. Sometimes, you may want to use this flow to avoid processing a particularly slow prop on the initial load. In this case, you can use Optional props. Optional props aren't evaluated unless they're specifically requested by name in a partial reload.
 
 ```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 }
+  inertia_share some_data: InertiaRails.optional { some_very_slow_method }
 ```
 
 ### Routing
@@ -269,6 +266,14 @@ end
 
   __Default__: `false`
 
+#### `encrypt_history`
+
+  When enabled, you instruct Inertia to encrypt your app's history, it uses
+  the browser's built-in [`crypto` api](https://developer.mozilla.org/en-US/docs/Web/API/Crypto)
+  to encrypt the current page's data before pushing it to the history state.
+
+  __Default__: `false`
+
 #### `ssr_enabled` _(experimental)_
 
   Whether to use a JavaScript server to pre-render your JavaScript pages,

data/lib/inertia_rails/configuration.rb

@@ -16,6 +16,9 @@ module InertiaRails
       # controller configuration.
       layout: true,
 
+      # Whether to encrypt the history state in the client.
+      encrypt_history: false,
+
       # SSR options.
       ssr_enabled: false,
       ssr_url: 'http://localhost:13714',

data/lib/inertia_rails/controller.rb

@@ -123,7 +123,7 @@ module InertiaRails
     end
 
     def redirect_to(options = {}, response_options = {})
-      capture_inertia_errors(response_options)
+      capture_inertia_session_options(response_options)
       super
     end
 
@@ -155,8 +155,10 @@ module InertiaRails
       head :conflict
     end
 
-    def capture_inertia_errors(options)
-      if (inertia_errors = options.dig(:inertia, :errors))
+    def capture_inertia_session_options(options)
+      return unless (inertia = options[:inertia])
+
+      if (inertia_errors = inertia[:errors])
         if inertia_errors.respond_to?(:to_hash)
           session[:inertia_errors] = inertia_errors.to_hash
         else
@@ -165,7 +167,10 @@ module InertiaRails
           )
           session[:inertia_errors] = inertia_errors
         end
+
       end
+
+      session[:inertia_clear_history] = inertia[:clear_history] if inertia[:clear_history]
     end
   end
 end

data/lib/inertia_rails/defer_prop.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module InertiaRails
+  class DeferProp < IgnoreOnFirstLoadProp
+    DEFAULT_GROUP = 'default'
+
+    attr_reader :group
+
+    def initialize(group: nil, merge: nil, &block)
+      super(&block)
+
+      @group = group || DEFAULT_GROUP
+      @merge = merge
+      @block = block
+    end
+
+    def merge?
+      @merge
+    end
+  end
+end

data/lib/inertia_rails/ignore_on_first_load_prop.rb

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

data/lib/inertia_rails/inertia_rails.rb

@@ -1,6 +1,10 @@
 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
@@ -19,8 +23,20 @@ module InertiaRails
       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 defer(group: nil, merge: nil, &block)
+      DeferProp.new(group: group, merge: merge, &block)
+    end
   end
 end

data/lib/inertia_rails/lazy_prop.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
 module InertiaRails
-  class LazyProp < BaseProp
+  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

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

@@ -2,7 +2,7 @@
 
 require 'net/http'
 require 'json'
-require_relative "inertia_rails"
+require_relative 'inertia_rails'
 
 module InertiaRails
   class Renderer
@@ -15,9 +15,11 @@ module InertiaRails
       :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)
@@ -27,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
@@ -96,12 +100,22 @@ module InertiaRails
     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)
@@ -120,8 +134,26 @@ module InertiaRails
       end
     end
 
+    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
+
+    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
+      @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
@@ -147,8 +179,8 @@ module InertiaRails
         return false if excluded_by_except_partial_keys?(path_with_prefixes)
       end
 
-      # Precedence: Evaluate LazyProp only after partial keys have been checked
-      return false if prop.is_a?(LazyProp) && !rendering_partial_component?
+      # Precedence: Evaluate IgnoreOnFirstLoadProp only after partial keys have been checked
+      return false if prop.is_a?(IgnoreOnFirstLoadProp) && !rendering_partial_component?
 
       true
     end

data/lib/inertia_rails/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inertia_rails
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Brian Knoles
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 2024-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -218,14 +218,18 @@ files:
 - lib/inertia_rails/base_prop.rb
 - lib/inertia_rails/configuration.rb
 - lib/inertia_rails/controller.rb
+- lib/inertia_rails/defer_prop.rb
 - lib/inertia_rails/engine.rb
 - lib/inertia_rails/generators/controller_template_base.rb
 - lib/inertia_rails/generators/helper.rb
 - lib/inertia_rails/generators/scaffold_template_base.rb
 - lib/inertia_rails/helper.rb
+- lib/inertia_rails/ignore_on_first_load_prop.rb
 - lib/inertia_rails/inertia_rails.rb
 - lib/inertia_rails/lazy_prop.rb
+- lib/inertia_rails/merge_prop.rb
 - lib/inertia_rails/middleware.rb
+- lib/inertia_rails/optional_prop.rb
 - lib/inertia_rails/renderer.rb
 - lib/inertia_rails/rspec.rb
 - lib/inertia_rails/version.rb