Project

erbx

0.01
No release in over a year
Extended ERB with prettier tags
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

ERBX - ERB Extended with Pretty Tags

Gem Version Build Status


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.

# 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:

# 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.