node_query 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e489f2422c8b9f55da98a88393f23d1526759989feb8f34b9b1c822d6770250c
-  data.tar.gz: 99c6229810c7ffc28be0c29903a1719f4b07cb78a801028f5c7c44e0db97358d
+  metadata.gz: a2e54cf10c098ebfaff54d05d36f482c2766b5308f4b8389b2b6a86c1bfb6363
+  data.tar.gz: 4d0b3f4ece89c3d4184c9b8159b924a2e321bafde7b598ee1789f17a41b73ee4
 SHA512:
-  metadata.gz: b34877880a1058c6895c7a23bd6fb66a3e0b326a924878240a7ac49054ad0c39a37085405c4163fd9a92483929d8cff096a6b97b3a1b875093e1a151c3ad64d9
-  data.tar.gz: 1ddfb1d645b1636f20f85a207324783cf48207109d88b2e0bf9a60c65d84b47a432152207b63df3ed33996ec3982352e376ed6f81c1018eb8b2c19ef472ab393
+  metadata.gz: 0a0245239a1a6739dc8a9c51ddc507ddec1fba5e11820678d002af9572e4ed3e810b4ff4835bf6c6c36019e750f252da6a1fbbe08aa2abf00374d7010d6e7e36
+  data.tar.gz: e5ae500ad6d17776a1c2becc86f451fa7cc222e731a309dcb86be654930e1b3d038ad649319fa7805e03c4ea54320959898413bbde79a07dfeb09a50831a897d

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 1.13.0 (2023-05-15)
+
+* Add `SyntaxTreeParser`
+
+## 1.12.1 (2023-04-06)
+
+* Fix when `actual` is nil
+
 ## 1.12.0 (2023-01-16)
 
 * Drop `activesupport`

data/Gemfile

@@ -16,3 +16,4 @@ gem "oedipus_lex"
 gem "racc"
 gem "parser"
 gem "parser_node_ext"
+gem "syntax_tree_ext"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    node_query (1.12.0)
+    node_query (1.13.0)
 
 GEM
   remote: https://rubygems.org/
@@ -38,14 +38,15 @@ GEM
       nenv (~> 0.1)
       shellany (~> 0.0)
     oedipus_lex (2.6.0)
-    parser (3.1.2.0)
+    parser (3.2.2.1)
       ast (~> 2.4.1)
-    parser_node_ext (0.4.0)
+    parser_node_ext (1.1.0)
       parser
+    prettier_print (1.2.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.6.0)
+    racc (1.6.2)
     rake (13.0.6)
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
@@ -64,6 +65,10 @@ GEM
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
     shellany (0.0.1)
+    syntax_tree (6.1.1)
+      prettier_print (>= 1.2.0)
+    syntax_tree_ext (0.3.0)
+      syntax_tree
     thor (1.2.1)
 
 PLATFORMS
@@ -82,6 +87,7 @@ DEPENDENCIES
   racc
   rake (~> 13.0)
   rspec (~> 3.0)
+  syntax_tree_ext
 
 BUNDLED WITH
    2.3.7

data/README.md

@@ -17,14 +17,14 @@ NodeQuery defines a NQL (node query language) and node rules to query AST nodes.
     - [nql matches method result](#nql-matches-method-result)
     - [nql matches operators](#nql-matches-operators)
     - [nql matches array node attribute](#nql-matches-array-node-attribute)
-    - [nql matches * in attribute key](#nql-matches--in-attribute-key)
+    - [nql matches \* in attribute key](#nql-matches--in-attribute-key)
     - [nql matches multiple selectors](#nql-matches-multiple-selectors)
       - [Descendant combinator](#descendant-combinator)
       - [Child combinator](#child-combinator)
       - [Adjacent sibling combinator](#adjacent-sibling-combinator)
       - [General sibling combinator](#general-sibling-combinator)
     - [nql matches goto scope](#nql-matches-goto-scope)
-    - [nql matches :has and :not_has pseudo selector](#nql-matches-has-and-not_has-pseudo-selector)
+    - [nql matches :has and :not\_has pseudo selector](#nql-matches-has-and-not_has-pseudo-selector)
     - [nql matches :first-child and :last-child pseudo selector](#nql-matches-first-child-and-last-child-pseudo-selector)
     - [nql matches multiple expressions](#nql-matches-multiple-expressions)
   - [Node Rules](#node-rules)
@@ -115,7 +115,7 @@ It matches class node whose parent class name is Base
 ### nql matches evaluated value
 
 ```
-.ivasgn[left_value="@{{right_value}}"]
+.ivasgn[variable="@{{value}}"]
 ```
 
 It matches ivasgn node whose left value equals '@' plus the evaluated value of right value.
@@ -271,7 +271,7 @@ It matches send node whose parent is def node.
 #### Adjacent sibling combinator
 
 ```
-.send[left_value=@id] + .send
+.send[variable=@id] + .send
 ```
 
 It matches send node only if it is immediately follows the send node whose left value is @id.
@@ -279,7 +279,7 @@ It matches send node only if it is immediately follows the send node whose left
 #### General sibling combinator
 
 ```
-.send[left_value=@id] ~ .send
+.send[variable=@id] ~ .send
 ```
 
 It matches send node only if it is follows the send node whose left value is @id.
@@ -323,7 +323,7 @@ It matches the last def node.
 ### nql matches multiple expressions
 
 ```
-.ivasgn[left_value=@id], .ivasgn[left_value=@name]
+.ivasgn[variable=@id], .ivasgn[variable=@name]
 ```
 
 It matches ivasgn node whose left value is either @id or @name.
@@ -363,7 +363,7 @@ It matches class node whose parent class name is Base
 ### rules matches evaluated value
 
 ```
-{ node_type: 'ivasgn', left_value: '@{{right_value}}' }
+{ node_type: 'ivasgn', variable: '@{{value}}' }
 ```
 
 It matches ivasgn node whose left value equals '@' plus the evaluated value of right value.
@@ -474,17 +474,18 @@ It matches def node whose arguments are id and name.
 
 ## Write Adapter
 
-Different parser, like parser, will generate different AST nodes, to make NodeQuery work for them all,
+Different parser, like parser, syntax_tree, will generate different AST nodes, to make NodeQuery work for them all,
 we define an [Adapter](https://github.com/xinminlabs/node-query-ruby/blob/main/lib/node_query/adapter.rb) interface,
 if you implement the Adapter interface, you can set it as NodeQuery's adapter.
 
-```ruby
-NodeQuery.configure(adapter: ParserAdapter.new)
-```
+It provides 2 adapters
 
-Here is the ParserAdapter implementation:
+1. `ParserAdapter`
+2. `SyntaxTreeAdapter`
 
-[ParserAdapter](https://github.com/xinminlabs/node-query-ruby/blob/main/lib/node_query/parser_adapter.rb)
+```ruby
+NodeQuery.configure(adapter: SyntaxTreeAdapter.new) # default is ParserAdapter
+```
 
 ## Development
 

data/lib/node_query/adapter/syntax_tree.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class NodeQuery::SyntaxTreeAdapter
+  def is_node?(node)
+    node.is_a?(SyntaxTree::Node)
+  end
+
+  def get_node_type(node)
+    node.class.name.split('::').last
+  end
+
+  def get_source(node)
+    node.source
+  end
+
+  def get_children(node)
+    node.child_nodes
+  end
+
+  def get_siblings(node)
+    node.siblings
+  end
+end

data/lib/node_query/adapter.rb

@@ -35,4 +35,4 @@ class NodeQuery::Adapter
   def get_siblings(node)
     raise NotImplementedError, 'get_siblings is not implemented'
   end
-end
+end

data/lib/node_query/compiler/basic_selector.rb

@@ -18,7 +18,10 @@ module NodeQuery::Compiler
     def match?(node, base_node, _operator = '==')
       return false unless node
 
-      @node_type.to_sym == NodeQuery.adapter.get_node_type(node) && (!@attribute_list || @attribute_list.match?(node, base_node))
+      @node_type.to_sym == NodeQuery.adapter.get_node_type(node) && (!@attribute_list || @attribute_list.match?(
+        node,
+        base_node
+      ))
     end
 
     def to_s

data/lib/node_query/compiler/comparable.rb

@@ -25,7 +25,9 @@ module NodeQuery::Compiler
       when '!='
         if expected.is_a?(::Array)
           !actual.is_a?(::Array) || actual.size != expected.size ||
-            actual.zip(expected).any? { |actual_child, expected_child| expected_child.match?(actual_child, base_node, '!=') }
+            actual.zip(expected).any? { |actual_child, expected_child|
+              expected_child.match?(actual_child, base_node, '!=')
+            }
         else
           !is_equal?(actual, expected)
         end
@@ -66,7 +68,9 @@ module NodeQuery::Compiler
       else
         if expected.is_a?(::Array)
           actual.is_a?(::Array) && actual.size == expected.size &&
-            actual.zip(expected).all? { |actual_child, expected_child| expected_child.match?(actual_child, base_node, '==') }
+            actual.zip(expected).all? { |actual_child, expected_child|
+              expected_child.match?(actual_child, base_node, '==')
+            }
         else
           is_equal?(actual, expected)
         end
@@ -110,7 +114,7 @@ module NodeQuery::Compiler
     # Get the expected value
     # @param base_node [Node] the base node for evaluated value
     # @return expected value, could be integer, float, string, boolean, nil, range, and etc.
-    def expected_value(base_node)
+    def expected_value(_base_node)
       @value
     end
 

data/lib/node_query/compiler/selector.rb

@@ -12,7 +12,15 @@ module NodeQuery::Compiler
     # @param attribute_list [NodeQuery::Compiler::AttributeList] the attribute list
     # @param pseudo_class [String] the pseudo class, can be <code>has</code> or <code>not_has</code>
     # @param pseudo_selector [NodeQuery::Compiler::Expression] the pseudo selector
-    def initialize(goto_scope: nil, relationship: nil, rest: nil, basic_selector: nil, position: nil, pseudo_class: nil, pseudo_selector: nil)
+    def initialize(
+      goto_scope: nil,
+      relationship: nil,
+      rest: nil,
+      basic_selector: nil,
+      position: nil,
+      pseudo_class: nil,
+      pseudo_selector: nil
+    )
       @goto_scope = goto_scope
       @relationship = relationship
       @rest = rest
@@ -36,7 +44,10 @@ module NodeQuery::Compiler
           return false
         end
       end
-      NodeQuery.adapter.is_node?(node) && (!@basic_selector || (operator == "!=" ? !@basic_selector.match?(node, base_node) : @basic_selector.match?(node, base_node))) && match_pseudo_class?(node)
+      NodeQuery.adapter.is_node?(node) && (!@basic_selector || (operator == "!=" ? !@basic_selector.match?(
+        node,
+        base_node
+      ) : @basic_selector.match?(node, base_node))) && match_pseudo_class?(node)
     end
 
     # Query nodes by the selector.

data/lib/node_query/helper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class NodeQuery::Helper
-  class <<self
+  class << self
     # Get target node by the keys.
     # @param node [Node] ast node
     # @param keys [String|Array] keys of child node.
@@ -43,7 +43,7 @@ class NodeQuery::Helper
     # Evaluate node value.
     # @example
     #     source code of the node is @id = id
-    #     evaluated_node_value(node, "@{{right_value}}") # => @id
+    #     evaluated_node_value(node, "@{{value}}") # => @id
     # @param node [Node] ast node
     # @param str [String] string to be evaluated
     # @return [String] evaluated string
@@ -63,4 +63,4 @@ class NodeQuery::Helper
       node.to_s
     end
   end
-end
+end

data/lib/node_query/node_rules.rb

@@ -22,7 +22,7 @@ class NodeQuery::NodeRules
       return match_node?(node) ? [node] : []
     end
 
-    matching_nodes  = []
+    matching_nodes = []
     if options[:including_self] && match_node?(node)
       matching_nodes.push(node)
       return matching_nodes if options[:stop_at_first_match]
@@ -51,9 +51,10 @@ class NodeQuery::NodeRules
   def match_node?(node)
     flat_hash(@rules).keys.all? do |multi_keys|
       last_key = multi_keys.last
-      actual = KEYWORDS.include?(last_key) ?
-        NodeQuery::Helper.get_target_node(node, multi_keys[0...-1].join('.')) :
-        NodeQuery::Helper.get_target_node(node, multi_keys.join('.'))
+      actual =
+        KEYWORDS.include?(last_key) ?
+               NodeQuery::Helper.get_target_node(node, multi_keys[0...-1].join('.')) :
+               NodeQuery::Helper.get_target_node(node, multi_keys.join('.'))
       expected = expected_value(@rules, multi_keys)
       expected = NodeQuery::Helper.evaluate_node_value(node, expected) if expected.is_a?(String)
       case last_key
@@ -131,9 +132,9 @@ class NodeQuery::NodeRules
         actual == expected
       end
     when TrueClass
-      :true == actual.type
+      :true == actual&.type
     when FalseClass
-      :false == actual.type
+      :false == actual&.type
     when Parser::AST::Node
       actual == expected
     else

data/lib/node_query/version.rb

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

data/lib/node_query.rb

@@ -8,7 +8,8 @@ class NodeQuery
   class MethodNotSupported < StandardError; end
 
   autoload :Adapter, "node_query/adapter"
-  autoload :ParserAdapter, "node_query/parser_adapter"
+  autoload :ParserAdapter, "node_query/adapter/parser"
+  autoload :SyntaxTreeAdapter, "node_query/adapter/syntax_tree"
   autoload :Compiler, "node_query/compiler"
   autoload :Helper, "node_query/helper"
   autoload :NodeRules, "node_query/node_rules"

data/lib/node_query_parser.racc.rb

@@ -1,6 +1,6 @@
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.6.0
+# This file is automatically generated by Racc 1.6.2
 # from Racc grammar file "".
 #
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: node_query
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-16 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies: []
 description: ast node query language
 email:
@@ -26,6 +26,8 @@ files:
 - Rakefile
 - lib/node_query.rb
 - lib/node_query/adapter.rb
+- lib/node_query/adapter/parser.rb
+- lib/node_query/adapter/syntax_tree.rb
 - lib/node_query/compiler.rb
 - lib/node_query/compiler/array_value.rb
 - lib/node_query/compiler/attribute.rb
@@ -47,7 +49,6 @@ files:
 - lib/node_query/compiler/symbol.rb
 - lib/node_query/helper.rb
 - lib/node_query/node_rules.rb
-- lib/node_query/parser_adapter.rb
 - lib/node_query/version.rb
 - lib/node_query_lexer.rex
 - lib/node_query_lexer.rex.rb
@@ -77,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: ast node query language