tests, changes, and fixes

Testing
--

* Added `test/` directory.
* Added `pulp test` to the `build` script.
* New dev dependencies `purescript-assert` and `purescript-console`

Breaking changes
--

* `Data.String.Regex.search` now gives back `Maybe Int`.
    * `Nothing` for no match instead of `-1`.
* `Data.Char.toUpperChar` is now `Data.Char.toUpper`.
* `Data.Char.toLowerChar` is now `Data.Char.toLower`.

Bug fixes
--

* `Data.String.indexOf'` wrong for index out of bounds.
* `Data.String.lastIndexOf'` wrong for index out of bounds.
* `Data.String.localeCompare` off by 1.

Notes
--

The vast majority of functions have at least one test case.

Lots of room for more though, especially in `Data.String.Regex`!

Tests could also be added for checking that the unsafe functions throw in the documented ways.

Author: LiamGoodacre

bower.json

@@ -20,5 +20,9 @@
   ],
   "dependencies": {
     "purescript-maybe": "^0.3.0"
+  },
+  "devDependencies": {
+    "purescript-assert": "~0.1.0",
+    "purescript-console": "~0.1.0"
   }
 }

docs/Data/Char.md

@@ -26,18 +26,18 @@ fromCharCode :: Int -> Char
 
 Constructs a character from the given Unicode numeric value.
 
-#### `toLowerChar`
+#### `toLower`
 
 ``` purescript
-toLowerChar :: Char -> Char
+toLower :: Char -> Char
 ```
 
 Converts a character to lowercase.
 
-#### `toUpperChar`
+#### `toUpper`
 
 ``` purescript
-toUpperChar :: Char -> Char
+toUpper :: Char -> Char
 ```
 
 Converts a character to uppercase.

docs/Data/String/Regex.md

@@ -115,11 +115,11 @@ See the [reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
 #### `search`
 
 ``` purescript
-search :: Regex -> String -> Int
+search :: Regex -> String -> Maybe Int
 ```
 
-Returns the index of the first match of the `Regex` in the string, or
-`-1` if there is no match.
+Returns `Just` the index of the first match of the `Regex` in the string,
+or `Nothing` if there is no match.
 
 #### `split`
 

package.json

@@ -2,7 +2,7 @@
   "private": true,
   "scripts": {
     "postinstall": "pulp dep install",
-    "build": "jshint src && jscs src && pulp build && rimraf docs && pulp docs"
+    "build": "jshint src && jscs src && pulp build && pulp test && rimraf docs && pulp docs"
   },
   "devDependencies": {
     "jscs": "^1.13.1",

src/Data/Char.js

@@ -15,10 +15,10 @@ exports.fromCharCode = function (c) {
   return String.fromCharCode(c);
 };
 
-exports.toLowerChar = function (c) {
+exports.toLower = function (c) {
   return c.toLowerCase();
 };
 
-exports.toUpperChar = function (c) {
+exports.toUpper = function (c) {
   return c.toUpperCase();
 };

src/Data/Char.purs

@@ -3,8 +3,8 @@ module Data.Char
   ( toString
   , fromCharCode
   , toCharCode
-  , toLowerChar
-  , toUpperChar
+  , toLower
+  , toUpper
   ) where
 
 import Prelude
@@ -19,10 +19,10 @@ foreign import toCharCode :: Char -> Int
 foreign import fromCharCode :: Int -> Char
 
 -- | Converts a character to lowercase.
-foreign import toLowerChar :: Char -> Char
+foreign import toLower :: Char -> Char
 
 -- | Converts a character to uppercase.
-foreign import toUpperChar :: Char -> Char
+foreign import toUpper :: Char -> Char
 
 -- | Characters fall within the Unicode range.
 instance boundedChar :: Bounded Char where

src/Data/String.js

@@ -51,6 +51,7 @@ exports["_indexOf'"] = function (just) {
     return function (x) {
       return function (startAt) {
         return function (s) {
+          if (startAt < 0 || startAt > s.length) return nothing;
           var i = s.indexOf(x, startAt);
           return i === -1 ? nothing : just(i);
         };
@@ -75,6 +76,7 @@ exports["_lastIndexOf'"] = function (just) {
     return function (x) {
       return function (startAt) {
         return function (s) {
+          if (startAt < 0 || startAt > s.length) return nothing;
           var i = s.lastIndexOf(x, startAt);
           return i === -1 ? nothing : just(i);
         };
@@ -93,7 +95,7 @@ exports._localeCompare = function (lt) {
       return function (s1) {
         return function (s2) {
           var result = s1.localeCompare(s2);
-          return result < 0 ? lt : result > 1 ? gt : eq;
+          return result < 0 ? lt : result > 0 ? gt : eq;
         };
       };
     };

src/Data/String.purs

@@ -33,7 +33,7 @@ module Data.String
   ) where
 
 import Prelude
-import Data.Char
+import qualified Data.Char as C
 import Data.Maybe (Maybe(..), isJust)
 import Data.Monoid (Monoid)
 import qualified Data.String.Unsafe as U
@@ -50,7 +50,7 @@ foreign import _charAt :: (forall a. a -> Maybe a)
 
 -- | Returns a string of length `1` containing the given character.
 fromChar :: Char -> String
-fromChar = toString
+fromChar = C.toString
 
 -- | Returns a string of length `1` containing the given character.
 -- | Same as `fromChar`.

src/Data/String/Regex.js

@@ -70,9 +70,14 @@ exports["replace'"] = function (r) {
   };
 };
 
-exports.search = function (r) {
-  return function (s) {
-    return s.search(r);
+exports._search = function (just) {
+  return function (nothing) {
+    return function (r) {
+      return function (s) {
+        var result = s.search(r);
+        return result === -1 ? nothing : just(result);
+      };
+    };
   };
 };
 

src/Data/String/Regex.purs

@@ -104,9 +104,16 @@ foreign import replace :: Regex -> String -> String -> String
 -- | See the [reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace#Specifying_a_function_as_a_parameter).
 foreign import replace' :: Regex -> (String -> Array String -> String) -> String -> String
 
--- | Returns the index of the first match of the `Regex` in the string, or
--- | `-1` if there is no match.
-foreign import search :: Regex -> String -> Int
+foreign import _search :: (forall r. r -> Maybe r)
+                       -> (forall r. Maybe r)
+                       -> Regex
+                       -> String
+                       -> Maybe Int
+
+-- | Returns `Just` the index of the first match of the `Regex` in the string,
+-- | or `Nothing` if there is no match.
+search :: Regex -> String -> Maybe Int
+search = _search Just Nothing
 
 -- | Split the string into an array of substrings along occurences of the `Regex`.
 foreign import split :: Regex -> String -> Array String