Merge QSymbols into ArrayLiteral

Signed-off-by: Alexandre Terrasa <alexandre.terrasa@shopify.com>

Author: Morriar

lib/syntax_tree/dsl.rb

@@ -649,15 +649,6 @@ def Program(statements)
       Program.new(statements: statements, location: Location.default)
     end
 
-    # Create a new QSymbols node.
-    def QSymbols(beginning, elements)
-      QSymbols.new(
-        beginning: beginning,
-        elements: elements,
-        location: Location.default
-      )
-    end
-
     # Create a new QSymbolsBeg node.
     def QSymbolsBeg(value)
       QSymbolsBeg.new(value: value, location: Location.default)

lib/syntax_tree/field_visitor.rb

@@ -654,13 +654,6 @@ def visit_program(node)
         end
       end
 
-      def visit_qsymbols(node)
-        node(node, "qsymbols") do
-          list("elements", node.elements)
-          comments(node)
-        end
-      end
-
       def visit_qsymbols_beg(node)
         node(node, "qsymbols_beg") { field("value", node.value) }
       end

lib/syntax_tree/mutation_visitor.rb

@@ -591,14 +591,6 @@ def visit_program(node)
         node.copy(statements: visit(node.statements))
       end
 
-      # Visit a QSymbols node.
-      def visit_qsymbols(node)
-        node.copy(
-          beginning: visit(node.beginning),
-          elements: visit_all(node.elements)
-        )
-      end
-
       # Visit a QSymbolsBeg node.
       def visit_qsymbols_beg(node)
         node.copy

lib/syntax_tree/node.rb

@@ -1128,10 +1128,12 @@ def initialize(lbracket)
       def format(q)
         q.group do
           q.text("[")
-          q.indent do
-            lbracket.comments.each do |comment|
-              q.breakable_force
-              comment.format(q)
+          if lbracket.is_a?(LBracket)
+            q.indent do
+              lbracket.comments.each do |comment|
+                q.breakable_force
+                comment.format(q)
+              end
             end
           end
           q.breakable_force
@@ -1211,18 +1213,36 @@ def format(q)
       end
 
       q.group do
-        q.format(lbracket)
+        case lbracket
+        when QSymbolsBeg
+          q.text(lbracket.value)
+        else
+          q.format(lbracket)
+        end
 
         if contents
           q.indent do
             q.breakable_empty
-            q.format(contents)
-            q.if_break { q.text(",") } if q.trailing_comma?
+            case lbracket
+            when QSymbolsBeg
+              q.seplist(contents.parts, BREAKABLE_SPACE_SEPARATOR) do |part|
+                q.text(part.value)
+              end
+            else
+              q.format(contents)
+              q.if_break { q.text(",") } if q.trailing_comma?
+            end
           end
         end
 
         q.breakable_empty
-        q.text("]")
+
+        case lbracket
+        when QSymbolsBeg
+          q.text(lbracket.value[-1] == "{" ? "}" : "]")
+        else
+          q.text("]")
+        end
       end
     end
 
@@ -1396,8 +1416,7 @@ def ===(other)
   module AssignFormatting
     def self.skip_indent?(value)
       case value
-      when ArrayLiteral, HashLiteral, Heredoc, Lambda, QSymbols, QWords,
-           Symbols, Words
+      when ArrayLiteral, HashLiteral, Heredoc, Lambda, QWords, Symbols, Words
         true
       when CallNode
         skip_indent?(value.receiver)
@@ -8613,86 +8632,6 @@ def ===(other)
     end
   end
 
-  # QSymbols represents a symbol literal array without interpolation.
-  #
-  #     %i[one two three]
-  #
-  class QSymbols < Node
-    # [QSymbolsBeg] the token that opens this array literal
-    attr_reader :beginning
-
-    # [Array[ TStringContent ]] the elements of the array
-    attr_reader :elements
-
-    # [Array[ Comment | EmbDoc ]] the comments attached to this node
-    attr_reader :comments
-
-    def initialize(beginning:, elements:, location:)
-      @beginning = beginning
-      @elements = elements
-      @location = location
-      @comments = []
-    end
-
-    def accept(visitor)
-      visitor.visit_qsymbols(self)
-    end
-
-    def child_nodes
-      []
-    end
-
-    def copy(beginning: nil, elements: nil, location: nil)
-      node =
-        QSymbols.new(
-          beginning: beginning || self.beginning,
-          elements: elements || self.elements,
-          location: location || self.location
-        )
-
-      node.comments.concat(comments.map(&:copy))
-      node
-    end
-
-    alias deconstruct child_nodes
-
-    def deconstruct_keys(_keys)
-      {
-        beginning: beginning,
-        elements: elements,
-        location: location,
-        comments: comments
-      }
-    end
-
-    def format(q)
-      opening, closing = "%i[", "]"
-
-      if elements.any? { |element| element.match?(/[\[\]]/) }
-        opening = beginning.value
-        closing = Quotes.matching(opening[2])
-      end
-
-      q.text(opening)
-      q.group do
-        q.indent do
-          q.breakable_empty
-          q.seplist(
-            elements,
-            ArrayLiteral::BREAKABLE_SPACE_SEPARATOR
-          ) { |element| q.format(element) }
-        end
-        q.breakable_empty
-      end
-      q.text(closing)
-    end
-
-    def ===(other)
-      other.is_a?(QSymbols) && beginning === other.beginning &&
-        ArrayMatch.call(elements, other.elements)
-    end
-  end
-
   # QSymbolsBeg represents the beginning of a symbol literal array.
   #
   #     %i[one two three]

lib/syntax_tree/parser.rb

@@ -617,8 +617,8 @@ def on_args_new
     end
 
     # :call-seq:
-    #   on_array: ((nil | Args) contents) ->
-    #     ArrayLiteral | QSymbols | QWords | Symbols | Words
+    #   on_array: ((nil | Args | Array [ TStringContent ]) contents) ->
+    #     ArrayLiteral | QWords | Symbols | Words
     def on_array(contents)
       if !contents || contents.is_a?(Args)
         lbracket = consume_token(LBracket)
@@ -629,6 +629,14 @@ def on_array(contents)
           contents: contents,
           location: lbracket.location.to(rbracket.location)
         )
+      elsif contents.is_a?(ArrayLiteral)
+        tstring_end = consume_tstring_end(contents.lbracket.location)
+
+        ArrayLiteral.new(
+          lbracket: contents.lbracket,
+          contents: contents.contents,
+          location: contents.location.to(tstring_end.location)
+        )
       else
         tstring_end = consume_tstring_end(contents.beginning.location)
 
@@ -2999,11 +3007,14 @@ def nearest_nodes(node, comment)
     end
 
     # :call-seq:
-    #   on_qsymbols_add: (QSymbols qsymbols, TStringContent element) -> QSymbols
+    #   on_qsymbols_add: (ArrayLiteral qsymbols, TStringContent element) ->
+    #     ArrayLiteral
     def on_qsymbols_add(qsymbols, element)
-      QSymbols.new(
-        beginning: qsymbols.beginning,
-        elements: qsymbols.elements << element,
+      qsymbols.contents.parts << element
+
+      ArrayLiteral.new(
+        lbracket: qsymbols.lbracket,
+        contents: qsymbols.contents,
         location: qsymbols.location.to(element.location)
       )
     end
@@ -3028,13 +3039,16 @@ def on_qsymbols_beg(value)
     end
 
     # :call-seq:
-    #   on_qsymbols_new: () -> QSymbols
+    #   on_qsymbols_new: () -> ArrayLiteral
     def on_qsymbols_new
       beginning = consume_token(QSymbolsBeg)
 
-      QSymbols.new(
-        beginning: beginning,
-        elements: [],
+      ArrayLiteral.new(
+        lbracket: beginning,
+        contents: Args.new(
+          parts: [],
+          location: beginning.location
+        ),
         location: beginning.location
       )
     end

lib/syntax_tree/translation/parser.rb

@@ -254,7 +254,15 @@ def visit_args_forward(node)
         def visit_array(node)
           s(
             :array,
-            node.contents ? visit_all(node.contents.parts) : [],
+            if node.contents.nil?
+              []
+            elsif node.lbracket.is_a?(QSymbolsBeg)
+              visit_all(node.contents.parts.map do |part|
+                SymbolLiteral.new(value: part, location: part.location)
+              end)
+            else
+              visit_all(node.contents.parts)
+            end,
             if node.lbracket.nil?
               smap_collection_bare(srange_node(node))
             else
@@ -1898,22 +1906,6 @@ def visit_program(node)
           visit(node.statements)
         end
 
-        # Visit a QSymbols node.
-        def visit_qsymbols(node)
-          parts =
-            node.elements.map do |element|
-              SymbolLiteral.new(value: element, location: element.location)
-            end
-
-          visit_array(
-            ArrayLiteral.new(
-              lbracket: node.beginning,
-              contents: Args.new(parts: parts, location: node.location),
-              location: node.location
-            )
-          )
-        end
-
         # Visit a QWords node.
         def visit_qwords(node)
           visit_array(

lib/syntax_tree/visitor.rb

@@ -275,9 +275,6 @@ class Visitor < BasicVisitor
     # Visit a Program node.
     alias visit_program visit_child_nodes
 
-    # Visit a QSymbols node.
-    alias visit_qsymbols visit_child_nodes
-
     # Visit a QSymbolsBeg node.
     alias visit_qsymbols_beg visit_child_nodes
 

lib/syntax_tree/yarv/compiler.rb

@@ -126,7 +126,14 @@ def self.compile(node)
 
         visit_methods do
           def visit_array(node)
-            node.contents ? visit_all(node.contents.parts) : []
+            return [] unless node.contents
+
+            case node.lbracket
+            when QSymbolsBeg
+              visit_all(node.contents.parts).map(&:to_sym)
+            else
+              visit_all(node.contents.parts)
+            end
           end
 
           def visit_bare_assoc_hash(node)
@@ -171,10 +178,6 @@ def visit_mrhs(node)
             visit_all(node.parts)
           end
 
-          def visit_qsymbols(node)
-            node.elements.map { |element| visit(element).to_sym }
-          end
-
           def visit_qwords(node)
             visit_all(node.elements)
           end
@@ -1409,10 +1412,6 @@ def visit_program(node)
         top_iseq
       end
 
-      def visit_qsymbols(node)
-        iseq.duparray(node.accept(RubyVisitor.new))
-      end
-
       def visit_qwords(node)
         if options.frozen_string_literal?
           iseq.duparray(node.accept(RubyVisitor.new))

test/node_test.rb

@@ -774,7 +774,7 @@ def test_program
     end
 
     def test_qsymbols
-      assert_node(QSymbols, "%i[one two three]")
+      assert_node(ArrayLiteral, "%i[one two three]")
     end
 
     def test_qwords