stringio 3.1.8 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7955baf0f07b14461ca7f88b4c2f97383d9cf1114e07fd7408e1e332f974c139
-  data.tar.gz: 4169d5e9055f8ce90725fc374030ff97b8473734741c3cb741527f7e0aefd865
+  metadata.gz: 7c1acfcaec0e05165de2f55e7519bc0c5a732d9e00787843daade47fb287726e
+  data.tar.gz: 02eda2070ab8b4a9bc125de803c68de0a01845227c5e4f15359931f9fece7bbd
 SHA512:
-  metadata.gz: e91d6fa5462e3afec46f4e709dd746e8bb275198825eca723634b2837207270c05973f224884525da256fd1ad17b1da7659046f78135ba958651715c7a34b5f7
-  data.tar.gz: 673e6b9e4e59a31b708963893bcc9ea80e01351b272b82992467b72e8c7a074eb9f2f8f854cbdc2767ca826c5d9351cfaa82ce721e8a32dca41ca6ad9a47f883
+  metadata.gz: f86b9853126abe79c1b801c2854cb606d532617218fa2a26dcc0c55c2c0ef457bee707e1d9ce08e6bfaf93c09411a175d244773b23ad0970c91ad3d068ba5718
+  data.tar.gz: 76083aecab40178e6c7296351c6cb66f128188000d925062d210cc938917ad8e8316074843e1fc7da295e67d391b1be2bded0409c076700a8e15a16f9dc8cd23

data/NEWS.md

@@ -1,5 +1,54 @@
 # 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] Tweaks for StringIO#each_line
+    * GH-165
+
+  * [DOC] Doc for StringIO.size
+    * GH-175
+
+  * [DOC] Tweaks for StringIO#fsync
+    * GH-173
+
+  * [DOC] Fix #seek link
+    * GH-174
+
+  * Add a note about chilled string support to 3.1.8 release note
+    * GH-180 fixes GH-179
+
+### Fixes
+
+  * JRuby: Removed use of RubyBasicObject.flags
+    * GH-182
+
+### Thanks
+
+  * Burdette Lamar
+
+  * Charles Oliver Nutter
+
 ## 3.1.8 - 2025-11-12
 
 ### Improvements
@@ -7,6 +56,9 @@
   * Improved documents
     * Patch by Burdette Lamar
 
+  * Improved chilled string support
+    * GH-128
+
 ### Fixes
 
   * Fixed SEGV in `StringIO#seek` with `SEEK_END` on `StringIO.new(nil)`

data/ext/stringio/stringio.c

@@ -13,7 +13,7 @@
 **********************************************************************/
 
 static const char *const
-STRINGIO_VERSION = "3.1.8";
+STRINGIO_VERSION = "3.2.0";
 
 #include <stdbool.h>
 
@@ -747,7 +747,7 @@ strio_copy(VALUE copy, VALUE orig)
  *   lineno -> current_line_number
  *
  * Returns the current line number in +self+;
- * see {Line Number}[rdoc-ref:IO@Line+Number].
+ * see {Line Number}[rdoc-ref:StringIO@Line+Number].
  */
 static VALUE
 strio_get_lineno(VALUE self)
@@ -760,7 +760,7 @@ strio_get_lineno(VALUE self)
  *   lineno = new_line_number -> new_line_number
  *
  * Sets the current line number in +self+ to the given +new_line_number+;
- * see {Line Number}[rdoc-ref:IO@Line+Number].
+ * see {Line Number}[rdoc-ref:StringIO@Line+Number].
  */
 static VALUE
 strio_set_lineno(VALUE self, VALUE lineno)
@@ -774,7 +774,7 @@ strio_set_lineno(VALUE self, VALUE lineno)
  *   binmode -> self
  *
  * Sets the data mode in +self+ to binary mode;
- * see {Data Mode}[https://docs.ruby-lang.org/en/master/File.html#class-File-label-Data+Mode].
+ * see {Data Mode}[rdoc-ref:StringIO@Data+Mode].
  *
  */
 static VALUE
@@ -835,7 +835,7 @@ strio_reopen(int argc, VALUE *argv, VALUE self)
  *   pos -> stream_position
  *
  * Returns the current position (in bytes);
- * see {Position}[rdoc-ref:IO@Position].
+ * see {Position}[rdoc-ref:StringIO@Position].
  */
 static VALUE
 strio_get_pos(VALUE self)
@@ -848,7 +848,7 @@ strio_get_pos(VALUE self)
  *   pos = new_position -> new_position
  *
  * Sets the current position (in bytes);
- * see {Position}[rdoc-ref:IO@Position].
+ * see {Position}[rdoc-ref:StringIO@Position].
  */
 static VALUE
 strio_set_pos(VALUE self, VALUE pos)
@@ -883,9 +883,9 @@ strio_rewind(VALUE self)
  * call-seq:
  *   seek(offset, whence = SEEK_SET) -> 0
  *
- * Sets the current position to the given integer +offset+ (in bytes),
+ * Sets the position to the given integer +offset+ (in bytes),
  * with respect to a given constant +whence+;
- * see {Position}[rdoc-ref:IO@Position].
+ * see {IO#seek}[https://docs.ruby-lang.org/en/master/IO.html#method-i-seek].
  */
 static VALUE
 strio_seek(int argc, VALUE *argv, VALUE self)
@@ -1473,170 +1473,8 @@ strio_readline(int argc, VALUE *argv, VALUE self)
  *   each_line(limit, chomp: false) {|line| ... }      -> self
  *   each_line(sep, limit, chomp: false) {|line| ... } -> self
  *
- * With a block given calls the block with each remaining line (see "Position" below) in the stream;
- * returns `self`.
+ * :include: stringio/each_line.md
  *
- * Leaves stream position as end-of-stream.
- *
- * **No Arguments**
- *
- * With no arguments given,
- * reads lines using the default record separator global variable `$/`, whose initial value is `"\n"`.
- *
- * ```
- * strio = StringIO.new(TEXT)
- * strio.each_line {|line| p line }
- * strio.eof? # => true
- * ```
- *
- * Output:
- *
- * ```
- * "First line\n"
- * "Second line\n"
- * "\n"
- * "Fourth line\n"
- * "Fifth line\n"
- * ```
- *
- * **Argument `sep`**
- *
- * With only string argument `sep` given,
- * reads lines using that string as the record separator:
- *
- * ```
- * strio = StringIO.new(TEXT)
- * strio.each_line(' ') {|line| p line }
- * ```
- *
- * Output:
- *
- * ```
- * "First "
- * "line\nSecond "
- * "line\n\nFourth "
- * "line\nFifth "
- * "line\n"
- * ```
- *
- * **Argument `limit`**
- *
- * With only integer argument `limit` given,
- * reads lines using the default record separator global variable `$/`, whose initial value is `"\n"`;
- * also limits the size (in characters) of each line to the given limit:
- *
- * ```
- * strio = StringIO.new(TEXT)
- * strio.each_line(10) {|line| p line }
- * ```
- *
- * Output:
- *
- * ```
- * "First line"
- * "\n"
- * "Second lin"
- * "e\n"
- * "\n"
- * "Fourth lin"
- * "e\n"
- * "Fifth line"
- * "\n"
- * ```
- * **Arguments `sep` and `limit`**
- *
- * With arguments `sep` and `limit` both given,
- * honors both:
- *
- * ```
- * strio = StringIO.new(TEXT)
- * strio.each_line(' ', 10) {|line| p line }
- * ```
- *
- * Output:
- *
- * ```
- * "First "
- * "line\nSecon"
- * "d "
- * "line\n\nFour"
- * "th "
- * "line\nFifth"
- * " "
- * "line\n"
- * ```
- *
- * **Position**
- *
- * As stated above, method `each` _remaining_ line in the stream.
- *
- * In the examples above each `strio` object starts with its position at beginning-of-stream;
- * but in other cases the position may be anywhere (see StringIO#pos):
- *
- * ```
- * strio = StringIO.new(TEXT)
- * strio.pos = 30 # Set stream position to character 30.
- * strio.each_line {|line| p line }
- * ```
- *
- * Output:
- *
- * ```
- * " line\n"
- * "Fifth line\n"
- * ```
- *
- * **Special Record Separators**
- *
- * Like some methds in class `IO`, StringIO.each honors two special record separators;
- * see {Special Line Separators}[https://docs.ruby-lang.org/en/master/IO.html#class-IO-label-Special+Line+Separator+Values].
- *
- * ```
- * strio = StringIO.new(TEXT)
- * strio.each_line('') {|line| p line } # Read as paragraphs (separated by blank lines).
- * ```
- *
- * Output:
- *
- * ```
- * "First line\nSecond line\n\n"
- * "Fourth line\nFifth line\n"
- * ```
- *
- * ```
- * strio = StringIO.new(TEXT)
- * strio.each_line(nil) {|line| p line } # "Slurp"; read it all.
- * ```
- *
- * Output:
- *
- * ```
- * "First line\nSecond line\n\nFourth line\nFifth line\n"
- * ```
- *
- * **Keyword Argument `chomp`**
- *
- * With keyword argument `chomp` given as `true` (the default is `false`),
- * removes trailing newline (if any) from each line:
- *
- * ```
- * strio = StringIO.new(TEXT)
- * strio.each_line(chomp: true) {|line| p line }
- * ```
- *
- * Output:
- *
- * ```
- * "First line"
- * "Second line"
- * ""
- * "Fourth line"
- * "Fifth line"
- * ```
- *
- * With no block given, returns a new {Enumerator}[https://docs.ruby-lang.org/en/master/Enumerator.html].
- *
- * Related: StringIO.each_byte, StringIO.each_char, StringIO.each_codepoint.
  */
 static VALUE
 strio_each(int argc, VALUE *argv, VALUE self)
@@ -2005,10 +1843,10 @@ strio_syswrite_nonblock(int argc, VALUE *argv, VALUE self)
 
 /*
  * call-seq:
- *   strio.length -> integer
- *   strio.size   -> integer
+ *   size -> integer
+ *
+ * :include: stringio/size.rdoc
  *
- * Returns the size of the buffer string.
  */
 static VALUE
 strio_size(VALUE self)
@@ -2050,7 +1888,7 @@ strio_truncate(VALUE self, VALUE len)
  *   external_encoding -> encoding or nil
  *
  * Returns an Encoding object that represents the encoding of the string;
- * see {Encoding}[https://docs.ruby-lang.org/en/master/Encoding.html]:
+ * see {Encodings}[rdoc-ref:StringIO@Encodings]:
  *
  *   strio = StringIO.new('foo')
  *   strio.external_encoding # => #<Encoding:UTF-8>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stringio
 version: !ruby/object:Gem::Version
-  version: 3.1.8
+  version: 3.2.0
 platform: ruby
 authors:
 - Nobu Nakada
 - Charles Oliver Nutter
 bindir: bin
 cert_chain: []
-date: 2025-11-12 00:00:00.000000000 Z
+date: 2025-12-17 00:00:00.000000000 Z
 dependencies: []
 description: Pseudo `IO` class from/to `String`.
 email:
@@ -42,7 +42,7 @@ licenses:
 - Ruby
 - BSD-2-Clause
 metadata:
-  changelog_uri: https://github.com/ruby/stringio/releases/tag/v3.1.8
+  changelog_uri: https://github.com/ruby/stringio/releases/tag/v3.2.0
 rdoc_options: []
 require_paths:
 - lib