curlybars 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ef985c46340022e337318774e4fcf8f36a1f0f7fc6d87788d70ffa3b214f16f
-  data.tar.gz: 1bd1f9195be76418bc0b416f6466aa73809f39037d93ccdde901d90ffca14baa
+  metadata.gz: 2bf7afea132372069b140438296f8686ec486b2759c7fc89552b332ff1aed7ed
+  data.tar.gz: e03465297fef9e3c18c817bac1f0daae10d01d9cc051ac295049b7df9ae70158
 SHA512:
-  metadata.gz: 443143ccfb796e5cc14f4cb4bf2f5c1958b8de9b271c95f8fdfccc07caa169d520e4563e70b5111109f6d914388d18c8c6bd519f837524371f235cb375b10389
-  data.tar.gz: fc72c19b12e2084f7e9dab5a01c51d6c6f7ab1614dde449f635356f40fc0841ef3305fd2fb6169763c6333e66324e3486d38f396516325794597b8184801e84a
+  metadata.gz: 139398b59fdf16fd1b287a9a6968a304ea99b52bff79592a262ca695942d17e02a5c0a84fb7a278cba1d4f503f394fb1a42794ad90e71e647cb0174331266108
+  data.tar.gz: 2ce2c49e86bcdfd99b7754b8b6a48ec7d9ef01ef97b99c179c4a7d466838ce676e40cb82d6f0f80dc748d3eb516a9af8f9c74ac1ce800a68896fd1ae1d6cb49e

data/lib/curlybars/path_finder.rb

@@ -5,9 +5,13 @@ module Curlybars
       @matches = []
     end
 
-    def find(target_path)
+    # Find paths matching +target_path+.
+    # +role:+ filters by syntactic role — :output, :helper, :argument, :option,
+    # :condition, :collection, :scope, :partial, or an Array of these.
+    def find(target_path, role: nil)
       @matches = []
       @target_segments = normalize_path(target_path)
+      @role_filter = role
       traverse(@ast.template, [])
       @matches
     end
@@ -20,7 +24,7 @@ module Curlybars
       path.to_s.split('.')
     end
 
-    def traverse(node, context_stack)
+    def traverse(node, context_stack, role: nil)
       return unless node
 
       case node
@@ -29,15 +33,15 @@ module Curlybars
       when Curlybars::Node::Item
         traverse(node.item, context_stack)
       when Curlybars::Node::Path
-        check_path_match(node, context_stack)
+        check_path_match(node, context_stack, role)
       when Curlybars::Node::Output
-        traverse(node.value, context_stack)
+        traverse(node.value, context_stack, role: :output)
       when Curlybars::Node::Partial
-        traverse(node.path, context_stack)
+        traverse(node.path, context_stack, role: :partial)
       when Curlybars::Node::SubExpression
-        traverse(node.helper, context_stack)
-        node.arguments&.each { |arg| traverse(arg, context_stack) }
-        node.options&.each { |opt| traverse(opt.expression, context_stack) }
+        traverse(node.helper, context_stack, role: :helper)
+        node.arguments&.each { |arg| traverse(arg, context_stack, role: :argument) }
+        node.options&.each { |opt| traverse(opt.expression, context_stack, role: :option) }
       when Curlybars::Node::BlockHelperElse
         handle_block_helper(node, context_stack)
       when Curlybars::Node::IfElse, Curlybars::Node::UnlessElse
@@ -49,13 +53,25 @@ module Curlybars
       end
     end
 
-    def check_path_match(path_node, context_stack)
+    def check_path_match(path_node, context_stack, role)
+      return unless matches_role?(role)
+
       path_segments = path_node.path.split('.')
       resolved_segments = resolve_path(path_segments, context_stack)
 
       @matches << path_node if resolved_segments == @target_segments
     end
 
+    def matches_role?(role)
+      return true if @role_filter.nil?
+
+      if @role_filter.is_a?(Array)
+        @role_filter.include?(role)
+      else
+        @role_filter == role
+      end
+    end
+
     def resolve_path(path_segments, context_stack)
       full_path = path_segments.join('.')
       stack = context_stack.dup
@@ -71,15 +87,25 @@ module Curlybars
     end
 
     def handle_block_helper(node, context_stack)
-      traverse(node.helper, context_stack)
+      if simple_output?(node)
+        traverse(node.helper, context_stack, role: :output)
+      else
+        traverse(node.helper, context_stack, role: :helper)
+        node.arguments&.each { |arg| traverse(arg, context_stack, role: :argument) }
+        node.options&.each { |opt| traverse(opt.expression, context_stack, role: :option) }
+      end
       traverse(node.helper_template, context_stack)
       traverse(node.else_template, context_stack) if node.else_template
-      node.arguments&.each { |arg| traverse(arg, context_stack) }
-      node.options&.each { |opt| traverse(opt.expression, context_stack) }
+    end
+
+    def simple_output?(block_helper)
+      block_helper.arguments.empty? &&
+        block_helper.options.empty? &&
+        !block_helper.helper_template.is_a?(Curlybars::Node::Template)
     end
 
     def handle_conditional(node, context_stack)
-      traverse(node.expression, context_stack)
+      traverse(node.expression, context_stack, role: :condition)
 
       if node.is_a?(Curlybars::Node::IfElse)
         traverse(node.if_template, context_stack)
@@ -90,7 +116,7 @@ module Curlybars
     end
 
     def handle_each(node, context_stack)
-      traverse(node.path, context_stack)
+      traverse(node.path, context_stack, role: :collection)
 
       # EachElse changes context to the item being iterated
       collection_path = node.path.respond_to?(:subexpression?) && node.path.subexpression? ? node.path.helper : node.path
@@ -100,7 +126,7 @@ module Curlybars
     end
 
     def handle_with(node, context_stack)
-      traverse(node.path, context_stack)
+      traverse(node.path, context_stack, role: :scope)
 
       # WithElse changes context to the specified path
       presenter_path = node.path.respond_to?(:subexpression?) && node.path.subexpression? ? node.path.helper : node.path

data/lib/curlybars/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Curlybars
-  VERSION = '1.13.0'
+  VERSION = '1.14.0'
 end

data/lib/curlybars.rb

@@ -84,12 +84,22 @@ module Curlybars
     # target_path - The path String to search for (e.g., "user.name" or "user.organizations.id").
     # source - The source HBS String used to generate an AST.
     # identifier - The the file name of the template being checked (defaults to `nil`).
+    # role - Optional Symbol or Array of Symbols to filter by syntactic role:
+    #          :output     - bare output value         {{title}}
+    #          :helper     - helper name               {{truncate …}}, {{#block …}}
+    #          :argument   - positional argument        {{truncate title}}, (math score)
+    #          :option     - keyword option value       key=title
+    #          :condition  - #if / #unless expression   {{#if visible}}
+    #          :collection - #each collection path      {{#each posts}}
+    #          :scope      - #with scope path           {{#with author}}
+    #          :partial    - partial name               {{> header}}
+    #        When nil (default), all roles match (backward compatible).
     #
     # Returns an Array of Curlybars::Node::Path instances that match the target path.
-    def find(target_path, source, identifier = nil)
+    def find(target_path, source, identifier = nil, role: nil)
       tree = ast(transformed_source(source), identifier, run_processors: true)
       finder = Curlybars::PathFinder.new(tree)
-      finder.find(target_path)
+      finder.find(target_path, role: role)
     end
 
     def global_helpers_dependency_tree

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: curlybars
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Libo Cannici