digestion 1.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Sam Pohlenz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+Digestion (Asset Pipeline Fingerprinting Controls)
+==================================================
+
+The asset pipeline is a great new component of Rails 3.1. However it has a feature known as fingerprinting that makes it impossible to properly incorporate many popular JavaScript libraries (including [TinyMCE](http://tinymce.moxiecode.com/), [CKEditor](http://ckeditor.com/) and [FancyZoom](https://github.com/jnunemaker/fancy-zoom) to name just a few) into the asset pipeline.
+
+This gem patches the asset pipeline to allow these libraries to be used, by disabling the fingerprinting functionality for specific files or paths.
+
+
+Installation & Usage
+--------------------
+
+Add the following line to your Gemfile and run `bundle install`:
+
+    gem 'digestion'
+
+The `digestion` gem does not change any fingerprinting options by default but allows you to set the following options in your application configuration:
+
+    # Exclude specific assets from fingerprinting (use a path, glob or regex)
+    config.assets.digest_exclusions << "nofingerprints/*"
+
+Rails plugins can require this gem and set these options in an initializer, making the whole process transparent to the end-developer. See the [tinymce-rails](https://github.com/spohlenz/tinymce-rails) project for an example of this.
+
+
+The Problem With Fingerprinting
+-------------------------------
+
+Fingerprinting is used to improve caching of assets by including a version-specific fingerprint or digest in the asset filename. From the [Asset Pipeline Rails Guide](http://guides.rubyonrails.org/asset_pipeline.html#what-is-fingerprinting-and-why-should-i-care):
+
+> When a filename is unique and based on its content, HTTP headers can be set to encourage caches everywhere (at ISPs, in browsers) to keep their own copy of the content. When the content is updated, the fingerprint will change and the remote clients will request the new file. This is generally known as cachebusting.
+
+In the Rails asset pipeline (in production mode), the MD5 hash of the file contents is inserted into the filename, e.g. `application-d41d8cd98f00b204e9800998ecf8427e.js`. This requires that the relevant `asset_url` helpers are used when referencing assets in your HTML, JavaScript or CSS (or CoffeeScript, SASS, etc).
+
+When adding third-party code to your application, it is not always practical to make these changes. Worse still, more advanced libraries like TinyMCE load in plugins and other assets dynamically, making these changes virtually impossible. In these situations, the third-party code will work fine whilst in development but break suddenly when deployed to production.
+
+One option is to move the assets into the `public` directory. Whilst this approach will work, it has some major drawbacks:
+
+1. It prevents you from using the other great features of the asset pipeline such as asset concatenation and minification.
+2. It leaves your assets scattered across multiple locations, making maintenance difficult.
+3. A gem that provides assets must provide an additional rake task to copy its assets into `public`.
+
+Asset fingerprinting is a great feature and it is recommended you use it wherever possible. However without this gem, it is impossible to disable it for those libraries that are incompatible.

data/lib/digestion.rb

@@ -0,0 +1,2 @@
+require "digestion/helpers"
+require "digestion/railtie" if defined?(Rails)

data/lib/digestion/assets.rake

@@ -0,0 +1,66 @@
+Rake::Task["assets:precompile"].clear
+
+def digest_path?(logical_path)
+  return false unless Rails.application.config.assets.digest
+  return true if Rails.application.config.assets.digest_exclusions.blank?
+  
+  Rails.application.config.assets.digest_exclusions.none? do |path|
+    if path.is_a?(Regexp)
+      # Match path against `Regexp`
+      path.match(logical_path)
+    else
+      # Otherwise use fnmatch glob syntax
+      File.fnmatch(path.to_s, logical_path)
+    end
+  end
+end
+
+namespace :assets do
+  task :precompile do
+    # We need to do this dance because RAILS_GROUPS is used
+    # too early in the boot process and changing here is already too late.
+    if ENV["RAILS_GROUPS"].to_s.empty? || ENV["RAILS_ENV"].to_s.empty?
+      ENV["RAILS_GROUPS"] ||= "assets"
+      ENV["RAILS_ENV"]    ||= "production"
+      Kernel.exec $0, *ARGV
+    else
+      Rake::Task["environment"].invoke
+
+      # Ensure that action view is loaded and the appropriate sprockets hooks get executed
+      ActionView::Base
+
+      # Always compile files
+      Rails.application.config.assets.compile = true
+
+      config = Rails.application.config
+      env    = Rails.application.assets
+      target = Pathname.new(File.join(Rails.public_path, config.assets.prefix))
+      manifest = {}
+      manifest_path = config.assets.manifest || target
+
+      config.assets.precompile.each do |path|
+        env.each_logical_path do |logical_path|
+          if path.is_a?(Regexp)
+            next unless path.match(logical_path)
+          else
+            next unless File.fnmatch(path.to_s, logical_path)
+          end
+
+          if asset = env.find_asset(logical_path)
+            asset_path = digest_path?(logical_path) ? asset.digest_path : logical_path
+            manifest[logical_path] = asset_path
+            filename = target.join(asset_path)
+
+            mkdir_p filename.dirname
+            asset.write_to(filename)
+            asset.write_to("#{filename}.gz") if filename.to_s =~ /\.(css|js)$/
+          end
+        end
+      end
+
+      File.open("#{manifest_path}/manifest.yml", 'w') do |f|
+        YAML.dump(manifest, f)
+      end
+    end
+  end
+end

data/lib/digestion/helpers.rb

@@ -0,0 +1,51 @@
+require 'sprockets/helpers'
+
+Sprockets::Helpers::RailsHelper.module_eval do
+  alias_method :original_asset_paths, :asset_paths
+  
+  def asset_paths
+    @asset_paths ||= original_asset_paths.tap do |paths|
+      paths.digest_assets     = digest_assets?
+      paths.digest_exclusions = digest_exclusions
+    end
+  end
+
+private
+  def digest_assets?
+    Rails.application.config.assets.digest
+  end
+  
+  def digest_exclusions
+    Rails.application.config.assets.digest_exclusions
+  end
+end
+
+Sprockets::Helpers::RailsHelper::AssetPaths.class_eval do
+  attr_accessor :digest_assets, :digest_exclusions
+  
+  alias_method :original_digest_for, :digest_for
+  
+  def digest_for(logical_path)
+    if digest_path?(logical_path)
+      original_digest_for(logical_path)
+    else
+      logical_path
+    end
+  end
+
+private
+  def digest_path?(logical_path)
+    return false unless digest_assets
+    return true if digest_exclusions.blank?
+    
+    digest_exclusions.none? do |path|
+      if path.is_a?(Regexp)
+        # Match path against `Regexp`
+        path.match(logical_path)
+      else
+        # Otherwise use fnmatch glob syntax
+        File.fnmatch(path.to_s, logical_path)
+      end
+    end
+  end
+end

data/lib/digestion/railtie.rb

@@ -0,0 +1,13 @@
+require 'sprockets/railtie'
+
+module Digestion
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load "digestion/assets.rake"
+    end
+    
+    initializer :setup_configuration, :before => :load_environment_config do |app|
+      app.config.assets.digest_exclusions = []
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: digestion
+version: !ruby/object:Gem::Version
+  version: '1.1'
+  prerelease: 
+platform: ruby
+authors:
+- Sam Pohlenz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-05 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &2152759540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152759540
+description: Adds asset digest configuration options to Rails so that specific paths
+  can be excluded from fingerprinting.
+email: sam@sampohlenz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/digestion/assets.rake
+- lib/digestion/helpers.rb
+- lib/digestion/railtie.rb
+- lib/digestion.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Fine-grained digest controls for the Rails 3.1 asset pipeline.
+test_files: []