[ruby/prism] Require arguments to Source.for

ruby/prism@b38010c420

Author: kddnewton

lib/prism/parse_result.rb

@@ -19,9 +19,17 @@ class Source
     # be used instead of `new` and it will return either a `Source` or a
     # specialized and more performant `ASCIISource` if no multibyte characters
     # are present in the source code.
-    #--
-    #: (String source, ?Integer start_line, ?Array[Integer] offsets) -> Source
-    def self.for(source, start_line = 1, offsets = [])
+    #
+    # Note that if you are calling this method manually, you will need to supply
+    # the start_line and offsets parameters. start_line is the line number that
+    # the source starts on, which is typically 1 but can be different if this
+    # source is a subset of a larger source or if this is an eval. offsets is an
+    # array of byte offsets for the start of each line in the source code, which
+    # can be calculated by iterating through the source code and recording the
+    # byte offset whenever a newline character is encountered.
+    #--
+    #: (String source, Integer start_line, Array[Integer] offsets) -> Source
+    def self.for(source, start_line, offsets)
       if source.ascii_only?
         ASCIISource.new(source, start_line, offsets)
       elsif source.encoding == Encoding::BINARY
@@ -55,8 +63,8 @@ def self.for(source, start_line = 1, offsets = [])
 
     # Create a new source object with the given source code.
     #--
-    #: (String source, ?Integer start_line, ?Array[Integer] offsets) -> void
-    def initialize(source, start_line = 1, offsets = [])
+    #: (String source, Integer start_line, Array[Integer] offsets) -> void
+    def initialize(source, start_line, offsets)
       @source = source
       @start_line = start_line # set after parsing is done
       @offsets = offsets # set after parsing is done

prism/templates/lib/prism/dsl.rb.erb

@@ -5,7 +5,7 @@ module Prism
   # The DSL module provides a set of methods that can be used to create prism
   # nodes in a more concise manner. For example, instead of writing:
   #
-  #     source = Prism::Source.for("[1]")
+  #     source = Prism::Source.for("[1]", 1, [])
   #
   #     Prism::ArrayNode.new(
   #       source,
@@ -62,7 +62,7 @@ module Prism
     #--
     #: (String string) -> Source
     def source(string)
-      Source.for(string)
+      Source.for(string, 1, [])
     end
 
     # Create a new Location object.
@@ -136,7 +136,7 @@ module Prism
     #--
     #: () -> Source
     def default_source
-      Source.for("")
+      Source.for("", 1, [])
     end
 
     # The default location object that gets attached to nodes if no location is

prism/templates/lib/prism/serialize.rb.erb

@@ -27,7 +27,7 @@ module Prism
     #: (String input, String serialized, bool freeze) -> ParseResult
     def self.load_parse(input, serialized, freeze)
       input = input.dup
-      source = Source.for(input)
+      source = Source.for(input, 1, [])
       loader = Loader.new(source, serialized)
 
                        loader.load_header
@@ -81,7 +81,7 @@ module Prism
     #--
     #: (String input, String serialized, bool freeze) -> LexResult
     def self.load_lex(input, serialized, freeze)
-      source = Source.for(input)
+      source = Source.for(input, 1, [])
       loader = Loader.new(source, serialized)
 
       tokens =         loader.load_tokens
@@ -127,7 +127,7 @@ module Prism
     #--
     #: (String input, String serialized, bool freeze) -> Array[Comment]
     def self.load_parse_comments(input, serialized, freeze)
-      source = Source.for(input)
+      source = Source.for(input, 1, [])
       loader = Loader.new(source, serialized)
 
                    loader.load_header
@@ -151,7 +151,7 @@ module Prism
     #--
     #: (String input, String serialized, bool freeze) -> ParseLexResult
     def self.load_parse_lex(input, serialized, freeze)
-      source = Source.for(input)
+      source = Source.for(input, 1, [])
       loader = Loader.new(source, serialized)
 
       tokens =         loader.load_tokens