Updates for 0.7

garyb · garyb · commit a1bf3362cfef · 2015-05-10T01:12:19.000+01:00
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ bower install purescript-control
 ## Module documentation
 
 ### Functor/Applicative
-- [Control.Functor](docs/Control.Functor.md)
+- [Data.Functor](docs/Data.Functor.md)
 - [Control.Apply](docs/Control.Apply.md)
 
 ### Monad
diff --git a/bower.json b/bower.json
@@ -1,16 +1,25 @@
 {
   "name": "purescript-control",
   "homepage": "https://github.com/purescript/purescript-control",
-  "description": "Monad and Applicative utility functions",
+  "description": "Common control classes and utility functions",
   "keywords": [
-    "purescript"
+    "purescript",
+    "functor",
+    "applicative",
+    "monad",
+    "comonad"
   ],
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/purescript/purescript-control.git"
+  },
   "ignore": [
     "**/.*",
     "bower_components",
     "node_modules",
     "output",
+    "test",
     "bower.json",
     "gulpfile.js",
     "package.json"
diff --git a/docs/Control.Alt.md b/docs/Control.Alt.md
@@ -1,8 +1,5 @@
-# Module Documentation
-
 ## Module Control.Alt
 
-
 This module defines the `Alt` type class.
 
 #### `Alt`
@@ -34,4 +31,3 @@ For example, the `Array` (`[]`) type is an instance of `Alt`, where
 An infix version of `alt`.
 
 
-
diff --git a/docs/Control.Alternative.md b/docs/Control.Alternative.md
@@ -1,15 +1,12 @@
-# Module Documentation
-
 ## Module Control.Alternative
 
-
 This module defines the `Alternative` type class and associated
 helper functions.
 
 #### `Alternative`
 
 ``` purescript
-class (Applicative f, Plus f) <= Alternative f where
+class (Applicative f, Plus f) <= Alternative f
 ```
 
 The `Alternative` type class has no members of its own; it just specifies
@@ -22,4 +19,3 @@ laws:
 - Annihilation: `empty <*> f = empty`
 
 
-
diff --git a/docs/Control.Apply.md b/docs/Control.Apply.md
@@ -1,8 +1,5 @@
-# Module Documentation
-
 ## Module Control.Apply
 
-
 This module defines helper functions for working with `Apply` instances.
 
 #### `(<*)`
@@ -58,4 +55,3 @@ Lift a function of five arguments to a function which accepts and returns
 values wrapped with the type constructor `f`.
 
 
-
diff --git a/docs/Control.Bind.md b/docs/Control.Bind.md
@@ -1,8 +1,5 @@
-# Module Documentation
-
 ## Module Control.Bind
 
-
 This module defines helper functions for working with `Bind` instances.
 
 #### `(=<<)`
@@ -51,7 +48,7 @@ Collapse two applications of a monadic type constructor into one.
 ifM :: forall a m. (Bind m) => m Boolean -> m a -> m a -> m a
 ```
 
-Execute a monadic action if a condition holds. 
+Execute a monadic action if a condition holds.
 
 For example:
 
@@ -62,4 +59,3 @@ main = ifM ((< 0.5) <$> random)
 ```
 
 
-
diff --git a/docs/Control.Comonad.md b/docs/Control.Comonad.md
@@ -1,8 +1,5 @@
-# Module Documentation
-
 ## Module Control.Comonad
 
-
 This module defines the `Comonad` type class.
 
 #### `Comonad`
@@ -24,4 +21,3 @@ Laws:
 - Right Identity: `extract (f <<= xs) = f xs`
 
 
-
diff --git a/docs/Control.Extend.md b/docs/Control.Extend.md
@@ -1,8 +1,5 @@
-# Module Documentation
-
 ## Module Control.Extend
 
-
 This module defines the `Extend` type class and associated helper functions.
 
 #### `Extend`
@@ -12,24 +9,22 @@ class (Functor w) <= Extend w where
   extend :: forall b a. (w a -> b) -> w a -> w b
 ```
 
+##### Instances
+``` purescript
+instance extendFn :: (Semigroup w) => Extend (Function w)
+```
+
 The `Extend` class defines the extension operator `(<<=)`
 which extends a local context-dependent computation to
 a global computation.
 
-`Extend` is the dual of `Bind`, and `(<<=)` is the dual of 
+`Extend` is the dual of `Bind`, and `(<<=)` is the dual of
 `(>>=)`.
 
 Laws:
 
 - Associativity: `extend f <<< extend g = extend (f <<< extend g)`
 
-#### `extendArr`
-
-``` purescript
-instance extendArr :: (Semigroup w) => Extend (Prim.Function w)
-```
-
-
 #### `(<<=)`
 
 ``` purescript
@@ -73,4 +68,3 @@ Duplicate a comonadic context.
 `duplicate` is dual to `Control.Bind.join`.
 
 
-
diff --git a/docs/Control.Lazy.md b/docs/Control.Lazy.md
@@ -1,8 +1,5 @@
-# Module Documentation
-
 ## Module Control.Lazy
 
-
 This module defines the `Lazy` type class and associated
 helper functions.
 
@@ -30,4 +27,3 @@ fix :: forall l a. (Lazy l) => (l -> l) -> l
 The `Lazy` instance allows us to generate the result lazily.
 
 
-
diff --git a/docs/Control.Monad.md b/docs/Control.Monad.md
@@ -1,8 +1,5 @@
-# Module Documentation
-
 ## Module Control.Monad
 
-
 This module defines helper functions for working with `Monad` instances.
 
 #### `when`
@@ -22,4 +19,3 @@ unless :: forall m. (Monad m) => Boolean -> m Unit -> m Unit
 Perform a monadic action unless a condition is true.
 
 
-
diff --git a/docs/Control.MonadPlus.md b/docs/Control.MonadPlus.md
@@ -1,14 +1,11 @@
-# Module Documentation
-
 ## Module Control.MonadPlus
 
-
 This module defines the `MonadPlus` type class.
 
 #### `MonadPlus`
 
 ``` purescript
-class (Monad m, Alternative m) <= MonadPlus m where
+class (Monad m, Alternative m) <= MonadPlus m
 ```
 
 The `MonadPlus` type class has no members of its own; it just specifies
@@ -43,4 +40,3 @@ factors n = do
 ```
 
 
-
diff --git a/docs/Control.Plus.md b/docs/Control.Plus.md
@@ -1,8 +1,5 @@
-# Module Documentation
-
 ## Module Control.Plus
 
-
 This module defines the `Plus` type class.
 
 #### `Plus`
@@ -26,4 +23,3 @@ kind `* -> *`, like `Array` or `List`, rather than concrete types like
 - Annihilation: `f <$> empty == empty`
 
 
-
diff --git a/docs/Data.Functor.md b/docs/Data.Functor.md
@@ -0,0 +1,21 @@
+## Module Data.Functor
+
+This module defines helper functions for working with `Functor` instances.
+
+#### `(<$)`
+
+``` purescript
+(<$) :: forall f a b. (Functor f) => a -> f b -> f a
+```
+
+Ignore the return value of a computation, using the specified return value instead.
+
+#### `($>)`
+
+``` purescript
+($>) :: forall f a b. (Functor f) => f a -> b -> f b
+```
+
+A version of `(<$)` with its arguments flipped.
+
+
diff --git a/gulpfile.js b/gulpfile.js
@@ -1,50 +1,54 @@
+/* jshint node: true */
 "use strict";
 
 var gulp = require("gulp");
+var jshint = require("gulp-jshint");
+var jscs = require("gulp-jscs");
 var plumber = require("gulp-plumber");
 var purescript = require("gulp-purescript");
-var jsvalidate = require("gulp-jsvalidate");
 
-var paths = [
+var sources = [
   "src/**/*.purs",
   "bower_components/purescript-*/src/**/*.purs"
 ];
 
-gulp.task("make", function() {
-  return gulp.src(paths)
+gulp.task("lint", function() {
+  return gulp.src("src/**/*.js")
+    .pipe(jshint())
+    .pipe(jshint.reporter())
+    .pipe(jscs());
+});
+
+gulp.task("make", ["lint"], function() {
+  return gulp.src(sources)
     .pipe(plumber())
     .pipe(purescript.pscMake());
 });
 
-gulp.task("jsvalidate", ["make"], function () {
-  return gulp.src("output/**/*.js")
+gulp.task("docs", function () {
+  return gulp.src(sources)
     .pipe(plumber())
-    .pipe(jsvalidate());
+    .pipe(purescript.pscDocs({
+      docgen: {
+        "Control.Alt": "docs/Control.Alt.md",
+        "Control.Alternative": "docs/Control.Alternative.md",
+        "Control.Apply": "docs/Control.Apply.md",
+        "Control.Bind": "docs/Control.Bind.md",
+        "Control.Comonad": "docs/Control.Comonad.md",
+        "Control.Extend": "docs/Control.Extend.md",
+        "Control.Lazy": "docs/Control.Lazy.md",
+        "Control.Monad": "docs/Control.Monad.md",
+        "Control.MonadPlus": "docs/Control.MonadPlus.md",
+        "Control.Plus": "docs/Control.Plus.md",
+        "Data.Functor": "docs/Data.Functor.md"
+      }
+    }));
 });
 
-var docTasks = [];
-
-var docTask = function(name) {
-  var taskName = "docs-" + name.toLowerCase();
-  gulp.task(taskName, function () {
-    return gulp.src("src/" + name.replace(/\./g, "/") + ".purs")
-      .pipe(plumber())
-      .pipe(purescript.pscDocs())
-      .pipe(gulp.dest("docs/" + name + ".md"));
-  });
-  docTasks.push(taskName);
-};
-
-["Control.Alt", "Control.Alternative", "Control.Apply", "Control.Bind",
- "Control.Comonad", "Control.Extend", "Control.Functor", "Control.Lazy",
- "Control.Monad", "Control.MonadPlus", "Control.Plus"].forEach(docTask);
-
-gulp.task("docs", docTasks);
-
 gulp.task("dotpsci", function () {
-  return gulp.src(paths)
+  return gulp.src(sources)
     .pipe(plumber())
     .pipe(purescript.dotPsci());
 });
 
-gulp.task("default", ["jsvalidate", "docs", "dotpsci"]);
+gulp.task("default", ["make", "docs", "dotpsci"]);
diff --git a/package.json b/package.json
@@ -2,8 +2,9 @@
   "private": true,
   "devDependencies": {
     "gulp": "^3.8.11",
-    "gulp-jsvalidate": "^1.0.1",
+    "gulp-jscs": "^1.6.0",
+    "gulp-jshint": "^1.10.0",
     "gulp-plumber": "^1.0.0",
-    "gulp-purescript": "^0.3.1"
+    "gulp-purescript": "^0.5.0"
   }
 }
diff --git a/src/Control/Alternative.purs b/src/Control/Alternative.purs
@@ -16,4 +16,3 @@ import Control.Plus
 -- | - Distributivity: `(f <|> g) <*> x == (f <*> x) <|> (g <*> x)`
 -- | - Annihilation: `empty <*> f = empty`
 class (Applicative f, Plus f) <= Alternative f
-
diff --git a/src/Control/Apply.purs b/src/Control/Apply.purs
diff --git a/src/Control/Bind.purs b/src/Control/Bind.purs
diff --git a/src/Control/Extend.purs b/src/Control/Extend.purs
diff --git a/src/Control/Monad.purs b/src/Control/Monad.purs
diff --git a/src/Data/Functor.purs b/src/Data/Functor.purs
