syntax_tree 2.3.1 → 2.4.0

data/lib/syntax_tree/visitor.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 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.
@@ -24,7 +27,9 @@ module SyntaxTree
 
       def corrections
         @corrections ||=
-          DidYouMean::SpellChecker.new(dictionary: Visitor.visit_methods).correct(visit_method)
+          DidYouMean::SpellChecker.new(
+            dictionary: Visitor.visit_methods
+          ).correct(visit_method)
       end
 
       DidYouMean.correct_error(VisitMethodError, self)

data/lib/syntax_tree.rb

@@ -11,7 +11,9 @@ require_relative "syntax_tree/node"
 require_relative "syntax_tree/parser"
 require_relative "syntax_tree/version"
 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
@@ -28,6 +30,20 @@ unless PrettyPrint.const_defined?(:Align)
   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
+# build formatters, linters, language servers, and more.
 module SyntaxTree
   # This holds references to objects that respond to both #parse and #format
   # so that we can use them in the CLI.
@@ -61,8 +77,10 @@ module SyntaxTree
   def self.read(filepath)
     encoding =
       File.open(filepath, "r") do |file|
+        break Encoding.default_external if file.eof?
+
         header = file.readline
-        header += file.readline if header.start_with?("#!")
+        header += file.readline if !file.eof? && header.start_with?("#!")
         Ripper.new(header).tap(&:parse).encoding
       end
 

data/syntax_tree.gemspec

@@ -1,30 +1,32 @@
 # frozen_string_literal: true
 
-require_relative 'lib/syntax_tree/version'
+require_relative "lib/syntax_tree/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'syntax_tree'
-  spec.version       = SyntaxTree::VERSION
-  spec.authors       = ['Kevin Newton']
-  spec.email         = ['kddnewton@gmail.com']
+  spec.name = "syntax_tree"
+  spec.version = SyntaxTree::VERSION
+  spec.authors = ["Kevin Newton"]
+  spec.email = ["kddnewton@gmail.com"]
 
-  spec.summary       = 'A parser based on ripper'
-  spec.homepage      = 'https://github.com/kddnewton/syntax_tree'
-  spec.license       = 'MIT'
-  spec.metadata      = { 'rubygems_mfa_required' => 'true' }
+  spec.summary = "A parser based on ripper"
+  spec.homepage = "https://github.com/kddnewton/syntax_tree"
+  spec.license = "MIT"
+  spec.metadata = { "rubygems_mfa_required" => "true" }
 
-  spec.files         = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      f.match(%r{^(test|spec|features)/})
+  spec.files =
+    Dir.chdir(__dir__) do
+      `git ls-files -z`.split("\x0")
+        .reject { |f| f.match(%r{^(test|spec|features)/}) }
     end
-  end
 
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.required_ruby_version = ">= 2.7.3"
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syntax_tree
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-22 00:00:00.000000000 Z
+date: 2022-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,6 +78,7 @@ files:
 - ".github/workflows/gh-pages.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -88,6 +89,7 @@ files:
 - bin/bench
 - bin/console
 - bin/profile
+- config/rubocop.yml
 - doc/logo.svg
 - exe/stree
 - lib/syntax_tree.rb
@@ -100,7 +102,9 @@ files:
 - lib/syntax_tree/prettyprint.rb
 - lib/syntax_tree/version.rb
 - lib/syntax_tree/visitor.rb
+- lib/syntax_tree/visitor/field_visitor.rb
 - lib/syntax_tree/visitor/json_visitor.rb
+- lib/syntax_tree/visitor/match_visitor.rb
 - lib/syntax_tree/visitor/pretty_print_visitor.rb
 - syntax_tree.gemspec
 homepage: https://github.com/kddnewton/syntax_tree
@@ -116,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="