Changes for RC

purescript · Jun 10, 2015 · b4a3a03 · b4a3a03
1 parent 14286c6
commit b4a3a03
Show file tree

Hide file tree

Showing 13 changed files with 115 additions and 351 deletions.
diff --git a/README.md b/README.md
@@ -12,9 +12,9 @@ bower install purescript-quickcheck
 
 ## Module documentation
 
-- [Test.QuickCheck](docs/Test.QuickCheck.md)
-- [Test.QuickCheck.Arbitrary](docs/Test.QuickCheck.Arbitrary.md)
-- [Test.QuickCheck.Gen](docs/Test.QuickCheck.Gen.md)
-- [Test.QuickCheck.LCG](docs/Test.QuickCheck.LCG.md)
-- [Test.QuickCheck.Data.AlphaNumString](docs/Test.QuickCheck.Data.AlphaNumString.md)
-- [Test.QuickCheck.Data.ApproxNumber](docs/Test.QuickCheck.Data.ApproxNumber.md)
+- [Test.QuickCheck](docs/Test/QuickCheck.md)
+- [Test.QuickCheck.Arbitrary](docs/Test/QuickCheck/Arbitrary.md)
+- [Test.QuickCheck.Gen](docs/Test/QuickCheck/Gen.md)
+- [Test.QuickCheck.LCG](docs/Test/QuickCheck/LCG.md)
+- [Test.QuickCheck.Data.AlphaNumString](docs/Test/QuickCheck/Data/AlphaNumString.md)
+- [Test.QuickCheck.Data.ApproxNumber](docs/Test/QuickCheck/Data/ApproxNumber.md)
diff --git a/bower.json b/bower.json
@@ -5,6 +5,10 @@
     "John A. De Goes <john@degoes.net> (http://degoes.net)",
     "Phil Freeman <freeman.phil@gmail.com>"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/purescript/purescript-quickcheck.git"
+  },
   "ignore": [
     "**/.*",
     "bower_components",
@@ -17,11 +21,14 @@
     "package.json"
   ],
   "dependencies": {
-    "purescript-random": "~0.2.0",
-    "purescript-exceptions": "~0.3.0",
-    "purescript-strings": "~0.5.0",
-    "purescript-foldable-traversable": "~0.4.0",
-    "purescript-console": "~0.1.0",
-    "purescript-math": "~0.1.1"
+    "purescript-random": "^0.2.0",
+    "purescript-exceptions": "^0.3.0",
+    "purescript-strings": "^0.5.0",
+    "purescript-arrays": "^0.4.0",
+    "purescript-lists": "^0.7.0",
+    "purescript-either": "^0.2.0",
+    "purescript-foldable-traversable": "^0.4.0",
+    "purescript-console": "^0.1.0",
+    "purescript-math": "^0.2.0"
   }
 }
diff --git a/docs/Test.QuickCheck.md → docs/Test/QuickCheck.md b/docs/Test.QuickCheck.md → docs/Test/QuickCheck.md
@@ -1,8 +1,5 @@
-# Module Documentation
-
 ## Module Test.QuickCheck
 
-
 This module is a partial port of the Haskell QuickCheck library.
 
 QuickCheck provides a way to write _property-based_ tests.
@@ -24,7 +21,7 @@ main = quickCheck \n -> n + 1 > n
 #### `QC`
 
 ``` purescript
-type QC a = forall eff. Eff (err :: EXCEPTION, random :: RANDOM, console :: CONSOLE | eff) a
+type QC a = forall eff. Eff (console :: CONSOLE, random :: RANDOM, err :: EXCEPTION | eff) a
 ```
 
 A type synonym which represents the effects used by the `quickCheck` function.
@@ -52,7 +49,7 @@ representing the number of tests which should be run.
 #### `quickCheckPure`
 
 ``` purescript
-quickCheckPure :: forall prop. (Testable prop) => Int -> Int -> prop -> [Result]
+quickCheckPure :: forall prop. (Testable prop) => Int -> Int -> prop -> List Result
 ```
 
 Test a property, returning all test results as an array.
@@ -74,44 +71,29 @@ returning a `Boolean` or `Result`.
 
 Testable properties can be passed to the `quickCheck` function.
 
-#### `testableResult`
-
+##### Instances
 ``` purescript
 instance testableResult :: Testable Result
-```
-
-
-#### `testableBoolean`
-
-``` purescript
 instance testableBoolean :: Testable Boolean
-```
-
-
-#### `testableFunction`
-
-``` purescript
 instance testableFunction :: (Arbitrary t, Testable prop) => Testable (t -> prop)
 ```
 
-
 #### `Result`
 
 ``` purescript
 data Result
-  = Success 
+  = Success
   | Failed String
 ```
 
 The result of a test: success or failure (with an error message).
 
-#### `showResult`
-
+##### Instances
 ``` purescript
+instance testableResult :: Testable Result
 instance showResult :: Show Result
 ```
 
-
 #### `(<?>)`
 
 ``` purescript
@@ -143,4 +125,3 @@ Self-documenting equality assertion
 Self-documenting inequality assertion
 
 
-
diff --git a/docs/Test.QuickCheck.Arbitrary.md → docs/Test/QuickCheck/Arbitrary.md b/docs/Test.QuickCheck.Arbitrary.md → docs/Test/QuickCheck/Arbitrary.md
@@ -1,5 +1,3 @@
-# Module Documentation
-
 ## Module Test.QuickCheck.Arbitrary
 
 #### `Arbitrary`
@@ -16,6 +14,22 @@ _randomly-generated_.
 the type `t`. Combinators in the `Test.QuickCheck.Gen`
 module can be used to construct random generators.
 
+##### Instances
+``` purescript
+instance arbBoolean :: Arbitrary Boolean
+instance arbNumber :: Arbitrary Number
+instance arbInt :: Arbitrary Int
+instance arbString :: Arbitrary String
+instance arbChar :: Arbitrary Char
+instance arbUnit :: Arbitrary Unit
+instance arbOrdering :: Arbitrary Ordering
+instance arbArray :: (Arbitrary a) => Arbitrary (Array a)
+instance arbFunction :: (Coarbitrary a, Arbitrary b) => Arbitrary (a -> b)
+instance arbTuple :: (Arbitrary a, Arbitrary b) => Arbitrary (Tuple a b)
+instance arbMaybe :: (Arbitrary a) => Arbitrary (Maybe a)
+instance arbEither :: (Arbitrary a, Arbitrary b) => Arbitrary (Either a b)
+```
+
 #### `Coarbitrary`
 
 ``` purescript
@@ -32,173 +46,20 @@ is the role of the `coarbitrary` function.
 
 `Coarbitrary` instances can be written using the `perturbGen` function.
 
-#### `arbBoolean`
-
-``` purescript
-instance arbBoolean :: Arbitrary Boolean
-```
-
-
-#### `coarbBoolean`
-
+##### Instances
 ``` purescript
 instance coarbBoolean :: Coarbitrary Boolean
-```
-
-
-#### `arbNumber`
-
-``` purescript
-instance arbNumber :: Arbitrary Number
-```
-
-
-#### `coarbNumber`
-
-``` purescript
 instance coarbNumber :: Coarbitrary Number
-```
-
-
-#### `arbInt`
-
-``` purescript
-instance arbInt :: Arbitrary Int
-```
-
-
-#### `coarbInt`
-
-``` purescript
 instance coarbInt :: Coarbitrary Int
-```
-
-
-#### `arbString`
-
-``` purescript
-instance arbString :: Arbitrary String
-```
-
-
-#### `coarbString`
-
-``` purescript
 instance coarbString :: Coarbitrary String
-```
-
-
-#### `arbChar`
-
-``` purescript
-instance arbChar :: Arbitrary Char
-```
-
-
-#### `coarbChar`
-
-``` purescript
 instance coarbChar :: Coarbitrary Char
-```
-
-
-#### `arbUnit`
-
-``` purescript
-instance arbUnit :: Arbitrary Unit
-```
-
-
-#### `coarbUnit`
-
-``` purescript
 instance coarbUnit :: Coarbitrary Unit
-```
-
-
-#### `arbOrdering`
-
-``` purescript
-instance arbOrdering :: Arbitrary Ordering
-```
-
-
-#### `coarbOrdering`
-
-``` purescript
 instance coarbOrdering :: Coarbitrary Ordering
-```
-
-
-#### `arbArray`
-
-``` purescript
-instance arbArray :: (Arbitrary a) => Arbitrary [a]
-```
-
-
-#### `coarbArray`
-
-``` purescript
-instance coarbArray :: (Coarbitrary a) => Coarbitrary [a]
-```
-
-
-#### `arbFunction`
-
-``` purescript
-instance arbFunction :: (Coarbitrary a, Arbitrary b) => Arbitrary (a -> b)
-```
-
-
-#### `coarbFunction`
-
-``` purescript
+instance coarbArray :: (Coarbitrary a) => Coarbitrary (Array a)
 instance coarbFunction :: (Arbitrary a, Coarbitrary b) => Coarbitrary (a -> b)
-```
-
-
-#### `arbTuple`
-
-``` purescript
-instance arbTuple :: (Arbitrary a, Arbitrary b) => Arbitrary (Tuple a b)
-```
-
-
-#### `coarbTuple`
-
-``` purescript
 instance coarbTuple :: (Coarbitrary a, Coarbitrary b) => Coarbitrary (Tuple a b)
-```
-
-
-#### `arbMaybe`
-
-``` purescript
-instance arbMaybe :: (Arbitrary a) => Arbitrary (Maybe a)
-```
-
-
-#### `coarbMaybe`
-
-``` purescript
 instance coarbMaybe :: (Coarbitrary a) => Coarbitrary (Maybe a)
-```
-
-
-#### `arbEither`
-
-``` purescript
-instance arbEither :: (Arbitrary a, Arbitrary b) => Arbitrary (Either a b)
-```
-
-
-#### `coarbEither`
-
-``` purescript
 instance coarbEither :: (Coarbitrary a, Coarbitrary b) => Coarbitrary (Either a b)
 ```
 
 
-
-
diff --git a/docs/Test.QuickCheck.Data.AlphaNumString.md → docs/Test/QuickCheck/Data/AlphaNumString.md b/docs/Test.QuickCheck.Data.AlphaNumString.md → docs/Test/QuickCheck/Data/AlphaNumString.md
@@ -1,5 +1,3 @@
-# Module Documentation
-
 ## Module Test.QuickCheck.Data.AlphaNumString
 
 #### `AlphaNumString`
@@ -12,19 +10,16 @@ newtype AlphaNumString
 A newtype for `String` whose `Arbitrary` instance generated random
 alphanumeric strings.
 
-#### `arbAlphaNumString`
-
+##### Instances
 ``` purescript
 instance arbAlphaNumString :: Arbitrary AlphaNumString
+instance coarbAlphaNumString :: Coarbitrary AlphaNumString
 ```
 
-
-#### `coarbAlphaNumString`
+#### `runAlphaNumString`
 
 ``` purescript
-instance coarbAlphaNumString :: Coarbitrary AlphaNumString
+runAlphaNumString :: AlphaNumString -> String
 ```
 
 
-
-