rack-zippy 2.0.2 → 3.0.0

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.0.0 / 2015-04-18
+- Make static extensions list configurable ([#45](https://github.com/eliotsykes/rack-zippy/pull/45/files)) Anton Petrunich
+
 ## 2.0.2 / 2014-12-15
 - Remove binstub bin/rake permanently, may be causing Heroku issues
 

data/README.md

@@ -85,6 +85,21 @@ Any files given the `max_age_fallback` would have the following `Cache-Control`
 Cache-Control: public, max-age=600
 ```
 
+### Configuration
+
+#### static_extensions
+
+rack-zippy handles only files with whitelisted extensions. Default extensions list: 
+`css js html htm txt ico png jpg jpeg gif pdf svg zip gz eps psd ai woff woff2 ttf eot otf swf`
+
+You can modify this list:
+
+```ruby
+Rack::Zippy.configure do |config|
+  config.static_extensions << 'csv'
+end
+```
+
 ## Troubleshooting
 
 ##### 'assert_index': No such middleware to insert before: ActionDispatch::Static (RuntimeError)
@@ -139,13 +154,14 @@ Cleanup time! When you’re finished testing, delete the local override and set
 - Eliot Sykes https://eliotsykes.com
 - Kieran Topping https://github.com/ktopping
 - Luke Wendling https://github.com/lukewendling
-
+- Anton Petrunich https://github.com/solenko
 
 ## Releasing a new gem
 
 1. Update pre-release version to the release version in `lib/rack-zippy/version.rb`, e.g. `1.0.1.pre` becomes `1.0.1`
 2. Update `CHANGELOG.md` version and date. Update Contributors in `README.md`.
 3. Tests pass? (`rake test`)
+4. Commit and push changes to origin.
 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`.

data/lib/rack-zippy.rb

@@ -1,17 +1,18 @@
 require 'rack-zippy/version'
 require 'rack-zippy/asset_compiler'
 require 'rack-zippy/serveable_file'
+require 'rack-zippy/configuration'
 
 module Rack
   module Zippy
+    extend Configuration
+
+    define_setting :static_extensions, %w(css js html htm txt ico png jpg jpeg gif pdf svg zip gz eps psd ai woff woff2 ttf eot otf swf)
 
     PRECOMPILED_ASSETS_SUBDIR_REGEX = /\A\/assets(?:\/|\z)/
 
     class AssetServer
 
-      # 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, options={})
@@ -46,6 +47,7 @@ module Rack
 
         serveable_file = ServeableFile.find_first(serveable_file_options)
 
+
         if serveable_file
           return [HTTP_STATUS_CODE_OK, serveable_file.headers, serveable_file.response_body]
         end

data/lib/rack-zippy/configuration.rb

@@ -0,0 +1,37 @@
+module Rack
+  module Zippy
+    module Configuration
+      def configure
+        yield self
+      end
+
+      def define_setting(name, default = nil)
+        default_copy = begin
+                         default.dup
+        rescue TypeError
+                         default
+        end
+        class_variable_set("@@#{name}", default_copy)
+
+        define_class_method "#{name}=" do |value|
+          class_variable_set("@@#{name}", value)
+        end
+        define_class_method name do
+          class_variable_get("@@#{name}")
+        end
+        define_class_method "reset_#{name}" do
+          class_variable_set("@@#{name}", default)
+        end
+      end
+
+      private
+
+      def define_class_method(name, &block)
+        (class << self; self; end).instance_eval do
+          define_method name, &block
+        end
+      end
+
+    end
+  end
+end

data/lib/rack-zippy/serveable_file.rb

@@ -94,7 +94,7 @@ module Rack
       end
 
       def self.has_static_extension?(path)
-        path =~ AssetServer::STATIC_EXTENSION_REGEX
+        Rack::Zippy.static_extensions.include? ::File.extname(path).slice(1..-1).to_s.downcase
       end
 
       def encoding_variants?

data/lib/rack-zippy/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Zippy
-    VERSION = '2.0.2'
+    VERSION = '3.0.0'
   end
 end

data/test/asset_server_test.rb

@@ -39,10 +39,6 @@ module Rack
         assert_responds_with_html_file '', 'public/index.html'
       end
 
-      def test_static_extension_regexp_available_in_established_constant_for_monkey_patching
-        assert AssetServer.const_defined?(:STATIC_EXTENSION_REGEX)
-      end
-
       def test_rails_asset_compiler_set_when_rails_environment_detected
         assert_equal RailsAssetCompiler, app.send(:asset_compiler).class
       end
@@ -346,4 +342,4 @@ module Rack
 
     end
   end
-end
+end

data/test/configuration_test.rb

@@ -0,0 +1,62 @@
+require_relative 'test_helper'
+
+module Rack
+  module Zippy
+    class ConfigurationTest < TestCase
+
+      def setup
+        Rack::Zippy.const_set(:ConfiguredClass, Class.new)
+        ConfiguredClass.extend Configuration
+      end
+
+      def teardown
+        Rack::Zippy.send(:remove_const, :ConfiguredClass)
+      end
+
+
+      def setting_name
+        'test_setting'
+      end
+
+      def test_define_setting_create_setter_method
+        ConfiguredClass.define_setting setting_name
+        assert ConfiguredClass.respond_to? "#{setting_name}="
+      end
+
+      def test_define_setting_create_getter_method
+        ConfiguredClass.define_setting setting_name
+        assert ConfiguredClass.respond_to? setting_name
+      end
+
+      def test_define_setting_create_reset_method
+        ConfiguredClass.define_setting setting_name
+        assert ConfiguredClass.respond_to? "reset_#{setting_name}"
+      end
+
+      def test_define_setting_can_handle_not_clonable_default_values
+        ConfiguredClass.define_setting setting_name, :singleton_type_instance
+        assert_equal ConfiguredClass.test_setting, :singleton_type_instance
+      end
+
+      def test_reset_setting_to_default_value
+        ConfiguredClass.define_setting 'test_setting', 'default_value'
+        ConfiguredClass.test_setting = 'new_value'
+        ConfiguredClass.reset_test_setting
+        assert_equal ConfiguredClass.test_setting, 'default_value'
+      end
+
+      def test_setter_store_config_value
+        ConfiguredClass.define_setting 'test_setting', 'default_value'
+        ConfiguredClass.test_setting = 'new_value'
+        assert_equal ConfiguredClass.test_setting, 'new_value'
+      end
+
+      def test_reset_setting_if_default_value_passed_by_reference
+        ConfiguredClass.define_setting 'test_setting', [1]
+        ConfiguredClass.test_setting << 2
+        ConfiguredClass.reset_test_setting
+        assert_equal ConfiguredClass.test_setting, [1]
+      end
+    end
+  end
+end

data/test/serveable_file_test.rb

@@ -14,6 +14,7 @@ module Rack
 
       def teardown
         revert_to_original_working_directory
+        Rack::Zippy.reset_static_extensions
       end
 
       def test_day_long_cache_headers_for_root_html_requests
@@ -467,6 +468,12 @@ module Rack
                "Should handle flash .swf files"
       end
 
+      def test_has_static_extension_returns_true_for_configured_extension
+        Rack::Zippy.static_extensions << 'csv'
+        assert ServeableFile.has_static_extension?('/static-file.csv'),
+               "Should handle files with user configured extensions"
+      end
+
       private
 
       def assert_last_modified(headers, expected)
@@ -484,4 +491,4 @@ module Rack
 
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-zippy
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2015-04-18 00:00:00.000000000 Z
 dependencies: []
 description: Rack middleware for serving static gzipped assets generated by the Rails
   asset pipeline
@@ -28,10 +28,12 @@ files:
 - Rakefile
 - lib/rack-zippy.rb
 - lib/rack-zippy/asset_compiler.rb
+- lib/rack-zippy/configuration.rb
 - lib/rack-zippy/serveable_file.rb
 - lib/rack-zippy/version.rb
 - rack-zippy.gemspec
 - test/asset_server_test.rb
+- test/configuration_test.rb
 - test/null_asset_compiler_test.rb
 - test/public/assets/application.css
 - test/public/assets/application.css.gz
@@ -65,7 +67,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2483500908093930156
+      hash: -1760946869363206133
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -74,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2483500908093930156
+      hash: -1760946869363206133
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23.2
@@ -84,6 +86,7 @@ summary: Rack middleware for serving static gzipped assets generated by the Rail
   asset pipeline
 test_files:
 - test/asset_server_test.rb
+- test/configuration_test.rb
 - test/null_asset_compiler_test.rb
 - test/public/assets/application.css
 - test/public/assets/application.css.gz