Merge pull request #148 from ruby-syntax-tree/2-7

Support Ruby 2.7.0

Author: kddnewton

.github/workflows/main.yml

@@ -8,7 +8,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-        - '2.7'
+        - '2.7.0'
         - '3.0'
         - '3.1'
         - head

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)

lib/syntax_tree/cli.rb

@@ -53,10 +53,13 @@ def source
       end
     end
 
-    # An item of work that corresponds to a script content passed via the command line.
+    # 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
@@ -68,10 +71,6 @@ def handler
       def filepath
         FILEPATH
       end
-
-      def source
-        @source
-      end
     end
 
     # The parent action class for the CLI that implements the basics.
@@ -197,7 +196,7 @@ def run(item)
 
         source = item.source
         formatted = item.handler.format(source, options.print_width)
-        File.write(filepath, formatted) if FileItem === item
+        File.write(filepath, formatted) if item.filepath != :script
 
         color = source == formatted ? Color.gray(filepath) : filepath
         delta = ((Time.now - start) * 1000).round
@@ -259,13 +258,19 @@ def run(item)
     # responsible for parsing the list and then returning the file paths at the
     # end.
     class Options
-      attr_reader :print_width, :scripts
+      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)
       end
@@ -285,7 +290,8 @@ def parser
           #     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
@@ -296,8 +302,13 @@ def parser
 
           # 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") do |script|
-            @scripts << script
+          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
@@ -395,9 +406,7 @@ def run(argv)
                 queue << FileItem.new(filepath) if File.file?(filepath)
               end
           end
-          options.scripts.each do |script|
-            queue << ScriptItem.new(script)
-          end
+          options.scripts.each { |script| queue << ScriptItem.new(script) }
         else
           queue << ScriptItem.new($stdin.read)
         end

lib/syntax_tree/formatter.rb

@@ -14,7 +14,11 @@ class Formatter < PrettierPrint
     # 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 @@ class Formatter < PrettierPrint
 
     # 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,6 +45,7 @@ def initialize(
       # 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)

lib/syntax_tree/node.rb

@@ -2132,8 +2132,7 @@ def format(q)
         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 @@ def format(q)
           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 @@ def call(q, node)
             false
           in {
                statements: { body: [truthy] },
-               consequent: Else[statements: { body: [falsy] }]
-             }
+               consequent: Else[statements: { body: [falsy] }] }
             ternaryable?(truthy) && ternaryable?(falsy)
           else
             false

lib/syntax_tree/rake/check_task.rb

@@ -39,16 +39,22 @@ class CheckTask < ::Rake::TaskLib
       # 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 @@ def define_task
       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

lib/syntax_tree/rake/write_task.rb

@@ -39,16 +39,22 @@ class WriteTask < ::Rake::TaskLib
       # 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 @@ def define_task
       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

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) }

test/cli_test.rb

@@ -134,12 +134,12 @@ def test_no_arguments_no_tty
     end
 
     def test_inline_script
-      stdio, = capture_io { SyntaxTree::CLI.run(["format", "-e", "1+1"]) }
+      stdio, = capture_io { SyntaxTree::CLI.run(%w[format -e 1+1]) }
       assert_equal("1 + 1\n", stdio)
     end
 
     def test_multiple_inline_scripts
-      stdio, = capture_io { SyntaxTree::CLI.run(["format", "-e", "1+1", "-e", "2+2"]) }
+      stdio, = capture_io { SyntaxTree::CLI.run(%w[format -e 1+1 -e 2+2]) }
       assert_equal("1 + 1\n2 + 2\n", stdio)
     end
 

test/fixtures/args_forward.rb

@@ -1,4 +1,4 @@
-%
+% # >= 2.7.3
 def foo(...)
   bar(:baz, ...)
 end