prism 1.3.0 → 1.5.0

data/lib/prism/node_ext.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+# :markup: markdown
 
+#--
 # 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
     def deprecated(*replacements) # :nodoc:
@@ -9,7 +12,7 @@ module Prism
       location = location[0].label if location
       suggest = replacements.map { |replacement| "#{self.class}##{replacement}" }
 
-      warn(<<~MSG, category: :deprecated)
+      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")}

data/lib/prism/pack.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
+# :markup: markdown
 # typed: ignore
 
+#
 module Prism
   # A parser for the pack template language.
   module Pack

data/lib/prism/parse_result/comments.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# :markup: markdown
 
 module Prism
   class ParseResult < Result

data/lib/prism/parse_result/errors.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# :markup: markdown
 
 require "stringio"
 

data/lib/prism/parse_result/newlines.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# :markup: markdown
 
 module Prism
   class ParseResult < Result
@@ -63,7 +64,7 @@ module Prism
 
   class Node
     def newline_flag? # :nodoc:
-      @newline_flag ? true : false
+      !!defined?(@newline_flag)
     end
 
     def newline_flag!(lines) # :nodoc:

data/lib/prism/parse_result.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# :markup: markdown
 
 module Prism
   # This represents a source of Ruby code that has been parsed. It is used in
@@ -48,6 +49,16 @@ module Prism
       @offsets = offsets # set after parsing is done
     end
 
+    # Replace the value of start_line with the given value.
+    def replace_start_line(start_line)
+      @start_line = start_line
+    end
+
+    # Replace the value of offsets with the given value.
+    def replace_offsets(offsets)
+      @offsets.replace(offsets)
+    end
+
     # Returns the encoding of the source code, which is set by parameters to the
     # parser or by the encoding magic comment.
     def encoding
@@ -132,6 +143,13 @@ module Prism
       code_units_offset(byte_offset, encoding) - code_units_offset(line_start(byte_offset), encoding)
     end
 
+    # Freeze this object and the objects it contains.
+    def deep_freeze
+      source.freeze
+      offsets.freeze
+      freeze
+    end
+
     private
 
     # Binary search through the offsets to find the line number for the given
@@ -854,5 +872,40 @@ module Prism
       location
       super
     end
+
+    # Freeze this object and the objects it contains.
+    def deep_freeze
+      value.freeze
+      location.freeze
+      freeze
+    end
+  end
+
+  # This object is passed to the various Prism.* methods that accept the
+  # `scopes` option as an element of the list. It defines both the local
+  # variables visible at that scope as well as the forwarding parameters
+  # available at that scope.
+  class Scope
+    # The list of local variables that are defined in this scope. This should be
+    # defined as an array of symbols.
+    attr_reader :locals
+
+    # The list of local variables that are forwarded to the next scope. This
+    # should by defined as an array of symbols containing the specific values of
+    # :*, :**, :&, or :"...".
+    attr_reader :forwarding
+
+    # Create a new scope object with the given locals and forwarding.
+    def initialize(locals, forwarding)
+      @locals = locals
+      @forwarding = forwarding
+    end
+  end
+
+  # Create a new scope with the given locals and forwarding options that is
+  # suitable for passing into one of the Prism.* methods that accepts the
+  # `scopes` option.
+  def self.scope(locals: [], forwarding: [])
+    Scope.new(locals, forwarding)
   end
 end

data/lib/prism/pattern.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# :markup: markdown
 
 module Prism
   # A pattern is an object that wraps a Ruby pattern matching expression. The

data/lib/prism/polyfill/append_as_bytes.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Polyfill for String#append_as_bytes, which didn't exist until Ruby 3.4.
+if !("".respond_to?(:append_as_bytes))
+  String.include(
+    Module.new {
+      def append_as_bytes(*args)
+        args.each do |arg|
+          arg = Integer === arg ? [arg].pack("C") : arg.b
+          self.<<(arg) # steep:ignore
+        end
+      end
+    }
+  )
+end

data/lib/prism/polyfill/scan_byte.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "strscan"
+
+# Polyfill for StringScanner#scan_byte, which didn't exist until Ruby 3.4.
+if !(StringScanner.instance_methods.include?(:scan_byte))
+  StringScanner.include(
+    Module.new {
+      def scan_byte # :nodoc:
+        get_byte&.b&.ord
+      end
+    }
+  )
+end

data/lib/prism/polyfill/warn.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Polyfill for Kernel#warn with the category parameter. Not all Ruby engines
+# have Method#parameters implemented, so we check the arity instead if
+# necessary.
+if (method = Kernel.instance_method(:warn)).respond_to?(:parameters) ? method.parameters.none? { |_, name| name == :category } : (method.arity == -1)
+  Kernel.prepend(
+    Module.new {
+      def warn(*msgs, uplevel: nil, category: nil) # :nodoc:
+        uplevel =
+          case uplevel
+          when nil
+            1
+          when Integer
+            uplevel + 1
+          else
+            uplevel.to_int + 1
+          end
+
+        super(*msgs, uplevel: uplevel)
+      end
+    }
+  )
+
+  Object.prepend(
+    Module.new {
+      def warn(*msgs, uplevel: nil, category: nil) # :nodoc:
+        uplevel =
+          case uplevel
+          when nil
+            1
+          when Integer
+            uplevel + 1
+          else
+            uplevel.to_int + 1
+          end
+
+        super(*msgs, uplevel: uplevel)
+      end
+    }
+  )
+end

data/lib/prism/reflection.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
+# :markup: markdown
 
 =begin
+--
 This file is generated by the templates/template.rb script and should not be
 modified manually. See templates/lib/prism/reflection.rb.erb
 if you are looking to modify the template
+++
 =end
 
 module Prism
@@ -334,7 +337,7 @@ module Prism
       when :parameters_node
         [NodeListField.new(:requireds), NodeListField.new(:optionals), OptionalNodeField.new(:rest), NodeListField.new(:posts), NodeListField.new(:keywords), OptionalNodeField.new(:keyword_rest), OptionalNodeField.new(:block)]
       when :parentheses_node
-        [OptionalNodeField.new(:body), LocationField.new(:opening_loc), LocationField.new(:closing_loc)]
+        [FlagsField.new(:flags, [:multiple_statements?]), OptionalNodeField.new(:body), LocationField.new(:opening_loc), LocationField.new(:closing_loc)]
       when :pinned_expression_node
         [NodeField.new(:expression), LocationField.new(:operator_loc), LocationField.new(:lparen_loc), LocationField.new(:rparen_loc)]
       when :pinned_variable_node
@@ -360,7 +363,7 @@ module Prism
       when :rescue_modifier_node
         [NodeField.new(:expression), LocationField.new(:keyword_loc), NodeField.new(:rescue_expression)]
       when :rescue_node
-        [LocationField.new(:keyword_loc), NodeListField.new(:exceptions), OptionalLocationField.new(:operator_loc), OptionalNodeField.new(:reference), OptionalNodeField.new(:statements), OptionalNodeField.new(:subsequent)]
+        [LocationField.new(:keyword_loc), NodeListField.new(:exceptions), OptionalLocationField.new(:operator_loc), OptionalNodeField.new(:reference), OptionalLocationField.new(:then_keyword_loc), OptionalNodeField.new(:statements), OptionalNodeField.new(:subsequent)]
       when :rest_parameter_node
         [FlagsField.new(:flags, [:repeated_parameter?]), OptionalConstantField.new(:name), OptionalLocationField.new(:name_loc), LocationField.new(:operator_loc)]
       when :retry_node

data/lib/prism/relocation.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# :markup: markdown
 
 module Prism
   # Prism parses deterministically for the same input. This provides a nice