Adding the project files for easily generating names

drewry · drewry · commit a21d59d9f65a · 2017-03-04T18:13:42.000-05:00
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,2 @@
+test
+lib/generator.js
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,14 @@
+{
+  "extends": "airbnb-base",
+  "plugins": [
+    "import"
+  ],
+  "rules": {
+    "import/no-dynamic-require": 0,
+    "import/newline-after-import": 0,
+    "no-extend-native": 0,
+    "func-names": 0,
+    "no-bitwise": 0,
+    "global-require": 0
+  }
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,50 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# Ignore generated files
+tmp
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Open DnD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/bin/nomina b/bin/nomina
@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../lib/index');
diff --git a/bin/nomina-generate b/bin/nomina-generate
@@ -0,0 +1 @@
+#!/usr/bin/env node
diff --git a/bin/nomina-list b/bin/nomina-list
@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../lib/nomina-list');
diff --git a/data/asian.json b/data/asian.json
@@ -0,0 +1,4 @@
+{
+  "male": ["Ao", "Bang", "Buwei", "Changdong", "Chao", "Fuling", "Gao", "Guang", "He", "Hu Hai", "Jizi", "Ju", "Kang", "Long", "Lun", "Mang", "Qi", "Qian", "Qing", "She", "Sheng", "Si", "Tian", "Wan", "Xian", "Xie", "Xin", "Xing", "Yang", "Ying", "Yu", "Yuan", "Yun", "Zhao", "Zheng", "Zhuang Xiang", "Zhuo", "Ziying"],
+  "female": ["Feiyan", "Hou", "Ji", "Jiangnu", "Lihua", "Na", "Shengtong", "Zhi"]
+}
diff --git a/data/classical.json b/data/classical.json
@@ -0,0 +1,4 @@
+{
+  "male": ["Atticus", "Augustus", "Cassius", "Cato", "Cyprian", "Felix", "Julius", "Justus", "Lucius", "Magnus", "Marcus", "Maximus", "Octavius", "Philo", "Remus", "Rufus", "Septimus", "Tiberius", "Urban"],
+  "female": ["Aeliana", "Antonia", "Augusta", "Aurelia", "Camilla", "Cassia", "Cecilia", "Decima", "Drusilla", "Flavia", "Florentina", "Junia", "Laelia", "Laurentia", "Livia", "Marilla", "Octavia", "Priscilla", "Sabina", "Tanaquil", "Tatiana", "Tullia", "Valentina", "Vita"]
+}
diff --git a/data/medieval.json b/data/medieval.json
@@ -0,0 +1,4 @@
+{
+  "male": ["Merek", "Carac", "Ulric", "Tybalt", "Borin", "Sadon", "Terrowin", "Rowan", "Forthwind", "Althalos", "Fendrel", "Brom", "Hadrian", "Walter", "Fenwick", "Oliver", "Clifton", "Walter", "Roger", "Joseph", "Geoffrey", "William", "Francis", "Simon", "John", "Edmund", "Charles", "Benedict", "Gregory", "Peter", "Henry", "Frederick", "Walter", "Thomas", "Arthur", "Bryce", "Donald", "Leofrick", "Letholdus", "Lief", "Barda", "Rulf", "Robin", "Gavin", "Terryn", "Ronald", "Jarin", "Cassius", "Leo", "Cedric", "Gavin", "Peyton", "Josef", "Janshai", "Doran", "Asher", "Quinn", "Zane", "Xalvador", "Favian", "Destrian", "Dain", "Falk", "Berinon", "Tristan", "Gorvenal"],
+  "female": ["Millicent", "Alys", "Ayleth", "Anastas", "Alianor", "Cedany", "Ellyn", "Helewys", "Malkyn", "Peronell", "Sybbyl", "Ysmay", "Thea", "Jacquelyn", "Amelia", "Gloriana", "Bess", "Catherine", "Anne", "Mary", "Arabella", "Elizabeth", "Hildegard", "Brunhild", "Adelaide", "Alice", "Beatrix", "Cristiana", "Eleanor", "Emeline", "Isabel", "Juliana", "Margaret", "Matilda", "Mirabelle", "Rose", "Helena", "Guinevere", "Isolde", "Maerwynn", "Muriel", "Winifred", "Godiva", "Catrain", "Angmar", "Gussalen", "Jasmine", "Josselyn", "Maria", "Victoria", "Gwendolynn", "Enndolynn", "Janet", "Luanda", "Krea", "Rainydayas", "Atheena", "Dimia", "Phrowenia", "Aleida", "Ariana", "Alexia", "Katelyn", "Katrina", "Loreena", "Kaylein", "Seraphina", "Duraina", "Ryia", "Farfelee", "Iseult", "Benevolence", "Brangian"]
+}
diff --git a/lib/generator.js b/lib/generator.js
@@ -0,0 +1,160 @@
+// Originally written and released to the public domain by drow <drow@bin.sh>
+// http://creativecommons.org/publicdomain/zero/1.0/
+
+var NameGenerator = function () {
+  this.nameSet    = {};
+  this.chainCache = {};
+
+  // name generator function
+  this.generateName = function (type) {
+    var chain; 
+
+    if (chain = this.markovChain(type)) {
+      return this.markovName(chain);
+    }
+
+    return '';
+  };
+
+  // generate multiple names
+  this.nameList = function (type, nOf) {
+    var list = [],
+        i;
+
+    for (i = 0; i < nOf; i++) {
+      list.push(this.generateName(type));
+    }
+
+    return list;
+  };
+
+  // get markov chain by type
+  this.markovChain = function (type) {
+    var chain; 
+
+    if (chain = this.chainCache[type]) {
+      return chain;
+    } else {
+      var list; 
+
+      if (list = this.nameSet[type]) {
+        var chain;
+
+        if (chain = this.constructChain(list)) {
+          this.chainCache[type] = chain;
+          return chain;
+        }
+      }
+    }
+
+    return false;
+  };
+
+  // construct markov chain from list of names
+  this.constructChain = function (list) {
+    var chain = {},
+        i;
+
+    for (i = 0; i < list.length; i++) {
+      var names = list[i].split(/\s+/);
+      chain = this.incrChain(chain,'parts',names.length);
+      var j; 
+
+      for (j = 0; j < names.length; j++) {
+        var name = names[j];
+        chain = this.incrChain(chain,'nameLen',name.length);
+
+        var c = name.substr(0,1);
+        chain = this.incrChain(chain,'initial',c);
+
+        var string = name.substr(1),
+            lastC  = c;
+
+        while (string.length > 0) {
+          var c = string.substr(0,1);
+          chain = this.incrChain(chain,lastC,c);
+
+          string = string.substr(1);
+          lastC  = c;
+        }
+      }
+    }
+
+    return this.scaleChain(chain);
+  };
+
+  this.incrChain = function (chain, key, token) {
+    if (chain[key]) {
+      if (chain[key][token]) {
+        chain[key][token]++;
+      } else {
+        chain[key][token] = 1;
+      }
+    } else {
+      chain[key] = {};
+      chain[key][token] = 1;
+    }
+
+    return chain;
+  };
+
+  this.scaleChain = function (chain) {
+    var tableLen = {},
+        key;
+
+    for (key in chain) {
+      tableLen[key] = 0;
+      var token;
+
+      for (token in chain[key]) {
+        var count    = chain[key][token],
+            weighted = Math.floor(Math.pow(count,1.3));
+
+        chain[key][token] = weighted;
+        tableLen[key]    += weighted;
+      }
+    }
+
+    chain['tableLen'] = tableLen;
+    
+    return chain;
+  };
+
+  // construct name from markov chain
+  this.markovName = function (chain) {
+    var parts = this.selectLink(chain,'parts'),
+        names = [],
+        i; 
+
+    for (i = 0; i < parts; i++) {
+      var nameLen = this.selectLink(chain, 'nameLen'),
+          c       = this.selectLink(chain, 'initial'),
+          name    = c,
+          lastC   = c;
+
+      while (name.length < nameLen) {
+        c     = this.selectLink(chain, lastC);
+        name += c;
+        lastC = c;
+      }
+
+      names.push(name);
+    }
+    return names.join(' ');
+  };
+
+  this.selectLink = function (chain, key) {
+    var len = chain['tableLen'][key],
+        idx = Math.floor(Math.random() * len),
+        t   = 0;
+
+    for (token in chain[key]) {
+      t += chain[key][token];
+      if (idx < t) { return token; }
+    }
+
+    return '-';
+  };
+}
+
+module.exports = NameGenerator;
diff --git a/lib/index.js b/lib/index.js
@@ -0,0 +1,50 @@
+const program = require('commander');
+const path = require('path');
+const rootDir = path.join(__dirname, '..');
+const libDir = path.join(rootDir, 'lib');
+const pinfo = require(path.join(rootDir, 'package.json'));
+const nomina = require(path.join(libDir, 'nomina'));
+
+// program basics
+program
+.version(pinfo.version, '-v, --version')
+.description(pinfo.description)
+.option('-g, --gender <type>', 'specify which gender to generate')
+.option('-t, --type <type>', 'specify which type to generate')
+.command('generate', 'generate a name', { isDefault: true })
+.command('list', 'list the available types')
+.parse(process.argv);
+
+// config
+if (program.args.indexOf('list') < 0) {
+  const options = {};
+
+  // gender option
+  if (program.gender) {
+    const genderValue = program.gender.toLowerCase();
+    const shortNames = ['m', 'f'];
+    const genders = ['male', 'female'];
+    let gender = 'male';
+
+    // check if it is abbreviated
+    if (shortNames.indexOf(genderValue) >= 0) {
+      gender = genders[shortNames.indexOf(genderValue)];
+    }
+
+    // check if it is in the list
+    if (genders.indexOf(genderValue) >= 0) {
+      gender = genderValue;
+    }
+
+    options.gender = gender;
+  }
+
+  // type option
+  if (program.type) {
+    const typeValue = program.type.toLowerCase();
+    options.type = typeValue;
+  }
+
+  const result = nomina(options);
+  process.stdout.write(`${result}\n`);
+}
diff --git a/lib/nomina-list.js b/lib/nomina-list.js
@@ -0,0 +1,13 @@
+const fs = require('fs');
+const path = require('path');
+const rootDir = path.join(__dirname, '..');
+const dataDir = path.join(rootDir, 'data');
+
+process.stdout.write('Here are the available types:\n');
+
+fs.readdir(dataDir, (err, files) => {
+  files.forEach((file) => {
+    const name = file.replace('.json', '\n');
+    process.stdout.write(`  - ${name}`);
+  });
+});
diff --git a/lib/nomina.js b/lib/nomina.js
@@ -0,0 +1,18 @@
+const path = require('path');
+const rootDir = path.join(__dirname, '..');
+const dataDir = path.join(rootDir, 'data');
+const libDir = path.join(rootDir, 'lib');
+const NameGenerator = require(path.join(libDir, 'generator'));
+
+const nomina = (options = {}) => {
+  const type = options.type || 'asian';
+  const gender = options.gender || 'male';
+  const set = require(path.join(dataDir, `${type}.json`));
+  const nameSet = { default: set[gender] };
+  const generator = new NameGenerator();
+  generator.nameSet = nameSet;
+
+  return generator.generateName('default');
+};
+
+module.exports = nomina;
diff --git a/package.json b/package.json
diff --git a/test/lib/nomina-test.js b/test/lib/nomina-test.js

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+#!/usr/bin/env node`
	`2`	`+`
	`3`	`+require('../lib/index');`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+#!/usr/bin/env node`
	`2`	`+`
	`3`	`+require('../lib/nomina-list');`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "male": ["Ao", "Bang", "Buwei", "Changdong", "Chao", "Fuling", "Gao", "Guang", "He", "Hu Hai", "Jizi", "Ju", "Kang", "Long", "Lun", "Mang", "Qi", "Qian", "Qing", "She", "Sheng", "Si", "Tian", "Wan", "Xian", "Xie", "Xin", "Xing", "Yang", "Ying", "Yu", "Yuan", "Yun", "Zhao", "Zheng", "Zhuang Xiang", "Zhuo", "Ziying"],
 +  "female": ["Feiyan", "Hou", "Ji", "Jiangnu", "Lihua", "Na", "Shengtong", "Zhi"]
 +}