patroon 0.0.5 → 0.1.2

package/.nycrc

@@ -0,0 +1,6 @@
+{
+  "branches": 100,
+  "lines": 100,
+  "functions": 100,
+  "statements": 100
+}

package/README.md

@@ -1,5 +1,8 @@
 # Patroon
 
+![Code Coverage](https://img.shields.io/badge/coverage-100%25-green?style=flat-square)
+![NPM](https://img.shields.io/npm/v/patroon?color=blue&style=flat-square)
+
 Pattern matching in Javascript without additional syntax.
 
 ## Implementation
@@ -13,10 +16,41 @@ Pattern matching in Javascript without additional syntax.
 3. [./src/helpers.js][4] - You might have noticed that both the patroon and
    walkable modules have common helper functions.
 
+## Installation
+
+[Patroon][9] is hosted on the NPM repository.
+
+```bash
+npm install patroon
+```
+
 ## Specifications
 
 Let's see what valid and less valid uses of patroon are.
 
+### Primitives
+
+The simplest thing one can do is match on a primitive.
+
+```js ./tape-test
+t.equal(patroon(
+  2, 3,
+  1, 2
+)(1), 2)
+t.end()
+```
+
+### Regular Expressions
+
+Will check if a Regex matches the passed string using the `.test` method.
+
+```js ./tape-test
+patroon(
+  /^bunion/, fail,
+  /^banana/,end
+)('banana tree')
+```
+
 ### Arrays
 
 A less intuitive case (at least initially) is the matching with an empty array.
@@ -31,7 +65,7 @@ patroon(
 Notice that the empty array matches with `[1]`. This is because the empty array
 is a subset of `[1]`.
 
-In this case you might as well write the following for readability sake:
+You might as well write the following for readability sake:
 
 ```js ./tape-test
 patroon(
@@ -39,8 +73,8 @@ patroon(
 )([1])
 ```
 
-Patroon even tries to determine if something is a constructor. No need to use
-typed in that case.
+Patroon tries to determine if something is a constructor. No need to use typed
+for this case.
 
 ```js ./tape-test
 patroon(
@@ -49,7 +83,8 @@ patroon(
 )([1])
 ```
 
-If you wish to match on the reference of a constructor you can use the `ref` helper.
+If you wish to match on the reference of a constructor you can use the `ref`
+helper.
 
 ```js ./tape-test
 patroon(
@@ -76,6 +111,20 @@ t.equal(arrayMatch([2, 3]), 1)
 t.end()
 ```
 
+How to define default argument values:
+
+```js ./tape-test
+const count = patroon(
+  [_], ([, ...xs], n=0) => count(xs, n + 1),
+  [], (array, c=0) => c
+)
+
+t.equal(count([]), 0)
+t.equal(count([1]), 1)
+t.equal(count([1, 2]), 2)
+t.end()
+```
+
 The array pattern assumes that the array has rest elements. It's a design
 choice which avoids adding additional helpers with little to no downsides.
 
@@ -116,10 +165,10 @@ const toPairs = patroon(
   _, (_, p = []) => p
 )
 
-t.deepEquals(toPairs([1]), [])
-t.deepEquals(toPairs([1, 2]), [[1, 2]])
-t.deepEquals(toPairs([1, 2, 3]), [[1, 2]])
-t.deepEquals(toPairs([1, 2, 3, 4]), [[1, 2], [3, 4]])
+t.deepEqual(toPairs([1]), [])
+t.deepEqual(toPairs([1, 2]), [[1, 2]])
+t.deepEqual(toPairs([1, 2, 3]), [[1, 2]])
+t.deepEqual(toPairs([1, 2, 3, 4]), [[1, 2], [3, 4]])
 t.end()
 ```
 
@@ -131,7 +180,7 @@ So that's arrays. What about objects.
 
 ### Objects
 
-Just like an empty array; matching on an empty object can be written in two
+Just like an empty array; matching on an empty object can be written in three
 ways.
 
 ```js ./tape-test
@@ -195,6 +244,7 @@ patroon(
 ```
 
 An object of a certain type might also have values we would want to match on.
+Here you do need to use the typed helper.
 
 ```js ./tape-test
 patroon(
@@ -250,37 +300,72 @@ patroon(
 )([{a: 42}])
 ```
 
+### Custom Helpers
+
+It is very easy to write your own helpers. All the builtin helpers are really
+just predicates. Let's look at the source of one of these helpers, the simplest
+one being the `_` helper.
+
+```js
+const _ = () => true
+```
+
+Other more complex helpers like the typed helper are also predicates. See the
+[./src/index.js][3] if you are interested in their implementation.
+
 ## Tests
 
 Now for some additional edge cases and some generative testing.
 [./src/index.test.js][5]
 
+First make sure the dependencies are clean.
+
+```bash bash &> /dev/null
+npm i && npm prune
+```
+
+We also care about code coverage so we'll use [nyc][8] to generate a coverage
+report.
+
 ```bash bash
-npm test
+npx nyc npm t && npx nyc check-coverage
 ```
 ```
 
-> patroon@0.0.5 test
+> patroon@0.1.2 test
 > tape ./src/index.test.js
 
 TAP version 13
+# Matches on a simple primitive
+ok 1 should be strictly equal
+# Matches using a RegExp
+# Match using reference
+# Matches on type and value
 # Matches always when pattern equals value
 # Matches none of the patterns and throws
-ok 1 should be truthy
+ok 2 should be truthy
 # Does not match when a value does not exist
 # Throws when a typed does not receice a constructor
-ok 2 should be truthy
-# Throws in a predicate function
 ok 3 should be truthy
-# Throws when an uneven amount of arguments are passed
+# Throws in a predicate function
 ok 4 should be truthy
+# Throws when an uneven amount of arguments are passed
+ok 5 should be truthy
 
-1..4
-# tests 4
-# pass  4
+1..5
+# tests 5
+# pass  5
 
 # ok
 
+-------------|---------|----------|---------|---------|-------------------
+File         | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
+-------------|---------|----------|---------|---------|-------------------
+All files    |     100 |      100 |     100 |     100 |                   
+ helpers.js  |     100 |      100 |     100 |     100 |                   
+ index.js    |     100 |      100 |     100 |     100 |                   
+ walkable.js |     100 |      100 |     100 |     100 |                   
+-------------|---------|----------|---------|---------|-------------------
 ```
 
 ## Formatting
@@ -291,12 +376,16 @@ Standard is good enough.
 npx standard || npx standard --fix
 ```
 
+## Stackoverflow
+
+This project is mentioned in the following [stackoverflow question][7].
+
 ## Documentation
 
 The README.md is generated using [markatzea][6].
 
-```bash bash
-test "$RECUR" -eq 1 || RECUR=1 markatzea README.mz | tee README.md
+```bash
+markatzea README.mz > README.md
 ```
 
 ## Contribute
@@ -304,11 +393,11 @@ test "$RECUR" -eq 1 || RECUR=1 markatzea README.mz | tee README.md
 You may contribute in whatever manner you see fit. Do try to be helpful and
 polite. Some suggestions for contributions:
 
-- [ ] Matching on strings in a similar manner to arrays.
-- [ ] Allow regular expressions for matching strings.
+- [ ] A fitting logo.
 - [ ] Find and report bugs and inconsistencies.
+- [ ] Improve documentation.
+- [ ] Prevent exceeding stack size by managing recursive patterns.
 - [ ] Suggest API improvements in naming and functionality.
-- [ ] A fitting logo.
 
 [1]:https://en.wikipedia.org/wiki/Tree_traversal
 [2]:https://github.com/bas080/patroon/blob/master/src/walkable.js
@@ -316,3 +405,6 @@ polite. Some suggestions for contributions:
 [4]:https://github.com/bas080/patroon/blob/master/src/helpers.js
 [5]:https://github.com/bas080/patroon/blob/master/src/index.test.js
 [6]:https://github.com/bas080/markatzea
+[7]:https://stackoverflow.com/questions/50452844/functional-programming-style-pattern-matching-in-javascript/67376827#67376827
+[8]:https://github.com/istanbuljs/nyc
+[9]:https://www.npmjs.com/package/patroon

package/README.mz

@@ -1,5 +1,8 @@
 # Patroon
 
+![Code Coverage](https://img.shields.io/badge/coverage-100%25-green?style=flat-square)
+![NPM](https://img.shields.io/npm/v/patroon?color=blue&style=flat-square)
+
 Pattern matching in Javascript without additional syntax.
 
 ## Implementation
@@ -13,10 +16,41 @@ Pattern matching in Javascript without additional syntax.
 3. [./src/helpers.js][4] - You might have noticed that both the patroon and
    walkable modules have common helper functions.
 
+## Installation
+
+[Patroon][9] is hosted on the NPM repository.
+
+```bash
+npm install patroon
+```
+
 ## Specifications
 
 Let's see what valid and less valid uses of patroon are.
 
+### Primitives
+
+The simplest thing one can do is match on a primitive.
+
+```js ./tape-test
+t.equal(patroon(
+  2, 3,
+  1, 2
+)(1), 2)
+t.end()
+```
+
+### Regular Expressions
+
+Will check if a Regex matches the passed string using the `.test` method.
+
+```js ./tape-test
+patroon(
+  /^bunion/, fail,
+  /^banana/,end
+)('banana tree')
+```
+
 ### Arrays
 
 A less intuitive case (at least initially) is the matching with an empty array.
@@ -31,7 +65,7 @@ patroon(
 Notice that the empty array matches with `[1]`. This is because the empty array
 is a subset of `[1]`.
 
-In this case you might as well write the following for readability sake:
+You might as well write the following for readability sake:
 
 ```js ./tape-test
 patroon(
@@ -39,8 +73,8 @@ patroon(
 )([1])
 ```
 
-Patroon even tries to determine if something is a constructor. No need to use
-typed in that case.
+Patroon tries to determine if something is a constructor. No need to use typed
+for this case.
 
 ```js ./tape-test
 patroon(
@@ -49,7 +83,8 @@ patroon(
 )([1])
 ```
 
-If you wish to match on the reference of a constructor you can use the `ref` helper.
+If you wish to match on the reference of a constructor you can use the `ref`
+helper.
 
 ```js ./tape-test
 patroon(
@@ -76,6 +111,20 @@ t.equal(arrayMatch([2, 3]), 1)
 t.end()
 ```
 
+How to define default argument values:
+
+```js ./tape-test
+const count = patroon(
+  [_], ([, ...xs], n=0) => count(xs, n + 1),
+  [], (array, c=0) => c
+)
+
+t.equal(count([]), 0)
+t.equal(count([1]), 1)
+t.equal(count([1, 2]), 2)
+t.end()
+```
+
 The array pattern assumes that the array has rest elements. It's a design
 choice which avoids adding additional helpers with little to no downsides.
 
@@ -116,10 +165,10 @@ const toPairs = patroon(
   _, (_, p = []) => p
 )
 
-t.deepEquals(toPairs([1]), [])
-t.deepEquals(toPairs([1, 2]), [[1, 2]])
-t.deepEquals(toPairs([1, 2, 3]), [[1, 2]])
-t.deepEquals(toPairs([1, 2, 3, 4]), [[1, 2], [3, 4]])
+t.deepEqual(toPairs([1]), [])
+t.deepEqual(toPairs([1, 2]), [[1, 2]])
+t.deepEqual(toPairs([1, 2, 3]), [[1, 2]])
+t.deepEqual(toPairs([1, 2, 3, 4]), [[1, 2], [3, 4]])
 t.end()
 ```
 
@@ -131,7 +180,7 @@ So that's arrays. What about objects.
 
 ### Objects
 
-Just like an empty array; matching on an empty object can be written in two
+Just like an empty array; matching on an empty object can be written in three
 ways.
 
 ```js ./tape-test
@@ -195,6 +244,7 @@ patroon(
 ```
 
 An object of a certain type might also have values we would want to match on.
+Here you do need to use the typed helper.
 
 ```js ./tape-test
 patroon(
@@ -250,13 +300,35 @@ patroon(
 )([{a: 42}])
 ```
 
+### Custom Helpers
+
+It is very easy to write your own helpers. All the builtin helpers are really
+just predicates. Let's look at the source of one of these helpers, the simplest
+one being the `_` helper.
+
+```js
+const _ = () => true
+```
+
+Other more complex helpers like the typed helper are also predicates. See the
+[./src/index.js][3] if you are interested in their implementation.
+
 ## Tests
 
 Now for some additional edge cases and some generative testing.
 [./src/index.test.js][5]
 
+First make sure the dependencies are clean.
+
+```bash bash &> /dev/null
+npm i && npm prune
+```
+
+We also care about code coverage so we'll use [nyc][8] to generate a coverage
+report.
+
 ```bash bash
-npm test
+npx nyc npm t && npx nyc check-coverage
 ```
 
 ## Formatting
@@ -267,12 +339,16 @@ Standard is good enough.
 npx standard || npx standard --fix
 ```
 
+## Stackoverflow
+
+This project is mentioned in the following [stackoverflow question][7].
+
 ## Documentation
 
 The README.md is generated using [markatzea][6].
 
-```bash bash
-test "$RECUR" -eq 1 || RECUR=1 markatzea README.mz | tee README.md
+```bash
+markatzea README.mz > README.md
 ```
 
 ## Contribute
@@ -280,11 +356,11 @@ test "$RECUR" -eq 1 || RECUR=1 markatzea README.mz | tee README.md
 You may contribute in whatever manner you see fit. Do try to be helpful and
 polite. Some suggestions for contributions:
 
-- [ ] Matching on strings in a similar manner to arrays.
-- [ ] Allow regular expressions for matching strings.
+- [ ] A fitting logo.
 - [ ] Find and report bugs and inconsistencies.
+- [ ] Improve documentation.
+- [ ] Prevent exceeding stack size by managing recursive patterns.
 - [ ] Suggest API improvements in naming and functionality.
-- [ ] A fitting logo.
 
 [1]:https://en.wikipedia.org/wiki/Tree_traversal
 [2]:https://github.com/bas080/patroon/blob/master/src/walkable.js
@@ -292,3 +368,6 @@ polite. Some suggestions for contributions:
 [4]:https://github.com/bas080/patroon/blob/master/src/helpers.js
 [5]:https://github.com/bas080/patroon/blob/master/src/index.test.js
 [6]:https://github.com/bas080/markatzea
+[7]:https://stackoverflow.com/questions/50452844/functional-programming-style-pattern-matching-in-javascript/67376827#67376827
+[8]:https://github.com/istanbuljs/nyc
+[9]:https://www.npmjs.com/package/patroon

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "patroon",
-  "version": "0.0.5",
+  "version": "0.1.2",
   "description": "Pattern matching library",
   "repository": "github:bas080/patroon",
   "main": "./src/index.js",
@@ -8,8 +8,16 @@
     "test": "tape ./src/index.test.js"
   },
   "keywords": [
+    "array",
+    "condition",
+    "match",
+    "matching",
+    "object",
     "pattern",
-    "matching"
+    "pattern-matching",
+    "predicate",
+    "types",
+    "string"
   ],
   "author": "Bassim Huis",
   "license": "GPLv3",

package/src/helpers.js

@@ -12,7 +12,12 @@ function isConstructor (func) {
   return Boolean(func && typeof func === 'function' && func.prototype && func.prototype.constructor)
 }
 
+function isDefined (x) {
+  return x != null
+}
+
 module.exports = {
+  isDefined,
   always: x => () => x,
   isConstructor,
   toPairs,
@@ -26,7 +31,7 @@ module.exports = {
     }
 
     return instance =>
-      instance.constructor === Ctor || instance instanceof Ctor
+      isDefined(instance) && (instance.constructor === Ctor || instance instanceof Ctor)
   },
   tryCatch (tryFn, catchFn) {
     return (...args) => {
@@ -45,8 +50,5 @@ module.exports = {
   },
   isFunction (x) {
     return typeof x === 'function'
-  },
-  isDefined (x) {
-    return x != null
   }
 }

package/src/index.js

@@ -1,16 +1,24 @@
 const { mapLeaves, path, PathError } = require('./walkable')()
 const { isConstructor, isFunction, equals, T, is, tryCatch, isEven, isNil, toPairs, always } = require('./helpers')
 
+const isRegExp = is(RegExp)
+
 const match = pattern => {
   // TODO: also check if something is a constructor
 
+  const normalize = (value, pth) => {
+    if (isRegExp(value)) return arg => value.test(arg)
+
+    if (isConstructor(value)) { return typed(value) }
+
+    if (isFunction(value)) { return arg => value(path(pth, arg)) }
+
+    return arg => equals(path(pth, arg), value)
+  }
+
   const patternPredicates = mapLeaves(
     (value, pth) => tryCatch(
-      isConstructor(value)
-        ? typed(value)
-        : (isFunction(value)
-            ? arg => value(path(pth, arg))
-            : arg => equals(path(pth, arg), value)),
+      normalize(value, pth),
       e => {
         if (e instanceof PathError) { return false }
 

package/src/index.test.js

@@ -1,12 +1,44 @@
 const { test } = require('tape')
 const { check, gen } = require('tape-check')
 const {
+  ref,
   patroon,
   typed,
   NoMatchError,
   _
 } = require('./index')
 
+test('Matches on a simple primitive', t => {
+  t.equal(patroon(
+    1, 2,
+    2, 3
+  )(2), 3)
+  t.end()
+})
+
+test('Matches using a RegExp', t => {
+  patroon(
+    /^bunion/, () => t.fail(),
+    /^banana/, () => t.end()
+  )('banana tree')
+})
+
+test('Match using reference', t => {
+  patroon(
+    1, () => t.fail(),
+    Number, () => t.fail(),
+    ref(Number), t.end()
+  )(Number)
+})
+
+test('Matches on type and value', t => {
+  patroon(
+    typed(Error, { x: 20 }), () => t.fail(),
+    typed(Error, { x: 10 }), () => t.end(),
+    typed(Error), () => t.fail()
+  )(Object.assign(new Error(), { x: 10 }))
+})
+
 test('Matches always when pattern equals value', check(gen.any, (t, val) => {
   patroon(val, () => t.end())(val)
 }))

package/src/walkable.js

@@ -1,4 +1,4 @@
-const { isFunction, isDefined } = require('./helpers')
+const { isFunction, isNil } = require('./helpers')
 
 function walk (config, transform, item, path = []) {
   if (config.isLeafe(item)) { return transform(item, path) }
@@ -25,7 +25,7 @@ function isObject (v) {
 }
 
 function isLeafe (x) {
-  return Number.isNaN(x) || !isDefined(x) || isFunction(x) || (!isObject(x) && !isArray(x))
+  return Number.isNaN(x) || isNil(x) || x instanceof RegExp || isFunction(x) || (!isObject(x) && !isArray(x))
 }
 
 function mapLeaves (config, cb, item) {