node_query 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c7363cd71167f293f046d95014611ceb1f695c6639036a3cc0e202ab0ae5b2b
-  data.tar.gz: 161c5784daae011699a1300b0cedc2f18bdc7235f71b7e89e1b1dce41caef71a
+  metadata.gz: 526c6ef0b0f58f1a8f1f7aff14e147ce4220cd6366bea5d5108db29591e0ab02
+  data.tar.gz: 347fc60e4f3629871356757349c5a126235a192049eefa713fb15890d26033d0
 SHA512:
-  metadata.gz: 356e94651bf61cb5c244399bbfe0aa353aafe3a3506fc7e6b1efba9cc4c853a0b963850c9d64e9b9de26dd3986f10967b2752a3dc7ec627dfd7466ddcf9a70f8
-  data.tar.gz: 0fdacf2a86292f60968a02054ce43e02a131d3a1da7c528d1e6df2e8279afd5de19afe714a80bd1b9ab17143c433b4e219c7be2cf8b55e3f28e45ff82a25d274
+  metadata.gz: b94b5f913b63824d89211dc6156add8ada6963a0122cf5d6adafc60fcf20af62a4f9a239f2bd341ef12167adcf8a5785b96b9c1b6bbad41d2ebe3f0eb90b498f
+  data.tar.gz: 2a9613221d35553af7e91e1e2a20792dbee63572634e254633cb0951180adb48b582454dee93f6c817d870ec16962af346bb1ce4ea253b253da10cb7e78ada49

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 1.5.0 (2022-09-15)
+
+* Add `Helper.to_string`
+* Only check the current node if `including_self` is true and `recursive` is false
+* Fix `Regexp#match?` and `String#match?`
+* Rename `stop_on_match` to `stop_at_first_match`
+
+## 1.4.0 (2022-09-14)
+
+* Add options `including_self`, `stop_on_match` and `recursive`
+* Fix regex to match evaluated value
+
 ## 1.3.0 (2022-09-13)
 
 * Rename `NodeQuery#parse` to `NodeQuery#query_nodes`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    node_query (1.3.0)
+    node_query (1.5.0)
       activesupport (< 7.0.0)
 
 GEM

data/README.md

@@ -62,7 +62,7 @@ It provides two apis: `query_nodes` and `match_node?`
 
 ```ruby
 node_query = NodeQuery.new(nqlOrRules: String | Hash) # Initialize NodeQuery
-node_query.query_nodes(node: Node, including_self = true): Node[] # Get the matching nodes.
+node_query.query_nodes(node: Node, options = { including_self: true, stop_at_first_match: false, recursive: true }): Node[] # Get the matching nodes.
 node_query.match_node?(node: Node): boolean # Check if the node matches nql or rules.
 ```
 

data/lib/node_query/compiler/expression.rb

@@ -13,14 +13,17 @@ module NodeQuery::Compiler
 
     # Query nodes by the selector and the rest expression.
     # @param node [Node] node to match
-    # @params including_self [boolean] if query the current node.
+    # @param options [Hash] if query the current node
+    # @option options [boolean] :including_self if query the current node, default is ture
+    # @option options [boolean] :stop_at_first_match if stop at first match, default is false
+    # @option options [boolean] :recursive if recursively query child nodes, default is true
     # @return [Array<Node>] matching nodes.
-    def query_nodes(node, including_self = true)
-      matching_nodes = @selector.query_nodes(node, including_self)
+    def query_nodes(node, options = {})
+      matching_nodes = @selector.query_nodes(node, options)
       return matching_nodes if @rest.nil?
 
       matching_nodes.flat_map do |matching_node|
-        @rest.query_nodes(matching_node, including_self)
+        @rest.query_nodes(matching_node, options)
       end
     end
 

data/lib/node_query/compiler/expression_list.rb

@@ -13,13 +13,16 @@ module NodeQuery::Compiler
 
     # Query nodes by the current and the rest expression.
     # @param node [Node] node to match
-    # @params including_self [boolean] if query the current node.
+    # @param options [Hash] if query the current node
+    # @option options [boolean] :including_self if query the current node, default is ture
+    # @option options [boolean] :stop_at_first_match if stop at first match, default is false
+    # @option options [boolean] :recursive if recursively query child nodes, default is true
     # @return [Array<Node>] matching nodes.
-    def query_nodes(node, including_self = true)
-      matching_nodes = @expression.query_nodes(node, including_self)
+    def query_nodes(node, options = {})
+      matching_nodes = @expression.query_nodes(node, options)
       return matching_nodes if @rest.nil?
 
-      matching_nodes + @rest.query_nodes(node, including_self)
+      matching_nodes + @rest.query_nodes(node, options)
     end
 
     # Check if the node matches the expression list.

data/lib/node_query/compiler/regexp.rb

@@ -13,13 +13,16 @@ module NodeQuery::Compiler
 
     # Check if the regexp value matches the node value.
     # @param node [Node] the node
-    # @return [Boolean] true if the regexp value matches the node value.
-    def is_equal?(node)
-      if NodeQuery.adapter.is_node?(node)
-        @value.match(NodeQuery.adapter.get_source(node))
-      else
-        @value.match(node.to_s)
-      end
+    # @param operator [String] the operator
+    # @return [Boolean] true if the regexp value matches the node value, otherwise, false.
+    def match?(node, operator = '=~')
+      match =
+        if NodeQuery.adapter.is_node?(node)
+          @value.match(NodeQuery.adapter.get_source(node))
+        else
+          @value.match(node.to_s)
+        end
+      operator == '=~' ? match : !match
     end
 
     # Get valid operators.

data/lib/node_query/compiler/selector.rb

@@ -33,9 +33,13 @@ module NodeQuery::Compiler
     # * If relationship is next sibling, it try to match next sibling node.
     # * If relationship is subsequent sibling, it will match in all sibling nodes.
     # @param node [Node] node to match
-    # @params including_self [boolean] if query the current node.
+    # @param options [Hash] if query the current node
+    # @option options [boolean] :including_self if query the current node, default is ture
+    # @option options [boolean] :stop_at_first_match if stop at first match, default is false
+    # @option options [boolean] :recursive if recursively query child nodes, default is true
     # @return [Array<Node>] matching nodes.
-    def query_nodes(node, including_self = true)
+    def query_nodes(node, options = {})
+      options = { including_self: true, stop_at_first_match: false, recursive: true }.merge(options)
       return find_nodes_by_relationship(node) if @relationship
 
       if node.is_a?(::Array)
@@ -44,13 +48,30 @@ module NodeQuery::Compiler
 
       return find_nodes_by_goto_scope(node) if @goto_scope
 
+      if options[:including_self] && !options[:recursive]
+        return match?(node) ? [node] : []
+      end
+
       nodes = []
-      if including_self && match?(node)
+      if options[:including_self] && match?(node)
         nodes << node
+        return nodes if options[:stop_at_first_match]
       end
       if @basic_selector
-        NodeQuery::Helper.handle_recursive_child(node) do |child_node|
-          nodes << child_node if match?(child_node)
+        if options[:recursive]
+          NodeQuery::Helper.handle_recursive_child(node) do |child_node|
+            if match?(child_node)
+              nodes << child_node
+              break if options[:stop_at_first_match]
+            end
+          end
+        else
+          NodeQuery.adapter.get_children(node).each do |child_node|
+            if match?(child_node)
+              nodes << child_node
+              break if options[:stop_at_first_match]
+            end
+          end
         end
       end
       nodes

data/lib/node_query/compiler/string.rb

@@ -27,7 +27,7 @@ module NodeQuery::Compiler
     # @param node [Node] the node
     # @return [Boolean] true if the actual value equals the node value.
     def is_equal?(node)
-      actual_value(node).to_s == expected_value
+      NodeQuery::Helper.to_string(actual_value(node)) == expected_value
     end
 
     # Get valid operators.

data/lib/node_query/helper.rb

@@ -48,11 +48,19 @@ class NodeQuery::Helper
     # @param str [String] string to be evaluated
     # @return [String] evaluated string
     def evaluate_node_value(node, str)
-      str.scan(/{{(.*)}}/).each do |match_data|
+      str.scan(/{{(.*?)}}/).each do |match_data|
         target_node = NodeQuery::Helper.get_target_node(node, match_data.first)
-        str = str.sub("{{#{match_data.first}}}", NodeQuery.adapter.get_source(target_node))
+        str = str.sub("{{#{match_data.first}}}", to_string(target_node))
       end
       str
     end
+
+    def to_string(node)
+      if NodeQuery.adapter.is_node?(node)
+        return NodeQuery.adapter.get_source(node)
+      end
+
+      node.to_s
+    end
   end
 end

data/lib/node_query/node_rules.rb

@@ -11,16 +11,35 @@ class NodeQuery::NodeRules
 
   # Query nodes by the rules.
   # @param node [Node] node to query
-  # @params including_self [boolean] if query the current node.
+  # @param options [Hash] if query the current node
+  # @option options [boolean] :including_self if query the current node, default is ture
+  # @option options [boolean] :stop_at_first_match if stop at first match, default is false
+  # @option options [boolean] :recursive if recursively query child nodes, default is true
   # @return [Array<Node>] matching nodes.
-  def query_nodes(node, including_self = true)
+  def query_nodes(node, options = {})
+    options = { including_self: true, stop_at_first_match: false, recursive: true }.merge(options)
+    if options[:including_self] && !options[:recursive]
+      return match_node?(node) ? [node] : []
+    end
+
     matching_nodes  = []
-    if (including_self && match_node?(node))
+    if options[:including_self] && match_node?(node)
       matching_nodes.push(node)
+      return matching_nodes if options[:stop_at_first_match]
     end
-    NodeQuery::Helper.handle_recursive_child(node) do |child_node|
-      if (match_node?(child_node))
-        matching_nodes.push(child_node)
+    if options[:recursive]
+      NodeQuery::Helper.handle_recursive_child(node) do |child_node|
+        if match_node?(child_node)
+          matching_nodes.push(child_node)
+          break if options[:stop_at_first_match]
+        end
+      end
+    else
+      NodeQuery.adapter.get_children(node).each do |child_node|
+        if match_node?(child_node)
+          matching_nodes.push(child_node)
+          break if options[:stop_at_first_match]
+        end
       end
     end
     matching_nodes

data/lib/node_query/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class NodeQuery
-  VERSION = "1.3.0"
+  VERSION = "1.5.0"
 end

data/lib/node_query.rb

@@ -38,13 +38,16 @@ class NodeQuery
 
   # Query matching nodes.
   # @param node [Node] ast node
-  # @param including_self [boolean] if check the node itself
+  # @param options [Hash] if query the current node
+  # @option options [boolean] :including_self if query the current node, default is ture
+  # @option options [boolean] :stop_at_first_match if stop at first match, default is false
+  # @option options [boolean] :recursive if recursively query child nodes, default is true
   # @return [Array<Node>] matching child nodes
-  def query_nodes(node, including_self = true)
+  def query_nodes(node, options = {})
     if @expression
-      @expression.query_nodes(node, including_self)
+      @expression.query_nodes(node, options)
     elsif @rules
-      @rules.query_nodes(node, including_self)
+      @rules.query_nodes(node, options)
     else
       []
     end

data/sig/node_query.rbs

@@ -7,7 +7,7 @@ class NodeQuery[T]
 
   def initialize: (nqlOrRues: String | Hash) -> NodeQuery
 
-  def query_nodes: (node: T, including_self: boolean) -> Array[T]
+  def query_nodes: (node: T, options: Hash) -> Array[T]
 
   def match_node?: (node: T) -> boolean
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: node_query
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-13 00:00:00.000000000 Z
+date: 2022-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport