inertia_builder 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db89ab90b2cb82bff0edc49732dfb8662a1e1af582fa0a81b8b7b569f631f107
-  data.tar.gz: 63832da96a198430e738e3ca368ed9a3977415b615039d8a81c4c3dcec2b7a5a
+  metadata.gz: c2db7cf7bc04f52285ccfb06231fcb67cca0038b80140b84ec314f2cf9f1196b
+  data.tar.gz: '02989fb26e14f25cbfe80ca52559813137c7cbf67c9983afed7f0cb23ad59451'
 SHA512:
-  metadata.gz: 790787ba727eb3473a560275061fc28fe9a80a29bf8218a560471acb760b01b09599194542aa6b0bed8c491fad95d2c5741fa8b514ed149bd00e93d6ea175fdb
-  data.tar.gz: a1c8f57f40b69b96f2597614ef2e801bcabb21d7b019de7ebb0fe9c0feab8ca233c755c8d126d42cc0dc44e1d191431c834157cbdedbf20fcdc098c01d45722a
+  metadata.gz: faf2b72091c7fecc1c74f51b91e3a1e2237e8878d61777b8b6f5ed9505185c8a81c5cca058b0fcc470f42d98014783cd6b28a5494125a76df4525cbaac82b537
+  data.tar.gz: 359cfcca048b25bde18ac719f9a2a3dbccb02d1081d5c3886b424afcab8ef202d3d4997323640490ab3b63d1c48fa0806da861fa13dda60c7195442c3aa05d85

data/lib/inertia_builder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InertiaBuilder
-  VERSION = '0.1.1'
+  VERSION = '0.2.1'
 end

data/lib/inertia_builder.rb

@@ -4,18 +4,52 @@ require 'jbuilder/jbuilder_template'
 require 'inertia_builder/handler'
 require 'inertia_builder/controller'
 require 'inertia_builder/renderer'
-require 'inertia_builder/railtie' if defined?(Rails)
+require 'inertia_builder/railtie'
 
 class JbuilderTemplate
-  self.template_lookup_options = { handlers: [:inertia] }
+  self.template_lookup_options = { handlers: %i[inertia jbuilder] }
 end
 
 module InertiaBuilder
   class PropBuilder < JbuilderTemplate
     alias props attributes!
 
+    def optional!(&block)
+      _call_inertia_block(:optional, &block)
+    end
+
+    def always!(&block)
+      _call_inertia_block(:always, &block)
+    end
+
+    def defer!(**opts, &block)
+      _call_inertia_block(:defer, **opts, &block)
+    end
+
+    def method_missing(name, *args, &block)
+      prop = self
+
+      if @inertia_block
+        method, opts = @inertia_block
+        _set_value(name, ::InertiaRails.send(method, **opts) { prop.set!(name, *args, &block) })
+      elsif !@in_scope
+        # Lazy evaluate outermost properties.
+        _set_value(name, -> { prop.set!(name, *args, &block); })
+      else
+        super
+      end
+    end
+
     private
 
+    def _call_inertia_block(method, **opts)
+      ::Kernel.raise "Nesting #{method}! in a #{@inertia_block[0]}! block is not allowed" if @inertia_block
+
+      @inertia_block = [method, opts]
+      yield
+      @inertia_block = nil
+    end
+
     def _render_partial_with_options(options)
       options[:locals] ||= options.except(:partial, :as, :collection, :cached)
       options[:locals][:prop] = self
@@ -30,5 +64,25 @@ module InertiaBuilder
     def _render_active_model_partial(object)
       @context.render object, prop: self
     end
+
+    def _scope
+      has_parent_scope = @in_scope
+      @in_scope = true
+      super
+    ensure
+      @in_scope = false unless has_parent_scope
+    end
+
+    def _merge_values(current_value, updates)
+      # Always override lazy evaluation procs. For the other special prop types, InertiaRails already handles merging.
+      if current_value.is_a?(::Proc) ||
+         current_value.is_a?(::InertiaRails::OptionalProp) ||
+         current_value.is_a?(::InertiaRails::AlwaysProp) ||
+         current_value.is_a?(::InertiaRails::DeferProp)
+        updates
+      else
+        super
+      end
+    end
   end
 end

data/test/inertia_builder_test.rb

@@ -8,6 +8,11 @@ class User < Struct.new(:id, :first_name, :last_name, :email)
   include ActiveModel::Conversion
 end
 
+class Item < Struct.new(:id, :title)
+  extend ActiveModel::Naming
+  include ActiveModel::Conversion
+end
+
 class InertiaBuilderTest < Minitest::Test
   USER_PARTIAL = <<~INERTIA
     prop.id user.id
@@ -16,8 +21,14 @@ class InertiaBuilderTest < Minitest::Test
     prop.email user.email
   INERTIA
 
+  ITEM_PARTIAL = <<~INERTIA
+    prop.id item.id
+    prop.title item.title
+  INERTIA
+
   PARTIALS = {
-    'users/_user.html.inertia' => USER_PARTIAL
+    'users/_user.html.inertia' => USER_PARTIAL,
+    'items/_item.html.inertia' => ITEM_PARTIAL
   }
 
   def test_basic_html_rendering
@@ -47,8 +58,8 @@ class InertiaBuilderTest < Minitest::Test
       }
     }
 
-    assert_equal inertia_html_with_props(expected_props), render_view(template)
     assert_equal inertia_json_with_props(expected_props), render_view(template, json: true)
+    assert_equal inertia_html_with_props(expected_props), render_view(template)
   end
 
   def test_collection_prop
@@ -75,9 +86,9 @@ class InertiaBuilderTest < Minitest::Test
 
     expected_props = { products: products }
 
-    assert_equal inertia_html_with_props(expected_props), render_view(template, assigns: { products: products })
     assert_equal inertia_json_with_props(expected_props),
                  render_view(template, assigns: { products: products }, json: true)
+    assert_equal inertia_html_with_props(expected_props), render_view(template, assigns: { products: products })
   end
 
   def test_basic_partial_prop
@@ -91,8 +102,8 @@ class InertiaBuilderTest < Minitest::Test
 
     expected_props = { user: user }
 
-    assert_equal inertia_html_with_props(expected_props), render_view(template, assigns: { user: user })
     assert_equal inertia_json_with_props(expected_props), render_view(template, assigns: { user: user }, json: true)
+    assert_equal inertia_html_with_props(expected_props), render_view(template, assigns: { user: user })
   end
 
   def test_collection_partial_prop
@@ -119,12 +130,23 @@ class InertiaBuilderTest < Minitest::Test
       User.new({ id: 43, first_name: 'Jane', last_name: 'Smith', email: 'jane@email.com' })
     ]
 
-    template = "prop.users @users, partial: 'users/user', as: :user"
+    items = [
+      Item.new({ id: 1, title: 'Item 1' }),
+      Item.new({ id: 2, title: 'Item 2' })
+    ]
 
-    expected_props = { users: users }
+    template = <<~INERTIA
+      prop.data do
+        prop.users @users, partial: 'users/user', as: :user
+        prop.items @items, partial: 'items/item', as: :item
+      end
+    INERTIA
 
-    assert_equal inertia_html_with_props(expected_props), render_view(template, assigns: { users: users })
-    assert_equal inertia_json_with_props(expected_props), render_view(template, assigns: { users: users }, json: true)
+    expected_props = { data: { users: users, items: items } }
+
+    assert_equal inertia_json_with_props(expected_props),
+                 render_view(template, assigns: { users: users, items: items }, json: true)
+    assert_equal inertia_html_with_props(expected_props), render_view(template, assigns: { users: users, items: items })
   end
 
   def test_nil_prop_block
@@ -140,11 +162,110 @@ class InertiaBuilderTest < Minitest::Test
     assert_equal inertia_json_with_props(expected_props), render_view(template, json: true)
   end
 
+  def test_optional_block
+    template = <<~INERTIA
+      prop.id 1
+      prop.optional! do
+        prop.user do
+          prop.id 1
+          prop.email 'user@email.com'
+        end
+        prop.calculation 'Calculation'
+      end
+    INERTIA
+
+    partial_headers = {
+      'X-Inertia-Partial-Data' => 'user,calculation',
+      'X-Inertia-Partial-Component' => '/'
+    }
+    assert_equal inertia_json_with_props({ id: 1 }), render_view(template, json: true)
+    assert_equal inertia_json_with_props({ user: { id: 1, email: 'user@email.com' }, calculation: 'Calculation' }),
+                 render_view(template, json: true, headers: partial_headers)
+  end
+
+  def test_always_block
+    template = <<~INERTIA
+      prop.id 1
+      prop.always! do
+        prop.user do
+          prop.id 1
+          prop.email 'user@email.com'
+        end
+      end
+      prop.optional! do
+        prop.calculation 'Calculation'
+      end
+    INERTIA
+
+    partial_headers = {
+      'X-Inertia-Partial-Data' => 'calculation',
+      'X-Inertia-Partial-Component' => '/'
+    }
+    assert_equal inertia_json_with_props({ id: 1, user: { id: 1, email: 'user@email.com' } }),
+                 render_view(template, json: true)
+    assert_equal inertia_json_with_props({ user: { id: 1, email: 'user@email.com' }, calculation: 'Calculation' }),
+                 render_view(template, json: true, headers: partial_headers)
+  end
+
+  def test_defer_block
+    template = <<~INERTIA
+      prop.id 1
+      prop.defer! do
+        prop.user do
+          prop.id 1
+          prop.email 'user@email.com'
+        end
+        prop.calculation 'Calculation'
+      end
+    INERTIA
+
+    assert_equal inertia_json_with_props({ id: 1 }, deferredProps: { default: %w[user calculation] }),
+                 render_view(template, json: true)
+  end
+
+  def test_defer_block_grouping
+    template = <<~INERTIA
+      prop.id 1
+      prop.defer! group: 'group1' do
+        prop.user 'User'
+      end
+      prop.defer! group: 'group2' do
+        prop.calculation 'Calculation'
+      end
+    INERTIA
+
+    assert_equal inertia_json_with_props({ id: 1 }, deferredProps: { group1: ['user'], group2: ['calculation'] }),
+                 render_view(template, json: true)
+  end
+
+  def test_defer_block_fetching
+    user = User.new({ id: 1, email: 'user@email.com' })
+
+    template = <<~INERTIA
+      prop.id 1
+      prop.defer! do
+        prop.user do
+          prop.partial! @user
+        end
+        prop.calculation 'Calculation'
+      end
+    INERTIA
+
+    partial_headers = {
+      'X-Inertia-Partial-Data' => 'user,calculation',
+      'X-Inertia-Partial-Component' => '/'
+    }
+
+    assert_equal inertia_json_with_props({ user: user, calculation: 'Calculation' }),
+                 render_view(template, assigns: { user: user }, json: true, headers: partial_headers)
+  end
+
   private
 
-  def render_view(source, assigns: {}, json: false)
+  def render_view(source, **opts)
     req = ActionDispatch::TestRequest.create
-    req.headers['X-Inertia'] = 'true' if json
+    req.headers.merge!(opts[:headers] || {})
+    req.headers['X-Inertia'] = 'true' if opts[:json]
 
     controller = ActionView::TestCase::TestController.new
     controller.request = req
@@ -152,7 +273,7 @@ class InertiaBuilderTest < Minitest::Test
     resolver = ActionView::FixtureResolver.new(PARTIALS.merge('source.html.inertia' => source))
     lookup = ActionView::LookupContext.new([resolver], {}, [''])
 
-    view = ActionView::Base.with_empty_template_cache.new(lookup, assigns, controller)
+    view = ActionView::Base.with_empty_template_cache.new(lookup, opts[:assigns] || [], controller)
 
     view.render(template: 'source')
   end
@@ -163,7 +284,7 @@ class InertiaBuilderTest < Minitest::Test
     HTML
   end
 
-  def inertia_json_with_props(props)
+  def inertia_json_with_props(props, **extra_fields)
     {
       component: '/',
       props: { errors: {} }.merge(props),
@@ -171,6 +292,6 @@ class InertiaBuilderTest < Minitest::Test
       version: nil,
       encryptHistory: false,
       clearHistory: false
-    }.to_json
+    }.merge(extra_fields).to_json
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inertia_builder
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Rodrigo Lima
@@ -70,8 +70,8 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rodrigotavio91/inertia-builder/issues
-  changelog_uri: https://github.com/rodrigotavio91/inertia-builder/releases/tag/v0.1.1
-  source_code_uri: https://github.com/rodrigotavio91/inertia-builder/tree/v0.1.1
+  changelog_uri: https://github.com/rodrigotavio91/inertia-builder/releases/tag/v0.2.1
+  source_code_uri: https://github.com/rodrigotavio91/inertia-builder/tree/v0.2.1
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: