Dassets

Digest and serve HTML asset files.

Usage

You have some css, js, images, etc files. You want to update, deploy, and serve them in an efficient way. Dassets can help.

Setup

# in config/dassets.rb
require 'dassets'

Dassets.configure do |c|

  # tell Dassets where to look for source files
  c.source '/path/to/app/assets'

  # (optional) tell Dassets where to store digested asset files
  # if none given, Dassets will not write any digested output
  # use this to "cache" digested assets to the public dir (for example)
  c.file_store '/path/to/public' # default: `NullFileStore.new`

end

Dassets.init
Dassets['css/site.css'].href       # => "/css/site-123abc.css"
Dassets['img/logos/main.jpg'].href # => "/img/logos/main-a1b2c3.jpg"

Serve

Use the Dassets middleware to serve your digested asset files:

# `app` is a rack application
require 'dassets/server'
app.use Dassets::Server

Compiling

Dassets compiles your asset source as part of its digest pipeline using "engines". Engines transform source extensions and content.

Engines are "registered" with dassets based on source extensions. Name your source file with registered extensions and those engines will be used to compile your source content.

Some Dassets Engines

Examples are key here, so check out some of the Dasset's engines available:

TODO

Creating your own Engine

  • create a class that subclasses Dassets::Engine
  • override the ext method to specify how the input source extension should be handled
  • override the compile method to specify how the input content should be transformed
  • register your engine class with Dassets

Sources

TODO: filtering files, registering engines

Combinations

TODO

Installation

Add this line to your application's Gemfile:

gem 'dassets'

And then execute:

$ bundle

Or install it yourself as:

$ gem install dassets

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request