README.md
### <i color="red">WARNING :</i> [This repo is not maintained anymore!](https://github.com/rstacruz/sinatra-assetpack/issues/197)
See sprocket-based alternatives like [sinatra-asset-pipeline](https://github.com/kalasjocke/sinatra-asset-pipeline) and [sprockets-helpers](https://github.com/petebrowne/sprockets-helpers).
# [Sinatra AssetPack](http://ricostacruz.com/sinatra-assetpack)
> The most convenient way to manage your assets in Sinatra.
[](https://travis-ci.org/rstacruz/sinatra-assetpack)
[](http://rubygems.org/gems/sinatra-assetpack)
[](https://gemnasium.com/rstacruz/sinatra-assetpack)
[](https://codeclimate.com/github/rstacruz/sinatra-assetpack)
## Installation
``` ruby
# Gemfile
gem 'sinatra-assetpack', :require => 'sinatra/assetpack'
```
## Setup
Register the extension and set your assets configuration.
``` ruby
require 'sinatra/base'
require 'sinatra/assetpack'
class App < Sinatra::Base
set :root, File.dirname(__FILE__) # You must set app root
register Sinatra::AssetPack
assets {
serve '/js', from: 'app/js' # Default
serve '/css', from: 'app/css' # Default
serve '/images', from: 'app/images' # Default
# The second parameter defines where the compressed version will be served.
# (Note: that parameter is optional, AssetPack will figure it out.)
# The final parameter is an array of glob patterns defining the contents
# of the package (as matched on the public URIs, not the filesystem)
js :app, '/js/app.js', [
'/js/vendor/**/*.js',
'/js/lib/**/*.js'
]
css :application, '/css/application.css', [
'/css/screen.css'
]
js_compression :jsmin # :jsmin | :yui | :closure | :uglify
css_compression :simple # :simple | :sass | :yui | :sqwish
}
end
```
## Usage
1. Drop your assets into `/app/css`, `/app/js`, `/app/images`.
2. Add `register Sinatra::AssetPack` (see setup options).
3. Use `<%= js :app %>` and `<%= css :application %>` in your layout.
4. You now have proper assets management!
#### Using in layouts
In your layouts, use the `css` and `js` helpers:
``` erb
# layout.erb
<%= css :application, :media => 'screen' %>
<%= js :app %>
```
```
# layout.haml
!= css :application, :media => 'screen'
!= js :app
```
## Results
#### Development mode
If you're on **development** mode, it serves each of the files as so:
``` html
<link rel='stylesheet' href='/css/screen.849289.css' media='screen' type='text/css' />
<script type='text/javascript' src='/js/vendor/jquery.283479.js'></script>
<script type='text/javascript' src='/js/vendor/underscore.589491.js'></script>
<script type='text/javascript' src='/js/app/main.589491.js'></script>
```
#### Production mode
If you're on **production** mode, it serves a compressed version in the URLs you specify:
``` html
<link rel='stylesheet' href='/css/application.849289.css' media='screen' type='text/css' />
<script type='text/javascript' src='/js/app.589491.js'></script>
```
## Features
* __CoffeeScript support__ Just add your coffee files in one of the paths
served (in the example, `app/js/hello.coffee`) and they will be available as JS
files (`http://localhost:4567/js/hello.js`).
* __Sass/Less/SCSS support__ Works the same way. Place your dynamic CSS files
in there (say, `app/css/screen.sass`) and they will be available as CSS files
(`http://localhost:4567/css/screen.css`).
* __Cache busting__ the `css` and `js` helpers automatically ensures the URL
is based on when the file was last modified. The URL `/js/jquery.js` may be
translated to `/js/jquery.8237898.js` to ensure visitors always get the latest
version.
* __Images support__ Image filenames in your CSS will automatically get a
cache-busting suffix (eg, `/images/icon.742958.png`).
* __Embedded images support__ You can embed images in your CSS files as
`data:` URIs by simply adding `?embed` to the end of your URL.
* __No intermediate files needed__ You don't need to generate compiled files.
You can, but it's optional. Keeps your source repo clean!
* __Auto minification (with caching)__ JS and CSS files will be compressed as
needed.
* __Heroku support__ Oh yes. That's right.
## Compressors
By default, AssetPack uses [JSMin](http://rubygems.org/gems/jsmin) for JS
compression, and simple regexes for CSS compression. You can specify other
compressors in the `assets` block:
``` ruby
assets {
js_compression :jsmin # :jsmin | :yui | :closure | :uglify
css_compression :simple # :simple | :sass | :yui | :sqwish
}
```
### YUI Compressor
This uses Yahoo's Java-powered YUI compressor.
``` ruby
assets {
js_compression :yui
js_compression :yui, :munge => true # Munge variable names
css_compression :yui
}
```
__Note:__ This depends on the `yui-compressor` gem :
``` ruby
# Gemfile
gem 'yui-compressor', :require => 'yui/compressor'
```
### SASS compression
This treats the CSS files as Scss files and uses Sass's `:output => :compressed`.
``` ruby
assets {
css_compression :sass
}
```
__Note:__ This depends on the `sass` gem :
``` ruby
# Gemfile
gem 'sass'
```
### Sqwish CSS compression
[Sqwish](http://github.com/ded/sqwish) is a NodeJS-based CSS compressor. To use
Sqwish with AssetPack, install it using `npm install -g sqwish`. You need NodeJS
and NPM installed.
``` ruby
assets {
css_compression :sqwish
css_compression :sqwish, :strict => true
}
```
### Google Closure compression
This uses the [Google closure compiler
service](http://closure-compiler.appspot.com/home)
to compress your JavaScript. Available levels are:
* `WHITESPACE_ONLY`
* `SIMPLE_OPTIMIZATIONS`
* `ADVANCED_OPTIMIZATIONS`
``` ruby
assets {
js_compression :closure
js_compression :closure, :level => "SIMPLE_OPTIMIZATIONS"
}
```
### UglifyJS compression
This uses the [UglifyJS](https://github.com/mishoo/UglifyJS) compressor to
compress your JavaScript. You will need to install the
[uglifier](http://rubygems.org/gems/uglifier) gem.
For options, refer to the [Uglifier
documentation](https://github.com/lautis/uglifier).
``` ruby
assets {
js_compression :uglify
js_compression :uglify, [options]
}
```
__Note:__ This depends on the `uglifier` gem :
``` ruby
# Gemfile
gem 'uglifier'
```
## Images
To show images, use the `img` helper.
This automatically adds width, height, and a cache buster thingie.
ImageMagick is required to generate full image tags with width and height.
``` html
<!-- Original: --> <%= img '/images/email.png' %>
<!-- Output: --> <img src='/images/email.873842.png' width='16' height='16' />
```
#### URL translation
In your CSS files, `url()`'s will automatically be translated.
``` css
/* Original: */ .email { background: url(/images/email.png); }
/* Output: */ .email { background: url(/images/email.6783478.png); }
```
#### Image embedding
Want to embed images as `data:` URI's? Sure! Just add `?embed` at the end of the
URL.
``` css
/* Original: */ .email { background: url(/images/email.png?embed); }
/* Output: */ .email { background: url(data:image/png;base64,NF8dG3I...); }
```
## Precompile
``` ruby
# Rakefile
APP_FILE = 'app.rb'
APP_CLASS = 'App'
# For Padrino users, do not forget to add your application namspace
# APP_CLASS = '<Project>::App'
require 'sinatra/assetpack/rake'
```
#### Invoking
Now you have the following tasks to precompile assets.
``` ruby
rake assetpack:precompile # Precompile all assets
rake assetpack:precompile:files # Precompile files only
rake assetpack:precompile:packages # Precompile packages only
```
## Settings
#### Assets block
All configuration happens in the `assets` block. You may invoke it in 2 ways:
``` ruby
class App < Sinatra::Base
register Sinatra::AssetPack
# Style 1
assets do
css :hello, [ '/css/*.css' ]
css_compression :yui
end
# Style 2
assets do |a|
a.css :hello, ['/css/*.css' ]
a.css_compression :yui
end
end
```
#### Getting options
Invoking it without a block allows you to access the options. This works for
almost all the options, with the exception for `css`, `js` and `serve`.
``` ruby
App.assets
App.assets.css_compression #=> :yui
```
### assets.serve
Serves files from `LOCALPATH` in the URI path `PATH`. Both parameters are
required.
``` ruby
# Usage
serve 'PATH', :from => 'LOCALPATH'
```
#### Example
This makes `/app/javascripts/vendor/jquery.js`
available as `http://localhost:4567/js/vendor/jquery.js`.
``` ruby
serve '/js', from: '/app/javascripts'
```
### assets.js\_compression<br>assets.css\_compression
Sets the compression engine to use for JavaScript or CSS. This defaults to
`:jsmin` and `:simple`, respectively.
If `OPTIONS_HASH` is given as a hash, it sets options for the engine to use.
``` ruby
# Usage:
assets {
js_compression :ENGINE
js_compression :ENGINE, OPTIONS_HASH
css_compression :ENGINE
css_compression :ENGINE, OPTIONS_HASH
}
```
#### Examples
Yo seriously check this out: the first line uses Sqwish with it's defaults, and
the second line uses Sqwish with it's magic.
``` ruby
assets {
css_compression :sqwish
css_compression :sqwish, :strict => true
}
```
### assets.js\_compression\_options<br>assets.css\_compression\_options
Sets the options for the compression engine to use. This is usually not needed
as you can already set options using `js_compression` and `css_compression`.
``` ruby
# Usage:
assets {
js_compression_options HASH
css_compression_options HASH
}
```
#### Example
This sets the option for `:munge` for the CSS compression engine.
``` ruby
css_compression_options :munge => true
```
### assets.css<br>assets.js
Adds packages to be used.
The `NAME` is a symbol defines the ID for that given package that you can use
for the helpers. That is, If a CSS package was defined as `css :main, [ ... ]`,
then you will need to use `<%= css :main %>` to render it in views.
the `URI` is a string that defines where the compressed version will be served.
It is optional. If not provided, it will default to `"/assets/name.type"` (eg:
`/assets/main.css`).
the `PATHs` is an array that defines files that will be served. Take note that
this is an array of URI paths, not local paths.
If a `PATH` contains wildcards, it will be expanded in alphabetical order.
Redundancies will be taken care of.
``` ruby
# Usage:
assets {
css :NAME, [ PATH1, PATH2, ... ]
css :NAME, 'URI', [ PATH1, PATH2, ... ]
js :NAME, [ PATH1, PATH2, ... ]
js :NAME, 'URI', [ PATH1, PATH2, ... ]
}
```
#### Example
In this example, JavaScript files will be served compressed as
`/js/application.js` (default since no `URI` is given). The files will be taken
from `./app/javascripts/vendor/jquery*.js`.
``` ruby
class App < Sinatra::Base
assets {
serve '/js', from: '/app/javascripts'
js :application, [
'/js/vendor/jquery.*.js',
'/js/vendor/jquery.js'
]
}
end
# In views: <%= js :application %>
```
### assets.ignore
Excludes any URL paths that match the given spec.
These files will not show up in packages, and they will not be accessible.
By default, `.*` and `_*` are ignored. The former protects folders such as
`.svn` from being accessed, and the latter protects Sass partial files from
being accessed directly.
Note that this matches against URL paths, not local file paths. This means
something like `*.scss` will not work, as all stylesheet files will be compiled
to `.css`.
``` ruby
# Usage:
assets {
ignore FILESPEC
}
```
#### Example
Here's an example.
``` ruby
class App < Sinatra::Base
assets {
# Ignores all files matching *.private.js in any folder.
ignore '*.private.js'
# Ignores all files in `/app/js/foo/**/*`
ignore '/js/foo'
}
end
```
#### Advanced usage
By default, `.*` and `_*` are ignored. To disable this behavior, you can use
`clear_ignores!` before your `ignore` lines.
``` ruby
assets {
clear_ignores!
ignore '*.private.js'
}
```
To check if a certain file is ignored, use `assets.ignore?`
``` ruby
assets.ignored?("/css/_chrome.css") #=> true
```
### assets.prebuild
Caches the built packages on application startup.
If this is not used, the packages will be minified when they are first
requested. This only has an effect in the production environment (or when
Sinatra's `reload_templates` is otherwise set to false).
``` ruby
# Usage:
prebuild {true|false}
```
#### Example
In this example, the package for `:application` will be built when the
application is started in the production environment.
``` ruby
class App < Sinatra::Base
assets {
js_compression :closure
js :application, [
'/js/vendor/jquery.*.js',
'/js/vendor/jquery.js'
]
prebuild true
}
end
# $ RACK_ENV=production ruby app.rb
# ** Building /assets/application.js...
# == Sinatra/1.2.6 has taken the stage on 4567 for production
# >> Thin web server (v1.2.11 codename Bat-Shit Crazy)
# >> Maximum connections set to 1024
# >> Listening on 0.0.0.0:4567, CTRL+C to stop
```
### assets.expires
Sets cache control headers for all assets handled by AssetPack. Defaults to `expires 86400*30, :public`. Passes the arguments to [Sinatras #expires](http://rubydoc.info/gems/sinatra/Sinatra/Helpers#expires-instance_method).
``` ruby
# Usage:
expires amount, *values
```
#### Example
In this example all assets get cached for a year.
``` ruby
class App < Sinatra::Base
assets {
js_compression :closure
js :application, [
'/js/vendor/jquery.*.js',
'/js/vendor/jquery.js'
]
expires 86400*365, :public
}
end
```
### assets.cache_dynamic_assets
Caches dynamic files unless they have been modified.
Useful during development if asset compilation of all dynamic assets on each request is slow.
If set to true, dynamic assets will be compiled on the initial asset request, but only be re-compiled when the asset's mtime changes.
``` ruby
# Usage:
cache_dynamic_assets {true|false}
```
#### Example
In this example, all dynamic files will be compiled on first request, but later requests will be served from a cache unless the file is modified
``` ruby
class App < Sinatra::Base
assets {
js_compression :closure
js :application, [
'/js/vendor/jquery.*.js',
'/js/vendor/jquery.js'
]
cache_dynamic_assets true
}
end
```
### assets.asset_hosts
Adds asset hosts to be used in production.
Useful for hosting your assets on CDNs.
``` ruby
# Usage:
assets {
asset_hosts ['URL1', 'URL2']
}
```
#### Example
In this example, all assets are served from multiple CDN subdomains:
``` ruby
class App < Sinatra::Base
assets {
serve '/css', :from => 'app/css'
serve '/js', :from => 'app/js'
asset_hosts [
'//cdn-0.example.org',
'//cdn-1.example.org'
]
css :a, ["/css/style.css"]
js :b, ["/js/hello.js"]
}
end
```
## Helpers
These are helpers you can use in your views.
### <%= css %>
Shows a CSS package named `PACKAGE`. If `OPTIONS_HASH` is given, they will we
passed onto the `<link>` tag to be generated as attributes.
You may specify as many packages as you need, as shown in the second usage line.
``` ruby
# Usage:
<%= css :PACKAGE %>
<%= css :PACKAGE_1, :PACKAGE_2, ... :PACKAGE_N, OPTIONS_HASH %>
<%= css :PACKAGE, OPTIONS_HASH %>
```
#### Example 1
This links to the `main` stylesheet for *screen* media.
``` erb
<%= css :main, media: 'screen' %>
<!-- Output: -->
<link rel='stylesheet' type='text/css' href='/css/main.873984.css' media='screen' />
```
#### Example 2
You may also invoke it with multiple packages.
``` erb
<%= css :base, :app, :main, media: 'screen' %>
<!-- Output: -->
<link rel='stylesheet' type='text/css' href='/css/base.873984.css' media='screen' />
<link rel='stylesheet' type='text/css' href='/css/app.873984.css' media='screen' />
<link rel='stylesheet' type='text/css' href='/css/main.873984.css' media='screen' />
```
### <%= js %>
Same as `css`, but obviously for JavaScript. You may also specify as many packages as you need, just with `css`.
``` erb
# Usage:
<%= js :PACKAGE %>
<%= js :PACKAGE_1, :PACKAGE_2, ... :PACKAGE_N, OPTIONS_HASH %>
<%= js :PACKAGE, OPTIONS_HASH %>
```
#### Example
This example embeds the *main* package with an ID.
``` erb
<%= js :main, id: 'main_script' %>
<!-- Output: -->
<script type='text/javascript' src='/js/main.783439.js' id='main_script'></script>
```
### <%= img %>
Shows an `<img>` tag from the given `SRC`. If the images is found in the asset
directories (and ImageMagick is available), `width` and `height` attributes will
be added.
``` ruby
# Usage:
img 'SRC'
img 'SRC', OPTIONS_HASH
```
If `OPTIONS_HASH` is given, they will we passed onto the `<img>` tag to be
generated as attributes.
#### Example
This example renders an image with an alt tag.
``` erb
<%= img '/images/icon.png', alt: 'Icon' %>
<!-- Output: -->
<img src='/images/icon.834782.png' width='24' height='24' alt='Icon' />`
```
## Compass
AssetPack doesn't have built-in [Compass](http://compass-style.org)
support, but you can include it easily with
[Sinatra Support](https://github.com/sinefunc/sinatra-support/).
See also the [Compass example application.][compass]
[compass]: https://github.com/rstacruz/sinatra-assetpack/tree/master/examples/compass
## Contributing
See [CONTRIBUTING.md](https://github.com/rstacruz/sinatra-assetpack/blob/master/CONTRIBUTING.md) for details on contributing and running test.
## Acknowledgements
© 2011-2013, Rico Sta. Cruz. Released under the [MIT
License](http://www.opensource.org/licenses/mit-license.php).
Sinatra-AssetPack is authored by [Rico Sta. Cruz][rsc] with help
from it's [contributors][c]. It is sponsored by [Sinefunc, Inc][sf].
Sinatra-AssetPack is maintained by [Jean-Philipe Doyle][j15e] at [Hookt Studios][hookt].
Github : [@rstacruz](http://github.com/rstacruz), [@j15e](http://github.com/j15e)
Twitter : [@rstacruz](http://twitter.com/rstacruz), [@j15e](http://twitter.com/j15e)
[rsc]: http://ricostacruz.com
[c]: http://github.com/rstacruz/sinatra-assetpack/contributors
[sf]: http://sinefunc.com
[j15e]: http://github.com/j15e
[hookt]: http://github.com/hooktstudios