Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
This fork includes a number of bug fixes that haven't been applied upstream.
Ruby
branch: master

This branch is 28 commits ahead of thegorgon:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples
lib
Gemfile
LICENSE.mkd
README.mkd
sinatra-sprockets.gemspec

README.mkd

Sinatra Sprockets!

Because Sprockets is cool, and Rails is cool, but they shouldn't get married. This is a fork which includes changes that haven't been applied upstream. We do regular gem releases under the alphasights- prefix.

Installation

Run

gem install alphasights-sinatra-sprockets

Or add

gem 'alphasights-sinatra-sprockets', require: 'sinatra/sprockets'

to your Gemfile

Setup

Sinatra Sprockets needs to be configured to work properly. In your server initialization, add a configuration :

Sinatra::Sprockets.configure do |config|
  config.app = MyApp

  ['stylesheets', 'javascripts', 'images'].each do |dir|
    config.append_path(File.join('app', 'assets', dir))
  end
end

The only required field is app which is necessary to translate app configuration to Sprockets. You will also want to append_paths as none are included by default. See Configuration for more information.

Include Sinatra::Sprockets::Helpers as helpers in your application :

helpers Sinatra::Sprockets::Helpers

And mount the environment :

map '/assets' do
  run Sinatra::Sprockets.environment
end

Require files in layouts :

<%= javascript_include_tag "application" %>
<%= stylesheet_link_tag "application" %>

image_tag, favicon_link_tag, video_tag and audio_tag are also provided.

Configuration

Sprockets requires a decent amount of configuration to work properly. Most of the options listed here are taken from the Sprockets/Rails integration. You can get more detailed information in the Rails guide on asset pipelines.

digest : Boolean value. Should Sprockets use "digest" asset paths? That is, should asset paths be fingerprinted using file digests for cache busting? For more information. This is on by default, though you may want to turn it off in development.

debug : Boolean value. Should sprockets include assets for debugging? That is, should assets be rendered as individual included files for debugging or as the combination? When on, javascript and stylesheet debugging are much easier. Off by default, though you probably want to turn it on in development.

compile: Boolean value.

Known Issues

There's no testing or documentation. I know. Want to help?

Anything else?

Questions, requests, concerns? You can find the original author at the gorgon lab. You can find the current maintainers at alphadev.

Something went wrong with that request. Please try again.