prism 0.24.0 → 0.29.0

data/lib/prism/debug.rb

@@ -55,7 +55,7 @@ module Prism
       verbose, $VERBOSE = $VERBOSE, nil
 
       begin
-        locals = []
+        locals = [] #: Array[Array[Symbol | Integer]]
         stack = [ISeq.new(RubyVM::InstructionSequence.compile(source).to_a)]
 
         while (iseq = stack.pop)
@@ -96,8 +96,8 @@ module Prism
     # For the given source, parses with prism and returns a list of all of the
     # sets of local variables that were encountered.
     def self.prism_locals(source)
-      locals = []
-      stack = [Prism.parse(source).value]
+      locals = [] #: Array[Array[Symbol | Integer]]
+      stack = [Prism.parse(source).value] #: Array[Prism::node]
 
       while (node = stack.pop)
         case node
@@ -202,5 +202,48 @@ module Prism
     def self.newlines(source)
       Prism.parse(source).source.offsets
     end
+
+    # A wrapping around prism's internal encoding data structures. This is used
+    # for reflection and debugging purposes.
+    class Encoding
+      # The name of the encoding, that can be passed to Encoding.find.
+      attr_reader :name
+
+      # Initialize a new encoding with the given name and whether or not it is
+      # a multibyte encoding.
+      def initialize(name, multibyte)
+        @name = name
+        @multibyte = multibyte
+      end
+
+      # Whether or not the encoding is a multibyte encoding.
+      def multibyte?
+        @multibyte
+      end
+
+      # Returns the number of bytes of the first character in the source string,
+      # if it is valid for the encoding. Otherwise, returns 0.
+      def width(source)
+        Encoding._width(name, source)
+      end
+
+      # Returns true if the first character in the source string is a valid
+      # alphanumeric character for the encoding.
+      def alnum?(source)
+        Encoding._alnum?(name, source)
+      end
+
+      # Returns true if the first character in the source string is a valid
+      # alphabetic character for the encoding.
+      def alpha?(source)
+        Encoding._alpha?(name, source)
+      end
+
+      # Returns true if the first character in the source string is a valid
+      # uppercase character for the encoding.
+      def upper?(source)
+        Encoding._upper?(name, source)
+      end
+    end
   end
 end

data/lib/prism/desugar_compiler.rb

@@ -73,6 +73,8 @@ module Prism
 
     # Desugar `x += y` to `x = x + y`
     def compile
+      binary_operator_loc = node.binary_operator_loc.chop
+
       write_class.new(
         source,
         *arguments,
@@ -82,15 +84,15 @@ module Prism
           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),
+          binary_operator_loc.slice.to_sym,
+          binary_operator_loc,
           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.binary_operator_loc.copy(start_offset: node.binary_operator_loc.end_offset - 1, length: 1),
         node.location
       )
     end

data/lib/prism/dispatcher.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 =begin
 This file is generated by the templates/template.rb script and should not be
 modified manually. See templates/lib/prism/dispatcher.rb.erb
@@ -761,6 +762,14 @@ module Prism
       listeners[:on_interpolated_x_string_node_leave]&.each { |listener| listener.on_interpolated_x_string_node_leave(node) }
     end
 
+    # Dispatch enter and leave events for ItParametersNode nodes and continue
+    # walking the tree.
+    def visit_it_parameters_node(node)
+      listeners[:on_it_parameters_node_enter]&.each { |listener| listener.on_it_parameters_node_enter(node) }
+      super
+      listeners[:on_it_parameters_node_leave]&.each { |listener| listener.on_it_parameters_node_leave(node) }
+    end
+
     # Dispatch enter and leave events for KeywordHashNode nodes and continue
     # walking the tree.
     def visit_keyword_hash_node(node)
@@ -1113,6 +1122,14 @@ module Prism
       listeners[:on_self_node_leave]&.each { |listener| listener.on_self_node_leave(node) }
     end
 
+    # Dispatch enter and leave events for ShareableConstantNode nodes and continue
+    # walking the tree.
+    def visit_shareable_constant_node(node)
+      listeners[:on_shareable_constant_node_enter]&.each { |listener| listener.on_shareable_constant_node_enter(node) }
+      super
+      listeners[:on_shareable_constant_node_leave]&.each { |listener| listener.on_shareable_constant_node_leave(node) }
+    end
+
     # Dispatch enter and leave events for SingletonClassNode nodes and continue
     # walking the tree.
     def visit_singleton_class_node(node)
@@ -1778,6 +1795,12 @@ module Prism
         listeners[:on_interpolated_x_string_node_leave]&.each { |listener| listener.on_interpolated_x_string_node_leave(node) }
       end
 
+      # Dispatch enter and leave events for ItParametersNode nodes.
+      def visit_it_parameters_node(node)
+        listeners[:on_it_parameters_node_enter]&.each { |listener| listener.on_it_parameters_node_enter(node) }
+        listeners[:on_it_parameters_node_leave]&.each { |listener| listener.on_it_parameters_node_leave(node) }
+      end
+
       # Dispatch enter and leave events for KeywordHashNode nodes.
       def visit_keyword_hash_node(node)
         listeners[:on_keyword_hash_node_enter]&.each { |listener| listener.on_keyword_hash_node_enter(node) }
@@ -2042,6 +2065,12 @@ module Prism
         listeners[:on_self_node_leave]&.each { |listener| listener.on_self_node_leave(node) }
       end
 
+      # Dispatch enter and leave events for ShareableConstantNode nodes.
+      def visit_shareable_constant_node(node)
+        listeners[:on_shareable_constant_node_enter]&.each { |listener| listener.on_shareable_constant_node_enter(node) }
+        listeners[:on_shareable_constant_node_leave]&.each { |listener| listener.on_shareable_constant_node_leave(node) }
+      end
+
       # Dispatch enter and leave events for SingletonClassNode nodes.
       def visit_singleton_class_node(node)
         listeners[:on_singleton_class_node_enter]&.each { |listener| listener.on_singleton_class_node_enter(node) }

data/lib/prism/dot_visitor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 =begin
 This file is generated by the templates/template.rb script and should not be
 modified manually. See templates/lib/prism/dot_visitor.rb.erb
@@ -24,7 +25,7 @@ module Prism
         if port
           "<tr><td align=\"left\" colspan=\"2\" port=\"#{name}\">#{name}</td></tr>"
         else
-          "<tr><td align=\"left\">#{name}</td><td>#{CGI.escapeHTML(value)}</td></tr>"
+          "<tr><td align=\"left\">#{name}</td><td>#{CGI.escapeHTML(value || raise)}</td></tr>"
         end
       end
     end
@@ -764,11 +765,11 @@ module Prism
       # write_name
       table.field("write_name", node.write_name.inspect)
 
-      # operator
-      table.field("operator", node.operator.inspect)
+      # binary_operator
+      table.field("binary_operator", node.binary_operator.inspect)
 
-      # operator_loc
-      table.field("operator_loc", location_inspect(node.operator_loc))
+      # binary_operator_loc
+      table.field("binary_operator_loc", location_inspect(node.binary_operator_loc))
 
       # value
       table.field("value", port: true)
@@ -1059,15 +1060,15 @@ module Prism
       # name_loc
       table.field("name_loc", location_inspect(node.name_loc))
 
-      # operator_loc
-      table.field("operator_loc", location_inspect(node.operator_loc))
+      # binary_operator_loc
+      table.field("binary_operator_loc", location_inspect(node.binary_operator_loc))
 
       # value
       table.field("value", port: true)
       digraph.edge("#{id}:value -> #{node_id(node.value)};")
 
-      # operator
-      table.field("operator", node.operator.inspect)
+      # binary_operator
+      table.field("binary_operator", node.binary_operator.inspect)
 
       digraph.nodes << <<~DOT
         #{id} [
@@ -1155,9 +1156,7 @@ module Prism
       digraph.edge("#{id}:value -> #{node_id(node.value)};")
 
       # operator_loc
-      unless (operator_loc = node.operator_loc).nil?
-        table.field("operator_loc", location_inspect(operator_loc))
-      end
+      table.field("operator_loc", location_inspect(node.operator_loc))
 
       digraph.nodes << <<~DOT
         #{id} [
@@ -1206,15 +1205,15 @@ module Prism
       # name_loc
       table.field("name_loc", location_inspect(node.name_loc))
 
-      # operator_loc
-      table.field("operator_loc", location_inspect(node.operator_loc))
+      # binary_operator_loc
+      table.field("binary_operator_loc", location_inspect(node.binary_operator_loc))
 
       # value
       table.field("value", port: true)
       digraph.edge("#{id}:value -> #{node_id(node.value)};")
 
-      # operator
-      table.field("operator", node.operator.inspect)
+      # binary_operator
+      table.field("binary_operator", node.binary_operator.inspect)
 
       digraph.nodes << <<~DOT
         #{id} [
@@ -1288,13 +1287,15 @@ module Prism
         digraph.edge("#{id}:parent -> #{node_id(parent)};")
       end
 
-      # child
-      table.field("child", port: true)
-      digraph.edge("#{id}:child -> #{node_id(node.child)};")
+      # name
+      table.field("name", node.name.inspect)
 
       # delimiter_loc
       table.field("delimiter_loc", location_inspect(node.delimiter_loc))
 
+      # name_loc
+      table.field("name_loc", location_inspect(node.name_loc))
+
       digraph.nodes << <<~DOT
         #{id} [
           label=<#{table.to_dot.gsub(/\n/, "\n  ")}>
@@ -1313,15 +1314,15 @@ module Prism
       table.field("target", port: true)
       digraph.edge("#{id}:target -> #{node_id(node.target)};")
 
-      # operator_loc
-      table.field("operator_loc", location_inspect(node.operator_loc))
+      # binary_operator_loc
+      table.field("binary_operator_loc", location_inspect(node.binary_operator_loc))
 
       # value
       table.field("value", port: true)
       digraph.edge("#{id}:value -> #{node_id(node.value)};")
 
-      # operator
-      table.field("operator", node.operator.inspect)
+      # binary_operator
+      table.field("binary_operator", node.binary_operator.inspect)
 
       digraph.nodes << <<~DOT
         #{id} [
@@ -1368,13 +1369,15 @@ module Prism
         digraph.edge("#{id}:parent -> #{node_id(parent)};")
       end
 
-      # child
-      table.field("child", port: true)
-      digraph.edge("#{id}:child -> #{node_id(node.child)};")
+      # name
+      table.field("name", node.name.inspect)
 
       # delimiter_loc
       table.field("delimiter_loc", location_inspect(node.delimiter_loc))
 
+      # name_loc
+      table.field("name_loc", location_inspect(node.name_loc))
+
       digraph.nodes << <<~DOT
         #{id} [
           label=<#{table.to_dot.gsub(/\n/, "\n  ")}>
@@ -1773,6 +1776,9 @@ module Prism
       table = Table.new("FloatNode")
       id = node_id(node)
 
+      # value
+      table.field("value", node.value.inspect)
+
       digraph.nodes << <<~DOT
         #{id} [
           label=<#{table.to_dot.gsub(/\n/, "\n  ")}>
@@ -1910,15 +1916,15 @@ module Prism
       # name_loc
       table.field("name_loc", location_inspect(node.name_loc))
 
-      # operator_loc
-      table.field("operator_loc", location_inspect(node.operator_loc))
+      # binary_operator_loc
+      table.field("binary_operator_loc", location_inspect(node.binary_operator_loc))
 
       # value
       table.field("value", port: true)
       digraph.edge("#{id}:value -> #{node_id(node.value)};")
 
-      # operator
-      table.field("operator", node.operator.inspect)
+      # binary_operator
+      table.field("binary_operator", node.binary_operator.inspect)
 
       digraph.nodes << <<~DOT
         #{id} [
@@ -2316,11 +2322,11 @@ module Prism
         digraph.edge("#{id}:block -> #{node_id(block)};")
       end
 
-      # operator
-      table.field("operator", node.operator.inspect)
+      # binary_operator
+      table.field("binary_operator", node.binary_operator.inspect)
 
-      # operator_loc
-      table.field("operator_loc", location_inspect(node.operator_loc))
+      # binary_operator_loc
+      table.field("binary_operator_loc", location_inspect(node.binary_operator_loc))
 
       # value
       table.field("value", port: true)
@@ -2465,15 +2471,15 @@ module Prism
       # name_loc
       table.field("name_loc", location_inspect(node.name_loc))
 
-      # operator_loc
-      table.field("operator_loc", location_inspect(node.operator_loc))
+      # binary_operator_loc
+      table.field("binary_operator_loc", location_inspect(node.binary_operator_loc))
 
       # value
       table.field("value", port: true)
       digraph.edge("#{id}:value -> #{node_id(node.value)};")
 
-      # operator
-      table.field("operator", node.operator.inspect)
+      # binary_operator
+      table.field("binary_operator", node.binary_operator.inspect)
 
       digraph.nodes << <<~DOT
         #{id} [
@@ -2580,6 +2586,9 @@ module Prism
       # flags
       table.field("flags", integer_base_flags_inspect(node))
 
+      # value
+      table.field("value", node.value.inspect)
+
       digraph.nodes << <<~DOT
         #{id} [
           label=<#{table.to_dot.gsub(/\n/, "\n  ")}>
@@ -2666,6 +2675,9 @@ module Prism
       table = Table.new("InterpolatedStringNode")
       id = node_id(node)
 
+      # flags
+      table.field("flags", interpolated_string_node_flags_inspect(node))
+
       # opening_loc
       unless (opening_loc = node.opening_loc).nil?
         table.field("opening_loc", location_inspect(opening_loc))
@@ -2768,6 +2780,20 @@ module Prism
       super
     end
 
+    # Visit a ItParametersNode node.
+    def visit_it_parameters_node(node)
+      table = Table.new("ItParametersNode")
+      id = node_id(node)
+
+      digraph.nodes << <<~DOT
+        #{id} [
+          label=<#{table.to_dot.gsub(/\n/, "\n  ")}>
+        ];
+      DOT
+
+      super
+    end
+
     # Visit a KeywordHashNode node.
     def visit_keyword_hash_node(node)
       table = Table.new("KeywordHashNode")
@@ -2902,8 +2928,8 @@ module Prism
       # name_loc
       table.field("name_loc", location_inspect(node.name_loc))
 
-      # operator_loc
-      table.field("operator_loc", location_inspect(node.operator_loc))
+      # binary_operator_loc
+      table.field("binary_operator_loc", location_inspect(node.binary_operator_loc))
 
       # value
       table.field("value", port: true)
@@ -2912,8 +2938,8 @@ module Prism
       # name
       table.field("name", node.name.inspect)
 
-      # operator
-      table.field("operator", node.operator.inspect)
+      # binary_operator
+      table.field("binary_operator", node.binary_operator.inspect)
 
       # depth
       table.field("depth", node.depth.inspect)
@@ -3977,6 +4003,9 @@ module Prism
       table = Table.new("ReturnNode")
       id = node_id(node)
 
+      # flags
+      table.field("flags", return_node_flags_inspect(node))
+
       # keyword_loc
       table.field("keyword_loc", location_inspect(node.keyword_loc))
 
@@ -4009,6 +4038,27 @@ module Prism
       super
     end
 
+    # Visit a ShareableConstantNode node.
+    def visit_shareable_constant_node(node)
+      table = Table.new("ShareableConstantNode")
+      id = node_id(node)
+
+      # flags
+      table.field("flags", shareable_constant_node_flags_inspect(node))
+
+      # write
+      table.field("write", port: true)
+      digraph.edge("#{id}:write -> #{node_id(node.write)};")
+
+      digraph.nodes << <<~DOT
+        #{id} [
+          label=<#{table.to_dot.gsub(/\n/, "\n  ")}>
+        ];
+      DOT
+
+      super
+    end
+
     # Visit a SingletonClassNode node.
     def visit_singleton_class_node(node)
       table = Table.new("SingletonClassNode")
@@ -4064,6 +4114,9 @@ module Prism
       table = Table.new("SourceFileNode")
       id = node_id(node)
 
+      # flags
+      table.field("flags", string_flags_inspect(node))
+
       # filepath
       table.field("filepath", node.filepath.inspect)
 
@@ -4390,6 +4443,11 @@ module Prism
         table.field("conditions", "[]")
       end
 
+      # then_keyword_loc
+      unless (then_keyword_loc = node.then_keyword_loc).nil?
+        table.field("then_keyword_loc", location_inspect(then_keyword_loc))
+      end
+
       # statements
       unless (statements = node.statements).nil?
         table.field("statements", port: true)
@@ -4517,7 +4575,8 @@ module Prism
     # Inspect a node that has arguments_node_flags flags to display the flags as a
     # comma-separated list.
     def arguments_node_flags_inspect(node)
-      flags = []
+      flags = [] #: Array[String]
+      flags << "contains_keywords" if node.contains_keywords?
       flags << "contains_keyword_splat" if node.contains_keyword_splat?
       flags.join(", ")
     end
@@ -4525,7 +4584,7 @@ module Prism
     # Inspect a node that has array_node_flags flags to display the flags as a
     # comma-separated list.
     def array_node_flags_inspect(node)
-      flags = []
+      flags = [] #: Array[String]
       flags << "contains_splat" if node.contains_splat?
       flags.join(", ")
     end
@@ -4533,7 +4592,7 @@ module Prism
     # Inspect a node that has call_node_flags flags to display the flags as a
     # comma-separated list.
     def call_node_flags_inspect(node)
-      flags = []
+      flags = [] #: Array[String]
       flags << "safe_navigation" if node.safe_navigation?
       flags << "variable_call" if node.variable_call?
       flags << "attribute_write" if node.attribute_write?
@@ -4544,7 +4603,7 @@ module Prism
     # Inspect a node that has encoding_flags flags to display the flags as a
     # comma-separated list.
     def encoding_flags_inspect(node)
-      flags = []
+      flags = [] #: Array[String]
       flags << "forced_utf8_encoding" if node.forced_utf8_encoding?
       flags << "forced_binary_encoding" if node.forced_binary_encoding?
       flags.join(", ")
@@ -4553,7 +4612,7 @@ module Prism
     # Inspect a node that has integer_base_flags flags to display the flags as a
     # comma-separated list.
     def integer_base_flags_inspect(node)
-      flags = []
+      flags = [] #: Array[String]
       flags << "binary" if node.binary?
       flags << "decimal" if node.decimal?
       flags << "octal" if node.octal?
@@ -4561,10 +4620,19 @@ module Prism
       flags.join(", ")
     end
 
+    # Inspect a node that has interpolated_string_node_flags flags to display the flags as a
+    # comma-separated list.
+    def interpolated_string_node_flags_inspect(node)
+      flags = [] #: Array[String]
+      flags << "frozen" if node.frozen?
+      flags << "mutable" if node.mutable?
+      flags.join(", ")
+    end
+
     # Inspect a node that has keyword_hash_node_flags flags to display the flags as a
     # comma-separated list.
     def keyword_hash_node_flags_inspect(node)
-      flags = []
+      flags = [] #: Array[String]
       flags << "symbol_keys" if node.symbol_keys?
       flags.join(", ")
     end
@@ -4572,7 +4640,7 @@ module Prism
     # Inspect a node that has loop_flags flags to display the flags as a
     # comma-separated list.
     def loop_flags_inspect(node)
-      flags = []
+      flags = [] #: Array[String]
       flags << "begin_modifier" if node.begin_modifier?
       flags.join(", ")
     end
@@ -4580,7 +4648,7 @@ module Prism
     # Inspect a node that has parameter_flags flags to display the flags as a
     # comma-separated list.
     def parameter_flags_inspect(node)
-      flags = []
+      flags = [] #: Array[String]
       flags << "repeated_parameter" if node.repeated_parameter?
       flags.join(", ")
     end
@@ -4588,7 +4656,7 @@ module Prism
     # Inspect a node that has range_flags flags to display the flags as a
     # comma-separated list.
     def range_flags_inspect(node)
-      flags = []
+      flags = [] #: Array[String]
       flags << "exclude_end" if node.exclude_end?
       flags.join(", ")
     end
@@ -4596,7 +4664,7 @@ module Prism
     # Inspect a node that has regular_expression_flags flags to display the flags as a
     # comma-separated list.
     def regular_expression_flags_inspect(node)
-      flags = []
+      flags = [] #: Array[String]
       flags << "ignore_case" if node.ignore_case?
       flags << "extended" if node.extended?
       flags << "multi_line" if node.multi_line?
@@ -4611,20 +4679,39 @@ module Prism
       flags.join(", ")
     end
 
+    # Inspect a node that has return_node_flags flags to display the flags as a
+    # comma-separated list.
+    def return_node_flags_inspect(node)
+      flags = [] #: Array[String]
+      flags << "redundant" if node.redundant?
+      flags.join(", ")
+    end
+
+    # Inspect a node that has shareable_constant_node_flags flags to display the flags as a
+    # comma-separated list.
+    def shareable_constant_node_flags_inspect(node)
+      flags = [] #: Array[String]
+      flags << "literal" if node.literal?
+      flags << "experimental_everything" if node.experimental_everything?
+      flags << "experimental_copy" if node.experimental_copy?
+      flags.join(", ")
+    end
+
     # Inspect a node that has string_flags flags to display the flags as a
     # comma-separated list.
     def string_flags_inspect(node)
-      flags = []
+      flags = [] #: Array[String]
       flags << "forced_utf8_encoding" if node.forced_utf8_encoding?
       flags << "forced_binary_encoding" if node.forced_binary_encoding?
       flags << "frozen" if node.frozen?
+      flags << "mutable" if node.mutable?
       flags.join(", ")
     end
 
     # Inspect a node that has symbol_flags flags to display the flags as a
     # comma-separated list.
     def symbol_flags_inspect(node)
-      flags = []
+      flags = [] #: Array[String]
       flags << "forced_utf8_encoding" if node.forced_utf8_encoding?
       flags << "forced_binary_encoding" if node.forced_binary_encoding?
       flags << "forced_us_ascii_encoding" if node.forced_us_ascii_encoding?