@jaredwray/fumanchu 1.0.0

package/lib/url.js

@@ -0,0 +1,132 @@
+'use strict';
+
+var url = require('url');
+var util = require('handlebars-utils');
+var querystring = require('querystring');
+var helpers = module.exports;
+
+/**
+ * Encodes a Uniform Resource Identifier (URI) component
+ * by replacing each instance of certain characters by
+ * one, two, three, or four escape sequences representing
+ * the UTF-8 encoding of the character.
+ *
+ * @param {String} `str` The un-encoded string
+ * @return {String} The endcoded string
+ * @api public
+ */
+
+helpers.encodeURI = function(str) {
+  if (util.isString(str)) {
+    return encodeURIComponent(str);
+  }
+};
+
+/**
+ * Escape the given string by replacing characters with escape sequences.
+ * Useful for allowing the string to be used in a URL, etc.
+ *
+ * @param {String} `str`
+ * @return {String} Escaped string.
+ * @api public
+ */
+
+helpers.escape = function(str) {
+  if (util.isString(str)) {
+    return querystring.escape(str);
+  }
+};
+
+/**
+ * Decode a Uniform Resource Identifier (URI) component.
+ *
+ * @param {String} `str`
+ * @return {String}
+ * @api public
+ */
+
+helpers.decodeURI = function(str) {
+  if (util.isString(str)) {
+    return decodeURIComponent(str);
+  }
+};
+
+/**
+ * Alias for [encodeURI](#encodeuri).
+ * @api public
+ */
+
+helpers.url_encode = function() {
+  return helpers.encodeURI.apply(this, arguments);
+};
+
+/**
+ * Alias for [decodeURI](#decodeuri).
+ * @api public
+ */
+
+helpers.url_decode = function(val) {
+  return helpers.decodeURI.apply(this, arguments);
+};
+
+/**
+ * Take a base URL, and a href URL, and resolve them as a
+ * browser would for an anchor tag.
+ *
+ * @param {String} `base`
+ * @param {String} `href`
+ * @return {String}
+ * @api public
+ */
+
+helpers.urlResolve = function(base, href) {
+  return url.resolve(base, href);
+};
+
+/**
+ * Parses a `url` string into an object.
+ *
+ * @param {String} `str` URL string
+ * @return {String} Returns stringified JSON
+ * @api public
+ */
+
+helpers.urlParse = function(str) {
+  return url.parse(str);
+};
+
+/**
+ * Strip the query string from the given `url`.
+ *
+ * @param {String} `url`
+ * @return {String} the url without the queryString
+ * @api public
+ */
+
+helpers.stripQuerystring = function(str) {
+  if (util.isString(str)) {
+    return str.split('?')[0];
+  }
+};
+
+/**
+ * Strip protocol from a `url`. Useful for displaying media that
+ * may have an 'http' protocol on secure connections.
+ *
+ * ```handlebars
+ * <!-- url = 'http://foo.bar' -->
+ * {{stripProtocol url}}
+ * <!-- results in: '//foo.bar' -->
+ * ```
+ * @param {String} `str`
+ * @return {String} the url with http protocol stripped
+ * @api public
+ */
+
+helpers.stripProtocol = function(str) {
+  if (util.isString(str)) {
+    var parsed = url.parse(str);
+    parsed.protocol = '';
+    return parsed.format();
+  }
+};

package/lib/utils/html.js

@@ -0,0 +1,82 @@
+'use strict';
+
+var util = require('handlebars-utils');
+var striptags = require('striptags');
+
+/**
+ * Expose `utils`
+ */
+
+var html = module.exports;
+
+/**
+ * Remove extra newlines from HTML, respect indentation.
+ *
+ * @param {String} html
+ * @return {String}
+ * @api public
+ */
+
+html.condense = function(str) {
+  return str.replace(/(\r\n|\r|\n|\u2028|\u2029) {2,}/g, '\n');
+};
+
+/**
+ * Add a single newline above code comments in HTML
+ *
+ * @param {String} `html`
+ * @return {String}
+ * @api public
+ */
+
+html.padcomments = function(str) {
+  return str.replace(/(\s*<!--)/g, '\n$1');
+};
+
+/**
+ * Parse HTML tag attributes from the `options.hash`.
+ *
+ * @param {Object} `hash` Helper options hash, e.g. `{foo: 'bar'}`
+ * @return {String} Stringified attributes, e.g. `foo="bar"`
+ * @api public
+ */
+
+html.parseAttributes = function parseAttributes(hash) {
+  return Object.keys(hash).map(function(key) {
+    var val = String(hash[key]).replace(/^['"]|["']$/g, '');
+    return key + '="' + val + '"';
+  }).join(' ');
+};
+
+/**
+ * Strip HTML tags from a string, so that only the text nodes
+ * are preserved.
+ *
+ * ```handlebars
+ * {{sanitize "<span>foo</span>"}}
+ * //=> 'foo'
+ * ```
+ *
+ * @param {String} `str` The string of HTML to sanitize.
+ * @return {String}
+ * @api public
+ */
+
+html.sanitize = function(str) {
+  if (!util.isString(str)) return '';
+  return striptags(str).trim();
+};
+
+html.toAttributes = function toAttributes(hash) {
+  var res = '';
+  var keys = Object.keys(hash);
+  for (var i = 0; i < keys.length; i++) {
+    var val = hash[keys[i]];
+    if (val === true) {
+      res += ' ' + keys[i];
+    } else {
+      res += ' ' + keys[i] + '="' + String(val) + '"';
+    }
+  }
+  return res;
+};

package/lib/utils/index.js

@@ -0,0 +1,88 @@
+'use strict';
+
+var util = require('handlebars-utils');
+var utils = require('./utils');
+
+/**
+ * Returns true if the given value contains the given
+ * `object`, optionally passing a starting index.
+ *
+ * @param {Array} val
+ * @param {Object} obj
+ * @param {Number} start
+ * @return {Boolean}
+ */
+
+utils.contains = function(val, obj, start) {
+  if (val == null || obj == null || !utils.isNumber(val.length)) {
+    return false;
+  }
+  return val.indexOf(obj, start) !== -1;
+};
+
+/**
+ * Remove leading and trailing whitespace and non-word
+ * characters from the given string.
+ *
+ * @param {String} `str`
+ * @return {String}
+ */
+
+utils.chop = function(str) {
+  if (!util.isString(str)) return '';
+  var re = /^[-_.\W\s]+|[-_.\W\s]+$/g;
+  return str.trim().replace(re, '');
+};
+
+/**
+ * Change casing on the given `string`, optionally
+ * passing a delimiter to use between words in the
+ * returned string.
+ *
+ * ```handlebars
+ * utils.changecase('fooBarBaz');
+ * //=> 'foo bar baz'
+ *
+ * utils.changecase('fooBarBaz' '-');
+ * //=> 'foo-bar-baz'
+ * ```
+ * @param {String} `string` The string to change.
+ * @return {String}
+ * @api public
+ */
+
+utils.changecase = function(str, fn) {
+  if (!util.isString(str)) return '';
+  if (str.length === 1) {
+    return str.toLowerCase();
+  }
+
+  str = utils.chop(str).toLowerCase();
+  if (typeof fn !== 'function') {
+    fn = utils.identity;
+  }
+
+  var re = /[-_.\W\s]+(\w|$)/g;
+  return str.replace(re, function(_, ch) {
+    return fn(ch);
+  });
+};
+
+/**
+ * Generate a random number
+ *
+ * @param {Number} `min`
+ * @param {Number} `max`
+ * @return {Number}
+ * @api public
+ */
+
+utils.random = function(min, max) {
+  return min + Math.floor(Math.random() * (max - min + 1));
+};
+
+/**
+ * Expose `utils`
+ */
+
+module.exports = utils;

package/lib/utils/utils.js

@@ -0,0 +1,41 @@
+'use strict';
+
+var utils = require('lazy-cache')(require);
+var fn = require;
+require = utils;
+
+// Array utils
+require('array-sort', 'sortBy');
+require('arr-flatten', 'flatten');
+
+// Html utils
+require('to-gfm-code-block', 'block');
+require('html-tag', 'tag');
+
+// JavaScript language utils
+require('kind-of', 'typeOf');
+
+// matching utils
+require('is-glob');
+require('micromatch', 'mm');
+require('falsey');
+
+// Number utils
+require('is-even');
+require('is-number');
+
+// Object utils
+require('create-frame');
+require('get-object');
+require('get-value', 'get');
+require('for-own');
+
+// Path utils
+require('relative');
+require = fn;
+
+/**
+ * Expose `utils`
+ */
+
+module.exports = utils;

package/package.json

@@ -0,0 +1,159 @@
+{
+  "name": "@jaredwray/fumanchu",
+  "description": "Handlebars + Helpers = Fumanchu",
+  "version": "1.0.0",
+  "homepage": "https://github.com/jaredwray/fumanchu",
+  "author": "Jared Wray (me@jaredwray.com)",
+  "contributors": [
+    "Adrián Mugnolo (https://github.com/xymbol)",
+    "Aleš Kotnik (www.draagle.com)",
+    "Ali Sheehan-Dare (https://github.com/alisd23)",
+    "Anders D. Johnson (https://andrz.me)",
+    "Arthur Cinader (http://github.com/acinader)",
+    "Brian Woodward (https://twitter.com/doowb)",
+    "Dan Dascalescu (http://dandascalescu.com)",
+    "Dan Gorby (https://plus.google.com/+GreenRaccoon23)",
+    "Dane Petersen (https://thegreatsunra.com)",
+    "Daniel Wabyick (https://github.com/dwabyick)",
+    "Dennis Borisevich (https://github.com/DenSpirit)",
+    "Foundy (http://foundy.io)",
+    "GONZO (https://github.com/why2pac)",
+    "GracefulLight (https://brendaniel.github.io)",
+    "Hariadi Hinta (http://www.hariadi.org)",
+    "James Tsuyuki (https://github.com/jtsuyuki)",
+    "Jan Stola (https://github.com/iamstolis)",
+    "Jason Bellamy (http://jasonbellamy.com)",
+    "Jeffrey Froom (http://jfroom.com)",
+    "Jocelyn Badgley (http://www.chipersoft.com)",
+    "Joey Baker (https://www.byjoeybaker.com)",
+    "Jon Schlinkert (http://twitter.com/jonschlinkert)",
+    "Kevin Davis (kevindav.us)",
+    "Laurent Goderre (https://github.com/LaurentGoderre)",
+    "Liam Moat (http://www.liammoat.com)",
+    "Makoto Tateno (https://github.com/makotot)",
+    "Marie Hogebrandt (http://mariehogebrandt.se)",
+    "Mark Perkins (http://allmarkedup.com)",
+    "Martyn Rushton (http://swapnull.co.uk)",
+    "Max Albrecht (178.is)",
+    "Michael Sheedy (michaelsheedy.com)",
+    "Mikko Tapionlinna (http://mikko.tapionlinna.fi)",
+    "Nathan Jessen (http://nathanjessen.github.io)",
+    "Nathaniel Furniss (https://github.com/nlfurniss)",
+    "Oleg Orlov (https://github.com/efender)",
+    "Omesh (https://github.com/omeshp)",
+    "Patrick Burtchaell (https://pburtchaell.com)",
+    "Paul Welsh (paulwelsh.info)",
+    "Raymond Camden (https://www.raymondcamden.com)",
+    "Rob (https://github.com/robsilva)",
+    "Sam Tiffin (https://samtiffin.com)",
+    "Shannon Moeller (http://shannonmoeller.com)",
+    "Spud Hsu (http://spud.in)",
+    "Stephen Way (http://stephenway.net)",
+    "Thomas Jaggi (http://responsive.ch)",
+    "Tim Douglas (https://github.com/timdouglas)",
+    "(https://github.com/homersimpsons)",
+    "Jonathas Ribeiro (https://github.com/jonathas)",
+    "Jared Wray (https://github.com/jaredwray)"
+  ],
+  "repository": "jaredwray/fumanchu",
+  "bugs": {
+    "url": "https://github.com/jaredwray/fumanchu/issues"
+  },
+  "license": "MIT",
+  "files": [
+    "index.js",
+    "helpers.js",
+    "lib",
+    "dist",
+    "index.d.ts"
+  ],
+  "source": "index.js",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "browser": "dist/fumanchu.min.js",
+  "engines": {
+    "node": ">=14"
+  },
+  "scripts": {
+    "test": "c8 mocha --reporter list",
+    "test:ci": "c8 --reporter=lcov mocha --reporter list",
+    "build": "parcel build --dist-dir dist",
+    "clean": "rm -rf node_modules && rm -rf dist && rm -rf .parcel-cache"
+  },
+  "dependencies": {
+    "arr-flatten": "^1.1.0",
+    "array-sort": "^1.0.0",
+    "create-frame": "^1.0.0",
+    "define-property": "^2.0.2",
+    "falsey": "^1.0.0",
+    "for-in": "^1.0.2",
+    "for-own": "^1.0.0",
+    "get-object": "^0.2.0",
+    "get-value": "^3.0.1",
+    "handlebars": "^4.7.8",
+    "handlebars-helper-create-frame": "^0.1.0",
+    "handlebars-utils": "^1.0.6",
+    "has-value": "^2.0.2",
+    "helper-date": "^1.0.1",
+    "helper-for-markdown": "^1.0.2",
+    "helper-md": "^0.2.2",
+    "html-tag": "^2.0.0",
+    "is-even": "^1.0.0",
+    "is-glob": "^4.0.3",
+    "is-number": "^7.0.0",
+    "kind-of": "^6.0.3",
+    "lazy-cache": "^2.0.2",
+    "logging-helpers": "^1.0.0",
+    "micromatch": "^4.0.5",
+    "relative": "^3.0.2",
+    "striptags": "^3.2.0",
+    "to-gfm-code-block": "^0.1.1",
+    "year": "^0.2.1"
+  },
+  "devDependencies": {
+    "@parcel/watcher": "^2.3.0",
+    "c8": "^8.0.1",
+    "chai": "^4.3.8",
+    "global-modules": "^2.0.0",
+    "mocha": "^10.2.0",
+    "parcel": "^2.9.3",
+    "template-helpers": "^1.0.1",
+    "templates": "^1.2.9"
+  },
+  "keywords": [
+    "array",
+    "assemble",
+    "collection",
+    "comparison",
+    "date",
+    "handlebars",
+    "helper",
+    "helpers",
+    "html",
+    "i18n",
+    "inflection",
+    "log",
+    "logging",
+    "markdown",
+    "math",
+    "number",
+    "object",
+    "path",
+    "repeat",
+    "string",
+    "template",
+    "time",
+    "url",
+    "util",
+    "utility"
+  ],
+  "browserslist": [
+    "last 1 version",
+    "> 1%",
+    "not dead"
+  ],
+  "targets": {
+    "main": false,
+    "types": false
+  }
+}