| commit | 5724cfd85151e5b6b53ddcd3380daf188fe47f92 | [log] [tgz] |
|---|---|---|
| author | Georgios Valotasios <valotas@gmail.com> | Sun Mar 15 16:45:50 2015 |
| committer | Georgios Valotasios <valotas@gmail.com> | Sun Mar 15 16:45:50 2015 |
| tree | 26e3588990210f92b80978bee3a856a6456723c6 | |
| parent | 3febdf50c4bfe7ca2bfdabaf16e1275226ee2055 [diff] |
Version 1.0.10
A simple implementation of Mustache for the Dart language, which passes happily all the mustache specs. If you want to have a look at how it works, just check the tests. For more info, just read further.
In order to use the library, just add it to your pubspec.yaml as a dependency
dependencies: mustache4dart: '>= 1.0.0 < 2.0.0'
and then import the package
import 'package:mustache4dart/mustache4dart.dart';
and you are good to go. You can use the render toplevel function to render your template. For example:
var salutation = render('Hello {{name}}!', {'name': 'Bob'}); print(salutation); //shoud print Hello Bob!
mustache4dart will look at your given object for operators, fields or methods. For example, if you give the template {{firstname}} for rendering, mustache4dart will try the followings
[] operator with firstname as the parameterfirstnamefirstnamefirstnamegetFirstnamein each case the first valid value will be used.
In order to do the stuff described above the mirror library is being used which could lead to big js files when compiling the library with dartjs. The implementation does use the @MirrorsUsed annotation but as documented this is experimental.
In order to avoid the use of the mirrors package, make sure that you compile your library with dart2js -DMIRRORS=false . In that case though you must always make sure that your context object have a right implementation of the [] operator as it will be the only check made against them (from the ones described above) in order to define a value.
mustache4dart support partials but it needs somehow to know how to find a partial. You can do that by providing a function that returns a template given a name:
String partialProvider(String partialName) => "this is the partial with name: ${partialName}"; expect(render('[{{>p}}]', null, partial: partialProvider), '[this is the partial with name: p]'));
If you have a template that you are going to reuse with different contextes you can compile it to a function using the toplevel function compile:
var salut = compile('Hello {{name}}!'); print(salut({'name': 'Alice'})); //should print Hello Alice!
The library passes all the optional lambda specs based on which lambdas must be treatable as arity 0 or 1 functions. As dart provides optional named parameters, you can pass to a given lambda function the nestedContext. In that case the current nested context will be given as parameter to the lambda function.
The project passes all the Mustache specs. You have to make sure though that you've downloaded them. Just make sure that you have done the steps described below.
git clone git://github.com/valotas/mustache4dart.git git submodule init git submodule update pub install
If you are with Linux, a script is provided to run all the test:
test/run.sh
Alternatively, if you have Dart Test Runner installed you can just do
pub global run test_runner
If you found a bug, just create a new issue or even better fork and issue a pull request with you fix.
The library will follow a semantic versioning