strscan 3.1.5 → 3.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74de6150a7cbeca1382c754e79ae54cc6adc16eb3073952b0d8ef5f2f0fe0c90
-  data.tar.gz: d3abc5e2e3a84aec4b0bd7f4748cbe5c5c5a66826220d60b850a5a49082f6ad3
+  metadata.gz: 8a20ded1eb483c2517db5c99febea87c52f108b1b8fb1077d6e66d3512b69a8c
+  data.tar.gz: 4cc83ff72dba80c66f05c0dc1ba31669a0d8b41cd3d4d36fad8fceb4b04a7e84
 SHA512:
-  metadata.gz: abf7dfce1540a7cbd710740c0269b84bba5b33bbb51d6434da84a860b75526f906b8bbc211f35678cf57d33cabc50f42fc2c578d2b9eb5ce5b6f81374b02ff4d
-  data.tar.gz: 03c301039437aece9be7ecb739a22d02aa2e143e706dc57ce14eeea57a3f8f77f5d7ba1a8f6b4e1aec2e378e5af6f2d64a56b31ab51b3d79eb30aa5240e42450
+  metadata.gz: 9890e1ba7ac3c7fd26f4e8c3b0e6a40a3473bc6e87b472eee4e6f18c4299fa0291eadbf222c19db68c6913277f7147f7609ee001711bcd5c454c6a9cd8f070c1
+  data.tar.gz: ceea0c6918412705091741a0154b8c3b0752cd2c1130da4932ecaff33c4fa8690775b046aea8157dc539ff28a873b8f2dff41bee67c0fc458095845a340f328d

data/.rdoc_options

@@ -1,3 +1,5 @@
 ---
 rdoc_include:
 - doc
+main_page: README.md
+op_dir: html

data/doc/strscan/strscan.md

@@ -37,7 +37,7 @@ Some examples here assume that certain helper methods are defined:
 - `match_values_cleared?(scanner)`:
   Returns whether the scanner's [match values][9] are cleared.
 
-See examples [here][ext/strscan/helper_methods_md.html].
+See examples at [helper methods](helper_methods.md).
 
 ## The `StringScanner` \Object
 
@@ -204,7 +204,7 @@ put_situation(scanner)
 
 ## Target Substring
 
-The target substring is the the part of the [stored string][1]
+The target substring is the part of the [stored string][1]
 that extends from the current [byte position][2] to the end of the stored string;
 it is always either:
 
@@ -417,7 +417,7 @@ Each of these methods returns a captured match value:
 | Method          | Return After Match                      | Return After No Match |
 |-----------------|-----------------------------------------|-----------------------|
 | #size           | Count of captured substrings.           | +nil+.                |
-| #[](n)          | <tt>n</tt>th captured substring.        | +nil+.                |
+| #\[\](n)        | <tt>n</tt>th captured substring.        | +nil+.                |
 | #captures       | Array of all captured substrings.       | +nil+.                |
 | #values_at(*n)  | Array of specified captured substrings. | +nil+.                |
 | #named_captures | Hash of named captures.                 | <tt>{}</tt>.          |

data/ext/strscan/extconf.rb

@@ -2,8 +2,9 @@
 require 'mkmf'
 if RUBY_ENGINE == 'ruby'
   $INCFLAGS << " -I$(top_srcdir)" if $extmk
-  have_func("onig_region_memsize", "ruby.h")
-  have_func("rb_reg_onig_match", "ruby.h")
+  have_func("onig_region_memsize(NULL)")
+  have_func("rb_reg_onig_match", "ruby/re.h")
+  have_func("rb_deprecate_constant")
   create_makefile 'strscan'
 else
   File.write('Makefile', dummy_makefile("").join)

data/ext/strscan/strscan.c

@@ -22,7 +22,15 @@ extern size_t onig_region_memsize(const struct re_registers *regs);
 
 #include <stdbool.h>
 
-#define STRSCAN_VERSION "3.1.5"
+#define STRSCAN_VERSION "3.1.6"
+
+
+#ifdef HAVE_RB_DEPRECATE_CONSTANT
+/* In ruby 3.0, defined but exposed in external headers */
+extern void rb_deprecate_constant(VALUE mod, const char *name);
+#else
+# define rb_deprecate_constant(mod, name) ((void)0)
+#endif
 
 /* =======================================================================
                          Data Type Definitions
@@ -30,7 +38,6 @@ extern size_t onig_region_memsize(const struct re_registers *regs);
 
 static VALUE StringScanner;
 static VALUE ScanError;
-static ID id_byteslice;
 
 static int usascii_encindex, utf8_encindex, binary_encindex;
 
@@ -97,7 +104,6 @@ static VALUE strscan_init_copy _((VALUE vself, VALUE vorig));
 
 static VALUE strscan_s_mustc _((VALUE self));
 static VALUE strscan_terminate _((VALUE self));
-static VALUE strscan_clear _((VALUE self));
 static VALUE strscan_get_string _((VALUE self));
 static VALUE strscan_set_string _((VALUE self, VALUE str));
 static VALUE strscan_concat _((VALUE self, VALUE str));
@@ -119,14 +125,11 @@ static VALUE strscan_search_full _((VALUE self, VALUE re,
 static void adjust_registers_to_matched _((struct strscanner *p));
 static VALUE strscan_getch _((VALUE self));
 static VALUE strscan_get_byte _((VALUE self));
-static VALUE strscan_getbyte _((VALUE self));
 static VALUE strscan_peek _((VALUE self, VALUE len));
-static VALUE strscan_peep _((VALUE self, VALUE len));
 static VALUE strscan_scan_base10_integer _((VALUE self));
 static VALUE strscan_unscan _((VALUE self));
 static VALUE strscan_bol_p _((VALUE self));
 static VALUE strscan_eos_p _((VALUE self));
-static VALUE strscan_empty_p _((VALUE self));
 static VALUE strscan_rest_p _((VALUE self));
 static VALUE strscan_matched_p _((VALUE self));
 static VALUE strscan_matched _((VALUE self));
@@ -209,7 +212,7 @@ strscan_memsize(const void *ptr)
 static const rb_data_type_t strscanner_type = {
     "StringScanner",
     {strscan_mark, strscan_free, strscan_memsize},
-    0, 0, RUBY_TYPED_FREE_IMMEDIATELY
+    0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED
 };
 
 static VALUE
@@ -273,7 +276,7 @@ strscan_initialize(int argc, VALUE *argv, VALUE self)
         p->fixed_anchor_p = false;
     }
     StringValue(str);
-    p->str = str;
+    RB_OBJ_WRITE(self, &p->str, str);
 
     return self;
 }
@@ -303,7 +306,7 @@ strscan_init_copy(VALUE vself, VALUE vorig)
     orig = check_strscan(vorig);
     if (self != orig) {
 	self->flags = orig->flags;
-	self->str = orig->str;
+	RB_OBJ_WRITE(vself, &self->str, orig->str);
 	self->prev = orig->prev;
 	self->curr = orig->curr;
 	if (rb_reg_region_copy(&self->regs, &orig->regs))
@@ -385,21 +388,6 @@ strscan_terminate(VALUE self)
     return self;
 }
 
-/*
- * call-seq:
- *   clear -> self
- *
- * This method is obsolete; use the equivalent method StringScanner#terminate.
- */
-
- /* :nodoc: */
-static VALUE
-strscan_clear(VALUE self)
-{
-    rb_warning("StringScanner#clear is obsolete; use #terminate instead");
-    return strscan_terminate(self);
-}
-
 /*
  * :markup: markdown
  * :include: strscan/link_refs.txt
@@ -467,7 +455,7 @@ strscan_set_string(VALUE self, VALUE str)
     struct strscanner *p = check_strscan(self);
 
     StringValue(str);
-    p->str = str;
+    RB_OBJ_WRITE(self, &p->str, str);
     p->curr = 0;
     CLEAR_MATCH_STATUS(p);
     return str;
@@ -712,7 +700,7 @@ strscan_do_scan(VALUE self, VALUE pattern, int succptr, int getstr, int headonly
 
     if (RB_TYPE_P(pattern, T_REGEXP)) {
         OnigPosition ret;
-        p->regex = pattern;
+        RB_OBJ_WRITE(self, &p->regex, pattern);
         ret = rb_reg_onig_match(p->regex,
                                 p->str,
                                 headonly ? strscan_match : strscan_search,
@@ -1218,22 +1206,6 @@ strscan_get_byte(VALUE self)
                          adjust_register_position(p, p->regs.end[0]));
 }
 
-/*
- * call-seq:
- *   getbyte
- *
- * Equivalent to #get_byte.
- * This method is obsolete; use #get_byte instead.
- */
-
- /* :nodoc: */
-static VALUE
-strscan_getbyte(VALUE self)
-{
-    rb_warning("StringScanner#getbyte is obsolete; use #get_byte instead");
-    return strscan_get_byte(self);
-}
-
 /*
  * :markup: markdown
  * :include: strscan/link_refs.txt
@@ -1269,22 +1241,6 @@ strscan_peek(VALUE self, VALUE vlen)
     return extract_beg_len(p, p->curr, len);
 }
 
-/*
- * call-seq:
- *   peep
- *
- * Equivalent to #peek.
- * This method is obsolete; use #peek instead.
- */
-
- /* :nodoc: */
-static VALUE
-strscan_peep(VALUE self, VALUE vlen)
-{
-    rb_warning("StringScanner#peep is obsolete; use #peek instead");
-    return strscan_peek(self, vlen);
-}
-
 static VALUE
 strscan_parse_integer(struct strscanner *p, int base, long len)
 {
@@ -1322,11 +1278,12 @@ strscan_must_ascii_compat(VALUE str)
     rb_must_asciicompat(str);
 }
 
+/* :nodoc: */
 static VALUE
 strscan_scan_base10_integer(VALUE self)
 {
     char *ptr;
-    long len = 0;
+    long len = 0, remaining_len;
     struct strscanner *p;
 
     GET_SCANNER(self, p);
@@ -1336,7 +1293,7 @@ strscan_scan_base10_integer(VALUE self)
 
     ptr = CURPTR(p);
 
-    long remaining_len = S_RESTLEN(p);
+    remaining_len = S_RESTLEN(p);
 
     if (remaining_len <= 0) {
         return Qnil;
@@ -1359,11 +1316,12 @@ strscan_scan_base10_integer(VALUE self)
     return strscan_parse_integer(p, 10, len);
 }
 
+/* :nodoc: */
 static VALUE
 strscan_scan_base16_integer(VALUE self)
 {
     char *ptr;
-    long len = 0;
+    long len = 0, remaining_len;
     struct strscanner *p;
 
     GET_SCANNER(self, p);
@@ -1373,7 +1331,7 @@ strscan_scan_base16_integer(VALUE self)
 
     ptr = CURPTR(p);
 
-    long remaining_len = S_RESTLEN(p);
+    remaining_len = S_RESTLEN(p);
 
     if (remaining_len <= 0) {
         return Qnil;
@@ -1524,28 +1482,11 @@ strscan_eos_p(VALUE self)
     return EOS_P(p) ? Qtrue : Qfalse;
 }
 
-/*
- * call-seq:
- *   empty?
- *
- * Equivalent to #eos?.
- * This method is obsolete, use #eos? instead.
- */
-
- /* :nodoc: */
-static VALUE
-strscan_empty_p(VALUE self)
-{
-    rb_warning("StringScanner#empty? is obsolete; use #eos? instead");
-    return strscan_eos_p(self);
-}
-
 /*
  * call-seq:
  *   rest?
  *
  * Returns true if and only if there is more data in the string.  See #eos?.
- * This method is obsolete; use #eos? instead.
  *
  *   s = StringScanner.new('test string')
  *   # These two are opposites
@@ -1673,7 +1614,7 @@ name_to_backref_number(struct re_registers *regs, VALUE regexp, const char* name
                                               (const unsigned char* )name_end,
                                               regs);
         if (num >= 1) {
-	        return num;
+	    return num;
         }
     }
     rb_enc_raise(enc, rb_eIndexError, "undefined group name reference: %.*s",
@@ -2053,22 +1994,6 @@ strscan_rest_size(VALUE self)
     return INT2FIX(i);
 }
 
-/*
- * call-seq:
- *   restsize
- *
- * <tt>s.restsize</tt> is equivalent to <tt>s.rest_size</tt>.
- * This method is obsolete; use #rest_size instead.
- */
-
- /* :nodoc: */
-static VALUE
-strscan_restsize(VALUE self)
-{
-    rb_warning("StringScanner#restsize is obsolete; use #rest_size instead");
-    return strscan_rest_size(self);
-}
-
 #define INSPECT_LENGTH 5
 
 /*
@@ -2267,6 +2192,13 @@ strscan_named_captures(VALUE self)
                               Ruby Interface
    ======================================================================= */
 
+/*
+ * Document-class: StringScanner::Error
+ *
+ * The error class for StringScanner.
+ * See StringScanner#unscan.
+ */
+
 /*
  * Document-class: StringScanner
  *
@@ -2287,8 +2219,6 @@ Init_strscan(void)
     ID id_scanerr = rb_intern("ScanError");
     VALUE tmp;
 
-    id_byteslice = rb_intern("byteslice");
-
     usascii_encindex = rb_usascii_encindex();
     utf8_encindex = rb_utf8_encindex();
     binary_encindex = rb_ascii8bit_encindex();
@@ -2297,6 +2227,7 @@ Init_strscan(void)
     ScanError = rb_define_class_under(StringScanner, "Error", rb_eStandardError);
     if (!rb_const_defined(rb_cObject, id_scanerr)) {
 	rb_const_set(rb_cObject, id_scanerr, ScanError);
+	rb_deprecate_constant(rb_cObject, "ScanError");
     }
     tmp = rb_str_new2(STRSCAN_VERSION);
     rb_obj_freeze(tmp);
@@ -2304,6 +2235,7 @@ Init_strscan(void)
     tmp = rb_str_new2("$Id$");
     rb_obj_freeze(tmp);
     rb_const_set(StringScanner, rb_intern("Id"), tmp);
+    rb_deprecate_constant(StringScanner, "Id");
 
     rb_define_alloc_func(StringScanner, strscan_s_allocate);
     rb_define_private_method(StringScanner, "initialize", strscan_initialize, -1);
@@ -2311,7 +2243,6 @@ Init_strscan(void)
     rb_define_singleton_method(StringScanner, "must_C_version", strscan_s_mustc, 0);
     rb_define_method(StringScanner, "reset",       strscan_reset,       0);
     rb_define_method(StringScanner, "terminate",   strscan_terminate,   0);
-    rb_define_method(StringScanner, "clear",       strscan_clear,       0);
     rb_define_method(StringScanner, "string",      strscan_get_string,  0);
     rb_define_method(StringScanner, "string=",     strscan_set_string,  1);
     rb_define_method(StringScanner, "concat",      strscan_concat,      1);
@@ -2336,11 +2267,9 @@ Init_strscan(void)
 
     rb_define_method(StringScanner, "getch",       strscan_getch,       0);
     rb_define_method(StringScanner, "get_byte",    strscan_get_byte,    0);
-    rb_define_method(StringScanner, "getbyte",     strscan_getbyte,     0);
     rb_define_method(StringScanner, "scan_byte",   strscan_scan_byte,   0);
     rb_define_method(StringScanner, "peek",        strscan_peek,        1);
     rb_define_method(StringScanner, "peek_byte",   strscan_peek_byte,   0);
-    rb_define_method(StringScanner, "peep",        strscan_peep,        1);
 
     rb_define_private_method(StringScanner, "scan_base10_integer", strscan_scan_base10_integer, 0);
     rb_define_private_method(StringScanner, "scan_base16_integer", strscan_scan_base16_integer, 0);
@@ -2350,7 +2279,6 @@ Init_strscan(void)
     rb_define_method(StringScanner, "beginning_of_line?", strscan_bol_p, 0);
     rb_alias(StringScanner, rb_intern("bol?"), rb_intern("beginning_of_line?"));
     rb_define_method(StringScanner, "eos?",        strscan_eos_p,       0);
-    rb_define_method(StringScanner, "empty?",      strscan_empty_p,     0);
     rb_define_method(StringScanner, "rest?",       strscan_rest_p,      0);
 
     rb_define_method(StringScanner, "matched?",    strscan_matched_p,   0);
@@ -2365,7 +2293,6 @@ Init_strscan(void)
 
     rb_define_method(StringScanner, "rest",        strscan_rest,        0);
     rb_define_method(StringScanner, "rest_size",   strscan_rest_size,   0);
-    rb_define_method(StringScanner, "restsize",    strscan_restsize,    0);
 
     rb_define_method(StringScanner, "inspect",     strscan_inspect,     0);
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strscan
 version: !ruby/object:Gem::Version
-  version: 3.1.5
+  version: 3.1.6
 platform: ruby
 authors:
 - Minero Aoki
@@ -74,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Provides lexical scanning operations on a String.
 test_files: []