Copyright (c) 2006 Michael Fellinger [email protected]
All files in this distribution are subject to the terms of the Ruby license.
About Nagoro
Nagoro is a templating engine for XHTML based on different parsing engines. It featues a modular code layout and is used in the Ramaze web framework.
Nagoro consists of a series of so-called pipes to produce valid ruby from the templates that are eventually evaluated with custom binding.
All functionality of Nagoro is carefully tested by a series of specs to avoid breakage and give a good overview of nagoros capabilities.
Features Overview
- Pipes
Pipes are pluggable subclasses of Nagoro::Pipe::Base
or respond to ::process
and the returned value should provide a #to_html
method.
Element
Elements are tags that correspond to classes.
Include
Transforms
<include href="file" />
tags, file is passed toKernel::open
and so you can even include remote locations if yourequire 'open-uri'
Instruction
Instructions have a syntax of
<?name instruction?>
, most common is<?r code ?>
to evaluate ruby code without outputting it.Localization
Not based on Pipe::Base, processes the template by a regular expression and substitutes keys with localized strings.
Morph
Custom tag parameters like
<div if="cond">condition is fulfilled</div>
- Nagoro::Scanner
A hand-rolled SaX style parser for templates using StringScanner. StringScanner is a part of Ruby standard library that provides lexical scanning operations on a String. It is mostly implemented in C, which makes it quite fast and efficient. Our implementation is not a strict XML/SGML parser and allows for arbitrary code inside the templates.
Installation
- Rubygems
The easiest way of installing Nagoro is by:
$ gem install nagoro
Make sure you have the necessary privileges to execute the command. Rubygems can be found at http://rubygems.org
- Git
To get the latest version of nagoro, you can just pull from the repository and use it this way.
$ git clone git://github.com/manveru/nagoro
Please read the man darcs
or darcs help
for more information about
updating and creating your own patches.
This is usually only needed for developers as the implementation of nagoro is
not rapidly changing and releases are made after every major change.
Some hints for the usage of the git repo
Use
require 'nagoro'
from anywhereAdd a file to your
site_ruby
namednagoro.rb
the content should be:require '/path/to/git/repo/nagoro/lib/nagoro'
Get the latest version (from inside the nagoro directory)
$ git pull
Recording a patch
$ git commit -a
output your patches into a bundle ready to be mailed (compress it before sending to make sure it arrives in the way you sent it)
$ git format-patch origin/HEAD $ tar -cjf ramaze_bundle.tar.bz2 *.patch
Getting started
See the installation section for how to install nagoro. After installation you can use nagoro in a couple of ways
CLI
From commandline using the nagoro
executable.
$ nagoro yourfile.xhtml
In Ruby
Compiling a template
Template compilation is useful if you have templates that have contents that
will not change for some time, it will only run it through the pipes once and
do an eval on the compiled string every time you call the Template#result
or
Template#tidy_result
methods on the returned Template instance.
template = Nagoro.compile('<?r a = 42 ?>#{a * 42}')
puts template.result
puts '', 'And now tidy', ''
puts template.tidy_result
Rendering a template
This is handy for one-off scripts that just want to render without caring about the compilation step.
result = Nagoro.render('<?r a = 42 ?>#{a * 42}')
puts result
You may also use the equivalent of the Template#tidy_result
for rendering, that is done just as easily.
result = Nagoro.tidy_render('<?r a = 42 ?>#{a * 42}')
puts result
Using a path instead of a String
Nagoro will try to find a file matching your argument. It's not very smart about this functionality and will only try to determine whether your argument exists on the filesystem if the string is smaller than 1024 characters, that's mostly done for performance reasons.
template = Nagoro.compile('yourfile.nag')
puts template.result
And of course the same works for Nagoro::render
.
puts Nagoro.render('yourfile.nag')
Examples
Examples can be found in the /example directory.
And thanks to...
This list is by no means a full listing of all these people, but I try to get a good coverage despite that.
- Yukihiro Matsumoto a.k.a. matz
For giving the world Ruby and bringing joy and passion back into programming.
- Jim Weirich
For Rake, which lifts off a lot of tasks from the shoulders of every developer using it.
- George Moschovitis a.k.a. gmosx
For the Nitro web framework. Its templating engine has been the inspiration for nagoro.
- Jonathan Buch a.k.a. Kashia
For the first implementation of the Localization mechanism which is mostly ported from Ramaze.
- Minero Aoki
For his excellent StringScanner that works behind the scene, I've used it countless times and was always impressed by the way it makes even the most complex parsing seem trivial. Having it in the Ruby standard library and on all platforms is a significant bonus as well.