:recycle: add tests | break-up functions

index.js

@@ -1,134 +0,0 @@
-const { nanoid } = require('nanoid')
-
-const US_LIQUID_GALLONS_TO_CUBIC_INCHES = 231
-const CUBIC_INCHES_TO_US_LIQUID_GALLONS = 1 / US_LIQUID_GALLONS_TO_CUBIC_INCHES
-
-const toLiquid = cubicInches => cubicInches * CUBIC_INCHES_TO_US_LIQUID_GALLONS
-const fromLiquid = gallons => gallons * US_LIQUID_GALLONS_TO_CUBIC_INCHES
-
-const makeContainerT = (inputs, outputs, container) => [
-    inputs,
-    outputs,
-    container,
-]
-
-const fromConfig = {
-    tank_1: {
-        inputs: [1],
-        outputs: ['foo'],
-        dims: { l: 24, w: 12, h: 12 },
-    },
-    sump_1: {
-        inputs: [],
-        outputs: [],
-        dims: { l: 18, w: 12, h: 12 },
-    },
-    ato_1: {
-        inputs: [],
-        outputs: [],
-        dims: { l: 6, w: 12, h: 12 },
-    },
-}
-const digestConfig = config => {
-    const sys = new System()
-    for (const [containerName, inputsOutputsDims] of Object.entries(config)) {
-        const { inputs, outputs, dims } = inputsOutputsDims
-        const containerT = makeContainerT(
-            inputs,
-            outputs,
-            new Container(dims, 0, containerName)
-        )
-        sys.add(containerT[2].id, containerT)
-    }
-    return sys
-}
-
-class InOut {
-    constructor() {
-        this.value = null
-    }
-}
-
-/** Holds systems or containers */
-class Controller {}
-
-/** Holds systems or containers */
-class System {
-    constructor() {
-        this.inventory = {}
-    }
-    get inputs() {
-        return Object.values(this.inventory).map(containerT => containerT[0])
-    }
-    get outputs() {
-        return Object.values(this.inventory).map(containerT => containerT[1])
-    }
-    get containers() {
-        return Object.values(this.inventory).map(containerT => containerT[2])
-    }
-    add(id, containerT) {
-        this.inventory[id] = containerT
-    }
-    inputsFor({ id }) {
-        return Object.values(this.inventory).find(
-            containerT => containerT[2].id == id
-        )[0]
-    }
-    outputsFor({ id }) {
-        return Object.values(this.inventory).find(
-            containerT => containerT[2].id == id
-        )[1]
-    }
-}
-
-class Container {
-    constructor({ l, w, h }, level = 0, label) {
-        this._id = nanoid() //=> "V1StGXR8_Z5jdHi6B-myT"
-        this._label = label ? label : ''
-        this.l = l
-        this.w = w
-        this.h = h
-        this.level = level
-    }
-    get id() {
-        return this._id
-    }
-    get label() {
-        return this._label
-    }
-    get liquidVolumeCapacity() {
-        return toLiquid(this.l * this.w * this.h)
-    }
-    get liquidVolumeFilled() {
-        return toLiquid(this.l * this.w * this.level)
-    }
-    get liquidVolumeRemaining() {
-        return this.liquidVolumeCapacity - this.liquidVolumeFilled
-    }
-    setLevel(updatedLevel) {
-        this.level = updatedLevel
-    }
-}
-
-const _changeLevel = (amount, container) => {
-    const updatedLevel =
-        fromLiquid(container.liquidVolumeFilled + amount) /
-        container.l /
-        container.w
-    container.setLevel(updatedLevel)
-}
-const fill = ({ container, amount }) => _changeLevel(amount, container)
-const drain = ({ container, amount }) => _changeLevel(-1 * amount, container)
-
-mySystem = digestConfig(fromConfig)
-const tanks = mySystem.containers
-console.log('mySystem :>> ', mySystem.inventory)
-console.log('tank :>> ', tanks[0].liquidVolumeCapacity)
-console.log('tank :>> ', tanks[0].liquidVolumeFilled)
-fill({ container: tanks[0], amount: 10 })
-console.log('tank :>> ', tanks[0].liquidVolumeFilled)
-console.log('refs intact?', mySystem.containers[0] === tanks[0])
-drain({ container: tanks[0], amount: 3 })
-console.log('tank :>> ', tanks[0].liquidVolumeFilled)
-console.log('inputs :>> ', mySystem.inputsFor(tanks[0]))
-console.log('outputs :>> ', mySystem.outputsFor(tanks[0]))

package.json

@@ -1,14 +1,18 @@
 {
-  "name": "level",
-  "version": "1.0.0",
-  "description": "liquid measurement",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "TOJ",
-  "license": "UNLICENSED",
-  "dependencies": {
-    "nanoid": "^3.3.7"
-  }
+    "name": "level",
+    "version": "1.0.0",
+    "description": "liquid measurement",
+    "main": "index.js",
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "type": "module",
+    "author": "TOJ",
+    "license": "UNLICENSED",
+    "dependencies": {
+        "nanoid": "^3.3.7"
+    },
+    "devDependencies": {
+        "vitest": "^1.3.1"
+    }
 }

src/container.js

@@ -0,0 +1,30 @@
+import { nanoid } from 'nanoid'
+import { toLiquid } from './utils.js'
+
+class Container {
+    constructor({ l, w, h }, level = 0, label, id = nanoid()) {
+        this._id = id //=> "V1StGXR8_Z5jdHi6B-myT"
+        this._label = label ? label : ''
+        this.l = l
+        this.w = w
+        this.h = h
+        this.level = level
+    }
+    get id() {
+        return this._id
+    }
+    get label() {
+        return this._label
+    }
+    get liquidVolumeCapacity() {
+        return toLiquid(this.l * this.w * this.h)
+    }
+    get liquidVolumeFilled() {
+        return toLiquid(this.l * this.w * this.level)
+    }
+    get liquidVolumeRemaining() {
+        return this.liquidVolumeCapacity - this.liquidVolumeFilled
+    }
+}
+
+export { Container }

src/index.js

@@ -0,0 +1,58 @@
+const { makeContainerT } = require('./system.js')
+const { Container } = require('./container.js')
+const { fill, drain } = require('./utils.js')
+
+const fromConfig = {
+    tank_1: {
+        inputs: [1],
+        outputs: ['foo'],
+        dims: { l: 24, w: 12, h: 12 },
+    },
+    sump_1: {
+        inputs: [],
+        outputs: [],
+        dims: { l: 18, w: 12, h: 12 },
+    },
+    ato_1: {
+        inputs: [],
+        outputs: [],
+        dims: { l: 6, w: 12, h: 12 },
+    },
+}
+const digestConfig = config => {
+    const sys = new System()
+    for (const [containerName, inputsOutputsDims] of Object.entries(config)) {
+        const { inputs, outputs, dims } = inputsOutputsDims
+        const containerT = makeContainerT(
+            inputs,
+            outputs,
+            new Container(dims, 0, containerName)
+        )
+        sys.add(containerT[2].id, containerT)
+    }
+    return sys
+}
+
+/** Holds systems or containers */
+class Controller {}
+
+mySystem = digestConfig(fromConfig)
+
+console.log('mySystem :>> ', mySystem.inventory)
+console.log('\ntank capacity:>> ', mySystem.containers[0].liquidVolumeCapacity)
+console.log('tank level:>> ', mySystem.containers[0].liquidVolumeFilled)
+console.log('pass:>> ', mySystem.containers[0].liquidVolumeFilled === 0)
+
+const postFill = fill({ container: mySystem.containers[0], amount: 10 })
+mySystem.replaceContainer(postFill)
+console.log('\nfilled tank :>> ', mySystem.containers[0].liquidVolumeFilled)
+console.log('pass:>> ', mySystem.containers[0].liquidVolumeFilled === 10)
+
+const postDrain = drain({ container: mySystem.containers[0], amount: 3 })
+mySystem.replaceContainer(postDrain)
+console.log('\ndrained tank :>> ', mySystem.containers[0].liquidVolumeFilled)
+console.log('pass:>> ', mySystem.containers[0].liquidVolumeFilled === 7)
+
+console.log('\ninputs + outputs')
+console.log('inputs :>> ', mySystem.inputsFor(mySystem.containers[0]))
+console.log('outputs :>> ', mySystem.outputsFor(mySystem.containers[0]))

src/system.js

@@ -0,0 +1,47 @@
+/** Holds systems or containers */
+class System {
+    constructor() {
+        this.inventory = {}
+    }
+    get inputs() {
+        return Object.values(this.inventory).map(containerT => containerT[0])
+    }
+    get outputs() {
+        return Object.values(this.inventory).map(containerT => containerT[1])
+    }
+    get containers() {
+        return Object.values(this.inventory).map(containerT => containerT[2])
+    }
+    replaceContainer(container) {
+        const [inputs, outputs] = this.inventory[container.id]
+        this.inventory[container.id] = makeContainerT(
+            inputs,
+            outputs,
+            container
+        )
+    }
+    add(id, containerT) {
+        this.inventory[id] = containerT
+    }
+    remove(id) {
+        delete this.inventory[id]
+    }
+    inputsFor({ id }) {
+        return Object.values(this.inventory).find(
+            containerT => containerT[2].id == id
+        )[0]
+    }
+    outputsFor({ id }) {
+        return Object.values(this.inventory).find(
+            containerT => containerT[2].id == id
+        )[1]
+    }
+}
+
+const makeContainerT = (inputs, outputs, container) => [
+    inputs,
+    outputs,
+    container,
+]
+
+export { System, makeContainerT }

src/utils.js

@@ -0,0 +1,30 @@
+import { Container } from './container.js'
+
+const US_LIQUID_GALLONS_TO_CUBIC_INCHES = 231
+const CUBIC_INCHES_TO_US_LIQUID_GALLONS = 1 / US_LIQUID_GALLONS_TO_CUBIC_INCHES
+
+const toLiquid = cubicInches => cubicInches * CUBIC_INCHES_TO_US_LIQUID_GALLONS
+const fromLiquid = gallons => gallons * US_LIQUID_GALLONS_TO_CUBIC_INCHES
+
+const _changeLevel = (amount, container) => {
+    const updatedLevel =
+        fromLiquid(container.liquidVolumeFilled + amount) /
+        container.l /
+        container.w
+    return new Container(
+        {
+            l: container.l,
+            w: container.w,
+            h: container.h,
+        },
+        updatedLevel,
+        container.label,
+        container.id
+    )
+}
+
+// Human API
+const fill = ({ container, amount }) => _changeLevel(amount, container)
+const drain = ({ container, amount }) => _changeLevel(-1 * amount, container)
+
+export { toLiquid, fromLiquid, fill, drain }

test/container.spec.js

@@ -0,0 +1,25 @@
+import { expect, test } from 'vitest'
+import { Container } from '../src/container.js'
+
+const dims = { l: 10, w: 10, h: 10 } // inches
+const capacity = 4.329004329004329 // gallons
+
+test('container - calculates liquid volume correctly', () => {
+    let testContainer = new Container(dims)
+    expect(testContainer.level).toBe(0)
+    expect(testContainer.liquidVolumeCapacity).toBe(capacity)
+    expect(testContainer.liquidVolumeFilled).toBe(0)
+    expect(testContainer.liquidVolumeRemaining).toBe(capacity)
+
+    testContainer = new Container(dims, dims.h / 2)
+    expect(testContainer.level).toBe(dims.h / 2)
+    expect(testContainer.liquidVolumeCapacity).toBe(capacity)
+    expect(testContainer.liquidVolumeFilled).toBe(capacity / 2)
+    expect(testContainer.liquidVolumeRemaining).toBe(capacity - capacity / 2)
+
+    testContainer = new Container(dims, dims.h)
+    expect(testContainer.level).toBe(dims.h)
+    expect(testContainer.liquidVolumeCapacity).toBe(capacity)
+    expect(testContainer.liquidVolumeFilled).toBe(capacity)
+    expect(testContainer.liquidVolumeRemaining).toBe(0)
+})

test/system.spec.js

@@ -0,0 +1,19 @@
+import { expect, test } from 'vitest'
+import { System } from '../src/system.js'
+
+test('system - instantiates and stores inventory correctly', () => {
+    let testSystem = new System()
+    testSystem.add('aaa', ['input_test', 'output_test', { id: 'aaa' }])
+    expect(testSystem.inputs).toStrictEqual(['input_test'])
+    expect(testSystem.outputs).toStrictEqual(['output_test'])
+    expect(testSystem.containers[0].id).toStrictEqual('aaa')
+
+    // Make sure inputs and outputs get reassigned
+    testSystem.replaceContainer({ id: 'aaa' })
+    expect(testSystem.inputs).toStrictEqual(['input_test'])
+    expect(testSystem.outputs).toStrictEqual(['output_test'])
+    expect(testSystem.containers[0].id).toStrictEqual('aaa')
+
+    testSystem.remove('aaa')
+    expect(testSystem.inventory).toStrictEqual({})
+})

test/utils.spec.js

@@ -0,0 +1,17 @@
+import { expect, test } from 'vitest'
+import { Container } from '../src/container.js'
+import { fill, drain } from '../src/utils.js'
+
+const dims = { l: 10, w: 10, h: 10 } // inches
+const capacity = 4.329004329004329 // gallons
+
+test('utils - fill and drain work correctly', () => {
+    let testContainer = new Container(dims)
+    testContainer = fill({ container: testContainer, amount: capacity })
+    expect(testContainer.liquidVolumeFilled).toBe(capacity)
+    expect(testContainer.liquidVolumeRemaining).toBe(0)
+
+    testContainer = drain({ container: testContainer, amount: capacity })
+    expect(testContainer.liquidVolumeFilled).toBe(0)
+    expect(testContainer.liquidVolumeRemaining).toBe(capacity)
+})