My Bookshelf

# pug4j **Repository Path**: chatopera/pug4j ## Basic Information - **Project Name**: pug4j - **Description**: No description available - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-05-10 - **Last Updated**: 2024-04-26 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README [![Build Status](https://secure.travis-ci.org/neuland/pug4j.png?branch=master)](http://travis-ci.org/neuland/pug4j) # pug4j (formerly known as jade4j) - a jade implementation written in Java pug4j's intention is to be able to process pug templates in Java without the need of a JavaScript environment, while being **fully compatible** with the original pug syntax. ## Contents - [Example](#example) - [Syntax](#syntax) - [Usage](#usage) - [Simple static API](#simple-api) - [Full API](#api) - [Caching](#api-caching) - [Output Formatting](#api-output) - [Filters](#api-filters) - [Helpers](#api-helpers) - [Model Defaults](#api-model-defaults) - [Template Loader](#api-template-loader) - [Expressions](#expressions) - [Reserved Words](#reserved-words) - [Framework Integrations](#framework-integrations) - [Breaking Changes in 2.0.0](#breaking-changes-2) - [Breaking Changes in 1.0.0](#breaking-changes-1) - [Authors](#authors) - [License](#license) ## Example index.pug ``` doctype html html head title= pageName body ol#books for book in books if book.available li #{book.name} for #{book.price} € ``` Java model ```java List books = new ArrayList(); books.add(new Book("The Hitchhiker's Guide to the Galaxy", 5.70, true)); books.add(new Book("Life, the Universe and Everything", 5.60, false)); books.add(new Book("The Restaurant at the End of the Universe", 5.40, true)); Map model = new HashMap(); model.put("books", books); model.put("pageName", "My Bookshelf"); ``` Running the above code through `String html = Pug4J.render("./index.pug", model)` will result in the following output: ```html My Bookshelf

The Hitchhiker's Guide to the Galaxy for 5,70 €
The Restaurant at the End of the Universe for 5,40 €

``` ## Syntax We have put up an [interactive jade documentation](http://naltatis.github.com/jade-syntax-docs/). See also the original [visionmedia/jade documentation](https://github.com/visionmedia/jade#a6). ## Usage ### via Maven As of release 0.4.1, we have changed maven hosting to sonatype. Using Github Maven Repository is no longer required. Please be aware that we had to change the group id from 'de.neuland' to 'de.neuland-bfi' in order to meet sonatype conventions for group naming. Just add following dependency definitions to your `pom.xml`. ```xml de.neuland-bfi pug4j 2.0.0-alpha-3 ``` ### Build it yourself Clone this repository ... ```bash git clone https://github.com/neuland/pug4j.git ``` ... build it using `maven` ... ```bash cd pug4j mvn install ``` ... and use the `pug4j-2.x.x.jar` located in your target directory. ## Simple static API Parsing template and generating template in one step. ```java String html = Pug4J.render("./index.pug", model); ``` If you use this in production you would probably do the template parsing only once per template and call the render method with different models. ```java PugTemplate template = Pug4J.getTemplate("./index.pug"); String html = Pug4J.render(template, model); ``` Streaming output using a `java.io.Writer` ```java Pug4J.render(template, model, writer); ``` ## Full API If you need more control you can instantiate a `PugConfiguration` object. ```java PugConfiguration config = new PugConfiguration(); PugTemplate template = config.getTemplate("index"); Map model = new HashMap(); model.put("company", "neuland"); config.renderTemplate(template, model); ``` ### Caching The `PugConfiguration` handles template caching for you. If you request the same unmodified template twice you'll get the same instance and avoid unnecessary parsing. ```java PugTemplate t1 = config.getTemplate("index.pug"); PugTemplate t2 = config.getTemplate("index.pug"); t1.equals(t2) // true ``` You can clear the template and expression cache by calling the following: ```java config.clearCache(); ``` For development mode, you can also disable caching completely: ```java config.setCaching(false); ``` ### Output Formatting By default, Pug4J produces compressed HTML without unneeded whitespace. You can change this behaviour by enabling PrettyPrint: ```java config.setPrettyPrint(true); ``` Pug detects if it has to generate (X)HTML or XML code by your specified [doctype](https://github.com/pugjs/pug#syntax). If you are rendering partial templates that don't include a doctype pug4j generates HTML code. You can also set the `mode` manually: ``` config.setMode(Pug4J.Mode.HTML); // config.setMode(Pug4J.Mode.XHTML); // config.setMode(Pug4J.Mode.XML); // ``` ### Filters Filters allow embedding content like `markdown` or `coffeescript` into your pug template: script :coffeescript sayHello -> alert "hello world" will generate pug4j comes with a `plain` and `cdata` filter. `plain` takes your input to pass it directly through, `cdata` wraps your content in ``. You can add your custom filters to your configuration. config.setFilter("coffeescript", new CoffeeScriptFilter()); To implement your own filter, you have to implement the `Filter` Interface. If your filter doesn't use any data from the model you can inherit from the abstract `CachingFilter` and also get caching for free. See the [neuland/jade4j-coffeescript-filter](https://github.com/neuland/jade4j-coffeescript-filter) project as an example. ### Helpers If you need to call custom java functions the easiest way is to create helper classes and put an instance into the model. ```java public class MathHelper { public long round(double number) { return Math.round(number); } } ``` ```java model.put("math", new MathHelper()); ``` Note: Helpers don't have their own namespace, so you have to be careful not to overwrite them with other variables. ``` p= math.round(1.44) ``` ### Model Defaults If you are using multiple templates you might have the need for a set of default objects that are available in all templates. ```java Map defaults = new HashMap(); defaults.put("city", "Bremen"); defaults.put("country", "Germany"); defaults.put("url", new MyUrlHelper()); config.setSharedVariables(defaults); ``` ### Template Loader By default, pug4j searches for template files in your work directory. By specifying your own `FileTemplateLoader`, you can alter that behavior. You can also implement the `TemplateLoader` interface to create your own. ```java TemplateLoader loader = new FileTemplateLoader("/templates/", "UTF-8"); config.setTemplateLoader(loader); ``` ## Expressions The original pug implementation uses JavaScript for expression handling in `if`, `unless`, `for`, `case` commands, like this - var book = {"price": 4.99, "title": "The Book"} if book.price < 5.50 && !book.soldOut p.sale special offer: #{book.title} each author in ["artur", "stefan", "michael"] h2= author As of version 0.3.0, jade4j uses [JEXL](http://commons.apache.org/jexl/) instead of [OGNL](http://en.wikipedia.org/wiki/OGNL) for parsing and executing these expressions. As of version 2.0.0, pug4j uses JEXL3 We decided to switch to JEXL because its syntax and behavior is more similar to ECMAScript/JavaScript and so closer to the original pug.js implementation. JEXL runs also much faster than OGNL. In our benchmark, it showed a **performance increase by factor 3 to 4**. We are using a slightly modified JEXL version which to have better control of the exception handling. JEXL now runs in a semi-strict mode, where non existing values and properties silently evaluate to `null`/`false` where as invalid method calls lead to a `PugCompilerException`. ## Reserved Words JEXL comes with the three builtin functions `new`, `size` and `empty`. For properties with this name the `.` notation does not work, but you can access them with `[]`. ``` - var book = {size: 540} book.size // does not work book["size"] // works ``` You can read more about this in the [JEXL documentation](http://commons.apache.org/proper/commons-jexl/reference/syntax.html#Language_Elements). ## Framework Integrations - [neuland/spring-pug4j](https://github.com/neuland/spring-pug4j) pug4j spring integration. - [jooby-jade](https://github.com/jooby-project/jooby/tree/master/jooby-jade) jade4j for [Jooby](http://jooby.org). - [vertx-web](http://vertx.io/docs/vertx-web/js/#_jade_template_engine) jade4j for [Vert.X](http://vertx.io/) ## Breaking Changes in 2.0.0 - Classes are renamed to pug4j. - Default file extension is now .pug - Compiler Level has been raised to Java 8+ - Syntax has been adapted to the most current pug version. (2.0.4) ### Breaking Changes in 1.3.1 - Fixed a mayor scoping bug in loops. Use this version and not 1.3.0 ### Breaking Changes in 1.3.0 - setBasePath has been removed from JadeConfiguration. Set folderPath on FileTemplateLoader instead. - Scoping of variables in loops changed, so its more in line with jade. This could break your template. ### Breaking Changes in 1.2.0 - Breaking change in filter interface: if you use filters outside of the project, they need to be adapted to new interface ### Breaking Changes in 1.0.0 In Version 1.0.0 we added a lot of features of JadeJs 1.11. There are also some Breaking Changes: - Instead of 'id = 5' you must use '- var id = 5' - Instead of 'h1(attributes, class = "test")' you must use 'h1(class= "test")&attributes(attributes)' - Instead of '!!! 5' you must use 'doctype html' - Jade Syntax for Conditional Comments is not supported anymore - Thanks to rzara for contributing to issue-108 ## Authors - Artur Tomas / [atomiccoder](https://github.com/atomiccoder) - Stefan Kuper / [planetk](https://github.com/planetk) - Michael Geers / [naltatis](https://github.com/naltatis) - Christoph Blömer / [chbloemer](https://github.com/chbloemer) Special thanks to [TJ Holowaychuk](https://github.com/visionmedia) the creator of jade! ## License The MIT License Copyright (C) 2011-2020 [neuland Büro für Informatik](http://www.neuland-bfi.de/), Bremen, Germany 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.