Add InertiaRails.optional prop

Author: skryukov

lib/inertia_rails/inertia_rails.rb

@@ -2,6 +2,7 @@
 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'
@@ -22,6 +23,10 @@ def lazy(value = nil, &block)
       LazyProp.new(value, &block)
     end
 
+    def optional(&block)
+      OptionalProp.new(&block)
+    end
+
     def always(&block)
       AlwaysProp.new(&block)
     end

lib/inertia_rails/optional_prop.rb

@@ -0,0 +1,4 @@
+module InertiaRails
+  class OptionalProp < IgnoreOnFirstLoadProp
+  end
+end

spec/dummy/app/controllers/inertia_render_test_controller.rb

@@ -10,10 +10,10 @@ def props
   def except_props
     render inertia: 'TestComponent', props: {
       flat: 'flat param',
-      lazy: InertiaRails.lazy('lazy param'),
-      nested_lazy: InertiaRails.lazy do
+      optional: InertiaRails.optional { 'optional param' },
+      nested_optional: InertiaRails.optional do
         {
-          first: 'first nested lazy param',
+          first: 'first nested optional param',
         }
       end,
       nested: {
@@ -83,14 +83,22 @@ def lazy_props
     }
   end
 
+  def optional_props
+    render inertia: 'TestComponent', props: {
+      regular: 1,
+      optional: InertiaRails.optional { 1 },
+      another_optional: InertiaRails.optional { 1 },
+    }
+  end
+
   def always_props
     render inertia: 'TestComponent', props: {
       always: InertiaRails.always { 'always prop' },
       regular: 'regular prop',
-      lazy: InertiaRails.lazy do
-        'lazy prop'
+      optional: InertiaRails.optional do
+        'optional prop'
       end,
-      another_lazy: InertiaRails.lazy(->{ 'another lazy prop' })
+      another_optional: InertiaRails.optional { 'another optional prop' }
     }
   end
 

spec/dummy/config/routes.rb

@@ -31,6 +31,7 @@
   get 'error_500' => 'inertia_test#error_500'
   get 'content_type_test' => 'inertia_test#content_type_test'
   get 'lazy_props' => 'inertia_render_test#lazy_props'
+  get 'optional_props' => 'inertia_render_test#optional_props'
   get 'always_props' => 'inertia_render_test#always_props'
   get 'except_props' => 'inertia_render_test#except_props'
   get 'merge_props' => 'inertia_render_test#merge_props'

spec/inertia/rendering_spec.rb

@@ -257,7 +257,7 @@
     let(:headers) do
       {
         'X-Inertia' => true,
-        'X-Inertia-Partial-Data' => 'nested,nested_lazy',
+        'X-Inertia-Partial-Data' => 'nested,nested_optional',
         'X-Inertia-Partial-Except' => 'nested',
         'X-Inertia-Partial-Component' => 'TestComponent',
       }
@@ -268,7 +268,7 @@
     it 'returns listed props without excepted' do
       expect(response.parsed_body['props']).to eq(
         'always' => 'always prop',
-        'nested_lazy' => { 'first' => 'first nested lazy param' },
+        'nested_optional' => { 'first' => 'first nested optional param' },
       )
     end
 
@@ -282,25 +282,25 @@
       it 'returns all regular and partial props except excepted' do
         expect(response.parsed_body['props']).to eq(
           'flat' => 'flat param',
-          'lazy' => 'lazy param',
+          'optional' => 'optional param',
           'always' => 'always prop',
-          'nested_lazy' => { 'first' => 'first nested lazy param' },
+          'nested_optional' => { 'first' => 'first nested optional param' },
         )
       end
     end
 
     context 'when except always prop' do
       let(:headers) {{
         'X-Inertia' => true,
-        'X-Inertia-Partial-Data' => 'nested_lazy',
+        'X-Inertia-Partial-Data' => 'nested_optional',
         'X-Inertia-Partial-Except' => 'always_prop',
         'X-Inertia-Partial-Component' => 'TestComponent',
       }}
 
       it 'returns always prop anyway' do
         expect(response.parsed_body['props']).to eq(
           'always' => 'always prop',
-          'nested_lazy' => { 'first' => 'first nested lazy param' },
+          'nested_optional' => { 'first' => 'first nested optional param' },
         )
       end
     end
@@ -309,7 +309,7 @@
       let(:headers) do
         {
           'X-Inertia' => true,
-          'X-Inertia-Partial-Data' => 'nested_lazy',
+          'X-Inertia-Partial-Data' => 'nested_optional',
           'X-Inertia-Partial-Except' => 'unknown',
           'X-Inertia-Partial-Component' => 'TestComponent',
         }
@@ -318,7 +318,7 @@
       it 'returns props' do
         expect(response.parsed_body['props']).to eq(
           'always' => 'always prop',
-          'nested_lazy' => { 'first' => 'first nested lazy param' },
+          'nested_optional' => { 'first' => 'first nested optional param' },
         )
       end
     end
@@ -327,8 +327,8 @@
       let(:headers) do
         {
           'X-Inertia' => true,
-          'X-Inertia-Partial-Data' => 'nested,nested_lazy',
-          'X-Inertia-Partial-Except' => 'nested.first,nested_lazy.first',
+          'X-Inertia-Partial-Data' => 'nested,nested_optional',
+          'X-Inertia-Partial-Except' => 'nested.first,nested_optional.first',
           'X-Inertia-Partial-Component' => 'TestComponent',
         }
       end
@@ -337,7 +337,7 @@
         expect(response.parsed_body['props']).to eq(
           'always' => 'always prop',
           'nested' => { 'second' => 'second nested param' },
-          'nested_lazy' => { 'first' => 'first nested lazy param' },
+          'nested_optional' => { 'first' => 'first nested optional param' },
         )
       end
     end
@@ -372,6 +372,32 @@
     end
   end
 
+  context 'optional prop rendering' do
+    context 'on first load' do
+      let(:page) {
+        InertiaRails::Renderer.new('TestComponent', controller, request, response, '', props: { regular: 1}).send(:page)
+      }
+      before { get optional_props_path }
+
+      it { is_expected.to include inertia_div(page) }
+    end
+
+    context 'with a partial reload' do
+      let(:page) {
+        InertiaRails::Renderer.new('TestComponent', controller, request, response, '', props: { regular: 1, optional: 1}).send(:page)
+      }
+      let(:headers) {{
+        'X-Inertia' => true,
+        'X-Inertia-Partial-Data' => 'optional',
+        'X-Inertia-Partial-Component' => 'TestComponent',
+      }}
+
+      before { get optional_props_path, headers: headers }
+
+      it { is_expected.to eq page.to_json }
+    end
+  end
+
   context 'always prop rendering' do
     let(:headers) { { 'X-Inertia' => true } }
 
@@ -384,12 +410,12 @@
     context 'with a partial reload' do
       let(:headers) {{
         'X-Inertia' => true,
-        'X-Inertia-Partial-Data' => 'lazy',
+        'X-Inertia-Partial-Data' => 'optional',
         'X-Inertia-Partial-Component' => 'TestComponent',
       }}
 
       it "returns listed and always props" do
-        expect(response.parsed_body["props"]).to eq({"always" => 'always prop', "lazy" => 'lazy prop' })
+        expect(response.parsed_body["props"]).to eq({"always" => 'always prop', "optional" => 'optional prop' })
       end
     end
   end