syntax_tree 2.3.1 → 2.5.0

data/lib/syntax_tree/node.rb

@@ -3,9 +3,21 @@
 module SyntaxTree
   # Represents the location of a node in the tree from the source code.
   class Location
-    attr_reader :start_line, :start_char, :start_column, :end_line, :end_char, :end_column
+    attr_reader :start_line,
+                :start_char,
+                :start_column,
+                :end_line,
+                :end_char,
+                :end_column
 
-    def initialize(start_line:, start_char:, start_column:, end_line:, end_char:, end_column:)
+    def initialize(
+      start_line:,
+      start_char:,
+      start_column:,
+      end_line:,
+      end_char:,
+      end_column:
+    )
       @start_line = start_line
       @start_char = start_char
       @start_column = start_column
@@ -39,7 +51,7 @@ module SyntaxTree
       [start_line, start_char, start_column, end_line, end_char, end_column]
     end
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         start_line: start_line,
         start_char: start_char,
@@ -62,7 +74,14 @@ module SyntaxTree
     end
 
     def self.fixed(line:, char:, column:)
-      new(start_line: line, start_char: char, start_column: column, end_line: line, end_char: char, end_column: column)
+      new(
+        start_line: line,
+        start_char: char,
+        start_column: column,
+        end_line: line,
+        end_char: char,
+        end_column: column
+      )
     end
   end
 
@@ -102,6 +121,10 @@ module SyntaxTree
       visitor = Visitor::JSONVisitor.new
       visitor.visit(self).to_json(*opts)
     end
+
+    def construct_keys
+      PrettierPrint.format(+"") { |q| Visitor::MatchVisitor.new(q).visit(self) }
+    end
   end
 
   # BEGINBlock represents the use of the +BEGIN+ keyword, which hooks into the
@@ -140,7 +163,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         lbrace: lbrace,
         statements: statements,
@@ -192,7 +215,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -243,7 +266,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         lbrace: lbrace,
         statements: statements,
@@ -298,7 +321,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -323,6 +346,8 @@ module SyntaxTree
   # symbols (note that this includes dynamic symbols like
   # :"left-#{middle}-right").
   class Alias < Node
+    # Formats an argument to the alias keyword. For symbol literals it uses the
+    # value of the symbol directly to look like bare words.
     class AliasArgumentFormatter
       # [DynaSymbol | SymbolLiteral] the argument being passed to alias
       attr_reader :argument
@@ -374,7 +399,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { left: left, right: right, location: location, comments: comments }
     end
 
@@ -435,7 +460,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         collection: collection,
         index: index,
@@ -496,7 +521,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         collection: collection,
         index: index,
@@ -558,7 +583,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { arguments: arguments, location: location, comments: comments }
     end
 
@@ -606,7 +631,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { parts: parts, location: location, comments: comments }
     end
 
@@ -642,7 +667,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -679,7 +704,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -729,7 +754,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -745,6 +770,7 @@ module SyntaxTree
   #     [one, two, three]
   #
   class ArrayLiteral < Node
+    # Formats an array of multiple simple string literals into the %w syntax.
     class QWordsFormatter
       # [Args] the contents of the array
       attr_reader :contents
@@ -761,7 +787,7 @@ module SyntaxTree
               if part.is_a?(StringLiteral)
                 q.format(part.parts.first)
               else
-                q.text(part.value[1..-1])
+                q.text(part.value[1..])
               end
             end
           end
@@ -770,6 +796,7 @@ module SyntaxTree
       end
     end
 
+    # Formats an array of multiple simple symbol literals into the %i syntax.
     class QSymbolsFormatter
       # [Args] the contents of the array
       attr_reader :contents
@@ -791,6 +818,28 @@ module SyntaxTree
       end
     end
 
+    # Formats an array that contains only a list of variable references. To make
+    # things simpler, if there are a bunch, we format them all using the "fill"
+    # algorithm as opposed to breaking them into a ton of lines. For example,
+    #
+    #     [foo, bar, baz]
+    #
+    # instead of becoming:
+    #
+    #     [
+    #       foo,
+    #       bar,
+    #       baz
+    #     ]
+    #
+    # would instead become:
+    #
+    #     [
+    #       foo, bar,
+    #       baz
+    #     ]
+    #
+    # provided the line length was hit between `bar` and `baz`.
     class VarRefsFormatter
       # [Args] the contents of the array
       attr_reader :contents
@@ -816,6 +865,9 @@ module SyntaxTree
       end
     end
 
+    # This is a special formatter used if the array literal contains no values
+    # but _does_ contain comments. In this case we do some special formatting to
+    # make sure the comments gets indented properly.
     class EmptyWithCommentsFormatter
       # [LBracket] the opening bracket
       attr_reader :lbracket
@@ -865,7 +917,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         lbracket: lbracket,
         contents: contents,
@@ -951,7 +1003,8 @@ module SyntaxTree
     # If we have an empty array that contains only comments, then we're going
     # to do some special printing to ensure they get indented correctly.
     def empty_with_comments?
-      contents.nil? && lbracket.comments.any? && lbracket.comments.none?(&:inline?)
+      contents.nil? && lbracket.comments.any? &&
+        lbracket.comments.none?(&:inline?)
     end
   end
 
@@ -973,6 +1026,7 @@ module SyntaxTree
   # and an optional array of positional matches that occur after the splat.
   # All of the in clauses above would create an AryPtn node.
   class AryPtn < Node
+    # Formats the optional splat of an array pattern.
     class RestFormatter
       # [VarField] the identifier that represents the remaining positionals
       attr_reader :value
@@ -1035,7 +1089,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         constant: constant,
         requireds: requireds,
@@ -1067,6 +1121,8 @@ module SyntaxTree
         q.text("[")
         q.seplist(parts) { |part| q.format(part) }
         q.text("]")
+      elsif parts.empty?
+        q.text("[]")
       else
         q.group { q.seplist(parts) { |part| q.format(part) } }
       end
@@ -1077,7 +1133,8 @@ module SyntaxTree
   module AssignFormatting
     def self.skip_indent?(value)
       case value
-      in ArrayLiteral | HashLiteral | Heredoc | Lambda | QSymbols | QWords | Symbols | Words
+      in ArrayLiteral | HashLiteral | Heredoc | Lambda | QSymbols | QWords |
+           Symbols | Words
         true
       in Call[receiver:]
         skip_indent?(receiver)
@@ -1123,7 +1180,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { target: target, value: value, location: location, comments: comments }
     end
 
@@ -1185,12 +1242,12 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { key: key, value: value, location: location, comments: comments }
     end
 
     def format(q)
-      if value&.is_a?(HashLiteral)
+      if value.is_a?(HashLiteral)
         format_contents(q)
       else
         q.group { format_contents(q) }
@@ -1243,7 +1300,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -1281,7 +1338,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -1316,7 +1373,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -1329,21 +1386,28 @@ module SyntaxTree
   # hash or bare hash. It first determines if every key in the hash can use
   # labels. If it can, it uses labels. Otherwise it uses hash rockets.
   module HashKeyFormatter
+    # Formats the keys of a hash literal using labels.
     class Labels
+      LABEL = /\A[A-Za-z_](\w*[\w!?])?\z/
+
       def format_key(q, key)
         case key
-        when Label
+        in Label
           q.format(key)
-        when SymbolLiteral
+        in SymbolLiteral
           q.format(key.value)
           q.text(":")
-        when DynaSymbol
+        in DynaSymbol[parts: [TStringContent[value: LABEL] => part]]
+          q.format(part)
+          q.text(":")
+        in DynaSymbol
           q.format(key)
           q.text(":")
         end
       end
     end
 
+    # Formats the keys of a hash literal using hash rockets.
     class Rockets
       def format_key(q, key)
         case key
@@ -1417,7 +1481,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { assocs: assocs, location: location, comments: comments }
     end
 
@@ -1459,7 +1523,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { bodystmt: bodystmt, location: location, comments: comments }
     end
 
@@ -1507,7 +1571,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { statement: statement, location: location, comments: comments }
     end
 
@@ -1567,7 +1631,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         left: left,
         operator: operator,
@@ -1602,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.
@@ -1682,14 +1700,13 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { params: params, locals: locals, location: location, comments: comments }
     end
 
     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("; ")
@@ -1726,7 +1743,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { name: name, location: location, comments: comments }
     end
 
@@ -1822,7 +1839,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         statements: statements,
         rescue_clause: rescue_clause,
@@ -1868,6 +1885,7 @@ module SyntaxTree
 
   # Responsible for formatting either a BraceBlock or a DoBlock.
   class BlockFormatter
+    # Formats the opening brace or keyword of a block.
     class BlockOpenFormatter
       # [String] the actual output that should be printed
       attr_reader :text
@@ -1933,9 +1951,9 @@ module SyntaxTree
       end
 
       q.group do
-        q.if_break { format_break(q, break_opening, break_closing) }.if_flat do
-          format_flat(q, flat_opening, flat_closing)
-        end
+        q
+          .if_break { format_break(q, break_opening, break_closing) }
+          .if_flat { format_flat(q, flat_opening, flat_closing) }
       end
     end
 
@@ -2060,7 +2078,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         lbrace: lbrace,
         block_var: block_var,
@@ -2099,7 +2117,11 @@ module SyntaxTree
           #
           #     break
           #
-        in [Paren[contents: { body: [ArrayLiteral[contents: { parts: [_, _, *] }] => array] }]]
+        in [Paren[
+             contents: {
+               body: [ArrayLiteral[contents: { parts: [_, _, *] }] => array]
+             }
+           ]]
           # Here we have a single argument that is a set of parentheses wrapping
           # an array literal that has at least 2 elements. We're going to print
           # the contents of the array directly. This would be like if we had:
@@ -2255,7 +2277,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { arguments: arguments, location: location, comments: comments }
     end
 
@@ -2287,6 +2309,20 @@ module SyntaxTree
     end
   end
 
+  # This is probably the most complicated formatter in this file. It's
+  # responsible for formatting chains of method calls, with or without arguments
+  # or blocks. In general, we want to go from something like
+  #
+  #     foo.bar.baz
+  #
+  # to
+  #
+  #     foo
+  #       .bar
+  #       .baz
+  #
+  # Of course there are a lot of caveats to that, including trailing operators
+  # when necessary, where comments are places, how blocks are aligned, etc.
   class CallChainFormatter
     # [Call | MethodAddBlock] the top of the call chain
     attr_reader :node
@@ -2301,7 +2337,7 @@ module SyntaxTree
 
       # First, walk down the chain until we get to the point where we're not
       # longer at a chainable node.
-      while true
+      loop do
         case children.last
         in Call[receiver: Call]
           children << children.last.receiver
@@ -2321,7 +2357,7 @@ module SyntaxTree
       # block. For more details, see
       # https://github.com/prettier/plugin-ruby/issues/863.
       parents = q.parents.take(4)
-      if parent = parents[2]
+      if (parent = parents[2])
         # If we're at a do_block, then we want to go one more level up. This is
         # because do blocks have BodyStmt nodes instead of just Statements
         # nodes.
@@ -2335,7 +2371,11 @@ module SyntaxTree
       end
 
       if children.length >= threshold
-        q.group { q.if_break { format_chain(q, children) }.if_flat { node.format_contents(q) } }
+        q.group do
+          q
+            .if_break { format_chain(q, children) }
+            .if_flat { node.format_contents(q) }
+        end
       else
         node.format_contents(q)
       end
@@ -2346,9 +2386,9 @@ module SyntaxTree
       # chain of calls without arguments except for the last one. This is common
       # enough in Ruby source code that it's worth the extra complexity here.
       empty_except_last =
-        children.drop(1).all? do |child|
-          child.is_a?(Call) && child.arguments.nil?
-        end
+        children
+          .drop(1)
+          .all? { |child| child.is_a?(Call) && child.arguments.nil? }
 
       # Here, we're going to add all of the children onto the stack of the
       # formatter so it's as if we had descending normally into them. This is
@@ -2368,9 +2408,12 @@ module SyntaxTree
           # and a trailing operator.
           skip_operator = false
 
-          while child = children.pop
+          while (child = children.pop)
             case child
-            in Call[receiver: Call[message: { value: "where" }], message: { value: "not" }]
+            in Call[
+                 receiver: Call[message: { value: "where" }],
+                 message: { value: "not" }
+               ]
               # This is very specialized behavior wherein we group
               # .where.not calls together because it looks better. For more
               # information, see
@@ -2432,16 +2475,25 @@ module SyntaxTree
     # want to indent the first call. So we'll pop off the first children and
     # format it separately here.
     def attach_directly?(node)
-      [ArrayLiteral, HashLiteral, Heredoc, If, Unless, XStringLiteral]
-        .include?(node.receiver.class)
+      [ArrayLiteral, HashLiteral, Heredoc, If, Unless, XStringLiteral].include?(
+        node.receiver.class
+      )
     end
 
-    def format_child(q, child, skip_comments: false, skip_operator: false, skip_attached: false)
+    def format_child(
+      q,
+      child,
+      skip_comments: false,
+      skip_operator: false,
+      skip_attached: false
+    )
       # First, format the actual contents of the child.
       case child
       in Call
         q.group do
-          q.format(CallOperatorFormatter.new(child.operator)) unless skip_operator
+          unless skip_operator
+            q.format(CallOperatorFormatter.new(child.operator))
+          end
           q.format(child.message) if child.message != :call
           child.format_arguments(q) unless skip_attached
         end
@@ -2513,7 +2565,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         receiver: receiver,
         operator: operator,
@@ -2528,8 +2580,13 @@ module SyntaxTree
       # If we're at the top of a call chain, then we're going to do some
       # specialized printing in case we can print it nicely. We _only_ do this
       # at the top of the chain to avoid weird recursion issues.
-      if !CallChainFormatter.chained?(q.parent) && CallChainFormatter.chained?(receiver)
-        q.group { q.if_break { CallChainFormatter.new(self).format(q) }.if_flat { format_contents(q) } }
+      if !CallChainFormatter.chained?(q.parent) &&
+           CallChainFormatter.chained?(receiver)
+        q.group do
+          q
+            .if_break { CallChainFormatter.new(self).format(q) }
+            .if_flat { format_contents(q) }
+        end
       else
         format_contents(q)
       end
@@ -2618,7 +2675,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         keyword: keyword,
         value: value,
@@ -2683,7 +2740,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         value: value,
         operator: operator,
@@ -2772,7 +2829,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         constant: constant,
         superclass: superclass,
@@ -2837,7 +2894,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -2875,7 +2932,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         message: message,
         arguments: arguments,
@@ -2957,7 +3014,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         receiver: receiver,
         operator: operator,
@@ -2992,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:
@@ -3034,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
@@ -3079,7 +3111,7 @@ module SyntaxTree
     end
 
     def ignore?
-      value[1..-1].strip == "stree-ignore"
+      value[1..].strip == "stree-ignore"
     end
 
     def comments
@@ -3096,7 +3128,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, inline: inline, location: location }
     end
 
@@ -3142,7 +3174,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -3184,7 +3216,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         parent: parent,
         constant: constant,
@@ -3231,7 +3263,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         parent: parent,
         constant: constant,
@@ -3276,7 +3308,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { constant: constant, location: location, comments: comments }
     end
 
@@ -3312,7 +3344,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -3356,7 +3388,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         name: name,
         params: params,
@@ -3441,7 +3473,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         target: target,
         operator: operator,
@@ -3509,7 +3541,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -3575,7 +3607,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         target: target,
         operator: operator,
@@ -3650,7 +3682,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         keyword: keyword,
         block_var: block_var,
@@ -3730,7 +3762,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { left: left, right: right, location: location, comments: comments }
     end
 
@@ -3778,7 +3810,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { left: left, right: right, location: location, comments: comments }
     end
 
@@ -3800,7 +3832,7 @@ module SyntaxTree
     # quotes, then single quotes would deactivate it.)
     def self.locked?(node)
       node.parts.any? do |part|
-        part.is_a?(TStringContent) && part.value.match?(/#[@${]|[\\]/)
+        !part.is_a?(TStringContent) || part.value.match?(/\\|#[@${]/)
       end
     end
 
@@ -3865,7 +3897,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { parts: parts, quote: quote, location: location, comments: comments }
     end
 
@@ -3906,9 +3938,14 @@ module SyntaxTree
         matching = Quotes.matching(quote[2])
         pattern = /[\n#{Regexp.escape(matching)}'"]/
 
-        if parts.any? { |part|
-             part.is_a?(TStringContent) && part.value.match?(pattern)
-           }
+        # This check is to ensure we don't find a matching quote inside of the
+        # symbol that would be confusing.
+        matched =
+          parts.any? do |part|
+            part.is_a?(TStringContent) && part.value.match?(pattern)
+          end
+
+        if matched
           [quote, matching]
         elsif Quotes.locked?(self)
           ["#{":" unless hash_key}'", "'"]
@@ -3917,7 +3954,7 @@ module SyntaxTree
         end
       elsif Quotes.locked?(self)
         if quote.start_with?(":")
-          [hash_key ? quote[1..-1] : quote, quote[1..-1]]
+          [hash_key ? quote[1..] : quote, quote[1..]]
         else
           [hash_key ? quote : ":#{quote}", quote]
         end
@@ -3960,7 +3997,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         keyword: keyword,
         statements: statements,
@@ -4026,7 +4063,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         predicate: predicate,
         statements: statements,
@@ -4098,7 +4135,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
 
@@ -4133,7 +4170,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -4163,7 +4200,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -4195,7 +4232,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -4234,7 +4271,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         keyword: keyword,
         statements: statements,
@@ -4288,7 +4325,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -4331,7 +4368,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         value: value,
         arguments: arguments,
@@ -4343,7 +4380,8 @@ module SyntaxTree
     def format(q)
       q.format(value)
 
-      if arguments.is_a?(ArgParen) && arguments.arguments.nil? && !value.is_a?(Const)
+      if arguments.is_a?(ArgParen) && arguments.arguments.nil? &&
+           !value.is_a?(Const)
         # If you're using an explicit set of parentheses on something that looks
         # like a constant, then we need to match that in order to maintain valid
         # Ruby. For example, you could do something like Foo(), on which we
@@ -4390,7 +4428,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         parent: parent,
         operator: operator,
@@ -4436,7 +4474,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -4488,7 +4526,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         constant: constant,
         left: left,
@@ -4552,7 +4590,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         index: index,
         collection: collection,
@@ -4609,7 +4647,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -4623,6 +4661,9 @@ module SyntaxTree
   #     { key => value }
   #
   class HashLiteral < Node
+    # This is a special formatter used if the hash literal contains no values
+    # but _does_ contain comments. In this case we do some special formatting to
+    # make sure the comments gets indented properly.
     class EmptyWithCommentsFormatter
       # [LBrace] the opening brace
       attr_reader :lbrace
@@ -4672,7 +4713,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { lbrace: lbrace, assocs: assocs, location: location, comments: comments }
     end
 
@@ -4741,7 +4782,14 @@ module SyntaxTree
     # [Array[ Comment | EmbDoc ]] the comments attached to this node
     attr_reader :comments
 
-    def initialize(beginning:, ending: nil, dedent: 0, parts: [], location:, comments: [])
+    def initialize(
+      beginning:,
+      ending: nil,
+      dedent: 0,
+      parts: [],
+      location:,
+      comments: []
+    )
       @beginning = beginning
       @ending = ending
       @dedent = dedent
@@ -4760,7 +4808,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         beginning: beginning,
         location: location,
@@ -4771,13 +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)
@@ -4832,7 +4876,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -4849,6 +4893,7 @@ module SyntaxTree
   #     end
   #
   class HshPtn < Node
+    # Formats a key-value pair in a hash pattern. The value is optional.
     class KeywordFormatter
       # [Label] the keyword being used
       attr_reader :key
@@ -4875,6 +4920,7 @@ module SyntaxTree
       end
     end
 
+    # Formats the optional double-splat from the pattern.
     class KeywordRestFormatter
       # [VarField] the parameter that matches the remaining keywords
       attr_reader :keyword_rest
@@ -4924,7 +4970,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         constant: constant,
         keywords: keywords,
@@ -4938,36 +4984,64 @@ module SyntaxTree
       parts = keywords.map { |(key, value)| KeywordFormatter.new(key, value) }
       parts << KeywordRestFormatter.new(keyword_rest) if keyword_rest
 
+      nested = PATTERNS.include?(q.parent.class)
       contents = -> do
         q.group { q.seplist(parts) { |part| q.format(part, stackable: false) } }
 
         # If there isn't a constant, and there's a blank keyword_rest, then we
         # have an plain ** that needs to have a `then` after it in order to
         # parse correctly on the next parse.
-        q.text(" then") if !constant && keyword_rest && keyword_rest.value.nil?
+        if !constant && keyword_rest && keyword_rest.value.nil? && !nested
+          q.text(" then")
+        end
       end
 
+      # If there is a constant, we're going to format to have the constant name
+      # first and then use brackets.
       if constant
-        q.format(constant)
-        q.group(0, "[", "]", &contents)
+        q.group do
+          q.format(constant)
+          q.text("[")
+          q.indent do
+            q.breakable("")
+            contents.call
+          end
+          q.breakable("")
+          q.text("]")
+        end
         return
       end
 
+      # If there's nothing at all, then we're going to use empty braces.
       if parts.empty?
         q.text("{}")
-      elsif PATTERNS.include?(q.parent.class)
-        q.text("{ ")
-        contents.call
-        q.text(" }")
-      else
+        return
+      end
+
+      # If there's only one pair, then we'll just print the contents provided
+      # we're not inside another pattern.
+      if !nested && parts.size == 1
         contents.call
+        return
+      end
+
+      # Otherwise, we're going to always use braces to make it clear it's a hash
+      # pattern.
+      q.group do
+        q.text("{")
+        q.indent do
+          q.breakable
+          contents.call
+        end
+        q.breakable
+        q.text("}")
       end
     end
   end
 
   # The list of nodes that represent patterns inside of pattern matching so that
   # when a pattern is being printed it knows if it's nested.
-  PATTERNS = [AryPtn, Binary, FndPtn, HshPtn, RAssign]
+  PATTERNS = [AryPtn, Binary, FndPtn, HshPtn, RAssign].freeze
 
   # Ident represents an identifier anywhere in code. It can represent a very
   # large number of things, depending on where it is in the syntax tree.
@@ -4997,7 +5071,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -5014,7 +5088,7 @@ module SyntaxTree
     def self.call(parent)
       queue = [parent]
 
-      while node = queue.shift
+      while (node = queue.shift)
         return true if [Assign, MAssign, OpAssign].include?(node.class)
         queue += node.child_nodes
       end
@@ -5041,9 +5115,14 @@ module SyntaxTree
         else
           # Otherwise, we're going to check the conditional for certain cases.
           case node
-          in { predicate: Assign | Command | CommandCall | MAssign | OpAssign }
+          in predicate: Assign | Command | CommandCall | MAssign | OpAssign
             false
-          in { statements: { body: [truthy] }, consequent: Else[statements: { body: [falsy] }] }
+          in predicate: Not[parentheses: false]
+            false
+          in {
+               statements: { body: [truthy] },
+               consequent: Else[statements: { body: [falsy] }]
+             }
             ternaryable?(truthy) && ternaryable?(falsy)
           else
             false
@@ -5054,8 +5133,8 @@ module SyntaxTree
       private
 
       # Certain expressions cannot be reduced to a ternary without adding
-      # parentheses around them. In this case we say they cannot be ternaried and
-      # default instead to breaking them into multiple lines.
+      # parentheses around them. In this case we say they cannot be ternaried
+      # and default instead to breaking them into multiple lines.
       def ternaryable?(statement)
         # This is a list of nodes that should not be allowed to be a part of a
         # ternary clause.
@@ -5113,13 +5192,15 @@ module SyntaxTree
         q.group { format_break(q, force: true) }
       else
         q.group do
-          q.if_break { format_break(q, force: false) }.if_flat do
-            Parentheses.flat(q) do
-              q.format(node.statements)
-              q.text(" #{keyword} ")
-              q.format(node.predicate)
+          q
+            .if_break { format_break(q, force: false) }
+            .if_flat do
+              Parentheses.flat(q) do
+                q.format(node.statements)
+                q.text(" #{keyword} ")
+                q.format(node.predicate)
+              end
             end
-          end
         end
       end
     end
@@ -5148,51 +5229,52 @@ module SyntaxTree
 
     def format_ternary(q)
       q.group do
-        q.if_break do
-          q.text("#{keyword} ")
-          q.nest(keyword.length + 1) { q.format(node.predicate) }
+        q
+          .if_break do
+            q.text("#{keyword} ")
+            q.nest(keyword.length + 1) { q.format(node.predicate) }
 
-          q.indent do
-            q.breakable
-            q.format(node.statements)
-          end
-
-          q.breakable
-          q.group do
-            q.format(node.consequent.keyword)
             q.indent do
-              # This is a very special case of breakable where we want to 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)
-              q.format(node.consequent.statements)
+              q.breakable
+              q.format(node.statements)
             end
-          end
 
-          q.breakable
-          q.text("end")
-        end.if_flat do
-          Parentheses.flat(q) do
-            q.format(node.predicate)
-            q.text(" ? ")
+            q.breakable
+            q.group do
+              q.format(node.consequent.keyword)
+              q.indent do
+                # This is a very special case of breakable where we want to
+                # 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.
+                q.breakable(force: :skip_break_parent)
+                q.format(node.consequent.statements)
+              end
+            end
+
+            q.breakable
+            q.text("end")
+          end
+          .if_flat do
+            Parentheses.flat(q) do
+              q.format(node.predicate)
+              q.text(" ? ")
 
-            statements = [node.statements, node.consequent.statements]
-            statements.reverse! if keyword == "unless"
+              statements = [node.statements, node.consequent.statements]
+              statements.reverse! if keyword == "unless"
 
-            q.format(statements[0])
-            q.text(" : ")
-            q.format(statements[1])
+              q.format(statements[0])
+              q.text(" : ")
+              q.format(statements[1])
+            end
           end
-        end
       end
     end
 
     def contains_conditional?
       case node
-      in { statements: { body: [If | IfMod | IfOp | Unless | UnlessMod] } }
+      in statements: { body: [If | IfMod | IfOp | Unless | UnlessMod] }
         true
       else
         false
@@ -5242,7 +5324,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         predicate: predicate,
         statements: statements,
@@ -5292,7 +5374,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         predicate: predicate,
         truthy: truthy,
@@ -5310,7 +5392,8 @@ module SyntaxTree
         Yield0, ZSuper
       ]
 
-      if q.parent.is_a?(Paren) || force_flat.include?(truthy.class) || force_flat.include?(falsy.class)
+      if q.parent.is_a?(Paren) || force_flat.include?(truthy.class) ||
+           force_flat.include?(falsy.class)
         q.group { format_flat(q) }
         return
       end
@@ -5430,7 +5513,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         statement: statement,
         predicate: predicate,
@@ -5471,7 +5554,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -5518,7 +5601,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         pattern: pattern,
         statements: statements,
@@ -5577,7 +5660,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -5587,7 +5670,7 @@ module SyntaxTree
         # the values, then we're going to insert them every 3 characters
         # starting from the right.
         index = (value.length + 2) % 3
-        q.text("  #{value}"[index..-1].scan(/.../).join("_").strip)
+        q.text("  #{value}"[index..].scan(/.../).join("_").strip)
       else
         q.text(value)
       end
@@ -5621,7 +5704,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -5666,7 +5749,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -5703,7 +5786,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { name: name, location: location, comments: comments }
     end
 
@@ -5749,7 +5832,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -5784,7 +5867,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -5820,7 +5903,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         params: params,
         statements: statements,
@@ -5842,25 +5925,27 @@ module SyntaxTree
         end
 
         q.text(" ")
-        q.if_break do
-          force_parens =
-            q.parents.any? do |node|
-              node.is_a?(Command) || node.is_a?(CommandCall)
+        q
+          .if_break do
+            force_parens =
+              q.parents.any? do |node|
+                node.is_a?(Command) || node.is_a?(CommandCall)
+              end
+
+            q.text(force_parens ? "{" : "do")
+            q.indent do
+              q.breakable
+              q.format(statements)
             end
 
-          q.text(force_parens ? "{" : "do")
-          q.indent do
             q.breakable
+            q.text(force_parens ? "}" : "end")
+          end
+          .if_flat do
+            q.text("{ ")
             q.format(statements)
+            q.text(" }")
           end
-
-          q.breakable
-          q.text(force_parens ? "}" : "end")
-        end.if_flat do
-          q.text("{ ")
-          q.format(statements)
-          q.text(" }")
-        end
       end
     end
   end
@@ -5889,7 +5974,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -5922,7 +6007,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -5955,7 +6040,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -6005,7 +6090,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { target: target, value: value, location: location, comments: comments }
     end
 
@@ -6052,7 +6137,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { call: call, block: block, location: location, comments: comments }
     end
 
@@ -6060,8 +6145,13 @@ module SyntaxTree
       # If we're at the top of a call chain, then we're going to do some
       # specialized printing in case we can print it nicely. We _only_ do this
       # at the top of the chain to avoid weird recursion issues.
-      if !CallChainFormatter.chained?(q.parent) && CallChainFormatter.chained?(call)
-        q.group { q.if_break { CallChainFormatter.new(self).format(q) }.if_flat { format_contents(q) } }
+      if !CallChainFormatter.chained?(q.parent) &&
+           CallChainFormatter.chained?(call)
+        q.group do
+          q
+            .if_break { CallChainFormatter.new(self).format(q) }
+            .if_flat { format_contents(q) }
+        end
       else
         format_contents(q)
       end
@@ -6108,7 +6198,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { parts: parts, location: location, comma: comma, comments: comments }
     end
 
@@ -6152,7 +6242,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { contents: contents, location: location, comments: comments }
     end
 
@@ -6208,7 +6298,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         constant: constant,
         bodystmt: bodystmt,
@@ -6275,7 +6365,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { parts: parts, location: location, comments: comments }
     end
 
@@ -6324,7 +6414,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { arguments: arguments, location: location, comments: comments }
     end
 
@@ -6361,7 +6451,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -6407,7 +6497,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         target: target,
         operator: operator,
@@ -6475,7 +6565,16 @@ module SyntaxTree
   # This approach maintains the nice conciseness of the inline version, while
   # keeping the correct semantic meaning.
   module Parentheses
-    NODES = [Args, Assign, Assoc, Binary, Call, Defined, MAssign, OpAssign]
+    NODES = [
+      Args,
+      Assign,
+      Assoc,
+      Binary,
+      Call,
+      Defined,
+      MAssign,
+      OpAssign
+    ].freeze
 
     def self.flat(q)
       return yield unless NODES.include?(q.parent.class)
@@ -6507,6 +6606,8 @@ module SyntaxTree
   #     def method(param) end
   #
   class Params < Node
+    # Formats the optional position of the parameters. This includes the label,
+    # as well as the default value.
     class OptionalFormatter
       # [Ident] the name of the parameter
       attr_reader :name
@@ -6530,6 +6631,8 @@ module SyntaxTree
       end
     end
 
+    # Formats the keyword position of the parameters. This includes the label,
+    # as well as an optional default value.
     class KeywordFormatter
       # [Ident] the name of the parameter
       attr_reader :name
@@ -6556,6 +6659,8 @@ module SyntaxTree
       end
     end
 
+    # Formats the keyword_rest position of the parameters. This can be the **nil
+    # syntax, the ... syntax, or the ** syntax.
     class KeywordRestFormatter
       # [:nil | ArgsForward | KwRestParam] the value of the parameter
       attr_reader :value
@@ -6569,11 +6674,7 @@ module SyntaxTree
       end
 
       def format(q)
-        if value == :nil
-          q.text("**nil")
-        else
-          q.format(value)
-        end
+        value == :nil ? q.text("**nil") : q.format(value)
       end
     end
 
@@ -6654,7 +6755,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         location: location,
         requireds: requireds,
@@ -6675,18 +6776,17 @@ module SyntaxTree
       ]
 
       parts << rest if rest && !rest.is_a?(ExcessedComma)
-      parts +=
-        [
-          *posts,
-          *keywords.map { |(name, value)| KeywordFormatter.new(name, value) }
-        ]
+      parts += [
+        *posts,
+        *keywords.map { |(name, value)| KeywordFormatter.new(name, value) }
+      ]
 
       parts << KeywordRestFormatter.new(keyword_rest) if keyword_rest
       parts << block if block
 
       contents = -> do
         q.seplist(parts) { |part| q.format(part) }
-        q.format(rest) if rest && rest.is_a?(ExcessedComma)
+        q.format(rest) if rest.is_a?(ExcessedComma)
       end
 
       if ![Def, Defs, DefEndless].include?(q.parent.class) || parts.empty?
@@ -6736,7 +6836,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         lparen: lparen,
         contents: contents,
@@ -6787,7 +6887,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -6820,7 +6920,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { statements: statements, location: location, comments: comments }
     end
 
@@ -6865,7 +6965,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         beginning: beginning,
         elements: elements,
@@ -6920,18 +7020,9 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
-
-    def pretty_print(q)
-      q.group(2, "(", ")") do
-        q.text("qsymbols_beg")
-
-        q.breakable
-        q.pp(value)
-      end
-    end
   end
 
   # QWords represents a string literal array without interpolation.
@@ -6965,7 +7056,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         beginning: beginning,
         elements: elements,
@@ -7020,7 +7111,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -7052,7 +7143,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -7081,7 +7172,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -7106,7 +7197,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -7138,7 +7229,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -7177,7 +7268,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { beginning: beginning, parts: parts, location: location }
     end
   end
@@ -7210,7 +7301,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -7244,7 +7335,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -7285,10 +7376,11 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         beginning: beginning,
         ending: ending,
+        options: options,
         parts: parts,
         location: location,
         comments: comments
@@ -7296,7 +7388,7 @@ module SyntaxTree
     end
 
     def format(q)
-      braces = ambiguous?(q) || include?(%r{\/})
+      braces = ambiguous?(q) || include?(%r{/})
 
       if braces && include?(/[{}]/)
         q.group do
@@ -7323,18 +7415,22 @@ module SyntaxTree
           end
 
           q.text("}")
-          q.text(ending[1..-1])
+          q.text(options)
         end
       else
         q.group do
           q.text("/")
           q.format_each(parts)
           q.text("/")
-          q.text(ending[1..-1])
+          q.text(options)
         end
       end
     end
 
+    def options
+      ending[1..]
+    end
+
     private
 
     def include?(pattern)
@@ -7390,7 +7486,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         exceptions: exceptions,
         variable: variable,
@@ -7465,7 +7561,10 @@ module SyntaxTree
 
       if consequent
         consequent.bind_end(end_char, end_column)
-        statements.bind_end(consequent.location.start_char, consequent.location.start_column)
+        statements.bind_end(
+          consequent.location.start_char,
+          consequent.location.start_column
+        )
       else
         statements.bind_end(end_char, end_column)
       end
@@ -7481,7 +7580,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         keyword: keyword,
         exception: exception,
@@ -7548,7 +7647,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         statement: statement,
         value: value,
@@ -7602,7 +7701,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { name: name, location: location, comments: comments }
     end
 
@@ -7639,7 +7738,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -7675,7 +7774,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { arguments: arguments, location: location, comments: comments }
     end
 
@@ -7711,7 +7810,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -7740,7 +7839,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -7779,7 +7878,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         target: target,
         bodystmt: bodystmt,
@@ -7881,7 +7980,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { parser: parser, body: body, location: location, comments: comments }
     end
 
@@ -7951,12 +8050,19 @@ module SyntaxTree
         comment = parser_comments[comment_index]
         location = comment.location
 
-        if !comment.inline? && (start_char <= location.start_char) && (end_char >= location.end_char) && !comment.ignore?
-          while (node = body[body_index]) && (node.is_a?(VoidStmt) || node.location.start_char < location.start_char)
+        if !comment.inline? && (start_char <= location.start_char) &&
+             (end_char >= location.end_char) && !comment.ignore?
+          while (node = body[body_index]) &&
+                  (
+                    node.is_a?(VoidStmt) ||
+                      node.location.start_char < location.start_char
+                  )
             body_index += 1
           end
 
-          if body_index != 0 && body[body_index - 1].location.start_char < location.start_char && body[body_index - 1].location.end_char > location.start_char
+          if body_index != 0 &&
+               body[body_index - 1].location.start_char < location.start_char &&
+               body[body_index - 1].location.end_char > location.start_char
             # The previous node entirely encapsules the comment, so we don't
             # want to attach it here since it will get attached normally. This
             # is mostly in the case of hash and array literals.
@@ -7996,7 +8102,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { parts: parts, location: location }
     end
   end
@@ -8034,14 +8140,14 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { left: left, right: right, location: location, comments: comments }
     end
 
     def format(q)
       q.group do
         q.format(left)
-        q.text(' \\')
+        q.text(" \\")
         q.indent do
           q.breakable(force: true)
           q.format(right)
@@ -8079,7 +8185,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { variable: variable, location: location, comments: comments }
     end
 
@@ -8119,7 +8225,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { statements: statements, location: location, comments: comments }
     end
 
@@ -8129,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('#{')
@@ -8177,7 +8282,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { parts: parts, quote: quote, location: location, comments: comments }
     end
 
@@ -8240,7 +8345,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { arguments: arguments, location: location, comments: comments }
     end
 
@@ -8293,7 +8398,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -8323,7 +8428,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -8357,7 +8462,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -8398,7 +8503,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         beginning: beginning,
         elements: elements,
@@ -8454,7 +8559,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -8483,7 +8588,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -8513,7 +8618,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -8547,7 +8652,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { constant: constant, location: location, comments: comments }
     end
 
@@ -8585,7 +8690,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { constant: constant, location: location, comments: comments }
     end
 
@@ -8624,7 +8729,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -8664,7 +8769,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -8702,7 +8807,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -8738,7 +8843,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         statement: statement,
         parentheses: parentheses,
@@ -8749,7 +8854,9 @@ module SyntaxTree
 
     def format(q)
       parent = q.parents.take(2)[1]
-      ternary = (parent.is_a?(If) || parent.is_a?(Unless)) && Ternaryable.call(q, parent)
+      ternary =
+        (parent.is_a?(If) || parent.is_a?(Unless)) &&
+          Ternaryable.call(q, parent)
 
       q.text("not")
 
@@ -8803,7 +8910,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         operator: operator,
         statement: statement,
@@ -8823,6 +8930,9 @@ module SyntaxTree
   #     undef method
   #
   class Undef < Node
+    # Undef accepts a variable number of arguments that can be either DynaSymbol
+    # or SymbolLiteral objects. For SymbolLiteral objects we descend directly
+    # into the value in order to have it come out as bare words.
     class UndefArgumentFormatter
       # [DynaSymbol | SymbolLiteral] the symbol to undefine
       attr_reader :node
@@ -8866,7 +8976,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { symbols: symbols, location: location, comments: comments }
     end
 
@@ -8925,7 +9035,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         predicate: predicate,
         statements: statements,
@@ -8971,7 +9081,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         statement: statement,
         predicate: predicate,
@@ -9010,13 +9120,15 @@ module SyntaxTree
       end
 
       q.group do
-        q.if_break { format_break(q) }.if_flat do
-          Parentheses.flat(q) do
-            q.format(statements)
-            q.text(" #{keyword} ")
-            q.format(node.predicate)
+        q
+          .if_break { format_break(q) }
+          .if_flat do
+            Parentheses.flat(q) do
+              q.format(statements)
+              q.text(" #{keyword} ")
+              q.format(node.predicate)
+            end
           end
-        end
       end
     end
 
@@ -9066,7 +9178,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         predicate: predicate,
         statements: statements,
@@ -9122,7 +9234,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         statement: statement,
         predicate: predicate,
@@ -9188,7 +9300,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { left: left, right: right, location: location, comments: comments }
     end
 
@@ -9231,7 +9343,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -9275,7 +9387,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -9316,7 +9428,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -9356,7 +9468,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -9391,7 +9503,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { location: location, comments: comments }
     end
 
@@ -9442,7 +9554,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         arguments: arguments,
         statements: statements,
@@ -9523,7 +9635,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         predicate: predicate,
         statements: statements,
@@ -9579,7 +9691,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         statement: statement,
         predicate: predicate,
@@ -9648,7 +9760,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { parts: parts, location: location, comments: comments }
     end
 
@@ -9688,7 +9800,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       {
         beginning: beginning,
         elements: elements,
@@ -9744,7 +9856,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location }
     end
   end
@@ -9773,7 +9885,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { parts: parts, location: location }
     end
   end
@@ -9806,7 +9918,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { parts: parts, location: location, comments: comments }
     end
 
@@ -9844,7 +9956,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { arguments: arguments, location: location, comments: comments }
     end
 
@@ -9894,7 +10006,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end
 
@@ -9930,7 +10042,7 @@ module SyntaxTree
 
     alias deconstruct child_nodes
 
-    def deconstruct_keys(keys)
+    def deconstruct_keys(_keys)
       { value: value, location: location, comments: comments }
     end