rubico 2.0.1 → 2.2.0

package/monad/PossiblePromise.js

@@ -1,144 +0,0 @@
-/* rubico v1.5.0
- * https://github.com/a-synchronous/rubico
- * (c) 2019-2020 Richard Tong
- * rubico may be freely distributed under the MIT license.
- */
-
-'use strict'
-
-const isPromise = value => value != null && typeof value.then == 'function'
-
-const promiseAll = Promise.all.bind(Promise)
-
-/**
- * @name PossiblePromise
- *
- * @synopsis
- * new PossiblePromise(value Promise|any) -> PossiblePromise
- *
- * @catchphrase
- * Possibly a Promise
- */
-const PossiblePromise = function(value) {
-  this.value = value
-}
-
-/**
- * @name PossiblePromise.prototype.then
- *
- * @synopsis
- * new PossiblePromise(value Promise|any).then(func function) -> Promise|any
- *
- * @catchphrase
- * .then if internal Promise, else call
- */
-PossiblePromise.prototype.then = function(func) {
-  const value = this.value
-  return isPromise(value) ? value.then(func) : func(value)
-}
-
-/**
- * @name PossiblePromise.then
- *
- * @synopsis
- * PossiblePromise.then(value Promise|any, func function) -> Promise|any
- *
- * @catchphrase
- * .then if passed a Promise, else call
- */
-PossiblePromise.then = (value, func) => (
-  isPromise(value) ? value.then(func) : func(value))
-
-/**
- * @name PossiblePromise.catch
- *
- * @synopsis
- * PossiblePromise.catch(
- *   value Promise|any,
- *   func any=>Promise|any,
- * ) -> Promise|any
- *
- * @catchphrase
- * .catch if passed a Promise, else noop
- */
-PossiblePromise.catch = (value, func) => (
-  isPromise(value) ? value.catch(func) : value)
-
-/**
- * @name SyncThenable
- *
- * @synopsis
- * new SyncThenable(value any) -> SyncThenable
- *
- * @catchphrase
- * A synchronous Promise-like structure
- */
-const SyncThenable = function(value) { this.value = value }
-
-/**
- * @name SyncThenable.prototype.then
- *
- * @synopsis
- * new SyncThenable(value any).then(func function) -> any
- *
- * @catchphrase
- * .then as a function call
- */
-SyncThenable.prototype.then = function(func) { return func(this.value) }
-
-/**
- * @name PossiblePromise.all
- *
- * @synopsis
- * PossiblePromise.all(
- *   values Array<Promise>|Array,
- * ) -> Promise<Array>|PossiblePromise<Array>
- *
- * @catchphrase
- * Always returns a thenable of an Array
- */
-PossiblePromise.all = values => (values.some(isPromise)
-  ? promiseAll(values)
-  : new SyncThenable(values))
-
-/**
- * @name PossiblePromise.args
- *
- * @synopsis
- * PossiblePromise.args(func function)(args ...any) -> Promise|any
- *
- * @catchphrase
- * Resolves any Promises supplied as arguments to a function
- */
-PossiblePromise.args = func => (...args) => (args.some(isPromise)
-  ? promiseAll(args).then(res => func(...res))
-  : func(...args))
-
-/* PossiblePromise.argsSome = func => (...args) => (args.some(isPromise)
-  ? promiseAll(args).then(res => func(...res))
-  : func(...args))
-
-PossiblePromise.argsSomeApply = func => {
-  const fApply = func.apply.bind(func)
-  return (...args) => (args.some(isPromise)
-    ? promiseAll(args).then(res => fApply(null, res))
-    : fApply(null, args))
-}
-
-PossiblePromise.argumentsLoop = func => function() {
-  for (let i = 0; i < arguments.length; i++) {
-    if (isPromise(arguments[i])) {
-      return promiseAll(arguments).then(res => func(...res))
-    }
-  }
-  return func.apply(null, arguments)
-}
-
-PossiblePromise.argsLoop = func => (...args) => {
-  for (const arg of args) {
-    if (isPromise(arg)) return promiseAll(args).then(res => func(...res))
-  }
-  return func(...args)
-} */
-
-module.exports = PossiblePromise

package/monad/PossiblePromise.test.js

@@ -1,89 +0,0 @@
-const PossiblePromise = require('./PossiblePromise')
-const assert = require('assert')
-
-describe('PossiblePromise', () => {
-  describe('new PossiblePromise(p Promise|any) -> PossiblePromise', () => {
-    it('p nonPromise', async () => {
-      const pp = new PossiblePromise('hey')
-      assert.strictEqual(pp.constructor, PossiblePromise)
-      assert.strictEqual(pp.value, 'hey')
-    })
-    it('p Promise', async () => {
-      const pp = new PossiblePromise(Promise.resolve('hey'))
-      assert.strictEqual(pp.constructor, PossiblePromise)
-      assert(pp.value instanceof Promise)
-    })
-  })
-
-  describe('new PossiblePromise(p Promise|any).then(f function)', () => {
-    it('p nonPromise; calls f with p', async () => {
-      const pp = new PossiblePromise(10)
-      const f = number => number ** 2
-      assert.strictEqual(pp.then(f), 100)
-    })
-    it('p Promise; supplies f to p.then', async () => {
-      const pp = new PossiblePromise(Promise.resolve(10))
-      assert(pp.then(number => number ** 2) instanceof Promise)
-      assert.strictEqual(await pp.then(number => number ** 2), 100)
-    })
-  })
-
-  describe('PossiblePromise.then(p Promise|any, f function)', () => {
-    it('p nonPromise; calls f with nonPromise', async () => {
-      assert.strictEqual(PossiblePromise.then(10, number => number ** 2), 100)
-    })
-    it('p Promise, supplies f to p.then', async () => {
-      assert(PossiblePromise.then(Promise.resolve(10), number => number ** 2) instanceof Promise)
-      assert.strictEqual(
-        await PossiblePromise.then(Promise.resolve(10), number => number ** 2),
-        100,
-      )
-    })
-  })
-
-  describe('PossiblePromise.catch(p Promise|any, catcher function)', () => {
-    it('p nonPromise; noops, returns p', async () => {
-      assert.strictEqual(PossiblePromise.catch(1, console.error), 1)
-    })
-    it('p Promise; supplies catcher to p.catch', async () => {
-      const err = PossiblePromise.catch(
-        Promise.reject(new Error('hey')),
-        err => err,
-      )
-      assert.strictEqual((await err).message, 'hey')
-    })
-  })
-
-  describe('PossiblePromise.all(ps Array<Promise|any>) -> Promise', () => {
-    it('ps has some Promises; calls Promise.all', async () => {
-      const ps = [Promise.resolve('hey'), 'ho', 'hi']
-      assert(PossiblePromise.all(ps) instanceof Promise)
-      assert.deepEqual(await PossiblePromise.all(ps), ['hey', 'ho', 'hi'])
-    })
-    it('ps has no Promises; returns PossiblePromise', async () => {
-      const ps = ['hey', 'ho', 'hi']
-      assert(typeof PossiblePromise.all(ps).then === 'function')
-      assert.deepEqual(await PossiblePromise.all(ps), ps)
-    })
-  })
-
-  describe('PossiblePromise.args(f function)', () => {
-    it('resolves any Promises passed as arguments to f', async () => {
-      const add = (a, b) => a + b
-      assert(
-        PossiblePromise.args(add)(Promise.resolve(1), 2) instanceof Promise,
-      )
-      assert.strictEqual(
-        await PossiblePromise.args(add)(Promise.resolve(1), 2),
-        3,
-      )
-    })
-    it('behaves synchronously for no Promise arguments', async () => {
-      const add = (a, b) => a + b
-      assert.strictEqual(
-        PossiblePromise.args(add)(1, 2),
-        3,
-      )
-    })
-  })
-})

package/monad/README.md

@@ -1,75 +0,0 @@
-# rubico/monad
-
-This is a place for JavaScript monads.
-
-Warning: this entire directory is experimental; APIs here are subject to change.
-
-# Specification
-
-Each rubico monad must return an object that implements `.chain`, while having some notion of `.map` and `.concat`. Similarly, while `.empty` is not strictly required, there should be some notion of an empty instance of a Monad. For example, `[]` is `empty` for Arrays. All of these methods as well as any others are free to implement; only `.chain` is required. Monads should throw TypeErrors from the constructor for invalid types of arguments. rubico Monads should generally act on objects or primitive values and not functions. A Monad that acts on a function may be better for rubico/x.
-
-```coffeescript [specscript]
-Monad = (args ...any)=>({
-  chain: function,
-  map: function?,
-  concat: function?,
-  empty: function?,
-})
-```
-
-## Monad.prototype.chain - required
-```coffeescript [specscript]
-Monad(value any).chain(
-  flatMapper value=>(result Monad|any)) -> result
-```
-
-## Monad.prototype.map
-```coffeescript [specscript]
-Monad(value any).map(mapper value=>any) -> mappedMonad Monad
-```
-
-## Monad.prototype.concat
-```coffeescript [specscript]
-Monad(value any).concat(anotherMonad Monad) -> combinedMonad Monad
-```
-
-## Monad.prototype.empty
-```coffeescript [specscript]
-Monad.empty() -> emptyMonad Monad
-```
-
-# Examples
-
-A monad's effect is activated by calling its `.chain` method with `flatMap`.
-
-```javascript
-const { flatMap } = require('rubico')
-
-const Maybe = value => ({
-  chain(flatMapper) {
-    return value == null ? value : flatMapper(value)
-  },
-})
-
-flatMap(console.log)(Maybe(null))
-
-flatMap(console.log)(Maybe('hello world')) // hello world
-```
-
-Additionally, if a monad implements `.concat`, it can be transformed as a Semigroup with a transducer and `transform`.
-
-```javascript
-const { transform } = require('rubico')
-
-const Max = number => ({
-  number,
-  concat(value) {
-    return Max(Math.max(
-      number, value.constructor == Max ? value.number : value))
-  },
-})
-
-transform(
-  map(Math.abs), new Max(-Infinity),
-)([-1, -2, -3, -4, -5]) // Max { 5 }
-```

package/monad/Sequence.benchmark.js

@@ -1,42 +0,0 @@
-const timeInLoop = require('../x/timeInLoop')
-
-const objectProto = Object.prototype
-
-const nativeObjectToString = objectProto.toString
-
-const objectToString = value => nativeObjectToString.call(value)
-
-const symbolIterator = Symbol.iterator
-
-const symbolAsyncIterator = Symbol.asyncIterator
-
-const generatorFunctionTag = '[object GeneratorFunction]'
-
-const asyncGeneratorFunctionTag = '[object AsyncGeneratorFunction]'
-
-const isGeneratorFunction = value => {
-  const tag = objectToString(value)
-  return tag == generatorFunctionTag || tag == asyncGeneratorFunctionTag
-}
-
-/*
- * @name Sequence.isSequence
- *
- * @benchmark
- * isSequence1([]): 1e+8: 103.083ms
- * isSequence2([]): 1e+8: 102.643ms
- */
-
-const isSequence1 = value => value != null
-  && (Boolean(value[symbolIterator])
-    || Boolean(value[symbolAsyncIterator])
-    || isGeneratorFunction(value))
-
-const isSequence2 = value => value != null
-  && (typeof value[symbolIterator] == 'function'
-    || typeof value[symbolAsyncIterator] == 'function'
-    || isGeneratorFunction(value))
-
-// timeInLoop('isSequence1([])', 1e8, () => isSequence1([]))
-
-// timeInLoop('isSequence2([])', 1e8, () => isSequence2([]))

package/monad/Sequence.js

@@ -1,36 +0,0 @@
-'use strict'
-
-const symbolIterator = Symbol.iterator
-
-const symbolAsyncIterator = Symbol.asyncIterator
-
-const objectProto = Object.prototype
-
-const nativeObjectToString = objectProto.toString
-
-const objectToString = x => nativeObjectToString.call(x)
-
-const generatorFunctionTag = '[object GeneratorFunction]'
-
-const asyncGeneratorFunctionTag = '[object AsyncGeneratorFunction]'
-
-const isGeneratorFunction = value => objectToString(value) == generatorFunctionTag
-
-const isAsyncGeneratorFunction = value => objectToString(value) == asyncGeneratorFunctionTag
-
-const isIterable = value => value != null
-  && typeof value[symbolIterator] == 'function'
-
-const isAsyncIterable = value => value != null
-  && typeof value[symbolAsyncIterator] == 'function'
-
-const Sequence = function (value) {
-  if (value == null) {
-    this.iterator = [][symbolIterator]()
-  }
-  // if (isGeneratorFunction(value)) {}
-}
-
-Sequence.prototype.next = function (value) {
-  return this.iterator.next(value)
-}

package/monad/Struct.benchmark.js

@@ -1,154 +0,0 @@
-const timeInLoop = require('../x/timeInLoop')
-const Struct = require('./Struct')
-const _ = require('lodash')
-
-/**
- * @name Struct.get
- *
- * @benchmark
- * structGet(arr, 0): 1e+7: 13.472ms
- * structGetTernary(arr, 0): 1e+7: 13.414ms
- */
-
-{
-  const arr = [1, 2, 3]
-
-  const structGet = Struct.get
-
-  // timeInLoop('structGet(arr, 0)', 1e7, () => structGet(x, 0))
-
-  // const structGetTernary = Struct.get.ternary
-
-  // timeInLoop('structGetTernary(arr, 0)', 1e7, () => structGetTernary(x, 0))
-}
-
-/**
- * @name Struct.set
- *
- * @benchmark
- * arr[5] = 6: 1e+7: 12.785ms
- * structSet(arr, 6, 5): 1e+7: 13.989ms
- *
- * obj['f'] = 6: 1e+7: 12.857ms
- * structSet(obj, 6, 'f'): 1e+7: 14.154ms
- *
- * set.add(6): 1e+7: 95.934ms
- * structSet(set, 6): 1e+7: 97.659ms
- *
- * map.set('f', 6): 1e+7: 138.455ms
- * structSet(map, 6, 'f'): 1e+7: 139.162ms
- */
-
-{
-  const arr = [1, 2, 3, 4, 5]
-
-  const obj = { a: 1, b: 2, c: 3, d: 4, e: 5 }
-
-  const set = new Set([1, 2, 3, 4, 5])
-
-  const map = new Map([['a', 1], ['b', 2], ['c', 3], ['d', 4], ['e', 5]])
-
-  const structSet = Struct.set
-
-  // timeInLoop('arr[5] = 6', 1e7, () => { arr[5] = 6 })
-
-  // timeInLoop('structSet(arr, 6, 5)', 1e7, () => structSet(arr, 6, 5))
-
-  // timeInLoop('obj[\'f\'] = 6', 1e7, () => { obj['f'] = 6 })
-
-  // timeInLoop('structSet(obj, 6, \'f\')', 1e7, () => structSet(obj, 6, 'f'))
-
-  // timeInLoop('set.add(6)', 1e7, () => set.add(6))
-
-  // timeInLoop('structSet(set, 6)', 1e7, () => structSet(set, 6))
-
-  // timeInLoop('map.set(\'f\', 6)', 1e7, () => map.set('f', 6))
-
-  timeInLoop('structSet(map, 6, \'f\')', 1e7, () => structSet(map, 6, 'f'))
-}
-
-/**
- * @name Struct.size
- *
- * @benchmark
- * structSize(arr): 1e+7: 14.043ms
- * _.size(arr): 1e+7: 583.972ms
- *
- * structSize(obj): 1e+7: 117.314ms
- * structSizeObjectKeys(obj): 1e+7: 213.629ms
- * _.size(obj): 1e+7: 664.905ms
- */
-
-{
-  const structSize = Struct.size
-
-  const _size = _.size
-
-  // timeInLoop('structSize(arr)', 1e7, () => structSize(arr))
-
-  // timeInLoop('_.size(arr)', 1e7, () => _.size(arr))
-
-  const obj = { a: 1, b: 2, c: 3 }
-
-  // timeInLoop('structSize(obj)', 1e7, () => structSize(obj))
-
-  // const structSizeObjectKeys = structSize.objectKeys
-
-  // timeInLoop('structSize(obj)', 1e7, () => structSizeObjectKeys(obj))
-
-  // timeInLoop('_.size(obj)', 1e7, () => _.size(obj))
-}
-
-/**
- * @name Struct.copy
- *
- * @benchmark
- * arr.slice(): 1e+6: 18.674ms
- * Array.from(arr): 1e+6: 28.472ms
- * [...arr]: 1e+6: 24.933ms
- * Struct.copy(arr): 1e+6: 19.488ms
- *
- * ({ ...obj }): 1e+6: 40.274ms
- * Object.assign({}, obj): 1e+6: 164.081ms
- * Struct.copy(obj): 1e+6: 46.345ms
- *
- * new Set(set): 1e+6: 812.338ms
- * Struct.copy(set): 1e+6: 569.508ms
- *
- * new Map(map): 1e+6: 303.057ms
- * Struct.copy(map): 1e+6: 186.628ms
- */
-
-{
-  const structCopy = Struct.copy
-
-  const arr = [1, 2, 3, 4, 5]
-
-  const obj = { a: 1, b: 2, c: 3, d: 4, e: 5 }
-
-  const set = new Set([1, 2, 3, 4, 5, 6, 7, 8, 9, 10])
-
-  const map = new Map([['a', 1], ['b', 2], ['c', 3]])
-
-  // timeInLoop('arr.slice()', 1e6, () => arr.slice())
-
-  // timeInLoop('Array.from(arr)', 1e6, () => Array.from(arr))
-
-  // timeInLoop('[...arr]', 1e6, () => [...arr])
-
-  // timeInLoop('Struct.copy(arr)', 1e6, () => structCopy(arr))
-
-  // timeInLoop('({ ...obj })', 1e6, () => ({ ...obj }))
-
-  // timeInLoop('Object.assign({}, obj)', 1e6, () => Object.assign({}, obj))
-
-  // timeInLoop('Struct.copy(obj)', 1e6, () => structCopy(obj))
-
-  // timeInLoop('new Set(set)', 1e6, () => new Set(set))
-
-  // timeInLoop('Struct.copy(set)', 1e6, () => structCopy(set))
-
-  // timeInLoop('new Map(map)', 1e6, () => new Map(map))
-
-  // timeInLoop('Struct.copy(map)', 1e6, () => structCopy(map))
-}