Merge pull request #191 from ruby-syntax-tree/ractors

Support formatting from a non-main Ractor

Author: kddnewton

CHANGELOG.md

@@ -26,6 +26,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
   - `Return0` is no longer a node. Instead if has been folded into the `Return` node. The `Return` node can now have its `arguments` field be `nil`. Consequently, the `visit_return0` method has been removed from the visitor interface. If you were previously using this method, you should now use `visit_return` instead.
 - The `ArgsForward`, `Redo`, `Retry`, and `ZSuper` nodes no longer have `value` fields associated with them (which were always string literals corresponding to the keyword being used).
 - The `Command` and `CommandCall` nodes now has `block` attributes on them. These attributes are used in the place where you would previously have had a `MethodAddBlock` structure. Where before the `MethodAddBlock` would have the command and block as its two children, you now just have one command node with the `block` attribute set to the `Block` node.
+- Previously the formatting options were defined on an unfrozen hash called `SyntaxTree::Formatter::OPTIONS`. It was globally mutable, which made it impossible to reference from within a Ractor. As such, it has now been replaced with `SyntaxTree::Formatter::Options.new` which creates a new options object instance that can be modified without impacting global state. As a part of this change, formatting can now be performed from within a non-main Ractor. In order to check if the `plugin/single_quotes` plugin has been loaded, check if `SyntaxTree::Formatter::SINGLE_QUOTES` is defined. In order to check if the `plugin/trailing_comma` plugin has been loaded, check if `SyntaxTree::Formatter::TRAILING_COMMA` is defined.
 
 ## [4.3.0] - 2022-10-28
 

Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     syntax_tree (4.3.0)
-      prettier_print (>= 1.0.2)
+      prettier_print (>= 1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -14,7 +14,7 @@ GEM
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
-    prettier_print (1.0.2)
+    prettier_print (1.1.0)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.6.0)

lib/syntax_tree.rb

@@ -54,8 +54,12 @@ def self.parse(source)
   end
 
   # Parses the given source and returns the formatted source.
-  def self.format(source, maxwidth = DEFAULT_PRINT_WIDTH)
-    formatter = Formatter.new(source, [], maxwidth)
+  def self.format(
+    source,
+    maxwidth = DEFAULT_PRINT_WIDTH,
+    options: Formatter::Options.new
+  )
+    formatter = Formatter.new(source, [], maxwidth, options: options)
     parse(source).format(formatter)
 
     formatter.flush

lib/syntax_tree/cli.rb

@@ -131,9 +131,14 @@ class UnformattedError < StandardError
 
       def run(item)
         source = item.source
-        if source != item.handler.format(source, options.print_width)
-          raise UnformattedError
-        end
+        formatted =
+          item.handler.format(
+            source,
+            options.print_width,
+            options: options.formatter_options
+          )
+
+        raise UnformattedError if source != formatted
       rescue StandardError
         warn("[#{Color.yellow("warn")}] #{item.filepath}")
         raise
@@ -156,13 +161,23 @@ class NonIdempotentFormatError < StandardError
 
       def run(item)
         handler = item.handler
-
         warning = "[#{Color.yellow("warn")}] #{item.filepath}"
-        formatted = handler.format(item.source, options.print_width)
 
-        if formatted != handler.format(formatted, options.print_width)
-          raise NonIdempotentFormatError
-        end
+        formatted =
+          handler.format(
+            item.source,
+            options.print_width,
+            options: options.formatter_options
+          )
+
+        double_formatted =
+          handler.format(
+            formatted,
+            options.print_width,
+            options: options.formatter_options
+          )
+
+        raise NonIdempotentFormatError if formatted != double_formatted
       rescue StandardError
         warn(warning)
         raise
@@ -182,7 +197,9 @@ class Doc < Action
       def run(item)
         source = item.source
 
-        formatter = Formatter.new(source, [])
+        formatter_options = options.formatter_options
+        formatter = Formatter.new(source, [], options: formatter_options)
+
         item.handler.parse(source).format(formatter)
         pp formatter.groups.first
       end
@@ -206,7 +223,14 @@ def run(item)
     # An action of the CLI that formats the input source and prints it out.
     class Format < Action
       def run(item)
-        puts item.handler.format(item.source, options.print_width)
+        formatted =
+          item.handler.format(
+            item.source,
+            options.print_width,
+            options: options.formatter_options
+          )
+
+        puts formatted
       end
     end
 
@@ -273,7 +297,13 @@ def run(item)
         start = Time.now
 
         source = item.source
-        formatted = item.handler.format(source, options.print_width)
+        formatted =
+          item.handler.format(
+            source,
+            options.print_width,
+            options: options.formatter_options
+          )
+
         File.write(filepath, formatted) if item.writable?
 
         color = source == formatted ? Color.gray(filepath) : filepath
@@ -347,20 +377,16 @@ class Options
                   :plugins,
                   :print_width,
                   :scripts,
-                  :target_ruby_version
+                  :formatter_options
 
-      def initialize(print_width: DEFAULT_PRINT_WIDTH)
+      def initialize
         @ignore_files = []
         @plugins = []
-        @print_width = print_width
+        @print_width = DEFAULT_PRINT_WIDTH
         @scripts = []
-        @target_ruby_version = nil
+        @formatter_options = Formatter::Options.new
       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
@@ -404,8 +430,10 @@ def parser
           # 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
+            @formatter_options =
+              Formatter::Options.new(
+                target_ruby_version: Formatter::SemanticVersion.new(version)
+              )
           end
         end
       end

lib/syntax_tree/formatter.rb

@@ -4,21 +4,63 @@ module SyntaxTree
   # A slightly enhanced PP that knows how to format recursively including
   # comments.
   class Formatter < PrettierPrint
+    # Unfortunately, Gem::Version.new is not ractor-safe because it performs
+    # global caching using a class variable. This works around that by just
+    # setting the instance variables directly.
+    class SemanticVersion < ::Gem::Version
+      def initialize(version)
+        @version = version
+        @segments = nil
+      end
+    end
+
     # We want to minimize as much as possible the number of options that are
     # available in syntax tree. For the most part, if users want non-default
     # formatting, they should override the format methods on the specific nodes
     # themselves. However, because of some history with prettier and the fact
     # that folks have become entrenched in their ways, we decided to provide a
     # small amount of configurability.
-    #
-    # 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,
-      target_ruby_version: Gem::Version.new(RUBY_VERSION)
-    }
+    class Options
+      attr_reader :quote, :trailing_comma, :target_ruby_version
+
+      def initialize(
+        quote: :default,
+        trailing_comma: :default,
+        target_ruby_version: :default
+      )
+        @quote =
+          if quote == :default
+            # We ship with a single quotes plugin that will define this
+            # constant. That constant is responsible for determining the default
+            # quote style. If it's defined, we default to single quotes,
+            # otherwise we default to double quotes.
+            defined?(SINGLE_QUOTES) ? "'" : "\""
+          else
+            quote
+          end
+
+        @trailing_comma =
+          if trailing_comma == :default
+            # We ship with a trailing comma plugin that will define this
+            # constant. That constant is responsible for determining the default
+            # trailing comma value. If it's defined, then we default to true.
+            # Otherwise we default to false.
+            defined?(TRAILING_COMMA)
+          else
+            trailing_comma
+          end
+
+        @target_ruby_version =
+          if target_ruby_version == :default
+            # The default target Ruby version is the current version of Ruby.
+            # This is really only used for very niche cases, and it shouldn't be
+            # used by most users.
+            SemanticVersion.new(RUBY_VERSION)
+          else
+            target_ruby_version
+          end
+      end
+    end
 
     COMMENT_PRIORITY = 1
     HEREDOC_PRIORITY = 2
@@ -30,22 +72,16 @@ class Formatter < PrettierPrint
     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],
-      target_ruby_version: OPTIONS[:target_ruby_version]
-    )
+    def initialize(source, *args, options: Options.new)
       super(*args)
 
       @source = source
       @stack = []
 
-      # Memoizing these values per formatter to make access faster.
-      @quote = quote
-      @trailing_comma = trailing_comma
-      @target_ruby_version = target_ruby_version
+      # Memoizing these values to make access faster.
+      @quote = options.quote
+      @trailing_comma = options.trailing_comma
+      @target_ruby_version = options.target_ruby_version
     end
 
     def self.format(source, node)

lib/syntax_tree/node.rb

@@ -1026,7 +1026,7 @@ def call(q)
       end
     end
 
-    BREAKABLE_SPACE_SEPARATOR = BreakableSpaceSeparator.new
+    BREAKABLE_SPACE_SEPARATOR = BreakableSpaceSeparator.new.freeze
 
     # Formats an array of multiple simple string literals into the %w syntax.
     class QWordsFormatter
@@ -1759,7 +1759,7 @@ def ===(other)
   module HashKeyFormatter
     # Formats the keys of a hash literal using labels.
     class Labels
-      LABEL = /\A[A-Za-z_](\w*[\w!?])?\z/
+      LABEL = /\A[A-Za-z_](\w*[\w!?])?\z/.freeze
 
       def format_key(q, key)
         case key
@@ -2176,7 +2176,7 @@ def call(q)
 
     # We'll keep a single instance of this separator around for all block vars
     # to cut down on allocations.
-    SEPARATOR = Separator.new
+    SEPARATOR = Separator.new.freeze
 
     def format(q)
       q.text("|")
@@ -5723,7 +5723,8 @@ def deconstruct_keys(_keys)
 
     # This is a very specific behavior where you want to force a newline, but
     # don't want to force the break parent.
-    SEPARATOR = PrettierPrint::Breakable.new(" ", 1, indent: false, force: true)
+    SEPARATOR =
+      PrettierPrint::Breakable.new(" ", 1, indent: false, force: true).freeze
 
     def format(q)
       q.group do
@@ -6025,7 +6026,7 @@ def format(q)
           format_contents(q, parts, nested)
         end
 
-        if q.target_ruby_version < Gem::Version.new("2.7.3")
+        if q.target_ruby_version < Formatter::SemanticVersion.new("2.7.3")
           q.text(" }")
         else
           q.breakable_space
@@ -11703,7 +11704,7 @@ def call(q)
 
     # We're going to keep a single instance of this separator around so we don't
     # have to allocate a new one every time we format a when clause.
-    SEPARATOR = Separator.new
+    SEPARATOR = Separator.new.freeze
 
     def format(q)
       keyword = "when "

lib/syntax_tree/plugin/single_quotes.rb

@@ -1,3 +1,7 @@
 # frozen_string_literal: true
 
-SyntaxTree::Formatter::OPTIONS[:quote] = "'"
+module SyntaxTree
+  class Formatter
+    SINGLE_QUOTES = true
+  end
+end

lib/syntax_tree/plugin/trailing_comma.rb

@@ -1,3 +1,7 @@
 # frozen_string_literal: true
 
-SyntaxTree::Formatter::OPTIONS[:trailing_comma] = true
+module SyntaxTree
+  class Formatter
+    TRAILING_COMMA = true
+  end
+end

syntax_tree.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
-  spec.add_dependency "prettier_print", ">= 1.0.2"
+  spec.add_dependency "prettier_print", ">= 1.1.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest"

test/cli_test.rb

@@ -62,14 +62,8 @@ def test_check_print_width
     end
 
     def test_check_target_ruby_version
-      previous = Formatter::OPTIONS[:target_ruby_version]
-
-      begin
-        result = run_cli("check", "--target-ruby-version=2.6.0")
-        assert_includes(result.stdio, "match")
-      ensure
-        Formatter::OPTIONS[:target_ruby_version] = previous
-      end
+      result = run_cli("check", "--target-ruby-version=2.6.0")
+      assert_includes(result.stdio, "match")
     end
 
     def test_debug

test/plugin/single_quotes_test.rb

@@ -4,8 +4,6 @@
 
 module SyntaxTree
   class SingleQuotesTest < Minitest::Test
-    OPTIONS = Plugin.options("syntax_tree/plugin/single_quotes")
-
     def test_empty_string_literal
       assert_format("''\n", "\"\"")
     end
@@ -36,7 +34,8 @@ def test_label
     private
 
     def assert_format(expected, source = expected)
-      formatter = Formatter.new(source, [], **OPTIONS)
+      options = Formatter::Options.new(quote: "'")
+      formatter = Formatter.new(source, [], options: options)
       SyntaxTree.parse(source).format(formatter)
 
       formatter.flush