update replace' to reflect the existence of optional capturing groups

Author: davidchambers

src/Data/String/Regex.js

@@ -67,12 +67,21 @@ exports.replace = function (r) {
   };
 };
 
-exports.replaceBy = function (r) {
-  return function (f) {
-    return function (s2) {
-      return s2.replace(r, function (match) {
-        return f(match)(Array.prototype.splice.call(arguments, 1, arguments.length - 3));
-      });
+exports._replaceBy = function (just) {
+  return function (nothing) {
+    return function (r) {
+      return function (f) {
+        return function (s) {
+          return s.replace(r, function (match) {
+            var groups = [];
+            var group, i = 1;
+            while (typeof (group = arguments[i++]) !== "number") {
+              groups.push(group == null ? nothing : just(group));
+            }
+            return f(match)(groups);
+          });
+        };
+      };
     };
   };
 };

src/Data/String/Regex.purs

@@ -1,5 +1,5 @@
 -- | Wraps Javascript's `RegExp` object that enables matching strings with
--- | patternes defined by regular expressions.
+-- | patterns defined by regular expressions.
 -- | For details of the underlying implementation, see [RegExp Reference at MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp).
 module Data.String.Regex
   ( Regex(..)
@@ -93,18 +93,25 @@ foreign import _match
 match :: Regex -> String -> Maybe (NonEmptyArray (Maybe String))
 match = _match Just Nothing
 
--- | Replaces occurences of the `Regex` with the first string. The replacement
+-- | Replaces occurrences of the `Regex` with the first string. The replacement
 -- | string can include special replacement patterns escaped with `"$"`.
 -- | See [reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace).
 foreign import replace :: Regex -> String -> String -> String
 
--- | Transforms occurences of the `Regex` using a function of the matched
--- | substring and a list of submatch strings.
--- | See the [reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace#Specifying_a_function_as_a_parameter).
-replace' :: Regex -> (String -> Array String -> String) -> String -> String
-replace' = replaceBy
+foreign import _replaceBy
+  :: (forall r. r -> Maybe r)
+  -> (forall r. Maybe r)
+  -> Regex
+  -> (String -> Array (Maybe String) -> String)
+  -> String
+  -> String
 
-foreign import replaceBy :: Regex -> (String -> Array String -> String) -> String -> String
+-- | Transforms occurrences of the `Regex` using a function of the matched
+-- | substring and a list of groups of type `Maybe String`, where `Nothing`
+-- | represents an unmatched optional capturing group.
+-- | See the [reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace#Specifying_a_function_as_a_parameter).
+replace' :: Regex -> (String -> Array (Maybe String) -> String) -> String -> String
+replace' = _replaceBy Just Nothing
 
 foreign import _search
   :: (forall r. r -> Maybe r)
@@ -118,5 +125,5 @@ foreign import _search
 search :: Regex -> String -> Maybe Int
 search = _search Just Nothing
 
--- | Split the string into an array of substrings along occurences of the `Regex`.
+-- | Split the string into an array of substrings along occurrences of the `Regex`.
 foreign import split :: Regex -> String -> Array String

test/Test/Data/String/Regex.purs

@@ -10,7 +10,7 @@ import Data.String.Regex.Unsafe (unsafeRegex)
 import Effect (Effect)
 import Effect.Console (log)
 import Partial.Unsafe (unsafePartial)
-import Prelude (type (~>), Unit, discard, not, ($), (<<<), (<>), (==))
+import Prelude (type (~>), Unit, discard, not, show, ($), (<<<), (<>), (==))
 import Test.Assert (assert)
 
 testStringRegex :: Effect Unit
@@ -34,6 +34,10 @@ testStringRegex = do
 
   log "replace'"
   assert $ replace' (unsafeRegex "-" noFlags) (\s xs -> "!") "a-b-c" == "a!b-c"
+  assert $ replace' (unsafeRegex "(foo)(bar)?" noFlags) (\s xs -> show xs) "<>" == "<>"
+  assert $ replace' (unsafeRegex "(foo)(bar)?" noFlags) (\s xs -> show xs) "<foo>" == "<[(Just \"foo\"),Nothing]>"
+  assert $ replace' (unsafeRegex "(foo)(bar)?" noFlags) (\s xs -> show xs) "<foobar>" == "<[(Just \"foo\"),(Just \"bar\")]>"
+  assert $ replace' (unsafeRegex "@(?<username>\\w+)" noFlags) (\s xs -> show xs) "@purescript" == "[(Just \"purescript\")]"
 
   log "search"
   assert $ search (unsafeRegex "b" noFlags) "abc" == Just 1