Add InertiaRails.deep_merge & InertiaRails.defer(deep_merge: true)

Author: skryukov

lib/inertia_rails/defer_prop.rb

@@ -6,16 +6,22 @@ class DeferProp < IgnoreOnFirstLoadProp
 
     attr_reader :group
 
-    def initialize(group: nil, merge: nil, &block)
+    def initialize(group: nil, merge: nil, deep_merge: nil, &block)
+      raise ArgumentError, 'Cannot set both `deep_merge` and `merge` to true' if deep_merge && merge
+
       super(&block)
 
       @group = group || DEFAULT_GROUP
-      @merge = merge
-      @block = block
+      @merge = merge || deep_merge
+      @deep_merge = deep_merge
     end
 
     def merge?
       @merge
     end
+
+    def deep_merge?
+      @deep_merge
+    end
   end
 end

lib/inertia_rails/inertia_rails.rb

@@ -35,8 +35,12 @@ def merge(&block)
       MergeProp.new(&block)
     end
 
-    def defer(group: nil, merge: nil, &block)
-      DeferProp.new(group: group, merge: merge, &block)
+    def deep_merge(&block)
+      MergeProp.new(deep_merge: true, &block)
+    end
+
+    def defer(group: nil, merge: nil, deep_merge: nil, &block)
+      DeferProp.new(group: group, merge: merge, deep_merge: deep_merge, &block)
     end
   end
 end

lib/inertia_rails/merge_prop.rb

@@ -2,13 +2,17 @@
 
 module InertiaRails
   class MergeProp < BaseProp
-    def initialize(*)
-      super
-      @merge = true
+    def initialize(deep_merge: false, &block)
+      super(&block)
+      @deep_merge = deep_merge
     end
 
     def merge?
-      @merge
+      true
+    end
+
+    def deep_merge?
+      @deep_merge
     end
   end
 end

lib/inertia_rails/renderer.rb

@@ -105,8 +105,14 @@ def page
       deferred_props = deferred_props_keys
       default_page[:deferredProps] = deferred_props if deferred_props.present?
 
-      merge_props = merge_props_keys
+      all_merge_props = merge_props_keys
+
+      deep_merge_props, merge_props = all_merge_props.partition do |key|
+        @props[key].deep_merge?
+      end
+
       default_page[:mergeProps] = merge_props if merge_props.present?
+      default_page[:deepMergeProps] = deep_merge_props if deep_merge_props.present?
 
       default_page
     end

spec/dummy/app/controllers/inertia_render_test_controller.rb

@@ -105,8 +105,10 @@ def always_props
   def merge_props
     render inertia: 'TestComponent', props: {
       merge: InertiaRails.merge { 'merge prop' },
+      deep_merge: InertiaRails.deep_merge { {deep: 'merge prop'} },
       regular: 'regular prop',
       deferred_merge: InertiaRails.defer(merge: true) { 'deferred and merge prop' },
+      deferred_deep_merge: InertiaRails.defer(deep_merge: true) { {deep: 'deferred and merge prop'} },
       deferred: InertiaRails.defer { 'deferred' },
     }
   end

spec/inertia/defer_prop_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+RSpec.describe InertiaRails::DeferProp do
+  it_behaves_like 'base prop'
+
+  describe '#merge?' do
+    subject(:merge?) { prop.merge? }
+
+    let(:prop) { described_class.new { 'block' } }
+
+    it { is_expected.to be_falsy }
+
+    context 'when merge is set' do
+      let(:prop) { described_class.new(merge: true) { 'block' } }
+
+      it { is_expected.to be true }
+    end
+
+    context 'when deep_merge is set' do
+      let(:prop) { described_class.new(deep_merge: true) { 'block' } }
+
+      it { is_expected.to be true }
+    end
+
+    context 'when both merge and deep_merge are set' do
+      let(:prop) { described_class.new(merge: true, deep_merge: true) { 'block' } }
+
+      it 'raises an ArgumentError' do
+        expect { merge? }.to raise_error(ArgumentError, 'Cannot set both `deep_merge` and `merge` to true')
+      end
+    end
+  end
+
+  describe '#deep_merge?' do
+    subject(:deep_merge?) { prop.deep_merge? }
+
+    let(:prop) { described_class.new { 'block' } }
+
+    it { is_expected.to be_falsy }
+
+    context 'when deep is true' do
+      let(:prop) { described_class.new(deep_merge: true) { 'block' } }
+
+      it { is_expected.to be true }
+    end
+  end
+
+  describe '#group' do
+    subject(:group) { prop.group }
+
+    let(:prop) { described_class.new { 'block' } }
+
+    it { is_expected.to eq('default') }
+
+    context 'when group is set' do
+      let(:prop) { described_class.new(group: 'custom') { 'block' } }
+
+      it { is_expected.to eq('custom') }
+    end
+  end
+end

spec/inertia/merge_prop_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+RSpec.describe InertiaRails::MergeProp do
+  it_behaves_like 'base prop'
+
+  describe '#merge?' do
+    subject(:merge?) { prop.merge? }
+
+    let(:prop) { described_class.new { 'block' } }
+
+    it { is_expected.to be true }
+  end
+
+  describe '#deep_merge?' do
+    subject(:deep_merge?) { prop.deep_merge? }
+
+    let(:prop) { described_class.new { 'block' } }
+
+    it { is_expected.to be false }
+
+    context 'when deep_merge is true' do
+      let(:prop) { described_class.new(deep_merge: true) { 'block' } }
+
+      it { is_expected.to be true }
+    end
+  end
+end

spec/inertia/rendering_spec.rb

@@ -513,23 +513,25 @@
     before { get merge_props_path, headers: headers }
 
     it 'returns non-optional props and meta on first load' do
-      expect(response.parsed_body['props']).to eq('merge' => 'merge prop', 'regular' => 'regular prop')
+      expect(response.parsed_body['props']).to eq('merge' => 'merge prop', 'deep_merge' => { 'deep' => 'merge prop' }, 'regular' => 'regular prop')
       expect(response.parsed_body['mergeProps']).to match_array(%w[merge deferred_merge])
-      expect(response.parsed_body['deferredProps']).to eq('default' => %w[deferred_merge deferred])
+      expect(response.parsed_body['deepMergeProps']).to match_array(%w[deep_merge deferred_deep_merge])
+      expect(response.parsed_body['deferredProps']).to eq('default' => %w[deferred_merge deferred_deep_merge deferred])
     end
 
     context 'with a partial reload' do
       let(:headers) do
         {
           'X-Inertia' => true,
-          'X-Inertia-Partial-Data' => 'deferred_merge',
+          'X-Inertia-Partial-Data' => 'deferred_merge,deferred_deep_merge',
           'X-Inertia-Partial-Component' => 'TestComponent',
         }
       end
 
       it 'returns listed and merge props' do
-        expect(response.parsed_body['props']).to eq({ 'deferred_merge' => 'deferred and merge prop' })
+        expect(response.parsed_body['props']).to eq({ 'deferred_merge' => 'deferred and merge prop', 'deferred_deep_merge' => { 'deep' => 'deferred and merge prop' } })
         expect(response.parsed_body['mergeProps']).to match_array(%w[merge deferred_merge])
+        expect(response.parsed_body['deepMergeProps']).to match_array(%w[deep_merge deferred_deep_merge])
         expect(response.parsed_body['deferredProps']).to be_nil
       end
     end
@@ -538,14 +540,14 @@
       let(:headers) do
         {
           'X-Inertia' => true,
-          'X-Inertia-Partial-Data' => 'deferred_merge',
+          'X-Inertia-Partial-Data' => 'deferred_merge,deferred_deep_merge',
           'X-Inertia-Partial-Component' => 'TestComponent',
-          'X-Inertia-Reset' => 'deferred_merge',
+          'X-Inertia-Reset' => 'deferred_merge,deferred_deep_merge',
         }
       end
 
       it 'returns listed and merge props' do
-        expect(response.parsed_body['props']).to eq({ 'deferred_merge' => 'deferred and merge prop' })
+        expect(response.parsed_body['props']).to eq({ 'deferred_merge' => 'deferred and merge prop', 'deferred_deep_merge' => { 'deep' => 'deferred and merge prop' } })
         expect(response.parsed_body['mergeProps']).to match_array(%w[merge])
         expect(response.parsed_body['deferredProps']).to be_nil
       end