prism 0.19.0 → 0.24.0

data/lib/prism/desugar_compiler.rb

@@ -1,6 +1,216 @@
 # frozen_string_literal: true
 
 module Prism
+  class DesugarAndWriteNode # :nodoc:
+    attr_reader :node, :source, :read_class, :write_class, :arguments
+
+    def initialize(node, source, read_class, write_class, *arguments)
+      @node = node
+      @source = source
+      @read_class = read_class
+      @write_class = write_class
+      @arguments = arguments
+    end
+
+    # Desugar `x &&= y` to `x && x = y`
+    def compile
+      AndNode.new(
+        source,
+        read_class.new(source, *arguments, node.name_loc),
+        write_class.new(source, *arguments, node.name_loc, node.value, node.operator_loc, node.location),
+        node.operator_loc,
+        node.location
+      )
+    end
+  end
+
+  class DesugarOrWriteDefinedNode # :nodoc:
+    attr_reader :node, :source, :read_class, :write_class, :arguments
+
+    def initialize(node, source, read_class, write_class, *arguments)
+      @node = node
+      @source = source
+      @read_class = read_class
+      @write_class = write_class
+      @arguments = arguments
+    end
+
+    # Desugar `x ||= y` to `defined?(x) ? x : x = y`
+    def compile
+      IfNode.new(
+        source,
+        node.operator_loc,
+        DefinedNode.new(source, nil, read_class.new(source, *arguments, node.name_loc), nil, node.operator_loc, node.name_loc),
+        node.operator_loc,
+        StatementsNode.new(source, [read_class.new(source, *arguments, node.name_loc)], node.location),
+        ElseNode.new(
+          source,
+          node.operator_loc,
+          StatementsNode.new(
+            source,
+            [write_class.new(source, *arguments, node.name_loc, node.value, node.operator_loc, node.location)],
+            node.location
+          ),
+          node.operator_loc,
+          node.location
+        ),
+        node.operator_loc,
+        node.location
+      )
+    end
+  end
+
+  class DesugarOperatorWriteNode # :nodoc:
+    attr_reader :node, :source, :read_class, :write_class, :arguments
+
+    def initialize(node, source, read_class, write_class, *arguments)
+      @node = node
+      @source = source
+      @read_class = read_class
+      @write_class = write_class
+      @arguments = arguments
+    end
+
+    # Desugar `x += y` to `x = x + y`
+    def compile
+      write_class.new(
+        source,
+        *arguments,
+        node.name_loc,
+        CallNode.new(
+          source,
+          0,
+          read_class.new(source, *arguments, node.name_loc),
+          nil,
+          node.operator_loc.slice.chomp("="),
+          node.operator_loc.copy(length: node.operator_loc.length - 1),
+          nil,
+          ArgumentsNode.new(source, 0, [node.value], node.value.location),
+          nil,
+          nil,
+          node.location
+        ),
+        node.operator_loc.copy(start_offset: node.operator_loc.end_offset - 1, length: 1),
+        node.location
+      )
+    end
+  end
+
+  class DesugarOrWriteNode # :nodoc:
+    attr_reader :node, :source, :read_class, :write_class, :arguments
+
+    def initialize(node, source, read_class, write_class, *arguments)
+      @node = node
+      @source = source
+      @read_class = read_class
+      @write_class = write_class
+      @arguments = arguments
+    end
+
+    # Desugar `x ||= y` to `x || x = y`
+    def compile
+      OrNode.new(
+        source,
+        read_class.new(source, *arguments, node.name_loc),
+        write_class.new(source, *arguments, node.name_loc, node.value, node.operator_loc, node.location),
+        node.operator_loc,
+        node.location
+      )
+    end
+  end
+
+  private_constant :DesugarAndWriteNode, :DesugarOrWriteNode, :DesugarOrWriteDefinedNode, :DesugarOperatorWriteNode
+
+  class ClassVariableAndWriteNode
+    def desugar # :nodoc:
+      DesugarAndWriteNode.new(self, source, ClassVariableReadNode, ClassVariableWriteNode, name).compile
+    end
+  end
+
+  class ClassVariableOrWriteNode
+    def desugar # :nodoc:
+      DesugarOrWriteDefinedNode.new(self, source, ClassVariableReadNode, ClassVariableWriteNode, name).compile
+    end
+  end
+
+  class ClassVariableOperatorWriteNode
+    def desugar # :nodoc:
+      DesugarOperatorWriteNode.new(self, source, ClassVariableReadNode, ClassVariableWriteNode, name).compile
+    end
+  end
+
+  class ConstantAndWriteNode
+    def desugar # :nodoc:
+      DesugarAndWriteNode.new(self, source, ConstantReadNode, ConstantWriteNode, name).compile
+    end
+  end
+
+  class ConstantOrWriteNode
+    def desugar # :nodoc:
+      DesugarOrWriteDefinedNode.new(self, source, ConstantReadNode, ConstantWriteNode, name).compile
+    end
+  end
+
+  class ConstantOperatorWriteNode
+    def desugar # :nodoc:
+      DesugarOperatorWriteNode.new(self, source, ConstantReadNode, ConstantWriteNode, name).compile
+    end
+  end
+
+  class GlobalVariableAndWriteNode
+    def desugar # :nodoc:
+      DesugarAndWriteNode.new(self, source, GlobalVariableReadNode, GlobalVariableWriteNode, name).compile
+    end
+  end
+
+  class GlobalVariableOrWriteNode
+    def desugar # :nodoc:
+      DesugarOrWriteDefinedNode.new(self, source, GlobalVariableReadNode, GlobalVariableWriteNode, name).compile
+    end
+  end
+
+  class GlobalVariableOperatorWriteNode
+    def desugar # :nodoc:
+      DesugarOperatorWriteNode.new(self, source, GlobalVariableReadNode, GlobalVariableWriteNode, name).compile
+    end
+  end
+
+  class InstanceVariableAndWriteNode
+    def desugar # :nodoc:
+      DesugarAndWriteNode.new(self, source, InstanceVariableReadNode, InstanceVariableWriteNode, name).compile
+    end
+  end
+
+  class InstanceVariableOrWriteNode
+    def desugar # :nodoc:
+      DesugarOrWriteNode.new(self, source, InstanceVariableReadNode, InstanceVariableWriteNode, name).compile
+    end
+  end
+
+  class InstanceVariableOperatorWriteNode
+    def desugar # :nodoc:
+      DesugarOperatorWriteNode.new(self, source, InstanceVariableReadNode, InstanceVariableWriteNode, name).compile
+    end
+  end
+
+  class LocalVariableAndWriteNode
+    def desugar # :nodoc:
+      DesugarAndWriteNode.new(self, source, LocalVariableReadNode, LocalVariableWriteNode, name, depth).compile
+    end
+  end
+
+  class LocalVariableOrWriteNode
+    def desugar # :nodoc:
+      DesugarOrWriteNode.new(self, source, LocalVariableReadNode, LocalVariableWriteNode, name, depth).compile
+    end
+  end
+
+  class LocalVariableOperatorWriteNode
+    def desugar # :nodoc:
+      DesugarOperatorWriteNode.new(self, source, LocalVariableReadNode, LocalVariableWriteNode, name, depth).compile
+    end
+  end
+
   # DesugarCompiler is a compiler that desugars Ruby code into a more primitive
   # form. This is useful for consumers that want to deal with fewer node types.
   class DesugarCompiler < MutationCompiler
@@ -10,7 +220,7 @@ module Prism
     #
     # @@foo && @@foo = bar
     def visit_class_variable_and_write_node(node)
-      desugar_and_write_node(node, ClassVariableReadNode, ClassVariableWriteNode, node.name)
+      node.desugar
     end
 
     # @@foo ||= bar
@@ -19,7 +229,7 @@ module Prism
     #
     # defined?(@@foo) ? @@foo : @@foo = bar
     def visit_class_variable_or_write_node(node)
-      desugar_or_write_defined_node(node, ClassVariableReadNode, ClassVariableWriteNode, node.name)
+      node.desugar
     end
 
     # @@foo += bar
@@ -28,7 +238,7 @@ module Prism
     #
     # @@foo = @@foo + bar
     def visit_class_variable_operator_write_node(node)
-      desugar_operator_write_node(node, ClassVariableReadNode, ClassVariableWriteNode, node.name)
+      node.desugar
     end
 
     # Foo &&= bar
@@ -37,7 +247,7 @@ module Prism
     #
     # Foo && Foo = bar
     def visit_constant_and_write_node(node)
-      desugar_and_write_node(node, ConstantReadNode, ConstantWriteNode, node.name)
+      node.desugar
     end
 
     # Foo ||= bar
@@ -46,7 +256,7 @@ module Prism
     #
     # defined?(Foo) ? Foo : Foo = bar
     def visit_constant_or_write_node(node)
-      desugar_or_write_defined_node(node, ConstantReadNode, ConstantWriteNode, node.name)
+      node.desugar
     end
 
     # Foo += bar
@@ -55,7 +265,7 @@ module Prism
     #
     # Foo = Foo + bar
     def visit_constant_operator_write_node(node)
-      desugar_operator_write_node(node, ConstantReadNode, ConstantWriteNode, node.name)
+      node.desugar
     end
 
     # $foo &&= bar
@@ -64,7 +274,7 @@ module Prism
     #
     # $foo && $foo = bar
     def visit_global_variable_and_write_node(node)
-      desugar_and_write_node(node, GlobalVariableReadNode, GlobalVariableWriteNode, node.name)
+      node.desugar
     end
 
     # $foo ||= bar
@@ -73,7 +283,7 @@ module Prism
     #
     # defined?($foo) ? $foo : $foo = bar
     def visit_global_variable_or_write_node(node)
-      desugar_or_write_defined_node(node, GlobalVariableReadNode, GlobalVariableWriteNode, node.name)
+      node.desugar
     end
 
     # $foo += bar
@@ -82,7 +292,7 @@ module Prism
     #
     # $foo = $foo + bar
     def visit_global_variable_operator_write_node(node)
-      desugar_operator_write_node(node, GlobalVariableReadNode, GlobalVariableWriteNode, node.name)
+      node.desugar
     end
 
     # @foo &&= bar
@@ -91,7 +301,7 @@ module Prism
     #
     # @foo && @foo = bar
     def visit_instance_variable_and_write_node(node)
-      desugar_and_write_node(node, InstanceVariableReadNode, InstanceVariableWriteNode, node.name)
+      node.desugar
     end
 
     # @foo ||= bar
@@ -100,7 +310,7 @@ module Prism
     #
     # @foo || @foo = bar
     def visit_instance_variable_or_write_node(node)
-      desugar_or_write_node(node, InstanceVariableReadNode, InstanceVariableWriteNode, node.name)
+      node.desugar
     end
 
     # @foo += bar
@@ -109,7 +319,7 @@ module Prism
     #
     # @foo = @foo + bar
     def visit_instance_variable_operator_write_node(node)
-      desugar_operator_write_node(node, InstanceVariableReadNode, InstanceVariableWriteNode, node.name)
+      node.desugar
     end
 
     # foo &&= bar
@@ -118,7 +328,7 @@ module Prism
     #
     # foo && foo = bar
     def visit_local_variable_and_write_node(node)
-      desugar_and_write_node(node, LocalVariableReadNode, LocalVariableWriteNode, node.name, node.depth)
+      node.desugar
     end
 
     # foo ||= bar
@@ -127,7 +337,7 @@ module Prism
     #
     # foo || foo = bar
     def visit_local_variable_or_write_node(node)
-      desugar_or_write_node(node, LocalVariableReadNode, LocalVariableWriteNode, node.name, node.depth)
+      node.desugar
     end
 
     # foo += bar
@@ -136,72 +346,7 @@ module Prism
     #
     # foo = foo + bar
     def visit_local_variable_operator_write_node(node)
-      desugar_operator_write_node(node, LocalVariableReadNode, LocalVariableWriteNode, node.name, node.depth)
-    end
-
-    private
-
-    # Desugar `x &&= y` to `x && x = y`
-    def desugar_and_write_node(node, read_class, write_class, *arguments)
-      AndNode.new(
-        read_class.new(*arguments, node.name_loc),
-        write_class.new(*arguments, node.name_loc, node.value, node.operator_loc, node.location),
-        node.operator_loc,
-        node.location
-      )
-    end
-
-    # Desugar `x += y` to `x = x + y`
-    def desugar_operator_write_node(node, read_class, write_class, *arguments)
-      write_class.new(
-        *arguments,
-        node.name_loc,
-        CallNode.new(
-          0,
-          read_class.new(*arguments, node.name_loc),
-          nil,
-          node.operator_loc.slice.chomp("="),
-          node.operator_loc.copy(length: node.operator_loc.length - 1),
-          nil,
-          ArgumentsNode.new(0, [node.value], node.value.location),
-          nil,
-          nil,
-          node.location
-        ),
-        node.operator_loc.copy(start_offset: node.operator_loc.end_offset - 1, length: 1),
-        node.location
-      )
-    end
-
-    # Desugar `x ||= y` to `x || x = y`
-    def desugar_or_write_node(node, read_class, write_class, *arguments)
-      OrNode.new(
-        read_class.new(*arguments, node.name_loc),
-        write_class.new(*arguments, node.name_loc, node.value, node.operator_loc, node.location),
-        node.operator_loc,
-        node.location
-      )
-    end
-
-    # Desugar `x ||= y` to `defined?(x) ? x : x = y`
-    def desugar_or_write_defined_node(node, read_class, write_class, *arguments)
-      IfNode.new(
-        node.operator_loc,
-        DefinedNode.new(nil, read_class.new(*arguments, node.name_loc), nil, node.operator_loc, node.name_loc),
-        node.operator_loc,
-        StatementsNode.new([read_class.new(*arguments, node.name_loc)], node.location),
-        ElseNode.new(
-          node.operator_loc,
-          StatementsNode.new(
-            [write_class.new(*arguments, node.name_loc, node.value, node.operator_loc, node.location)],
-            node.location
-          ),
-          node.operator_loc,
-          node.location
-        ),
-        node.operator_loc,
-        node.location
-      )
+      node.desugar
     end
   end
 end

data/lib/prism/dot_visitor.rb

@@ -353,10 +353,8 @@ module Prism
       digraph.edge("#{id}:key -> #{node_id(node.key)};")
 
       # value
-      unless (value = node.value).nil?
-        table.field("value", port: true)
-        digraph.edge("#{id}:value -> #{node_id(value)};")
-      end
+      table.field("value", port: true)
+      digraph.edge("#{id}:value -> #{node_id(node.value)};")
 
       # operator_loc
       unless (operator_loc = node.operator_loc).nil?
@@ -488,6 +486,9 @@ module Prism
       table = Table.new("BlockLocalVariableNode")
       id = node_id(node)
 
+      # flags
+      table.field("flags", parameter_flags_inspect(node))
+
       # name
       table.field("name", node.name.inspect)
 
@@ -508,9 +509,6 @@ module Prism
       # locals
       table.field("locals", node.locals.inspect)
 
-      # locals_body_index
-      table.field("locals_body_index", node.locals_body_index.inspect)
-
       # parameters
       unless (parameters = node.parameters).nil?
         table.field("parameters", port: true)
@@ -543,6 +541,9 @@ module Prism
       table = Table.new("BlockParameterNode")
       id = node_id(node)
 
+      # flags
+      table.field("flags", parameter_flags_inspect(node))
+
       # name
       table.field("name", node.name.inspect)
 
@@ -1501,9 +1502,6 @@ module Prism
       # locals
       table.field("locals", node.locals.inspect)
 
-      # locals_body_index
-      table.field("locals_body_index", node.locals_body_index.inspect)
-
       # def_keyword_loc
       table.field("def_keyword_loc", location_inspect(node.def_keyword_loc))
 
@@ -2805,6 +2803,9 @@ module Prism
       table = Table.new("KeywordRestParameterNode")
       id = node_id(node)
 
+      # flags
+      table.field("flags", parameter_flags_inspect(node))
+
       # name
       table.field("name", node.name.inspect)
 
@@ -2833,9 +2834,6 @@ module Prism
       # locals
       table.field("locals", node.locals.inspect)
 
-      # locals_body_index
-      table.field("locals_body_index", node.locals_body_index.inspect)
-
       # operator_loc
       table.field("operator_loc", location_inspect(node.operator_loc))
 
@@ -3404,6 +3402,9 @@ module Prism
       table = Table.new("OptionalKeywordParameterNode")
       id = node_id(node)
 
+      # flags
+      table.field("flags", parameter_flags_inspect(node))
+
       # name
       table.field("name", node.name.inspect)
 
@@ -3428,6 +3429,9 @@ module Prism
       table = Table.new("OptionalParameterNode")
       id = node_id(node)
 
+      # flags
+      table.field("flags", parameter_flags_inspect(node))
+
       # name
       table.field("name", node.name.inspect)
 
@@ -3810,6 +3814,9 @@ module Prism
       table = Table.new("RequiredKeywordParameterNode")
       id = node_id(node)
 
+      # flags
+      table.field("flags", parameter_flags_inspect(node))
+
       # name
       table.field("name", node.name.inspect)
 
@@ -3830,6 +3837,9 @@ module Prism
       table = Table.new("RequiredParameterNode")
       id = node_id(node)
 
+      # flags
+      table.field("flags", parameter_flags_inspect(node))
+
       # name
       table.field("name", node.name.inspect)
 
@@ -3925,6 +3935,9 @@ module Prism
       table = Table.new("RestParameterNode")
       id = node_id(node)
 
+      # flags
+      table.field("flags", parameter_flags_inspect(node))
+
       # name
       table.field("name", node.name.inspect)
 
@@ -4524,6 +4537,7 @@ module Prism
       flags << "safe_navigation" if node.safe_navigation?
       flags << "variable_call" if node.variable_call?
       flags << "attribute_write" if node.attribute_write?
+      flags << "ignore_visibility" if node.ignore_visibility?
       flags.join(", ")
     end
 
@@ -4551,7 +4565,7 @@ module Prism
     # comma-separated list.
     def keyword_hash_node_flags_inspect(node)
       flags = []
-      flags << "static_keys" if node.static_keys?
+      flags << "symbol_keys" if node.symbol_keys?
       flags.join(", ")
     end
 
@@ -4563,6 +4577,14 @@ module Prism
       flags.join(", ")
     end
 
+    # Inspect a node that has parameter_flags flags to display the flags as a
+    # comma-separated list.
+    def parameter_flags_inspect(node)
+      flags = []
+      flags << "repeated_parameter" if node.repeated_parameter?
+      flags.join(", ")
+    end
+
     # Inspect a node that has range_flags flags to display the flags as a
     # comma-separated list.
     def range_flags_inspect(node)