sinatra-bundles 0.1.3 → 0.2.0

data/README.md

@@ -3,7 +3,6 @@ sinatra-bundles
 
 An easy way to bundle CSS and Javascript assets in your sinatra application.
 
-* Tests: [http://runcoderun.com/darkhelmet/sinatra-bundles](http://runcoderun.com/darkhelmet/sinatra-bundles)
 * Documentation: [http://yardoc.org/docs/darkhelmet-sinatra-bundles](http://yardoc.org/docs/darkhelmet-sinatra-bundles)
 
 Usage
@@ -36,24 +35,35 @@ And include it in your app:
       'sinatra-bundles rocks!'
     end
 
-That sinatra is version 0.10.1, so you'll have to grab it from source and install it that way, since it's not out yet.
-
 Then in your view, you can use the view helpers to insert the proper script tags:
 
     = javascript_bundle_include_tag(:all)
     = stylesheet_bundle_link_tag(:all)
 
-All 6 of those files will be served up in 2 files, and they'll be compressed and have headers set for caching.
+All 6 of those files will be served up in 2 files, and they'll be compressed and have headers and etags set for caching.
+
+You can also use wildcard splats.
+
+    = javascript_bundle(:test, %w(test/*))
+
+That will grab all files in the test directory.
+
+    = javascript_bundle(:test, %w(test/**/*))
+
+That will grab all files under the test directory recursively. If you don't specify any files, it defaults to 'all files' recursively.
+
+    = javascript_bundle(:all)
 
 Configuration
 -------------
 
 The defaults are pretty good. In development/test mode:
 
-    bundle_cache_time # => 60 * 60 * 24 * 365, or 1 year
-    compress_bundles # => false
-    cache_bundles # => false
-    stamp_bundles # => true
+    bundle_cache_time # => 60 * 60 * 24 * 365, or 1 year (length of time a bundle will be cached for)
+    compress_bundles # => false (compress CSS and Javascript using packr and rainpress)
+    cache_bundles # => false (set caching headers)
+    stamp_bundles # => true (append a timestamp to the URL as a query param)
+    warm_bundle_cache # => false (generate bundle when it is defined)
 
 And in production mode, compression and caching are enabled
 
@@ -85,12 +95,10 @@ Check out the code for my blog for a real example: [darkblog on github](http://g
 What you Need
 -------------
 
-    sinatra >= 0.10.1 (edge)
+    sinatra >= 1.0
     packr
     rainpress
 
-packr and rainpress are dependencies, but sinatra isn't, since version 0.10.1 isn't out yet, and you have to download the source manually.
-
 Note on Patches/Pull Requests
 -----------------------------
 
@@ -102,6 +110,13 @@ Note on Patches/Pull Requests
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
+Thanks!
+-------
+
+* [Patrick Hogan](http://github.com/pbhogan)
+** Etag support (with specs!)
+** Wildcard globbing
+
 Copyright
 ---------
 

data/Rakefile

@@ -13,7 +13,7 @@ begin
     gem.add_dependency 'rainpress', '>= 0'
     gem.add_dependency 'packr', '>= 0'
     gem.add_dependency 'rack', '>= 1.0'
-    gem.add_dependency 'sinatra', '>= 1.0.a'
+    gem.add_dependency 'sinatra', '>= 1.0'
     gem.add_development_dependency 'rspec', '>= 1.2.9'
     gem.add_development_dependency 'rack-test', '>= 0.5.3'
     gem.add_development_dependency 'yard', '>= 0'

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.2.0

data/lib/sinatra/bundles.rb

@@ -11,7 +11,7 @@ module Sinatra
     # @param [Symbol,String] key The bundle name
     # @param [Array(String)] files The list of filenames, without extension,
     #   assumed to be in the public directory, under 'javascripts'
-    def javascript_bundle(key, files)
+    def javascript_bundle(key, files = nil)
       javascript_bundles[key] = JavascriptBundle.new(self, files)
     end
 
@@ -20,7 +20,7 @@ module Sinatra
     # @param [Symbol,String] key The bundle name
     # @param [Array(String)] files The list of filenames, without extension,
     #   assumed to be in the public directory, under 'stylesheets'
-    def stylesheet_bundle(key, files)
+    def stylesheet_bundle(key, files = nil)
       stylesheet_bundles[key] = StylesheetBundle.new(self, files)
     end
 
@@ -34,6 +34,7 @@ module Sinatra
       app.disable(:compress_bundles)
       app.disable(:cache_bundles)
       app.enable(:stamp_bundles)
+      app.enable(:warm_bundle_cache)
 
       # Production defaults
       app.configure :production do
@@ -46,15 +47,21 @@ module Sinatra
       app.get('/stylesheets/bundles/:bundle.css') do |bundle|
         content_type('text/css')
         headers['Vary'] = 'Accept-Encoding'
-        expires(options.bundle_cache_time, :public, :must_revalidate) if options.cache_bundles
-        options.stylesheet_bundles[bundle.intern]
+        if options.cache_bundles
+          expires(options.bundle_cache_time, :public, :must_revalidate)
+          etag(options.stylesheet_bundles[bundle.intern].etag)
+        end
+        options.stylesheet_bundles[bundle.intern].content
       end
 
       app.get('/javascripts/bundles/:bundle.js') do |bundle|
         content_type('text/javascript; charset=utf-8')
         headers['Vary'] = 'Accept-Encoding'
-        expires(options.bundle_cache_time, :public, :must_revalidate) if options.cache_bundles
-        options.javascript_bundles[bundle.intern]
+        if options.cache_bundles
+          expires(options.bundle_cache_time, :public, :must_revalidate)
+          etag(options.javascript_bundles[bundle.intern].etag)
+        end
+        options.javascript_bundles[bundle.intern].content
       end
     end
   end

data/lib/sinatra/bundles/bundle.rb

@@ -1,12 +1,34 @@
+require 'digest'
+
 module Sinatra
   module Bundles
     # The base class for a bundle of files.
     # The developer user sinatra-bundles should
     # never have to deal with this directly
     class Bundle
-      def initialize(app, files)
+      include Enumerable
+
+      def initialize(app, files = nil)
         @app = app
-        @files = files
+        @files = Array.new
+        files ||= ['**/*']
+        files.each do |f|
+          full_path = path(f)
+          if File.file?(full_path)
+            @files << f
+          else
+            dir = File.dirname(full_path)
+            ext = File.extname(full_path)
+            Dir[full_path].each do |file|
+              if File.exists?(file)
+                file.chomp!(ext).gsub!("#{root}/", '')
+                @files << file
+              end
+            end
+          end
+        end
+        @files.uniq!
+        etag if @app.warm_bundle_cache
       end
 
       # Since we pass Bundles back as the body,
@@ -21,8 +43,34 @@ module Sinatra
         end
       end
 
-    private
+      # Returns the bundled content.
+      # Cached in a local variable to prevent rebundling on future requests.
+      def content
+        rebundle if needs_rebundle?
+        @content ||= self.to_a.join
+      end
+
+      # Returns an etag for the bundled content.
+      # Cached in a local variable to prevent recomputing on future requests.
+      def etag
+        rebundle if needs_rebundle?
+        @etag ||= Digest::MD5.hexdigest(content)
+      end
+
+      # Returns true if the content needs to be rebundled
+      def needs_rebundle?
+        # Right now compression is the only option that requires rebundling
+        @options_hash != @app.compress_bundles
+      end
 
+      # Clear local variable caches effectively causing rebundling
+      def rebundle
+        @content = nil
+        @etag = nil
+        @options_hash = @app.compress_bundles
+      end
+
+    private
       # The timestamp of the bundle, which is the newest file in the bundle.
       #
       # @return [Integer] The timestamp of the bundle

data/lib/sinatra/bundles/helpers.rb

@@ -14,8 +14,8 @@ module Sinatra
       #
       # @param [Symbol,String] bundle The bundle name
       # @return [String] HTML link tag
-      def stylesheet_bundle_link_tag(bundle)
-        options.stylesheet_bundles[bundle].to_html(bundle)
+      def stylesheet_bundle_link_tag(bundle, media = nil)
+        options.stylesheet_bundles[bundle].to_html(bundle, media)
       end
     end
   end

data/lib/sinatra/bundles/javascript_bundle.rb

@@ -15,6 +15,11 @@ module Sinatra
 
     protected
 
+      # The root of these bundles, for path purposes
+      def root
+        File.join(@app.public, 'javascripts')
+      end
+
       # Compress Javascript
       #
       # @param [String] js The Javascript to compress
@@ -30,7 +35,7 @@ module Sinatra
       #   assumed to be in the public directory, under 'javascripts'
       # @return [String] The full path to the file
       def path(filename)
-        File.join(@app.public, 'javascripts', "#{filename}.js")
+        File.join(root, "#{filename}.js")
       end
     end
   end

data/lib/sinatra/bundles/stylesheet_bundle.rb

@@ -9,12 +9,19 @@ module Sinatra
       #
       # @param [String] name The name of a bundle
       # @return [String] The HTML that can be inserted into the doc
-      def to_html(name)
-        "<link type='text/css' href='/stylesheets/bundles/#{name}.css#{@app.stamp_bundles ? "?#{stamp}" : ''}' rel='stylesheet' media='screen' />"
+      def to_html(name, media = nil)
+        media ||= :all
+        media = media.join(", ") if media.is_a? Array
+        "<link type='text/css' href='/stylesheets/bundles/#{name}.css#{@app.stamp_bundles ? "?#{stamp}" : ''}' rel='stylesheet' media='#{media}' />"
       end
 
     protected
 
+      # The root of these bundles, for path purposes
+      def root
+        File.join(@app.public, 'stylesheets')
+      end
+
       # Compress CSS
       #
       # @param [String] css The CSS to compress

data/sinatra-bundles.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra-bundles}
-  s.version = "0.1.3"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Huckstep"]
-  s.date = %q{2010-02-28}
+  s.date = %q{2010-04-02}
   s.description = %q{Bundle CSS and Javascript assets to a single file, compress, and cache them for snappier web experiences.}
   s.email = %q{darkhelmet@darkhelmetlive.com}
   s.extra_rdoc_files = [
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
      "spec/app.rb",
      "spec/production_app.rb",
      "spec/public/javascripts/eval.js",
+     "spec/public/javascripts/splat/splat.js",
      "spec/public/javascripts/test1.js",
      "spec/public/javascripts/test2.js",
      "spec/public/stylesheets/test1.css",
@@ -60,7 +61,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<rainpress>, [">= 0"])
       s.add_runtime_dependency(%q<packr>, [">= 0"])
       s.add_runtime_dependency(%q<rack>, [">= 1.0"])
-      s.add_runtime_dependency(%q<sinatra>, [">= 1.0.a"])
+      s.add_runtime_dependency(%q<sinatra>, [">= 1.0"])
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_development_dependency(%q<rack-test>, [">= 0.5.3"])
       s.add_development_dependency(%q<yard>, [">= 0"])
@@ -68,7 +69,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rainpress>, [">= 0"])
       s.add_dependency(%q<packr>, [">= 0"])
       s.add_dependency(%q<rack>, [">= 1.0"])
-      s.add_dependency(%q<sinatra>, [">= 1.0.a"])
+      s.add_dependency(%q<sinatra>, [">= 1.0"])
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<rack-test>, [">= 0.5.3"])
       s.add_dependency(%q<yard>, [">= 0"])
@@ -77,7 +78,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rainpress>, [">= 0"])
     s.add_dependency(%q<packr>, [">= 0"])
     s.add_dependency(%q<rack>, [">= 1.0"])
-    s.add_dependency(%q<sinatra>, [">= 1.0.a"])
+    s.add_dependency(%q<sinatra>, [">= 1.0"])
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
     s.add_dependency(%q<rack-test>, [">= 0.5.3"])
     s.add_dependency(%q<yard>, [">= 0"])

data/spec/app.rb

@@ -7,5 +7,7 @@ class TestApp < Sinatra::Base
   register Sinatra::Bundles
 
   stylesheet_bundle(:test, %w(test1 test2))
-  javascript_bundle(:test, %w(test1 test2 eval))
+  javascript_bundle(:test, %w(eval test1 test2))
+  javascript_bundle(:test2, %w(test*))
+  javascript_bundle(:all)
 end

data/spec/public/javascripts/splat/splat.js

@@ -0,0 +1,5 @@
+function splat() {
+  alert('splat');
+}
+
+splat();

data/spec/sinatra-bundles_spec.rb

@@ -29,7 +29,7 @@ describe 'sinatra-bundles' do
   end
 
   before do
-    @scripts = %w(test1 test2 eval).map do |name|
+    @scripts = %w(eval splat/splat test1 test2).map do |name|
       File.expand_path(File.join(File.dirname(__FILE__), 'public', 'javascripts', "#{name}.js"))
     end
 
@@ -76,9 +76,9 @@ describe 'sinatra-bundles' do
 
   context 'javascript bundles' do
     it 'should be able to set bundles' do
-      app.javascript_bundle(:all, %w(foo bar baz))
+      app.javascript_bundle(:foo, %w(foo bar baz))
       app.javascript_bundles.should_not == {}
-      app.javascript_bundles[:all].should be_a_kind_of(Sinatra::Bundles::Bundle)
+      app.javascript_bundles[:foo].should be_a_kind_of(Sinatra::Bundles::Bundle)
     end
 
     it 'should create a tag without a stamp if stamps are disabled' do
@@ -101,7 +101,7 @@ describe 'sinatra-bundles' do
 
     it 'should concat files in order with newlines including one at the end' do
       get '/javascripts/bundles/test.js'
-      last_response.body.should == @scripts.map { |path| File.read(path) }.join("\n") + "\n"
+      last_response.body.should == @scripts.reject { |s| s.include?('splat') }.map { |path| File.read(path) }.join("\n") + "\n"
     end
 
     it 'should set cache headers' do
@@ -110,6 +110,7 @@ describe 'sinatra-bundles' do
       last_response.should be_ok
       last_response.headers['Vary'].should == 'Accept-Encoding'
       last_response.headers['Cache-Control'].should == 'public, must-revalidate, max-age=31536000'
+      last_response.headers['Etag'].should == '"4f647cfd3ab71800da1b0d0b127e2cd4"'
     end
 
     it 'should not shrink vars on javascript files that use eval' do
@@ -120,6 +121,19 @@ describe 'sinatra-bundles' do
       last_response.body.include?(Packr.pack(js)).should be_true
       last_response.body.include?(Packr.pack(js, :shrink_vars => true)).should be_false
     end
+
+    it 'should handle wildcard splats for bundles' do
+      get '/javascripts/bundles/test2.js'
+      last_response.should be_ok
+      last_response.body.include?('eval').should be_false
+      last_response.body.should == @scripts.reject { |s| s.match(/eval|splat/) }.map { |path| File.read(path) }.join("\n") + "\n"
+    end
+
+    it 'should handle the all scripts wildcard' do
+      get '/javascripts/bundles/all.js'
+      last_response.should be_ok
+      last_response.body.should == @scripts.map { |path| File.read(path) }.join("\n") + "\n"
+    end
   end
 
   context 'stylesheet bundles' do
@@ -133,13 +147,25 @@ describe 'sinatra-bundles' do
       app.new.instance_eval do
         options.disable(:stamp_bundles)
         stylesheet_bundle_link_tag(:test)
-      end.should == "<link type='text/css' href='/stylesheets/bundles/test.css' rel='stylesheet' media='screen' />"
+      end.should == "<link type='text/css' href='/stylesheets/bundles/test.css' rel='stylesheet' media='all' />"
     end
 
     it 'should stamp bundles with the timestamp of the newest file in the bundle' do
       app.new.instance_eval do
         stylesheet_bundle_link_tag(:test)
-      end.should == "<link type='text/css' href='/stylesheets/bundles/test.css?#{css_stamp(%w(test1 test2))}' rel='stylesheet' media='screen' />"
+      end.should == "<link type='text/css' href='/stylesheets/bundles/test.css?#{css_stamp(%w(test1 test2))}' rel='stylesheet' media='all' />"
+    end
+
+    it 'should create a tag with default media attribute set to all' do
+      app.new.instance_eval do
+        stylesheet_bundle_link_tag(:test)
+      end.include?("media='all'").should be_true
+    end
+
+    it 'should create a tag with specified media attributes' do
+      app.new.instance_eval do
+        stylesheet_bundle_link_tag(:test, [:screen, :print])
+      end.include?("media='screen, print'").should be_true
     end
 
     it 'should serve bundles' do
@@ -158,6 +184,7 @@ describe 'sinatra-bundles' do
       last_response.should be_ok
       last_response.headers['Vary'].should == 'Accept-Encoding'
       last_response.headers['Cache-Control'].should == 'public, must-revalidate, max-age=31536000'
+      last_response.headers['Etag'].should == '"6ecd0946412b76dcd1eaa341cdfefa8b"'
     end
   end
 end

data/spec/spec_helper.rb

@@ -6,7 +6,12 @@ require 'spec'
 require 'spec/autorun'
 require 'rack/test'
 
-gem 'sinatra', '>= 1.0.a'
+begin
+  require 'ruby-debug'
+rescue LoadError
+end
+
+gem 'sinatra', '>= 1.0'
 require 'sinatra/base'
 require 'sinatra/bundles'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra-bundles
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors: 
 - Daniel Huckstep
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-28 00:00:00 -07:00
+date: 2010-04-02 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,7 +50,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.a
+        version: "1.0"
     version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -107,6 +107,7 @@ files:
 - spec/app.rb
 - spec/production_app.rb
 - spec/public/javascripts/eval.js
+- spec/public/javascripts/splat/splat.js
 - spec/public/javascripts/test1.js
 - spec/public/javascripts/test2.js
 - spec/public/stylesheets/test1.css