Add merge strategies support

Author: skryukov

lib/inertia_rails/defer_prop.rb

@@ -4,16 +4,17 @@ module InertiaRails
   class DeferProp < IgnoreOnFirstLoadProp
     DEFAULT_GROUP = 'default'
 
-    attr_reader :group
+    attr_reader :group, :merge_strategy
 
-    def initialize(group: nil, merge: nil, deep_merge: nil, &block)
+    def initialize(group: nil, merge: nil, deep_merge: nil, merge_strategy: 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 || deep_merge
       @deep_merge = deep_merge
+      @merge_strategy = merge_strategy
     end
 
     def merge?

lib/inertia_rails/inertia_rails.rb

@@ -33,16 +33,16 @@ def always(&block)
       AlwaysProp.new(&block)
     end
 
-    def merge(&block)
-      MergeProp.new(&block)
+    def merge(merge_strategy: nil, &block)
+      MergeProp.new(merge_strategy: merge_strategy, &block)
     end
 
-    def deep_merge(&block)
-      MergeProp.new(deep_merge: true, &block)
+    def deep_merge(merge_strategy: nil, &block)
+      MergeProp.new(deep_merge: true, merge_strategy: merge_strategy, &block)
     end
 
-    def defer(group: nil, merge: nil, deep_merge: nil, &block)
-      DeferProp.new(group: group, merge: merge, deep_merge: deep_merge, &block)
+    def defer(group: nil, merge: nil, deep_merge: nil, merge_strategy: nil, &block)
+      DeferProp.new(group: group, merge: merge, deep_merge: deep_merge, merge_strategy: merge_strategy, &block)
     end
   end
 end

lib/inertia_rails/merge_prop.rb

@@ -2,9 +2,12 @@
 
 module InertiaRails
   class MergeProp < BaseProp
-    def initialize(deep_merge: false, &block)
+    attr_reader :merge_strategy
+
+    def initialize(deep_merge: false, merge_strategy: nil, &block)
       super(&block)
       @deep_merge = deep_merge
+      @merge_strategy = merge_strategy
     end
 
     def merge?

lib/inertia_rails/renderer.rb

@@ -106,14 +106,17 @@ def page
       deferred_props = deferred_props_keys
       default_page[:deferredProps] = deferred_props if deferred_props.present?
 
-      all_merge_props = merge_props_keys
+      deep_merge_props, merge_props = all_merge_props.partition do |_key, prop|
+        prop.deep_merge?
+      end
 
-      deep_merge_props, merge_props = all_merge_props.partition do |key|
-        @props[key].deep_merge?
+      merge_strategies = all_merge_props.filter_map do |key, prop|
+        "#{key}.#{prop.merge_strategy}" if prop.merge_strategy
       end
 
-      default_page[:mergeProps] = merge_props if merge_props.present?
-      default_page[:deepMergeProps] = deep_merge_props if deep_merge_props.present?
+      default_page[:mergeProps] = merge_props.map(&:first) if merge_props.present?
+      default_page[:deepMergeProps] = deep_merge_props.map(&:first) if deep_merge_props.present?
+      default_page[:mergeStrategies] = merge_strategies if merge_strategies.present?
 
       default_page
     end
@@ -147,9 +150,16 @@ def deferred_props_keys
       end
     end
 
-    def merge_props_keys
-      @props.each_with_object([]) do |(key, prop), result|
-        result << key if prop.try(:merge?) && reset_keys.exclude?(key)
+    def all_merge_props
+      @all_merge_props ||= @props.select do |key, prop|
+        next unless prop.try(:merge?)
+        next if reset_keys.include?(key)
+        next if rendering_partial_component? && (
+          (partial_keys.present? && partial_keys.exclude?(key.name)) ||
+            (partial_except_keys.present? && partial_except_keys.include?(key.name))
+        )
+
+        true
       end
     end
 
@@ -180,7 +190,7 @@ def resolve_component(component)
     def keep_prop?(prop, path)
       return true if prop.is_a?(AlwaysProp)
 
-      if rendering_partial_component?
+      if rendering_partial_component? && (partial_keys.present? || partial_except_keys.present?)
         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)

spec/dummy/app/controllers/inertia_render_test_controller.rb

@@ -106,10 +106,14 @@ def always_props
   def merge_props
     render inertia: 'TestComponent', props: {
       merge: InertiaRails.merge { 'merge prop' },
+      merge_strategy: InertiaRails.merge(merge_strategy: 'id') { [id: 1] },
       deep_merge: InertiaRails.deep_merge { { deep: 'merge prop' } },
+      deep_merge_strategy: InertiaRails.deep_merge(merge_strategy: 'deep.id') { { deep: [id: 1] } },
       regular: 'regular prop',
       deferred_merge: InertiaRails.defer(merge: true) { 'deferred and merge prop' },
+      deferred_merge_strategy: InertiaRails.defer(merge: true, merge_strategy: 'id') { [id: 1] },
       deferred_deep_merge: InertiaRails.defer(deep_merge: true) { { deep: 'deferred and merge prop' } },
+      deferred_deep_merge_strategy: InertiaRails.defer(deep_merge: true, merge_strategy: 'deep.id') { { deep: [id: 1] } },
       deferred: InertiaRails.defer { 'deferred' },
     }
   end

spec/inertia/rendering_spec.rb

@@ -530,30 +530,37 @@
     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', 'deep_merge' => { 'deep' => 'merge prop' },
-                                                  'regular' => 'regular 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 eq('default' => %w[deferred_merge deferred_deep_merge deferred])
+      expect(response.parsed_body['props']).to eq(
+        'merge' => 'merge prop', 'merge_strategy' => [{ 'id' => 1 }],
+        'deep_merge' => { 'deep' => 'merge prop' }, 'deep_merge_strategy' => { 'deep' => [{ 'id' => 1 }] },
+        'regular' => 'regular prop'
+      )
+      expect(response.parsed_body['mergeProps']).to match_array(%w[merge merge_strategy deferred_merge deferred_merge_strategy])
+      expect(response.parsed_body['deepMergeProps']).to match_array(%w[deep_merge deep_merge_strategy deferred_deep_merge deferred_deep_merge_strategy])
+      expect(response.parsed_body['deferredProps']).to eq('default' => %w[deferred_merge deferred_merge_strategy deferred_deep_merge deferred_deep_merge_strategy deferred])
+      expect(response.parsed_body['mergeStrategies']).to match_array(%w[deep_merge_strategy.deep.id deferred_deep_merge_strategy.deep.id deferred_merge_strategy.id merge_strategy.id])
     end
 
     context 'with a partial reload' do
       let(:headers) do
         {
           'X-Inertia' => true,
-          'X-Inertia-Partial-Data' => 'deferred_merge,deferred_deep_merge',
+          'X-Inertia-Partial-Data' => 'deferred_merge,deferred_deep_merge,deferred_deep_merge_strategy,deferred_merge_strategy',
           'X-Inertia-Partial-Component' => 'TestComponent',
         }
       end
 
-      it 'returns listed and merge props' do
+      it 'returns listed merge props' do
         expect(response.parsed_body['props']).to eq(
           'deferred_merge' => 'deferred and merge prop',
-          'deferred_deep_merge' => { 'deep' => 'deferred and merge prop' }
+          'deferred_deep_merge' => { 'deep' => 'deferred and merge prop' },
+          'deferred_deep_merge_strategy' => { 'deep' => [{ 'id' => 1 }] },
+          'deferred_merge_strategy' => [{ 'id' => 1 }]
         )
-        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['mergeProps']).to match_array(%w[deferred_merge deferred_merge_strategy])
+        expect(response.parsed_body['deepMergeProps']).to match_array(%w[deferred_deep_merge deferred_deep_merge_strategy])
         expect(response.parsed_body['deferredProps']).to be_nil
+        expect(response.parsed_body['mergeStrategies']).to match_array(%w[deferred_deep_merge_strategy.deep.id deferred_merge_strategy.id])
       end
     end
 
@@ -567,13 +574,36 @@
         }
       end
 
-      it 'returns listed and merge props' do
+      it 'returns listed props' do
         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['mergeProps']).to be_nil
+        expect(response.parsed_body['deferredProps']).to be_nil
+        expect(response.parsed_body['mergeStrategies']).to be_nil
+      end
+    end
+
+    context 'with an except header' do
+      let(:headers) do
+        {
+          'X-Inertia' => true,
+          'X-Inertia-Partial-Data' => 'deferred_merge,deferred_deep_merge,deep_merge_strategy',
+          'X-Inertia-Partial-Except' => 'deferred_merge',
+          'X-Inertia-Partial-Component' => 'TestComponent',
+        }
+      end
+
+      it 'returns only the excepted props' do
+        expect(response.parsed_body['props']).to eq(
+          'deferred_deep_merge' => { 'deep' => 'deferred and merge prop' },
+          'deep_merge_strategy' => { 'deep' => [{ 'id' => 1 }] }
+        )
+        expect(response.parsed_body['mergeProps']).to be_nil
+        expect(response.parsed_body['deepMergeProps']).to match_array(%w[deferred_deep_merge deep_merge_strategy])
         expect(response.parsed_body['deferredProps']).to be_nil
+        expect(response.parsed_body['mergeStrategies']).to match_array(%w[deep_merge_strategy.deep.id])
       end
     end
   end