syntax_tree 5.0.1 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b2322461fc3abb52a77604f2b6791c82941983bb490a8281eceb336336ae2f1
-  data.tar.gz: 395163315be211645af6b4ed60852342d247b428cda0d29a546f700a3d311387
+  metadata.gz: 1c5651bab4283bf0f1c451619e5c3b54c9b229d1fb5050a3732918bccb7be177
+  data.tar.gz: 2cda5e4b62a3beac16dddc8ff9298624c161bc99c3b82ba2ecc10d8d643aac4b
 SHA512:
-  metadata.gz: 7d6754a8cc53af931bc1c14a18ed85a86e0c15412e127ad9a0c94592694c8ffdb359cf51e89ba87b84c9c3c5da64a2cee4ebf5638cbb2d2c672f47bc69a4d376
-  data.tar.gz: 90d86586324ca16f482f29f77dc8091a297b237970abdbb95745455ef6619cce854682be8f4ea98e5a6b6006379379fe5cc5e3e15ce96d1883da983b085fce22
+  metadata.gz: 81d331f10356569b23ada917cea2ecf5a2dd1073bc927e39ba0b6036ea4b79813ce7b1e4826f39d919559cdbb5925da8a5680d72653d64d0eb05979729356173
+  data.tar.gz: 53b320f073ef5e15efcd2e7d706e959e3ade48f18ab0f131a588a183276aeea3352cf6da0ef2ad842dc0c9bf517ac4c441ee4fbe98fa73dd156e845d5d4007d7

data/.github/dependabot.yml

@@ -4,3 +4,7 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/auto-merge.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
       - name: Dependabot metadata
         id: metadata
-        uses: dependabot/fetch-metadata@v1.3.3
+        uses: dependabot/fetch-metadata@v1.3.5
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
       - name: Enable auto-merge for Dependabot PRs

data/.github/workflows/main.yml

@@ -1,7 +1,9 @@
 name: Main
+
 on:
 - push
 - pull_request
+
 jobs:
   ci:
     strategy:
@@ -11,13 +13,14 @@ jobs:
         - '2.7.0'
         - '3.0'
         - '3.1'
+        - '3.2'
         - head
         - truffleruby-head
     name: CI
     runs-on: ubuntu-latest
     env:
       CI: true
-      TESTOPTS: --verbose
+      # TESTOPTS: --verbose
     steps:
     - uses: actions/checkout@master
     - uses: ruby/setup-ruby@v1
@@ -37,7 +40,7 @@ jobs:
     - uses: ruby/setup-ruby@v1
       with:
         bundler-cache: true
-        ruby-version: '3.1'
+        ruby-version: '3.2'
     - name: Check
       run: |
         bundle exec rake stree:check

data/.gitmodules

@@ -0,0 +1,6 @@
+[submodule "mspec"]
+	path = spec/mspec
+	url = git@github.com:ruby/mspec.git
+[submodule "spec"]
+	path = spec/ruby
+	url = git@github.com:ruby/spec.git

data/.rubocop.yml

@@ -7,7 +7,7 @@ AllCops:
   SuggestExtensions: false
   TargetRubyVersion: 2.7
   Exclude:
-  - '{.git,.github,bin,coverage,pkg,test/fixtures,vendor,tmp}/**/*'
+  - '{.git,.github,bin,coverage,pkg,spec,test/fixtures,vendor,tmp}/**/*'
   - test.rb
 
 Layout/LineLength:
@@ -16,6 +16,15 @@ Layout/LineLength:
 Lint/AmbiguousBlockAssociation:
   Enabled: false
 
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+
+Lint/AmbiguousRange:
+  Enabled: false
+
+Lint/BooleanSymbol:
+  Enabled: false
+
 Lint/DuplicateBranch:
   Enabled: false
 
@@ -28,9 +37,21 @@ Lint/InterpolationCheck:
 Lint/MissingSuper:
   Enabled: false
 
+Lint/NonLocalExitFromIterator:
+  Enabled: false
+
 Lint/RedundantRequireStatement:
   Enabled: false
 
+Lint/RescueException:
+  Enabled: false
+
+Lint/SuppressedException:
+  Enabled: false
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
 Lint/UnusedMethodArgument:
   AllowUnusedKeywordArguments: true
 
@@ -46,15 +67,42 @@ Naming/MethodParameterName:
 Naming/RescuedExceptionsVariableName:
   PreferredName: error
 
+Naming/VariableNumber:
+  Enabled: false
+
+Security/Eval:
+  Enabled: false
+
+Style/AccessorGrouping:
+  Enabled: false
+
 Style/CaseEquality:
   Enabled: false
 
+Style/CaseLikeIf:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EndBlock:
+  Enabled: false
+
 Style/ExplicitBlockArgument:
   Enabled: false
 
 Style/FormatString:
   Enabled: false
 
+Style/FormatStringToken:
+  Enabled: false
+
 Style/GuardClause:
   Enabled: false
 
@@ -79,6 +127,9 @@ Style/MutableConstant:
 Style/NegatedIfElseCondition:
   Enabled: false
 
+Style/Next:
+  Enabled: false
+
 Style/NumericPredicate:
   Enabled: false
 
@@ -88,8 +139,14 @@ Style/ParallelAssignment:
 Style/PerlBackrefs:
   Enabled: false
 
+Style/SafeNavigation:
+  Enabled: false
+
 Style/SpecialGlobalVars:
   Enabled: false
 
 Style/StructInheritance:
   Enabled: false
+
+Style/YodaExpression:
+  Enabled: false

data/CHANGELOG.md

@@ -6,6 +6,31 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [5.2.0] - 2023-01-04
+
+### Added
+
+- An experiment in evaluating compiled instruction sequences has been added to Syntax Tree. This is subject to change, so it will not be well documented or testing at the moment. It does not impact other functionality.
+
+### Changed
+
+- Empty parentheses on method calls will now be left in place. Previously they were left in place if the method being called looked like a constant. Now they are left in place for all method calls since the method name can mirror the name of a local variable, in which case the parentheses are required.
+
+## [5.1.0] - 2022-12-28
+
+### Added
+
+- An experiment in working with instruction sequences has been added to Syntax Tree. This is subject to change, so it is not well documented or tested at the moment. It does not impact other functionality.
+- You can now format at a different base layer of indentation. This is an optional third argument to `SyntaxTree::format`.
+
+### Changed
+
+- Support forwarding anonymous keyword arguments with `**`.
+- The `BodyStmt` node now has a more correct location information.
+- Ignore the `textDocument/documentColor` request coming into the language server to support clients that require that request be received.
+- Do not attempt to convert `if..else` into ternaries if the predicate has a `Binary` node.
+- Properly handle nested pattern matching when a rightward assignment is inside a `when` clause.
+
 ## [5.0.1] - 2022-11-10
 
 ### Changed
@@ -456,7 +481,9 @@ 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/v5.0.1...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v5.2.0...HEAD
+[5.2.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v5.1.0...v5.2.0
+[5.1.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v5.0.1...v5.1.0
 [5.0.1]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v5.0.0...v5.0.1
 [5.0.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v4.3.0...v5.0.0
 [4.3.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v4.2.0...v4.3.0

data/Gemfile.lock

@@ -1,44 +1,44 @@
 PATH
   remote: .
   specs:
-    syntax_tree (5.0.1)
-      prettier_print (>= 1.1.0)
+    syntax_tree (5.2.0)
+      prettier_print (>= 1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     docile (1.4.0)
-    json (2.6.2)
-    minitest (5.16.3)
+    json (2.6.3)
+    minitest (5.17.0)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.2.0.0)
       ast (~> 2.4.1)
-    prettier_print (1.1.0)
+    prettier_print (1.2.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.0)
+    regexp_parser (2.6.1)
     rexml (3.2.5)
-    rubocop (1.38.0)
+    rubocop (1.42.0)
       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.23.0, < 2.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.23.0)
+    rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.3.0)
+    unicode-display_width (2.4.1)
 
 PLATFORMS
   arm64-darwin-21

data/README.md

@@ -324,11 +324,11 @@ stree write "**/{[!schema]*,*}.rb"
 
 ## Library
 
-Syntax Tree can be used as a library to access the syntax tree underlying Ruby source code.
+Syntax Tree can be used as a library to access the syntax tree underlying Ruby source code. The API is described below. For the full library documentation, see the [RDoc documentation](https://ruby-syntax-tree.github.io/syntax_tree/).
 
 ### SyntaxTree.read(filepath)
 
-This function takes a filepath and returns a string associated with the content of that file. It is similar in functionality to `File.read`, except htat it takes into account Ruby-level file encoding (through magic comments at the top of the file).
+This function takes a filepath and returns a string associated with the content of that file. It is similar in functionality to `File.read`, except that it takes into account Ruby-level file encoding (through magic comments at the top of the file).
 
 ### SyntaxTree.parse(source)
 
@@ -570,7 +570,7 @@ SyntaxTree::Formatter.format(source, program.accept(visitor))
 ### WithEnvironment
 
 The `WithEnvironment` module can be included in visitors to automatically keep track of local variables and arguments
-defined inside each environment. A `current_environment` accessor is made availble to the request, allowing it to find
+defined inside each environment. A `current_environment` accessor is made available to the request, allowing it to find
 all usages and definitions of a local.
 
 ```ruby
@@ -611,7 +611,7 @@ The language server also responds to the relatively new inlay hints request. Thi
 1 + 2 * 3
 ```
 
-Implicity, the `2 * 3` is going to be executed first because the `*` operator has higher precedence than the `+` operator. To ease mental overhead, our language server includes small parentheses to make this explicit, as in:
+Implicitly, the `2 * 3` is going to be executed first because the `*` operator has higher precedence than the `+` operator. To ease mental overhead, our language server includes small parentheses to make this explicit, as in:
 
 ```ruby
 1 + ₍2 * 3₎
@@ -686,7 +686,7 @@ Below are listed all of the "official" language plugins hosted under the same Gi
 
 ## Integration
 
-Syntax Tree's goal is to seemlessly integrate into your workflow. To this end, it provides a couple of additional tools beyond the CLI and the Ruby library.
+Syntax Tree's goal is to seamlessly integrate into your workflow. To this end, it provides a couple of additional tools beyond the CLI and the Ruby library.
 
 ### Rake
 

data/Rakefile

@@ -26,3 +26,10 @@ end
 
 SyntaxTree::Rake::CheckTask.new(&configure)
 SyntaxTree::Rake::WriteTask.new(&configure)
+
+desc "Run mspec tests using YARV emulation"
+task :spec do
+  Dir["./spec/ruby/language/**/*_spec.rb"].each do |filepath|
+    sh "exe/yarv ./spec/mspec/bin/mspec-tag #{filepath}"
+  end
+end

data/exe/yarv

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$:.unshift(File.expand_path("../lib", __dir__))
+
+require "syntax_tree"
+
+# Require these here so that we can run binding.irb without having them require
+# anything that we've already patched.
+require "irb"
+require "irb/completion"
+require "irb/color_printer"
+require "readline"
+
+# First, create an instance of our virtual machine.
+events =
+  if ENV["DEBUG"]
+    SyntaxTree::YARV::VM::STDOUTEvents.new
+  else
+    SyntaxTree::YARV::VM::NullEvents.new
+  end
+
+vm = SyntaxTree::YARV::VM.new(events)
+
+# Next, set up a bunch of aliases for methods that we're going to hook into in
+# order to set up our virtual machine.
+class << Kernel
+  alias yarv_require require
+  alias yarv_require_relative require_relative
+  alias yarv_load load
+  alias yarv_eval eval
+  alias yarv_throw throw
+  alias yarv_catch catch
+end
+
+# Next, patch the methods that we just aliased so that they use our virtual
+# machine's versions instead. This allows us to load Ruby files and have them
+# execute in our virtual machine instead of the runtime environment.
+[Kernel, Kernel.singleton_class].each do |klass|
+  klass.define_method(:require) { |filepath| vm.require(filepath) }
+
+  klass.define_method(:load) { |filepath| vm.load(filepath) }
+
+  # klass.define_method(:require_relative) do |filepath|
+  #   vm.require_relative(filepath)
+  # end
+
+  # klass.define_method(:eval) do |
+  #   source,
+  #   binding = TOPLEVEL_BINDING,
+  #   filename = "(eval)",
+  #   lineno = 1
+  # |
+  #   vm.eval(source, binding, filename, lineno)
+  # end
+
+  # klass.define_method(:throw) { |tag, value = nil| vm.throw(tag, value) }
+
+  # klass.define_method(:catch) { |tag, &block| vm.catch(tag, &block) }
+end
+
+# Finally, require the file that we want to execute.
+vm.require_resolved(ARGV.shift)