syntax_tree 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e69df6c9df69726ed7040c1b47584e8f17d9f3cc45a7a72de308aa9db39b4b66
-  data.tar.gz: 9dddf054616a7ca765dc7ebb7bbe98dbdaee8114a34043dd66390d9a6d576ea2
+  metadata.gz: 3b1505fca44f379d951132dafb8122a2591fe46607c8402d096bab67bd53d0a3
+  data.tar.gz: 0d58e60b6779ec1acd22ca776f3610f290c4b048cc1bf41b425f9c5a74e80db8
 SHA512:
-  metadata.gz: cf759fc42716b42988156d84333ebe66baa87ad881b85e062e0942d285c8be25f074a894b329c6a69758c68655667c1972291f68339141592f4e01ce089a9a6c
-  data.tar.gz: e5b5e3a6645fa340959458be14670784cba49f0d6436a518429ef8926581dea2169b03400f14916c8c9bbb66388d1116b8cdedac811e371a1ea37368bd5f3b42
+  metadata.gz: 42d4dea2571b21b3cf877a129f0a840f30125eb918c558b25b5bc303c915bb758b731151cdf2cfb6e70e92cbc4957d915095d1284312529675fec71f3a6af3a7
+  data.tar.gz: 5178b395ddcfdcf795c18f7c986e86a12f6ca2bdec871792de2c21220dffc7c2a2238a02926cece3021635f42859ab5084ba4dba21932ce7f1791c2a17a5bc49

data/CHANGELOG.md

@@ -6,6 +6,17 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [2.5.0] - 2022-05-13
+
+### Added
+
+- [#79](https://github.com/ruby-syntax-tree/syntax_tree/pull/79) - Support an optional `maxwidth` second argument to `SyntaxTree.format`.
+
+### Changed
+
+- [#77](https://github.com/ruby-syntax-tree/syntax_tree/pull/77) - Correct the pattern for checking if a dynamic symbol can be converted into a label as a hash key.
+- [#72](https://github.com/ruby-syntax-tree/syntax_tree/pull/72) - Disallow conditionals with `not` without parentheses in the predicate from turning into a ternary.
+
 ## [2.4.1] - 2022-05-10
 
 - [#73](https://github.com/ruby-syntax-tree/syntax_tree/pull/73) - Fix nested hash patterns from accidentally adding a `then` to their output.
@@ -213,7 +224,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/v2.4.1...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.5.0...HEAD
+[2.5.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.4.1...v2.5.0
 [2.4.1]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.4.0...v2.4.1
 [2.4.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.3.1...v2.4.0
 [2.3.1]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.3.0...v2.3.1

data/Gemfile

@@ -3,5 +3,3 @@
 source "https://rubygems.org"
 
 gemspec
-
-gem "rubocop"

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    syntax_tree (2.4.1)
+    syntax_tree (2.5.0)
+      prettier_print
 
 GEM
   remote: https://rubygems.org/
@@ -12,11 +13,12 @@ GEM
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
+    prettier_print (0.1.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.3.1)
+    regexp_parser (2.4.0)
     rexml (3.2.5)
-    rubocop (1.29.0)
+    rubocop (1.29.1)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)

data/lib/syntax_tree/formatter.rb

@@ -3,7 +3,7 @@
 module SyntaxTree
   # A slightly enhanced PP that knows how to format recursively including
   # comments.
-  class Formatter < PP
+  class Formatter < PrettierPrint
     COMMENT_PRIORITY = 1
     HEREDOC_PRIORITY = 2
 

data/lib/syntax_tree/node.rb

@@ -123,7 +123,7 @@ module SyntaxTree
     end
 
     def construct_keys
-      PP.format(+"") { |q| Visitor::MatchVisitor.new(q).visit(self) }
+      PrettierPrint.format(+"") { |q| Visitor::MatchVisitor.new(q).visit(self) }
     end
   end
 
@@ -1388,7 +1388,7 @@ module SyntaxTree
   module HashKeyFormatter
     # Formats the keys of a hash literal using labels.
     class Labels
-      LABEL = /^[@$_A-Za-z]([_A-Za-z0-9]*)?([!_=?A-Za-z0-9])?$/
+      LABEL = /\A[A-Za-z_](\w*[\w!?])?\z/
 
       def format_key(q, key)
         case key
@@ -1666,52 +1666,6 @@ module SyntaxTree
     end
   end
 
-  # This module will remove any breakables from the list of contents so that no
-  # newlines are present in the output.
-  module RemoveBreaks
-    class << self
-      def call(doc)
-        marker = Object.new
-        stack = [doc]
-
-        while stack.any?
-          doc = stack.pop
-
-          if doc == marker
-            stack.pop
-            next
-          end
-
-          stack += [doc, marker]
-
-          case doc
-          when PrettyPrint::Align, PrettyPrint::Indent, PrettyPrint::Group
-            doc.contents.map! { |child| remove_breaks(child) }
-            stack += doc.contents.reverse
-          when PrettyPrint::IfBreak
-            doc.flat_contents.map! { |child| remove_breaks(child) }
-            stack += doc.flat_contents.reverse
-          end
-        end
-      end
-
-      private
-
-      def remove_breaks(doc)
-        case doc
-        when PrettyPrint::Breakable
-          text = PrettyPrint::Text.new
-          text.add(object: doc.force? ? "; " : doc.separator, width: doc.width)
-          text
-        when PrettyPrint::IfBreak
-          PrettyPrint::Align.new(indent: 0, contents: doc.flat_contents)
-        else
-          doc
-        end
-      end
-    end
-  end
-
   # BlockVar represents the parameters being declared for a block. Effectively
   # this node is everything contained within the pipes. This includes all of the
   # various parameter types, as well as block-local variable declarations.
@@ -1752,8 +1706,7 @@ module SyntaxTree
 
     def format(q)
       q.group(0, "|", "|") do
-        doc = q.format(params)
-        RemoveBreaks.call(doc)
+        q.remove_breaks(q.format(params))
 
         if locals.any?
           q.text("; ")
@@ -3096,31 +3049,6 @@ module SyntaxTree
 
     private
 
-    # This is a somewhat naive method that is attempting to sum up the width of
-    # the doc nodes that make up the given doc node. This is used to align
-    # content.
-    def doc_width(parent)
-      queue = [parent]
-      width = 0
-
-      until queue.empty?
-        doc = queue.shift
-
-        case doc
-        when PrettyPrint::Text
-          width += doc.width
-        when PrettyPrint::Indent, PrettyPrint::Align, PrettyPrint::Group
-          queue = doc.contents + queue
-        when PrettyPrint::IfBreak
-          queue = doc.break_contents + queue
-        when PrettyPrint::Breakable
-          width = 0
-        end
-      end
-
-      width
-    end
-
     def argument_alignment(q, doc)
       # Very special handling case for rspec matchers. In general with rspec
       # matchers you expect to see something like:
@@ -3138,7 +3066,7 @@ module SyntaxTree
       if %w[to not_to to_not].include?(message.value)
         0
       else
-        width = doc_width(doc) + 1
+        width = q.last_position(doc) + 1
         width > (q.maxwidth / 2) ? 0 : width
       end
     end
@@ -4891,17 +4819,9 @@ module SyntaxTree
     end
 
     def format(q)
-      # This is a very specific behavior that should probably be included in the
-      # prettyprint module. It's when you want to force a newline, but don't
-      # want to force the break parent.
-      breakable = -> do
-        q.target << PrettyPrint::Breakable.new(
-          " ",
-          1,
-          indent: false,
-          force: true
-        )
-      end
+      # This is a very specific behavior where you want to force a newline, but
+      # don't want to force the break parent.
+      breakable = -> { q.breakable(indent: false, force: :skip_break_parent) }
 
       q.group do
         q.format(beginning)
@@ -5197,6 +5117,8 @@ module SyntaxTree
           case node
           in predicate: Assign | Command | CommandCall | MAssign | OpAssign
             false
+          in predicate: Not[parentheses: false]
+            false
           in {
                statements: { body: [truthy] },
                consequent: Else[statements: { body: [falsy] }]
@@ -5325,9 +5247,8 @@ module SyntaxTree
                 # force it into the output but we _don't_ want to explicitly
                 # break the parent. If a break-parent shows up in the tree, then
                 # it's going to force it all the way up to the tree, which is
-                # going to negate the ternary. Maybe this should be an option in
-                # prettyprint? As in force: :no_break_parent or something.
-                q.target << PrettyPrint::Breakable.new(" ", 1, force: true)
+                # going to negate the ternary.
+                q.breakable(force: :skip_break_parent)
                 q.format(node.consequent.statements)
               end
             end
@@ -8314,8 +8235,7 @@ module SyntaxTree
         # same line in the source, then we're going to leave them in place and
         # assume that's the way the developer wanted this expression
         # represented.
-        doc = q.group(0, '#{', "}") { q.format(statements) }
-        RemoveBreaks.call(doc)
+        q.remove_breaks(q.group(0, '#{', "}") { q.format(statements) })
       else
         q.group do
           q.text('#{')

data/lib/syntax_tree/version.rb

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

data/lib/syntax_tree/visitor/match_visitor.rb

@@ -22,7 +22,7 @@ module SyntaxTree
           # entire value into the output buffer.
           q.text(node.inspect)
         else
-          q.pp(node)
+          node.pretty_print(q)
         end
       end
 
@@ -114,7 +114,7 @@ module SyntaxTree
         q.nest(0) do
           q.text(name)
           q.text(": ")
-          q.pp(value)
+          value.pretty_print(q)
         end
       end
     end

data/lib/syntax_tree.rb

@@ -2,7 +2,7 @@
 
 require "json"
 require "pp"
-require "prettyprint"
+require "prettier_print"
 require "ripper"
 require "stringio"
 
@@ -16,30 +16,6 @@ require_relative "syntax_tree/visitor/json_visitor"
 require_relative "syntax_tree/visitor/match_visitor"
 require_relative "syntax_tree/visitor/pretty_print_visitor"
 
-# If PrettyPrint::Align isn't defined, then we haven't gotten the updated
-# version of prettyprint. In that case we'll define our own. This is going to
-# overwrite a bunch of methods, so silencing them as well.
-unless PrettyPrint.const_defined?(:Align)
-  verbose = $VERBOSE
-  $VERBOSE = nil
-
-  begin
-    require_relative "syntax_tree/prettyprint"
-  ensure
-    $VERBOSE = verbose
-  end
-end
-
-# When PP is running, it expects that everything that interacts with it is going
-# to flow through PP.pp, since that's the main entry into the module from the
-# perspective of its uses in core Ruby. In doing so, it calls guard_inspect_key
-# at the top of the PP.pp method, which establishes some thread-local hashes to
-# check for cycles in the pretty printed tree. This means that if you want to
-# manually call pp on some object _before_ you have established these hashes,
-# you're going to break everything. So this call ensures that those hashes have
-# been set up before anything uses pp manually.
-PP.new(+"", 0).guard_inspect_key {}
-
 # Syntax Tree is a suite of tools built on top of the internal CRuby parser. It
 # provides the ability to generate a syntax tree from source, as well as the
 # tools necessary to inspect and manipulate that syntax tree. It can be used to
@@ -64,8 +40,8 @@ module SyntaxTree
   end
 
   # Parses the given source and returns the formatted source.
-  def self.format(source)
-    formatter = Formatter.new(source, [])
+  def self.format(source, maxwidth = 80)
+    formatter = Formatter.new(source, [], maxwidth)
     parse(source).format(formatter)
 
     formatter.flush

data/syntax_tree.gemspec

@@ -25,8 +25,11 @@ 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"
+
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
   spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: syntax_tree
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-10 00:00:00.000000000 Z
+date: 2022-05-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: prettier_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -101,7 +129,6 @@ files:
 - lib/syntax_tree/node.rb
 - lib/syntax_tree/parser.rb
 - lib/syntax_tree/plugin/single_quotes.rb
-- lib/syntax_tree/prettyprint.rb
 - lib/syntax_tree/version.rb
 - lib/syntax_tree/visitor.rb
 - lib/syntax_tree/visitor/field_visitor.rb
@@ -129,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: A parser based on ripper