periodicjs.core.responder - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

adapters/html_content.js

@@ -15,10 +15,11 @@ 'use strict';
 var findValidViewFromPaths = function (_default, dirs = []) {
-	if (!dirs.length) return Promisie.resolve(_default);
-	return Promisie.retry(() => {
-		let filePath = dirs.shift();
-		return fs.statAsync(filePath)
-			.then(() => filePath, e => Promise.reject(e));
-	}, { times: dirs.length, timeout: 0 })
-		.then(fp => fp)
-		.catch(() => _default);
+  if (!dirs.length) return Promisie.resolve(_default);
+  dirs.reverse(); // use the specific routes first, fallback to the default route
+  return Promisie.retry(() => {
+    let filePath = dirs.shift();
+    return fs.statAsync(filePath)
+      .then(() => filePath, e => Promise.reject(e));
+  }, { times: dirs.length, timeout: 0, })
+    .then(fp => fp)
+    .catch(() => _default);
 };
@@ -40,28 +41,36 @@
 const _RENDER = function (data, options) {
-	try {
-		let { themename, viewname, extname, fileext } = ['themename','viewname','extname','fileext'].reduce((result, key) => {
-	    result[key] = options[key] || this[key];
-	    return result;
-	  }, {});
-	  if (typeof viewname !== 'string') throw new TypeError('viewname must be specified in order to render template');
-	  let dirs = [];
-	  if (options.dirname) {
-	  	if (Array.isArray(options.dirname)) options.dirname.forEach(dir => dirs.push(path.join(dir, `${ viewname }${ (/^\./.test(fileext)) ? fileext : '.' + fileext }`)));
-	  	else dirs.push(path.join(options.dirname, `${ viewname }${ (/^\./.test(fileext)) ? fileext : '.' + fileext }`));
-	  }
-	  if (typeof themename == 'string' && typeof fileext === 'string') dirs.push(path.join(__dirname, '../../../content/themes', themename, 'views', `${ viewname }${ (/^\./.test(fileext)) ? fileext : '.' + fileext }`));
-	  if (typeof extname === 'string' && typeof fileext === 'string') dirs.push(path.join(__dirname, '../../', extname, 'views', `${ viewname }${ (/^\./.test(fileext)) ? fileext : '.' + fileext }`));
-	  dirs.push(path.join(__dirname, '../../../app/views', `${ viewname }${ (/^\./.test(fileext)) ? fileext : '.' + fileext }`));
-	  if (options.resolve_filepath === true) return findValidViewFromPaths(viewname, dirs);
-	  return findValidViewFromPaths(`${ viewname }${ (/^\./.test(fileext)) ? fileext : '.' + fileext }`, dirs)
-	  	.then(filePath => Promisie.all(fs.readFileAsync(filePath, 'utf8'), filePath))
-	  	.spread((filestr, filename) => {
-	  		filestr = filestr.toString();
-	  		return Promisie.resolve(this.engine.render(filestr, data, Object.assign({ filename }, options.engine_configuration || this.engine_configuration)));
-	  	})
-	  	.catch(e => Promisie.reject(e));
-	}
-	catch (e) {
-		return Promisie.reject(e);
-	}
+  try {
+    let { themename, viewname, extname, fileext, } = ['themename', 'viewname', 'extname', 'fileext', ].reduce((result, key) => {
+      result[key] = options[key] || this[key];
+      return result;
+    }, {});
+    if (typeof viewname !== 'string') throw new TypeError('viewname must be specified in order to render template');
+    let dirs = [];
+    //fallback view
+    dirs.push(path.join(options.dirname, `${viewname.replace(viewname.split('/')[0], 'default')}${(/^\./.test(fileext)) ? fileext : '.' + fileext}`));
+    if (options.dirname) {
+      if (Array.isArray(options.dirname)) options.dirname.forEach(dir => dirs.push(path.join(dir, `${ viewname }${ (/^\./.test(fileext)) ? fileext : '.' + fileext }`)));
+      else dirs.push(path.join(options.dirname, `${ viewname }${ (/^\./.test(fileext)) ? fileext : '.' + fileext }`));
+      
+    }
+    if (typeof themename === 'string' && typeof fileext === 'string') dirs.push(path.join(__dirname, '../../../content/themes', themename, 'views', `${ viewname }${ (/^\./.test(fileext)) ? fileext : '.' + fileext }`));
+    if (typeof extname === 'string' && typeof fileext === 'string') dirs.push(path.join(__dirname, '../../', extname, 'views', `${ viewname }${ (/^\./.test(fileext)) ? fileext : '.' + fileext }`));
+    dirs.push(path.join(__dirname, '../../../app/views', `${viewname}${(/^\./.test(fileext)) ? fileext : '.' + fileext}`));
+    
+    if (options.resolve_filepath === true) {
+      console.log('resolving paths', { options, viewname, dirs, });
+      return findValidViewFromPaths(viewname, dirs);
+    } else {
+      console.log('not resolving filepath', { options, viewname, fileext, dirs, });
+      return findValidViewFromPaths(`${ viewname }${ (/^\./.test(fileext)) ? fileext : '.' + fileext }`, dirs)
+        .then(filePath => Promisie.all(fs.readFileAsync(filePath, 'utf8'), filePath))
+        .spread((filestr, filename) => {
+          filestr = filestr.toString();
+          return Promisie.resolve(this.engine.render(filestr, data, Object.assign({ filename, }, options.engine_configuration || this.engine_configuration)));
+        })
+        .catch(e => Promisie.reject(e));
+    }
+  }  catch (e) {
+    return Promisie.reject(e);
+  }
 };
@@ -77,13 +86,12 @@
 const _ERROR = function (err, options) {
-	try {
-		if (this.custom_error_path) options.viewname = (options.viewname) ? path.join(this.custom_error_path, options.viewname) : path.join(this.custom_error_path, 'home/error404');
-		else options.viewname = options.viewname || 'home/error404';
-		return _RENDER.call(this, Object.assign({ flash_messages: {} }, options.locals || {}, {
-			pagedata: { title: 'Not Found', error: (err instanceof Error || err.message) ? err.message : err },
-			url: options.viewname
-		}), options);
-	}
-	catch (e) {
-		return Promise.reject(e);
-	}
+  try {
+    if (this.custom_error_path) options.viewname = (options.viewname) ? path.join(this.custom_error_path, options.viewname) : path.join(this.custom_error_path, 'home/error404');
+    else options.viewname = options.viewname || 'home/error404';
+    return _RENDER.call(this, Object.assign({ flash_messages: {}, }, options.locals || {}, {
+      pagedata: { title: 'Not Found', error: (err instanceof Error || err.message) ? err.message : err, },
+      url: options.viewname,
+    }), options);
+  }  catch (e) {
+    return Promise.reject(e);
+  }
 };
@@ -97,122 +105,120 @@
 const HTML_ADAPTER = class HTML_Adapter extends JSON_Adapter {
-	/**
-	 * @constructor
-	 * @param  {Object} options Configurable options for HTML adapter
-	 * @param {Object} [options.engine=ejs] Defines which templating engine to use when rendering template files
-	 * @param {Function} options.engine.render If providing a custom rendering engine module must include a .render function which is synchronous or returns a Promise. Render function should also expect the following arguments in this order: (template_string, template_data, options)
-	 * @param {Object} [options.engine_configuration] Defines a default set of configuration options that are passed to the rendering function
-	 * @param {string} [options.extname] Name of a periodicjs extension. Used in finding valid template
-	 * @param {string} [options.themename="periodicjs.theme.default"] Name of a periodicjs theme. Used in finding valid template
-	 * @param {Object} [options.locals={}] Shared local values for rendering. Only used when express rendering is not available.
-	 * @param {string} [options.viewname] Defines a default view name that should be used in rendering
-	 * @param {string} [options.fileext=".ejs"] Defines the default extension name of the template file
-	 */
-	constructor (options = {}) {
-		super(options);
-		this.engine = (options.engine && typeof options.engine.render === 'function') ? options.engine : ejs;
-		this.engine_configuration = options.engine_configuration;
-		this.extname = options.extname;
-		this.themename = options.themename || 'periodicjs.theme.default';
-		this.viewname = options.viewname;
-		this.fileext = options.fileext || '.ejs';
-		this.locals = (options.locals && typeof options.locals === 'object') ? options.locals : {};
-		this.custom_error_path = options.custom_error_path;
-	}
-	/**
-	 * Renders HTML from provided data and template
-	 * @param  {Object}  data    Data that is passed to render template
-	 * @param  {Object}  [options={}] Configurable options for rendering see _RENDER for full details
-	 * @param {Function} [options.formatRender=_RENDER] Custom rendering function. It is not recommended to override the default value of this property and may no longer work properly
-	 * @param {Object} [options.req] Express request object. If options.req and options.res are defined the express .render method will be used to render template
-	 * @param {Object} [options.res] Express response object. If options.res and options.req are defined the express .render method will be used to render template
-	 * @param {Boolean} [options.skip_response] If true function will resolve with the rendered template instead of sending a response
-	 * @param  {Function} cb      Optional callback function. If arugment is not passed function will 
-	 * @return {Object}          Returns a Promise if cb arguement is not provided
-	 */
-	render (data, options = {}, cb = false) {
-		if (typeof options === 'function') {
-			cb = options;
-			options = {};
-		}
-		if (options.req && options.res) {
-			data.flash_messages = (typeof options.req.flash === 'function') ? options.req.flash() : {};
-			return _RENDER.call(this, {}, Object.assign(options, { resolve_filepath: true }))
-				.then(filepath => Promisie.promisify(options.res.render, options.res)(filepath, data))
-				.then(rendered => {
-					if (typeof cb === 'function') cb(null, rendered);
-					else if (options.skip_response && typeof cb !== 'function') return Promisie.resolve(rendered);
-					else {
-						options.res.status(200).send(rendered);
-						return Promisie.resolve(rendered);
-					}
-				})
-				.catch(err => this.error(err, options, cb));
-		}
-		else {
-			options.formatRender = (typeof options.formatRender === 'function') ? options.formatRender : _RENDER.bind(this);
-			options.sync = true;
-			return super.render(Object.assign({ flash_messages: {} }, this.locals, data), options)
-				.then(result => {
-					if (typeof cb === 'function') cb(null, result);
-					else return result;
-				}, e => {
-					if (typeof cb === 'function') cb(e);
-					else return Promisie.reject(e);
-				});
-		}
-	}
-	/**
-	 * Renders error view from template
-	 * @param  {*}  err    Any error data that should be passed to template
-	 * @param  {Object}  [options={}] Configurable options for rendering see _ERROR for full details
-	 * @param {Function} [options.formatError=_RENDER] Custom rendering function. It is not recommended to override the default value of this property and may no longer work properly
-	 * @param {Object} [options.req] Express request object. If options.req and options.res are defined the express .render method will be used to render template
-	 * @param {Object} [options.res] Express response object. If options.res and options.req are defined the express .render method will be used to render template
-	 * @param {Boolean} [options.skip_response] If true function will resolve with the rendered 
-	 * @param  {Function} cb      Optional callback function. If arugment is not passed function will 
-	 * @return {Object}          Returns a Promise if cb arguement is not provided
-	 */
-	error (err, options = {}, cb = false) {
-		if (typeof options === 'function') {
-			cb = options;
-			options = {};
-		}
-		if (options.req && options.res) {
-			let flash_messages = (typeof options.req.flash === 'function') ? options.req.flash() : {};
-			if (options.dirname && this.custom_error_path) options.dirname = (Array.isArray(options.dirname)) ? options.dirname.concat(this.custom_error_path) : [options.dirname].concat(this.custom_error_path);
-			else if (!options.dirname && this.custom_error_path) options.dirname = this.custom_error_path;
-			return _RENDER.call(this, {}, Object.assign(options, { resolve_filepath: true }))
-				.then(filepath => Promisie.promisify(options.res.render, options.res)(filepath, Object.assign({
-						pagedata: { title: 'Not Found', error: (err instanceof Error || err.message) ? err.message : err },
-						url: options.viewname
-					}, { flash_messages, error: err, message: err.message })))
-				.then(rendered => {
-					if (typeof cb === 'function') cb(null, rendered);
-					else if (options.skip_response && typeof cb !== 'function') return Promisie.resolve(rendered);
-					else {
-						options.res.status(500).send(rendered);
-						return Promisie.resolve(rendered);
-					}
-				})
-				.catch(err => {
-					if (typeof cb === 'function') cb(err);
-					else return Promisie.reject(err);
-				});
-		}
-		else {
-			options.formatError = (typeof options.formatError === 'function') ? options.formatError : _ERROR.bind(this);
-			options.sync = true;
-			options.locals = this.locals;
-			return super.error(err, options)
-				.then(result => {
-					if (typeof cb === 'function') cb(null, result);
-					else return result;
-				}, e => {
-					if (typeof cb === 'function') cb(e);
-					else return Promisie.reject(e);
-				});
-		}
-	}
+  /**
+   * @constructor
+   * @param  {Object} options Configurable options for HTML adapter
+   * @param {Object} [options.engine=ejs] Defines which templating engine to use when rendering template files
+   * @param {Function} options.engine.render If providing a custom rendering engine module must include a .render function which is synchronous or returns a Promise. Render function should also expect the following arguments in this order: (template_string, template_data, options)
+   * @param {Object} [options.engine_configuration] Defines a default set of configuration options that are passed to the rendering function
+   * @param {string} [options.extname] Name of a periodicjs extension. Used in finding valid template
+   * @param {string} [options.themename="periodicjs.theme.default"] Name of a periodicjs theme. Used in finding valid template
+   * @param {Object} [options.locals={}] Shared local values for rendering. Only used when express rendering is not available.
+   * @param {string} [options.viewname] Defines a default view name that should be used in rendering
+   * @param {string} [options.fileext=".ejs"] Defines the default extension name of the template file
+   */
+  constructor (options = {}) {
+    super(options);
+    this.engine = (options.engine && typeof options.engine.render === 'function') ? options.engine : ejs;
+    this.engine_configuration = options.engine_configuration;
+    this.extname = options.extname;
+    this.themename = options.themename || 'periodicjs.theme.default';
+    this.viewname = options.viewname;
+    this.fileext = options.fileext || '.ejs';
+    this.locals = (options.locals && typeof options.locals === 'object') ? options.locals : {};
+    this.custom_error_path = options.custom_error_path;
+  }
+  /**
+   * Renders HTML from provided data and template
+   * @param  {Object}  data    Data that is passed to render template
+   * @param  {Object}  [options={}] Configurable options for rendering see _RENDER for full details
+   * @param {Function} [options.formatRender=_RENDER] Custom rendering function. It is not recommended to override the default value of this property and may no longer work properly
+   * @param {Object} [options.req] Express request object. If options.req and options.res are defined the express .render method will be used to render template
+   * @param {Object} [options.res] Express response object. If options.res and options.req are defined the express .render method will be used to render template
+   * @param {Boolean} [options.skip_response] If true function will resolve with the rendered template instead of sending a response
+   * @param  {Function} cb      Optional callback function. If arugment is not passed function will 
+   * @return {Object}          Returns a Promise if cb arguement is not provided
+   */
+  render (data, options = {}, cb = false) {
+    if (typeof options === 'function') {
+      cb = options;
+      options = {};
+    }
+    if (options.req && options.res) {
+      data.flash_messages = (typeof options.req.flash === 'function') ? options.req.flash() : {};
+      return _RENDER.call(this, {}, Object.assign(options, { resolve_filepath: true, }))
+        .then(filepath => Promisie.promisify(options.res.render, options.res)(filepath, data))
+        .then(rendered => {
+          if (typeof cb === 'function') cb(null, rendered);
+          else if (options.skip_response && typeof cb !== 'function') return Promisie.resolve(rendered);
+          else {
+            options.res.status(200).send(rendered);
+            return Promisie.resolve(rendered);
+          }
+        })
+        .catch(err => this.error(err, options, cb));
+    }    else {
+      options.formatRender = (typeof options.formatRender === 'function') ? options.formatRender : _RENDER.bind(this);
+      options.sync = true;
+      return super.render(Object.assign({ flash_messages: {}, }, this.locals, data), options)
+        .then(result => {
+          if (typeof cb === 'function') cb(null, result);
+          else return result;
+        }, e => {
+          if (typeof cb === 'function') cb(e);
+          else return Promisie.reject(e);
+        });
+    }
+  }
+  /**
+   * Renders error view from template
+   * @param  {*}  err    Any error data that should be passed to template
+   * @param  {Object}  [options={}] Configurable options for rendering see _ERROR for full details
+   * @param {Function} [options.formatError=_RENDER] Custom rendering function. It is not recommended to override the default value of this property and may no longer work properly
+   * @param {Object} [options.req] Express request object. If options.req and options.res are defined the express .render method will be used to render template
+   * @param {Object} [options.res] Express response object. If options.res and options.req are defined the express .render method will be used to render template
+   * @param {Boolean} [options.skip_response] If true function will resolve with the rendered 
+   * @param  {Function} cb      Optional callback function. If arugment is not passed function will 
+   * @return {Object}          Returns a Promise if cb arguement is not provided
+   */
+  error (err, options = {}, cb = false) {
+    if (typeof options === 'function') {
+      cb = options;
+      options = {};
+    }
+    if (options.req && options.res) {
+      let flash_messages = (typeof options.req.flash === 'function') ? options.req.flash() : {};
+      if (options.dirname && this.custom_error_path) options.dirname = (Array.isArray(options.dirname)) ? options.dirname.concat(this.custom_error_path) : [options.dirname, ].concat(this.custom_error_path);
+      else if (!options.dirname && this.custom_error_path) options.dirname = this.custom_error_path;
+      return _RENDER.call(this, {}, Object.assign(options, { resolve_filepath: true, }))
+        .then(filepath => Promisie.promisify(options.res.render, options.res)(filepath, Object.assign({
+          pagedata: { title: 'Not Found', error: (err instanceof Error || err.message) ? err.message : err, },
+          url: options.viewname,
+        }, { flash_messages, error: err, message: err.message, })))
+        .then(rendered => {
+          if (typeof cb === 'function') cb(null, rendered);
+          else if (options.skip_response && typeof cb !== 'function') return Promisie.resolve(rendered);
+          else {
+            options.res.status(500).send(rendered);
+            return Promisie.resolve(rendered);
+          }
+        })
+        .catch(err => {
+          if (typeof cb === 'function') cb(err);
+          else return Promisie.reject(err);
+        });
+    }    else {
+      options.formatError = (typeof options.formatError === 'function') ? options.formatError : _ERROR.bind(this);
+      options.sync = true;
+      options.locals = this.locals;
+      return super.error(err, options)
+        .then(result => {
+          if (typeof cb === 'function') cb(null, result);
+          else return result;
+        }, e => {
+          if (typeof cb === 'function') cb(e);
+          else return Promisie.reject(e);
+        });
+    }
+  }
 };
 
-module.exports = { HTML_ADAPTER, findValidViewFromPaths };
+module.exports = { HTML_ADAPTER, findValidViewFromPaths, };

package.json

@@ -91,4 +91,4 @@ {
   },
-  "version": "0.2.0",
+  "version": "0.3.0",
   "license": "MIT"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1243267

increased by0.07%

Lines of code

1926

increased by0.21%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes