0.0.31

Author: lizmat

Changes

@@ -2,6 +2,10 @@ Revision history for String-Utils
 
 {{$NEXT}}
 
+0.0.31  2024-12-03T22:36:38+01:00
+    - Make "word-at" also return the ordinal number of the word in
+      string, and return Empty if not found (instead of Nil)
+
 0.0.30  2024-12-03T20:42:23+01:00
     - Add support for "word-at"
 

META6.json

@@ -30,5 +30,5 @@
   ],
   "test-depends": [
   ],
-  "version": "0.0.30"
+  "version": "0.0.31"
 }

README.md

@@ -441,10 +441,12 @@ word-at
 -------
 
 ```raku
-say word-at("foo bar baz", 5);  # (4 3)
+say word-at("foo bar baz", 5);  # (4 3 1)
 ```
 
-Returns a `List` with the start position and its length of the word found in the given string at the given position, or directly before it. Return `Nil` if no word could be found at the given position, or the position was out of range.
+Returns a `List` with the start position, the number of characters of the word, and the ordinal number of the word found in the given string at the given position, or directly before it (using `.words` semantics).
+
+Returns `Empty` if no word could be found at the given position, or the position was out of range.
 
 AUTHOR
 ======

doc/String-Utils.rakudoc

@@ -527,13 +527,15 @@ be replaced by spaces.
 
 =begin code :lang<raku>
 
-say word-at("foo bar baz", 5);  # (4 3)
+say word-at("foo bar baz", 5);  # (4 3 1)
 
 =end code
 
-Returns a C<List> with the start position and its length of the word
-found in the given string at the given position, or directly before it.
-Return C<Nil> if no word could be found at the given position, or the
+Returns a C<List> with the start position, the number of characters of
+the word, and the ordinal number of the word found in the given string
+at the given position, or directly before it (using C<.words> semantics).
+
+Returns C<Empty> if no word could be found at the given position, or the
 position was out of range.
 
 =head1 AUTHOR

lib/String/Utils.rakumod

@@ -544,34 +544,29 @@ my sub word-at(str $string, int $cursor) {
 
     # something to look at
     if $cursor >= 0 && nqp::chars($string) -> int $length {
-        if $cursor {
-            my int $last;
-            my int $pos;
-            nqp::while(
-              $last < $length && ($pos = nqp::findcclass(
-                nqp::const::CCLASS_WHITESPACE,
-                $string,
-                $last,
-                $length - $last
-              )) < $cursor,
-              ($last = $pos + 1)
-            );
-            $last >= $length
-              ?? Nil
-              !! ($last, $pos - $last)
-        }
-
-        # cursor at start, so the first word will do
-        else {
-            (0, nqp::findcclass(
-              nqp::const::CCLASS_WHITESPACE,$string,0,$length
-            ));
-        }
+        my int $last;
+        my int $pos;
+        my int $index;
+        nqp::while(
+          $last < $length && ($pos = nqp::findcclass(
+            nqp::const::CCLASS_WHITESPACE,
+            $string,
+            $last,
+            $length - $last
+          )) < $cursor,
+          nqp::stmts(
+            nqp::if($pos > $last, ++$index),
+            ($last  = $pos + 1)
+          )
+        );
+        $last >= $length || $pos == $last
+          ?? Empty
+          !! ($last, $pos - $last, $index)
     }
 
     # nothing to look at
     else {
-        Nil
+        Empty
     }
 }
 

t/01-basic.rakutest

@@ -1,7 +1,7 @@
 use Test;
 use String::Utils;
 
-plan 93;
+plan 109;
 
 is after("foobar","foo"),       "bar", 'after(foo) ok?';
 is "foobar".&after("foo"),      "bar", '.&after(foo) ok?';
@@ -117,18 +117,24 @@ my $text = "\na\n\nb\n\n\nc";
 is-deeply paragraphs($text).map(*.value).join("\n"), $text,
   'can we round-trip with .join("\n")?';
 
-is paragraphs($*PROGRAM.lines).elems, 31, 'reading from file lazily';
-
 my str $base = "a\tbb\tccc\tdddd\teeeee";
 is-deeply expand-tab($base,0), "abbcccddddeeeee", '0 removes tabs';
 is-deeply expand-tab($base,1), "a bb ccc dddd eeeee", '1 replaces tab w/space';
 is-deeply expand-tab($base,4), "a   bb  ccc dddd    eeeee", '4 is ok';
 is-deeply expand-tab("foo",4), "foo", 'no tabs ok';
 
 my str $string = "foo bar baz";
-is-deeply word-at($string, $_), Nil, "no word at $_" for -1, 12;
-is-deeply word-at($string, $_), (0,3), "'foo' at $_" for 0 .. 3;
-is-deeply word-at($string, $_), (4,3), "'bar' at $_" for 4 .. 7;
-is-deeply word-at($string, $_), (8,3), "'baz' at $_" for 8 .. 11;
+is-deeply word-at($string, $_), Empty, "no word at $_" for -1, 12;
+is-deeply word-at($string, $_), (0,3,0), "'foo' at $_" for 0 .. 3;
+is-deeply word-at($string, $_), (4,3,1), "'bar' at $_" for 4 .. 7;
+is-deeply word-at($string, $_), (8,3,2), "'baz' at $_" for 8 .. 11;
+
+$string = " foo  bar baz";
+is-deeply word-at($string, $_), Empty, "no word at $_" for -1, 0, 5, 14;
+is-deeply word-at($string, $_), ( 1,3,0), "'foo' at $_" for 1 .. 4;
+is-deeply word-at($string, $_), ( 6,3,1), "'bar' at $_" for 6 .. 9;
+is-deeply word-at($string, $_), (10,3,2), "'baz' at $_" for 10 .. 13;
+
+is paragraphs($*PROGRAM.lines).elems, 32, 'reading from file lazily';
 
 # vim: expandtab shiftwidth=4