1 files changed, 162 insertions, 34 deletions

diff --git a/lib/prism/node_ext.rb b/lib/prism/node_ext.rb
index 8674544065..8a6624e76d 100644
--- a/lib/prism/node_ext.rb
+++ b/lib/prism/node_ext.rb
@@ -1,13 +1,37 @@
 # frozen_string_literal: true
+# :markup: markdown
+#--
+# rbs_inline: enabled
 
+#--
 # Here we are reopening the prism module to provide methods on nodes that aren't
 # templated and are meant as convenience methods.
+#++
 module Prism
+  class Node
+    #: (*String replacements) -> void
+    def deprecated(*replacements) # :nodoc:
+      location = caller_locations(1, 1)&.[](0)&.label
+      suggest = replacements.map { |replacement| "#{self.class}##{replacement}" }
+
+      warn(<<~MSG, uplevel: 1, category: :deprecated)
+        [deprecation]: #{self.class}##{location} is deprecated and will be \
+        removed in the next major version. Use #{suggest.join("/")} instead.
+        #{(caller(1, 3) || []).join("\n")}
+      MSG
+    end
+  end
+
   module RegularExpressionOptions # :nodoc:
     # Returns a numeric value that represents the flags that were used to create
     # the regular expression.
-    def options
-      o = flags & (RegularExpressionFlags::IGNORE_CASE | RegularExpressionFlags::EXTENDED | RegularExpressionFlags::MULTI_LINE)
+    #--
+    #: (Integer flags) -> Integer
+    def self.options(flags)
+      o = 0
+      o |= Regexp::IGNORECASE if flags.anybits?(RegularExpressionFlags::IGNORE_CASE)
+      o |= Regexp::EXTENDED if flags.anybits?(RegularExpressionFlags::EXTENDED)
+      o |= Regexp::MULTILINE if flags.anybits?(RegularExpressionFlags::MULTI_LINE)
       o |= Regexp::FIXEDENCODING if flags.anybits?(RegularExpressionFlags::EUC_JP | RegularExpressionFlags::WINDOWS_31J | RegularExpressionFlags::UTF_8)
       o |= Regexp::NOENCODING if flags.anybits?(RegularExpressionFlags::ASCII_8BIT)
       o
@@ -15,67 +39,121 @@ module Prism
   end
 
   class InterpolatedMatchLastLineNode < Node
-    include RegularExpressionOptions
+    # Returns a numeric value that represents the flags that were used to create
+    # the regular expression.
+    #--
+    #: () -> Integer
+    def options
+      RegularExpressionOptions.options(flags)
+    end
   end
 
   class InterpolatedRegularExpressionNode < Node
-    include RegularExpressionOptions
+    # Returns a numeric value that represents the flags that were used to create
+    # the regular expression.
+    #--
+    #: () -> Integer
+    def options
+      RegularExpressionOptions.options(flags)
+    end
   end
 
   class MatchLastLineNode < Node
-    include RegularExpressionOptions
+    # Returns a numeric value that represents the flags that were used to create
+    # the regular expression.
+    #--
+    #: () -> Integer
+    def options
+      RegularExpressionOptions.options(flags)
+    end
   end
 
   class RegularExpressionNode < Node
-    include RegularExpressionOptions
+    # Returns a numeric value that represents the flags that were used to create
+    # the regular expression.
+    #--
+    #: () -> Integer
+    def options
+      RegularExpressionOptions.options(flags)
+    end
   end
 
   private_constant :RegularExpressionOptions
 
   module HeredocQuery # :nodoc:
     # Returns true if this node was represented as a heredoc in the source code.
-    def heredoc?
+    #--
+    #: (String? opening) -> bool?
+    def self.heredoc?(opening)
+      # @type self: InterpolatedStringNode | InterpolatedXStringNode | StringNode | XStringNode
       opening&.start_with?("<<")
     end
   end
 
   class InterpolatedStringNode < Node
-    include HeredocQuery
+    # Returns true if this node was represented as a heredoc in the source code.
+    #--
+    #: () -> bool?
+    def heredoc?
+      HeredocQuery.heredoc?(opening)
+    end
   end
 
   class InterpolatedXStringNode < Node
-    include HeredocQuery
+    # Returns true if this node was represented as a heredoc in the source code.
+    #--
+    #: () -> bool?
+    def heredoc?
+      HeredocQuery.heredoc?(opening)
+    end
   end
 
   class StringNode < Node
-    include HeredocQuery
+    # Returns true if this node was represented as a heredoc in the source code.
+    #--
+    #: () -> bool?
+    def heredoc?
+      HeredocQuery.heredoc?(opening)
+    end
 
     # Occasionally it's helpful to treat a string as if it were interpolated so
     # that there's a consistent interface for working with strings.
+    #--
+    #: () -> InterpolatedStringNode
     def to_interpolated
       InterpolatedStringNode.new(
         source,
+        -1,
+        location,
         frozen? ? InterpolatedStringNodeFlags::FROZEN : 0,
         opening_loc,
-        [copy(opening_loc: nil, closing_loc: nil, location: content_loc)],
-        closing_loc,
-        location
+        [copy(location: content_loc, opening_loc: nil, closing_loc: nil)],
+        closing_loc
       )
     end
   end
 
   class XStringNode < Node
-    include HeredocQuery
+    # Returns true if this node was represented as a heredoc in the source code.
+    #--
+    #: () -> bool?
+    def heredoc?
+      HeredocQuery.heredoc?(opening)
+    end
 
     # Occasionally it's helpful to treat a string as if it were interpolated so
     # that there's a consistent interface for working with strings.
+    #--
+    #: () -> InterpolatedXStringNode
     def to_interpolated
       InterpolatedXStringNode.new(
         source,
+        -1,
+        location,
+        flags,
         opening_loc,
-        [StringNode.new(source, 0, nil, content_loc, nil, unescaped, content_loc)],
-        closing_loc,
-        location
+        [StringNode.new(source, node_id, content_loc, 0, nil, content_loc, nil, unescaped)],
+        closing_loc
       )
     end
   end
@@ -84,6 +162,8 @@ module Prism
 
   class ImaginaryNode < Node
     # Returns the value of the node as a Ruby Complex.
+    #--
+    #: () -> Complex
     def value
       Complex(0, numeric.value)
     end
@@ -91,19 +171,25 @@ module Prism
 
   class RationalNode < Node
     # Returns the value of the node as a Ruby Rational.
+    #--
+    #: () -> Rational
     def value
-      Rational(numeric.is_a?(IntegerNode) ? numeric.value : slice.chomp("r"))
+      Rational(numerator, denominator)
     end
   end
 
   class ConstantReadNode < Node
     # Returns the list of parts for the full name of this constant.
     # For example: [:Foo]
+    #--
+    #: () -> Array[Symbol]
     def full_name_parts
       [name]
     end
 
     # Returns the full name of this constant. For example: "Foo"
+    #--
+    #: () -> String
     def full_name
       name.to_s
     end
@@ -112,11 +198,15 @@ module Prism
   class ConstantWriteNode < Node
     # Returns the list of parts for the full name of this constant.
     # For example: [:Foo]
+    #--
+    #: () -> Array[Symbol]
     def full_name_parts
       [name]
     end
 
     # Returns the full name of this constant. For example: "Foo"
+    #--
+    #: () -> String
     def full_name
       name.to_s
     end
@@ -131,23 +221,26 @@ module Prism
     # local variable
     class DynamicPartsInConstantPathError < StandardError; end
 
-    # An error class raised when missing nodes are found while computing a
+    # An error class raised when error recovery nodes are found while computing a
     # constant path's full name. For example:
     # Foo:: -> raises because the constant path is missing the last part
-    class MissingNodesInConstantPathError < StandardError; end
+    class ErrorRecoveryNodesInConstantPathError < StandardError; end
 
     # Returns the list of parts for the full name of this constant path.
     # For example: [:Foo, :Bar]
+    #--
+    #: () -> Array[Symbol]
     def full_name_parts
       parts = [] #: Array[Symbol]
       current = self #: node?
 
       while current.is_a?(ConstantPathNode)
-        child = current.child
-        if child.is_a?(MissingNode)
-          raise MissingNodesInConstantPathError, "Constant path contains missing nodes. Cannot compute full name"
+        name = current.name
+        if name.nil?
+          raise ErrorRecoveryNodesInConstantPathError, "Constant path contains error recovery nodes. Cannot compute full name"
         end
-        parts.unshift(child.name)
+
+        parts.unshift(name)
         current = current.parent
       end
 
@@ -159,6 +252,8 @@ module Prism
     end
 
     # Returns the full name of this constant path. For example: "Foo::Bar"
+    #--
+    #: () -> String
     def full_name
       full_name_parts.join("::")
     end
@@ -167,9 +262,11 @@ module Prism
   class ConstantPathTargetNode < Node
     # Returns the list of parts for the full name of this constant path.
     # For example: [:Foo, :Bar]
+    #--
+    #: () -> Array[Symbol]
     def full_name_parts
       parts =
-        case parent
+        case (parent = self.parent)
         when ConstantPathNode, ConstantReadNode
           parent.full_name_parts
         when nil
@@ -179,14 +276,16 @@ module Prism
           raise ConstantPathNode::DynamicPartsInConstantPathError, "Constant target path contains dynamic parts. Cannot compute full name"
         end
 
-      if child.is_a?(MissingNode)
-        raise ConstantPathNode::MissingNodesInConstantPathError, "Constant target path contains missing nodes. Cannot compute full name"
+      if (name = self.name).nil?
+        raise ConstantPathNode::ErrorRecoveryNodesInConstantPathError, "Constant target path contains error recovery nodes. Cannot compute full name"
       end
 
-      parts.push(child.name)
+      parts.push(name)
     end
 
     # Returns the full name of this constant path. For example: "Foo::Bar"
+    #--
+    #: () -> String
     def full_name
       full_name_parts.join("::")
     end
@@ -195,11 +294,15 @@ module Prism
   class ConstantTargetNode < Node
     # Returns the list of parts for the full name of this constant.
     # For example: [:Foo]
+    #--
+    #: () -> Array[Symbol]
     def full_name_parts
       [name]
     end
 
     # Returns the full name of this constant. For example: "Foo"
+    #--
+    #: () -> String
     def full_name
       name.to_s
     end
@@ -207,6 +310,8 @@ module Prism
 
   class ParametersNode < Node
     # Mirrors the Method#parameters method.
+    #--
+    #: () -> Array[[Symbol, Symbol] | [Symbol]]
     def signature
       names = [] #: Array[[Symbol, Symbol] | [Symbol]]
 
@@ -216,15 +321,15 @@ module Prism
 
       optionals.each { |param| names << [:opt, param.name] }
 
-      if rest && rest.is_a?(RestParameterNode)
+      if (rest = self.rest).is_a?(RestParameterNode)
         names << [:rest, rest.name || :*]
       end
 
       posts.each do |param|
-        if param.is_a?(MultiTargetNode)
+        case param
+        when MultiTargetNode
           names << [:req]
-        elsif param.is_a?(NoKeywordsParameterNode)
-          # Invalid syntax, e.g. "def f(**nil, ...)" moves the NoKeywordsParameterNode to posts
+        when ErrorRecoveryNode
           raise "Invalid syntax"
         else
           names << [:req, param.name]
@@ -244,7 +349,7 @@ module Prism
 
       keyopt.each { |param| names << [:key, param.name] }
 
-      case keyword_rest
+      case (keyword_rest = self.keyword_rest)
       when ForwardingParameterNode
         names.concat([[:rest, :*], [:keyrest, :**], [:block, :&]])
       when KeywordRestParameterNode
@@ -253,8 +358,31 @@ module Prism
         names << [:nokey]
       end
 
-      names << [:block, block.name || :&] if block
+      case (block = self.block)
+      when BlockParameterNode
+        names << [:block, block.name || :&]
+      when NoBlockParameterNode
+        names << [:noblock]
+      end
+
       names
     end
   end
+
+  class CallNode < Node
+    # When a call node has the attribute_write flag set, it means that the call
+    # is using the attribute write syntax. This is either a method call to []=
+    # or a method call to a method that ends with =. Either way, the = sign is
+    # present in the source.
+    #
+    # Prism returns the message_loc _without_ the = sign attached, because there
+    # can be any amount of space between the message and the = sign. However,
+    # sometimes you want the location of the full message including the inner
+    # space and the = sign. This method provides that.
+    #--
+    #: () -> Location?
+    def full_message_loc
+      attribute_write? ? message_loc&.adjoin("=") : message_loc
+    end
+  end
 end