patroon 1.3.0 → 1.4.0

package/CHANGELOG.md

@@ -4,8 +4,14 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v1.4.0](https://github.com/bas080/patroon/compare/v1.3.0...v1.4.0)
+
+- Add the matches pattern helper [`249eba6`](https://github.com/bas080/patroon/commit/249eba61481ce1a8899a3474c5055e85d441b783)
+
 #### [v1.3.0](https://github.com/bas080/patroon/compare/v1.2.6...v1.3.0)
 
+> 5 October 2022
+
 - Remove testcheck from dev dependency list [`6d0bbfb`](https://github.com/bas080/patroon/commit/6d0bbfbc41a539670f9ce830c6b3f679fafaff7e)
 
 #### [v1.2.6](https://github.com/bas080/patroon/compare/v1.2.5...v1.2.6)

package/CONTRIBUTING.md

@@ -42,11 +42,11 @@ npm link patroon
 ```
 ```
 
-up to date, audited 3 packages in 1s
+up to date, audited 3 packages in 910ms
 
 found 0 vulnerabilities
 
-added 1 package, and audited 79 packages in 1s
+added 1 package, and audited 79 packages in 906ms
 
 52 packages are looking for funding
   run `npm fund` for details

package/README.md

@@ -22,6 +22,7 @@ Pattern matching in JavaScript without additional syntax.
   * [Some](#some)
   * [Multi](#multi)
   * [Predicate](#predicate)
+  * [Matches](#matches)
   * [Custom Helper](#custom-helper)
   * [Errors](#errors)
     + [NoMatchError](#nomatcherror)
@@ -46,7 +47,9 @@ npm install patroon
 ```js node -
 const {
 
+  // Match Helpers
   patroon,
+  matches,
 
   // Pattern Helpers
   every,
@@ -495,6 +498,34 @@ patroon(
 is greater than 42
 ```
 
+### Matches
+
+A pattern matching helper that can help with using patroon patterns in if
+statements and such.
+
+```js ./tape-test
+const isUser = matches({user: _})
+const isAdmin = matches({user: {admin: true}})
+
+const user = {
+  user: {
+    id: 2
+  }
+}
+
+const admin = {
+  user: {
+    id: 1,
+    admin: true
+  }
+}
+
+JSON.stringify([isUser(admin), isUser(user), isAdmin(admin), isAdmin(user)])
+```
+```
+[true,true,true,false]
+```
+
 ### Custom Helper
 
 It is very easy to write your own helpers. All the builtin helpers are really
@@ -604,7 +635,7 @@ npx nyc npm t | npx tap-nyc
 npx nyc check-coverage
 ```
 ```
-    > patroon@1.3.0 test
+    > patroon@1.4.0 test
     > tape ./src/index.test.js
     -------------|---------|----------|---------|---------|-------------------
     File         | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
@@ -615,10 +646,10 @@ npx nyc check-coverage
      walkable.js |     100 |      100 |     100 |     100 |                   
     -------------|---------|----------|---------|---------|-------------------
 
-  total:     28
-  passing:   28
+  total:     31
+  passing:   31
 
-  duration:  37.4s
+  duration:  10.7s
 
 ```
 

package/README.mz

@@ -24,7 +24,9 @@ npm install patroon
 ```js node -
 const {
 
+  // Match Helpers
   patroon,
+  matches,
 
   // Pattern Helpers
   every,
@@ -392,6 +394,31 @@ patroon(
 )([{a: 43}])
 ```
 
+### Matches
+
+A pattern matching helper that can help with using patroon patterns in if
+statements and such.
+
+```js ./tape-test
+const isUser = matches({user: _})
+const isAdmin = matches({user: {admin: true}})
+
+const user = {
+  user: {
+    id: 2
+  }
+}
+
+const admin = {
+  user: {
+    id: 1,
+    admin: true
+  }
+}
+
+JSON.stringify([isUser(admin), isUser(user), isAdmin(admin), isAdmin(user)])
+```
+
 ### Custom Helper
 
 It is very easy to write your own helpers. All the builtin helpers are really

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "patroon",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Pattern matching library",
   "repository": "github:bas080/patroon",
   "main": "./src/index.js",

package/src/index.js

@@ -108,6 +108,13 @@ function instanceOf (ctor) {
   return value => value instanceof ctor
 }
 
+function matches (pattern) {
+  return patroon(
+    pattern, true,
+    T, false
+  )
+}
+
 module.exports = Object.assign(patroon, {
   NoMatchError,
   UnevenArgumentCountError,
@@ -121,5 +128,6 @@ module.exports = Object.assign(patroon, {
   typed,
   t: typed,
   instanceOf,
+  matches,
   _: T
 })

package/src/index.test.js

@@ -5,6 +5,7 @@ const { version } = require('../package')
 const {
   reference,
   instanceOf,
+  matches,
   typed,
   t,
   ref,
@@ -227,6 +228,26 @@ test('Does not match on reference', t => {
   t.end()
 })
 
+test('Matches function', check(gen.any, gen.any, (t, a, b) => {
+  t.ok(matches(a)(a))
+  t.equals(typeof matches(a)(b), 'boolean')
+  t.end()
+}))
+
+test('Check that matches throws non patroon errors', t => {
+  class SomeError extends Error { }
+
+  const predicate = () => {
+    throw new SomeError()
+  }
+  const pattern = {
+    predicate
+  }
+
+  t.throws(() => matches(pattern)({ predicate: 2 }), SomeError)
+  t.end()
+})
+
 if (version.startsWith('2')) {
   test('Deprecated functions in version 2', t => {
     t.plan(3)

package/tape-test

@@ -4,6 +4,7 @@ cat <(echo '
 const {
   _,
   every,
+  matches,
   instanceOf,
   some,
   multi,