syntax_tree 4.0.2 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 959bd2a452303ffb7565ee0ce9641cc1167609c7c2231fc12d476d35db44ae34
-  data.tar.gz: d1d15bf2076e7ee83caf30d1371d3d2e3c43415349e5e89e39efca68ccda0339
+  metadata.gz: 61bd75fb26dcf665293adb21c2cf21a5f0f26b56a2077d80ce5ff6806eaf434d
+  data.tar.gz: 545306a76376f972805159e8eed622e825011b7fa9ef6b93cb9649c6caf9eccf
 SHA512:
-  metadata.gz: 814586875ea83553dcf691b374056617b0491af9237c5fc4332da559cec7cf459593b515549cdf33c2a5b3bd45a79b01b8fa9c6bb027646799f3fb935b1b37b1
-  data.tar.gz: a7a70c1d9b77b7c9f3c460973760cabf7446fa794e1254da25536657e7094c9bbcdb6522f08a00a26fe317d982b31b48e9f99758e2a9dde093b5c7998cdf047a
+  metadata.gz: 633701480cbe5c34bfcff52c4dd6c48f10cb22cba377b295ac56f2c288ce6a5dfdde57df5e682a3226f3d49ca7c3dd8d02db5d2d6d37acfc54df5c304be8a16f
+  data.tar.gz: e4224136ab12c158c45bd6375308e01a4e7075c7da30536f82f77ebecd3d4c426c4798e80fb5eb6fef9a1771036d4ac7e5d709dc49c5b620cbe9a2c3f2dd15a0

data/.rubocop.yml

@@ -28,6 +28,9 @@ Lint/InterpolationCheck:
 Lint/MissingSuper:
   Enabled: false
 
+Lint/RedundantRequireStatement:
+  Enabled: false
+
 Lint/UnusedMethodArgument:
   AllowUnusedKeywordArguments: true
 

data/CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [4.1.0] - 2022-10-24
+
+### Added
+
+- [#180](https://github.com/ruby-syntax-tree/syntax_tree/pull/180) - The new `stree search` CLI command and the corresponding `SyntaxTree::Search` class for searching for a pattern against a given syntax tree.
+
 ## [4.0.2] - 2022-10-19
 
 ### Changed
@@ -397,7 +403,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 - 🎉 Initial release! 🎉
 
-[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v4.0.2...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v4.1.0...HEAD
+[4.1.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v4.0.2...v4.1.0
 [4.0.2]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v4.0.1...v4.0.2
 [4.0.1]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v4.0.0...v4.0.1
 [4.0.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.6.3...v4.0.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    syntax_tree (4.0.2)
+    syntax_tree (4.1.0)
       prettier_print (>= 1.0.2)
 
 GEM
@@ -19,17 +19,17 @@ GEM
     rake (13.0.6)
     regexp_parser (2.6.0)
     rexml (3.2.5)
-    rubocop (1.36.0)
+    rubocop (1.37.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.22.0)
+    rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)

data/README.md

@@ -18,6 +18,7 @@ It is built with only standard library dependencies. It additionally ships with
   - [format](#format)
   - [json](#json)
   - [match](#match)
+  - [search](#search)
   - [write](#write)
   - [Configuration](#configuration)
   - [Globbing](#globbing)
@@ -215,6 +216,29 @@ SyntaxTree::Program[
 ]
 ```
 
+### search
+
+This command will search the given filepaths against the specified pattern to find nodes that match. The pattern is a Ruby pattern-matching expression that is matched against each node in the tree. It can optionally be loaded from a file if you specify a filepath as the pattern argument.
+
+```sh
+stree search VarRef path/to/file.rb
+```
+
+For a file that contains `Foo + Bar` you will receive:
+
+```ruby
+path/to/file.rb:1:0: Foo + Bar
+path/to/file.rb:1:6: Foo + Bar
+```
+
+If you put `VarRef` into a file instead (for example, `query.txt`), you would instead run:
+
+```sh
+stree search query.txt path/to/file.rb
+```
+
+Note that the output of the `match` CLI command creates a valid pattern that can be used as the input for this command.
+
 ### write
 
 This command will format the listed files and write that formatted version back to the source files. Note that this overwrites the original content, to be sure to be using a version control system.

data/lib/syntax_tree/cli.rb

@@ -212,6 +212,39 @@ module SyntaxTree
       end
     end
 
+    # An action of the CLI that searches for the given pattern matching pattern
+    # in the given files.
+    class Search < Action
+      attr_reader :search
+
+      def initialize(query)
+        query = File.read(query) if File.readable?(query)
+        @search = SyntaxTree::Search.new(query)
+      rescue SyntaxTree::Search::UncompilableError => error
+        warn(error.message)
+        exit(1)
+      end
+
+      def run(item)
+        search.scan(item.handler.parse(item.source)) do |node|
+          location = node.location
+          line = location.start_line
+
+          bold_range =
+            if line == location.end_line
+              location.start_column...location.end_column
+            else
+              location.start_column..
+            end
+
+          source = item.source.lines[line - 1].chomp
+          source[bold_range] = Color.bold(source[bold_range]).to_s
+
+          puts("#{item.filepath}:#{line}:#{location.start_column}: #{source}")
+        end
+      end
+    end
+
     # An action of the CLI that formats the input source and writes the
     # formatted output back to the file.
     class Write < Action
@@ -263,6 +296,9 @@ module SyntaxTree
       #{Color.bold("stree lsp [--plugins=...] [--print-width=NUMBER]")}
         Run syntax tree in language server mode
 
+      #{Color.bold("stree search PATTERN [-e SCRIPT] FILE")}
+        Search for the given pattern in the given files
+
       #{Color.bold("stree version")}
         Output the current version of syntax tree
 
@@ -400,6 +436,8 @@ module SyntaxTree
             Debug.new(options)
           when "doc"
             Doc.new(options)
+          when "f", "format"
+            Format.new(options)
           when "help"
             puts HELP
             return 0
@@ -411,8 +449,8 @@ module SyntaxTree
             return 0
           when "m", "match"
             Match.new(options)
-          when "f", "format"
-            Format.new(options)
+          when "s", "search"
+            Search.new(arguments.shift)
           when "version"
             puts SyntaxTree::VERSION
             return 0
@@ -434,7 +472,7 @@ module SyntaxTree
               .glob(pattern)
               .each do |filepath|
                 if File.readable?(filepath) &&
-                    options.ignore_files.none? { File.fnmatch?(_1, filepath) }
+                     options.ignore_files.none? { File.fnmatch?(_1, filepath) }
                   queue << FileItem.new(filepath)
                 end
               end

data/lib/syntax_tree/node.rb

@@ -1657,12 +1657,12 @@ module SyntaxTree
     # for older Ruby versions.
     unless :+.respond_to?(:name)
       using Module.new {
-        refine Symbol do
-          def name
-            to_s.freeze
-          end
-        end
-      }
+              refine Symbol do
+                def name
+                  to_s.freeze
+                end
+              end
+            }
     end
 
     # [untyped] the left-hand side of the expression

data/lib/syntax_tree/search.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  # Provides an interface for searching for a pattern of nodes against a
+  # subtree of an AST.
+  class Search
+    class UncompilableError < StandardError
+    end
+
+    attr_reader :matcher
+
+    def initialize(query)
+      root = SyntaxTree.parse("case nil\nin #{query}\nend")
+      @matcher = compile(root.statements.body.first.consequent.pattern)
+    end
+
+    def scan(root)
+      return to_enum(__method__, root) unless block_given?
+      queue = [root]
+
+      until queue.empty?
+        node = queue.shift
+        next unless node
+
+        yield node if matcher.call(node)
+        queue += node.child_nodes
+      end
+    end
+
+    private
+
+    def compile(pattern)
+      case pattern
+      in Binary[left:, operator: :|, right:]
+        compiled_left = compile(left)
+        compiled_right = compile(right)
+
+        ->(node) { compiled_left.call(node) || compiled_right.call(node) }
+      in Const[value:] if SyntaxTree.const_defined?(value)
+        clazz = SyntaxTree.const_get(value)
+
+        ->(node) { node.is_a?(clazz) }
+      in Const[value:] if Object.const_defined?(value)
+        clazz = Object.const_get(value)
+
+        ->(node) { node.is_a?(clazz) }
+      in ConstPathRef[parent: VarRef[value: Const[value: "SyntaxTree"]]]
+        compile(pattern.constant)
+      in HshPtn[constant:, keywords:, keyword_rest: nil]
+        compiled_constant = compile(constant)
+
+        preprocessed_keywords =
+          keywords.to_h do |keyword, value|
+            raise NoMatchingPatternError unless keyword.is_a?(Label)
+            [keyword.value.chomp(":").to_sym, compile(value)]
+          end
+
+        compiled_keywords = ->(node) do
+          deconstructed = node.deconstruct_keys(preprocessed_keywords.keys)
+          preprocessed_keywords.all? do |keyword, matcher|
+            matcher.call(deconstructed[keyword])
+          end
+        end
+
+        ->(node) do
+          compiled_constant.call(node) && compiled_keywords.call(node)
+        end
+      in RegexpLiteral[parts: [TStringContent[value:]]]
+        regexp = /#{value}/
+
+        ->(attribute) { regexp.match?(attribute) }
+      in StringLiteral[parts: [TStringContent[value:]]]
+        ->(attribute) { attribute == value }
+      in VarRef[value: Const => value]
+        compile(value)
+      end
+    rescue NoMatchingPatternError
+      raise UncompilableError, <<~ERROR
+        Syntax Tree was unable to compile the pattern you provided to search
+        into a usable expression. It failed on the node within the pattern
+        matching expression represented by:
+
+        #{PP.pp(pattern, +"").chomp}
+
+        Note that not all syntax supported by Ruby's pattern matching syntax is
+        also supported by Syntax Tree's code search. If you're using some syntax
+        that you believe should be supported, please open an issue on the GitHub
+        repository at https://github.com/ruby-syntax-tree/syntax_tree.
+      ERROR
+    end
+  end
+end

data/lib/syntax_tree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SyntaxTree
-  VERSION = "4.0.2"
+  VERSION = "4.1.0"
 end

data/lib/syntax_tree.rb

@@ -21,6 +21,7 @@ require_relative "syntax_tree/visitor/environment"
 require_relative "syntax_tree/visitor/with_environment"
 
 require_relative "syntax_tree/parser"
+require_relative "syntax_tree/search"
 
 # Syntax Tree is a suite of tools built on top of the internal CRuby parser. It
 # provides the ability to generate a syntax tree from source, as well as the

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syntax_tree
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.1.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prettier_print
@@ -135,6 +135,7 @@ files:
 - lib/syntax_tree/rake/task.rb
 - lib/syntax_tree/rake/write_task.rb
 - lib/syntax_tree/rake_tasks.rb
+- lib/syntax_tree/search.rb
 - lib/syntax_tree/version.rb
 - lib/syntax_tree/visitor.rb
 - lib/syntax_tree/visitor/environment.rb