Adding the Roger Root name coding procedure

Yomguithereal · Jul 3, 2016 · b292bca · b292bca
1 parent 21becb8
commit b292bca
Show file tree

Hide file tree

Showing 4 changed files with 229 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 * Adding the `features/extraction/vectorizer` namespace.
 * Adding the `phonetics/lein` namespace.
+* Adding the `phonetics/roger-root` namespace.
 * Adding the `phonetics/statcan` namespace.
 
 ## 0.6.0

diff --git a/src/phonetics/roger-root.js b/src/phonetics/roger-root.js
@@ -0,0 +1,181 @@
+/**
+ * Talisman phonetics/roger-root
+ * ==============================
+ *
+ * The Roger Root name coding procedure.
+ *
+ * [Reference]:
+ * http://naldc.nal.usda.gov/download/27833/PDF
+ */
+import deburr from 'lodash/deburr';
+import {squeeze} from '../helpers';
+
+/**
+ * Constants.
+ */
+const FIRST_LETTER_ENCODING = {
+  A: '1',
+  B: '09',
+  C: [
+    ['CE', '00'],
+    ['CH', '06'],
+    ['CI', '00'],
+    ['CY', '00'],
+    ['C', '07']
+  ],
+  D: [
+    ['DG', '07'],
+    ['D', '01']
+  ],
+  E: '1',
+  F: '08',
+  G: [
+    ['GF', '08'],
+    ['GM', '03'],
+    ['GN', '02'],
+    ['G', '07']
+  ],
+  H: '2',
+  I: '1',
+  J: '3',
+  K: [
+    ['KN', '02'],
+    ['K', '07']
+  ],
+  L: '05',
+  M: '03',
+  N: '02',
+  O: '1',
+  P: [
+    ['PF', '08'],
+    ['PH', '08'],
+    ['PN', '02'],
+    ['P', '09']
+  ],
+  Q: '07',
+  R: '04',
+  S: [
+    ['SCH', '06'],
+    ['SH', '06'],
+    ['S', '00']
+  ],
+  T: [
+    ['TSCH', '06'],
+    ['TSH', '06'],
+    ['TS', '00'],
+    ['T', '01']
+  ],
+  U: '1',
+  V: '08',
+  W: [
+    ['WR', '04'],
+    ['W', '4']
+  ],
+  X: '07',
+  Y: '5',
+  Z: '00'
+};
+
+const ENCODING = {
+  B: '9',
+  C: [
+    ['CE', '0'],
+    ['CH', '6'],
+    ['CI', '0'],
+    ['CY', '0'],
+    ['C', '7']
+  ],
+  D: [
+    ['DG', '7'],
+    ['D', '1']
+  ],
+  F: '8',
+  G: '7',
+  J: '6',
+  K: '7',
+  L: '5',
+  M: '3',
+  N: '2',
+  P: [
+    ['PH', '8'],
+    ['P', '9']
+  ],
+  Q: '7',
+  R: '4',
+  S: [
+    ['SCH', '6'],
+    ['SH', '6'],
+    ['S', '0']
+  ],
+  T: [
+    ['TSCH', '6'],
+    ['TSH', '6'],
+    ['TS', '0'],
+    ['T', '1']
+  ],
+  V: '8',
+  X: '7',
+  Z: '0'
+};
+
+/**
+ * Helpers.
+ */
+function pad(code) {
+  return (code + '00000').slice(0, 5);
+}
+
+/**
+ * Function taking a single name and computing its roger root code.
+ *
+ * @param  {string}  name - The name to process.
+ * @return {string}       - The roger root code.
+ *
+ * @throws {Error} The function expects the name to be a string.
+ */
+export default function rogerRoot(name) {
+  if (typeof name !== 'string')
+    throw Error('talisman/phonetics/rogerRoot: the given name is not a string.');
+
+  name = deburr(name)
+    .toUpperCase()
+    .replace(/[^A-Z]/g, '');
+
+  let code = '',
+      encodedFirstLetter;
+
+  for (let i = 0, l = name.length; i < l; i++) {
+    const firstIteration = !i,
+          encoding = firstIteration ? FIRST_LETTER_ENCODING : ENCODING,
+          rules = encoding[name[i]];
+
+    if (rules) {
+      if (typeof rules === 'string') {
+        code += rules;
+      }
+      else {
+
+        for (let j = 0, m = rules.length; j < m; j++) {
+          const [match, replacement] = rules[j];
+
+          if (name.substr(i, match.length) === match) {
+            code += replacement;
+            i += (match.length - 1);
+            break;
+          }
+        }
+      }
+    }
+    else {
+      code += '-';
+    }
+
+    if (firstIteration)
+      encodedFirstLetter = code;
+  }
+
+  // Squeezing the code
+  code = encodedFirstLetter + squeeze(code.slice(encodedFirstLetter.length));
+
+  return pad(code.replace(/-/g, ''));
+}
diff --git a/test/endpoint.js b/test/endpoint.js
@@ -50,6 +50,7 @@ describe('phonetics', function() {
   require('./phonetics/metaphone.js');
   require('./phonetics/mra.js');
   require('./phonetics/nysiis.js');
+  require('./phonetics/roger-root.js');
   require('./phonetics/soundex.js');
   require('./phonetics/statcan.js');
 

diff --git a/test/phonetics/roger-root.js b/test/phonetics/roger-root.js
@@ -0,0 +1,46 @@
+/**
+ * Talisman phonetics/roger-root tests
+ * ====================================
+ *
+ */
+import assert from 'assert';
+import rogerRoot from '../../src/phonetics/roger-root';
+
+describe('roger-root', function() {
+
+  it('should throw if the given word is not a string.', function() {
+    assert.throws(function() {
+      rogerRoot([]);
+    }, /string/);
+  });
+
+  it('should compute the roger-root code correctly.', function() {
+    const tests = [
+      ['Guillaume', '07530'],
+      ['Arlène', '14520'],
+      ['Lüdenscheidt', '05126'],
+      ['Chalman', '06532'],
+      ['Ching', '06270'],
+      ['Anderson', '12140'],
+      ['Overstreet', '18401'],
+      ['Heckel', '27500'],
+      ['Wyszynski', '40207'],
+      ['Whitted', '41100'],
+      ['Ongoog', '12770'],
+      ['Johnson', '32020'],
+      ['Williams', '45300'],
+      ['Smith', '00310'],
+      ['Jones', '32000'],
+      ['Brown', '09420'],
+      ['Davis', '01800'],
+      ['Jackson', '37020'],
+      ['Wilson', '45020'],
+      ['Lee', '05000'],
+      ['Thomas', '01300']
+    ];
+
+    tests.forEach(function([word, code]) {
+      assert.strictEqual(rogerRoot(word), code, `${word} => ${code}`);
+    });
+  });
+});