Merge pull request #7 from jonsterling/ready/6

Update dependencies to latest versions; add Travis integration
purescript-deprecated · Sep 10, 2015 · 80f0ddd · 80f0ddd
2 parents 7c75455 + 1696abd
commit 80f0ddd
Show file tree

Hide file tree

Showing 72 changed files with 247 additions and 82 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,6 @@
-/.*
 !/.gitignore
 /output/
 /node_modules/
 /bower_components/
 /tmp/
-/node_modules/
+/node_modules/
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,11 @@
+language: node_js
+sudo: false
+node_js:
+  - 0.12.7
+install:
+  - npm install -g gulp bower
+  - npm install
+  - bower install
+script:
+  - npm run build
+
diff --git a/MODULES.md b/MODULES.md
@@ -0,0 +1,3 @@
+## Module Base
+
+
diff --git a/bower.json b/bower.json
@@ -2,7 +2,8 @@
   "name": "purescript-base",
   "license": "MIT",
   "authors": [
-    "John A. De Goes <[email protected]> (http://degoes.net)"
+    "John A. De Goes <[email protected]> (http://degoes.net)",
+    "Jon Sterling <[email protected]> (http://jonmsterling.com)"
   ],
   "ignore": [
     "**/.*",
@@ -16,19 +17,19 @@
     "package.json"
   ],
   "dependencies": {
-    "purescript-arrays":               "^0.4.0",
+    "purescript-arrays":               "^0.4.2",
     "purescript-control":              "^0.3.0",
-    "purescript-either":               "^0.2.0",
-    "purescript-enums":                "^0.5.0",
+    "purescript-either":               "^0.2.2",
+    "purescript-enums":                "^0.7.0",
     "purescript-foldable-traversable": "^0.4.0",
-    "purescript-lists":                "^0.7.0",
+    "purescript-lists":                "^0.7.4",
     "purescript-math":                 "^0.2.0",
-    "purescript-maybe":                "^0.3.0",
+    "purescript-maybe":                "^0.3.4",
     "purescript-monoid":               "^0.3.0",
-    "purescript-strings":              "^0.5.0",
+    "purescript-strings":              "^0.7.0",
     "purescript-tuples":               "^0.4.0",
-    "purescript-console":              "^0.1.0",
+    "purescript-console":              "^0.1.1",
     "purescript-unfoldable":           "^0.4.0",
-    "purescript-integers":             "^0.2.0"
+    "purescript-integers":             "^0.2.1"
   }
 }
diff --git a/docs/Base.md b/docs/Base.md
@@ -0,0 +1,3 @@
+## Module Base
+
+
diff --git a/docs/Control/Alt.purs → docs/Control/Alt.md b/docs/Control/Alt.purs → docs/Control/Alt.md
diff --git a/docs/Control/Alternative.purs → docs/Control/Alternative.md b/docs/Control/Alternative.purs → docs/Control/Alternative.md
diff --git a/docs/Control/Apply.purs → docs/Control/Apply.md b/docs/Control/Apply.purs → docs/Control/Apply.md
diff --git a/docs/Control/Biapplicative.purs → docs/Control/Biapplicative.md b/docs/Control/Biapplicative.purs → docs/Control/Biapplicative.md
diff --git a/docs/Control/Biapply.purs → docs/Control/Biapply.md b/docs/Control/Biapply.purs → docs/Control/Biapply.md
diff --git a/docs/Control/Bind.purs → docs/Control/Bind.md b/docs/Control/Bind.purs → docs/Control/Bind.md
diff --git a/docs/Control/Comonad.purs → docs/Control/Comonad.md b/docs/Control/Comonad.purs → docs/Control/Comonad.md
diff --git a/docs/Control/Extend.purs → docs/Control/Extend.md b/docs/Control/Extend.purs → docs/Control/Extend.md
diff --git a/docs/Control/Lazy.purs → docs/Control/Lazy.md b/docs/Control/Lazy.purs → docs/Control/Lazy.md
diff --git a/docs/Control/Monad.purs → docs/Control/Monad.md b/docs/Control/Monad.purs → docs/Control/Monad.md
diff --git a/docs/Control/Monad/Eff.purs → docs/Control/Monad/Eff.md b/docs/Control/Monad/Eff.purs → docs/Control/Monad/Eff.md
diff --git a/docs/Control/Monad/Eff/Class.purs → docs/Control/Monad/Eff/Class.md b/docs/Control/Monad/Eff/Class.purs → docs/Control/Monad/Eff/Class.md
diff --git a/docs/Control/Monad/Eff/Console.purs → docs/Control/Monad/Eff/Console.md b/docs/Control/Monad/Eff/Console.purs → docs/Control/Monad/Eff/Console.md
@@ -1,5 +1,7 @@
 ## Module Control.Monad.Eff.Console
 
+Console-related functions and effect type.
+
 #### `CONSOLE`
 
 ``` purescript

diff --git a/docs/Control/Monad/Eff/Console/Unsafe.md b/docs/Control/Monad/Eff/Console/Unsafe.md
@@ -0,0 +1,21 @@
+## Module Control.Monad.Eff.Console.Unsafe
+
+Unsafe functions to display arbitrary values.
+
+#### `logAny`
+
+``` purescript
+logAny :: forall a eff. a -> Eff (console :: CONSOLE | eff) Unit
+```
+
+Write an arbitrary value to the console.
+
+#### `errorAny`
+
+``` purescript
+errorAny :: forall a eff. a -> Eff (console :: CONSOLE | eff) Unit
+```
+
+Write an error with an arbitrary value to the console.
+
+
diff --git a/docs/Control/Monad/Eff/Unsafe.purs → docs/Control/Monad/Eff/Unsafe.md b/docs/Control/Monad/Eff/Unsafe.purs → docs/Control/Monad/Eff/Unsafe.md
diff --git a/docs/Control/Monad/ST.purs → docs/Control/Monad/ST.md b/docs/Control/Monad/ST.purs → docs/Control/Monad/ST.md
diff --git a/docs/Control/MonadPlus.purs → docs/Control/MonadPlus.md b/docs/Control/MonadPlus.purs → docs/Control/MonadPlus.md
diff --git a/docs/Control/Plus.purs → docs/Control/Plus.md b/docs/Control/Plus.purs → docs/Control/Plus.md
diff --git a/docs/Data/Array.purs → docs/Data/Array.md b/docs/Data/Array.purs → docs/Data/Array.md
@@ -170,7 +170,20 @@ Running time: `O(n)` where `n` is the length of the array
 uncons :: forall a. Array a -> Maybe { head :: a, tail :: Array a }
 ```
 
-Break an array into its first element, and the remaining elements
+Break an array into its first element and remaining elements.
+
+Using `uncons` provides a way of writing code that would use cons patterns
+in Haskell or pre-PureScript 0.7:
+``` purescript
+f (x : xs) = something
+f [] = somethingElse
+```
+Becomes:
+``` purescript
+f arr = case uncons arr of
+  Just { head: x, tail: xs } -> something
+  Nothing -> somethingElse
+```
 
 #### `index`
 

diff --git a/docs/Data/Array/ST.purs → docs/Data/Array/ST.md b/docs/Data/Array/ST.purs → docs/Data/Array/ST.md
diff --git a/docs/Data/Array/Unsafe.purs → docs/Data/Array/Unsafe.md b/docs/Data/Array/Unsafe.purs → docs/Data/Array/Unsafe.md
diff --git a/docs/Data/Bifoldable.purs → docs/Data/Bifoldable.md b/docs/Data/Bifoldable.purs → docs/Data/Bifoldable.md
diff --git a/docs/Data/Bifunctor.purs → docs/Data/Bifunctor.md b/docs/Data/Bifunctor.purs → docs/Data/Bifunctor.md
diff --git a/docs/Data/Bifunctor/Clown.purs → docs/Data/Bifunctor/Clown.md b/docs/Data/Bifunctor/Clown.purs → docs/Data/Bifunctor/Clown.md
diff --git a/docs/Data/Bifunctor/Flip.purs → docs/Data/Bifunctor/Flip.md b/docs/Data/Bifunctor/Flip.purs → docs/Data/Bifunctor/Flip.md
diff --git a/docs/Data/Bifunctor/Join.purs → docs/Data/Bifunctor/Join.md b/docs/Data/Bifunctor/Join.purs → docs/Data/Bifunctor/Join.md
diff --git a/docs/Data/Bifunctor/Joker.purs → docs/Data/Bifunctor/Joker.md b/docs/Data/Bifunctor/Joker.purs → docs/Data/Bifunctor/Joker.md
diff --git a/docs/Data/Bifunctor/Product.purs → docs/Data/Bifunctor/Product.md b/docs/Data/Bifunctor/Product.purs → docs/Data/Bifunctor/Product.md
diff --git a/docs/Data/Bifunctor/Wrap.purs → docs/Data/Bifunctor/Wrap.md b/docs/Data/Bifunctor/Wrap.purs → docs/Data/Bifunctor/Wrap.md
diff --git a/docs/Data/Bitraversable.purs → docs/Data/Bitraversable.md b/docs/Data/Bitraversable.purs → docs/Data/Bitraversable.md
diff --git a/docs/Data/Char.purs → docs/Data/Char.md b/docs/Data/Char.purs → docs/Data/Char.md
@@ -26,4 +26,20 @@ fromCharCode :: Int -> Char
 
 Constructs a character from the given Unicode numeric value.
 
+#### `toLower`
+
+``` purescript
+toLower :: Char -> Char
+```
+
+Converts a character to lowercase.
+
+#### `toUpper`
+
+``` purescript
+toUpper :: Char -> Char
+```
+
+Converts a character to uppercase.
+
 
diff --git a/docs/Data/Either.purs → docs/Data/Either.md b/docs/Data/Either.purs → docs/Data/Either.md
@@ -31,6 +31,8 @@ instance foldableEither :: Foldable (Either a)
 instance bifoldableEither :: Bifoldable Either
 instance traversableEither :: Traversable (Either a)
 instance bitraversableEither :: Bitraversable Either
+instance semiringEither :: (Semiring b) => Semiring (Either a b)
+instance semigroupEither :: (Semigroup b) => Semigroup (Either a b)
 ```
 
 #### `either`

diff --git a/docs/Data/Either/Nested.purs → docs/Data/Either/Nested.md b/docs/Data/Either/Nested.purs → docs/Data/Either/Nested.md
diff --git a/docs/Data/Either/Unsafe.purs → docs/Data/Either/Unsafe.md b/docs/Data/Either/Unsafe.purs → docs/Data/Either/Unsafe.md
diff --git a/docs/Data/Enum.purs → docs/Data/Enum.md b/docs/Data/Enum.purs → docs/Data/Enum.md
diff --git a/docs/Data/Foldable.purs → docs/Data/Foldable.md b/docs/Data/Foldable.purs → docs/Data/Foldable.md
diff --git a/docs/Data/Functor.purs → docs/Data/Functor.md b/docs/Data/Functor.purs → docs/Data/Functor.md
diff --git a/docs/Data/Functor/Invariant.purs → docs/Data/Functor/Invariant.md b/docs/Data/Functor/Invariant.purs → docs/Data/Functor/Invariant.md
diff --git a/docs/Data/Int.purs → docs/Data/Int.md b/docs/Data/Int.purs → docs/Data/Int.md
@@ -10,6 +10,33 @@ Creates an `Int` from a `Number` value. The number must already be an
 integer and fall within the valid range of values for the `Int` type
 otherwise `Nothing` is returned.
 
+#### `floor`
+
+``` purescript
+floor :: Number -> Int
+```
+
+Convert a `Number` to an `Int`, by taking the closest integer equal to or
+less than the argument. Values outside the `Int` range are clamped.
+
+#### `ceil`
+
+``` purescript
+ceil :: Number -> Int
+```
+
+Convert a `Number` to an `Int`, by taking the closest integer equal to or
+greater than the argument. Values outside the `Int` range are clamped.
+
+#### `round`
+
+``` purescript
+round :: Number -> Int
+```
+
+Convert a `Number` to an `Int`, by taking the nearest integer to the
+argument. Values outside the `Int` range are clamped.
+
 #### `toNumber`
 
 ``` purescript

diff --git a/docs/Data/Int/Bits.purs → docs/Data/Int/Bits.md b/docs/Data/Int/Bits.purs → docs/Data/Int/Bits.md
diff --git a/docs/Data/Lazy.purs → docs/Data/Lazy.md b/docs/Data/Lazy.purs → docs/Data/Lazy.md
diff --git a/docs/Data/List.purs → docs/Data/List.md b/docs/Data/List.purs → docs/Data/List.md
@@ -486,7 +486,7 @@ Split a list into two parts:
 For example,
 
 ```purescript
-span (\n -> n % 2 == 1) (1 : 3 : 2 : 4 : 5 : Nil) == Tuple (1 : 3 : Nil) (2 : 4 : 5 : Nil)
+span (\n -> n % 2 == 1) (1 : 3 : 2 : 4 : 5 : Nil) == { init: (1 : 3 : Nil), rest: (2 : 4 : 5 : Nil) }
 ```
 
 Running time: `O(n)`

diff --git a/docs/Data/List/Lazy.purs → docs/Data/List/Lazy.md b/docs/Data/List/Lazy.purs → docs/Data/List/Lazy.md
diff --git a/docs/Data/List/Unsafe.purs → docs/Data/List/Unsafe.md b/docs/Data/List/Unsafe.purs → docs/Data/List/Unsafe.md
diff --git a/docs/Data/List/ZipList.purs → docs/Data/List/ZipList.md b/docs/Data/List/ZipList.purs → docs/Data/List/ZipList.md
diff --git a/docs/Data/Maybe.purs → docs/Data/Maybe.md b/docs/Data/Maybe.purs → docs/Data/Maybe.md
@@ -24,7 +24,7 @@ instance bindMaybe :: Bind Maybe
 instance monadMaybe :: Monad Maybe
 instance monadPlusMaybe :: MonadPlus Maybe
 instance extendMaybe :: Extend Maybe
-instance invariantFirst :: Invariant Maybe
+instance invariantMaybe :: Invariant Maybe
 instance semigroupMaybe :: (Semigroup a) => Semigroup (Maybe a)
 instance monoidMaybe :: (Semigroup a) => Monoid (Maybe a)
 instance semiringMaybe :: (Semiring a) => Semiring (Maybe a)
@@ -55,6 +55,22 @@ maybe x f Nothing == x
 maybe x f (Just y) == f y
 ```
 
+#### `maybe'`
+
+``` purescript
+maybe' :: forall a b. (Unit -> b) -> (a -> b) -> Maybe a -> b
+```
+
+Similar to `maybe` but for use in cases where the default value may be
+expensive to compute. As PureScript is not lazy, the standard `maybe` has
+to evaluate the default value before returning the result, whereas here
+the value is only computed when the `Maybe` is known to be `Nothing`.
+
+``` purescript
+maybe' (\_ -> x) f Nothing == x
+maybe' (\_ -> x) f (Just y) == f y
+```
+
 #### `fromMaybe`
 
 ``` purescript
@@ -70,6 +86,22 @@ fromMaybe x Nothing == x
 fromMaybe x (Just y) == y
 ```
 
+#### `fromMaybe'`
+
+``` purescript
+fromMaybe' :: forall a. (Unit -> a) -> Maybe a -> a
+```
+
+Similar to `fromMaybe` but for use in cases where the default value may be
+expensive to compute. As PureScript is not lazy, the standard `fromMaybe`
+has to evaluate the default value before returning the result, whereas here
+the value is only computed when the `Maybe` is known to be `Nothing`.
+
+``` purescript
+fromMaybe' (\_ -> x) Nothing == x
+fromMaybe' (\_ -> x) (Just y) == y
+```
+
 #### `isJust`
 
 ``` purescript

diff --git a/docs/Data/Maybe/First.purs → docs/Data/Maybe/First.md b/docs/Data/Maybe/First.purs → docs/Data/Maybe/First.md
diff --git a/docs/Data/Maybe/Last.purs → docs/Data/Maybe/Last.md b/docs/Data/Maybe/Last.purs → docs/Data/Maybe/Last.md
diff --git a/docs/Data/Maybe/Unsafe.purs → docs/Data/Maybe/Unsafe.md b/docs/Data/Maybe/Unsafe.purs → docs/Data/Maybe/Unsafe.md
@@ -10,4 +10,10 @@ A partial function that extracts the value from the `Just` data
 constructor. Passing `Nothing` to `fromJust` will throw an error at
 runtime.
 
+#### `unsafeThrow`
+
+``` purescript
+unsafeThrow :: forall a. String -> a
+```
+
 
diff --git a/docs/Data/Monoid.purs → docs/Data/Monoid.md b/docs/Data/Monoid.purs → docs/Data/Monoid.md
diff --git a/docs/Data/Monoid/Additive.purs → docs/Data/Monoid/Additive.md b/docs/Data/Monoid/Additive.purs → docs/Data/Monoid/Additive.md
diff --git a/docs/Data/Monoid/Conj.purs → docs/Data/Monoid/Conj.md b/docs/Data/Monoid/Conj.purs → docs/Data/Monoid/Conj.md
diff --git a/docs/Data/Monoid/Disj.purs → docs/Data/Monoid/Disj.md b/docs/Data/Monoid/Disj.purs → docs/Data/Monoid/Disj.md
diff --git a/docs/Data/Monoid/Dual.purs → docs/Data/Monoid/Dual.md b/docs/Data/Monoid/Dual.purs → docs/Data/Monoid/Dual.md
diff --git a/docs/Data/Monoid/Endo.purs → docs/Data/Monoid/Endo.md b/docs/Data/Monoid/Endo.purs → docs/Data/Monoid/Endo.md
diff --git a/docs/Data/Monoid/Multiplicative.purs → docs/Data/Monoid/Multiplicative.md b/docs/Data/Monoid/Multiplicative.purs → docs/Data/Monoid/Multiplicative.md
diff --git a/docs/Data/String.purs → docs/Data/String.md b/docs/Data/String.purs → docs/Data/String.md
@@ -78,6 +78,28 @@ dropWhile :: (Char -> Boolean) -> String -> String
 
 Returns the suffix remaining after `takeWhile`.
 
+#### `stripPrefix`
+
+``` purescript
+stripPrefix :: String -> String -> Maybe String
+```
+
+If the string starts with the given prefix, return the portion of the
+string left after removing it, as a Just value. Otherwise, return Nothing.
+* `stripPrefix "http:" "http://purescript.org" == Just "//purescript.org"`
+* `stripPrefix "http:" "https://purescript.org" == Nothing`
+
+#### `stripSuffix`
+
+``` purescript
+stripSuffix :: String -> String -> Maybe String
+```
+
+If the string ends with the given suffix, return the portion of the
+string left after removing it, as a Just value. Otherwise, return Nothing.
+* `stripSuffix ".exe" "psc.exe" == Just "psc"`
+* `stripSuffix ".exe" "psc" == Nothing`
+
 #### `fromCharArray`
 
 ``` purescript
@@ -120,7 +142,7 @@ lastIndexOf :: String -> String -> Maybe Int
 ```
 
 Returns the index of the last occurrence of the first string in the
-second string. Returns `-1` if there is no match.
+second string. Returns `Nothing` if there is no match.
 
 #### `lastIndexOf'`
 
@@ -178,16 +200,18 @@ Returns the string without the first `n` characters.
 count :: (Char -> Boolean) -> String -> Int
 ```
 
-Returns the number of characters in the string for which the predicate holds.
+Returns the number of contiguous characters at the beginning
+of the string for which the predicate holds.
 
 #### `split`
 
 ``` purescript
 split :: String -> String -> Array String
 ```
 
-Returns the substrings of the first string separated along occurences
-of the second string.
+Returns the substrings of the second string separated along occurences
+of the first string.
+* `split " " "hello world" == ["hello", "world"]`
 
 #### `toCharArray`
 

diff --git a/docs/Data/String/Regex.purs → docs/Data/String/Regex.md b/docs/Data/String/Regex.purs → 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`
 

diff --git a/docs/Data/String/Unsafe.purs → docs/Data/String/Unsafe.md b/docs/Data/String/Unsafe.purs → docs/Data/String/Unsafe.md
diff --git a/docs/Data/Traversable.purs → docs/Data/Traversable.md b/docs/Data/Traversable.purs → docs/Data/Traversable.md
diff --git a/docs/Data/Tuple.purs → docs/Data/Tuple.md b/docs/Data/Tuple.purs → docs/Data/Tuple.md
diff --git a/docs/Data/Tuple/Nested.purs → docs/Data/Tuple/Nested.md b/docs/Data/Tuple/Nested.purs → docs/Data/Tuple/Nested.md
diff --git a/docs/Data/Unfoldable.purs → docs/Data/Unfoldable.md b/docs/Data/Unfoldable.purs → docs/Data/Unfoldable.md
diff --git a/docs/Math.purs → docs/Math.md b/docs/Math.purs → docs/Math.md
diff --git a/docs/Prelude.purs → docs/Prelude.md b/docs/Prelude.purs → docs/Prelude.md
@@ -634,7 +634,7 @@ multiplication, division, and modulo (division remainder) operations.
 Instances must satisfy the following law in addition to the `Semiring`
 laws:
 
-- Remainder: `a / b * b + (a `mod` b) = a`
+- Remainder: ``a / b * b + (a `mod` b) = a``
 
 ##### Instances
 ``` purescript
@@ -756,7 +756,7 @@ comparing two values:
 
 `LT` - The first value is _less than_ the second.
 `GT` - The first value is _greater than_ the second.
-`EQ` - The first value is _equal to_ or _incomparable to_ the second.
+`EQ` - The first value is _equal to_ the second.
 
 ##### Instances
 ``` purescript
@@ -775,9 +775,10 @@ class (Eq a) <= Ord a where
   compare :: a -> a -> Ordering
 ```
 
-The `Ord` type class represents types which support comparisons.
+The `Ord` type class represents types which support comparisons with a
+_total order_.
 
-`Ord` instances should satisfy the laws of _partially orderings_:
+`Ord` instances should satisfy the laws of total orderings:
 
 - Reflexivity: `a <= a`
 - Antisymmetry: if `a <= b` and `b <= a` then `a = b`
@@ -835,6 +836,12 @@ _left-associative / precedence 4_
 
 Test whether one value is _non-strictly greater than_ another.
 
+#### `unsafeCompare`
+
+``` purescript
+unsafeCompare :: forall a. a -> a -> Ordering
+```
+
 #### `Bounded`
 
 ``` purescript
@@ -859,6 +866,7 @@ instance boundedBoolean :: Bounded Boolean
 instance boundedUnit :: Bounded Unit
 instance boundedOrdering :: Bounded Ordering
 instance boundedInt :: Bounded Int
+instance boundedChar :: Bounded Char
 instance boundedFn :: (Bounded b) => Bounded (a -> b)
 ```
 
@@ -880,6 +888,7 @@ instance boundedOrdBoolean :: BoundedOrd Boolean
 instance boundedOrdUnit :: BoundedOrd Unit
 instance boundedOrdOrdering :: BoundedOrd Ordering
 instance boundedOrdInt :: BoundedOrd Int
+instance boundedOrdChar :: BoundedOrd Char
 ```
 
 #### `BooleanAlgebra`