syntax_tree 5.1.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0adfab4347f7d3abda07479e427b2df975e98fb9dafa731cb8b2188da42ab18b
-  data.tar.gz: 4d730d2eaadfa61585e683f6ad444b40336787a561ac7f08c630d5aef857d3d7
+  metadata.gz: 3261679bf963ba7263bb3ae21e826ed1fa7a28c6afbf2a2b65b42101be16b7ac
+  data.tar.gz: 653c6c79a34db7686ceeadf83f0d8adb47093d1ab1d946636008ee4c31144258
 SHA512:
-  metadata.gz: 890fdc12c1d6d0643231a908bb0f1a503d365fc56d1349f36dc99497eff6a30e51309ecce2cb19e10159e3dd1a1f811a8fd8c3904c94943992ff069811f85ced
-  data.tar.gz: f1e546cd8397b62f4c518103b18c712fead74c82e23ecb527909727a91f7556cddc9886c730be8a968e957b64addb79c9665869e6fcb57b1d26b1b7f13f5bfa5
+  metadata.gz: 9cefe2a22c594efc74aa0fbe300c986a414c890efb7204633481345ceb9b0bd3578d836046ca64e289621ce31ea343f0da40db1f9b3d2d7dbd7f0a11b020c725
+  data.tar.gz: 628ed098064cb9e6dc720666d59b5e9d8653f7e06cb7e0774887dfeb4ed4a5bdb217ea644b93f52a3730e2dfdc14334c0690018d145728a89fa99cbd041e4301

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.6
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
       - name: Enable auto-merge for Dependabot PRs

data/.github/workflows/gh-pages.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
       - name: Setup Pages
-        uses: actions/configure-pages@v2
+        uses: actions/configure-pages@v3
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

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,9 @@
+[submodule "mspec"]
+	path = spec/mspec
+	url = git@github.com:ruby/mspec.git
+[submodule "spec"]
+	path = spec/ruby
+	url = git@github.com:ruby/spec.git
+[submodule "test/ruby-syntax-fixtures"]
+	path = test/ruby-syntax-fixtures
+	url = https://github.com/ruby-syntax-tree/ruby-syntax-fixtures

data/.rubocop.yml

@@ -7,9 +7,13 @@ 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/ruby-syntax-fixtures/**/*
   - test.rb
 
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
 Layout/LineLength:
   Max: 80
 
@@ -43,6 +47,9 @@ Lint/NonLocalExitFromIterator:
 Lint/RedundantRequireStatement:
   Enabled: false
 
+Lint/RescueException:
+  Enabled: false
+
 Lint/SuppressedException:
   Enabled: false
 
@@ -144,3 +151,6 @@ Style/SpecialGlobalVars:
 
 Style/StructInheritance:
   Enabled: false
+
+Style/YodaExpression:
+  Enabled: false

data/CHANGELOG.md

@@ -6,6 +6,32 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [5.3.0] - 2023-01-26
+
+### Added
+
+- `#arity` has been added to `DefNode`, `BlockNode`, and `Params`. The method returns a range where the lower bound is the minimum and the upper bound is the maximum number of arguments that can be used to invoke that block/method definition.
+- `#arity` has been added to `CallNode`, `Command`, `CommandCall`, and `VCall` nodes. The method returns the number of arguments included in the invocation. For splats, double splats, or argument forwards, this method returns `Float::INFINITY`.
+- `SyntaxTree::index` and `SyntaxTree::index_file` APIs have been added to collect a list of classes, modules, and methods defined in a given source string or file, respectively. These APIs are experimental and subject to change.
+- A `plugin/disable_auto_ternary` plugin has been added the disables the formatted that automatically changes permissable `if/else` clauses into ternaries.
+
+### Changed
+
+- Files are now only written from the CLI if the content of them changes, which should match watching files less chaotic.
+- In the case that `rb_iseq_load` cannot be found, `Fiddle::DLError` is now rescued.
+- Previously if there were invalid UTF-8 byte sequences after the `__END__` keyword the parser could potentially have crashed when parsing comments. This has been fixed.
+- Previously there was special formatting for array literals that contained only variable references (either locals, method calls, or constants). For consistency, this has been removed and all array literals are now formatted the same way.
+
+## [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
@@ -471,7 +497,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.1.0...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v5.3.0...HEAD
+[5.3.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v5.2.0...v5.3.0
+[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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    syntax_tree (5.1.0)
+    syntax_tree (5.3.0)
       prettier_print (>= 1.2.0)
 
 GEM
@@ -10,26 +10,26 @@ GEM
     ast (2.4.2)
     docile (1.4.0)
     json (2.6.3)
-    minitest (5.16.3)
+    minitest (5.17.0)
     parallel (1.22.1)
-    parser (3.1.3.0)
+    parser (3.2.0.0)
       ast (~> 2.4.1)
     prettier_print (1.2.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.1)
+    regexp_parser (2.6.2)
     rexml (3.2.5)
-    rubocop (1.41.1)
+    rubocop (1.44.1)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       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.24.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     simplecov (0.22.0)
@@ -38,7 +38,7 @@ GEM
       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.2)
 
 PLATFORMS
   arm64-darwin-21

data/README.md

@@ -658,6 +658,7 @@ To register plugins, define a file somewhere in your load path named `syntax_tre
 
 * `plugin/single_quotes` - This will change all of your string literals to use single quotes instead of the default double quotes.
 * `plugin/trailing_comma` - This will put trailing commas into multiline array literals, hash literals, and method calls that can support trailing commas.
+* `plugin/disable_auto_ternary` - This will prevent the automatic conversion of `if ... else` to ternary expressions.
 
 If you're using Syntax Tree as a library, you can require those files directly or manually pass those options to the formatter initializer through the `SyntaxTree::Formatter::Options` class.
 

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)

data/lib/syntax_tree/cli.rb

@@ -303,10 +303,11 @@ module SyntaxTree
             options.print_width,
             options: options.formatter_options
           )
+        changed = source != formatted
 
-        File.write(filepath, formatted) if item.writable?
+        File.write(filepath, formatted) if item.writable? && changed
 
-        color = source == formatted ? Color.gray(filepath) : filepath
+        color = changed ? filepath : Color.gray(filepath)
         delta = ((Time.now - start) * 1000).round
 
         puts "#{color} #{delta}ms"

data/lib/syntax_tree/formatter.rb

@@ -21,11 +21,15 @@ module SyntaxTree
     # that folks have become entrenched in their ways, we decided to provide a
     # small amount of configurability.
     class Options
-      attr_reader :quote, :trailing_comma, :target_ruby_version
+      attr_reader :quote,
+                  :trailing_comma,
+                  :disable_auto_ternary,
+                  :target_ruby_version
 
       def initialize(
         quote: :default,
         trailing_comma: :default,
+        disable_auto_ternary: :default,
         target_ruby_version: :default
       )
         @quote =
@@ -50,6 +54,17 @@ module SyntaxTree
             trailing_comma
           end
 
+        @disable_auto_ternary =
+          if disable_auto_ternary == :default
+            # We ship with a disable ternary plugin that will define this
+            # constant. That constant is responsible for determining the default
+            # disable ternary value. If it's defined, then we default to true.
+            # Otherwise we default to false.
+            defined?(DISABLE_TERNARY)
+          else
+            disable_auto_ternary
+          end
+
         @target_ruby_version =
           if target_ruby_version == :default
             # The default target Ruby version is the current version of Ruby.
@@ -69,8 +84,13 @@ module SyntaxTree
 
     # These options are overridden in plugins to we need to make sure they are
     # available here.
-    attr_reader :quote, :trailing_comma, :target_ruby_version
+    attr_reader :quote,
+                :trailing_comma,
+                :disable_auto_ternary,
+                :target_ruby_version
+
     alias trailing_comma? trailing_comma
+    alias disable_auto_ternary? disable_auto_ternary
 
     def initialize(source, *args, options: Options.new)
       super(*args)
@@ -81,6 +101,7 @@ module SyntaxTree
       # Memoizing these values to make access faster.
       @quote = options.quote
       @trailing_comma = options.trailing_comma
+      @disable_auto_ternary = options.disable_auto_ternary
       @target_ruby_version = options.target_ruby_version
     end