https://github.com/DannyBen/erbx
ERB Extended with Pretty Tags
https://github.com/DannyBen/erbx
erb ruby template-language
Last synced: 8 months ago
JSON representation
ERB Extended with Pretty Tags
- Host: GitHub
- URL: https://github.com/DannyBen/erbx
- Owner: DannyBen
- License: mit
- Created: 2020-04-24T15:11:57.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-08-01T15:28:17.000Z (10 months ago)
- Last Synced: 2025-10-07T16:56:42.339Z (8 months ago)
- Topics: erb, ruby, template-language
- Language: Ruby
- Size: 18.6 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ERBX - ERB Extended with Pretty Tags
ERBX is a tiny extension to ERB allowing these tags:
- `{{ ... }}` as an equivalent to `<%= ... %>` (print ruby code)
- `(( ... ))` as an equivalent to `<%- ... -%>` (run ruby code)
Both tag pairs are configurable.
---
## Installation
```
$ gem install erbx
```
## Usage
Given this ERBX templalte:
```
# example/template.md
((
# Any ruby code can go here
today = Time.now.strftime "%B %d, %Y"
dice = [rand(6) + 1, rand(6) + 1]
))
This roll of a dice happened on {{ today }}.
(( if dice[0] == dice[1] ))
Congratulations, its a double: {{ dice }}
(( else ))
You rolled {{ dice }}
(( end ))
```
Render it with `ERBX.new`, which returns an `ERB` instance, after replacing
the extended tags - `{{ }}` and `(( ))` - with their `ERB` equivalents.
```ruby
# Render example
require 'erbx'
template = ERBX.load 'example/template.md'
p template.class
#=> ERB
puts template.result
#=>
#=> This roll of a dice happened on April 24, 2020.
#=> You rolled [4, 2]
```
## Custom Tags
If you wish to use different tags in your template, you can provide them using
these four options:
- `code_open` - default `((`
- `code_close` - default `))`
- `output_open` - default `{{`
- `output_close` - default `}}`
For example:
```ruby
# Render example with options
require 'erbx'
template = ERBX.load 'example/template2.md', code_open: '===[', code_close: ']==='
puts template.result_with_hash number: rand(100..999)
#=> This template only uses output tags, and uses data provided by the caller.
#=> This is useful when the file may contain (( markers like these )) that are
#=> not intended to be interpreted as code.
#=>
#=> Random number: 938
```
## Contributing / Support
If you experience any issue, have a question or a suggestion, or if you wish
to contribute, feel free to [open an issue][issues].
---
[issues]: https://github.com/DannyBen/erbx/issues