inertia_builder 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b41a77c0abf695c22870a0f35ac4a37c26c97271ac5d33b0a2b4eb1beec5480
-  data.tar.gz: c64489eded45ffc35d4946f4787a0c4ab23ccf88626ca41d005138a9d621d2de
+  metadata.gz: 5d7e71953b0936b8ed91f3b928595e60d6d57680e0b35c0cfb7859b7bdaf7625
+  data.tar.gz: 6ff8c51673223bd0986100dd215666220ff7a06a743a18433aa6613064d77d23
 SHA512:
-  metadata.gz: 6739d2a741a60a35d07b8e638f029fd349aa58d706b437350de491e09c3717aceacb7cc3075b612f91502300d8efd2cc5601251b0c1895d3a9cebf0fb448cf61
-  data.tar.gz: bd1a2ae1600c6461469f84298bdbb5143faf35e3fdfed32bf792285480584839abd6a7186a374730ebc2ef505fac12823368bfaed11827a0e6c0dfe96a7ff6e2
+  metadata.gz: 3265c9ac28a8aabd5bb6f9499a9efe7469337f5f2f117986205112d2ae337b40e9830f03030ed341f98dd86424655c031e7ef5c451e950ebacd42841dc56c7ee
+  data.tar.gz: 895d95e54656cb6b15ee7dbd8fd3722d8e1d6717509736756cfaaeef3e1d9d8dc64e85a23c8866dcab27bd6c85bf3b88b02312f36ed1d139b783cc515eb5c2c0

data/lib/inertia_builder/renderer.rb

@@ -23,7 +23,7 @@ module InertiaBuilder
         @view_context.controller.render_to_string(
           template: 'inertia',
           layout: false,
-          locals: @inertia_renderer.send(:view_data).merge(page: page)
+          locals: { page: page }
         )
       end
     end

data/lib/inertia_builder/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module InertiaBuilder
-  VERSION = '0.2.2'
+  VERSION = "0.3.0"
 end

data/lib/inertia_builder.rb

@@ -26,12 +26,16 @@ module InertiaBuilder
       _call_inertia_block(:defer, **opts, &block)
     end
 
+    def scroll!(metadata = nil, **opts, &block)
+      _call_inertia_block(:scroll, metadata, **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) })
+        method, positional_args, opts = @inertia_block
+        _set_value(name, ::InertiaRails.send(method, *positional_args, **opts) { prop.set!(name, *args, &block) })
       elsif !@in_scope
         # Lazy evaluate outermost properties.
         _set_value(name, -> { prop.set!(name, *args, &block); })
@@ -42,10 +46,10 @@ module InertiaBuilder
 
     private
 
-    def _call_inertia_block(method, **opts)
+    def _call_inertia_block(method, *args, **opts)
       ::Kernel.raise "Nesting #{method}! in a #{@inertia_block[0]}! block is not allowed" if @inertia_block
 
-      @inertia_block = [method, opts]
+      @inertia_block = [method, args, opts]
       yield
       @inertia_block = nil
     end
@@ -78,7 +82,8 @@ module InertiaBuilder
       if current_value.is_a?(::Proc) ||
          current_value.is_a?(::InertiaRails::OptionalProp) ||
          current_value.is_a?(::InertiaRails::AlwaysProp) ||
-         current_value.is_a?(::InertiaRails::DeferProp)
+         current_value.is_a?(::InertiaRails::DeferProp) ||
+         current_value.is_a?(::InertiaRails::ScrollProp)
         updates
       else
         super

data/test/inertia_builder_test.rb

@@ -13,6 +13,23 @@ class Item < Struct.new(:id, :title)
   include ActiveModel::Conversion
 end
 
+Paginator = Struct.new(:current, :previous, :next, :param_name, keyword_init: true)
+
+class PaginatorAdapter
+  def match?(metadata)
+    metadata.is_a?(Paginator)
+  end
+
+  def call(metadata, **_options)
+    {
+      page_name: metadata.param_name,
+      previous_page: metadata.previous,
+      next_page: metadata.next,
+      current_page: metadata.current
+    }
+  end
+end
+
 class InertiaBuilderTest < Minitest::Test
   USER_PARTIAL = <<~INERTIA
     prop.id user.id
@@ -260,6 +277,79 @@ class InertiaBuilderTest < Minitest::Test
                  render_view(template, assigns: { user: user }, json: true, headers: partial_headers)
   end
 
+  def test_scroll_block
+    users = [
+      User.new(id: 1, first_name: 'John', last_name: 'Smith', email: 'john@email.com'),
+      User.new(id: 2, first_name: 'Jane', last_name: 'Smith', email: 'jane@email.com')
+    ]
+
+    template = <<~INERTIA
+      prop.id 1
+      prop.scroll!(page_name: 'page', current_page: 1, previous_page: nil, next_page: 2) do
+        prop.users @users, partial: 'users/user', as: :user
+      end
+    INERTIA
+
+    expected = inertia_json_with_props(
+      { id: 1, users: users },
+      scrollProps: { users: { pageName: 'page', previousPage: nil, nextPage: 2, currentPage: 1, reset: false } },
+      mergeProps: ['users']
+    )
+
+    assert_equal expected, render_view(template, assigns: { users: users }, json: true)
+  end
+
+  def test_scroll_block_fetching
+    users = [
+      User.new(id: 3, first_name: 'Alice', last_name: 'Jones', email: 'alice@email.com'),
+      User.new(id: 4, first_name: 'Bob', last_name: 'Brown', email: 'bob@email.com')
+    ]
+
+    template = <<~INERTIA
+      prop.id 1
+      prop.scroll!(page_name: 'page', current_page: 2, previous_page: 1, next_page: 3) do
+        prop.users @users, partial: 'users/user', as: :user
+      end
+    INERTIA
+
+    partial_headers = {
+      'X-Inertia-Partial-Data' => 'users',
+      'X-Inertia-Partial-Component' => '/'
+    }
+    expected = inertia_json_with_props(
+      { users: users },
+      scrollProps: { users: { pageName: 'page', previousPage: 1, nextPage: 3, currentPage: 2, reset: false } },
+      mergeProps: ['users']
+    )
+
+    assert_equal expected, render_view(template, assigns: { users: users }, json: true, headers: partial_headers)
+  end
+
+  def test_scroll_block_with_metadata_extractor
+    users = [
+      User.new(id: 1, first_name: 'John', last_name: 'Smith', email: 'john@email.com')
+    ]
+
+    paginator = Paginator.new(current: 1, previous: nil, next: 2, param_name: 'p')
+
+    template = <<~INERTIA
+      prop.id 1
+      prop.scroll!(@paginator) do
+        prop.users @users, partial: 'users/user', as: :user
+      end
+    INERTIA
+
+    with_scroll_metadata_adapater(PaginatorAdapter) do
+      expected = inertia_json_with_props(
+        { id: 1, users: users },
+        scrollProps: { users: { pageName: 'p', previousPage: nil, nextPage: 2, currentPage: 1, reset: false } },
+        mergeProps: ['users']
+      )
+
+      assert_equal expected, render_view(template, assigns: { users: users, paginator: paginator }, json: true)
+    end
+  end
+
   private
 
   def render_view(source, **opts)
@@ -294,4 +384,12 @@ class InertiaBuilderTest < Minitest::Test
       clearHistory: false
     }.merge(extra_fields).to_json
   end
+
+  def with_scroll_metadata_adapater(adapter_class)
+    original_adapters = InertiaRails::ScrollMetadata.adapters.dup
+    InertiaRails::ScrollMetadata.register_adapter(adapter_class)
+    yield
+  ensure
+    InertiaRails::ScrollMetadata.adapters = original_adapters
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inertia_builder
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Rodrigo Lima
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: jbuilder
   requirement: !ruby/object:Gem::Requirement
@@ -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.2.2
-  source_code_uri: https://github.com/rodrigotavio91/inertia-builder/tree/v0.2.2
+  changelog_uri: https://github.com/rodrigotavio91/inertia-builder/releases/tag/v0.3.0
+  source_code_uri: https://github.com/rodrigotavio91/inertia-builder/tree/v0.3.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: