Merge pull request #2212 from ParadoxV5/chomp

`#gets`s, `#readline`s and `#readlines`s *also* accept `chomp: true`

Author: soutaro

Rakefile

@@ -112,7 +112,7 @@ end
 
 task :stdlib_test => :compile do
   test_files = FileList["test/stdlib/**/*_test.rb"].reject do |path|
-    path =~ %r{Ractor} || path =~ %r{Encoding}
+    path =~ %r{Ractor} || path =~ %r{Encoding} || path =~ %r{CGI_test}
   end
 
   if ENV["RANDOMIZE_STDLIB_TEST_ORDER"] == "true"
@@ -121,6 +121,7 @@ task :stdlib_test => :compile do
 
   sh "#{ruby} -Ilib #{bin}/test_runner.rb #{test_files.join(' ')}"
   # TODO: Ractor tests need to be run in a separate process
+  sh "#{ruby} -Ilib #{bin}/test_runner.rb test/stdlib/CGI_test.rb"
   sh "#{ruby} -Ilib #{bin}/test_runner.rb test/stdlib/Ractor_test.rb"
   sh "#{ruby} -Ilib #{bin}/test_runner.rb test/stdlib/Encoding_test.rb"
 end

core/kernel.rbs

@@ -1163,7 +1163,7 @@ module Kernel : BasicObject
   # The style of programming using `$_` as an implicit parameter is gradually
   # losing favor in the Ruby community.
   #
-  def self?.gets: (?String arg0, ?Integer arg1) -> String?
+  def self?.gets: (?String sep, ?Integer limit, ?chomp: boolish) -> String?
 
   # <!--
   #   rdoc-file=eval.c
@@ -1486,7 +1486,7 @@ module Kernel : BasicObject
   # Optional keyword argument `chomp` specifies whether line separators are to be
   # omitted.
   #
-  def self?.readline: (?String arg0, ?Integer arg1) -> String
+  def self?.readline: (?String arg0, ?Integer arg1, ?chomp: boolish) -> String
 
   # <!--
   #   rdoc-file=io.c

core/rbs/unnamed/argf.rbs

@@ -639,7 +639,7 @@ module RBS
       # See IO.readlines for details about getline_args.
       #
       %a{annotate:rdoc:copy:ARGF#gets}
-      def gets: (?String sep, ?Integer limit) -> String?
+      def gets: (?String sep, ?Integer limit, ?chomp: boolish) -> String?
 
       # <!--
       #   rdoc-file=io.c
@@ -1024,7 +1024,7 @@ module RBS
       # An EOFError is raised at the end of the file.
       #
       %a{annotate:rdoc:copy:ARGF#readline}
-      def readline: (?String sep, ?Integer limit) -> String
+      def readline: (?String sep, ?Integer limit, ?chomp: boolish) -> String
 
       # <!--
       #   rdoc-file=io.c
@@ -1044,7 +1044,7 @@ module RBS
       # See `IO.readlines` for a full description of all options.
       #
       %a{annotate:rdoc:copy:ARGF#readlines}
-      def readlines: (?String sep, ?Integer limit) -> ::Array[String]
+      def readlines: (?String sep, ?Integer limit, ?chomp: boolish) -> ::Array[String]
 
       # <!--
       #   rdoc-file=io.c

stdlib/openssl/0/openssl.rbs

@@ -2025,7 +2025,7 @@ module OpenSSL
     #
     # Unlike IO#gets the separator must be provided if a limit is provided.
     #
-    def gets: (?String | Regexp eol, ?Integer limit) -> String?
+    def gets: (?String | Regexp eol, ?Integer limit, ?chomp: boolish) -> String?
 
     # <!--
     #   rdoc-file=ext/openssl/lib/openssl/buffering.rb

stdlib/stringio/0/stringio.rbs

@@ -338,7 +338,7 @@ class StringIO
 
   def readchar: () -> String
 
-  def readline: (?String sep, ?Integer limit) -> String
+  def readline: (?String sep, ?Integer limit, ?chomp: boolish) -> String
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c

test/stdlib/ARGF_test.rb

@@ -27,6 +27,10 @@ def test_gets
                       ARGF.class.new(__FILE__), :gets, "\n"
     assert_send_type  "(::String sep, ::Integer limit) -> ::String",
                       ARGF.class.new(__FILE__), :gets, "\n", 1
+    assert_send_type  "(chomp: boolish) -> ::String",
+                      ARGF.class.new(__FILE__), :gets, chomp: true
+    assert_send_type  "(::String sep, ::Integer limit, chomp: boolish) -> ::String",
+                      ARGF.class.new(__FILE__), :gets, "\n", 1, chomp: true
     assert_send_type  "() -> nil",
                       ARGF.class.new(Tempfile.new), :gets
   end
@@ -60,6 +64,10 @@ def test_readline
                       ARGF.class.new(__FILE__), :readline, "\n"
     assert_send_type  "(::String sep, ::Integer limit) -> ::String",
                       ARGF.class.new(__FILE__), :readline, "\n", 1
+    assert_send_type  "(chomp: boolish) -> ::String",
+                      ARGF.class.new(__FILE__), :readline, chomp: true
+    assert_send_type  "(::String sep, ::Integer limit, chomp: boolish) -> ::String",
+                      ARGF.class.new(__FILE__), :readline, "\n", 1, chomp: true
   end
 
   def test_readlines
@@ -69,6 +77,10 @@ def test_readlines
                       ARGF.class.new(__FILE__), :readlines, "\n"
     assert_send_type  "(::String sep, ::Integer limit) -> ::Array[::String]",
                       ARGF.class.new(__FILE__), :readlines, "\n", 1
+    assert_send_type  "(chomp: boolish) -> ::Array[::String]",
+                      ARGF.class.new(__FILE__), :readlines, chomp: true
+    assert_send_type  "(::String sep, ::Integer limit, chomp: boolish) -> ::Array[::String]",
+                      ARGF.class.new(__FILE__), :readlines, "\n", 1, chomp: true
   end
 
   def test_inspect

test/stdlib/Kernel_test.rb

@@ -561,4 +561,25 @@ def test_raise
       end
     end
   end
+
+  def test_readlines
+    $stdin = File.open(__FILE__)
+
+    assert_send_type(
+      "() -> Array[String]",
+      JustKernel.new, :readlines
+    )
+
+    with_int(3) do |limit|
+      with_string(",") do |separator|
+        $stdin = File.open(__FILE__)
+        assert_send_type(
+          "(string, int, chomp: bool) -> Array[String]",
+          JustKernel.new, :readlines, ",", 3, chomp: true
+        )
+      end
+    end
+  ensure
+    $stdin = STDIN
+  end
 end

test/stdlib/StringIO_test.rb

@@ -59,4 +59,30 @@ def test_truncate
       io, :truncate, 10
     )
   end
+
+  def test_readline
+    assert_send_type  "() -> ::String",
+                      StringIO.new("\n"), :readline
+    assert_send_type  "(::String sep) -> ::String",
+                      StringIO.new("\n"), :readline, "\n"
+    assert_send_type  "(::String sep, ::Integer limit) -> ::String",
+                      StringIO.new("\n"), :readline, "\n", 1
+    assert_send_type  "(chomp: boolish) -> ::String",
+                      StringIO.new("\n"), :readline, chomp: true
+    assert_send_type  "(::String sep, ::Integer limit, chomp: boolish) -> ::String",
+                      StringIO.new("\n"), :readline, "\n", 1, chomp: true
+  end
+
+  def test_readlines
+    assert_send_type  "() -> ::Array[::String]",
+                      StringIO.new("\n"), :readlines
+    assert_send_type  "(::String sep) -> ::Array[::String]",
+                      StringIO.new("\n"), :readlines, "\n"
+    assert_send_type  "(::String sep, ::Integer limit) -> ::Array[::String]",
+                      StringIO.new("\n"), :readlines, "\n", 1
+    assert_send_type  "(chomp: boolish) -> ::Array[::String]",
+                      StringIO.new("\n"), :readlines, chomp: true
+    assert_send_type  "(::String sep, ::Integer limit, chomp: boolish) -> ::Array[::String]",
+                      StringIO.new("\n"), :readlines, "\n", 1, chomp: true
+  end
 end