Handlebars Helpers

Handlebars Helpers is a library that provides 44 handlebars helpers across 7 categories, it was built to complement cowboyd/handlebars.rb with Ruby helpers commonly found in the Javascript community

This GEM is inspired by the Javascript Library handlebars-helpers.

I am following a lot of the categories found there, but this GEM is not a one for one match to the existing JS library as I feel it is a bit dated and could use some new helpers and categories may be relevant today.

Installation

Add this line to your application's Gemfile:

gem 'handlebars-helpers'

And then execute:

bundle install

Or install it yourself as:

gem install handlebars-helpers

Stories

Main Story

As a Ruby Developer, I want to use HandlebarsJS with useful helpers, so that I have a rich templating experience

See all stories

Usage

See all usage examples

Basic Example

Basic example

Render a template value using camel case and dasherize case

Handlebars::Helpers::Template.render('{{camel .}}', 'david was here') # => "DavidWasHere"

Handlebars::Helpers::Template.render('{{dasherize .}}', 'david was here') # => "david-was-here"

Development

Checkout the repo

git clone klueless-io/handlebars-helpers

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests.

You can also run bin/console for an interactive prompt that will allow you to experiment.

bin/console

Handlebars::Helpers::Template.render('{{camel .}}', 'david was here')
# => "DavidWasHere"
Handlebars::Helpers::Template.render('{{dasherize .}}', 'david was here')
# => "david-was-here"

handlebars-helpers is setup with Guard, run guard, this will watch development file changes and run tests automatically, if successful, it will then run rubocop for style quality.

To release a new version, update the version number in version.rb, build the gem and push the .gem file to rubygems.org.

gem build
gem push rspec-usecases-?.?.??.gem
# or push the latest gem
ls *.gem | sort -r | head -1 | xargs gem push

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/klueless-io/handlebars-helpers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Handlebars Helpers project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Copyright

Copyright (c) David Cruwys. See MIT License for further details.