diff options
Diffstat (limited to 'src/thing')
-rw-r--r-- | src/thing/album.js | 43 | ||||
-rw-r--r-- | src/thing/structures.js | 17 | ||||
-rw-r--r-- | src/thing/thing.js | 66 |
3 files changed, 126 insertions, 0 deletions
diff --git a/src/thing/album.js b/src/thing/album.js new file mode 100644 index 00000000..1915ab85 --- /dev/null +++ b/src/thing/album.js @@ -0,0 +1,43 @@ +import Thing from './thing.js'; + +import { + validateReference +} from './structures.js'; + +import { + showAggregate, + withAggregate +} from '../util/sugar.js'; + +export default class Album extends Thing { + #tracks; + + static updateError = { + tracks: Thing.extendPropertyError('tracks') + }; + + update(source) { + withAggregate(({ wrap, call, map }) => { + if (source.tracks) { + this.#tracks = map(source.tracks, validateReference('track'), { + errorClass: this.constructor.updateError.tracks + }); + } + }); + } +} + +const album = new Album(); + +try { + album.update({ + tracks: [ + 'lol', + 123, + 'track:oh-yeah', + 'group:what-am-i-doing-here' + ] + }); +} catch (error) { + showAggregate(error); +} diff --git a/src/thing/structures.js b/src/thing/structures.js new file mode 100644 index 00000000..e6b9fd4b --- /dev/null +++ b/src/thing/structures.js @@ -0,0 +1,17 @@ +// Generic structure utilities common across various Thing types. + +export function validateReference(type = '') { + return ref => { + if (typeof ref !== 'string') + throw new TypeError(`Expected a string, got ${ref}`); + + if (type) { + if (!ref.includes(':')) + throw new TypeError(`Expected ref to begin with "${type}:", but no type specified (ref: ${ref})`); + + const typePart = ref.split(':')[0]; + if (typePart !== type) + throw new TypeError(`Expected ref to begin with "${type}:", got "${typePart}:" (ref: ${ref})`); + } + }; +} diff --git a/src/thing/thing.js b/src/thing/thing.js new file mode 100644 index 00000000..c2465e32 --- /dev/null +++ b/src/thing/thing.js @@ -0,0 +1,66 @@ +// Base class for Things. No, we will not come up with a better name. +// Sorry not sorry! :) +// +// NB: Since these methods all involve processing a variety of input data, some +// of which will pass and some of which may fail, any failures should be thrown +// together as an AggregateError. See util/sugar.js for utility functions to +// make writing code around this easier! + +export default class Thing { + constructor(source, { + wikiData + } = {}) { + if (source) { + this.update(source); + } + + if (wikiData && this.checkComplete()) { + this.postprocess({wikiData}); + } + } + + static PropertyError = class extends AggregateError { + #key = this.constructor.key; + get key() { return this.#key; } + + constructor(errors) { + super(errors, ''); + this.message = `${errors.length} error(s) in property "${this.#key}"`; + } + }; + + static extendPropertyError(key) { + const cls = class extends this.PropertyError { + static #key = key; + static get key() { return this.#key; } + }; + + Object.defineProperty(cls, 'name', {value: `PropertyError:${key}`}); + return cls; + } + + // Called when instantiating a thing, and when its data is updated for any + // reason. (Which currently includes no reasons, but hey, future-proofing!) + // + // Don't expect source to be a complete object, even on the first call - the + // method checkComplete() will prevent incomplete resources from being mixed + // with the rest. + update(source) {} + + // Called when collecting the full list of available things of that type + // for wiki data; this method determine whether or not to include it. + // + // This should return whether or not the object is complete enough to be + // used across the wiki - not whether every optional attribute is provided! + // (That is, attributes required for postprocessing & basic page generation + // are all present.) + checkComplete() {} + + // Called when adding the thing to the wiki data list, and when its source + // data is updated (provided checkComplete() passes). + // + // This should generate any cached object references, across other wiki + // data; for example, building an array of actual track objects + // corresponding to an album's track list ('track:cool-track' strings). + postprocess({wikiData}) {} +} |