Add support for :if, :unless, :only, :except options in inertia_share

Author: skryukov

lib/inertia_rails/controller.rb

@@ -14,10 +14,19 @@ module Controller
     end
 
     module ClassMethods
-      def inertia_share(attrs = {}, &block)
-        @inertia_share ||= []
-        @inertia_share << attrs.freeze unless attrs.empty?
-        @inertia_share << block if block
+      def inertia_share(hash = nil, **props, &block)
+        options = extract_inertia_share_options(props)
+        return push_to_inertia_share(**(hash || props), &block) if options.empty?
+
+        push_to_inertia_share do
+          next unless options[:if].all? { |filter| instance_exec(&filter) } if options[:if]
+          next unless options[:unless].none? { |filter| instance_exec(&filter)  } if options[:unless]
+
+          next hash unless block
+
+          res = instance_exec(&block)
+          hash ? hash.merge(res) : res
+        end
       end
 
       def inertia_config(**attrs)
@@ -55,6 +64,53 @@ def _inertia_shared_data
           end.freeze
         end
       end
+
+      private
+
+      def push_to_inertia_share(**attrs, &block)
+        @inertia_share ||= []
+        @inertia_share << attrs.freeze unless attrs.empty?
+        @inertia_share << block if block
+      end
+
+      def extract_inertia_share_options(props)
+        options = props.slice(:if, :unless, :only, :except)
+
+        return options if options.empty?
+
+        if props.except(:if, :unless, :only, :except).any?
+          raise ArgumentError, "You must not mix shared data and [:if, :unless, :only, :except] options, pass data as a hash or a block."
+        end
+
+        extract_inertia_share_option(options, :only, :if)
+        extract_inertia_share_option(options, :except, :unless)
+
+        options.transform_values! do |filters|
+          Array(filters).map!(&method(:filter_to_proc))
+        end
+
+        options
+      end
+
+      def extract_inertia_share_option(options, from, to)
+        if (from_value = options.delete(from))
+          filter = AbstractController::Callbacks::ActionFilter.new([:inertia_share], from, from_value)
+          options[to] = Array(options[to]).unshift(filter)
+        end
+      end
+
+      def filter_to_proc(filter)
+        case filter
+        when Symbol
+          -> { send(filter) }
+        when Proc
+          filter
+        when AbstractController::Callbacks::ActionFilter
+          -> { filter.match?(self) }
+        else
+          raise ArgumentError, "You must pass a symbol or a proc as a filter."
+        end
+      end
     end
 
     def default_render

spec/dummy/app/controllers/inertia_conditional_sharing_controller.rb

@@ -7,6 +7,32 @@ class InertiaConditionalSharingController < ApplicationController
     {conditionally_shared_show_prop: 1} if action_name == "show"
   end
 
+  inertia_share only: :edit do
+    {only_block_prop: 1}
+  end
+
+  inertia_share except: [:show, :index] do
+    {except_block_prop: 1}
+  end
+
+  inertia_share if: -> { is_edit? } do
+    {if_proc_prop: 1}
+  end
+
+  inertia_share unless: -> { !is_edit? } do
+    {unless_proc_prop: 1}
+  end
+
+  inertia_share({only_prop: 1}, only: :edit)
+
+  inertia_share({if_prop: 1}, if: [:is_edit?, -> { true }])
+
+  inertia_share({unless_prop: 1}, unless: :not_edit?)
+
+  inertia_share({only_if_prop: 1}, only: :edit, if: -> { true })
+
+  inertia_share({except_if_prop: 1}, except: [:index, :show], if: -> { true })
+
   def index
     render inertia: 'EmptyTestComponent', props: {
       index_only_prop: 1,
@@ -25,9 +51,23 @@ def show_with_a_problem
     }
   end
 
+  def edit
+    render inertia: 'EmptyTestComponent', props: {
+      edit_only_prop: 1,
+    }
+  end
+
   protected
 
   def conditionally_share_a_prop
     self.class.inertia_share incorrectly_conditionally_shared_prop: 1
   end
+
+  def not_edit?
+    !is_edit?
+  end
+
+  def is_edit?
+    action_name == "edit"
+  end
 end

spec/dummy/config/routes.rb

@@ -52,5 +52,6 @@
 
   get 'conditional_share_index' => 'inertia_conditional_sharing#index'
   get 'conditional_share_show' => 'inertia_conditional_sharing#show'
+  get 'conditional_share_edit' => 'inertia_conditional_sharing#edit'
   get 'conditional_share_show_with_a_problem' => 'inertia_conditional_sharing#show_with_a_problem'
 end

spec/inertia/conditional_sharing_spec.rb

@@ -14,6 +14,20 @@
       expect(JSON.parse(response.body)['props'].deep_symbolize_keys).not_to include({
         conditionally_shared_show_prop: 1,
       })
+      get conditional_share_edit_path, headers: { 'X-Inertia' => true }
+      expect(JSON.parse(response.body)['props'].deep_symbolize_keys).to eq({
+        normal_shared_prop: 1,
+        only_block_prop: 1,
+        except_block_prop: 1,
+        if_proc_prop: 1,
+        unless_proc_prop: 1,
+        only_prop: 1,
+        if_prop: 1,
+        unless_prop: 1,
+        only_if_prop: 1,
+        except_if_prop: 1,
+        edit_only_prop: 1,
+      })
     end
   end