simplify streams, lint docs

This commit is contained in:
Leo Horie 2016-11-15 23:13:38 -05:00
parent a7f8018df9
commit 6ce2a384ec
20 changed files with 1271 additions and 2132 deletions

View file

@ -1,26 +0,0 @@
//! adapted for mithril from flyd https://github.com/paldepind/flyd
"use strict"
var combine = require("../stream").combine
module.exports = function (tuples, seed) {
var streams = tuples.map(function (tuple) {
var stream = tuple[0]
if (stream._state.state === 0) stream(undefined)
return stream
})
var newStream = combine(function () {
var changed = arguments[arguments.length - 1]
streams.forEach(function (stream, idx) {
if (changed.indexOf(stream) > -1) {
seed = tuples[idx][1](seed, stream._state.value)
}
})
return seed
}, streams)
return newStream
}

View file

@ -1,14 +1,13 @@
//! adapted for mithril from flyd https://github.com/paldepind/flyd
"use strict"
var combine = require("../stream").combine
var combine = require("./stream").combine
module.exports = function (reducer, seed, stream) {
var newStream = combine(function (s) {
return seed = reducer(seed, s._state.value)
}, [stream])
var newStream = combine(function (s) {
return seed = reducer(seed, s._state.value)
}, [stream])
if (newStream._state.state === 0) newStream(seed)
if (newStream._state.state === 0) newStream(seed)
return newStream
return newStream
}

25
stream/scanMerge.js Normal file
View file

@ -0,0 +1,25 @@
"use strict"
var combine = require("./stream").combine
module.exports = function(tuples, seed) {
var streams = tuples.map(function(tuple) {
var stream = tuple[0]
if (stream._state.state === 0) stream(undefined)
return stream
})
var newStream = combine(function() {
var changed = arguments[arguments.length - 1]
streams.forEach(function(stream, idx) {
if (changed.indexOf(stream) > -1) {
seed = tuples[idx][1](seed, stream._state.value)
}
})
return seed
}, streams)
return newStream
}

115
stream/stream.js Normal file
View file

@ -0,0 +1,115 @@
"use strict"
var guid = 0, noop = function() {}, HALT = {}
function createStream() {
function stream() {
if (arguments.length > 0 && arguments[0] !== HALT) updateStream(stream, arguments[0])
return stream._state.value
}
initStream(stream)
if (arguments.length > 0 && arguments[0] !== HALT) updateStream(stream, arguments[0])
return stream
}
function initStream(stream) {
stream.constructor = createStream
stream._state = {id: guid++, value: undefined, state: 0, derive: undefined, recover: undefined, deps: {}, parents: [], endStream: undefined}
stream.map = stream["fantasy-land/map"] = map, stream["fantasy-land/ap"] = ap, stream["fantasy-land/of"] = createStream
stream.valueOf = valueOf, stream.toJSON = toJSON, stream.toString = valueOf
Object.defineProperties(stream, {
end: {get: function() {
if (!stream._state.endStream) {
var endStream = createStream()
endStream.map(function(value) {
if (value === true) unregisterStream(stream), unregisterStream(endStream)
return value
})
stream._state.endStream = endStream
}
return stream._state.endStream
}}
})
}
function updateStream(stream, value) {
updateState(stream, value)
for (var id in stream._state.deps) updateDependency(stream._state.deps[id], false)
finalize(stream)
}
function updateState(stream, value) {
stream._state.value = value
stream._state.changed = true
if (stream._state.state !== 2) stream._state.state = 1
}
function updateDependency(stream, mustSync) {
var state = stream._state, parents = state.parents
if (parents.length > 0 && parents.filter(active).length === parents.length && (mustSync || parents.filter(changed).length > 0)) {
var value = stream._state.derive()
if (value === HALT) return false
updateState(stream, value)
}
}
function finalize(stream) {
stream._state.changed = false
for (var id in stream._state.deps) stream._state.deps[id]._state.changed = false
}
function combine(fn, streams) {
if (streams.length > streams.filter(valid).length) throw new Error("Ensure that each item passed to m.prop.combine/m.prop.merge is a stream")
return initDependency(createStream(), streams, function() {
return fn.apply(this, streams.concat([streams.filter(changed)]))
})
}
function initDependency(dep, streams, derive) {
var state = dep._state
state.derive = derive
state.parents = streams.filter(notEnded)
registerDependency(dep, state.parents)
updateDependency(dep, true)
return dep
}
function registerDependency(stream, parents) {
for (var i = 0; i < parents.length; i++) {
parents[i]._state.deps[stream._state.id] = stream
registerDependency(stream, parents[i]._state.parents)
}
}
function unregisterStream(stream) {
for (var i = 0; i < stream._state.parents.length; i++) {
var parent = stream._state.parents[i]
delete parent._state.deps[stream._state.id]
}
for (var id in stream._state.deps) {
var dependent = stream._state.deps[id]
var index = dependent._state.parents.indexOf(stream)
if (index > -1) dependent._state.parents.splice(index, 1)
}
stream._state.state = 2 //ended
stream._state.deps = {}
}
function map(fn) {return combine(function(stream) {return fn(stream())}, [this])}
function ap(stream) {return combine(function(s1, s2) {return s1()(s2())}, [stream, this])}
function valueOf() {return this._state.value}
function toJSON() {return this._state.value != null && typeof this._state.value.toJSON === "function" ? this._state.value.toJSON() : this._state.value}
function valid(stream) {return stream._state }
function active(stream) {return stream._state.state === 1}
function changed(stream) {return stream._state.changed}
function notEnded(stream) {return stream._state.state !== 2}
function merge(streams) {
return combine(function() {
return streams.map(function(s) {return s()})
}, streams)
}
createStream["fantasy-land/of"] = createStream
createStream.merge = merge
createStream.combine = combine
createStream.HALT = HALT
module.exports = createStream

View file

@ -6,11 +6,13 @@
<body>
<script src="../../module/module.js"></script>
<script src="../../ospec/ospec.js"></script>
<script src="../../util/stream.js"></script>
<script src="../../stream.js"></script>
<script src="../../test-utils/callAsync.js"></script>
<script src="../stream.js"></script>
<script src="../scan.js"></script>
<script src="../scan-merge.js"></script>
<script src="../scanMerge.js"></script>
<script src="test-stream.js"></script>
<script src="test-scanMerge.js"></script>
<script src="test-scanMerge.js"></script>
<script>require("../../ospec/ospec").run()</script>
</body>

78
stream/tests/test-scan.js Normal file
View file

@ -0,0 +1,78 @@
"use strict"
var o = require("../../ospec/ospec")
var stream = require("../stream")
var scan = require("../scan")
o.spec("scan", function() {
o("defaults to seed", function() {
var parent = stream()
var child = scan(function(out, p) {
return out - p
}, 123, parent)
o(child()).equals(123)
})
o("accumulates values as expected", function() {
var parent = stream()
var child = scan(function(arr, p) {
return arr.concat(p)
}, [], parent)
parent(7)
parent("11")
parent(undefined)
parent({ a: 1 })
var result = child()
// deepEquals fails on arrays?
o(result[0]).equals(7)
o(result[1]).equals("11")
o(result[2]).equals(undefined)
o(result[3]).deepEquals({a: 1})
})
})
o.spec("scanMerge", function() {
var scanMerge
o.beforeEach(function() {
scanMerge = require("../scan-merge")
})
o("defaults to seed", function() {
var parent1 = stream()
var parent2 = stream()
var child = scanMerge([
[parent1, function(out, p1) {
return out + p1
}],
[parent2, function(out, p2) {
return out + p2
}]
], -10)
o(child()).equals(-10)
})
o("accumulates as expected", function() {
var parent1 = stream()
var parent2 = stream()
var child = scanMerge([
[parent1, function(out, p1) {
return out + p1
}],
[parent2, function(out, p2) {
return out + p2 + p2
}]
], "a")
parent1("b")
parent2("c")
parent1("b")
o(child()).equals("abccb")
})
})

View file

@ -0,0 +1,43 @@
"use strict"
var o = require("../../ospec/ospec")
var stream = require("../stream")
var scanMerge = require("../scanMerge")
o.spec("scanMerge", function() {
o("defaults to seed", function() {
var parent1 = stream()
var parent2 = stream()
var child = scanMerge([
[parent1, function(out, p1) {
return out + p1
}],
[parent2, function(out, p2) {
return out + p2
}]
], -10)
o(child()).equals(-10)
})
o("accumulates as expected", function() {
var parent1 = stream()
var parent2 = stream()
var child = scanMerge([
[parent1, function(out, p1) {
return out + p1
}],
[parent2, function(out, p2) {
return out + p2 + p2
}]
], "a")
parent1("b")
parent2("c")
parent1("b")
o(child()).equals("abccb")
})
})

View file

@ -1,90 +1,452 @@
'use strict'
"use strict"
var o = require('../../ospec/ospec')
var o = require("../../ospec/ospec")
var callAsync = require("../../test-utils/callAsync")
var Stream = require("../stream")
o.spec('stream', function () {
var prop
o.spec("stream", function() {
o.spec("stream", function() {
o("works as getter/setter", function() {
var stream = Stream(1)
var initialValue = stream()
stream(2)
var newValue = stream()
o.beforeEach(function () {
prop = require('../../stream')
})
o(initialValue).equals(1)
o(newValue).equals(2)
})
o("has undefined value by default", function() {
var stream = Stream()
o.spec('scan', function () {
var scan
o(stream()).equals(undefined)
})
o("can update to undefined", function() {
var stream = Stream(1)
stream(undefined)
o.beforeEach(function () {
scan = require('../scan')
})
o(stream()).equals(undefined)
})
o("can be stream of streams", function() {
var stream = Stream(Stream(1))
o('defaults to seed', function () {
var parent = prop()
var child = scan(function (out, p) {
return out - p
}, 123, parent)
o(child()).equals(123)
})
o(stream()()).equals(1)
})
})
o.spec("combine", function() {
o("transforms value", function() {
var stream = Stream()
var doubled = Stream.combine(function(s) {return s() * 2}, [stream])
o('accumulates values as expected', function () {
var parent = prop()
var child = scan(function (arr, p) {
return arr.concat(p)
}, [], parent)
stream(2)
parent(7)
parent('11')
parent(undefined)
parent({ a: 1 })
var result = child()
o(doubled()).equals(4)
})
o("transforms default value", function() {
var stream = Stream(2)
var doubled = Stream.combine(function(s) {return s() * 2}, [stream])
// deepEquals fails on arrays?
o(result[0]).equals(7)
o(result[1]).equals('11')
o(result[2]).equals(undefined)
o(result[3]).deepEquals({ a: 1 })
})
})
o(doubled()).equals(4)
})
o("transforms multiple values", function() {
var s1 = Stream()
var s2 = Stream()
var added = Stream.combine(function(s1, s2) {return s1() + s2()}, [s1, s2])
o.spec('scanMerge', function () {
var scanMerge
s1(2)
s2(3)
o.beforeEach(function () {
scanMerge = require('../scan-merge')
})
o(added()).equals(5)
})
o("transforms multiple default values", function() {
var s1 = Stream(2)
var s2 = Stream(3)
var added = Stream.combine(function(s1, s2) {return s1() + s2()}, [s1, s2])
o('defaults to seed', function () {
var parent1 = prop()
var parent2 = prop()
o(added()).equals(5)
})
o("transforms mixed default and late-bound values", function() {
var s1 = Stream(2)
var s2 = Stream()
var added = Stream.combine(function(s1, s2) {return s1() + s2()}, [s1, s2])
var child = scanMerge([
[parent1, function (out, p1) {
return out + p1
}],
[parent2, function (out, p2) {
return out + p2
}]
], -10)
s2(3)
o(child()).equals(-10)
})
o(added()).equals(5)
})
o("combines atomically", function() {
var count = 0
var a = Stream()
var b = Stream.combine(function(a) {return a() * 2}, [a])
var c = Stream.combine(function(a) {return a() * a()}, [a])
var d = Stream.combine(function(b, c) {
count++
return b() + c()
}, [b, c])
o('accumulates as expected', function () {
var parent1 = prop()
var parent2 = prop()
a(3)
var child = scanMerge([
[parent1, function (out, p1) {
return out + p1
}],
[parent2, function (out, p2) {
return out + p2 + p2
}]
], 'a')
o(d()).equals(15)
o(count).equals(1)
})
o("combines default value atomically", function() {
var count = 0
var a = Stream(3)
var b = Stream.combine(function(a) {return a() * 2}, [a])
var c = Stream.combine(function(a) {return a() * a()}, [a])
var d = Stream.combine(function(b, c) {
count++
return b() + c()
}, [b, c])
parent1('b')
parent2('c')
parent1('b')
o(d()).equals(15)
o(count).equals(1)
})
o("combine lists only changed upstreams in last arg", function() {
var streams = []
var a = Stream()
var b = Stream()
var c = Stream.combine(function(a, b, changed) {
streams = changed
}, [a, b])
o(child()).equals('abccb')
})
})
a(3)
b(5)
o(streams.length).equals(1)
o(streams[0]).equals(b)
})
o("combine lists only changed upstreams in last arg with default value", function() {
var streams = []
var a = Stream(3)
var b = Stream(5)
var c = Stream.combine(function(a, b, changed) {
streams = changed
}, [a, b])
a(7)
o(streams.length).equals(1)
o(streams[0]).equals(a)
})
o("combine can return undefined", function() {
var a = Stream(1)
var b = Stream.combine(function(a) {
return undefined
}, [a])
o(b()).equals(undefined)
})
o("combine can return stream", function() {
var a = Stream(1)
var b = Stream.combine(function(a) {
return Stream(2)
}, [a])
o(b()()).equals(2)
})
o("combine can return pending stream", function() {
var a = Stream(1)
var b = Stream.combine(function(a) {
return Stream()
}, [a])
o(b()()).equals(undefined)
})
o("combine can halt", function() {
var count = 0
var a = Stream(1)
var b = Stream.combine(function(a) {
return Stream.HALT
}, [a])
["fantasy-land/map"](function() {
count++
return 1
})
o(b()).equals(undefined)
})
o("combine will throw with a helpful error if given non-stream values", function () {
var spy = o.spy()
var a = Stream(1)
var thrown = null;
try {
var b = Stream.combine(spy, [a, ''])
} catch (e) {
thrown = e
}
o(thrown).notEquals(null)
o(thrown.constructor === TypeError).equals(false)
o(spy.callCount).equals(0)
})
})
o.spec("merge", function() {
o("transforms an array of streams to an array of values", function() {
var all = Stream.merge([
Stream(10),
Stream("20"),
Stream({value: 30}),
])
o(all()).deepEquals([10, "20", {value: 30}])
})
o("remains pending until all streams are active", function() {
var straggler = Stream()
var all = Stream.merge([
Stream(10),
Stream("20"),
straggler,
])
o(all()).equals(undefined)
straggler(30)
o(all()).deepEquals([10, "20", 30])
})
o("calls run callback after all parents are active", function() {
var value = 0
var id = function(value) {return value}
var a = Stream()
var b = Stream()
var all = Stream.merge([a.map(id), b.map(id)]).map(function(data) {
value = data[0] + data[1]
})
a(1)
b(2)
o(value).equals(3)
a(3)
b(4)
o(value).equals(7)
})
})
o.spec("end", function() {
o("end stream works", function() {
var stream = Stream()
var doubled = Stream.combine(function(stream) {return stream() * 2}, [stream])
stream.end(true)
stream(3)
o(doubled()).equals(undefined)
})
o("end stream works with default value", function() {
var stream = Stream(2)
var doubled = Stream.combine(function(stream) {return stream() * 2}, [stream])
stream.end(true)
stream(3)
o(doubled()).equals(4)
})
o("cannot add downstream to ended stream", function() {
var stream = Stream(2)
stream.end(true)
var doubled = Stream.combine(function(stream) {return stream() * 2}, [stream])
stream(3)
o(doubled()).equals(undefined)
})
o("upstream does not affect ended stream", function() {
var stream = Stream(2)
var doubled = Stream.combine(function(stream) {return stream() * 2}, [stream])
doubled.end(true)
stream(4)
o(doubled()).equals(4)
})
})
o.spec("valueOf", function() {
o("works", function() {
o(Stream(1).valueOf()).equals(1)
o(Stream("a").valueOf()).equals("a")
o(Stream(true).valueOf()).equals(true)
o(Stream(null).valueOf()).equals(null)
o(Stream(undefined).valueOf()).equals(undefined)
o(Stream({a: 1}).valueOf()).deepEquals({a: 1})
o(Stream([1, 2, 3]).valueOf()).deepEquals([1, 2, 3])
o(Stream().valueOf()).equals(undefined)
})
o("allows implicit value access in mathematical operations", function() {
o(Stream(1) + Stream(1)).equals(2)
})
})
o.spec("toString", function() {
o("aliases valueOf", function() {
var stream = Stream(1)
o(stream.toString).equals(stream.valueOf)
})
o("allows implicit value access in string operations", function() {
o(Stream("a") + Stream("b")).equals("ab")
})
})
o.spec("toJSON", function() {
o("works", function() {
o(Stream(1).toJSON()).equals(1)
o(Stream("a").toJSON()).equals("a")
o(Stream(true).toJSON()).equals(true)
o(Stream(null).toJSON()).equals(null)
o(Stream(undefined).toJSON()).equals(undefined)
o(Stream({a: 1}).toJSON()).deepEquals({a: 1})
o(Stream([1, 2, 3]).toJSON()).deepEquals([1, 2, 3])
o(Stream().toJSON()).equals(undefined)
o(Stream(new Date(0)).toJSON()).equals(new Date(0).toJSON())
})
o("works w/ JSON.stringify", function() {
o(JSON.stringify(Stream(1))).equals(JSON.stringify(1))
o(JSON.stringify(Stream("a"))).equals(JSON.stringify("a"))
o(JSON.stringify(Stream(true))).equals(JSON.stringify(true))
o(JSON.stringify(Stream(null))).equals(JSON.stringify(null))
o(JSON.stringify(Stream(undefined))).equals(JSON.stringify(undefined))
o(JSON.stringify(Stream({a: 1}))).deepEquals(JSON.stringify({a: 1}))
o(JSON.stringify(Stream([1, 2, 3]))).deepEquals(JSON.stringify([1, 2, 3]))
o(JSON.stringify(Stream())).equals(JSON.stringify(undefined))
o(JSON.stringify(Stream(new Date(0)))).equals(JSON.stringify(new Date(0)))
})
})
o.spec("map", function() {
o("works", function() {
var stream = Stream()
var doubled = stream["fantasy-land/map"](function(value) {return value * 2})
stream(3)
o(doubled()).equals(6)
})
o("works with default value", function() {
var stream = Stream(3)
var doubled = stream["fantasy-land/map"](function(value) {return value * 2})
o(doubled()).equals(6)
})
o("works with undefined value", function() {
var stream = Stream()
var mapped = stream["fantasy-land/map"](function(value) {return String(value)})
stream(undefined)
o(mapped()).equals("undefined")
})
o("works with default undefined value", function() {
var stream = Stream(undefined)
var mapped = stream["fantasy-land/map"](function(value) {return String(value)})
o(mapped()).equals("undefined")
})
o("works with pending stream", function() {
var stream = Stream(undefined)
var mapped = stream["fantasy-land/map"](function(value) {return Stream()})
o(mapped()()).equals(undefined)
})
o("has alias", function() {
var stream = Stream(undefined)
o(stream["fantasy-land/map"]).equals(stream.map)
})
})
o.spec("ap", function() {
o("works", function() {
var apply = Stream(function(value) {return value * 2})
var stream = Stream(3)
var applied = stream["fantasy-land/ap"](apply)
o(applied()).equals(6)
apply(function(value) {return value / 3})
o(applied()).equals(1)
stream(9)
o(applied()).equals(3)
})
o("works with undefined value", function() {
var apply = Stream(function(value) {return String(value)})
var stream = Stream(undefined)
var applied = stream["fantasy-land/ap"](apply)
o(applied()).equals("undefined")
apply(function(value) {return String(value) + "a"})
o(applied()).equals("undefineda")
})
})
o.spec("fantasy-land", function() {
o.spec("functor", function() {
o("identity", function() {
var stream = Stream(3)
var mapped = stream["fantasy-land/map"](function(value) {return value})
o(stream()).equals(mapped())
})
o("composition", function() {
function f(x) {return x * 2}
function g(x) {return x * x}
var stream = Stream(3)
var mapped = stream["fantasy-land/map"](function(value) {return f(g(value))})
var composed = stream["fantasy-land/map"](g)["fantasy-land/map"](f)
o(mapped()).equals(18)
o(mapped()).equals(composed())
})
})
o.spec("apply", function() {
o("composition", function() {
var a = Stream(function(value) {return value * 2})
var u = Stream(function(value) {return value * 3})
var v = Stream(5)
var mapped = v["fantasy-land/ap"](u["fantasy-land/ap"](a["fantasy-land/map"](function(f) {
return function(g) {
return function(x) {
return f(g(x))
}
}
})))
var composed = v["fantasy-land/ap"](u)["fantasy-land/ap"](a)
o(mapped()).equals(30)
o(mapped()).equals(composed())
})
})
o.spec("applicative", function() {
o("identity", function() {
var a = Stream()["fantasy-land/of"](function(value) {return value})
var v = Stream(5)
o(v["fantasy-land/ap"](a)()).equals(5)
o(v["fantasy-land/ap"](a)()).equals(v())
})
o("homomorphism", function() {
var a = Stream(0)
var f = function(value) {return value * 2}
var x = 3
o(a["fantasy-land/of"](x)["fantasy-land/ap"](a["fantasy-land/of"](f))()).equals(6)
o(a["fantasy-land/of"](x)["fantasy-land/ap"](a["fantasy-land/of"](f))()).equals(a["fantasy-land/of"](f(x))())
})
o("interchange", function() {
var u = Stream(function(value) {return value * 2})
var a = Stream()
var y = 3
o(a["fantasy-land/of"](y)["fantasy-land/ap"](u)()).equals(6)
o(a["fantasy-land/of"](y)["fantasy-land/ap"](u)()).equals(u["fantasy-land/ap"](a["fantasy-land/of"](function(f) {return f(y)}))())
})
})
})
})