NEW: add type properties to models (#30)

dwhieb · web-flow · commit 3142656ed539 · 2020-08-27T15:04:08.000-05:00
closes #30
diff --git a/src/core/Collection.js b/src/core/Collection.js
@@ -1,3 +1,5 @@
+import Model from './Model.js';
+
 /* eslint-disable
   no-constructor-return,
 */
@@ -11,18 +13,20 @@ class Collection extends Array {
 
   /**
    * Create a new Collection
-   * @param {Function} Model      The class to use as the model for each item in the collection
+   * @param {Function} ItemModel  The class to use as the model for each item in the collection
    * @param {Array}    [array=[]] The array to instantiate the Collection with
    */
-  constructor(Model, array = []) {
+  constructor(ItemModel, array = []) {
 
     super();
 
+    Model.defineTypeProp(this, `Collection`);
+
     const proxy = new Proxy(this, {
       set(target, prop, val, prox) {
 
         if (Number.isInteger(Number(prop))) {
-          val = new Model(val); // eslint-disable-line no-param-reassign
+          val = new ItemModel(val); // eslint-disable-line no-param-reassign
         }
 
         return Reflect.set(target, prop, val, prox);
diff --git a/src/core/Collection.test.js b/src/core/Collection.test.js
@@ -34,4 +34,9 @@ describe(`Collection`, () => {
 
   });
 
+  it(`type`, () => {
+    const collection = new Collection;
+    collection.type.should.equal(`Collection`);
+  });
+
 });
diff --git a/src/core/Model.js b/src/core/Model.js
@@ -63,8 +63,10 @@ class Model {
     Object.defineProperty(object, `type`, {
       configurable: true,
       enumerable:   true,
-      value:        type,
-      writable:     false,
+      get() {
+        return type;
+      },
+      set() {}, // eslint-disable-line no-empty-function
     });
   }
 
diff --git a/src/core/Model.test.js b/src/core/Model.test.js
@@ -48,6 +48,18 @@ describe(`Model`, () => {
 
   });
 
+  it(`defineTypeProp`, () => {
+
+    const obj = {};
+
+    Model.defineTypeProp(obj, `Test`);
+
+    obj.type.should.equal(`Test`);
+    (() => { obj.type = `test`; }).should.not.throw();
+    obj.type.should.equal(`Test`);
+
+  });
+
   it(`defineValidatedProp`, () => {
 
     const validate = val => {
diff --git a/src/models/Language.test.js b/src/models/Language.test.js
@@ -55,7 +55,6 @@ describe(`Language`, () => {
   it(`type`, () => {
     const lang = new Language;
     lang.type.should.equal(`Language`);
-    (() => { lang.type = `language`; }).should.throw();
   });
 
 });
diff --git a/src/models/MultiLangString.js b/src/models/MultiLangString.js
@@ -1,4 +1,5 @@
 import isLanguageTag from '../utilities/types/isLanguageTag.js';
+import Model         from '../core/Model.js';
 
 /**
  * Validates a language tag. Throws a type error if the input is not a valid IETF language tag.
@@ -76,6 +77,8 @@ class MultiLangString extends Map {
 
     super(Object.entries(data));
 
+    Model.defineTypeProp(this, `MultiLangString`);
+
   }
 
   set(key, val) {
diff --git a/src/models/MultiLangString.test.js b/src/models/MultiLangString.test.js
@@ -109,8 +109,9 @@ describe(modelName, () => {
 
   });
 
-  it(`.type (should not exist)`, () => {
-    should.not.exist(new MultiLangString().type);
+  it(`.type`, () => {
+    const mls = new MultiLangString;
+    mls.type.should.equal(`MultiLangString`);
   });
 
 });
diff --git a/src/models/Text.js b/src/models/Text.js
@@ -21,6 +21,7 @@ class Text extends Model {
 
     Model.defineArrayProp(this, `utterances`, Utterance);
     Model.defineModelProp(this, `title`, MultiLangString);
+    Model.defineTypeProp(this, `Text`);
 
     Object.assign(this, data);
 
diff --git a/src/models/Text.test.js b/src/models/Text.test.js
@@ -4,6 +4,10 @@ import Text            from './Text.js';
 
 describe(`Text`, () => {
 
+  it(`class: Text`, () => {
+    Text.name.should.equal(`Text`);
+  });
+
   it(`instantiates with no data`, () => {
 
     const text = new Text;
@@ -13,13 +17,27 @@ describe(`Text`, () => {
 
   });
 
-  it(`instantiates with data`, () => {
+  it(`title`, () => {
 
-    const data = {
+    const text = new Text({
       title: {
         eng: `The Little Prince`,
         fra: `Le Petit Prince`,
       },
+    });
+
+    text.title.get(`fra`).should.equal(`Le Petit Prince`);
+
+  });
+
+  it(`type`, () => {
+    const text = new Text;
+    text.type.should.equal(`Text`);
+  });
+
+  it(`utterances`, () => {
+
+    const text = new Text({
       utterances: [
         {
           transcription: {
@@ -28,14 +46,9 @@ describe(`Text`, () => {
           translation:   `the little prince`,
         },
       ],
-    };
-
-    const text = new Text(data);
+    });
 
-    text.title.get(`fra`).should.equal(data.title.fra);
     text.utterances.length.should.equal(1);
-    text.utterances[0].transcription.get(`fra`).should.equal(`le petite prince`);
-    text.utterances[0].translation.get(`eng`).should.equal(`the little prince`);
 
   });
 
diff --git a/src/models/Transcription.js b/src/models/Transcription.js
@@ -1,4 +1,5 @@
 import isAbbreviation from '../utilities/types/isAbbreviation.js';
+import Model          from '../core/Model.js';
 
 /**
   * Validates an abbreviation. Throws a type error if the input is not a valid abbreviation.
@@ -63,6 +64,8 @@ class Transcription extends Map {
 
     super(Object.entries(data));
 
+    Model.defineTypeProp(this, `Transcription`);
+
   }
 
   set(key, val) {
diff --git a/src/models/Transcription.test.js b/src/models/Transcription.test.js
@@ -75,4 +75,9 @@ describe(`Transcription`, () => {
 
   });
 
+  it(`type`, () => {
+    const txn = new Transcription;
+    txn.type.should.equal(`Transcription`);
+  });
+
 });
diff --git a/src/models/Utterance.js b/src/models/Utterance.js
@@ -26,6 +26,7 @@ class Utterance extends Model {
     Model.defineModelProp(this, `transcription`, Transcription);
     Model.defineModelProp(this, `translation`, MultiLangString);
     Model.defineArrayProp(this, `words`, Word);
+    Model.defineTypeProp(this, `Utterance`);
 
     Object.assign(this, data);
 
diff --git a/src/models/Utterance.test.js b/src/models/Utterance.test.js
@@ -10,10 +10,20 @@ describe(`Utterance`, () => {
   const testData = { eng: 'Hello world!' };
 
   it(`instantiates without data`, () => {
-    (() => new Utterance).should.not.throw();
+
+    const utterance = new Utterance;
+
+    should.not.exist(utterance.transcript);
+
+    utterance.transcription.should.be.instanceOf(Transcription);
+    utterance.transcription.size.should.equal(0);
+
+    utterance.translation.should.be.instanceOf(MultiLangString);
+    utterance.translation.size.should.equal(0);
+
   });
 
-  it(`transcript is a Transcription object`, () => {
+  it(`transcript`, () => {
 
     const utterance = new Utterance({ transcript: testData });
 
@@ -22,27 +32,13 @@ describe(`Utterance`, () => {
 
   });
 
-  it(`transcript is undefined if absent`, () => {
-    const utterance = new Utterance;
-    should.not.exist(utterance.transcript);
-  });
-
-  it(`transcription is a Transcription object`, () => {
+  it(`transcription`, () => {
     const utterance = new Utterance({ transcription: testData });
     utterance.transcription.should.be.instanceOf(Transcription);
     utterance.transcription.get(`eng`).should.equal(testData.eng);
   });
 
-  it(`transcription is an empty Transcription (Map) object if absent`, () => {
-
-    const utterance = new Utterance;
-
-    utterance.transcription.should.be.instanceOf(Transcription);
-    utterance.transcription.size.should.equal(0);
-
-  });
-
-  it(`translation is a MultiLangString object`, () => {
+  it(`translation`, () => {
 
     const utterance = new Utterance({ translation: testData });
 
@@ -51,13 +47,9 @@ describe(`Utterance`, () => {
 
   });
 
-  it(`translation is an empty MultiLangString if absent`, () => {
-
+  it(`type`, () => {
     const utterance = new Utterance;
-
-    utterance.translation.should.be.instanceOf(MultiLangString);
-    utterance.translation.size.should.equal(0);
-
+    utterance.type.should.equal(`Utterance`);
   });
 
 });
diff --git a/src/models/Word.js b/src/models/Word.js
@@ -27,6 +27,7 @@ class Word extends Model {
     Model.defineModelProp(this, `literal`, MultiLangString);
     Model.defineModelProp(this, `transcription`, Transcription);
     Model.defineModelProp(this, `translation`, MultiLangString);
+    Model.defineTypeProp(this, `Word`);
 
     Object.assign(this, data);
 
diff --git a/src/models/Word.test.js b/src/models/Word.test.js
@@ -10,28 +10,24 @@ describe(`Word`, () => {
   const testData = { eng: `hello` };
 
   it(`instantiates without data`, () => {
-    (() => new Word).should.not.throw();
-  });
-
-  it(`transcription is a Transcription object`, () => {
-
-    const word = new Word({ transcription: testData });
-
+    const word = new Word;
+    should.not.exist(word.analysis);
+    should.not.exist(word.literal);
     word.transcription.should.be.instanceOf(Transcription);
-    word.transcription.get(`eng`).should.equal(testData.eng);
-
+    word.transcription.size.should.equal(0);
+    should.not.exist(word.translation);
   });
 
-  it(`transcription is an empty Transcription (Map) object if absent`, () => {
+  it(`analysis`, () => {
 
-    const word = new Word;
+    const word = new Word({ analysis: testData });
 
-    word.transcription.should.be.instanceOf(Transcription);
-    word.transcription.size.should.equal(0);
+    word.analysis.should.be.instanceOf(Transcription);
+    word.analysis.get(`eng`).should.equal(testData.eng);
 
   });
 
-  it(`literal translation is a MultiLangString object`, () => {
+  it(`literal`, () => {
 
     const word = new Word({ literal: testData });
 
@@ -40,37 +36,27 @@ describe(`Word`, () => {
 
   });
 
-  it(`literal translation is undefined if absent`, () => {
-    const word = new Word;
-    should.not.exist(word.literal);
-  });
-
-  it(`free translation is a MultiLangString object`, () => {
+  it(`transcription`, () => {
 
-    const word = new Word({ translation: testData });
+    const word = new Word({ transcription: testData });
 
-    word.translation.should.be.instanceOf(MultiLangString);
-    word.translation.get(`eng`).should.equal(testData.eng);
+    word.transcription.should.be.instanceOf(Transcription);
+    word.transcription.get(`eng`).should.equal(testData.eng);
 
   });
 
-  it(`free translation is undefined if absent`, () => {
-    const word = new Word;
-    should.not.exist(word.translation);
-  });
-
-  it(`analysis is a Transcription object`, () => {
+  it(`translation`, () => {
 
-    const word = new Word({ analysis: testData });
+    const word = new Word({ translation: testData });
 
-    word.analysis.should.be.instanceOf(Transcription);
-    word.analysis.get(`eng`).should.equal(testData.eng);
+    word.translation.should.be.instanceOf(MultiLangString);
+    word.translation.get(`eng`).should.equal(testData.eng);
 
   });
 
-  it(`analysis is undefined if absent`, () => {
+  it(`type`, () => {
     const word = new Word;
-    should.not.exist(word.analysis);
+    word.type.should.equal(`Word`);
   });
 
 });
diff --git a/src/models/index.js b/src/models/index.js
@@ -5,6 +5,7 @@
 
 export { default as Language } from './Language.js';
 export { default as MultiLangString } from './MultiLangString.js';
+export { default as Tags } from './Tags.js';
 export { default as Text } from './Text.js';
 export { default as Transcription } from './Transcription.js';
 export { default as Utterance } from './Utterance.js';
diff --git a/src/models/index.test.js b/src/models/index.test.js
@@ -7,6 +7,7 @@ import chai from 'chai';
 import {
   Language,
   MultiLangString,
+  Tags,
   Text,
   Transcription,
   Utterance,
@@ -17,9 +18,10 @@ chai.should();
 
 describe(`models`, () => {
 
-  it(`has the expected exports`, () => {
+  it(`have the expected exports`, () => {
     MultiLangString.name.should.equal(`MultiLangString`);
     Language.name.should.equal(`Language`);
+    Tags.name.should.equal(`Tags`);
     Text.name.should.equal(`Text`);
     Transcription.name.should.equal(`Transcription`);
     Utterance.name.should.equal(`Utterance`);
