Initial commit

Author: rdmurphy

.babelrc

@@ -0,0 +1,14 @@
+{
+  "env": {
+    "commonjs": {
+      "plugins": [
+        ["transform-es2015-modules-commonjs", { "loose": true }]
+      ]
+    },
+    "es": {
+      "plugins": [
+        "./build/use-lodash-es"
+      ]
+    }
+  }
+}

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -0,0 +1,39 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# 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 REPL history
+.node_repl_history
+
+# Project folders
+dist
+es
+lib

build/use-lodash-es.js

@@ -0,0 +1,10 @@
+module.exports = function () {
+  return {
+    visitor: {
+      ImportDeclaration(path) {
+        var source = path.node.source;
+        source.value = source.value.replace(/^lodash($|\/)/, 'lodash-es$1');
+      }
+    }
+  };
+};

package.json

@@ -0,0 +1,58 @@
+{
+  "name": "journalize",
+  "version": "0.1.0",
+  "description": "A collection of functions useful for making prose more reader friendly. Inspired by Django's `django.contrib.humanize`.",
+  "main": "lib/index.js",
+  "jsnext:main": "es/index.js",
+  "files": [
+    "dist",
+    "lib",
+    "es",
+    "src"
+  ],
+  "scripts": {
+    "build:commonjs": "BABEL_ENV=commonjs babel src --out-dir lib",
+    "build:es": "BABEL_ENV=es babel src --out-dir es",
+    "build:umd": "BABEL_ENV=commonjs rollup --config --output ./dist/journalize.js -- ./src/index.js",
+    "build:umd:min": "BABEL_ENV=commonjs rollup --config -- ./src/index.js | uglifyjs --compress --mangle --output ./dist/journalize.min.js",
+    "build": "npm run build:commonjs && npm run build:es && npm run build:umd && npm run build:umd:min",
+    "clean": "rimraf dist es lib",
+    "docs:serve": "documentation serve --watch ./src/index.js",
+    "test": "BABEL_ENV=commonjs mocha --compilers js:babel-register",
+    "test:cov": "BABEL_ENV=commonjs babel-node $(npm bin)/isparta cover $(npm bin)/_mocha"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rdmurphy/journalize.git"
+  },
+  "keywords": [
+    "normalization",
+    "journalism",
+    "humanity",
+    "editing",
+    "prose"
+  ],
+  "author": "Ryan Murphy <[email protected]>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/rdmurphy/journalize/issues"
+  },
+  "homepage": "https://github.com/rdmurphy/journalize#readme",
+  "dependencies": {
+    "lodash": "^4.11.0",
+    "lodash-es": "^4.11.0"
+  },
+  "devDependencies": {
+    "babel-cli": "^6.7.5",
+    "babel-plugin-transform-es2015-modules-commonjs": "^6.7.4",
+    "babel-register": "^6.7.2",
+    "documentation": "^4.0.0-beta2",
+    "isparta": "^4.0.0",
+    "mocha": "^2.4.5",
+    "rimraf": "^2.5.2",
+    "rollup": "^0.25.8",
+    "rollup-plugin-commonjs": "^2.2.1",
+    "rollup-plugin-node-resolve": "^1.5.0",
+    "uglify-js": "^2.6.2"
+  }
+}

rollup.config.js

@@ -0,0 +1,14 @@
+import commonjs from 'rollup-plugin-commonjs';
+import node from 'rollup-plugin-node-resolve';
+
+export default {
+  format: 'umd',
+  moduleName: 'journalize',
+  plugins: [
+    commonjs(),
+    node({
+      jsnext: true,
+      main: true
+    })
+  ]
+};

src/apnumber.js

@@ -0,0 +1,45 @@
+import isInteger from 'lodash/isInteger';
+import isNil from 'lodash/isNil';
+
+/**
+ * List of spelled out numbers per AP style.
+ * @private
+ * @type {Array}
+ */
+var AP_NUMBERS = ['one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine'];
+
+/**
+ * Converts an integer to string representation per AP style rules. If an
+ * integer is not one that would be converted, it is returned in its original
+ * form.
+ *
+ * If a non-integer is given, it will be returned in its original form, as
+ * well.
+ *
+ * @param  {Number} val
+ * @return {String}
+ * @example
+ *
+ * var journalize = require('journalize');
+ *
+ * journalize.apnumber(8);
+ * // returns 'eight'
+ *
+ * journalize.apnumber(42);
+ * // returns 42
+ *
+ */
+export default function apnumber (val) {
+  // if `val` is undefined or null, return an empty string
+  if (isNil(val)) return '';
+
+  var convertedVal = +val;
+
+  // if `convertedVal` is not an integer, return `val`
+  if (!isInteger(convertedVal)) return val;
+
+  // if `convertedVal` is not between 0 and 10, return `val`
+  if (convertedVal <= 0 || convertedVal >= 10) return val;
+
+  return AP_NUMBERS[convertedVal - 1];
+}

src/index.js

@@ -0,0 +1,9 @@
+import apnumber from './apnumber';
+import intword from './intword';
+import ordinal from './ordinal';
+
+export {
+  apnumber,
+  intword,
+  ordinal
+};

src/intword.js

@@ -0,0 +1,13 @@
+import isInteger from 'lodash/isInteger';
+import isNil from 'lodash/isNil';
+
+export default function intword (val) {
+  if (isNil(val)) return '';
+
+  var convertedVal = +val;
+
+  if (!isInteger(convertedVal)) return val;
+  if (convertedVal < 1000000) return convertedVal;
+
+  return convertedVal;
+}

src/ordinal.js

@@ -0,0 +1,45 @@
+import isInteger from 'lodash/isInteger';
+import isNil from 'lodash/isNil';
+import includes from 'lodash/includes';
+
+/**
+ * A list of suffixes for conversions.
+ * @private
+ * @type {Array}
+ */
+var SUFFIXES = ['th', 'st', 'nd', 'rd', 'th', 'th', 'th', 'th', 'th', 'th'];
+
+/**
+ * Converts an integer into its ordinal form. Handles the special cases of 11,
+ * 12 and 13, too. If a non-integer is submitted, it will be returned in its
+ * original form.
+ *
+ * @param  {Number} val
+ * @return {String}
+ * @example
+ *
+ * var journalize = require('journalize');
+ *
+ * journalize.ordinal(5);
+ * // returns '5th'
+ *
+ * journalize.ordinal(13);
+ * // returns '13th'
+ *
+ * journalize.ordinal(103);
+ * // returns '103rd'
+ */
+export default function ordinal (val) {
+  // if `val` is undefined or null, return an empty string
+  if (isNil(val)) return '';
+
+  var convertedVal = +val;
+
+  // if `convertedVal` is not an integer, return `val`
+  if (!isInteger(convertedVal)) return val;
+
+  // if `convertedVal` is 11, 12 or 13, English gets weird
+  if (includes([11, 12, 13], convertedVal % 100)) return convertedVal + SUFFIXES[0];
+
+  return convertedVal + SUFFIXES[convertedVal % 10];
+}

test/test.js

@@ -0,0 +1,86 @@
+var assert = require('assert');
+var range = require('lodash/range');
+
+var journalize = require('../src');
+
+describe('apnumber', () => {
+  it('should correctly convert numbers', () => {
+    var test_list = range(-1, 11).map((n) => n.toString());
+
+    var result_list = ['-1', '0', 'one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', '10'];
+
+    test_list.forEach((n, idx) => {
+      assert.deepEqual(journalize.apnumber(n), result_list[idx]);
+    });
+  });
+
+  it('should return empty string when input is `undefined`', () => {
+    assert.deepEqual(journalize.apnumber(undefined), '');
+  });
+
+  it('should return empty string when input is `null`', () => {
+    assert.deepEqual(journalize.apnumber(null), '');
+  });
+
+  it('should return original input when input is not a number', () => {
+    assert.deepEqual(journalize.apnumber('corgi'), 'corgi');
+  });
+
+  it('should return original input when input is not an integer', () => {
+    assert.deepEqual(journalize.apnumber('1.234'), '1.234');
+  });
+});
+
+describe('ordinal', () => {
+  it('should correctly convert ordinals', () => {
+    var test_list = ['1', '2', '3', '4', '11', '12', '13', '101', '102', '103', '111'];
+    var result_list = ['1st', '2nd', '3rd', '4th', '11th', '12th', '13th', '101st', '102nd', '103rd', '111th'];
+
+    test_list.forEach((n, idx) => {
+      assert.deepEqual(journalize.ordinal(n), result_list[idx]);
+    });
+  });
+
+  it('should return empty string when input is `undefined`', () => {
+    assert.deepEqual(journalize.ordinal(undefined), '');
+  });
+
+  it('should return empty string when input is `null`', () => {
+    assert.deepEqual(journalize.ordinal(null), '');
+  });
+
+  it('should return original input when input is not a number', () => {
+    assert.deepEqual(journalize.ordinal('corgi'), 'corgi');
+  });
+
+  it('should return original input when input is not an integer', () => {
+    assert.deepEqual(journalize.ordinal('1.234'), '1.234');
+  });
+});
+
+describe('intword', () => {
+  it('should correctly convert integers to words', () => {
+    var test_list = ['100', '1000000', '1200000', '1290000', '1000000000', '2000000000', '6000000000000', '1300000000000000', '3500000000000000000000', '8100000000000000000000000000000000'];
+    var result_list = ['100', '1.0 million', '1.2 million', '1.3 million', '1.0 billion', '2.0 billion', '6.0 trillion', '1.3 quadrillion', '3.5 sextillion', '8.1 decillion'];
+
+    test_list.forEach((n, idx) => {
+      assert.deepEqual(journalize.intword(n), result_list[idx]);
+    });
+  });
+
+  it('should return empty string when input is `undefined`', () => {
+    assert.deepEqual(journalize.intword(undefined), '');
+  });
+
+  it('should return empty string when input is `null`', () => {
+    assert.deepEqual(journalize.intword(null), '');
+  });
+
+  it('should return original input when input is not a number', () => {
+    assert.deepEqual(journalize.intword('corgi'), 'corgi');
+  });
+
+  it('should return original input when input is not an integer', () => {
+    assert.deepEqual(journalize.intword('1.234'), '1.234');
+  });
+});