Merge pull request #29 from cloudfour/feat-capitalize

Add capitalize helpers

Author: tylersticka

lib/capitalize.js

@@ -0,0 +1,27 @@
+'use strict';
+
+var R = require('ramda');
+var Capitalize = require('capitalize');
+
+/**
+ * Capitalize the first letter of a String.
+ *
+ * @since 0.4.0
+ * @param {String|*} str - String to capitalize. Other types will be converted.
+ * @return {String}
+ * @example:
+ *
+ *    {{capitalize "hello world"}} //=> "Hello world"
+ */
+
+module.exports = function capitalize (str) {
+  if (R.isNil(str)) {
+    throw new Error('The "capitalize" helper requires one argument.')
+  }
+
+  if (!R.is(String, str)) {
+    str = str.toString();
+  }
+
+  return Capitalize(str);
+};

lib/capitalizeWords.js

@@ -0,0 +1,30 @@
+'use strict';
+
+var R = require('ramda');
+var Capitalize = require('capitalize');
+
+/**
+ * Capitalize each word in a String. Works with punctuation and international
+ * characters.
+ *
+ * @since 0.4.0
+ * @param {String|*} str - String to capitalize. Other types will be converted.
+ * @return {String}
+ * @example:
+ *
+ *    {{capitalizeWords "hello world"}} //=> "Hello World"
+ *    {{capitalizeWords "hello-cañapolísas"}} //=> "Hello-Cañapolísas"
+ *    {{capitalizeWords "it's a nice day"}} //=> "It's A Nice Day"
+ */
+
+module.exports = function capitalizeWords (str) {
+  if (R.isNil(str)) {
+    throw new Error('The "capitalizeWords" helper requires one argument.')
+  }
+
+  if (!R.is(String, str)) {
+    str = str.toString();
+  }
+
+  return Capitalize.words(str);
+};

package.json

@@ -27,6 +27,7 @@
   },
   "homepage": "https://github.com/cloudfour/core-hbs-helpers",
   "dependencies": {
+    "capitalize": "^1.0.0",
     "chance": "^1.0.3",
     "handlebars": "^4.0.3",
     "moment": "^2.10.6",

test/capitalize.spec.js

@@ -0,0 +1,31 @@
+'use strict';
+
+var capitalize = require('../').capitalize;
+var tape = require('tape');
+var Handlebars = require('handlebars');
+
+Handlebars.registerHelper(capitalize.name, capitalize);
+
+tape('capitalize', function (test) {
+  var template = Handlebars.compile('{{capitalize content}}');
+  var expected;
+  var actual;
+
+  test.plan(3);
+
+  expected = 'Hello world';
+  actual = template({ content: 'hello world' });
+  test.equal(actual, expected, 'Works');
+
+  expected = 'True';
+  actual = template({ content: true });
+  test.equal(actual, expected, 'Works with non-String arguments');
+
+  test.throws(
+    function () {
+      template();
+    },
+    /requires one argument\.$/,
+    'Errors when argument is missing'
+  );
+});

test/capitalizeWords.spec.js

@@ -0,0 +1,31 @@
+'use strict';
+
+var capitalizeWords = require('../').capitalizeWords;
+var tape = require('tape');
+var Handlebars = require('handlebars');
+
+Handlebars.registerHelper(capitalizeWords.name, capitalizeWords);
+
+tape('capitalizeWords', function (test) {
+  var template = Handlebars.compile('{{{capitalizeWords content}}}');
+  var expected;
+  var actual;
+
+  test.plan(3);
+
+  expected = '"How\'s It Going?"';
+  actual = template({ content: '"how\'s it going?"' });
+  test.equal(actual, expected, 'Works');
+
+  expected = 'A,B,C';
+  actual = template({ content: ['a', 'b', 'c'] });
+  test.equal(actual, expected, 'Works with non-String arguments');
+
+  test.throws(
+    function () {
+      template();
+    },
+    /requires one argument\.$/,
+    'Errors when argument is missing'
+  );
+});