mirror of
https://github.com/haml/haml.git
synced 2022-11-09 12:33:31 -05:00
87 lines
3.1 KiB
Markdown
87 lines
3.1 KiB
Markdown
# Hamlit
|
|
|
|
[](http://badge.fury.io/rb/hamlit)
|
|
[](https://travis-ci.org/k0kubun/hamlit)
|
|
[](https://coveralls.io/r/k0kubun/hamlit?branch=master)
|
|
[](https://codeclimate.com/github/k0kubun/hamlit)
|
|
|
|
Hamlit is a high performance [haml](https://github.com/haml/haml) implementation.
|
|
|
|
## Installation
|
|
|
|
Add this line to your application's Gemfile:
|
|
|
|
```ruby
|
|
gem 'hamlit'
|
|
```
|
|
|
|
or just replace `gem "haml"` with `gem "hamlit"`.
|
|
|
|
## Features
|
|
### Fast rendering
|
|
|
|
|
|
|
|
Hamlit's rendering is **7.16x times faster** than original haml.
|
|
|
|
```
|
|
erubis: 114501.6 i/s
|
|
hamlit: 112888.1 i/s - 1.01x slower
|
|
slim: 103298.5 i/s - 1.11x slower
|
|
faml: 88675.4 i/s - 1.29x slower
|
|
haml: 15750.6 i/s - 7.27x slower
|
|
```
|
|
|
|
[This benchmark](https://github.com/k0kubun/hamlit/blob/4e5655c4ba1d51c85b4551c3b22baa6d7780d208/benchmarks/benchmark.rb)
|
|
is the same as [slim-template/slim](https://github.com/slim-template/slim)'s one for fairness.
|
|
([The result on travis CI](https://travis-ci.org/k0kubun/hamlit/jobs/58162910))
|
|
|
|
### Better parser
|
|
|
|
Haml's attribute parser is not so good. For example, raises syntax error for `%a{ b: '}' }`.
|
|
Hamlit's attribute parser is implemented with Ripper, which is an official lexer for Ruby,
|
|
so it is able to parse such an attribute.
|
|
|
|
### Passing haml-spec
|
|
|
|
[haml/haml-spec](https://github.com/haml/haml-spec) is a basic suite of tests for Haml interpreters.
|
|
For all test cases in haml-spec, Hamlit behaves the same as Haml (ugly and escape\_html mode only, which is used on production).
|
|
|
|
Hamlit is used on [githubranking.com](http://githubranking.com/).
|
|
|
|
## Usage
|
|
|
|
Basically the same as [haml](https://github.com/haml/haml).
|
|
Check out the [reference documentation](http://haml.info/docs/yardoc/file.REFERENCE.html) for details.
|
|
|
|
### Rails
|
|
Just update Gemfile.
|
|
|
|
### Sinatra
|
|
Update Gemfile. Html escaping is enabled by default.
|
|
If you want to disable it, add following code.
|
|
|
|
```rb
|
|
set :haml, { escape_html: false }
|
|
```
|
|
|
|
## Why high performance?
|
|
### Less work on runtime
|
|
Haml's rendering is very slow because generated code by haml runs many operations on runtime.
|
|
For example, Haml::Util is extended on view, attribute rendering runs even if it is a
|
|
static value and the values in attribute is sorted. All of them is achieved on runtime.
|
|
|
|
Hamlit extends ActionView beforehand, attribute rendering is done when compiled if it
|
|
is a static hash and no unnecessary operation is done on runtime.
|
|
|
|
### Temple optimizers
|
|
Hamlit is implemented with [temple](https://github.com/judofyr/temple), which is a template
|
|
engine framework for Ruby. Temple has some great optimizers for generated code. Thus generated
|
|
code by Hamlit is very fast.
|
|
|
|
Not only relying on temple optimizers, but also Hamlit's compiler cares about many cases
|
|
to optimize performance such as string interpolation.
|
|
|
|
## License
|
|
|
|
MIT License
|