rack-zippy 1.2.1 → 2.0.0

data/.gitignore

@@ -20,4 +20,4 @@ tmp
 .ruby-version
 vendor
 .DS_Store
-
+*.tmp

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 2.0.0 / 2014-12-07
+- Rack Zippy now works cleanly with all Rack apps, including Rails apps ([#23](https://github.com/eliotsykes/rack-zippy/issues/23))
+- Decomposed AssetServer into AssetServer, ServeableFile, and AssetCompiler classes
+- Installation notes for non-Rails Rack apps added to README.md
+- Smarter handling of directory requests to match behaviour of Rails Static middleware ([#15](https://github.com/eliotsykes/rack-zippy/issues/15))
+    - Requests for `/` and `/index` respond with `public/index.html` if present
+    - Requests for `/foo/` and `/foo` respond with first file present out of `public/foo.html`, `public/foo/index.html` (Same behaviour for subdirectories)
+- Use File.join to build file path ([#34](https://github.com/eliotsykes/rack-zippy/issues/34))
+- Respond with 404 Not Found instead of raising SecurityError for illegal paths ([#17](https://github.com/eliotsykes/rack-zippy/issues/17))
+
 ## 1.2.1 / 2014-07-09
 - Use absolute (not relative) path for default asset_root ([#11](https://github.com/eliotsykes/rack-zippy/issues/11))
 

data/Gemfile

@@ -4,6 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'rake'
+  gem 'guard-test'
   gem 'rack-test'
+  gem 'rake'
 end

data/Guardfile

@@ -0,0 +1,7 @@
+# More info at https://github.com/guard/guard#readme
+
+guard :test do
+  watch(%r{^test/.+_test\.rb$})
+  watch('test/test_helper.rb')  { 'test' }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
+end

data/README.md

@@ -5,16 +5,21 @@ on Heroku if you want to serve the precompiled gzipped assets to gzip-capable cl
 
 By default, Rails + Heroku will not serve *.gz assets even though they are generated at deploy time.
 
-rack-zippy replaces the ActionDispatch::Static middleware used by Rails, which is not capable of serving the gzipped assets created by
+rack-zippy replaces the `ActionDispatch::Static` middleware used by Rails, which is not capable of serving the gzipped assets created by
 the `rake assets:precompile` task. rack-zippy will serve non-gzipped assets where they are not available or not supported by the
 requesting client.
 
+rack-zippy (since 2.0.0) has the same **convenient directory request handling** provided by `ActionDispatch::Static`, which means you can take advantage of this in any rack app:
+
+- Requests for `/` and `/index` respond with `public/index.html` if present
+- Requests for `/foo/` and `/foo` respond with first file present out of `public/foo.html`, `public/foo/index.html` (Same behaviour for subdirectories)
+
 Watch the [Web Dev Break podcast on rack-zippy](http://www.webdevbreak.com/specials/rack-zippy "Faster, friendlier assets with rack-zippy") to see how you can check if your app
 is currently serving uncompressed assets and how quick it is to setup rack-zippy:
 
 [ ![Faster, friendlier assets with rack-zippy](/video-player.png "Faster, friendlier assets with rack-zippy") ](http://www.webdevbreak.com/specials/rack-zippy "Faster, friendlier assets with rack-zippy")
 
-## Installation
+## Installation in Rails app
 
 Add this line to your application's Gemfile:
 
@@ -36,11 +41,32 @@ Create the file `config/initializers/rack_zippy.rb` and put this line in it:
 
 Now run `rake middleware` at the command line and make sure that `Rack::Zippy::AssetServer` is near the top of the outputted list. ActionDispatch::Static should not be in the list. Nicely done, rack-zippy is now installed in your app.
 
+## Installation in Rack app (that isn’t a Rails app)
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-zippy'
+
+And then execute:
+
+    $ bundle
+
+In `config.ru`:
+
+    require 'rack-zippy'
+
+    # Set asset_root to an absolute or relative path to the directory holding your asset files
+    # e.g. '/path/to/my/apps/static-assets' or 'public'
+    asset_root = '/path/to/my/apps/public'
+    use Rack::Zippy::AssetServer, asset_root
+
+
 ## Usage
 
 Follow the installation instructions above and rack-zippy will serve any static assets, including gzipped assets, from your
 application's public/ directory and will respond with sensible caching headers.
 
+
 ## Troubleshooting
 
 ##### 'assert_index': No such middleware to insert before: ActionDispatch::Static (RuntimeError)
@@ -49,6 +75,7 @@ Check your environment (in config/environments/) does not have `serve_static_ass
 
     config.serve_static_assets = false # Oops! Should be set to true for rack-zippy
 
+
 ## Contributing
 
 1. Fork it
@@ -58,6 +85,31 @@ Check your environment (in config/environments/) does not have `serve_static_ass
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new Pull Request
 
+### Optional for contributors
+To try a local branch of rack-zippy out as the gem dependency in a local app, configure bundler with a local gem
+override as follows:
+
+In `your-app/Gemfile`: edit the rack-zippy dependency to the following:
+
+    # The branch your-local-branch-name **must** exist otherwise bundler will shout obscenities at you
+    gem 'rack-zippy', :github => 'eliotsykes/rack-zippy', :branch => 'your-local-branch-name'
+
+At the command line, inside `your-app`, configure bundler to set a local git repo to override the one we specified in the previous step for rack-zippy:
+
+    $> bundle config --local local.rack-zippy /path/to/your/local/rack-zippy
+
+Now when you run your-app **with** `bundle exec`, the rack-zippy gem dependency will resolve to `/path/to/your/local/rack-zippy`.
+
+Cleanup time! When you’re finished testing, delete the local override and set your Gemfile dependency back to the original:
+
+    # At the command line:
+    $> bundle config --delete local.rack-zippy
+
+    # In your-app/Gemfile change rack-zippy dependency to this (or similar):
+    gem 'rack-zippy', '~> 9.8.7' # Replace 9.8.7 with the rack-zippy release version you want to use.
+
+
+
 ## Contributors
 
 - [Eliot Sykes](https://github.com/eliotsykes)
@@ -72,5 +124,6 @@ Check your environment (in config/environments/) does not have `serve_static_ass
 3. Tests pass? (`rake test`)
 4. Build the gem (`rake build`)
 5. Release on rubygems.org (`rake release`)
-6. Update version to the next pre-release version in lib/rack-zippy/version.rb, e.g. '1.0.1' becomes '1.0.2.pre'
+6. Update version to the next pre-release version in lib/rack-zippy/version.rb, e.g. '1.0.1' becomes '1.0.2.pre'.
+7. Commit and push the updated lib/rack-zippy/version.rb.
 

data/lib/rack-zippy.rb

@@ -1,39 +1,47 @@
 require 'rack-zippy/version'
+require 'rack-zippy/asset_compiler'
+require 'rack-zippy/serveable_file'
 
 module Rack
   module Zippy
+
+    PRECOMPILED_ASSETS_SUBDIR_REGEX = /\A\/assets(?:\/|\z)/
+
     class AssetServer
 
-      def initialize(app, asset_root=Rails.public_path)
+      # Font extensions: woff, woff2, ttf, eot, otf
+      STATIC_EXTENSION_REGEX = /\.(?:css|js|html|htm|txt|ico|png|jpg|jpeg|gif|pdf|svg|zip|gz|eps|psd|ai|woff|woff2|ttf|eot|otf|swf)\z/i
+
+      HTTP_STATUS_CODE_OK = 200
+
+      def initialize(app, asset_root=nil)
+        if asset_root.nil?
+          if RailsAssetCompiler.rails_env?
+            asset_root = ::Rails.public_path
+          else
+            raise ArgumentError.new 'Please specify asset_root when initializing Rack::Zippy::AssetServer ' +
+              '(asset_root is the path to your public directory, often the one with favicon.ico in it)'
+          end
+        end
         @app = app
         @asset_root = asset_root
+        @asset_compiler = resolve_asset_compiler
       end
 
       def call(env)
         path_info = env['PATH_INFO']
-        assert_legal_path path_info
 
-        if serve?(path_info)
-          headers = { 'Content-Type'  => Rack::Mime.mime_type(::File.extname(path_info)) }
-          headers.merge! cache_headers(path_info)
+        return not_found_response if path_info =~ ILLEGAL_PATH_REGEX
 
-          file_path = path_to_file(path_info)
-          gzipped_file_path = "#{file_path}.gz"
-          gzipped_file_present = ::File.exists?(gzipped_file_path) && ::File.readable?(gzipped_file_path)
+        serveable_file = ServeableFile.find_first(
+            :path_info => path_info,
+            :asset_root => @asset_root,
+            :asset_compiler => @asset_compiler,
+            :include_gzipped => client_accepts_gzip?(env)
+        )
 
-          if gzipped_file_present
-            headers['Vary'] = 'Accept-Encoding'
-
-            if client_accepts_gzip?(env)
-              file_path = gzipped_file_path
-              headers['Content-Encoding'] = 'gzip'
-            end
-          end
-
-          status = 200
-          headers['Content-Length'] = ::File.size(file_path).to_s
-          response_body = [::File.read(file_path)]
-          return [status, headers, response_body]
+        if serveable_file
+          return [HTTP_STATUS_CODE_OK, serveable_file.headers, serveable_file.response_body]
         end
 
         @app.call(env)
@@ -41,77 +49,21 @@ module Rack
 
       private
 
-      SECONDS_IN = {
-          :day => 24*60*60,
-          :month => 31*(24*60*60),
-          :year => 365*(24*60*60)
-      }.freeze
-
-      # Font extensions: woff, woff2, ttf, eot, otf
-      STATIC_EXTENSION_REGEX = /\.(?:css|js|html|htm|txt|ico|png|jpg|jpeg|gif|pdf|svg|zip|gz|eps|psd|ai|woff|woff2|ttf|eot|otf|swf)\z/i
-
-      PRECOMPILED_ASSETS_SUBDIR_REGEX = /\A\/assets(?:\/|\z)/
-
       ACCEPTS_GZIP_REGEX = /\bgzip\b/
 
       ILLEGAL_PATH_REGEX = /(\.\.|\/\.)/
 
-      # Old last-modified headers encourage caching via browser heuristics. Use it for year-long cached assets.
-      CACHE_FRIENDLY_LAST_MODIFIED = 'Mon, 10 Jan 2005 10:00:00 GMT'
-
-      def cache_headers(path_info)
-        case path_info
-          when PRECOMPILED_ASSETS_SUBDIR_REGEX
-            lifetime = :year
-            last_modified = CACHE_FRIENDLY_LAST_MODIFIED
-          when '/favicon.ico'
-            lifetime = :month
-            last_modified = CACHE_FRIENDLY_LAST_MODIFIED
-          else
-            lifetime = :day
-        end
-
-        headers = { 'Cache-Control' => "public, max-age=#{SECONDS_IN[lifetime]}" }
-        headers['Last-Modified'] = last_modified if last_modified
-
-        return headers
-      end
-
-      def path_to_file(path_info)
-        "#{@asset_root}#{path_info}"
-      end
-
-      def serve?(path_info)
-        should_serve_from_filesystem = false
-
-        if has_static_extension?(path_info)
-          file_path = path_to_file(path_info)
-          is_serveable = ::File.file?(file_path) && ::File.readable?(file_path)
-
-          if is_serveable
-            is_outside_assets_dir = !(path_info =~ PRECOMPILED_ASSETS_SUBDIR_REGEX)
-            should_serve_from_filesystem = is_outside_assets_dir || block_asset_pipeline_from_generating_asset?
-          end
-        end
-
-        return should_serve_from_filesystem
-      end
-
-      def block_asset_pipeline_from_generating_asset?
-        # config.assets.compile is normally false in production, and true in dev+test envs.
-        !::Rails.configuration.assets.compile
-      end
-
       def client_accepts_gzip?(rack_env)
         rack_env['HTTP_ACCEPT_ENCODING'] =~ ACCEPTS_GZIP_REGEX
       end
 
-      def has_static_extension?(path)
-        path =~ STATIC_EXTENSION_REGEX
+      def resolve_asset_compiler
+        asset_compiler_class = RailsAssetCompiler.rails_env? ? RailsAssetCompiler : NullAssetCompiler
+        return asset_compiler_class.new
       end
 
-      def assert_legal_path(path_info)
-        raise SecurityError.new('Illegal path requested') if path_info =~ ILLEGAL_PATH_REGEX
+      def not_found_response
+        [404, {}, ['Not Found']]
       end
 
     end

data/lib/rack-zippy/asset_compiler.rb

@@ -0,0 +1,39 @@
+module Rack
+  module Zippy
+
+    class NullAssetCompiler
+      def compiles?(path_info)
+        return false
+      end
+    end
+
+    class RailsAssetCompiler
+
+      def initialize
+        # config.assets.compile is normally false in production, and true in dev+test envs.
+        # compile == true => active pipeline
+        # compile == false => disabled pipeline
+        @active = ::Rails.configuration.assets.compile
+      end
+
+      def compiles?(path_info)
+        return active? && on_pipeline_path?(path_info)
+      end
+
+      private
+
+      def on_pipeline_path?(path_info)
+        path_info =~ PRECOMPILED_ASSETS_SUBDIR_REGEX
+      end
+
+      def active?
+        return @active
+      end
+
+      def self.rails_env?
+        return defined?(::Rails.version)
+      end
+    end
+
+  end
+end

data/lib/rack-zippy/serveable_file.rb

@@ -0,0 +1,138 @@
+module Rack
+  module Zippy
+    class ServeableFile
+
+      attr_reader :path, :full_path_info
+
+      def initialize(options)
+        raise ArgumentError.new(':has_encoding_variants option must be given') unless options.has_key?(:has_encoding_variants)
+
+        @path = options[:path]
+        @full_path_info = options[:full_path_info]
+        @has_encoding_variants = options[:has_encoding_variants]
+        @is_gzipped = options[:is_gzipped]
+      end
+
+      def headers
+        headers = { 'Content-Type'  => Rack::Mime.mime_type(::File.extname(full_path_info)) }
+        headers.merge! cache_headers
+
+        headers['Vary'] = 'Accept-Encoding' if encoding_variants?
+        headers['Content-Encoding'] = 'gzip' if gzipped?
+
+        headers['Content-Length'] = ::File.size(path).to_s
+        return headers
+      end
+
+      def cache_headers
+        case full_path_info
+          when PRECOMPILED_ASSETS_SUBDIR_REGEX
+            lifetime = :year
+            last_modified = CACHE_FRIENDLY_LAST_MODIFIED
+          when '/favicon.ico'
+            lifetime = :month
+            last_modified = CACHE_FRIENDLY_LAST_MODIFIED
+          else
+            lifetime = :day
+        end
+
+        headers = { 'Cache-Control' => "public, max-age=#{SECONDS_IN[lifetime]}" }
+        headers['Last-Modified'] = last_modified if last_modified
+
+        return headers
+      end
+
+      def response_body
+        [::File.read(path)]
+      end
+
+      def self.find_first(options)
+        asset_compiler = options[:asset_compiler]
+        path_info = options[:path_info].chomp('/')
+        
+        return nil if asset_compiler.compiles?(path_info)
+
+        asset_root = options[:asset_root]
+
+        candidate_path_infos = []
+        if !path_info.empty?
+          candidate_path_infos << path_info
+          candidate_path_infos << "#{path_info}#{DEFAULT_STATIC_EXTENSION}"
+        end
+        candidate_path_infos << "#{path_info}/index#{DEFAULT_STATIC_EXTENSION}"
+
+        file_path = nil
+
+        full_path_info = candidate_path_infos.find do |candidate_path_info|
+          file_path = ::File.join(asset_root, candidate_path_info)
+          readable_file?(file_path)
+        end
+
+        return nil if full_path_info.nil? || !has_static_extension?(full_path_info)
+
+        include_gzipped = options[:include_gzipped]
+
+        gzipped_file_path = "#{file_path}.gz"
+        gzipped_file_present = readable_file?(gzipped_file_path)
+
+        has_encoding_variants = gzipped_file_present
+
+        if include_gzipped && gzipped_file_present
+          return ServeableFile.new(
+              :path => gzipped_file_path,
+              :full_path_info => full_path_info,
+              :has_encoding_variants => has_encoding_variants,
+              :is_gzipped => true
+          )
+        end
+
+        return ServeableFile.new(
+            :path => file_path,
+            :full_path_info => full_path_info,
+            :has_encoding_variants => has_encoding_variants
+        )
+      end
+
+      def self.has_static_extension?(path)
+        path =~ AssetServer::STATIC_EXTENSION_REGEX
+      end
+
+      def encoding_variants?
+        return @has_encoding_variants
+      end
+
+      def gzipped?
+        return @is_gzipped
+      end
+
+      def ==(other)
+        return false if other.nil?
+        return true if self.equal?(other)
+        return self.class == other.class &&
+          self.gzipped? == other.gzipped? &&
+          self.encoding_variants? == other.encoding_variants? &&
+          self.path == other.path &&
+          self.full_path_info == other.full_path_info
+      end
+      alias_method :eql?, :==
+
+      private
+
+      # Old last-modified headers encourage caching via browser heuristics. Use it for year-long cached assets.
+      CACHE_FRIENDLY_LAST_MODIFIED = 'Mon, 10 Jan 2005 10:00:00 GMT'
+
+      SECONDS_IN = {
+          :day => 24*60*60,
+          :month => 31*(24*60*60),
+          :year => 365*(24*60*60)
+      }.freeze
+
+      DEFAULT_STATIC_EXTENSION = '.html'.freeze
+
+      def self.readable_file?(file_path)
+        return ::File.file?(file_path) && ::File.readable?(file_path)
+      end
+
+    end
+  end
+end