Merge pull request #28 from cloudfour/feat-new_random

New random helper

Author: tylersticka

lib/random.js

@@ -0,0 +1,41 @@
+'use strict';
+
+var R = require('ramda');
+var Chance = require('chance');
+var chance;
+
+/**
+ * Generate a random integer or any other type of random content supported by
+ * [Chance.js](http://chancejs.com).
+ *
+ * @since v0.4.0
+ * @param {String} [method=integer] - Chance method to use.
+ * @param {Object} options
+ * @param {Object} options.hash - Additional options to pass to method.
+ * @return {*}
+ * @see {@link http://chancejs.com|Chance.js}
+ * @example
+ *
+ *    {{random}} //=> 1839473434
+ *    {{random min=5 max=10}} //=> 7
+ *    {{random "state"}} //=> WA
+ *    {{random "dollar" max=20}} //=> $17.42
+ */
+
+module.exports = function random () {
+  var options = R.last(arguments);
+  var hash = options.hash || {};
+  var method = arguments.length > 1 ? arguments[0] : 'integer';
+
+  if (!R.is(String, method)) {
+    throw new Error('The "random" helper\'s first argument must be a String.');
+  }
+
+  chance = chance || new Chance();
+
+  if (!R.propIs(Function, method, chance)) {
+    throw new Error('The "random" helper does not support the "' + method + '" method.');
+  }
+
+  return chance[method](hash);
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-hbs-helpers",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Handlebars helpers that we usually need.",
   "main": "index.js",
   "files": [
@@ -27,6 +27,7 @@
   },
   "homepage": "https://github.com/cloudfour/core-hbs-helpers",
   "dependencies": {
+    "chance": "^1.0.3",
     "handlebars": "^4.0.3",
     "moment": "^2.10.6",
     "ramda": "^0.18.0",

test/random.spec.js

@@ -0,0 +1,56 @@
+'use strict';
+
+var random = require('../').random;
+var tape = require('tape');
+var R = require('ramda');
+var Handlebars = require('handlebars');
+var Chance = require('chance');
+var chance = new Chance();
+
+Handlebars.registerHelper(random.name, random);
+
+tape('random', function (test) {
+  var template;
+  var result;
+  var parsed;
+
+  test.plan(6);
+
+  template = Handlebars.compile('{{random}}');
+  result = template();
+  parsed = parseFloat(result);
+  test.ok(R.is(Number, parsed) && parsed === parseInt(result, 10), 'Works');
+
+  template = Handlebars.compile('{{random min=5 max=10}}');
+  result = template();
+  parsed = parseInt(result, 10);
+  test.ok(parsed >= 5 && parsed <= 10, 'Works with hash');
+
+  template = Handlebars.compile('{{random "state"}}');
+  result = template();
+  test.ok(R.find(R.propEq('abbreviation', result))(chance.states()), 'Works with method');
+
+  template = Handlebars.compile('{{random "dollar" max=20}}');
+  result = template();
+  parsed = parseFloat(result.substr(1));
+  test.ok(result[0] === '$' && parsed <= 20, 'Works with method and hash');
+
+  template = Handlebars.compile('{{random 42}}');
+  test.throws(
+    function () {
+      template();
+    },
+    /first argument must be a String\.$/,
+    'Errors when method is not a String'
+  );
+
+  template = Handlebars.compile('{{random "whatever"}}');
+  test.throws(
+    function () {
+      template();
+    },
+    /does not support the "whatever" method\.$/,
+    'Errors when method does not exist'
+  );
+
+});