template-tal

template-tal ============ TAL Implementation for nodejs. TAL is an XML templating language. template-tal is suitable for node.js or client-side, and has no dependancies. ** UPDATE ** as from 0.2.0, template-tal supports invoking synchronous & asynchronous functions from the template expressions, see below. SYNOPSIS -------- In your Javascript code: let tal = require ('./lib/template-tal') let xml = ` <html> <body> <p tal:content="foo">Dummy Content</p> <p tal:content="bar()">Dummy Content</p> <p tal:content="baz()">Dummy Content</p> </body> </html> ` let data = { // value foo: "FOO", // function bar: function() { return "BAR" }, // async function baz: function() { return new Promise(function(resolve) { setTimeout(function() { resolve('BAZ')}, 100) }) } } tal .process(xml, data) .then(function(result){ console.log(result) }) It should produce something like this: <html> <body> <p>FOO</p> <p>BAR</p> <p>BAZ</p> </body> </html> SUMMARY ------- Template Attribute Language https://en.wikipedia.org/wiki/Template_Attribute_Language is an amazingly clever specification on how to template XML documents. It does so simply by adding extra attributes to your XML Template file. The specification has been implemented in many languages, including Javascript, but the two existing Javascript implementation either depend on external libraries (jstal/E4X) or work using the DOM (distal). template-tal does neither. It is a completely self-contained library, suitable for node.js, client side applications and / or embedded apps. It is a port of the Perl Petal::Tiny package. http://search.cpan.org/~jhiver/Petal-Tiny-1.03/ This Readme hence steals a lot of its documentation and explains the differences between the two modules. NAMESPACE --------- template-tal has no namespace support, you must use the tal: prefix throughout. KICKSTART --------- Typically, you may have a data structure looking like this: var data = { user: "Bob", getBasket: fetchBasketFunction, }; Where `fetchBasketFunction()` would either return a list of fruits, or a Promise object which should resolve to a list of fruits, like `['apple', 'banana', 'kiwi', 'mango']` You want your end result to look like this: <body> <h1>Bob</h1> <p>Basket List:</p> <ul> <li>apple</li> <li>banana</li> <li>kiwi</li> <li>mango</li> </ul> </body> So let's work this out. First let's replace the username "Bob": <h1 tal:content="user">Bob</h1> Now lets work out the list: <ul> <li tal:repeat="item getBasket()" tal:content="item">some fruit goes here</li> </ul> Our template now looks like: <body> <h1 tal:content="user">Bob</h1> <p>Basket List:</p> <ul> <li tal:repeat="item getBasket()" tal:content="item">some fruit goes here</li> </ul> </body> Ah! But what is happening if our basket is empty? Then we'd get the following output: <body> <h1>Bob</h1> <p>Basket List:</p> <ul> </ul> </body> Which is not very elegant. Thus we change the template as follows: <body tal:define="basket getBasket()"> <h1 tal:content="user">Bob</h1> <div tal:condition="true:basket"> <p>Basket List:</p> <ul> <li tal:repeat="item basket" tal:content="item">some fruit goes here</li> </ul> </div> <div tal:condition="false:basket"> <p><span tal:replace="user">SomeUser</span>'s basket is empty :-(.</p> </div> </body> Let's explain what we did: 1. We used tal:define to assign the list of fruits to a variable called basket using a javascript expression, getBasket(), which can either return the desired value or a Promise to resolve to the desired value. 2. We used tal:content to replace the content of a tag with a javascript expression. This implementation of the TAL spec evals Javascript directly, so you can do things like `<theAnswer tal:content="21*2" />` Which would output <theAnswer>42</theAnswer> Your expression must return something or a Promise of something. 3. We then used tal:condition in conjunction with the "true:" modifier to either display a list if the list is populated, or display a message describing an empty basket. 4. Finally, we used tal:repeat to iterate through each item of the basket. You can find a TAL reference at http://www.owlfish.com/software/simpleTAL/tal-guide.html, and this library tried to implement most of it. RESTRICTIONS: ------------- <ul> <li>No namespace support, just use 'tal:' everywhere.</li> <li>Doesn't implement TALES to evaluate expressions Instead, the Javascript which you supply is evaled directly, which should allow some cool stuff if you use this library in conjunction with jquery for instance.</li> <li>Doesn't implement METAL spec (Macros).</li> </ul> SUPPORTED TAL STATEMENTS: ------------------------- <ul> <li> tal:on-error - to deal with errors</li></ul> <p tal:on-error="string:sorry, could not fetch user."> <b tal:content="database.getUser().name">replace me</b> </p> <ul><li> tal:define - to avoid typing too much</li></ul> <p tal:define="user database.getUser()"> <span tal:replace="user.name" /> </p> <ul><li> tal:condition - for conditional branching</li></ul> <p tal:condition="true:stuff"> stuff is true, let's do something. </p> <p tal:condition="false:stuff"> stuff is false, let's do something else. </p> <ul><li> tal:repeat - to iterate over arrays</li></ul> <table> <th> <td>username</td> <td>email</td> </th> <tr tal:repeat="user users()"> <td tal:content="user.login()">login</td> <td tal:content="user.email()">email</td> </tr> </table> Note that tal:repeat also auto creates the following variables, which you can access from within your repeat block. <ul> <li>repeat.index - 1, 2, 3, etc.</li> <li>repeat.number - same as 'index'</li> <li>repeat.even - true if index is even</li> <li>repeat.odd - true is index is odd</li> <li>repeat.start - true if index == 1</li> <li>repeat.end - true if index is pointing to last item of your list</li> <li>repeat.inner - true if niether start nor end are true</li> </ul> <ul> <li>tal:content - replaces inner tag content with something else.</li></ul> <p tal:content="someStuff">I will be replaced</p> <ul><li>tal:replace - replaces the whole tag and all its contents with something else.</li></ul> <p tal:replace="someStuff">I will be replaced, including the p tag.</p> <ul><li> tal:attributes - to set tag attributes</li></ul> <a href="#" alt="desc" tal:attributes="href url.href; alt url.desc" tal:content="url.label">SomeLabel</a> <ul><li>tal:omit-tag - omits a tag (but not its contents) if the expression which is evaled is true.</li></ul> <em tal:omit-tag="false:important">I may be important.</em> Note that tal:omit-tag="" ALWAYS strips the tag. EXPRESSIONS ----------- *structure keyword* Prefixing an expression with the keyword `structure` will make it not escape HTML when replacing the output. This is handy when you are using variables which themselves return HTML.  <span tal:content="getSomeHTML()">replace me</span>  <span tal:content="structure getSomeHTML()">replace me</span> *template keyword* Same as structure, except the resulting expression is expected to be a template. Useful for importing template fragments and even building recursive templates such as sitemaps. <span tal:content="template getSomeTALTemplate()">replace me</span> *true:EXPRESSION* If EXPRESSION returns an array reference If this array reference has at least one element Returns TRUE Else Returns FALSE Else If EXPRESSION returns a TRUE value (according to Javascript 'trueness') Returns TRUE Else Returns FALSE the true: or false: modifiers should always be used when using the tal:condition statement. *false:EXPRESSION* I'm pretty sure you can work this one out by yourself :-) *string:STRING* The string: modifier lets you interpolate tal expressions within a string and returns the value. *IMPORTANT NOTE* string interpolation does not support asynchronous expressions which returns Promises. You can always get the async value in another variable using `tal:define` and then interpolate that. string:Welcome ${user.realName()}, it is ${myLocalTime()}! Writing your own modifiers is easy: tal.MODIFIERS.uppercase = function (expr, self, callback) { resolve(expr, context, function(error, arg) { if(error) { return callback(error) } if (typeof arg === 'string') { string = string.toUpperCase() } return callback(null,string) }) } Then in your template: <p tal:content="uppercase:database.getUser().name">hello</p> EXPORTS ------- tal.process(), tal.MODIFIERS BUGS ---- If you find any, please drop me an email - jhiver (at) gmail (dot) com. Patches are always welcome of course. SEE ALSO -------- This library is a port of the Perl package Petal::Tiny, which I also wrote. Jean-Michel Hiver - jhiver (at) gmail (dot) com This module free software and is distributed under the same license as node.jis itself (MIT license) Copyright (C) 2018 - Jean-Michel Hiver Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.