Add tests for mapModel()

src/helpers/errors.js

@@ -3,7 +3,11 @@ const analyzeErrors = {
 }
 
 const generateErrors = {
+  invalidInput: new Error(`argument 'model' must be a Token[]`),
+}
+
+const mapModelErrors = {
   invalidInput: new Error(`argument 'model' must be an Object literal`),
 }
 
-module.exports = { analyzeErrors, generateErrors }
+module.exports = { analyzeErrors, generateErrors, mapModelErrors }

src/helpers/mapModel.js

@@ -1,4 +1,27 @@
+const { mapModelErrors: errors } = require('./errors.js')
+
+/**
+ * @typedef {Object} Token
+ * @property {string} token
+ * @property {number} count
+ * @property {boolean} start
+ * @property {Word[]} next
+ */
+
+/**
+ * @typedef {Object} Word
+ * @property {string} token
+ * @property {number} weight
+ */
+
+/**
+ * @param {Object} model Raw Model
+ * @returns {Token[]}
+ */
 const mapModel = model => {
+  // Input Validation
+  if (model.constructor !== Object) throw errors.invalidInput
+
   let output = Object.entries(model)
     .map(x => {
       let [key, value] = x

test/tests.js

@@ -4,7 +4,7 @@ const { expect } = require('chai')
 
 // Local Package
 const { analyze, generate, mapModel } = require('../src/index.js')
-const { analyzeErrors, generateErrors } = require('../src/helpers/errors.js')
+const { analyzeErrors, generateErrors, mapModelErrors } = require('../src/helpers/errors.js')
 
 // Test Data
 const { testInput, testModel, testMapped } = require('./data.js')
@@ -53,6 +53,36 @@ describe('analyze()', () => {
   })
 })
 
+describe('mapModel()', () => {
+  it('should be a function', () => {
+    expect(mapModel).to.be.a('function')
+  })
+
+  describe('input types', () => {
+    it('should accept an Object literal', () => {
+      expect(() => { mapModel(testModel) }).to.not.throw()
+    })
+
+    it('should throw when given a string', () => {
+      expect(() => { mapModel('string') }).to.throw(mapModelErrors.invalidInput)
+    })
+
+    it('should throw when given a number', () => {
+      expect(() => { mapModel(5) }).to.throw(mapModelErrors.invalidInput)
+    })
+
+    it('should throw when given an Array', () => {
+      expect(() => { mapModel([]) }).to.throw(mapModelErrors.invalidInput)
+    })
+  })
+
+  describe('return types', () => {
+    it('should return an Object', () => {
+      expect(mapModel(testModel)).to.be.an('array')
+    })
+  })
+})
+
 describe('generate()', () => {
   it('should be a function', () => {
     expect(generate).to.be.a('function')