https://github.com/combinaut/minibars
A (mostly) drop-in replacement for Handlebars.rb based on MiniRacer rather than therubyracer.
https://github.com/combinaut/minibars
handlebars miniracer rails ruby therubyracer
Last synced: 7 months ago
JSON representation
A (mostly) drop-in replacement for Handlebars.rb based on MiniRacer rather than therubyracer.
- Host: GitHub
- URL: https://github.com/combinaut/minibars
- Owner: combinaut
- License: mit
- Created: 2021-11-29T19:18:20.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-05T17:39:18.000Z (about 2 years ago)
- Last Synced: 2025-09-06T20:04:44.678Z (8 months ago)
- Topics: handlebars, miniracer, rails, ruby, therubyracer
- Language: Ruby
- Homepage:
- Size: 72.3 KB
- Stars: 8
- Watchers: 7
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Minibars
A (mostly) drop-in replacement for [Handlebars.rb][3] based on [MiniRacer][1] rather than [therubyracer][2].
An appropriately revised quote from the [Handlebars.rb][3] README:
> This uses ~~therubyracer~~[MiniRacer][1] to bind to the _actual_ JavaScript implementation of [Handlebars.js](https://github.com/handlebars-lang/handlebars.js) so that you can use it from ruby.
# Why?
Minibars is a stripped down implementation of [Handlerbars.rb][3] using [MiniRacer][1]. It eschews capabilities that require two-way binding with the JS runtime, making it a good choice for those with simple Handlebars templates who need an upgrade path for their ARM64 architecture.
# Usage
## Simple Stuff
```ruby
require 'minibars'
minibars = Minibars::Context.new
template = minibars.compile("{{say}} {{what}}")
template.call(say: "Hey", what: "Yuh!") #=> "Hey Yuh!"
```
## Functions as Properties
This feature differs from [Handlebars.rb][3] since Minibars templates won't pass a `this` argument to property functions.
```ruby
template.call(say: "Hey ", what: ->{ ("yo" * 2) + "!"}) #=> "Hey yoyo!"
```
## Helpers
JavaScript helpers can be loaded as individual files or as a glob
```ruby
minibars.load_helpers("#{__dir__}/javascripts/helpers/**/*.js")
minibars.load_helper("#{__dir__}/javascripts/helpers/admin.js")
```
## Partials
You can directly register partials
```ruby
minibars.register_partial("whoami", "I am {{who}}")
minibars.compile("{{>whoami}}").call(who: 'Legend') #=> I am Legend
```
## SafeStrings
By default, handlebars will escape strings that are returned by your block helpers. To mark a string as safe:
```ruby
template = minibars.compile("{{safe}}")
template.call(safe: Minibars::SafeString.new("
Totally Safe!"))
```
## Compatibility
`Handlebars::Context` aliases `Minibars::Context` and `Handlebars::SafeString` aliases `Minibars::SafeString` unless they are already defined.
```ruby
require 'handlebars` # Applies the compatibility layer found in lib/handlebars.rb and loads minibars
```
## Limitations
- No Ruby helpers
## Security
In general, you should not trust user-provided templates: a template can call any method (with no arguments) or access any property on any object in the `Minibars::Context`.
If you'd like to render user-provided templates, you'd want to make sure you do so in a sanitized Context, e.g. no filesystem access, read-only or no database access, etc.
[1]: https://github.com/rubyjs/mini_racer
[2]: https://github.com/rubyjs/therubyracer
[3]: https://github.com/cowboyd/handlebars.rb