Merge branch 'master' into multibyte_chars_doc

Author: BurdetteLamar

.github/workflows/macos.yml

@@ -19,8 +19,9 @@ jobs:
       fail-fast: false
       matrix:
         os:
-        - macos-13
         - macos-14
+        - macos-15-intel
+        - macos-15
         ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
     steps:
     - name: git config

.github/workflows/ubuntu.yml

@@ -44,7 +44,7 @@ jobs:
       run: bundle exec rake compile
     - name: Build gem
       run: bundle exec rake build
-    - uses: actions/upload-artifact@v5
+    - uses: actions/upload-artifact@v6
       with:
         name: gem-${{ matrix.os }}-${{ matrix.ruby }}
         path: pkg/

NEWS.md

@@ -1,5 +1,24 @@
 # News
 
+## 3.2.0 - 2025-12-17
+
+### Improvements
+
+  * Improved documents.
+    * GH-179
+    * GH-188
+    * GH-189
+    * GH-190
+    * GH-191
+    * GH-192
+    * GH-193
+    * GH-194
+    * Patch by Burdette Lamar
+
+### Thanks
+
+  * Burdette Lamar
+
 ## 3.1.9 - 2025-12-01
 
 ### Improvements

doc/stringio/getbyte.rdoc

@@ -15,9 +15,10 @@ Returns +nil+ if at end-of-stream:
 Returns a byte, not a character:
 
   s = 'こんにちは'
-  s.bytes       # => [227, 129, 147, 227, 130, 147, 227, 129, 171, 227, 129, 161, 227, 129, 175]
+  s.bytes
+  # => [227, 129, 147, 227, 130, 147, 227, 129, 171, 227, 129, 161, 227, 129, 175]
   strio = StringIO.new(s)
   strio.getbyte # => 227
   strio.getbyte # => 129
 
-Related: StringIO.getc.
+Related: #each_byte, #ungetbyte, #getc.

doc/stringio/getc.rdoc

@@ -27,4 +27,4 @@ in other cases that need not be true:
    strio.pos = 5 # => 5     # At third byte of second character; returns byte.
    strio.getc    # => "\x93"
 
-Related: StringIO.getbyte.
+Related: #getbyte, #putc, #ungetc.

doc/stringio/gets.rdoc

@@ -95,4 +95,5 @@ removes the trailing newline (if any) from the returned line:
   strio.gets              # => "First line\n"
   strio.gets(chomp: true) # => "Second line"
 
-Related: StringIO.each_line.
+Related: #each_line, #readlines,
+{Kernel#puts}[https://docs.ruby-lang.org/en/master/Kernel.html#method-i-puts].

doc/stringio/pread.rdoc

@@ -0,0 +1,65 @@
+**Note**: \Method +pread+ is different from other reading methods
+in that it does not modify +self+ in any way;
+thus, multiple threads may read safely from the same stream.
+
+Reads up to +maxlen+ bytes from the stream,
+beginning at 0-based byte offset +offset+;
+returns a string containing the read bytes.
+
+The returned string:
+
+- Contains +maxlen+ bytes from the stream, if available;
+  otherwise contains all available bytes.
+- Has encoding +Encoding::ASCII_8BIT+.
+
+With only arguments +maxlen+ and +offset+ given,
+returns a new string:
+
+  english = 'Hello'  # Five 1-byte characters.
+  strio = StringIO.new(english)
+  strio.pread(3, 0)  # => "Hel"
+  strio.pread(3, 2)  # => "llo"
+  strio.pread(0, 0)  # => ""
+  strio.pread(50, 0) # => "Hello"
+  strio.pread(50, 2) # => "llo"
+  strio.pread(50, 4) # => "o"
+  strio.pread(0, 0).encoding
+  # => #<Encoding:BINARY (ASCII-8BIT)>
+
+  russian = 'Привет' # Six 2-byte characters.
+  strio = StringIO.new(russian)
+  strio.pread(50, 0) # All 12 bytes.
+  # => "\xD0\x9F\xD1\x80\xD0\xB8\xD0\xB2\xD0\xB5\xD1\x82"
+  strio.pread(3, 0)  # => "\xD0\x9F\xD1"
+  strio.pread(3, 3)  # => "\x80\xD0\xB8"
+  strio.pread(0, 0).encoding
+  # => #<Encoding:BINARY (ASCII-8BIT)>
+
+  japanese = 'こんにちは' # Five 3-byte characters.
+  strio = StringIO.new(japanese)
+  strio.pread(50, 0)    # All 15 bytes.
+  # => "\xE3\x81\x93\xE3\x82\x93\xE3\x81\xAB\xE3\x81\xA1\xE3\x81\xAF"
+  strio.pread(6, 0)     # => "\xE3\x81\x93\xE3\x82\x93"
+  strio.pread(1, 2)     # => "\x93"
+  strio.pread(0, 0).encoding
+  # => #<Encoding:BINARY (ASCII-8BIT)>
+
+Raises an exception if +offset+ is out-of-range:
+
+  strio = StringIO.new(english)
+  strio.pread(5, 50) # Raises EOFError: end of file reached
+
+With string argument +out_string+ given:
+
+- Reads as above.
+- Overwrites the content of +out_string+ with the read bytes.
+
+Examples:
+
+  out_string = 'Will be overwritten'
+  out_string.encoding                # => #<Encoding:UTF-8>
+  result = StringIO.new(english).pread(50, 0, out_string)
+  result.__id__ == out_string.__id__ # => true
+  out_string                         # => "Hello"
+  out_string.encoding                # => #<Encoding:BINARY (ASCII-8BIT)>
+

doc/stringio/putc.rdoc

@@ -0,0 +1,82 @@
+Replaces one or more bytes at position +pos+
+with bytes of the given argument;
+advances the position by the count of bytes written;
+returns the argument.
+
+\StringIO object for 1-byte characters.
+
+  strio = StringIO.new('foo')
+  strio.pos # => 0
+
+With 1-byte argument, replaces one byte:
+
+  strio.putc('b')
+  strio.string    # => "boo"
+  strio.pos       # => 1
+  strio.putc('a') # => "a"
+  strio.string    # => "bao"
+  strio.pos       # => 2
+  strio.putc('r') # => "r"
+  strio.string    # => "bar"
+  strio.pos       # => 3
+  strio.putc('n') # => "n"
+  strio.string    # => "barn"
+  strio.pos       # => 4
+
+Fills with null characters if necessary:
+
+  strio.pos = 6
+  strio.putc('x') # => "x"
+  strio.string    # => "barn\u0000\u0000x"
+  strio.pos       # => 7
+
+With integer argument, replaces one byte with the low-order byte of the integer:
+
+  strio = StringIO.new('foo')
+  strio.putc(70)
+  strio.string # => "Foo"
+  strio.putc(79)
+  strio.string # => "FOo"
+  strio.putc(79 + 1024)
+  strio.string # => "FOO"
+
+\StringIO object for Multi-byte characters:
+
+  greek = 'αβγδε' # Five 2-byte characters.
+  strio = StringIO.new(greek)
+  strio.string# => "αβγδε"
+  strio.string.b        # => "\xCE\xB1\xCE\xB2\xCE\xB3\xCE\xB4\xCE\xB5"
+  strio.string.bytesize # => 10
+  strio.string.chars    # => ["α", "β", "γ", "δ", "ε"]
+  strio.string.size     # => 5
+
+With 1-byte argument, replaces one byte of the string:
+
+  strio.putc(' ')       # 1-byte ascii space.
+  strio.pos             # => 1
+  strio.string          # => " \xB1βγδε"
+  strio.string.b        # => " \xB1\xCE\xB2\xCE\xB3\xCE\xB4\xCE\xB5"
+  strio.string.bytesize # => 10
+  strio.string.chars    # => [" ", "\xB1", "β", "γ", "δ", "ε"]
+  strio.string.size     # => 6
+
+  strio.putc(' ')
+  strio.pos             # => 2
+  strio.string          # => "  βγδε"
+  strio.string.b        # => "  \xCE\xB2\xCE\xB3\xCE\xB4\xCE\xB5"
+  strio.string.bytesize # => 10
+  strio.string.chars    # => [" ", " ", "β", "γ", "δ", "ε"]
+  strio.string.size     # => 6
+
+With 2-byte argument, replaces two bytes of the string:
+
+  strio.rewind
+  strio.putc('α')
+  strio.pos             # => 2
+  strio.string          # => "αβγδε"
+  strio.string.b        # => "\xCE\xB1\xCE\xB2\xCE\xB3\xCE\xB4\xCE\xB5"
+  strio.string.bytesize # => 10
+  strio.string.chars    # => ["α", "β", "γ", "δ", "ε"]
+  strio.string.size     # => 5
+
+Related: #getc, #ungetc.

doc/stringio/read.rdoc

@@ -0,0 +1,83 @@
+Reads and returns a string containing bytes read from the stream,
+beginning at the current position;
+advances the position by the count of bytes read.
+
+With no arguments given,
+reads all remaining bytes in the stream;
+returns a new string containing bytes read:
+
+  strio = StringIO.new('Hello') # Five 1-byte characters.
+  strio.read                    # => "Hello"
+  strio.pos                     # => 5
+  strio.read                    # => ""
+  StringIO.new('').read         # => ""
+
+With non-negative argument +maxlen+ given,
+reads +maxlen+ bytes as available;
+returns a new string containing the bytes read, or +nil+ if none:
+
+  strio.rewind
+  strio.read(3) # => "Hel"
+  strio.read(3) # => "lo"
+  strio.read(3) # => nil
+
+  russian = 'Привет' # Six 2-byte characters.
+  russian.b
+  # => "\xD0\x9F\xD1\x80\xD0\xB8\xD0\xB2\xD0\xB5\xD1\x82"
+  strio = StringIO.new(russian)
+  strio.read(6) # => "\xD0\x9F\xD1\x80\xD0\xB8"
+  strio.read(6) # => "\xD0\xB2\xD0\xB5\xD1\x82"
+  strio.read(6) # => nil
+
+  japanese = 'こんにちは'
+  japanese.b
+  # => "\xE3\x81\x93\xE3\x82\x93\xE3\x81\xAB\xE3\x81\xA1\xE3\x81\xAF"
+  strio = StringIO.new(japanese)
+  strio.read(9) # => "\xE3\x81\x93\xE3\x82\x93\xE3\x81\xAB"
+  strio.read(9) # => "\xE3\x81\xA1\xE3\x81\xAF"
+  strio.read(9) # => nil
+
+With argument +max_len+ as +nil+ and string argument +out_string+ given,
+reads the remaining bytes in the stream;
+clears +out_string+ and writes the bytes into it;
+returns +out_string+:
+
+  out_string = 'Will be overwritten'
+  strio = StringIO.new('Hello')
+  strio.read(nil, out_string) # => "Hello"
+  strio.read(nil, out_string) # => ""
+
+With non-negative argument +maxlen+ and string argument +out_string+ given,
+reads the +maxlen bytes from the stream, as availble;
+clears +out_string+ and writes the bytes into it;
+returns +out_string+ if any bytes were read, or +nil+ if none:
+
+  out_string = 'Will be overwritten'
+  strio = StringIO.new('Hello')
+  strio.read(3, out_string) # => "Hel"
+  strio.read(3, out_string) # => "lo"
+  strio.read(3, out_string) # => nil
+
+  out_string = 'Will be overwritten'
+  strio = StringIO.new(russian)
+  strio.read(6, out_string) # => "При"
+  strio.read(6, out_string) # => "вет"
+  strio.read(6, out_string) # => nil
+  strio.rewind
+  russian.b
+  # => "\xD0\x9F\xD1\x80\xD0\xB8\xD0\xB2\xD0\xB5\xD1\x82"
+  strio.read(3)             # => "\xD0\x9F\xD1"
+  strio.read(3)             # => "\x80\xD0\xB8"
+
+  out_string = 'Will be overwritten'
+  strio = StringIO.new(japanese)
+  strio.read(9, out_string) # => "こんに"
+  strio.read(9, out_string) # => "ちは"
+  strio.read(9, out_string) # => nil
+  strio.rewind
+  japanese.b
+  # => "\xE3\x81\x93\xE3\x82\x93\xE3\x81\xAB\xE3\x81\xA1\xE3\x81\xAF"
+  strio.read(4)             # => "\xE3\x81\x93\xE3"
+  strio.read(4)             # => "\x82\x93\xE3\x81"
+
+Related: #gets, #readlines.

ext/java/org/jruby/ext/stringio/StringIO.java

@@ -102,7 +102,7 @@ private StringIOData getPtr() {
     }
 
     private static final String
-    STRINGIO_VERSION = "3.1.10";
+    STRINGIO_VERSION = "3.2.1";
 
     private static final byte STRIO_READABLE = 1;
     private static final byte STRIO_WRITABLE = 2;