Guard to automatically compile Rails 3.1 assets
Go to file
Dmytrii Nagirniak 61345ee839 update README
2011-07-16 19:06:12 +10:00
lib/guard added specs, fix #3 2011-07-16 18:54:35 +10:00
spec added specs, fix #3 2011-07-16 18:54:35 +10:00
.gitignore initial commit with aprox specs 2011-06-17 20:32:50 +10:00
Gemfile added template and README 2011-06-17 23:23:04 +10:00
Gemfile.lock update Gemfile.lock 2011-07-08 13:32:50 +10:00
guard-rails-assets.gemspec initial commit with aprox specs 2011-06-17 20:32:50 +10:00
Rakefile initial commit with aprox specs 2011-06-17 20:32:50 +10:00
README.md update README 2011-07-16 19:06:12 +10:00

Guard::RailsAssets

Guard::RailsAssets compiles the assets in Rails 3.1 application automatically when files are modified.

Tested on MRI Ruby 1.9.2 (please report if it works on your platform).

If you have any questions please contact me @dnagir.

Install

Please be sure to have Guard installed.

Install the gem:

Add it to your Gemfile, preferably inside the test and development group:

gem 'guard-rails-assets'

Add guard definition to your Guardfile by running:

$ guard init rails-assets

Rails 3.1

The Rails 3.1 is a mandatory requirement, but is not enforeced via dependencies for now. The reason is that the assets are currently compiled via command line and thus this guard does not explicitly depend on Rails.

Good thing about it is that assets will always be same as produced by Rails. Bad thing is that it is pretty slow (~10 seconds) because it starts Rails from ground zero.

NOTE: The guard runs the rake assets:clean assets:precopile. As of current Rails 3.1 edge that means that the assets will be deleted before they are compiled.

Guardfile and Options

In addition to the standard configuration, this Guard has options to specify when exacly to precompile assets.

  • :start - compile assets when the guard starts (enabled by default)
  • :change - compile assets when watched files change (enabled by default)
  • :reload - compile assets when the guard quites (Ctrl-C) (not enabled by default)
  • :all - compile assets when running all the guards (Ctrl-/) (not enabled by default)

For example:

# compile ONLY when something changes
guard 'rails-assets', :run_on => :change do
  watch(%r{^app/assets/.+$})
end

# compile when something changes and when starting
guard 'rails-assets', :run_on => [:start, :change] do
  watch(%r{^app/assets/.+$})
end

# This is the default behaviour
guard 'rails-assets', :run_on => [:start, :change] do
  watch(%r{^app/assets/.+$})
end

Development

Pull requests are very welcome!

Licensed under WTFPL

            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
                    Version 2, December 2004

 Copyright (C) 2011 Dmytrii Nagirniak <dnagir@gmail.com>

 Everyone is permitted to copy and distribute verbatim or modified
 copies of this license document, and changing it is allowed as long
 as the name is changed.

            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  0. You just DO WHAT THE FUCK YOU WANT TO.