Sprockets-rails sets up your Rails application for use with Sprockets.
The first thing you need to do is install the Sprockets RubyGem. Just run;
gem install --remote sprockets
Sprockets-rails can be installed as a gem or as a plugin;
Installing as a gem
Add this to your
config.gem 'sprockets-rails', :source => 'http://gemcutter.org'
Once the gem is installed, run the generator and you’re all set;
The gem is now installed and the required files and folders will be generated into your project.
Installing as a plugin
Run this in the root of your Rails project;
script/plugin install git://github.com/80beans/sprockets-rails.git
The plugin will get installed and the required files and folders will be generated into your project.
Now you have sprockets-rails installed as a gem or a plugin. You now have
vendor/sprockets/ directories in your application, as well as a
config/routes.rb file to add routes for
ActionController::Routing::Routes.draw do |map| # Add the following line: SprocketsApplication.routes(map) ... end
The last thing you’ll have to do is adjust your HTML templates to call
<%= sprockets_include_tag %> instead of
sprockets-rails is installed, you can check out Sprockets plugins into the
vendor/sprockets/ directory. By default,
sprockets-rails configures Sprockets’ load path to search
vendor/sprockets/*/src/, as well as
Using multiple sprockets configurations in a project
config/sprockets.rb file to name the configurations:
Now, adjust your HTML templates to call
<%= sprockets_include_tag(:config_name) %> with the name of the configuration you wish to use. Concatenations are located at
RAILS_ROOT/sprockets/<config_name>.js, except for the default configuration, whose concatenation located at
How it works
Sprockets-rails includes a controller named
SprocketsController that renders your application’s Sprockets concatenation. When caching is enabled, e.g. in production mode,
SprocketsController uses Rails page caching to save the concatenated output to
public/sprockets.js the first time it is requested. When caching is disabled, e.g. in development mode,
SprocketsController will render a fresh concatenation any time a source file changes.
Sprockets-rails also includes a set of Rake tasks for generating the concatenation (
rake sprockets:install_script) and installing provided assets (
rake sprockets:install_assets). Run
sprockets:install_assets any time you add or update a Sprockets plugin in your application. Add
after "deploy:update_code", "sprockets:install_script" as a Capistrano post-deploy hook to generate the Sprockets concatenation on your servers automatically at deploy time.
Copyright © 2009 Sam Stephenson, released under the MIT license