[GR-18163] Fix compatibility issue - support :chomp argument

PullRequest: truffleruby/3339

Author: andrykonchin

CHANGELOG.md

@@ -29,6 +29,7 @@ Compatibility:
 * Fix `instance_variable_get` and `instance_variable_set` for immutable objects (@bjfish).
 * `Thread#raise(exc, message)` now calls `exc.exception` in the target thread like CRuby (@eregon).
 * Define `Process::{CLOCK_BOOTTIME,CLOCK_BOOTTIME_ALARM,CLOCK_REALTIME_ALARM}` (#1480, @eregon).
+* Improve support of `:chomp` keyword argument in `IO` and `StringIO` methods (#2650, @andrykonchin). 
 
 Performance:
 

lib/truffle/pathname.rb

@@ -806,8 +806,8 @@ class Pathname    # * IO *
   #
   # This method has existed since 1.8.1.
   #
-  def each_line(*args, &block) # :yield: line
-    IO.foreach(@path, *args, &block)
+  def each_line(*args, **kw, &block) # :yield: line
+    IO.foreach(@path, *args, **kw, &block)
   end
 
   # See <tt>IO.read</tt>.  Returns all data from the file, or the first +N+ bytes
@@ -825,7 +825,7 @@ def write(*args) IO.write(@path, *args) end
   def binwrite(*args) IO.binwrite(@path, *args) end
 
   # See <tt>IO.readlines</tt>.  Returns all the lines from the file.
-  def readlines(*args) IO.readlines(@path, *args) end
+  def readlines(*args, **kw) IO.readlines(@path, *args, **kw) end
 
   # See <tt>IO.sysopen</tt>.
   def sysopen(*args) IO.sysopen(@path, *args) end

lib/truffle/stringio.rb

@@ -41,11 +41,11 @@ def readbyte
     readchar.getbyte(0)
   end
 
-  def readline(sep=$/, limit=::Undefined)
+  def readline(sep=$/, limit=::Undefined, chomp: false)
     check_readable
     raise EOFError, 'end of file reached' if eof?
 
-    Primitive.io_last_line_set(Primitive.caller_special_variables, getline(true, sep, limit))
+    Primitive.io_last_line_set(Primitive.caller_special_variables, getline(false, sep, limit, chomp))
   end
 
   def sysread(length = nil, buffer = nil)
@@ -220,7 +220,6 @@ def each_byte
 
     self
   end
-  alias_method :bytes, :each_byte
 
   def each_char
     return to_enum :each_char unless block_given?
@@ -230,7 +229,6 @@ def each_char
 
     self
   end
-  alias_method :chars, :each_char
 
   def each_codepoint(&block)
     return to_enum :each_codepoint unless block_given?
@@ -253,20 +251,18 @@ def each_codepoint(&block)
 
     self
   end
-  alias_method :codepoints, :each_codepoint
 
-  def each(sep=$/, limit=Undefined)
-    return to_enum :each, sep, limit unless block_given?
+  def each(sep=$/, limit=Undefined, chomp: false)
+    return to_enum :each, sep, limit, chomp: chomp unless block_given?
     check_readable
 
-    while line = getline(true, sep, limit)
+    while line = getline(true, sep, limit, chomp)
       yield line
     end
 
     self
   end
   alias_method :each_line, :each
-  alias_method :lines, :each
 
   def binmode
     set_encoding(Encoding::BINARY)
@@ -373,12 +369,12 @@ def getbyte
     byte
   end
 
-  def gets(sep=$/, limit=Undefined)
+  def gets(sep=$/, limit=Undefined, chomp: false)
     check_readable
 
     # Truffle: $_ is thread and frame local, so we use a primitive to
     # set it in the caller's frame.
-    Primitive.io_last_line_set(Primitive.caller_special_variables, getline(false, sep, limit))
+    Primitive.io_last_line_set(Primitive.caller_special_variables, getline(false, sep, limit, chomp))
   end
 
   def isatty
@@ -476,11 +472,11 @@ def read(length = nil, buffer = nil)
     str
   end
 
-  def readlines(sep=$/, limit=Undefined)
+  def readlines(sep=$/, limit=Undefined, chomp: false)
     check_readable
 
     ary = []
-    while line = getline(true, sep, limit)
+    while line = getline(true, sep, limit, chomp)
       ary << line
     end
 
@@ -682,7 +678,7 @@ def yaml_initialize(type, val)
     d.string.replace('') if (mode & IO::TRUNC) != 0
   end
 
-  private def getline(arg_error, sep, limit)
+  private def getline(arg_error, sep, limit, chomp=false)
     if limit != Undefined
       limit = Primitive.rb_to_int limit if limit
       sep = Truffle::Type.coerce_to sep, String, :to_str if sep
@@ -692,12 +688,17 @@ def yaml_initialize(type, val)
       unless sep == $/ or sep.nil?
         osep = sep
         sep = Truffle::Type.rb_check_convert_type sep, String, :to_str
-        limit = Primitive.rb_to_int osep unless sep
+        unless sep
+          limit = Primitive.rb_to_int osep
+          sep = $/
+        end
       end
     end
 
     raise ArgumentError if arg_error and limit == 0
 
+    limit = nil if limit && limit < 0
+
     return nil if eof?
 
     d = @__data__
@@ -744,6 +745,10 @@ def yaml_initialize(type, val)
 
     d.lineno += 1
 
+    if chomp
+      line.chomp!(sep || DEFAULT_RECORD_SEPARATOR)
+    end
+
     line
   end
 

spec/ruby/core/io/fixtures/classes.rb

@@ -108,6 +108,14 @@ def self.lines_space_separator
       "linha ", "cinco.\nHere ", "is ", "line ", "six.\n" ]
   end
 
+  def self.lines_space_separator_without_trailing_spaces
+    [ "Voici", "la", "ligne", "une.\nQui",
+      "\303\250", "la", "linea", "due.\n\n\nAqu\303\255",
+      "est\303\241", "la", "l\303\255nea", "tres.\nHier",
+      "ist", "Zeile", "vier.\n\nEst\303\241", "aqui", "a",
+      "linha", "cinco.\nHere", "is", "line", "six.\n" ]
+  end
+
   def self.lines_arbitrary_separator
     [ "Voici la ligne une.\nQui \303\250",
       " la linea due.\n\n\nAqu\303\255 est\303\241 la l\303\255nea tres.\nHier ist Zeile vier.\n\nEst\303\241 aqui a linha cinco.\nHere is line six.\n" ]
@@ -119,6 +127,12 @@ def self.paragraphs
       "Est\303\241 aqui a linha cinco.\nHere is line six.\n" ]
   end
 
+  def self.paragraphs_without_trailing_new_line_characters
+    [ "Voici la ligne une.\nQui \303\250 la linea due.",
+      "Aqu\303\255 est\303\241 la l\303\255nea tres.\nHier ist Zeile vier.",
+      "Est\303\241 aqui a linha cinco.\nHere is line six.\n" ]
+  end
+
   # Creates an IO instance for an existing fixture file. The
   # file should obviously not be deleted.
   def self.io_fixture(name, mode = "r:utf-8")

spec/ruby/core/io/gets_spec.rb

@@ -119,6 +119,16 @@
     it "returns the first line without a trailing newline character" do
       @io.gets(chomp: true).should == IOSpecs.lines_without_newline_characters[0]
     end
+
+    ruby_version_is "3.0" do
+      it "raises exception when options passed as Hash" do
+        -> { @io.gets({ chomp: true }) }.should raise_error(TypeError)
+
+        -> {
+          @io.gets("\n", 1, { chomp: true })
+        }.should raise_error(ArgumentError, "wrong number of arguments (given 3, expected 0..2)")
+      end
+    end
   end
 end
 
@@ -200,6 +210,10 @@
   it "reads all bytes when pass a separator and reading more than all bytes" do
     @io.gets("\t", 100).should == "one\n\ntwo\n\nthree\nfour\n"
   end
+
+  it "returns empty string when 0 passed as a limit" do
+    @io.gets(0).should == ""
+  end
 end
 
 describe "IO#gets" do

spec/ruby/core/io/readline_spec.rb

@@ -43,9 +43,40 @@
     end
   end
 
+  describe "when passed limit" do
+    it "reads limit bytes" do
+      @io.readline(3).should == "Voi"
+    end
+
+    it "returns an empty string when passed 0 as a limit" do
+      @io.readline(0).should == ""
+    end
+  end
+
+  describe "when passed separator and limit" do
+    it "reads limit bytes till the separator" do
+      # Voici la ligne une.\
+      @io.readline(" ", 4).should == "Voic"
+      @io.readline(" ", 4).should == "i "
+      @io.readline(" ", 4).should == "la "
+      @io.readline(" ", 4).should == "lign"
+      @io.readline(" ", 4).should == "e "
+    end
+  end
+
   describe "when passed chomp" do
     it "returns the first line without a trailing newline character" do
       @io.readline(chomp: true).should == IOSpecs.lines_without_newline_characters[0]
     end
+
+    ruby_version_is "3.0" do
+      it "raises exception when options passed as Hash" do
+        -> { @io.readline({ chomp: true }) }.should raise_error(TypeError)
+
+        -> {
+          @io.readline("\n", 1, { chomp: true })
+        }.should raise_error(ArgumentError, "wrong number of arguments (given 3, expected 0..2)")
+      end
+    end
   end
 end

spec/ruby/core/io/readlines_spec.rb

@@ -101,6 +101,28 @@
       @io.readlines(obj).should == IOSpecs.lines_r_separator
     end
   end
+
+  describe "when passed limit" do
+    it "raises ArgumentError when passed 0 as a limit" do
+      -> { @io.readlines(0) }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe "when passed chomp" do
+    it "returns the first line without a trailing newline character" do
+      @io.readlines(chomp: true).should == IOSpecs.lines_without_newline_characters
+    end
+
+    ruby_version_is "3.0" do
+      it "raises exception when options passed as Hash" do
+        -> { @io.readlines({ chomp: true }) }.should raise_error(TypeError)
+
+        -> {
+          @io.readlines("\n", 1, { chomp: true })
+        }.should raise_error(ArgumentError, "wrong number of arguments (given 3, expected 0..2)")
+      end
+    end
+  end
 end
 
 describe "IO#readlines" do

spec/ruby/core/io/shared/each.rb

@@ -161,6 +161,54 @@
       @io.send(@method, chomp: true) { |s| ScratchPad << s }
       ScratchPad.recorded.should == IOSpecs.lines_without_newline_characters
     end
+
+    ruby_version_is "3.0" do
+      it "raises exception when options passed as Hash" do
+        -> {
+          @io.send(@method, { chomp: true }) { |s| }
+        }.should raise_error(TypeError)
+
+        -> {
+          @io.send(@method, "\n", 1, { chomp: true }) { |s| }
+        }.should raise_error(ArgumentError, "wrong number of arguments (given 3, expected 0..2)")
+      end
+    end
+  end
+
+  describe "when passed chomp and a separator" do
+    it "yields each line without separator to the passed block" do
+      @io.send(@method, " ", chomp: true) { |s| ScratchPad << s }
+      ScratchPad.recorded.should == IOSpecs.lines_space_separator_without_trailing_spaces
+    end
+  end
+
+  describe "when passed chomp and empty line as a separator" do
+    it "yields each paragraph without trailing new line characters" do
+      @io.send(@method, "", 1024, chomp: true) { |s| ScratchPad << s }
+      ScratchPad.recorded.should == IOSpecs.paragraphs_without_trailing_new_line_characters
+    end
+  end
+
+  describe "when passed chomp and nil as a separator" do
+    it "yields self's content without trailing new line character" do
+      @io.pos = 100
+      @io.send(@method, nil, chomp: true) { |s| ScratchPad << s }
+      ScratchPad.recorded.should == ["qui a linha cinco.\nHere is line six."]
+    end
+  end
+
+  describe "when passed chomp, nil as a separator, and a limit" do
+    it "yields each line of limit size without truncating trailing new line character" do
+      # 43 - is a size of the 1st paragraph in the file
+      @io.send(@method, nil, 43, chomp: true) { |s| ScratchPad << s }
+
+      ScratchPad.recorded.should == [
+        "Voici la ligne une.\nQui è la linea due.\n\n\n",
+        "Aquí está la línea tres.\n" + "Hier ist Zeile ",
+        "vier.\n\nEstá aqui a linha cinco.\nHere is li",
+        "ne six.\n"
+      ]
+    end
   end
 end