-
Notifications
You must be signed in to change notification settings - Fork 2
/
utilities.js
267 lines (251 loc) · 7.78 KB
/
utilities.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
import append from "https://deno.land/x/ramda@v0.27.2/source/append.js";
import curry from "https://deno.land/x/ramda@v0.27.2/source/curry.js";
import curryN from "https://deno.land/x/ramda@v0.27.2/source/curryN.js";
import equals from "https://deno.land/x/ramda@v0.27.2/source/equals.js";
import find from "https://deno.land/x/ramda@v0.27.2/source/find.js";
import lift from "https://deno.land/x/ramda@v0.27.2/source/lift.js";
import reduce from "https://deno.land/x/ramda@v0.27.2/source/reduce.js";
const $$decoder = new TextDecoder();
const $$encoder = new TextEncoder();
/**
* ## Utilities
*
* ### `assertIsArray`
* `* -> Boolean`
*
* ### `assertIsBoolean`
* `* -> Boolean`
*
* ### `assertIsFunction`
* `* -> Boolean`
*
* ### `assertIsInstance`
* `* -> Boolean`
*
* ### `assertIsNull`
* `* -> Boolean`
*
* ### `assertIsNumber`
* `* -> Boolean`
*
* ### `assertIsObject`
* `* -> Boolean`
*
* ### `assertIsRegex`
* `* -> Boolean`
*
* ### `assertIsString`
* `* -> Boolean`
*
* ### `assertIsUndefined`
* `* -> Boolean`
*
* ### `decodeRaw`
* `Uint8Array -> String`
*
* ### `encodeText`
* `String -> Uint8Array`
*/
export const assertIsArray = value => value instanceof Array;
export const assertIsBoolean = value => value === true || value === false;
export const assertIsFunction = value => value instanceof Function;
export const assertIsInstance = curry((T, value) => value instanceof T);
export const assertIsNull = value => value === null;
export const assertIsNumber = value => typeof value === "number";
export const assertIsObject = value => typeof value === "object" && !(value instanceof Array);
export const assertIsRegex = value => value instanceof RegExp;
export const assertIsString = value => typeof value === "string";
export const assertIsUndefined = value => value === undefined;
export const decodeRaw = $$decoder.decode.bind($$decoder);
export const encodeText = $$encoder.encode.bind($$encoder);
/**
* ### `alt`
* `Alt a -> Alt b -> Alt a|b`
*
* This function takes a container of any type and, an Alternative functor. Then it returns either the container or the
* alternative functor.
* The function is in support of the [Alt algebra](https://github.com/fantasyland/fantasy-land#alt).
*
* ```js
* import Either from "https://deno.land/x/functional@v1.3.4/library/Either.js";
* import { alt } from "https://deno.land/x/functional@v1.3.4/library/utilities.js";
*
* const container = alt(Either.Right(42), Either.Left("Not the meaning of life"));
*
* assertEquals(container.extract(), 42);
* ```
*/
export const alt = curry(
(container, alternativeFunctor) =>
(alternativeFunctor.alt || alternativeFunctor["fantasy-land/alt"]).call(alternativeFunctor, container)
);
/**
* ### `chainLift`
* `(a -> b -> c) -> Chainable a -> Functor b -> Chainable c`
*
* This function is similar to [`lift`](https://ramdajs.com/docs/#lift) but is chainable.
*
* ```js
* import Task from "https://deno.land/x/functional@v1.3.4/library/Task.js";
* import { chainLift } from "https://deno.land/x/functional@v1.3.4/library/utilities.js";
*
* const hogeFuga = useWith(
* chainLift(curry((x, y) => Task.of(x * y))),
* [
* x => Task.of(x),
* x => Task.of(x)
* ]
* );
*
* const container = await hogeFuga(42, 24).run();
*
* const value = safeExtract("Failed.", container);
*
* assertEquals(value, 1008);
* ```
*/
export const chainLift = curry(
(binaryFunction, chainableFunctor, functor) => chainableFunctor.chain(x => functor.map(binaryFunction(x)))
);
/**
* ### `chainRec`
* `ChainRec r => ((a -> c, b -> c, a) -> r c) -> a -> r b`
*
* This function is a combinator for the [`chainRec` algebra](https://github.com/fantasyland/fantasy-land#chainrec).
* It takes a ternary function, an initial value and, a chainable recursive functor.
*
* ```js
* import Task from "https://deno.land/x/functional@v1.3.4/library/Task.js";
* import { chainRec } from "https://deno.land/x/functional@v1.3.4/library/utilities.js";
*
* const multiplyAll = curry((x, n) => chainRec(
* (Loop, Done, cursor) =>
* cursor === n ? Done(Pair(cursor, null)) : Loop(Pair(cursor + 1, Task.of([ x * (cursor + 1) ]))),
* 0
* ));
*
* const container = await multiplyAll(42, 10)(Task.of([ 0 ])).run();
*
* const value = safeExtract("Failed.", container);
*
* assertEquals(value, [ 0, 42, 84, 126, 168, 210, 252, 294, 336, 378, 420 ]);
* ```
*/
export const chainRec = curry(
(ternaryFunction, initiator, chainableRecursiveFunctor) =>
(chainableRecursiveFunctor.chainRec || chainableRecursiveFunctor["fantasy-land/chainRec"])
.call(chainableRecursiveFunctor, ternaryFunction, initiator)
);
/**
* ### `evert`
* `Applicative a => a -> a[] -> a`
*
* This function takes a type constructor and, a list of Applicative functor and evert it; effectively making an Applicative
* functor of a list of value.
*
* ```js
* import Task from "https://deno.land/x/functional@v1.3.4/library/Task.js";
* import { evert } from "https://deno.land/x/functional@v1.3.4/library/utilities.js";
*
* const container = await evert(Task, [ Task.of(42), Task.of(32), Task.of(24) ]).run();
*
* const list = safeExtract("Failed.", container);
*
* assertEquals(list, [ 42, 32, 24 ]);
* ```
*/
export const evert = curry(
(T, list) => list.reduce(
(accumulator, x) => lift(append)(x, accumulator),
T.of([])
)
);
export const insideOut = evert;
/**
* ### `log`
* `String -> a -> a`
*
* This function is a composable `console.debug`. It takes a message, a value and, return the value.
*/
export const log = message => x => console.debug(message, x) || x;
/**
* ### `runSequentially`
* `Chain c => (...c) -> c`
*
* This function takes n Chainable functor and chain them automatically.
*
* ```js
* import Task from "https://deno.land/x/functional@v1.3.4/library/Task.js";
* import { runSequentially } from "https://deno.land/x/functional@v1.3.4/library/utilities.js";
*
* const fuga = converge(
* runSequentially,
* [
* x => Task.of(x * 2),
* x => Task.of(x + 2)
* ]
* );
*
* const container = await fuga(42).run();
*
* const value = safeExtract("Failed.", container);
*
* assertEquals(value, 44);
* ```
*/
export const runSequentially = (initialChainableFunctor, ...chainableFunctorList) => reduce(
(accumulator, chainableFunctor) => accumulator.chain(_ => chainableFunctor),
initialChainableFunctor,
chainableFunctorList
);
/**
* ### `safeExtract`
* `String -> Either a -> a`
*
* This function takes a message and an Either container; if the container is `Either.Right`, the value will be
* returned. But if the container is `Either.Left`, it will throw an error with the message passed.
*/
export const safeExtract = curry(
(message, container) => container.fold({
Left: error => {
throw new Error(`${message} Error: ${
(error.hasOwnProperty('raw'))
? decodeRaw(error.raw)
: `${error.message}\n${error.stack}`
}`)
},
Right: value => value
})
);
/**
* ### `stream`
* `((a, b) -> a) -> a -> AsyncIterable b -> a`
*/
export const stream = curry(
async (binaryFunction, accumulator, iterator) => {
for await (const data of iterator) {
accumulator = binaryFunction(accumulator, data);
}
return accumulator;
}
);
export const factorizeSpy = () => {
const history = [];
return [
(functionArity, nAryFunction) =>
curryN(
functionArity, (...argumentList) => history.push(argumentList) && nAryFunction.call(null, ...argumentList)
),
{
assertCalledWith: (...argumentList) => !!find(equals(argumentList), history),
assertCallCount: n => n === history.length,
get callCount() { return history.length },
get history() { return history }
}
]
};
export const factorizeFakeInstance = instance => (
{
["fantasy-land/equals"]: value => value instanceof instance
}
)