src/cm/media/js/lib/yui/yui_3.10.3/build/template-micro/template-micro-debug.js
author Yves-Marie Haussonne <ymh.work+github@gmail.com>
Fri, 09 May 2014 18:35:26 +0200
changeset 656 a84519031134
parent 525 89ef5ed3c48b
permissions -rw-r--r--
add link to "privacy policy" in the header test
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
525
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     1
/*
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     2
YUI 3.10.3 (build 2fb5187)
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     3
Copyright 2013 Yahoo! Inc. All rights reserved.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     4
Licensed under the BSD License.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     5
http://yuilibrary.com/license/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     6
*/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     7
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     8
YUI.add('template-micro', function (Y, NAME) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     9
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    10
/*jshint expr:true */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    11
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    12
/**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    13
Adds the `Y.Template.Micro` template engine, which provides fast, simple
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    14
string-based micro-templating similar to ERB or Underscore templates.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    15
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    16
@module template
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    17
@submodule template-micro
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    18
@since 3.8.0
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    19
**/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    20
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    21
/**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    22
Fast, simple string-based micro-templating engine similar to ERB or Underscore
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    23
templates.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    24
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    25
@class Template.Micro
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    26
@static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    27
@since 3.8.0
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    28
**/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    29
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    30
// This code was heavily inspired by Underscore.js's _.template() method
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    31
// (written by Jeremy Ashkenas), which was in turn inspired by John Resig's
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    32
// micro-templating implementation.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    33
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    34
var Micro = Y.namespace('Template.Micro');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    35
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    36
/**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    37
Default options for `Y.Template.Micro`.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    38
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    39
@property {Object} options
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    40
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    41
    @param {RegExp} [options.code] Regex that matches code blocks like
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    42
        `<% ... %>`.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    43
    @param {RegExp} [options.escapedOutput] Regex that matches escaped output
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    44
        tags like `<%= ... %>`.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    45
    @param {RegExp} [options.rawOutput] Regex that matches raw output tags like
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    46
        `<%== ... %>`.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    47
    @param {RegExp} [options.stringEscape] Regex that matches characters that
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    48
        need to be escaped inside single-quoted JavaScript string literals.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    49
    @param {Object} [options.stringReplace] Hash that maps characters matched by
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    50
        `stringEscape` to the strings they should be replaced with. If you add
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    51
        a character to the `stringEscape` regex, you need to add it here too or
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    52
        it will be replaced with an empty string.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    53
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    54
@static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    55
@since 3.8.0
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    56
**/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    57
Micro.options = {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    58
    code         : /<%([\s\S]+?)%>/g,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    59
    escapedOutput: /<%=([\s\S]+?)%>/g,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    60
    rawOutput    : /<%==([\s\S]+?)%>/g,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    61
    stringEscape : /\\|'|\r|\n|\t|\u2028|\u2029/g,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    62
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    63
    stringReplace: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    64
        '\\'    : '\\\\',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    65
        "'"     : "\\'",
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    66
        '\r'    : '\\r',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    67
        '\n'    : '\\n',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    68
        '\t'    : '\\t',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    69
        '\u2028': '\\u2028',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    70
        '\u2029': '\\u2029'
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    71
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    72
};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    73
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    74
/**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    75
Compiles a template string into a JavaScript function. Pass a data object to the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    76
function to render the template using the given data and get back a rendered
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    77
string.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    78
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    79
Within a template, use `<%= ... %>` to output the value of an expression (where
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    80
`...` is the JavaScript expression or data variable to evaluate). The output
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    81
will be HTML-escaped by default. To output a raw value without escaping, use
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    82
`<%== ... %>`, but be careful not to do this with untrusted user input.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    83
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    84
To execute arbitrary JavaScript code within the template without rendering its
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    85
output, use `<% ... %>`, where `...` is the code to be executed. This allows the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    86
use of if/else blocks, loops, function calls, etc., although it's recommended
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    87
that you avoid embedding anything beyond basic flow control logic in your
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    88
templates.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    89
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    90
Properties of the data object passed to a template function are made available
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    91
on a `data` variable within the scope of the template. So, if you pass in
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    92
the object `{message: 'hello!'}`, you can print the value of the `message`
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    93
property using `<%= data.message %>`.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    94
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    95
@example
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    96
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    97
    YUI().use('template-micro', function (Y) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    98
        var template = '<ul class="<%= data.classNames.list %>">' +
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    99
                           '<% Y.Array.each(data.items, function (item) { %>' +
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   100
                               '<li><%= item %></li>' +
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   101
                           '<% }); %>' +
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   102
                       '</ul>';
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   103
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   104
        // Compile the template into a function.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   105
        var compiled = Y.Template.Micro.compile(template);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   106
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   107
        // Render the template to HTML, passing in the data to use.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   108
        var html = compiled({
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   109
            classNames: {list: 'demo'},
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   110
            items     : ['one', 'two', 'three', 'four']
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   111
        });
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   112
    });
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   113
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   114
@method compile
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   115
@param {String} text Template text to compile.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   116
@param {Object} [options] Options. If specified, these options will override the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   117
    default options defined in `Y.Template.Micro.options`. See the documentation
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   118
    for that property for details on which options are available.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   119
@return {Function} Compiled template function. Execute this function and pass in
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   120
    a data object to render the template with the given data.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   121
@static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   122
@since 3.8.0
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   123
**/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   124
Micro.compile = function (text, options) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   125
    /*jshint evil:true */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   126
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   127
    var blocks     = [],
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   128
        tokenClose = "\uffff",
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   129
        tokenOpen  = "\ufffe",
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   130
        source;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   131
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   132
    options = Y.merge(Micro.options, options);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   133
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   134
    // Parse the input text into a string of JavaScript code, with placeholders
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   135
    // for code blocks. Text outside of code blocks will be escaped for safe
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   136
    // usage within a double-quoted string literal.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   137
    //
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   138
    // $b is a blank string, used to avoid creating lots of string objects.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   139
    //
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   140
    // $v is a function that returns the supplied value if the value is truthy
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   141
    // or the number 0, or returns an empty string if the value is falsy and not
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   142
    // 0.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   143
    //
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   144
    // $t is the template string.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   145
    source = "var $b='', $v=function (v){return v || v === 0 ? v : $b;}, $t='" +
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   146
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   147
        // U+FFFE and U+FFFF are guaranteed to represent non-characters, so no
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   148
        // valid UTF-8 string should ever contain them. That means we can freely
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   149
        // strip them out of the input text (just to be safe) and then use them
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   150
        // for our own nefarious purposes as token placeholders!
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   151
        //
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   152
        // See http://en.wikipedia.org/wiki/Mapping_of_Unicode_characters#Noncharacters
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   153
        text.replace(/\ufffe|\uffff/g, '')
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   154
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   155
        .replace(options.rawOutput, function (match, code) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   156
            return tokenOpen + (blocks.push("'+\n$v(" + code + ")+\n'") - 1) + tokenClose;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   157
        })
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   158
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   159
        .replace(options.escapedOutput, function (match, code) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   160
            return tokenOpen + (blocks.push("'+\n$e($v(" + code + "))+\n'") - 1) + tokenClose;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   161
        })
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   162
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   163
        .replace(options.code, function (match, code) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   164
            return tokenOpen + (blocks.push("';\n" + code + "\n$t+='") - 1) + tokenClose;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   165
        })
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   166
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   167
        .replace(options.stringEscape, function (match) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   168
            return options.stringReplace[match] || '';
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   169
        })
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   170
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   171
        // Replace the token placeholders with code.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   172
        .replace(/\ufffe(\d+)\uffff/g, function (match, index) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   173
            return blocks[parseInt(index, 10)];
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   174
        })
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   175
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   176
        // Remove noop string concatenations that have been left behind.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   177
        .replace(/\n\$t\+='';\n/g, '\n') +
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   178
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   179
        "';\nreturn $t;";
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   180
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   181
    // If compile() was called from precompile(), return precompiled source.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   182
    if (options.precompile) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   183
        return "function (Y, $e, data) {\n" + source + "\n}";
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   184
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   185
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   186
    // Otherwise, return an executable function.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   187
    return this.revive(new Function('Y', '$e', 'data', source));
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   188
};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   189
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   190
/**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   191
Precompiles the given template text into a string of JavaScript source code that
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   192
can be evaluated later in another context (or on another machine) to render the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   193
template.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   194
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   195
A common use case is to precompile templates at build time or on the server,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   196
then evaluate the code on the client to render a template. The client only needs
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   197
to revive and render the template, avoiding the work of the compilation step.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   198
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   199
@method precompile
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   200
@param {String} text Template text to precompile.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   201
@param {Object} [options] Options. If specified, these options will override the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   202
    default options defined in `Y.Template.Micro.options`. See the documentation
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   203
    for that property for details on which options are available.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   204
@return {String} Source code for the precompiled template.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   205
@static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   206
@since 3.8.0
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   207
**/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   208
Micro.precompile = function (text, options) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   209
    options || (options = {});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   210
    options.precompile = true;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   211
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   212
    return this.compile(text, options);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   213
};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   214
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   215
/**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   216
Compiles and renders the given template text in a single step.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   217
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   218
This can be useful for single-use templates, but if you plan to render the same
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   219
template multiple times, it's much better to use `compile()` to compile it once,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   220
then simply call the compiled function multiple times to avoid recompiling.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   221
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   222
@method render
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   223
@param {String} text Template text to render.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   224
@param {Object} data Data to pass to the template.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   225
@param {Object} [options] Options. If specified, these options will override the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   226
    default options defined in `Y.Template.Micro.options`. See the documentation
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   227
    for that property for details on which options are available.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   228
@return {String} Rendered result.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   229
@static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   230
@since 3.8.0
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   231
**/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   232
Micro.render = function (text, data, options) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   233
    return this.compile(text, options)(data);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   234
};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   235
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   236
/**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   237
Revives a precompiled template function into a normal compiled template function
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   238
that can be called to render the template. The precompiled function must already
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   239
have been evaluated to a function -- you can't pass raw JavaScript code to
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   240
`revive()`.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   241
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   242
@method revive
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   243
@param {Function} precompiled Precompiled template function.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   244
@return {Function} Revived template function, ready to be rendered.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   245
@static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   246
@since 3.8.0
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   247
**/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   248
Micro.revive = function (precompiled) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   249
    return function (data) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   250
        data || (data = {});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   251
        return precompiled.call(data, Y, Y.Escape.html, data);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   252
    };
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   253
};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   254
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   255
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   256
}, '3.10.3', {"requires": ["escape"]});