Parsley is a template parser for WO. It's based on WOOgnl and thus supports it's inline binding syntax. It's a pure WO project, meaning it does not require Project Wonder (although, of course, it works fine with Project Wonder as well).
Note that If you're using wonder-slim you don't have to do do anything to add or enable Parsley. It's already there.
Parsley releases are deployed to the WOCommunity maven repository, so if you've got your environment set up for WO development just add this dependency to your pom.
<dependency>
<groupId>is.rebbi.parsley</groupId>
<artifactId>parsley</artifactId>
<version>1.6.0</version>
</dependency>
Parsley is not enabled by default so to use it as your app's default template parser, you'll have to activate it somewhere during your application's initialization. For example in your Application's constructor:
public Application() {
parsley.Parsley.configure()
.inlineErrors( isDevelopmentModeSafe() ) // Inline error reporting, usually only in dev mode
.controls( isDevelopmentModeSafe() ) // The in-page Parsley dev controls strip
.register();
}
configure() returns a builder that amends the current configuration, so the framework can register Parsley once and an app can add to that registration later without losing it (e.g. Parsley.configure().elementFactory( "html", new MyHTMLElementFactory() ).register();). The builder supports:
parsley.Parsley.configure()
.associationFactory( new MyAssociationFactory() ) // a custom association factory
.elementFactory( "html", new MyHTMLElementFactory() ) // an element factory for a namespace (the "wo" namespace is always present)
.inlineErrors( isDevelopmentModeSafe() ) // inline display of template/binding errors
.controls( isDevelopmentModeSafe() ) // the in-page Parsley dev controls strip
.excludeFromWrapping( SomeElement.class ) // exclude an element from proxy wrapping (by class)
.excludeFromWrapping( "SomeElementName" ) // …or by simple class name
.register();
For convenience, ParsleyConfiguration.defaultDevConfiguration() and defaultProductionConfiguration() provide ready-made builders to start from — development mode turns on inline errors and the controls strip, production turns everything off.
OGNL expression support (using the ~ prefix in binding values) is provided by the optional parsley-ognl plugin. Add its dependency to your pom:
<dependency>
<groupId>is.rebbi.parsley</groupId>
<artifactId>parsley-ognl</artifactId>
<version>1.6.0</version>
</dependency>
Then register Parsley with the plugin's association factory:
parsley.Parsley.configure()
.associationFactory( new parsley.ognl.ParsleyOgnlAssociationFactory() )
.register();
The OGNL factory falls back to the default association factory for any binding that isn't an OGNL expression, so all the usual binding syntax keeps working.
A tag in a template is resolved to an element through an alias map — a flat map of alias → target. This serves two purposes that are really the same operation:
str → WOString, if → ERXWOConditional.WOString → ERXWOString (the kind of swap ERExtensions does at runtime).Because both are just name-to-name aliases, resolution is recursive: str follows str → WOString → ERXWOString to its final target, so a shortcut and a replacement compose automatically.
Aliases are declared in parsley-tag-aliases.properties resources. Parsley ships its own built-in shortcuts this way, and a framework or app contributes its own simply by dropping a parsley-tag-aliases.properties file into its src/main/resources. Every copy of the file on the classpath is loaded — each entry is alias = target:
# An app or framework's parsley-tag-aliases.properties
WOString = ERXWOString
myWidget = com.example.MyWidgetElement
If the same alias is mapped to different targets by different files, the first registration stands and the conflicting one is ignored with a warning (classpath order isn't reliable, so Parsley doesn't silently pick a winner).
To get nice inline error messages when template parser errors occur (rather than huge stack-tracey exception pages). Currently, this only applies when you attempt to use an element/component that doesn't exist and for handling UnknownKeyEception (badly formed keypaths in bindings) and WODynamicElementCreationException which for well designed elements will cover things like wrong binding configuration.
Actually, this isn't the real "why" of the project. But it's currently the nicest byproduct visible to the user, making for a good cover story.
parsley-ognl module (see below).parseStandardTags behaviour.<wo:not> being an example use). Never used them but the idea isn't that bad. However functionality of that kind needs a little work in the parser.$true and $false will get interpreted as booleans (these were case insensitive in WOOgnl).str → WOString) live in a parsley-tag-aliases.properties resource, and any framework or app can contribute its own — including element-class replacements like WOString → ERXWOString — by dropping the same-named file into its src/main/resources. Aliases resolve recursively, so a shortcut and a replacement compose automatically (str → WOString → ERXWOString). See Tag aliases.Parsley.configure().….register() — replacing the old Parsley.register() / Parsley.showInlineRenderingErrors(…) / Parsley.registerElementFactory(…) calls. The builder amends the current configuration, so a framework can register Parsley once and an app can add to that registration later. ParsleyConfiguration.defaultDevConfiguration() / defaultProductionConfiguration() provide ready-made starting points..excludeFromWrapping(…)..controls(true)) — a small expanding control in the bottom-left corner for toggling Parsley's dev features at runtime.ParsleyTemplateParser class; Parsley is now purely the library's entry point and configuration.WOComponentReference is now wrapped in ParsleyProxyElement, so source-location reporting also covers nested component references.<wo:str value="yeah" value="wat" />. Previous versions (and WOOgnl) silently ignored duplicate bindings and just used the last declared binding value.parsley-ognl to 3.4.11is.rebbi to is.rebbi.parsleyParsley.register(factory)Parsley.registerElementFactory(namespace, factory)parsley-ognl module providing optional OGNL expression support (prefix ~ in binding values)ng-template-parser dependency. The parser has been completely rewritten as a single-pass recursive descent parser, replacing the old 3-stage pipeline (NGStringTokenizer → NGHTMLParser → callback → NGTemplateParser). New parser features (via ng-template-parser):
<p:raw>...</p:raw> directive — Wraps content that should be passed through verbatim without any template processing. Supports nesting. Useful for wrapping <script> blocks or any content that might contain characters that could confuse the parser.<p:comment>...</p:comment> directive — Developer comments that are stripped entirely from rendered output. Also supports nesting. Unlike HTML comments, these are guaranteed to produce nothing in the output.wo: (and webobject). The new parser accepts a configurable set of namespace names. Tags with unrecognized namespaces (e.g. svg:rect, xsl:template) pass through as plain HTML.<wo:Widget disabled />. The old parser required every binding to have a value./>).<wo: Repetition> (space after colon) and </ wo:Conditional> (space after </) with specific error messages, rather than silently misbehaving.<!-- --> comments flow through as plain HTML content rather than being tracked by the parser. Use <p:comment> for comments you want stripped from output.