Merge pull request #475 from sanctuary-js/davidchambers/type-classes

[email protected]

Author: davidchambers

bower.json

@@ -23,7 +23,7 @@
   ],
   "dependencies": {
     "sanctuary-def": "0.14.0",
-    "sanctuary-type-classes": "7.2.0",
+    "sanctuary-type-classes": "8.0.1",
     "sanctuary-type-identifiers": "2.0.1"
   },
   "ignore": [

index.js

@@ -786,6 +786,98 @@
   //. ```
   S.invert = def('invert', {g: [Z.Group]}, [g, g], Z.invert);
 
+  //# filter :: Filterable f => (a -> Boolean) -> f a -> f a
+  //.
+  //. Curried version of [`Z.filter`][]. Discards every element which does not
+  //. satisfy the predicate.
+  //.
+  //. See also [`reject`](#reject).
+  //.
+  //. ```javascript
+  //. > S.filter(S.odd, [1, 2, 3])
+  //. [1, 3]
+  //.
+  //. > S.filter(S.odd, {x: 1, y: 2, z: 3})
+  //. {x: 1, z: 3}
+  //.
+  //. > S.filter(S.odd, S.Nothing)
+  //. Nothing
+  //.
+  //. > S.filter(S.odd, S.Just(0))
+  //. Nothing
+  //.
+  //. > S.filter(S.odd, S.Just(1))
+  //. Just(1)
+  //. ```
+  S.filter =
+  def('filter', {f: [Z.Filterable]}, [$.Predicate(a), f(a), f(a)], Z.filter);
+
+  //# reject :: Filterable f => (a -> Boolean) -> f a -> f a
+  //.
+  //. Curried version of [`Z.reject`][]. Discards every element which satisfies
+  //. the predicate.
+  //.
+  //. See also [`filter`](#filter).
+  //.
+  //. ```javascript
+  //. > S.reject(S.odd, [1, 2, 3])
+  //. [2]
+  //.
+  //. > S.reject(S.odd, {x: 1, y: 2, z: 3})
+  //. {y: 2}
+  //.
+  //. > S.reject(S.odd, S.Nothing)
+  //. Nothing
+  //.
+  //. > S.reject(S.odd, S.Just(0))
+  //. Just(0)
+  //.
+  //. > S.reject(S.odd, S.Just(1))
+  //. Nothing
+  //. ```
+  S.reject =
+  def('reject', {f: [Z.Filterable]}, [$.Predicate(a), f(a), f(a)], Z.reject);
+
+  //# takeWhile :: Filterable f => (a -> Boolean) -> f a -> f a
+  //.
+  //. Curried version of [`Z.takeWhile`][]. Discards the first element which
+  //. does not satisfy the predicate, and all subsequent elements.
+  //.
+  //. See also [`dropWhile`](#dropWhile).
+  //.
+  //. ```javascript
+  //. > S.takeWhile(S.odd, [3, 3, 3, 7, 6, 3, 5, 4])
+  //. [3, 3, 3, 7]
+  //.
+  //. > S.takeWhile(S.even, [3, 3, 3, 7, 6, 3, 5, 4])
+  //. []
+  //. ```
+  S.takeWhile =
+  def('takeWhile',
+      {f: [Z.Filterable]},
+      [$.Predicate(a), f(a), f(a)],
+      Z.takeWhile);
+
+  //# dropWhile :: Filterable f => (a -> Boolean) -> f a -> f a
+  //.
+  //. Curried version of [`Z.dropWhile`][]. Retains the first element which
+  //. does not satisfy the predicate, and all subsequent elements.
+  //.
+  //. See also [`takeWhile`](#takeWhile).
+  //.
+  //. ```javascript
+  //. > S.dropWhile(S.odd, [3, 3, 3, 7, 6, 3, 5, 4])
+  //. [6, 3, 5, 4]
+  //.
+  //. > S.dropWhile(S.even, [3, 3, 3, 7, 6, 3, 5, 4])
+  //. [3, 3, 3, 7, 6, 3, 5, 4]
+  //. ```
+  S.dropWhile =
+  def('dropWhile',
+      {f: [Z.Filterable]},
+      [$.Predicate(a), f(a), f(a)],
+      Z.dropWhile);
+
   //# map :: Functor f => (a -> b) -> f a -> f b
   //.
   //. Curried version of [`Z.map`][].
@@ -1225,82 +1317,6 @@
       [Fn(b, a), f(a), f(b)],
       Z.contramap);
 
-  //# filter :: (Applicative f, Foldable f, Monoid (f a)) => (a -> Boolean) -> f a -> f a
-  //.
-  //. Curried version of [`Z.filter`][]. Filters its second argument in
-  //. accordance with the given predicate.
-  //.
-  //. See also [`filterM`](#filterM).
-  //.
-  //. ```javascript
-  //. > S.filter(S.odd, [1, 2, 3, 4, 5])
-  //. [1, 3, 5]
-  //. ```
-  S.filter =
-  def('filter',
-      {f: [Z.Applicative, Z.Foldable, Z.Monoid]},
-      [$.Predicate(a), f(a), f(a)],
-      Z.filter);
-
-  //# filterM :: (Alternative m, Monad m) => (a -> Boolean) -> m a -> m a
-  //.
-  //. Curried version of [`Z.filterM`][]. Filters its second argument in
-  //. accordance with the given predicate.
-  //.
-  //. See also [`filter`](#filter).
-  //.
-  //. ```javascript
-  //. > S.filterM(S.odd, [1, 2, 3, 4, 5])
-  //. [1, 3, 5]
-  //.
-  //. > S.filterM(S.odd, S.Just(9))
-  //. Just(9)
-  //.
-  //. > S.filterM(S.odd, S.Just(4))
-  //. Nothing
-  //. ```
-  S.filterM =
-  def('filterM',
-      {m: [Z.Alternative, Z.Monad]},
-      [$.Predicate(a), m(a), m(a)],
-      Z.filterM);
-
-  //# takeWhile :: (Foldable f, Alternative f) => (a -> Boolean) -> f a -> f a
-  //.
-  //. Discards the first inner value which does not satisfy the predicate, and
-  //. all subsequent inner values.
-  //.
-  //. ```javascript
-  //. > S.takeWhile(S.odd, [3, 3, 3, 7, 6, 3, 5, 4])
-  //. [3, 3, 3, 7]
-  //.
-  //. > S.takeWhile(S.even, [3, 3, 3, 7, 6, 3, 5, 4])
-  //. []
-  //. ```
-  S.takeWhile =
-  def('takeWhile',
-      {f: [Z.Foldable, Z.Alternative]},
-      [$.Predicate(a), f(a), f(a)],
-      Z.takeWhile);
-
-  //# dropWhile :: (Foldable f, Alternative f) => (a -> Boolean) -> f a -> f a
-  //.
-  //. Retains the first inner value which does not satisfy the predicate, and
-  //. all subsequent inner values.
-  //.
-  //. ```javascript
-  //. > S.dropWhile(S.odd, [3, 3, 3, 7, 6, 3, 5, 4])
-  //. [6, 3, 5, 4]
-  //.
-  //. > S.dropWhile(S.even, [3, 3, 3, 7, 6, 3, 5, 4])
-  //. [3, 3, 3, 7, 6, 3, 5, 4]
-  //. ```
-  S.dropWhile =
-  def('dropWhile',
-      {f: [Z.Foldable, Z.Alternative]},
-      [$.Predicate(a), f(a), f(a)],
-      Z.dropWhile);
-
   //. ### Combinator
 
   //# I :: a -> a
@@ -1828,6 +1844,28 @@
       other.isNothing ? this : Just(Z.concat(this.value, other.value));
   }
 
+  //# Maybe#fantasy-land/filter :: Maybe a ~> (a -> Boolean) -> Maybe a
+  //.
+  //. Takes a predicate and returns `this` if `this` is a Just and this Just's
+  //. value satisfies the given predicate; Nothing otherwise.
+  //.
+  //. It is idiomatic to use [`filter`](#filter) rather than use this method
+  //. directly.
+  //.
+  //. ```javascript
+  //. > S.filter(S.odd, S.Nothing)
+  //. Nothing
+  //.
+  //. > S.filter(S.odd, S.Just(0))
+  //. Nothing
+  //.
+  //. > S.filter(S.odd, S.Just(1))
+  //. Just(1)
+  //. ```
+  Maybe.prototype['fantasy-land/filter'] = function(pred) {
+    return this.isJust && pred(this.value) ? this : Nothing;
+  };
+
   //# Maybe#fantasy-land/map :: Maybe a ~> (a -> b) -> Maybe b
   //.
   //. Takes a function and returns `this` if `this` is Nothing; otherwise
@@ -4689,13 +4727,13 @@
 //. [`Z.compose`]:      v:sanctuary-js/sanctuary-type-classes#compose
 //. [`Z.concat`]:       v:sanctuary-js/sanctuary-type-classes#concat
 //. [`Z.contramap`]:    v:sanctuary-js/sanctuary-type-classes#contramap
+//. [`Z.dropWhile`]:    v:sanctuary-js/sanctuary-type-classes#dropWhile
 //. [`Z.duplicate`]:    v:sanctuary-js/sanctuary-type-classes#duplicate
 //. [`Z.empty`]:        v:sanctuary-js/sanctuary-type-classes#empty
 //. [`Z.equals`]:       v:sanctuary-js/sanctuary-type-classes#equals
 //. [`Z.extend`]:       v:sanctuary-js/sanctuary-type-classes#extend
 //. [`Z.extract`]:      v:sanctuary-js/sanctuary-type-classes#extract
 //. [`Z.filter`]:       v:sanctuary-js/sanctuary-type-classes#filter
-//. [`Z.filterM`]:      v:sanctuary-js/sanctuary-type-classes#filterM
 //. [`Z.gt`]:           v:sanctuary-js/sanctuary-type-classes#gt
 //. [`Z.gte`]:          v:sanctuary-js/sanctuary-type-classes#gte
 //. [`Z.id`]:           v:sanctuary-js/sanctuary-type-classes#id
@@ -4706,7 +4744,9 @@
 //. [`Z.map`]:          v:sanctuary-js/sanctuary-type-classes#map
 //. [`Z.of`]:           v:sanctuary-js/sanctuary-type-classes#of
 //. [`Z.promap`]:       v:sanctuary-js/sanctuary-type-classes#promap
+//. [`Z.reject`]:       v:sanctuary-js/sanctuary-type-classes#reject
 //. [`Z.sequence`]:     v:sanctuary-js/sanctuary-type-classes#sequence
+//. [`Z.takeWhile`]:    v:sanctuary-js/sanctuary-type-classes#takeWhile
 //. [`Z.toString`]:     v:sanctuary-js/sanctuary-type-classes#toString
 //. [`Z.traverse`]:     v:sanctuary-js/sanctuary-type-classes#traverse
 //. [`Z.zero`]:         v:sanctuary-js/sanctuary-type-classes#zero

package.json

@@ -12,14 +12,14 @@
   },
   "dependencies": {
     "sanctuary-def": "0.14.0",
-    "sanctuary-type-classes": "7.2.0",
+    "sanctuary-type-classes": "8.0.1",
     "sanctuary-type-identifiers": "2.0.1"
   },
   "devDependencies": {
     "browserify": "13.1.x",
     "doctest": "0.13.x",
     "eslint": "4.9.x",
-    "fantasy-land": "3.4.0",
+    "fantasy-land": "3.5.0",
     "istanbul": "0.4.x",
     "jsverify": "0.7.x",
     "karma": "1.3.x",

test/dropWhile.js

@@ -9,7 +9,7 @@ test('dropWhile', function() {
 
   eq(typeof S.dropWhile, 'function');
   eq(S.dropWhile.length, 2);
-  eq(S.dropWhile.toString(), 'dropWhile :: (Foldable f, Alternative f) => (a -> Boolean) -> f a -> f a');
+  eq(S.dropWhile.toString(), 'dropWhile :: Filterable f => (a -> Boolean) -> f a -> f a');
 
   eq(S.dropWhile(S.odd, [3, 3, 3, 7, 6, 3, 5, 4]), [6, 3, 5, 4]);
   eq(S.dropWhile(S.even, [3, 3, 3, 7, 6, 3, 5, 4]), [3, 3, 3, 7, 6, 3, 5, 4]);

test/filter.js

@@ -1,19 +1,38 @@
 'use strict';
 
-var S = require('..');
+var S = require('./internal/sanctuary');
 
+var List = require('./internal/List');
 var eq = require('./internal/eq');
 
 
+var Cons = List.Cons;
+var Nil = List.Nil;
+
+
 test('filter', function() {
 
   eq(typeof S.filter, 'function');
   eq(S.filter.length, 2);
-  eq(S.filter.toString(), 'filter :: (Applicative f, Foldable f, Monoid f) => (a -> Boolean) -> f a -> f a');
+  eq(S.filter.toString(), 'filter :: Filterable f => (a -> Boolean) -> f a -> f a');
 
   eq(S.filter(S.odd, []), []);
   eq(S.filter(S.odd, [0, 2, 4, 6, 8]), []);
   eq(S.filter(S.odd, [1, 3, 5, 7, 9]), [1, 3, 5, 7, 9]);
   eq(S.filter(S.odd, [1, 2, 3, 4, 5]), [1, 3, 5]);
 
+  eq(S.filter(S.odd, {}), {});
+  eq(S.filter(S.odd, {x: 1}), {x: 1});
+  eq(S.filter(S.odd, {x: 1, y: 2}), {x: 1});
+  eq(S.filter(S.odd, {x: 1, y: 2, z: 3}), {x: 1, z: 3});
+
+  eq(S.filter(S.odd, S.Nothing), S.Nothing);
+  eq(S.filter(S.odd, S.Just(0)), S.Nothing);
+  eq(S.filter(S.odd, S.Just(1)), S.Just(1));
+
+  eq(S.filter(S.odd, Nil), Nil);
+  eq(S.filter(S.odd, Cons(1, Nil)), Cons(1, Nil));
+  eq(S.filter(S.odd, Cons(1, Cons(2, Nil))), Cons(1, Nil));
+  eq(S.filter(S.odd, Cons(1, Cons(2, Cons(3, Nil)))), Cons(1, Cons(3, Nil)));
+
 });

test/filterM.js

@@ -63,6 +63,14 @@ List.prototype[FL.concat] = function(other) {
     Cons(this.head, Z.concat(this.tail, other));
 };
 
+List.prototype[FL.filter] = function(pred) {
+  return this.isNil ?
+    Nil :
+    pred(this.head) ?
+      Cons(this.head, Z.filter(pred, this.tail)) :
+      Z.filter(pred, this.tail);
+};
+
 List.prototype[FL.map] = function(f) {
   return this.isNil ?
     Nil :

test/internal/List.js

@@ -0,0 +1,38 @@
+'use strict';
+
+var S = require('./internal/sanctuary');
+
+var List = require('./internal/List');
+var eq = require('./internal/eq');
+
+
+var Cons = List.Cons;
+var Nil = List.Nil;
+
+
+test('reject', function() {
+
+  eq(typeof S.reject, 'function');
+  eq(S.reject.length, 2);
+  eq(S.reject.toString(), 'reject :: Filterable f => (a -> Boolean) -> f a -> f a');
+
+  eq(S.reject(S.odd, []), []);
+  eq(S.reject(S.odd, [0, 2, 4, 6, 8]), [0, 2, 4, 6, 8]);
+  eq(S.reject(S.odd, [1, 3, 5, 7, 9]), []);
+  eq(S.reject(S.odd, [1, 2, 3, 4, 5]), [2, 4]);
+
+  eq(S.reject(S.odd, {}), {});
+  eq(S.reject(S.odd, {x: 1}), {});
+  eq(S.reject(S.odd, {x: 1, y: 2}), {y: 2});
+  eq(S.reject(S.odd, {x: 1, y: 2, z: 3}), {y: 2});
+
+  eq(S.reject(S.odd, S.Nothing), S.Nothing);
+  eq(S.reject(S.odd, S.Just(0)), S.Just(0));
+  eq(S.reject(S.odd, S.Just(1)), S.Nothing);
+
+  eq(S.reject(S.odd, Nil), Nil);
+  eq(S.reject(S.odd, Cons(1, Nil)), Nil);
+  eq(S.reject(S.odd, Cons(1, Cons(2, Nil))), Cons(2, Nil));
+  eq(S.reject(S.odd, Cons(1, Cons(2, Cons(3, Nil)))), Cons(2, Nil));
+
+});

test/reject.js

@@ -9,7 +9,7 @@ test('takeWhile', function() {
 
   eq(typeof S.takeWhile, 'function');
   eq(S.takeWhile.length, 2);
-  eq(S.takeWhile.toString(), 'takeWhile :: (Foldable f, Alternative f) => (a -> Boolean) -> f a -> f a');
+  eq(S.takeWhile.toString(), 'takeWhile :: Filterable f => (a -> Boolean) -> f a -> f a');
 
   eq(S.takeWhile(S.odd, [3, 3, 3, 7, 6, 3, 5, 4]), [3, 3, 3, 7]);
   eq(S.takeWhile(S.even, [3, 3, 3, 7, 6, 3, 5, 4]), []);