Merge Symbols into ArrayLiteral

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

Author: Morriar

lib/syntax_tree/dsl.rb

@@ -812,15 +812,6 @@ def SymbolLiteral(value)
       SymbolLiteral.new(value: value, location: Location.default)
     end
 
-    # Create a new Symbols node.
-    def Symbols(beginning, elements)
-      Symbols.new(
-        beginning: beginning,
-        elements: elements,
-        location: Location.default
-      )
-    end
-
     # Create a new SymbolsBeg node.
     def SymbolsBeg(value)
       SymbolsBeg.new(value: value, location: Location.default)

lib/syntax_tree/field_visitor.rb

@@ -833,13 +833,6 @@ def visit_symbol_literal(node)
         end
       end
 
-      def visit_symbols(node)
-        node(node, "symbols") do
-          list("elements", node.elements)
-          comments(node)
-        end
-      end
-
       def visit_symbols_beg(node)
         node(node, "symbols_beg") { field("value", node.value) }
       end

lib/syntax_tree/mutation_visitor.rb

@@ -736,14 +736,6 @@ def visit_symbol_literal(node)
         node.copy(value: visit(node.value))
       end
 
-      # Visit a Symbols node.
-      def visit_symbols(node)
-        node.copy(
-          beginning: visit(node.beginning),
-          elements: visit_all(node.elements)
-        )
-      end
-
       # Visit a SymbolsBeg node.
       def visit_symbols_beg(node)
         node.copy

lib/syntax_tree/node.rb

@@ -1214,7 +1214,7 @@ def format(q)
 
       q.group do
         case lbracket
-        when QSymbolsBeg, QWordsBeg, WordsBeg
+        when QSymbolsBeg, QWordsBeg, WordsBeg, SymbolsBeg
           q.text(lbracket.value)
         else
           q.format(lbracket)
@@ -1228,7 +1228,7 @@ def format(q)
               q.seplist(contents.parts, BREAKABLE_SPACE_SEPARATOR) do |part|
                 q.text(part.value)
               end
-            when WordsBeg
+            when WordsBeg, SymbolsBeg
               q.seplist(contents.parts, BREAKABLE_SPACE_SEPARATOR) do |part|
                 q.format(part)
               end
@@ -1242,7 +1242,7 @@ def format(q)
         q.breakable_empty
 
         case lbracket
-        when QSymbolsBeg, QWordsBeg, WordsBeg
+        when QSymbolsBeg, QWordsBeg, WordsBeg, SymbolsBeg
           q.text(lbracket.value[-1] == "{" ? "}" : "]")
         else
           q.text("]")
@@ -1420,7 +1420,7 @@ def ===(other)
   module AssignFormatting
     def self.skip_indent?(value)
       case value
-      when ArrayLiteral, HashLiteral, Heredoc, Lambda, Symbols
+      when ArrayLiteral, HashLiteral, Heredoc, Lambda
         true
       when CallNode
         skip_indent?(value.receiver)
@@ -10444,82 +10444,6 @@ def ===(other)
     end
   end
 
-  # Symbols represents a symbol array literal with interpolation.
-  #
-  #     %I[one two three]
-  #
-  class Symbols < Node
-    # [SymbolsBeg] the token that opens this array literal
-    attr_reader :beginning
-
-    # [Array[ Word ]] the words in the symbol array literal
-    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_symbols(self)
-    end
-
-    def child_nodes
-      []
-    end
-
-    def copy(beginning: nil, elements: nil, location: nil)
-      Symbols.new(
-        beginning: beginning || self.beginning,
-        elements: elements || self.elements,
-        location: location || self.location
-      )
-    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?(Symbols) && beginning === other.beginning &&
-        ArrayMatch.call(elements, other.elements)
-    end
-  end
-
   # SymbolsBeg represents the start of a symbol array literal with
   # interpolation.
   #

lib/syntax_tree/parser.rb

@@ -3625,11 +3625,13 @@ def on_symbol_literal(value)
     end
 
     # :call-seq:
-    #   on_symbols_add: (Symbols symbols, Word word) -> Symbols
+    #   on_symbols_add: (ArrayLiteral symbols, Word word) -> ArrayLiteral
     def on_symbols_add(symbols, word)
-      Symbols.new(
-        beginning: symbols.beginning,
-        elements: symbols.elements << word,
+      symbols.contents.parts << word
+
+      ArrayLiteral.new(
+        lbracket: symbols.lbracket,
+        contents: symbols.contents,
         location: symbols.location.to(word.location)
       )
     end
@@ -3654,13 +3656,16 @@ def on_symbols_beg(value)
     end
 
     # :call-seq:
-    #   on_symbols_new: () -> Symbols
+    #   on_symbols_new: () -> ArrayLiteral
     def on_symbols_new
       beginning = consume_token(SymbolsBeg)
 
-      Symbols.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

@@ -260,6 +260,20 @@ def visit_array(node)
               visit_all(node.contents.parts.map do |part|
                 SymbolLiteral.new(value: part, location: part.location)
               end)
+            elsif node.lbracket.is_a?(SymbolsBeg)
+              visit_all(node.contents.parts.map do |element|
+                part = element.parts.first
+
+                if element.parts.length == 1 && part.is_a?(TStringContent)
+                  SymbolLiteral.new(value: part, location: part.location)
+                else
+                  DynaSymbol.new(
+                    parts: element.parts,
+                    quote: nil,
+                    location: element.location
+                  )
+                end
+              end)
             else
               visit_all(node.contents.parts)
             end,
@@ -2266,32 +2280,6 @@ def visit_symbol_literal(node)
           )
         end
 
-        # Visit a Symbols node.
-        def visit_symbols(node)
-          parts =
-            node.elements.map do |element|
-              part = element.parts.first
-
-              if element.parts.length == 1 && part.is_a?(TStringContent)
-                SymbolLiteral.new(value: part, location: part.location)
-              else
-                DynaSymbol.new(
-                  parts: element.parts,
-                  quote: nil,
-                  location: element.location
-                )
-              end
-            end
-
-          visit_array(
-            ArrayLiteral.new(
-              lbracket: node.beginning,
-              contents: Args.new(parts: parts, location: node.location),
-              location: node.location
-            )
-          )
-        end
-
         # Visit a TopConstField node.
         def visit_top_const_field(node)
           s(

lib/syntax_tree/visitor.rb

@@ -365,9 +365,6 @@ class Visitor < BasicVisitor
     # Visit a SymbolLiteral node.
     alias visit_symbol_literal visit_child_nodes
 
-    # Visit a Symbols node.
-    alias visit_symbols visit_child_nodes
-
     # Visit a SymbolsBeg node.
     alias visit_symbols_beg visit_child_nodes
 

lib/syntax_tree/yarv/compiler.rb

@@ -129,7 +129,7 @@ def visit_array(node)
             return [] unless node.contents
 
             case node.lbracket
-            when QSymbolsBeg
+            when QSymbolsBeg, SymbolsBeg
               visit_all(node.contents.parts).map(&:to_sym)
             else
               visit_all(node.contents.parts)
@@ -204,10 +204,6 @@ def visit_symbol_literal(node)
             node.value.value.to_sym
           end
 
-          def visit_symbols(node)
-            node.elements.map { |element| visit(element).to_sym }
-          end
-
           def visit_tstring_content(node)
             node.value
           end
@@ -397,6 +393,24 @@ def visit_array(node)
             iseq.newarray(node.contents.parts.length)
           end
           return
+        when SymbolsBeg
+          if (compiled = RubyVisitor.compile(node))
+            iseq.duparray(compiled)
+          else
+            node.contents.parts.each do |element|
+              if element.parts.length == 1 &&
+                   element.parts.first.is_a?(TStringContent)
+                iseq.putobject(element.parts.first.value.to_sym)
+              else
+                length = visit_string_parts(element)
+                iseq.concatstrings(length)
+                iseq.intern
+              end
+            end
+
+            iseq.newarray(node.contents.parts.length)
+          end
+          return
         end
 
         if (compiled = RubyVisitor.compile(node))
@@ -1627,25 +1641,6 @@ def visit_symbol_literal(node)
         iseq.putobject(node.accept(RubyVisitor.new))
       end
 
-      def visit_symbols(node)
-        if (compiled = RubyVisitor.compile(node))
-          iseq.duparray(compiled)
-        else
-          node.elements.each do |element|
-            if element.parts.length == 1 &&
-                 element.parts.first.is_a?(TStringContent)
-              iseq.putobject(element.parts.first.value.to_sym)
-            else
-              length = visit_string_parts(element)
-              iseq.concatstrings(length)
-              iseq.intern
-            end
-          end
-
-          iseq.newarray(node.elements.length)
-        end
-      end
-
       def visit_top_const_ref(node)
         iseq.opt_getconstant_path(constant_names(node))
       end

test/node_test.rb

@@ -889,7 +889,7 @@ def test_symbol_literal
     end
 
     def test_symbols
-      assert_node(Symbols, "%I[one two three]")
+      assert_node(ArrayLiteral, "%I[one two three]")
     end
 
     def test_top_const_field