NEW: Language.name (#59)

closes #59

Author: dwhieb

.eslintrc.yml

@@ -1,4 +1,5 @@
 # ESLint v6.7.2
+parser: babel-eslint
 parserOptions:
   ecmaVersion: 11
   sourceType: module

package-lock.json

@@ -35,6 +35,7 @@
     "access": "public"
   },
   "devDependencies": {
+    "babel-eslint": "^10.1.0",
     "eslint": "^6.8.0",
     "esm": "^3.2.25",
     "gh-pages": "^2.2.0",

package.json

@@ -1,16 +1,13 @@
 /**
- * A base Model class
+ * A base Model class. Most other models are instances of this base Model.
  * @memberof core
  */
 class Model {
 
   /**
    * Create a new Model
-   * @param {Object} [data={}] The data to populate this model with
    */
-  constructor(data = {}) {
-    Object.assign(this, data);
-  }
+  constructor() {} // eslint-disable-line
 
 }
 

src/core/Model.js

@@ -6,10 +6,4 @@ describe(`Model`, () => {
     expect(Model.name).toBe(`Model`);
   });
 
-  it(`copies data to the instance / allows custom properties`, () => {
-    const hello = `jambo`;
-    const model = new Model({ hello });
-    expect(model.hello).toBe(hello);
-  });
-
 });

src/core/Model.test.js

@@ -1,4 +1,5 @@
 /**
+ * Base classes and other code reused across this library. Most users will not need to use this module.
  * @namespace core
  */
 

src/core/index.js

@@ -1,4 +1,6 @@
-const { core: { Model } } = require(`../../test/index.js`);
+const { core } = require(`../../test/index.js`);
+
+const { Model } = core;
 
 /**
  * Check that the core module has the expected exports

src/core/index.test.js

@@ -1,18 +1,37 @@
-import Model from '../core/Model.js';
+import Model           from '../core/Model.js';
+import MultiLangString from './MultiLangString.js';
 
 /**
- * A class representing a language
+ * A class representing a language, formatted according to the [DLx Data Format for a language]{@link https://format.digitallinguistics.io/schemas/Language.html}
  * @memberof models
  * @extends Model
  */
 class Language extends Model {
 
+  #name;
+
   /**
    * Create a new Language
-   * @param {Object} [data={}] The data to use for this Language object
+   * @param {Object} [data={}] The data to use for this Language object. Data should be formatted according to the [DLx Data Format's guidelines for Language data]{@link https://format.digitallinguistics.io/schemas/Language.html}.
    */
   constructor(data = {}) {
-    super(data);
+
+    super();
+
+    this.name = new MultiLangString(data.name);
+
+  }
+
+  /**
+   * The name of this language, as a [MultiLangString]{@link models.MultiLangString}
+   * @type {Map}
+   */
+  get name() {
+    return this.#name;
+  }
+
+  set name(val) {
+    this.#name = new MultiLangString(val);
   }
 
 }

src/models/Language.js

@@ -1,9 +1,60 @@
-const { models: { Language } } = require(`../../test`);
+/* eslint-disable
+  max-nested-callbacks,
+*/
+
+const { models } = require(`../../test`);
+
+const {
+  MultiLangString,
+  Language,
+} = models;
 
 describe(`Language`, () => {
 
-  it(`is a Language class`, () => {
+  it(`class: Language`, () => {
     expect(Language.name).toBe(`Language`);
   });
 
+  describe(`Language.prototype.name`, () => {
+
+    it(`class: MultiLangString`, () => {
+      const lang = new Language();
+      expect(lang.name).toBeInstanceOf(MultiLangString);
+    });
+
+    it(`Success: String`, () => {
+
+      const name = `Chitimacha`;
+      const lang = new Language;
+
+      lang.name = name;
+
+      expect(lang.name.get(`eng`)).toBe(name);
+
+    });
+
+    it(`Success: Object`, () => {
+
+      const name = {
+        eng: `Chitimacha`,
+        fra: `chitimacha`,
+      };
+
+      const lang = new Language;
+
+      lang.name = name;
+
+      expect(lang.name.get(`eng`)).toBe(name.eng);
+      expect(lang.name.get(`fra`)).toBe(name.fra);
+
+    });
+
+    it(`Error: bad data`, () => {
+      const lang = new Language;
+      const setBadLang = () => { lang.name = false; };
+      expect(setBadLang).toThrowMatching(e => e.name === `MultiLangStringDataError`);
+    });
+
+  });
+
 });

src/models/Language.test.js

@@ -55,7 +55,7 @@ function validateString(input) {
 }
 
 /**
- * A class representing a Multi-Language Text / String
+ * A class representing a Multi-Language Text / String, as a JavaScript Map Object. See the [DLx Data Format]{@link https://format.digitallinguistics.io/schemas/MultiLangString.html} for information about formatting Multi-Language Strings.
  * @memberof models
  * @extends Map
  *