Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/redding/deas-erubis
Deas template engine for rendering erb templates using Erubis
https://github.com/redding/deas-erubis
ruby template-engine
Last synced: about 9 hours ago
JSON representation
Deas template engine for rendering erb templates using Erubis
- Host: GitHub
- URL: https://github.com/redding/deas-erubis
- Owner: redding
- License: mit
- Created: 2014-11-19T23:31:29.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-05-21T02:26:46.000Z (over 5 years ago)
- Last Synced: 2024-04-25T19:22:07.492Z (6 months ago)
- Topics: ruby, template-engine
- Language: Ruby
- Size: 74.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Deas::Erubis
[Deas](https://github.com/redding/deas) template engine for rendering [Erubis](http://www.kuwata-lab.com/erubis/) templates
## Usage
Register the engine:
```ruby
require 'deas'
require 'deas-erubis'
Deas.configure do |c|
c.template_source "/path/to/templates" do |s|
s.engine 'erb', Deas::Erubis::TemplateEngine
end
end
```
Add `.erb` to any template files in your template source path. Deas will evaluate their content using Erubis when they are rendered.
### Partials
Deas::Erubis provides template helpers for rendering partial templates.
```erb
# in /path/to/templates/list.html.erb
<%= list.title %>
<% list.items.each do |item| %>
<%= partial '_list_item.html', :item => item %>
<% end %>
# in /path/to/templates/_list_item.html.erb
# output
My List
- Item 1
- Item 2
- Item 3
```
There are also helpers for rendering partials that yield to given content blocks (called "capture partials")
```erb
# in /path/to/templates/list.html.erb
<%= list.title %>
<% list.items.each do |item| %>
<% capture_partial '_list_item.html' do %>
<%= item.name %>
<% end %>
<% end %>
# in /path/to/templates/_list_item.html.erb
# output
# output
My List
-
Item 1
-
Item 2
-
Item 3
```
### Notes
The engine doesn't allow overriding the template scope but instead allows you to pass in data that binds to the template scope as local methods. By default, the view handler will be bound to the scope via the `view` method in templates. If you want to change this, provide a `'handler_local'` option when registering:
```ruby
c.template_source "/path/to/templates" do |s|
s.engine 'erb', Deas::Erubis::TemplateEngine, 'handler_local' => 'view_handler'
end
```
By default, `::Erubis::Eruby` is used to evaluate the templates. However, Erubis provides "enhancers" that add certain features. You can pass in any custom eruby class (with any enhancers you like) useing the `'eruby'` option when registering:
```ruby
c.template_source "/path/to/templates" do |s|
s.engine 'erb', Deas::Erubis::TemplateEngine, 'eruby' => MyEnhancedEruby
end
```
The engine doesn't cache templates by default - it opens the file from disk on each render. To enable caching (which stores the file contents in memory on first use), pass a `'cache'` option when registering:
```ruby
c.template_source "/path/to/templates" do |s|
s.engine 'erb', Deas::Erubis::TemplateEngine, 'cache' => true
end
```
If you wish to provide custom template helpers, organize them in module(s) and pass them with the `'helpers'` option when registering:
```ruby
c.template_source "/path/to/templates" do |s|
s.engine 'erb', Deas::Erubis::TemplateEngine, 'helpers' => [MyAwesomeHelpers, NotSoAwesomeHelpers]
end
```
## Installation
Add this line to your application's Gemfile:
gem 'deas-erubis'
And then execute:
$ bundle
Or install it yourself as:
$ gem install deas-erubis
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request