chore: trim white space throughout word documents

migrate-mongo-config.js

@@ -1,6 +1,6 @@
 const config = {
   mongodb: {
-    url: process.env.MONGO_URI || 'mongodb://localhost:27017',
+    url: process.env.MONGO_URI || 'mongodb://0.0.0.0:27017',
     databaseName: process.env.DB_NAME || 'igbo_api',
     options: {
       useNewUrlParser: true,

migrations/20230605005447-trim-headword-and-tenses-whitespace.js

@@ -0,0 +1,103 @@
+const trimPipeline = [
+  {
+    $project: {
+      word: {
+        $trim: {
+          input: '$word',
+        },
+      },
+      wordPronunciation: 1,
+      conceptualWord: 1,
+      definitions: 1,
+      dialects: 1,
+      tags: 1,
+      'tenses.infinitive': {
+        $trim: {
+          input: '$tenses.infinitive',
+        },
+      },
+      'tenses.imperative': {
+        $trim: {
+          input: '$tenses.imperative',
+        },
+      },
+      'tenses.simplePast': {
+        $trim: {
+          input: '$tenses.simplePast',
+        },
+      },
+      'tenses.presentPassive': {
+        $trim: {
+          input: '$tenses.presentPassive',
+        },
+      },
+      'tenses.simplePresent': {
+        $trim: {
+          input: '$tenses.simplePresent',
+        },
+      },
+      'tenses.presentContinuous': {
+        $trim: {
+          input: '$tenses.presentContinuous',
+        },
+      },
+      'tenses.future': {
+        $trim: {
+          input: '$tenses.future',
+        },
+      },
+      attributes: 1,
+      pronunciation: 1,
+      variations: 1,
+      frequency: 1,
+      relatedTerms: 1,
+      hypernyms: 1,
+      hyponyms: 1,
+      stems: 1,
+      __v: 1,
+      updatedAt: 1,
+      createdAt: 1,
+    },
+  },
+];
+
+const revertTrimPipeline = [
+  {
+    $project: {
+      word: 1,
+      wordPronunciation: 1,
+      conceptualWord: 1,
+      definitions: 1,
+      dialects: 1,
+      tags: 1,
+      tenses: 1,
+      attributes: 1,
+      pronunciation: 1,
+      variations: 1,
+      frequency: 1,
+      relatedTerms: 1,
+      hypernyms: 1,
+      hyponyms: 1,
+      stems: 1,
+      __v: 1,
+      updatedAt: 1,
+      createdAt: 1,
+    },
+  },
+];
+
+module.exports = {
+  async up(db) {
+    const collections = ['words', 'wordsuggestions'];
+    await Promise.all(collections.map((collection) => (
+      db.collection(collection).updateMany({}, trimPipeline)
+    )));
+  },
+
+  async down(db) {
+    const collections = ['words', 'wordsuggestions'];
+    await Promise.all(collections.map((collection) => (
+      db.collection(collection).updateMany({}, revertTrimPipeline)
+    )));
+  },
+};

src/models/Word.js

@@ -15,28 +15,36 @@ const definitionSchema = new Schema({
     default: WordClass.NNC.value,
     enum: Object.values(WordClass).map(({ value }) => value),
   },
+  label: { type: String, default: '', trim: true },
   definitions: { type: [{ type: String }], default: [] },
-  nsibidi: { type: String, default: '' },
+  nsibidi: { type: String, default: '', index: true },
+  nsibidiCharacters: { type: [{ type: Types.ObjectId, ref: 'NsibidiCharacter' }], default: [] },
   igboDefinitions: {
     type: [{
       igbo: String,
       nsibidi: String,
+      nsibidiCharacters: { type: [{ type: Types.ObjectId, ref: 'NsibidiCharacter' }], default: [] },
     }],
     default: [],
   },
-}, { _id: true });
+}, { _id: true, toObject: toObjectPlugin });
 
 const dialectSchema = new Schema({
-  word: { type: String, required: true, index: true },
+  word: {
+    type: String,
+    required: true,
+    index: true,
+    trim: true,
+  },
   variations: { type: [{ type: String }], default: [] },
   dialects: { type: [{ type: String }], validate: (v) => every(v, (dialect) => Dialects[dialect].value), default: [] },
   pronunciation: { type: String, default: '' },
 }, { toObject: toObjectPlugin });
 
 export const wordSchema = new Schema({
-  word: { type: String, required: true },
-  wordPronunciation: { type: String, default: '' },
-  conceptualWord: { type: String, default: '' },
+  word: { type: String, required: true, trim: true },
+  wordPronunciation: { type: String, default: '', trim: true },
+  conceptualWord: { type: String, default: '', trim: true },
   definitions: [{
     type: definitionSchema,
     validate: (definitions) => (
@@ -52,19 +60,13 @@ export const wordSchema = new Schema({
       v.every((tag) => Object.values(WordTags).map(({ value }) => value).includes(tag))
     ),
   },
-  tenses: {
-    type: Object,
-    validate: (v) => {
-      const tenseValues = Object.values(Tenses);
-      Object.keys(v).every((key) => (
-        tenseValues.find(({ value: tenseValue }) => key === tenseValue)
-      ));
-    },
-    required: false,
-    default: {},
-  },
-  attributes: Object.entries(WordAttributes)
-    .reduce((finalAttributes, [, { value }]) => ({
+  tenses: Object.values(Tenses)
+    .reduce((tenses, { value }) => ({
+      ...tenses,
+      [value]: { type: String, default: '', trim: true },
+    }), {}),
+  attributes: Object.values(WordAttributes)
+    .reduce((finalAttributes, { value }) => ({
       ...finalAttributes,
       [value]: { type: Boolean, default: false },
     }), {}),