syntax_tree 2.4.1 → 2.7.0

data/lib/syntax_tree/rake/write_task.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "rake"
+require "rake/tasklib"
+
+require "syntax_tree"
+require "syntax_tree/cli"
+
+module SyntaxTree
+  module Rake
+    # A Rake task that runs format on a set of source files.
+    #
+    # Example:
+    #
+    #   require 'syntax_tree/rake/write_task'
+    #
+    #   SyntaxTree::Rake::WriteTask.new do |t|
+    #     t.source_files = '{app,config,lib}/**/*.rb'
+    #   end
+    #
+    # This will create task that can be run with:
+    #
+    #   rake stree_write
+    #
+    class WriteTask < ::Rake::TaskLib
+      # Name of the task.
+      # Defaults to :"stree:write".
+      attr_accessor :name
+
+      # Glob pattern to match source files.
+      # Defaults to 'lib/**/*.rb'.
+      attr_accessor :source_files
+
+      # The set of plugins to require.
+      # Defaults to [].
+      attr_accessor :plugins
+
+      def initialize(
+        name = :"stree:write",
+        source_files = ::Rake::FileList["lib/**/*.rb"],
+        plugins = []
+      )
+        @name = name
+        @source_files = source_files
+        @plugins = plugins
+
+        yield self if block_given?
+        define_task
+      end
+
+      private
+
+      def define_task
+        desc "Runs `stree write` over source files"
+        task(name) { run_task }
+      end
+
+      def run_task
+        arguments = ["write"]
+        arguments << "--plugins=#{plugins.join(",")}" if plugins.any?
+
+        SyntaxTree::CLI.run(arguments + Array(source_files))
+      end
+    end
+  end
+end

data/lib/syntax_tree/rake_tasks.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "rake/check_task"
+require_relative "rake/write_task"

data/lib/syntax_tree/version.rb

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

data/lib/syntax_tree/visitor/field_visitor.rb

@@ -49,9 +49,7 @@ module SyntaxTree
     # of circumstances, like when visiting the list of optional parameters
     # defined on a method.
     #
-    class FieldVisitor < Visitor
-      attr_reader :q
-
+    class FieldVisitor < BasicVisitor
       def visit_aref(node)
         node(node, "aref") do
           field("collection", node.collection)
@@ -586,6 +584,14 @@ module SyntaxTree
         end
       end
 
+      def visit_lambda_var(node)
+        node(node, "lambda_var") do
+          field("params", node.params)
+          list("locals", node.locals) if node.locals.any?
+          comments(node)
+        end
+      end
+
       def visit_lbrace(node)
         visit_token(node, "lbrace")
       end

data/lib/syntax_tree/visitor/match_visitor.rb

@@ -22,7 +22,7 @@ module SyntaxTree
           # entire value into the output buffer.
           q.text(node.inspect)
         else
-          q.pp(node)
+          node.pretty_print(q)
         end
       end
 
@@ -114,7 +114,7 @@ module SyntaxTree
         q.nest(0) do
           q.text(name)
           q.text(": ")
-          q.pp(value)
+          value.pretty_print(q)
         end
       end
     end

data/lib/syntax_tree/visitor.rb

@@ -4,72 +4,7 @@ module SyntaxTree
   # Visitor is a parent class that provides the ability to walk down the tree
   # and handle a subset of nodes. By defining your own subclass, you can
   # explicitly handle a node type by defining a visit_* method.
-  class Visitor
-    # This is raised when you use the Visitor.visit_method method and it fails.
-    # It is correctable to through DidYouMean.
-    class VisitMethodError < StandardError
-      attr_reader :visit_method
-
-      def initialize(visit_method)
-        @visit_method = visit_method
-        super("Invalid visit method: #{visit_method}")
-      end
-    end
-
-    # This class is used by DidYouMean to offer corrections to invalid visit
-    # method names.
-    class VisitMethodChecker
-      attr_reader :visit_method
-
-      def initialize(error)
-        @visit_method = error.visit_method
-      end
-
-      def corrections
-        @corrections ||=
-          DidYouMean::SpellChecker.new(
-            dictionary: Visitor.visit_methods
-          ).correct(visit_method)
-      end
-
-      DidYouMean.correct_error(VisitMethodError, self)
-    end
-
-    class << self
-      # This method is here to help folks write visitors.
-      #
-      # It's not always easy to ensure you're writing the correct method name in
-      # the visitor since it's perfectly valid to define methods that don't
-      # override these parent methods.
-      #
-      # If you use this method, you can ensure you're writing the correct method
-      # name. It will raise an error if the visit method you're defining isn't
-      # actually a method on the parent visitor.
-      def visit_method(method_name)
-        return if visit_methods.include?(method_name)
-
-        raise VisitMethodError, method_name
-      end
-
-      # This is the list of all of the valid visit methods.
-      def visit_methods
-        @visit_methods ||=
-          Visitor.instance_methods.grep(/^visit_(?!child_nodes)/)
-      end
-    end
-
-    def visit(node)
-      node&.accept(self)
-    end
-
-    def visit_all(nodes)
-      nodes.map { |node| visit(node) }
-    end
-
-    def visit_child_nodes(node)
-      visit_all(node.child_nodes)
-    end
-
+  class Visitor < BasicVisitor
     # Visit an ARef node.
     alias visit_aref visit_child_nodes
 
@@ -301,6 +236,9 @@ module SyntaxTree
     # Visit a Lambda node.
     alias visit_lambda visit_child_nodes
 
+    # Visit a LambdaVar node.
+    alias visit_lambda_var visit_child_nodes
+
     # Visit a LBrace node.
     alias visit_lbrace visit_child_nodes
 

data/lib/syntax_tree.rb

@@ -2,7 +2,7 @@
 
 require "json"
 require "pp"
-require "prettyprint"
+require "prettier_print"
 require "ripper"
 require "stringio"
 
@@ -10,36 +10,14 @@ require_relative "syntax_tree/formatter"
 require_relative "syntax_tree/node"
 require_relative "syntax_tree/parser"
 require_relative "syntax_tree/version"
+
+require_relative "syntax_tree/basic_visitor"
 require_relative "syntax_tree/visitor"
 require_relative "syntax_tree/visitor/field_visitor"
 require_relative "syntax_tree/visitor/json_visitor"
 require_relative "syntax_tree/visitor/match_visitor"
 require_relative "syntax_tree/visitor/pretty_print_visitor"
 
-# If PrettyPrint::Align isn't defined, then we haven't gotten the updated
-# version of prettyprint. In that case we'll define our own. This is going to
-# overwrite a bunch of methods, so silencing them as well.
-unless PrettyPrint.const_defined?(:Align)
-  verbose = $VERBOSE
-  $VERBOSE = nil
-
-  begin
-    require_relative "syntax_tree/prettyprint"
-  ensure
-    $VERBOSE = verbose
-  end
-end
-
-# When PP is running, it expects that everything that interacts with it is going
-# to flow through PP.pp, since that's the main entry into the module from the
-# perspective of its uses in core Ruby. In doing so, it calls guard_inspect_key
-# at the top of the PP.pp method, which establishes some thread-local hashes to
-# check for cycles in the pretty printed tree. This means that if you want to
-# manually call pp on some object _before_ you have established these hashes,
-# you're going to break everything. So this call ensures that those hashes have
-# been set up before anything uses pp manually.
-PP.new(+"", 0).guard_inspect_key {}
-
 # 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
 # tools necessary to inspect and manipulate that syntax tree. It can be used to
@@ -64,8 +42,8 @@ module SyntaxTree
   end
 
   # Parses the given source and returns the formatted source.
-  def self.format(source)
-    formatter = Formatter.new(source, [])
+  def self.format(source, maxwidth = 80)
+    formatter = Formatter.new(source, [], maxwidth)
     parse(source).format(formatter)
 
     formatter.flush

data/syntax_tree.gemspec

@@ -25,8 +25,11 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
+  spec.add_dependency "prettier_print"
+
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
   spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: syntax_tree
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.7.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-10 00:00:00.000000000 Z
+date: 2022-05-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: prettier_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -93,15 +121,20 @@ files:
 - doc/logo.svg
 - exe/stree
 - lib/syntax_tree.rb
+- lib/syntax_tree/basic_visitor.rb
 - lib/syntax_tree/cli.rb
 - lib/syntax_tree/formatter.rb
 - lib/syntax_tree/formatter/single_quotes.rb
+- lib/syntax_tree/formatter/trailing_comma.rb
 - lib/syntax_tree/language_server.rb
 - lib/syntax_tree/language_server/inlay_hints.rb
 - lib/syntax_tree/node.rb
 - lib/syntax_tree/parser.rb
 - lib/syntax_tree/plugin/single_quotes.rb
-- lib/syntax_tree/prettyprint.rb
+- lib/syntax_tree/plugin/trailing_comma.rb
+- lib/syntax_tree/rake/check_task.rb
+- lib/syntax_tree/rake/write_task.rb
+- lib/syntax_tree/rake_tasks.rb
 - lib/syntax_tree/version.rb
 - lib/syntax_tree/visitor.rb
 - lib/syntax_tree/visitor/field_visitor.rb