syntax_tree 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52707e3169fedfce017259222e4740b2e1032d210dfb628d454134eef578a7b6
-  data.tar.gz: aed3d5b3e6de7ed1e156c5b104007db6a01dab65e0ee80913afa2c1b5c63a5c0
+  metadata.gz: f4410889ecf31d320edb7e45b5491c97ec1af42f782e486cf946cad4672ee5cd
+  data.tar.gz: c81d09784f746b0b115af55409196a640d17d972a91e7d116a45b9b69bcb7c14
 SHA512:
-  metadata.gz: b81b4753a5e765712bd31081dedca6e50c67d04a7935a717fc56d278424154e6ed95b648ac1cbdd59b500ee44c2d8d89f57f52e3851f9615e378d8c9c2c6abe1
-  data.tar.gz: 32c95446f19190b8e73d9c3ce83ff4bd5573f5787f844cf695551a2d32c0c159af8c514714c4648a99be4e66189910bde7f01557ea973f6e17aaba66ace7fce2
+  metadata.gz: 1c6badd15f529d426d771679f3e8ebbd690a705f66027caa6510bf01c2788b3968fd1c3523bfa3534d3dd048604b968c8c01059e5a2c6d2148130aebd77d8530
+  data.tar.gz: e4567e0f5259ceb1b840f4c10c50fac526e972932e22340a5456fc1f394872c04b5f5651b63859bff40fc4e40da19e9040db6c51a70b6beb27559fcbe1597987

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

@@ -0,0 +1,22 @@
+name: Dependabot auto-merge
+on: pull_request
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1.3.3
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

data/.github/workflows/main.yml

@@ -1,14 +1,14 @@
 name: Main
 on:
 - push
-- pull_request_target
+- pull_request
 jobs:
   ci:
     strategy:
       fail-fast: false
       matrix:
         ruby:
-        - '2.7'
+        - '2.7.0'
         - '3.0'
         - '3.1'
         - head
@@ -40,20 +40,3 @@ jobs:
       run: |
         bundle exec rake stree:check
         bundle exec rubocop
-
-  automerge:
-    name: AutoMerge
-    needs:
-    - ci
-    - check
-    runs-on: ubuntu-latest
-    if: github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]'
-    steps:
-    - uses: actions/github-script@v3
-      with:
-        script: |
-          github.pulls.merge({
-            owner: context.payload.repository.owner.login,
-            repo: context.payload.repository.name,
-            pull_number: context.payload.pull_request.number
-          })

data/CHANGELOG.md

@@ -6,6 +6,18 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [3.5.0] - 2022-08-26
+
+### Added
+
+- [#148](https://github.com/ruby-syntax-tree/syntax_tree/pull/148) - Support Ruby 2.7.0 (previously we only supported back to 2.7.3).
+- [#152](https://github.com/ruby-syntax-tree/syntax_tree/pull/152) - Support the `-e` inline script option for the `stree` CLI.
+
+### Changed
+
+- [#141](https://github.com/ruby-syntax-tree/syntax_tree/pull/141) - Use `q.format` for `SyntaxTree.format` so that the main node gets pushed onto the stack for checking parent nodes.
+- [#147](https://github.com/ruby-syntax-tree/syntax_tree/pull/147) - Fix rightward assignment token management such that `in` and `=>` stay the same regardless of their context.
+
 ## [3.4.0] - 2022-08-19
 
 ### Added
@@ -332,7 +344,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/v3.4.0...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.5.0...HEAD
+[3.5.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.4.0...v3.5.0
 [3.4.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.3.0...v3.4.0
 [3.3.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.2.1...v3.3.0
 [3.2.1]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.2.0...v3.2.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    syntax_tree (3.4.0)
+    syntax_tree (3.5.0)
       prettier_print
 
 GEM
@@ -10,7 +10,7 @@ GEM
     ast (2.4.2)
     docile (1.4.0)
     json (2.6.2)
-    minitest (5.16.2)
+    minitest (5.16.3)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
@@ -19,7 +19,7 @@ GEM
     rake (13.0.6)
     regexp_parser (2.5.0)
     rexml (3.2.5)
-    rubocop (1.35.0)
+    rubocop (1.35.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)

data/Rakefile

@@ -12,8 +12,17 @@ end
 
 task default: :test
 
-SOURCE_FILES =
-  FileList[%w[Gemfile Rakefile syntax_tree.gemspec lib/**/*.rb test/*.rb]]
+configure = ->(task) do
+  task.source_files =
+    FileList[%w[Gemfile Rakefile syntax_tree.gemspec lib/**/*.rb test/*.rb]]
 
-SyntaxTree::Rake::CheckTask.new { |t| t.source_files = SOURCE_FILES }
-SyntaxTree::Rake::WriteTask.new { |t| t.source_files = SOURCE_FILES }
+  # Since Syntax Tree supports back to Ruby 2.7.0, we need to make sure that we
+  # format our code such that it's compatible with that version. This actually
+  # has very little effect on the output, the only change at the moment is that
+  # Ruby < 2.7.3 didn't allow a newline before the closing brace of a hash
+  # pattern.
+  task.target_ruby_version = Gem::Version.new("2.7.0")
+end
+
+SyntaxTree::Rake::CheckTask.new(&configure)
+SyntaxTree::Rake::WriteTask.new(&configure)

data/lib/syntax_tree/cli.rb

@@ -53,18 +53,23 @@ module SyntaxTree
       end
     end
 
-    # An item of work that corresponds to the stdin content.
-    class STDINItem
+    # An item of work that corresponds to a script content passed via the
+    # command line.
+    class ScriptItem
+      FILEPATH = :script
+
+      attr_reader :source
+
+      def initialize(source)
+        @source = source
+      end
+
       def handler
         HANDLERS[".rb"]
       end
 
       def filepath
-        :stdin
-      end
-
-      def source
-        $stdin.read
+        FILEPATH
       end
     end
 
@@ -191,7 +196,7 @@ module SyntaxTree
 
         source = item.source
         formatted = item.handler.format(source, options.print_width)
-        File.write(filepath, formatted) if filepath != :stdin
+        File.write(filepath, formatted) if item.filepath != :script
 
         color = source == formatted ? Color.gray(filepath) : filepath
         delta = ((Time.now - start) * 1000).round
@@ -206,25 +211,25 @@ module SyntaxTree
     # The help message displayed if the input arguments are not correctly
     # ordered or formatted.
     HELP = <<~HELP
-      #{Color.bold("stree ast [--plugins=...] [--print-width=NUMBER] FILE")}
+      #{Color.bold("stree ast [--plugins=...] [--print-width=NUMBER] [-e SCRIPT] FILE")}
         Print out the AST corresponding to the given files
 
-      #{Color.bold("stree check [--plugins=...] [--print-width=NUMBER] FILE")}
+      #{Color.bold("stree check [--plugins=...] [--print-width=NUMBER] [-e SCRIPT] FILE")}
         Check that the given files are formatted as syntax tree would format them
 
-      #{Color.bold("stree debug [--plugins=...] [--print-width=NUMBER] FILE")}
+      #{Color.bold("stree debug [--plugins=...] [--print-width=NUMBER] [-e SCRIPT] FILE")}
         Check that the given files can be formatted idempotently
 
-      #{Color.bold("stree doc [--plugins=...] FILE")}
+      #{Color.bold("stree doc [--plugins=...] [-e SCRIPT] FILE")}
         Print out the doc tree that would be used to format the given files
 
-      #{Color.bold("stree format [--plugins=...] [--print-width=NUMBER] FILE")}
+      #{Color.bold("stree format [--plugins=...] [--print-width=NUMBER] [-e SCRIPT] FILE")}
         Print out the formatted version of the given files
 
-      #{Color.bold("stree json [--plugins=...] FILE")}
+      #{Color.bold("stree json [--plugins=...] [-e SCRIPT] FILE")}
         Print out the JSON representation of the given files
 
-      #{Color.bold("stree match [--plugins=...] FILE")}
+      #{Color.bold("stree match [--plugins=...] [-e SCRIPT] FILE")}
         Print out a pattern-matching Ruby expression that would match the given files
 
       #{Color.bold("stree help")}
@@ -236,7 +241,7 @@ module SyntaxTree
       #{Color.bold("stree version")}
         Output the current version of syntax tree
 
-      #{Color.bold("stree write [--plugins=...] [--print-width=NUMBER] FILE")}
+      #{Color.bold("stree write [--plugins=...] [--print-width=NUMBER] [-e SCRIPT] FILE")}
         Read, format, and write back the source of the given files
 
       --plugins=...
@@ -244,20 +249,30 @@ module SyntaxTree
 
       --print-width=NUMBER
         The maximum line width to use when formatting.
+
+      -e SCRIPT
+        Parse an inline Ruby string.
     HELP
 
     # This represents all of the options that can be passed to the CLI. It is
     # responsible for parsing the list and then returning the file paths at the
     # end.
     class Options
-      attr_reader :print_width
+      attr_reader :plugins, :print_width, :scripts, :target_ruby_version
 
       def initialize(print_width: DEFAULT_PRINT_WIDTH)
+        @plugins = []
         @print_width = print_width
+        @scripts = []
+        @target_ruby_version = nil
       end
 
+      # TODO: This function causes a couple of side-effects that I really don't
+      # like to have here. It mutates the global state by requiring the plugins,
+      # and mutates the global options hash by adding the target ruby version.
+      # That should be done on a config-by-config basis, not here.
       def parse(arguments)
-        parser.parse(arguments)
+        parser.parse!(arguments)
       end
 
       private
@@ -275,7 +290,8 @@ module SyntaxTree
           #     require "syntax_tree/haml"
           #
           opts.on("--plugins=PLUGINS") do |plugins|
-            plugins.split(",").each { |plugin| require "syntax_tree/#{plugin}" }
+            @plugins = plugins.split(",")
+            @plugins.each { |plugin| require "syntax_tree/#{plugin}" }
           end
 
           # If there is a print width specified on the command line, then
@@ -283,6 +299,17 @@ module SyntaxTree
           opts.on("--print-width=NUMBER", Integer) do |print_width|
             @print_width = print_width
           end
+
+          # If there is a script specified on the command line, then parse
+          # it and add it to the list of scripts to run.
+          opts.on("-e SCRIPT") { |script| @scripts << script }
+
+          # If there is a target ruby version specified on the command line,
+          # parse that out and use it when formatting.
+          opts.on("--target-ruby-version=VERSION") do |version|
+            @target_ruby_version = Gem::Version.new(version)
+            Formatter::OPTIONS[:target_ruby_version] = @target_ruby_version
+          end
         end
       end
     end
@@ -361,7 +388,7 @@ module SyntaxTree
 
         # If we're not reading from stdin and the user didn't supply and
         # filepaths to be read, then we exit with the usage message.
-        if $stdin.tty? && arguments.empty?
+        if $stdin.tty? && arguments.empty? && options.scripts.empty?
           warn(HELP)
           return 1
         end
@@ -371,7 +398,7 @@ module SyntaxTree
 
         # If we're reading from stdin, then we'll just add the stdin object to
         # the queue. Otherwise, we'll add each of the filepaths to the queue.
-        if $stdin.tty? || arguments.any?
+        if $stdin.tty? && (arguments.any? || options.scripts.any?)
           arguments.each do |pattern|
             Dir
               .glob(pattern)
@@ -379,8 +406,9 @@ module SyntaxTree
                 queue << FileItem.new(filepath) if File.file?(filepath)
               end
           end
+          options.scripts.each { |script| queue << ScriptItem.new(script) }
         else
-          queue << STDINItem.new
+          queue << ScriptItem.new($stdin.read)
         end
 
         # At the end, we're going to return whether or not this worker ever

data/lib/syntax_tree/formatter.rb

@@ -14,7 +14,11 @@ module SyntaxTree
     # Note that we're keeping this in a global-ish hash instead of just
     # overriding methods on classes so that other plugins can reference this if
     # necessary. For example, the RBS plugin references the quote style.
-    OPTIONS = { quote: "\"", trailing_comma: false }
+    OPTIONS = {
+      quote: "\"",
+      trailing_comma: false,
+      target_ruby_version: Gem::Version.new(RUBY_VERSION)
+    }
 
     COMMENT_PRIORITY = 1
     HEREDOC_PRIORITY = 2
@@ -23,14 +27,15 @@ module SyntaxTree
 
     # These options are overridden in plugins to we need to make sure they are
     # available here.
-    attr_reader :quote, :trailing_comma
+    attr_reader :quote, :trailing_comma, :target_ruby_version
     alias trailing_comma? trailing_comma
 
     def initialize(
       source,
       *args,
       quote: OPTIONS[:quote],
-      trailing_comma: OPTIONS[:trailing_comma]
+      trailing_comma: OPTIONS[:trailing_comma],
+      target_ruby_version: OPTIONS[:target_ruby_version]
     )
       super(*args)
 
@@ -40,13 +45,14 @@ module SyntaxTree
       # Memoizing these values per formatter to make access faster.
       @quote = quote
       @trailing_comma = trailing_comma
+      @target_ruby_version = target_ruby_version
     end
 
     def self.format(source, node)
-      formatter = new(source, [])
-      node.format(formatter)
-      formatter.flush
-      formatter.output.join
+      q = new(source, [])
+      q.format(node)
+      q.flush
+      q.output.join
     end
 
     def format(node, stackable: true)

data/lib/syntax_tree/node.rb

@@ -2132,8 +2132,7 @@ module SyntaxTree
         in [
              Paren[
                contents: {
-                 body: [ArrayLiteral[contents: { parts: [_, _, *] }] => array]
-               }
+                 body: [ArrayLiteral[contents: { parts: [_, _, *] }] => array] }
              ]
            ]
           # Here we have a single argument that is a set of parentheses wrapping
@@ -5116,8 +5115,13 @@ module SyntaxTree
           q.breakable
           contents.call
         end
-        q.breakable
-        q.text("}")
+
+        if q.target_ruby_version < Gem::Version.new("2.7.3")
+          q.text(" }")
+        else
+          q.breakable
+          q.text("}")
+        end
       end
     end
   end
@@ -5204,8 +5208,7 @@ module SyntaxTree
             false
           in {
                statements: { body: [truthy] },
-               consequent: Else[statements: { body: [falsy] }]
-             }
+               consequent: Else[statements: { body: [falsy] }] }
             ternaryable?(truthy) && ternaryable?(falsy)
           else
             false

data/lib/syntax_tree/parser.rb

@@ -910,7 +910,12 @@ module SyntaxTree
           location: keyword.location.to(consequent.location)
         )
       else
-        operator = find_token(Kw, "in", consume: false) || find_token(Op, "=>")
+        operator =
+          if (keyword = find_token(Kw, "in", consume: false))
+            tokens.delete(keyword)
+          else
+            find_token(Op, "=>")
+          end
 
         RAssign.new(
           value: value,

data/lib/syntax_tree/rake/check_task.rb

@@ -39,16 +39,22 @@ module SyntaxTree
       # Defaults to 80.
       attr_accessor :print_width
 
+      # The target Ruby version to use for formatting.
+      # Defaults to Gem::Version.new(RUBY_VERSION).
+      attr_accessor :target_ruby_version
+
       def initialize(
         name = :"stree:check",
         source_files = ::Rake::FileList["lib/**/*.rb"],
         plugins = [],
-        print_width = DEFAULT_PRINT_WIDTH
+        print_width = DEFAULT_PRINT_WIDTH,
+        target_ruby_version = Gem::Version.new(RUBY_VERSION)
       )
         @name = name
         @source_files = source_files
         @plugins = plugins
         @print_width = print_width
+        @target_ruby_version = target_ruby_version
 
         yield self if block_given?
         define_task
@@ -64,10 +70,15 @@ module SyntaxTree
       def run_task
         arguments = ["check"]
         arguments << "--plugins=#{plugins.join(",")}" if plugins.any?
+
         if print_width != DEFAULT_PRINT_WIDTH
           arguments << "--print-width=#{print_width}"
         end
 
+        if target_ruby_version != Gem::Version.new(RUBY_VERSION)
+          arguments << "--target-ruby-version=#{target_ruby_version}"
+        end
+
         SyntaxTree::CLI.run(arguments + Array(source_files))
       end
     end

data/lib/syntax_tree/rake/write_task.rb

@@ -39,16 +39,22 @@ module SyntaxTree
       # Defaults to 80.
       attr_accessor :print_width
 
+      # The target Ruby version to use for formatting.
+      # Defaults to Gem::Version.new(RUBY_VERSION).
+      attr_accessor :target_ruby_version
+
       def initialize(
         name = :"stree:write",
         source_files = ::Rake::FileList["lib/**/*.rb"],
         plugins = [],
-        print_width = DEFAULT_PRINT_WIDTH
+        print_width = DEFAULT_PRINT_WIDTH,
+        target_ruby_version = Gem::Version.new(RUBY_VERSION)
       )
         @name = name
         @source_files = source_files
         @plugins = plugins
         @print_width = print_width
+        @target_ruby_version = target_ruby_version
 
         yield self if block_given?
         define_task
@@ -64,10 +70,15 @@ module SyntaxTree
       def run_task
         arguments = ["write"]
         arguments << "--plugins=#{plugins.join(",")}" if plugins.any?
+
         if print_width != DEFAULT_PRINT_WIDTH
           arguments << "--print-width=#{print_width}"
         end
 
+        if target_ruby_version != Gem::Version.new(RUBY_VERSION)
+          arguments << "--target-ruby-version=#{target_ruby_version}"
+        end
+
         SyntaxTree::CLI.run(arguments + Array(source_files))
       end
     end

data/lib/syntax_tree/version.rb

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

data/syntax_tree.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
         .reject { |f| f.match(%r{^(test|spec|features)/}) }
     end
 
-  spec.required_ruby_version = ">= 2.7.3"
+  spec.required_ruby_version = ">= 2.7.0"
 
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syntax_tree
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-19 00:00:00.000000000 Z
+date: 2022-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prettier_print
@@ -103,6 +103,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/auto-merge.yml"
 - ".github/workflows/gh-pages.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
@@ -153,7 +154,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.3
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="