rack-combobot 0.1.0 → 0.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-combobot (0.0.3)
+    rack-combobot (0.2.0)
       rack
       rake
 

data/README.md

@@ -6,10 +6,35 @@ Asset combinator for rack
 
 `gem install rack-combobot`
 
+## Path
+
+Point your frontend to `/combobot?script1.js&script2.js` to get script1.js and script2.js combined.
+
+### Usage in Rack apps (config.ru)
+
+```ruby
+require 'rack'
+require 'rack-combobot'
+require 'my-app'
+
+use Rack::Combobot, :root => '/public'
+run MyApp
+```
+
 ### Usage in Rails apps
 
-In your routes.rb file add the following route
+In your config/application.rb
 
 ```ruby
-match '/combobot', :to => Rack::Combobot.configure(:root => RAILS_ROOT + "/public")
+config.middleware.use 'Rack::Combobot', :root => "#{Rails.root}/public"
 ```
+
+### Expires header
+
+Add expires header by like so
+
+```ruby
+config.middleware.use 'Rack::Combobot', :root => "#{Rails.root}/public", :expires => Time.gm(2020)
+```
+
+To bust the cache, simple add a unique string to your request like so `/combobot/BUSTINGSRING?script1.js&script2.js`.

data/lib/rack/combobot.rb

@@ -8,6 +8,8 @@ require "uri"
 module Rack
   class Combobot
 
+    attr_reader :config
+
     MIME_TYPES = {
       "js"  => "text/javascript",
       "css" => "text/css"
@@ -17,12 +19,13 @@ module Rack
       @app = app
 
       root = Pathname.new(options[:root] || Dir.pwd)
-      @config = Rack::Combobot::Config.new(root)
+      expires = options[:expires]
+      @config = Rack::Combobot::Config.new(root, expires)
     end
 
     # rack request handler
     def call(env)
-      if Rack::Request.new(env).path == '/combobot'
+      if Rack::Request.new(env).path =~ /^\/combobot/
         combine(env)
       else
         @app.call(env)
@@ -35,16 +38,27 @@ module Rack
 
       return not_found if file_names.empty?
 
-      extension   = file_names[0].split(".").last
+      extension = file_names[0].split(".").last
+      headers   = create_headers(extension)
 
       begin
         combo = Combination.new(@config.root, file_names).combine
-        [200, {"Content-Type" => MIME_TYPES[extension]}, [combo]]
+        [200, headers, [combo]]
       rescue Combination::PathError
         not_found
       end
     end
 
+    def create_headers(extension)
+      headers = {"Content-Type" => MIME_TYPES[extension]}
+
+      if @config.expires
+        headers['Expires'] = @config.expires.httpdate
+      end
+
+      headers
+    end
+
     def not_found
       [404, {'Content-Type' => 'text/html'}, ['File not found']]
     end

data/lib/rack/combobot/config.rb

@@ -1,18 +1,13 @@
 module Rack
   class Combobot
     class Config
-      def initialize(root)
-        @cache = []
+      attr_accessor :root, :expires
+
+      def initialize(root, expires = nil)
         @root = root
+        @expires = expires
       end
 
-      def cache(*names)
-        @cache.concat(names)
-      end
-      
-      def root
-        @root
-      end
     end
   end
 end

data/rack-combobot.gemspec

@@ -4,7 +4,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "rack-combobot"
-  s.version     = "0.1.0"
+  s.version     = "0.2.0"
   s.authors     = ["Simon Højberg", "Christopher Meiklejohn"]
   s.email       = ["r.hackr@gmail.com", "christopher.meiklejohn@gmail.com"]
   s.homepage    = "https://github.com/hojberg/rack-combobot"

data/spec/lib/rack/combobot_spec.rb

@@ -11,24 +11,26 @@ describe Rack::Combobot do
     @app = Rack::Combobot.new(dummy_app, :root => File.dirname(__FILE__) + '/../../public')
   end
 
-  describe 'routing' do
-
-    # request helpers
-    let(:combobot_request)        { { 'PATH_INFO' => '/combobot' } }
-    let(:combobot_js_request)     { combobot_request.merge({ "QUERY_STRING" => "js1.js&js2.js" })       }
-    let(:combobot_css_request)    { combobot_request.merge({ "QUERY_STRING" => "css1.css&css2.css" })   }
-    let(:combobot_404_request)    { combobot_request.merge({ "QUERY_STRING" => "js3.js&js4.js" })       }
-    let(:combobot_hack_request)   { combobot_request.merge({ "QUERY_STRING" => "js3.js&../../js4.js" }) }
+  # request helpers
+  let(:combobot_request)        { { 'PATH_INFO' => '/combobot' } }
+  let(:combobot_js_request)     { combobot_request.merge({ "QUERY_STRING" => "js1.js&js2.js" })       }
+  let(:combobot_css_request)    { combobot_request.merge({ "QUERY_STRING" => "css1.css&css2.css" })   }
+  let(:combobot_404_request)    { combobot_request.merge({ "QUERY_STRING" => "js3.js&js4.js" })       }
+  let(:combobot_hack_request)   { combobot_request.merge({ "QUERY_STRING" => "js3.js&../../js4.js" }) }
 
-    # response helpers
-    let(:combobot_js_response)    { [200, {"Content-Type" => "text/javascript"}, ["function lorem() { return \"a\"; }\nfunction ipsum() { return \"b\"; }\n"]] }
-    let(:combobot_css_response)   { [200, {"Content-Type" => "text/css"}, [".lorem { background: blue; }\n#lipsum { border: 1px solid red }\n"]] }
-    let(:combobot_404_response)   { [404, {'Content-Type' => 'text/html'}, ['File not found']] }
+  # response helpers
+  let(:combobot_js_response)    { [200, {"Content-Type" => "text/javascript"}, ["function lorem() { return \"a\"; }\nfunction ipsum() { return \"b\"; }\n"]] }
+  let(:expires_js_response)     { [200, {"Content-Type" => "text/javascript", 'Expires' => 'Wed, 01 Jan 2020 00:00:00 GMT'}, ["function lorem() { return \"a\"; }\nfunction ipsum() { return \"b\"; }\n"]] }
+  let(:combobot_css_response)   { [200, {"Content-Type" => "text/css"}, [".lorem { background: blue; }\n#lipsum { border: 1px solid red }\n"]] }
+  let(:combobot_404_response)   { [404, {'Content-Type' => 'text/html'}, ['File not found']] }
 
+  describe 'routing' do
     it 'should not respond to anything other than "/combobot"' do
       @app.call({}).must_equal(dummy_app_response)
     end
+  end
 
+  describe 'combination' do
     it "combines javascript" do
       @app.call(combobot_js_request).must_equal(combobot_js_response)
     end
@@ -36,7 +38,9 @@ describe Rack::Combobot do
     it "combines css" do
       @app.call(combobot_css_request).must_equal(combobot_css_response)
     end
+  end
 
+  describe 'error handling' do
     it "returns 404 when it can't find files" do
       @app.call(combobot_404_request).must_equal(combobot_404_response)
     end
@@ -46,4 +50,22 @@ describe Rack::Combobot do
     end
   end
 
+  describe 'caching' do
+
+    it 'adds expires headers' do
+      @app.config.expires = Time.gm(2020)
+      @app.call(combobot_js_request).must_equal(expires_js_response)
+    end
+
+    it 'allows for versioning' do
+      @app.call(
+        combobot_js_request.merge({ 'PATH_INFO' => '/combobot/CACHEBUSTINGSHA1'})
+      ).must_equal(combobot_js_response)
+
+      @app.call(
+        combobot_js_request.merge({ 'PATH_INFO' => '/combobot/CACHEBUSTINGSHA2'})
+      ).must_equal(combobot_js_response)
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-combobot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-14 00:00:00.000000000 Z
+date: 2012-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153707180 !ruby/object:Gem::Requirement
+  requirement: &2156803500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153707180
+  version_requirements: *2156803500
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2153706740 !ruby/object:Gem::Requirement
+  requirement: &2156803060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153706740
+  version_requirements: *2156803060
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2153706320 !ruby/object:Gem::Requirement
+  requirement: &2156802640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153706320
+  version_requirements: *2156802640
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2153705900 !ruby/object:Gem::Requirement
+  requirement: &2156802220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153705900
+  version_requirements: *2156802220
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &2153705480 !ruby/object:Gem::Requirement
+  requirement: &2156801800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153705480
+  version_requirements: *2156801800
 - !ruby/object:Gem::Dependency
   name: guard-minitest
-  requirement: &2153705060 !ruby/object:Gem::Requirement
+  requirement: &2156801380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153705060
+  version_requirements: *2156801380
 description: combines assets to server 1 file
 email:
 - r.hackr@gmail.com