https://github.com/alexspeller/non-stupid-digest-assets

Fix the Rails 4 asset pipeline to generate non-digest along with digest assets
https://github.com/alexspeller/non-stupid-digest-assets

Last synced: 29 days ago
JSON representation

Fix the Rails 4 asset pipeline to generate non-digest along with digest assets

• Host: GitHub
• URL: https://github.com/alexspeller/non-stupid-digest-assets
• Owner: alexspeller
• License: mit
• Created: 2013-09-20T19:35:26.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2024-04-29T03:26:25.000Z (about 2 months ago)
• Last Synced: 2024-05-15T14:13:17.755Z (about 1 month ago)
• Language: Ruby
• Size: 20.5 KB
• Stars: 493
• Watchers: 12
• Forks: 87
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-rails - Non-stupid non-digest assets - compile both digest and non-digest assets in Rails 4. (Assets Management)

README

        
Non-stupid non-digest assets in Rails 4

=======================================

What is it?

-----------

In Rails 4, there is no way to by default compile both digest and non-digest assets. This is a pain in the arse for almost everyone developing a Rails 4 app. This gem solves the problem with the minimum possible effort.

How do I install it?

--------------------

Just put it in your Gemfile

```ruby

gem "non-stupid-digest-assets"

```

If you want to whitelist non-digest assets for only certain files, you can configure a whitelist like this:

```ruby

# config/initializers/non_digest_assets.rb

NonStupidDigestAssets.whitelist += [/tinymce\/.*/, "image.png"]

```

Be sure to give either a regex that will match the right assets or the logical path of the asset in question.

Note that the logical path is what you would provide to `asset_url`, so for an image at `RAILS_ROOT/assets/images/foo.png` the logical path is `foo.png`

But shouldn't I always use the Rails asset helpers anyway?

----------------------------------------------------------

Yes. But there are some obvious cases where you can't do this:

* Third party libraries in `vendor/assets` that need to include e.g. css / images

* In a static error page, e.g. a 404 page or a 500 page

* Referencing the assets from outside your rails application

What about other solutions?

--------------------------

[sprockets-redirect](https://github.com/sikachu/sprockets-redirect) uses a rack middleware to 302 redirect to the digest asset. This is terrible for performance because it requires 2 HTTP requests, and it also hits your ruby stack. An asset request should be handled by your webserver (e.g. nginx) because that's what it's good at.

[This rake task](https://github.com/rails/sprockets-rails/issues/49#issuecomment-20535134) will solve this problem, but requires an extra rake task. It won't work by default with things like capistrano / heroku. And it requires you to manage the code in your app.

Why do I need digest assets at all?

-----------------------------------

Digests are used for cache busting. Remember that if you use the non-digest assets and serve them with far-future expires headers, you will cause problems with cached assets if the contents ever need to change. You must bear this in mind when using non-digest assets.

Why is this not the default / a config option in Rails 4?

---------------------------------------------------------

Good question. I think it should be. [Complain here](https://github.com/rails/sprockets-rails/issues/49)