Merge pull request #2761 from ruby/script-lines

Node#script_lines and supporting infra

lib/prism/parse_result.rb

@@ -27,6 +27,11 @@ def encoding
       source.encoding
     end
 
+    # Returns the lines of the source code as an array of strings.
+    def lines
+      source.lines
+    end
+
     # Perform a byteslice on the source code using the given byte offset and
     # byte length.
     def slice(byte_offset, length)
@@ -177,6 +182,11 @@ def inspect
       "#<Prism::Location @start_offset=#{@start_offset} @length=#{@length} start_line=#{start_line}>"
     end
 
+    # Returns all of the lines of the source code associated with this location.
+    def source_lines
+      source.lines
+    end
+
     # The source code that this location represents.
     def slice
       source.slice(start_offset, length)

rbi/prism/parse_result.rbi

@@ -16,6 +16,9 @@ class Prism::Source
   sig { returns(Encoding) }
   def encoding; end
 
+  sig { returns(T::Array[Integer]) }
+  def lines; end
+
   sig { params(byte_offset: Integer, length: Integer).returns(String) }
   def slice(byte_offset, length); end
 
@@ -78,6 +81,9 @@ class Prism::Location
   sig { returns(String) }
   def inspect; end
 
+  sig { returns(T::Array[String]) }
+  def source_lines; end
+
   sig { returns(String) }
   def slice; end
 

sig/prism/parse_result.rbs

@@ -6,6 +6,7 @@ module Prism
 
     def initialize: (String source, ?Integer start_line, ?Array[Integer] offsets) -> void
     def encoding: () -> Encoding
+    def lines: () -> Array[String]
     def slice: (Integer byte_offset, Integer length) -> String
     def line: (Integer byte_offset) -> Integer
     def line_start: (Integer byte_offset) -> Integer
@@ -31,6 +32,7 @@ module Prism
     def comments: () -> Array[comment]
     def copy: (?source: Source, ?start_offset: Integer, ?length: Integer) -> Location
     def chop: () -> Location
+    def source_lines: () -> Array[String]
     def slice: () -> String
     def slice_lines: () -> String
     def start_character_offset: () -> Integer

templates/lib/prism/node.rb.erb

@@ -40,6 +40,15 @@ module Prism
       end
     end
 
+    # Returns all of the lines of the source code associated with this node.
+    def source_lines
+      location.source_lines
+    end
+
+    # An alias for source_lines, used to mimic the API from
+    # RubyVM::AbstractSyntaxTree to make it easier to migrate.
+    alias script_lines source_lines
+
     # Slice the location of the node from the source.
     def slice
       location.slice

templates/rbi/prism/node.rbi.erb

@@ -13,6 +13,12 @@ class Prism::Node
   sig { returns(Integer) }
   def end_offset; end
 
+  sig { returns(T::Array[String]) }
+  def source_lines; end
+
+  sig { returns(T::Array[String]) }
+  def script_lines; end
+
   sig { returns(String) }
   def slice; end
 

templates/sig/prism/node.rbs.erb

@@ -12,6 +12,8 @@ module Prism
 
     def start_offset: () -> Integer
     def end_offset: () -> Integer
+    def source_lines: () -> Array[String]
+    alias script_lines source_lines
     def slice: () -> String
     def slice_lines: () -> String
     def pretty_print: (untyped q) -> untyped