props_template 0.36.0 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '01825cc9ebfc4584469c98d5f8e9df4eb8461210b9eb7fce104ff9ed484c2fa0'
-  data.tar.gz: 392c600764ec2c4de0a0d0035c2d7c573e7bc19f071f0e2efd2b6a66d3e862bc
+  metadata.gz: 3667a1f94d254d08bf49d419e9c8d9c8fa72a4d5c4b4420c1caf65e3dbbf3e1c
+  data.tar.gz: 2a6bda4d99a4ce0aef62debf10ebbbe75399ea065390b5cd55a6208a9ff0d97b
 SHA512:
-  metadata.gz: cb079a592e94c1d85ca7bed68d334e3c39939652473ae9779ca92bd4cf76311fcca9f3e5603da198b5274e55cd49a54120a554c8968a76bea01141228d0d6abc
-  data.tar.gz: 6e3ada0a21fc1f1112bd5d0839d229b3bf673a79e96386af58d0ee6a4cbf5978081b9d1cc2ba84e98ad7a4f24430fa5eb1ecd11d54ae78fdc15e28ab68df23c0
+  metadata.gz: bc2851e095c1a83749d16b8256915ea76a1e1b76e6dd945f893030912b8920a45f6d7c8ee7722a0abd1d8eddf021d4884bdf4b19d74728df25ac85885b333e97
+  data.tar.gz: 3a18ecfd1c477c87e7a7ee267db634bd750c6c6b4a2804478ce850c9e0a633215bc9d33765b4487245d2f4b017e5826830cde72ba54387b53443eb0dcd79b437

data/README.md

@@ -72,7 +72,7 @@ gem 'props_template'
 and run `bundle`.
 
 Optionally add the [core ext](#array-core-extension) to an initializer if you
-want to [dig](#traversing) into your templates.
+want to [dig](#digging) into your templates.
 
 ```ruby
 require 'props_template/core_ext'
@@ -100,7 +100,7 @@ json.set! :authorDetails, {...options} do
   json.set! :firstName, 'David'
 end
 
-or
+# or
 
 json.authorDetails, {...options} do
   json.firstName 'David'
@@ -121,7 +121,7 @@ The inline form defines key and value
 
 json.set! :firstName, 'David'
 
-or
+# or
 
 json.firstName 'David'
 
@@ -138,13 +138,13 @@ The block form defines key and structure
 
 ```ruby
 json.set! :details do
-  ...
+  # ...
 end
 
 or
 
 json.details do
-  ...
+  # ...
 end
 ```
 
@@ -152,7 +152,7 @@ The difference between the block form and inline form is
   1. The block form is an internal node. Functionality such as Partials,
   Deferment and other [options](#options) are only available on the
   block form.
-  2. The inline form is considered a leaf node, and you can only [search](#traversing)
+  2. The inline form is considered a leaf node, and you can only [dig](#digging)
   for internal nodes.
 
 ### json.extract!
@@ -199,10 +199,10 @@ end
 
 | Parameter | Notes |
 | :--- | :--- |
-| collection | A collection that responds to `member_at` and `member_by` |
+| collection | A collection that optionally responds to `member_at` and `member_by` |
 | options | Additional [options](#options)|
 
-To support [traversing nodes](#traversing), any list passed
+To support [digging](#digging), any list passed
 to `array!` MUST implement `member_at(index)` and `member_by(attr, value)`.
 
 For example, if you were using a delegate:
@@ -230,7 +230,7 @@ data = ObjectCollection.new([
 ])
 
 json.array! data do
-  ...
+  # ...
 end
 ```
 
@@ -252,7 +252,7 @@ Then in your template:
 
 ```ruby
 json.array! Post.all do
-  ...
+  # ...
 end
 ```
 
@@ -270,13 +270,13 @@ data = [
 
 json.posts
   json.array! data do
-    ...
+    # ...
   end
 end
 ```
 
 PropsTemplate does not know what the elements are in your collection. The
-example above will be fine for [traversing](#traversing)
+example above will be fine for [digging](#digging)
 by index, but will raise a `NotImplementedError` if you query by attribute. You
 may still need to implement `member_by`.
 
@@ -306,7 +306,7 @@ option.
 `application.json.props` when first running `rails superglue:install:web`
 
 ## Options
-Options Functionality such as Partials, Deferements, and Caching can only be
+Options Functionality such as Partials, Deferments, and Caching can only be
 set on a block. It is normal to see empty blocks.
 
 ```ruby
@@ -339,7 +339,7 @@ end
 
 Rendering partials without a key is also supported using `json.partial!`, but use
 sparingly! `json.partial!` is not optimized for collection rendering and may
-cause performance problems. Its best used for things like a shared header or footer.
+cause performance problems. It's best used for things like a shared header or footer.
 
 Do:
 
@@ -359,7 +359,7 @@ end
 
 Do NOT:
 
-```
+```ruby
 @post.each do |post|
   json.partial! partial: "post", locals: {post: @post} do
   end
@@ -406,12 +406,12 @@ json.author(cache: "some_cache_key") do
   json.firstName "tommy"
 end
 
-#or
+# or
 
 json.profile(cache: "cachekey", partial: ["profile", locals: {foo: 1}]) do
 end
 
-#or nest it
+# or nest it
 
 json.author(cache: "some_cache_key") do
   json.address(cache: "some_other_cache_key") do
@@ -431,7 +431,7 @@ json.array! [4,5], opts do |x|
   json.top "hello" + x.to_s
 end
 
-#or on arrays with partials
+# or on arrays with partials
 
 opts = { cache: (->(d){ ['a', d.id] }), partial: ["blog_post", as: :blog_post] }
 
@@ -447,9 +447,9 @@ entirely and replace the value with a placeholder. A common use case would be
 tabbed content that does not load until you click the tab.
 
 When your client receives the payload, you may issue a second request to the
-same endpoint to fetch any missing nodes. See [traversing nodes](#traversing)
+same endpoint to fetch any missing nodes. See [digging](#digging)
 
-There is also an `defer: :auto` option that you can use with [SuperglueJS][1]. [SuperglueJS][1]
+There is also a `defer: :auto` option that you can use with [SuperglueJS][1]. [SuperglueJS][1]
 will use the metadata from `json.deferred!` to issue a `remote` dispatch to fetch
 the missing node and immutably graft it at the appropriate keypath in your Redux
 store.
@@ -489,10 +489,10 @@ json.defers json.deferred!
 ```
 
 #### Working with arrays
-The default behavior for deferements is to use the index of the collection to
+The default behavior for deferments is to use the index of the collection to
 identify an element.
 
-**Note** If you are using this library with [SuperglueJS][1], the `:auto` options will
+**Note** If you are using this library with [SuperglueJS][1], the `:auto` option will
 generate `?props_at=a.b.c.0.title` for `json.deferred!`.
 
 If you wish to use an attribute to identify the element. You must:
@@ -502,7 +502,7 @@ your collection item, and is used for `defer: :auto` to generate a keypath for
 [SuperglueJS][1]. If you are NOT using SuperglueJS, you do not need to do this.
 
 2. Implement `member_at`, on the [collection](#jsonarray). This will be called
-by PropsTemplate to when [searching nodes](#traversing)
+by PropsTemplate to when [digging](#digging)
 
 For example:
 
@@ -525,10 +525,10 @@ json.posts
 end
 ```
 
-If you are using [SuperglueJS][1], SuperglueJS will, it will automatically kick off
+If you are using [SuperglueJS][1], it will automatically kick off
 `remote(?props_at=posts.some_id=1.contact)` and `remote(?props_at=posts.some_id=2.contact)`.
 
-## Traversing
+## Digging
 
 PropsTemplate has the ability to walk the tree you build, skipping execution of
 untargeted nodes. This feature is useful for selectively updating your frontend
@@ -537,10 +537,10 @@ state.
 ```ruby
 traversal_path = ['data', 'details', 'personal']
 
-json.data(search: traversal_path) do
+json.data(dig: traversal_path) do
   json.details do
     json.employment do
-      ...more stuff
+      # ...more stuff
     end
 
     json.personal do
@@ -551,12 +551,12 @@ json.data(search: traversal_path) do
 end
 
 json.footer do
-  ...
+  # ...
 end
 ```
 
 PropsTemplate will walk depth first, walking only when it finds a matching key,
-then executes the associated block, and repeats until it the node is found.
+then executes the associated block, and repeats until the node is found.
 The above will output:
 
 ```json
@@ -571,13 +571,13 @@ The above will output:
 }
 ```
 
-Searching only works with blocks, and will NOT work with Scalars
+Digging only works with blocks, and will NOT work with Scalars
 ("leaf" values). For example:
 
 ```ruby
-traversal_path = ['data', 'details', 'personal', 'name'] <- not found
+traversal_path = ['data', 'details', 'personal', 'name'] # <- not found
 
-json.data(search: traversal_path) do
+json.data(dig: traversal_path) do
   json.details do
     json.personal do
       json.name 'james'
@@ -588,12 +588,12 @@ end
 
 ## Nodes that do not exist
 
-Nodes that are not found will remove the branch where search was enabled on.
+Nodes that are not found will remove the branch where digging was enabled on.
 
 ```ruby
 traversal_path = ['data', 'details', 'does_not_exist']
 
-json.data(search: traversal_path) do
+json.data(dig: traversal_path) do
   json.details do
     json.personal do
       json.name 'james'
@@ -602,7 +602,7 @@ json.data(search: traversal_path) do
 end
 
 json.footer do
-  ...
+  # ...
 end
 ```
 
@@ -641,8 +641,8 @@ json.flash flash.to_h
 will render Layout first, then the template when `yield json` is used.
 
 ## Change key format
-By default, keys are not formatted. This is intentional. By being explicity with your keys,
-it makes your views quicker and more easily searchable when working in Javascript land.
+By default, keys are not formatted. This is intentional. By being explicit with your keys,
+it makes your views quicker and more easily diggable when working in JavaScript land.
 
 If you must change this behavior, override it in an initializer and cache the value:
 

data/lib/props_template/base.rb

@@ -6,6 +6,8 @@ module Props
 
   class InvalidScopeForObjError < StandardError; end
 
+  class InvalidScopeForChildError < StandardError; end
+
   class Base
     def initialize(encoder = nil)
       @stream = Oj::StringWriter.new(mode: :rails)
@@ -87,8 +89,7 @@ module Props
       end
     end
 
-    # todo, add ability to define contents of array
-    def array!(collection, options = {})
+    def array!(collection = nil, options = {})
       if @scope.nil?
         @scope = :array
         @stream.push_array
@@ -96,8 +97,13 @@ module Props
         raise InvalidScopeForArrayError.new("array! expects exclusive use of this block")
       end
 
-      handle_collection(collection, options) do |item, index|
-        yield item, index
+      if collection.nil?
+        @child_index = nil
+        yield
+      else
+        handle_collection(collection, options) do |item, index|
+          yield item, index
+        end
       end
 
       @scope = :array
@@ -131,6 +137,28 @@ module Props
       end
     end
 
+    def child!(options = {})
+      if @scope != :array
+        raise InvalidScopeForChildError.new("child! can only be used in a `array!` with no arguments")
+      end
+
+      if !block_given?
+        raise ArgumentError.new("child! requires a block")
+      end
+
+      inner_scope = @scope
+      child_index = @child_index || -1
+      child_index += 1
+
+      # this changes the scope to nil so child in a child will break
+      set_block_content!(options) do
+        yield
+      end
+
+      @scope = inner_scope
+      @child_index = child_index
+    end
+
     def result!
       if @scope.nil?
         @stream.push_object

data/lib/props_template/base_with_extensions.rb

@@ -10,6 +10,10 @@ module Props
       super()
     end
 
+    def disable_deferments!
+      @em.disable_deferments
+    end
+
     def deferred!
       @em.deferred
     end

data/lib/props_template/extension_manager.rb

@@ -12,9 +12,16 @@ module Props
       @cache = Cache.new(@context)
     end
 
+    def disable_deferments
+      @deferment.disable!
+    end
+
     def refine_options(options, item = nil)
       options = @partialer.refine_options(options, item)
-      options = @deferment.refine_options(options, item)
+      if !@deferment.disabled
+        options = @deferment.refine_options(options, item)
+      end
+
       Cache.refine_options(options, item)
     end
 
@@ -40,7 +47,7 @@ module Props
     def handle(options)
       return yield if !has_extensions(options)
 
-      if options[:defer]
+      if options[:defer] && !@deferment.disabled
         placeholder = @deferment.handle(options)
         base.stream.push_value(placeholder)
         @fragment.handle(options)
@@ -86,12 +93,13 @@ module Props
           result
         end
 
+        meta, raw_json = state.split("\n")
+        next_deferred, next_fragments = Oj.load(meta)
+        deferred.push(*next_deferred)
+        fragments.push(*next_fragments)
+
         if !recently_cached
-          meta, raw_json = state.split("\n")
-          next_deferred, next_fragments = Oj.load(meta)
           base.stream.push_json(raw_json)
-          deferred.push(*next_deferred)
-          fragments.push(*next_fragments)
         end
       else
         yield

data/lib/props_template/extensions/deferment.rb

@@ -1,10 +1,15 @@
 module Props
   class Deferment
-    attr_reader :deferred
+    attr_reader :deferred, :disabled
 
     def initialize(base, deferred = [])
       @deferred = deferred
       @base = base
+      @disabled = false
+    end
+
+    def disable!
+      @disabled = true
     end
 
     def refine_options(options, item = nil)

data/lib/props_template/extensions/partial_renderer.rb

@@ -152,6 +152,10 @@ module Props
         locals[as] = item
 
         if (fragment_name = rest[:fragment])
+          if item && ::Proc === fragment_name
+            fragment_name = fragment_name.call(item)
+          end
+
           rest[:fragment] = fragment_name.to_s
         end
       end
@@ -163,3 +167,4 @@ module Props
     end
   end
 end
+

data/lib/props_template/partial_patch.rb

@@ -0,0 +1,39 @@
+module Props
+  module PartialPatch
+    def render(partial, context, block)
+      template = find_template(partial, template_keys(partial))
+
+      if !block && (layout = @options[:layout])
+        layout = find_template(layout.to_s, template_keys(partial))
+      end
+
+      if template.respond_to?(:handler) && template.handler == Props::Handler && layout
+        render_partial_props_template(context, @locals, template, layout, block)
+      else
+        super
+      end
+    end
+
+    def render_partial_props_template(view, locals, template, layout, block)
+      ActiveSupport::Notifications.instrument(
+        "render_partial.action_view",
+        identifier: template.identifier,
+        layout: layout && layout.virtual_path,
+        locals: locals
+      ) do |payload|
+        body = if layout
+          layout.render(view, locals, add_to_stack: !block) do |json|
+            template.render(view, locals)
+          end
+        else
+          template.render(view, locals)
+        end
+
+        build_rendered_template(body, template)
+      end
+    end
+  end
+end
+
+ActionView::PartialRenderer.prepend(Props::PartialPatch)
+

data/lib/props_template/railtie.rb

@@ -8,6 +8,7 @@ module Props
         ActionView::Template.register_template_handler :props, Props::Handler
         require "props_template/dependency_tracker"
         require "props_template/layout_patch"
+        require "props_template/partial_patch"
       end
     end
 

data/lib/props_template/searcher.rb

@@ -60,42 +60,75 @@ module Props
       nil
     end
 
-    def array!(collection, options = {}, &block)
+    def array!(collection = nil, options = {}, &block)
       return if @found_block
 
-      key_index = @search_path[@depth]
-      id_name, id_val = key_index.to_s.split("=")
-
-      if id_val
-        id_val = id_val.to_i
-        item = collection.member_by(id_name, id_val)
+      if collection.nil?
+        # Handle child! mode - initialize child_index for searching
+        @child_index = nil
+        yield
       else
-        index = id_name.to_i
-        item = collection.member_at(index)
+        # Original collection handling
+        key_index = @search_path[@depth]
+        id_name, id_val = key_index.to_s.split("=")
+
+        if id_val
+          id_val = id_val.to_i
+          item = collection.member_by(id_name, id_val)
+        else
+          index = id_name.to_i
+          item = collection.member_at(index)
+        end
+
+        if item
+          pass_opts = @partialer.refine_options(options, item)
+          @traveled_path.push(key_index)
+
+          if @depth == @search_path.size - 1
+            @found_options = pass_opts
+            @found_block = proc {
+              yield item, 0
+            }
+            return
+          end
+
+          @depth += 1
+          if pass_opts[:partial]
+            # todo: what happens when cached: true is passed?
+            # would there be any problems with not using the collection_rende?
+            @partialer.handle(pass_opts)
+          else
+            yield item, 0
+          end
+          @depth -= 1
+        end
       end
+    end
 
-      if item
-        pass_opts = @partialer.refine_options(options, item)
+    def child!(options={}, &block)
+      return if @found_block
+
+      child_index = @child_index || -1
+      child_index += 1
+
+      key_index = @search_path[@depth]
+      target_index = key_index.to_i
+
+      if child_index == target_index
         @traveled_path.push(key_index)
 
         if @depth == @search_path.size - 1
-          @found_options = pass_opts
-          @found_block = proc {
-            yield item, 0
-          }
+          @found_options = {}
+          @found_block = block
           return
         end
 
         @depth += 1
-        if pass_opts[:partial]
-          # todo: what happens when cached: true is passed?
-          # would there be any problems with not using the collection_rende?
-          @partialer.handle(pass_opts)
-        else
-          yield item, 0
-        end
+        yield
         @depth -= 1
       end
+
+      @child_index = child_index    
     end
   end
 end

data/lib/props_template/version.rb

@@ -1,3 +1,3 @@
 module Props
-  VERSION = "0.36.0".freeze
+  VERSION = "0.38.0".freeze
 end

data/lib/props_template.rb

@@ -22,10 +22,12 @@ module Props
     self.template_lookup_options = {handlers: [:props]}
 
     delegate :result!, :array!,
+      :child!,
       :partial!,
       :extract!,
       :deferred!,
       :fragments!,
+      :disable_deferments!,
       :set_block_content!,
       :traveled_path!,
       to: :builder!
@@ -36,11 +38,15 @@ module Props
     end
 
     def set!(key, options = {}, &block)
-      if block && options[:search] && !@builder.is_a?(Searcher)
+      if block && (options[:search] || options[:dig]) && !@builder.is_a?(Searcher)
+        search = options[:search] || options[:dig]
 
         prev_builder = @builder
-        @builder = Searcher.new(self, options[:search], @context)
+        @builder = Searcher.new(self, search, @context)
+
         options.delete(:search)
+        options.delete(:dig)
+
         @builder.set!(key, options, &block)
         found_block, found_options = @builder.found!
         @builder = prev_builder

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: props_template
 version: !ruby/object:Gem::Version
-  version: 0.36.0
+  version: 0.38.0
 platform: ruby
 authors:
 - Johny Ho
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2025-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,40 +15,52 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
 description: PropsTemplate is a direct-to-Oj, JBuilder-like DSL for building JSON.
@@ -73,6 +84,7 @@ files:
 - lib/props_template/extensions/partial_renderer.rb
 - lib/props_template/handler.rb
 - lib/props_template/layout_patch.rb
+- lib/props_template/partial_patch.rb
 - lib/props_template/railtie.rb
 - lib/props_template/searcher.rb
 - lib/props_template/version.rb
@@ -80,7 +92,6 @@ homepage: https://github.com/thoughtbot/props_template/
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,8 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A fast JSON builder
 test_files: []