match_at 1 → 2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91f41f9404f9926d531ef6c827e0617156bb71bf
-  data.tar.gz: 28ec30a32bfd55544e760881dd91fcb8ed2a16b9
+  metadata.gz: b20934cbff3ba306998d01baf791fd6dd2ea9b4b
+  data.tar.gz: fe95877702b2dadaa6df96ce90ce9d12286efc6d
 SHA512:
-  metadata.gz: a3a19f48b310d85009e46fe2ba8bc6ba517f2b42576428da4ca57c68743171b81c1160be6093abfe6635c3b44343952a3e49b41bb04da07a44c553004070bc76
-  data.tar.gz: 1952562c10d176e24f0de5fe980447ce8ca94f9b1d8f87e4160f8c86f0541831bc0ae9e9c9172c8ad16b888d3c5068917303392f7c5c87307ca9a1c0de383052
+  metadata.gz: ad86d7bd9683a9fe869a7c29e22162a15c45d3344a0b7a9456d373366efa3f3362c4b5576f659053dbd991f952d581389d813cfb73b99c1f36f261ee48a48778
+  data.tar.gz: bc97cfe8229b2a181d6ed9cb7ac6a18013673f8bf52a8815fc13ac05a2fa9ee850422df580afa5ade387ac6c595e87a2ae465ec0fdd6be6c1e603346d94c1d02

data/.gitignore

@@ -26,6 +26,7 @@ Gemfile.lock
 coverage
 doc
 stackprof.dump
+pkg
 tmp
 vendor
 *.so

data/ext/match_at/extconf.rb

@@ -24,4 +24,4 @@
 # SOFTWARE.
 
 require 'mkmf'
-create_makefile 'match_at'
+create_makefile 'match_at/match_at'

data/ext/match_at/match_at.c

@@ -29,12 +29,33 @@ static VALUE match_at(VALUE RB_UNUSED_VAR(mod), VALUE str, VALUE rexp, VALUE pos
 static VALUE match_at_p(VALUE RB_UNUSED_VAR(mod), VALUE str, VALUE rexp, VALUE pos);
 static bool do_match(VALUE str, VALUE rexp, VALUE pos, OnigRegion *region);
 
+/**
+ * Match the rexp  against str's position pos.  This is  lightweight because no
+ * MatchData is allocated.
+ *
+ * @param str  [String]  target string.
+ * @param rexp [Regexp]  pattern to match.
+ * @param pos  [Integer] str's index, in character.
+ * @return     [true]    successful match.
+ * @return     [false]   failure in match.
+ */
 VALUE
 match_at_p(VALUE mod, VALUE str, VALUE rexp, VALUE pos)
 {
     return do_match(str, rexp, pos, NULL) ? Qtrue : Qfalse;
 }
 
+/**
+ * Try to  construct a  MatchData at  str's pos  position.  If  that's possible
+ * return the allocated MatchData.  Otherwise, returns nil.
+ *
+ * @note  It does not update `$~`.
+ * @param str  [String]    target string.
+ * @param rexp [Regexp]    pattern to match.
+ * @param pos  [Integer]   str's index, in character.
+ * @return     [MatchData] successful match.
+ * @return     [nil]       failure in match.
+ */
 VALUE
 match_at(VALUE mod, VALUE str, VALUE rexp, VALUE pos)
 {
@@ -61,11 +82,7 @@ match_at(VALUE mod, VALUE str, VALUE rexp, VALUE pos)
 }
 
 bool
-do_match(
-    VALUE vstr,
-    VALUE vreg,
-    VALUE vpos,
-    OnigRegion *region)
+do_match(VALUE vstr, VALUE vreg, VALUE vpos, OnigRegion *region)
 {
     const char *str;
     const char *end;

data/lib/match_at/version.rb

@@ -24,4 +24,4 @@
 # SOFTWARE.
 ;
 
-MatchAt::VERSION = 1
+MatchAt::VERSION = 2

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: match_at
 version: !ruby/object:Gem::Version
-  version: '1'
+  version: '2'
 platform: ruby
 authors:
 - Urabe, Shyouhei