smart_assets 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8feafdbc7693ce1d631af2295f4b32fc24996fda
+  data.tar.gz: 3a6f4c22fba94c691916545b2db23a8df70ee672
+SHA512:
+  metadata.gz: f086f505f8d919605399be2a504f9e644366048cd6af79c9da611df8874623c547da3c8fb00e8789f30647afdcaf6da65da1432bd6505c61513a88de6f90bc40
+  data.tar.gz: 77a34c803172f5ac8c7f7e18473488edf2103d6b6ec560ed6e2acc1a175e40578caa016a875df2e0d43fafc0f6784c5f4fcf2e02ae47e84f8e36bfc312963c50

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smart_assets.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 thomas morgan
+
+MIT License
+
+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,47 @@
+# SmartAssets
+
+SmartAssets is a Rack Middleware for Rails that enables delivery of non-digest assets when using the default asset pipeline.
+
+It solves the problem of production environment requests for assets (eg: application.css) returning a 404 because they do not contain a digest (eg: application-1c8db23293725a8857e5132d59211909.css).
+
+In general, Rails' default behavior of requiring a digest is a good idea. Serving asset files without a digest can easily result in assets being cached for long periods of time, making them impossible to update. Consider yourself warned.
+
+At the same time, there are legitimate reasons to serve assets without a digest in the name, among them using assets with 404 and other error pages and with 3rd-party applications and sites.
+
+This middleware works by reading the sprockets manifest file and internally changing the HTTP request to reflect the digested name. If your manifest is out of date, you will still get 404s.
+
+In order to minimize the risks of long caching while using this gem, requests where the requested filename is mutated will set Cache-Control: public, max-age=60.
+
+This can configured in your environment files (or an initializer) using:
+
+    config.smart_assets.cache_control = 'public, max-age=60'
+
+Max-age is in seconds. Caching by browsers and proxies can be disabled entirely with:
+
+    config.smart_assets.cache_control = 'max-age=0,no-cache,no-store'
+
+This middleware may also be diabled on a per-environment basis with:
+
+    config.smart_assets.serve_non_digest_assets = false
+
+Note that `serve_static_assets` or `assets.compile` must be true or the middleware will disable itself.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'smart_assets'
+
+And then execute:
+
+    $ bundle
+
+
+## Contributing
+
+1. Fork it ( https://github.com/zarqman/smart_assets/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/smart_assets/rack.rb

@@ -0,0 +1,54 @@
+module SmartAssets
+  class Rack
+
+    def initialize(app, prefix, cache_control)
+      @app = app
+      @prefix = prefix
+      @cache_control = cache_control
+    end
+
+    def call(env)
+      unless is_asset?(env) && (digest_asset=digest_name(env))
+        return @app.call(env)
+      end
+
+      digest_path = File.join(manifest.dir, digest_asset)
+      if File.exists?(digest_path)
+        env['PATH_INFO'] = "#{@prefix}/#{digest_asset}"
+      end
+      status, headers, body = @app.call(env)
+      if [200, 206].include?(status)
+        headers['Cache-Control'] = @cache_control
+        headers['ETag'] ||= %("#{digest(digest_asset)}")
+      end
+      [status, headers, body]
+    end
+
+
+    def is_asset?(env)
+      case env['REQUEST_METHOD']
+      when 'GET', 'HEAD'
+        env['PATH_INFO'].start_with?(@prefix)
+      else
+        false
+      end
+    end
+
+    def base_path(env)
+      env['PATH_INFO'].sub(%r{^#{@prefix}/}, '')
+    end
+
+    def digest_name(env)
+      manifest.assets[base_path(env)]
+    end
+
+    def digest(name)
+      manifest.files[name]['digest']
+    end
+
+    def manifest
+      ActionView::Base.assets_manifest
+    end
+
+  end
+end

data/lib/smart_assets/railtie.rb

@@ -0,0 +1,23 @@
+module SmartAssets
+  class Railtie < Rails::Railtie
+
+    config.smart_assets = ActiveSupport::OrderedOptions.new
+    config.smart_assets.cache_control = 'public, max-age=60'
+    config.smart_assets.prefix = nil
+    config.smart_assets.serve_non_digest_assets = true
+
+    initializer 'smart_assets.configure' do |app|
+      if app.config.smart_assets.serve_non_digest_assets
+        prefix = app.config.smart_assets.prefix || app.config.assets.prefix || '/assets'
+        cc = app.config.smart_assets.cache_control
+
+        if app.config.serve_static_assets || app.config.assets.compile
+        #   app.middleware.insert_before(ActionDispatch::Static, SmartAssets::Rack, prefix, cc)
+        # elsif app.config.assets.compile
+          app.middleware.insert_after(::Rack::Sendfile, SmartAssets::Rack, prefix, cc)
+        end
+      end
+    end
+
+  end
+end

data/lib/smart_assets/version.rb

@@ -0,0 +1,3 @@
+module SmartAssets
+  VERSION = '0.0.1'
+end

data/lib/smart_assets.rb

@@ -0,0 +1,3 @@
+%w(rack railtie version).each do |f|
+  require "smart_assets/#{f}"
+end

data/smart_assets.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smart_assets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smart_assets"
+  spec.version       = SmartAssets::VERSION
+  spec.authors       = ["thomas morgan"]
+  spec.email         = ["tm@iprog.com"]
+  spec.summary       = %q{Rails/Rack middleware to enable delivery of non-digest assets}
+  spec.description   = %q{Rails/Rack middleware to enable delivery of non-digest assets.}
+  spec.homepage      = "https://github.com/zarqman/smart_assets"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails', '~> 4.0'
+  spec.add_dependency 'sprockets-rails', '~> 2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: smart_assets
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- thomas morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails/Rack middleware to enable delivery of non-digest assets.
+email:
+- tm@iprog.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smart_assets.rb
+- lib/smart_assets/rack.rb
+- lib/smart_assets/railtie.rb
+- lib/smart_assets/version.rb
+- smart_assets.gemspec
+homepage: https://github.com/zarqman/smart_assets
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Rails/Rack middleware to enable delivery of non-digest assets
+test_files: []