archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

template.js - cache, settings now instance fields

Browse Source 
`cache` and `settings` are no longer private fields.
This was done so
that plugins could use this class without messing up
the final output
when template name collisions occur. i.e. each instance
has it's own
template cache. The `settings` were made specific to each
instance so
that users of this class could redefine the underscore
template
settings if they want to.
This commit is contained in:
Matthew Kastor 2012-10-20 17:56:35 -04:00
parent 7dff20de33
commit 5ea5f62fc0
1 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
rhino_modules/jsdoc/template.js
View File

@ -1,19 +1,20 @@
/** /**
@overview * @file Wrapper for underscore's template utility to allow loading templates from files.
@author Rafał Wrzeszcz <rafal.wrzeszcz@wrzasq.pl> * @author Rafał Wrzeszcz <rafal.wrzeszcz@wrzasq.pl>
@license Apache License 2.0 - See file 'LICENSE.md' in this project. * @author <a href="mailto:matthewkastor@gmail.com">Matthew Christopher Kastor-Inare III</a>
* @license Apache License 2.0 - See file 'LICENSE.md' in this project.
* @change 2012-10-20 cache and settings are no longer private fields.
* This was done so that plugins could use this class without messing up
* the final output when template name collisions occur. i.e. each instance
* has it's own template cache. The settings were made specific to each
* instance so that users of this class could redefine the underscore
* template settings if they want to.
*/ */
var _ = require('underscore'), var _ = require('underscore'),
fs = require('fs'), fs = require('fs'),
path = require('path'); path = require('path');
// override default settings
var settings = {
evaluate: /<\?js([\s\S]+?)\?>/g,
interpolate: /<\?js=([\s\S]+?)\?>/g,
escape: /<\?js~([\s\S]+?)\?>/g
};
/** /**
@module jsdoc/template @module jsdoc/template
@ -27,6 +28,14 @@ var settings = {
exports.Template = function(path) { exports.Template = function(path) {
this.path = path; this.path = path;
this.layout = null; this.layout = null;
this.cache = {};
// override default template tag settings
this.settings = {
evaluate : /<\?js([\s\S]+?)\?>/g,
interpolate: /<\?js=([\s\S]+?)\?>/g,
escape : /<\?js~([\s\S]+?)\?>/g
};
}; };
/** Loads template from given file. /** Loads template from given file.
@ -35,11 +44,9 @@ exports.Template = function(path) {
*/ */
exports.Template.prototype.load = function(file) { exports.Template.prototype.load = function(file) {
var _path = path.join(this.path, file); var _path = path.join(this.path, file);
return _.template(fs.readFileSync(_path), null, settings); return _.template(fs.readFileSync(_path), null, this.settings);
}; };
// templates cache
var cache = {};
/** /**
Renders template using given data. Renders template using given data.
@ -52,12 +59,12 @@ var cache = {};
*/ */
exports.Template.prototype.partial = function(file, data) { exports.Template.prototype.partial = function(file, data) {
// load template into cache // load template into cache
if (!(file in cache)) { if (!(file in this.cache)) {
cache[file] = this.load(file); this.cache[file] = this.load(file);
} }
// keep template helper context // keep template helper context
return cache[file].call(this, data); return this.cache[file].call(this, data);
}; };
/** /**