SlimGruntHelpers

This gem injects a set of helpers in Ruby global namespace (or not, depending on how you require the gem) which will help you when setting up a pipeline with Grunt and Slim template language.

Installation

Add this line to your application's Gemfile:

gem 'slim-grunt-helpers', '~> 0.0.4'

And then execute:

$ bundle

Or install it yourself as:

$ gem install slim-grunt-helpers

Usage

The easiest way is to just use bundler and so Bundle.require(:default), which will inject code in global namespace (notice that in any case every method is prefixed with sg_).
Otherwise, if you don't want to pollute your global namespace you can change your Gemfile configuration into:

gem 'slim-grunt-helpers', require: ['slim-grunt-helpers/helpers']

And you'll need to include SlimGruntHelpers::Helpers in some place to have methods available.

Available helpers

Right now, only a few helpers are available, I'll add others in future.

sg_enclose_newline

Takes a block as an argument, just encloses the block in \n#{ block }\n

sg_usemin_css / sg_usemin_js

These two methods behave in the same way. The purpose is to use them with the very helpful grunt-usemin plugin which however requires some new lines here and there which are boring to type directly in Slim. The usage is simple:

== sg_usemin_css('application.css', alt: '.tmp') do |usemin|
  - usemin << 'styles/bootstrap.css'
  - usemin.add 'styles/main.css', 'data-customattr' => 'customdata'
  - usemin.include 'styles/secondary.css', 'data-customattr' => 'customdata'

Note: You can either use <<, add or include, I prefer the first one but if you want use two params, the only way to do it is in this way:

- usemin.<<('param1', 'data-customattr' => 'customdata')

Which I consider quite horrible, so the method is aliased with add

Anyway!
The first argument is required, and it's the path :

<!-- build:<type>(alternate search path) <path> -->

The :alt argument is optional and it's the alternate search path.
The :absolute argument is optional and if true, it will append '/' in tags to file paths when printing html.
An object usemin will be yielded to the block which has only one method: <<.
This method requires first argument which is path to your css file (http path) and the second argument is a hash of options which are appended as attributes to the link tag. Notice that on link tag, rel="stylesheet" is automatically appended (and can be overwritten by specifying a rel key in options).
Additionally, notice that attributes with nil or false as value are not set (so you can remove rel), while those with true are set but without value and without ="".

usemin.require and usemin.require_tree

require allows to include files only if they are not already included. Uses same params as include.
require_tree instead, require an entire directory tree, using Dir glob pattern. It accepts the following parameters:

root_path which is the path will be used as base directory (and omitted in tags)
pattern which is the pattern accepted by Dir glob, used to search files
options which are directly passed to require

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request