sinatra-bundles 0.2.0 → 0.3.0

data/README.md

@@ -114,8 +114,10 @@ Thanks!
 -------
 
 * [Patrick Hogan](http://github.com/pbhogan)
-** Etag support (with specs!)
-** Wildcard globbing
+  * Etag support (with specs!)
+  * Wildcard globbing
+* [docunext](http://github.com/docunext)
+  * Custom path prefixes for bundles (instead of 'javascripts' and 'stylesheets')
 
 Copyright
 ---------

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/sinatra/bundles.rb

@@ -1,10 +1,11 @@
 module Sinatra
   # Main Bundles Module
   module Bundles
-    autoload :Helpers, 'sinatra/bundles/helpers'
-    autoload :Bundle, 'sinatra/bundles/bundle'
-    autoload :JavascriptBundle, 'sinatra/bundles/javascript_bundle'
-    autoload :StylesheetBundle, 'sinatra/bundles/stylesheet_bundle'
+    mypath = File.dirname(__FILE__)
+    autoload :Helpers, "#{mypath}/bundles/helpers"
+    autoload :Bundle, "#{mypath}/bundles/bundle"
+    autoload :JavascriptBundle, "#{mypath}/bundles/javascript_bundle"
+    autoload :StylesheetBundle, "#{mypath}/bundles/stylesheet_bundle"
 
     # Set a Javascript bundle
     #    javascript_bundle(:all, %w(jquery lightbox))
@@ -25,43 +26,47 @@ module Sinatra
     end
 
     def self.registered(app)
-      # Setup empty bundle containers
-      app.set(:javascript_bundles, {})
-      app.set(:stylesheet_bundles, {})
-
       # Setup defaults
-      app.set(:bundle_cache_time, 60 * 60 * 24 * 365)
-      app.disable(:compress_bundles)
-      app.disable(:cache_bundles)
-      app.enable(:stamp_bundles)
-      app.enable(:warm_bundle_cache)
+      app.set({
+        :javascript_bundles => {},
+        :stylesheet_bundles => {},
+        :bundle_cache_time => 60 * 60 * 24 * 365,
+        :stylesheets => lambda { app.respond_to?(:css) ? app.css : 'stylesheets' },
+        :javascripts => lambda { app.respond_to?(:js) ? app.js : 'javascripts' },
+        :compress_bundles => false,
+        :cache_bundles => false,
+        :stamp_bundles => true,
+        :warm_bundle_cache => true
+      })
 
       # Production defaults
       app.configure :production do
-        app.enable(:compress_bundles)
-        app.enable(:cache_bundles)
+        app.set({
+          :compress_bundles => true,
+          :cache_bundles => true
+        })
       end
 
       app.helpers(Helpers)
 
-      app.get('/stylesheets/bundles/:bundle.css') do |bundle|
+      app.get(%r{/#{Regexp.quote(app.stylesheets)}/bundles/(\w+)(?:/(\d+))?\.css}) do |bundle, stamp| # Don't really care about the stamp.
         content_type('text/css')
         headers['Vary'] = 'Accept-Encoding'
-        if options.cache_bundles
-          expires(options.bundle_cache_time, :public, :must_revalidate)
-          etag(options.stylesheet_bundles[bundle.intern].etag)
+        if settings.cache_bundles
+          expires(settings.bundle_cache_time, :public, :must_revalidate)
+          etag(settings.stylesheet_bundles[bundle.intern].etag)
         end
-        options.stylesheet_bundles[bundle.intern].content
+        settings.stylesheet_bundles[bundle.intern].content
       end
 
-      app.get('/javascripts/bundles/:bundle.js') do |bundle|
+      app.get(%r{/#{Regexp.quote(app.javascripts)}/bundles/(\w+)(?:/(\d+))?\.js}) do |bundle, stamp| # Don't really care about the stamp.
         content_type('text/javascript; charset=utf-8')
         headers['Vary'] = 'Accept-Encoding'
-        if options.cache_bundles
-          expires(options.bundle_cache_time, :public, :must_revalidate)
-          etag(options.javascript_bundles[bundle.intern].etag)
+        if settings.cache_bundles
+          expires(settings.bundle_cache_time, :public, :must_revalidate)
+          etag(settings.javascript_bundles[bundle.intern].etag)
         end
-        options.javascript_bundles[bundle.intern].content
+        settings.javascript_bundles[bundle.intern].content
       end
     end
   end

data/lib/sinatra/bundles/bundle.rb

@@ -10,14 +10,13 @@ module Sinatra
 
       def initialize(app, files = nil)
         @app = app
-        @files = Array.new
+        @files = []
         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)
@@ -60,25 +59,30 @@ module Sinatra
       # 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
+        @options_hash != options_hash.hash
       end
 
       # Clear local variable caches effectively causing rebundling
       def rebundle
         @content = nil
         @etag = nil
-        @options_hash = @app.compress_bundles
+        @options_hash = options_hash.hash
       end
 
     private
+      def options_hash
+        {
+          :compress => @app.compress_bundles,
+          :stamp => stamp
+        }
+      end
+
       # The timestamp of the bundle, which is the newest file in the bundle.
       #
       # @return [Integer] The timestamp of the bundle
       def stamp
-        @files.map do |f|
-          File.mtime(path(f))
-        end.sort.first.to_i
+        @files.map { |f| File.mtime(path(f)) }.sort.last.to_i
       end
     end
   end
-end
+end

data/lib/sinatra/bundles/helpers.rb

@@ -7,15 +7,15 @@ module Sinatra
       # @param [Symbol,String] bundle The bundle name
       # @return [String] HTML script tag
       def javascript_bundle_include_tag(bundle)
-        options.javascript_bundles[bundle].to_html(bundle)
+        settings.javascript_bundles[bundle].to_html(bundle)
       end
 
       # Emit a script tag for a stylesheet bundle
       #
       # @param [Symbol,String] bundle The bundle name
       # @return [String] HTML link tag
-      def stylesheet_bundle_link_tag(bundle, media = nil)
-        options.stylesheet_bundles[bundle].to_html(bundle, media)
+      def stylesheet_bundle_link_tag(bundle, media = :all)
+        settings.stylesheet_bundles[bundle].to_html(bundle, media)
       end
     end
   end

data/lib/sinatra/bundles/javascript_bundle.rb

@@ -1,4 +1,3 @@
-require 'sinatra/bundles/bundle'
 require 'packr'
 
 module Sinatra
@@ -10,14 +9,16 @@ 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)
-        "<script type='text/javascript' src='/javascripts/bundles/#{name}.js#{@app.stamp_bundles ? "?#{stamp}" : ''}'></script>"
+        prefix = "/#{@app.javascripts}/bundles"
+        src = @app.stamp_bundles ? "#{prefix}/#{name}/#{stamp}.js" : "#{prefix}/#{name}.js"
+        "<script type='text/javascript' src='#{src}'></script>"
       end
 
     protected
 
       # The root of these bundles, for path purposes
       def root
-        File.join(@app.public, 'javascripts')
+        File.join(@app.public, @app.javascripts)
       end
 
       # Compress Javascript

data/lib/sinatra/bundles/stylesheet_bundle.rb

@@ -1,4 +1,3 @@
-require 'sinatra/bundles/bundle'
 require 'rainpress'
 
 module Sinatra
@@ -9,17 +8,18 @@ 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, 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}' />"
+      def to_html(name, media = :all)
+        media = media.join(', ') if media.is_a? Array
+        prefix = "/#{@app.stylesheets}/bundles"
+        href = @app.stamp_bundles ? "#{prefix}/#{name}/#{stamp}.css" : "#{prefix}/#{name}.css"
+        "<link type='text/css' href='#{href}' rel='stylesheet' media='#{media}' />"
       end
 
     protected
 
       # The root of these bundles, for path purposes
       def root
-        File.join(@app.public, 'stylesheets')
+        File.join(@app.public, @app.stylesheets)
       end
 
       # Compress CSS
@@ -36,7 +36,7 @@ module Sinatra
       #   assumed to be in the public directory, under 'stylesheets'
       # @return [String] The full path to the file
       def path(filename)
-        File.join(@app.public, 'stylesheets', "#{filename}.css")
+        File.join(root, "#{filename}.css")
       end
     end
   end

data/sinatra-bundles.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra-bundles}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Huckstep"]
-  s.date = %q{2010-04-02}
+  s.date = %q{2010-07-01}
   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 = [
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
      "lib/sinatra/bundles/stylesheet_bundle.rb",
      "sinatra-bundles.gemspec",
      "spec/app.rb",
+     "spec/custom_app.rb",
      "spec/production_app.rb",
      "spec/public/javascripts/eval.js",
      "spec/public/javascripts/splat/splat.js",
@@ -44,10 +45,11 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/darkhelmet/sinatra-bundles}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Easy asset bundling for sinatra}
   s.test_files = [
     "spec/app.rb",
+     "spec/custom_app.rb",
      "spec/production_app.rb",
      "spec/sinatra-bundles_spec.rb",
      "spec/spec_helper.rb"
@@ -57,7 +59,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rainpress>, [">= 0"])
       s.add_runtime_dependency(%q<packr>, [">= 0"])
       s.add_runtime_dependency(%q<rack>, [">= 1.0"])

data/spec/custom_app.rb

@@ -0,0 +1,15 @@
+class CustomApp < Sinatra::Base
+  configure do
+    set(:environment, :test)
+    set(:js, 's/js')
+    set(:css, 's/css')
+    set(:root, File.dirname(__FILE__))
+  end
+
+  register Sinatra::Bundles
+
+  stylesheet_bundle(:test, %w(test1 test2))
+  javascript_bundle(:test, %w(eval test1 test2))
+  javascript_bundle(:test2, %w(test*))
+  javascript_bundle(:all)
+end

data/spec/sinatra-bundles_spec.rb

@@ -1,12 +1,16 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'fileutils'
 require 'app'
 require 'production_app'
+require 'custom_app'
 
 describe 'sinatra-bundles' do
   def app(env = :test)
     case env
     when :production
       ProductionApp
+    when :custom
+      CustomApp
     else
       TestApp
     end
@@ -15,9 +19,7 @@ describe 'sinatra-bundles' do
   def stamp(type, ext, names)
     names.map do |name|
       File.expand_path(File.join(File.dirname(__FILE__), 'public', type, "#{name}.#{ext}"))
-    end.map do |path|
-      File.mtime(path)
-    end.sort.first.to_i
+    end.map { |path| File.mtime(path) }.sort.last.to_i
   end
 
   def js_stamp(names)
@@ -88,14 +90,23 @@ describe 'sinatra-bundles' do
       end.should == "<script type='text/javascript' src='/javascripts/bundles/test.js'></script>"
     end
 
+    it 'should create cusomized tag if path is CUSTOM' do
+      app(:custom).new.instance_eval do
+        options.disable(:stamp_bundles)
+        javascript_bundle_include_tag(:test)
+      end.should == "<script type='text/javascript' src='/s/js/bundles/test.js'></script>"
+    end
+
     it 'should stamp bundles with the timestamp of the newest file in the bundle' do
       app.new.instance_eval do
         javascript_bundle_include_tag(:test)
-      end.should == "<script type='text/javascript' src='/javascripts/bundles/test.js?#{js_stamp(%w(test1 test2))}'></script>"
+      end.should == "<script type='text/javascript' src='/javascripts/bundles/test/#{js_stamp(%w(eval test1 test2))}.js'></script>"
     end
 
     it 'should serve bundles' do
-      get "/javascripts/bundles/test.js"
+      get '/javascripts/bundles/test.js'
+      # Bogus stamp
+      get '/javascripts/bundles/test/987654.js'
       last_response.should be_ok
     end
 
@@ -126,13 +137,40 @@ describe 'sinatra-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"
+      last_response.body.should == @scripts.reject { |s| s.match(/eval|splat/) }.sort.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"
+      last_response.body.should == @scripts.sort.map { |path| File.read(path) }.join("\n") + "\n"
+    end
+
+    it 'should handle the all scripts wildcard CUSTOM' do
+      def app(env = :custom)
+        CustomApp
+      end
+
+      get '/s/js/bundles/all.js'
+      last_response.should be_ok
+      last_response.body.should == @scripts.sort.map { |path| File.read(path) }.join("\n") + "\n"
+    end
+
+    it 'should need rebundle when the value of compress_bundles changes' do
+      app.warm_bundle_cache.should be_true
+      app.compress_bundles.should be_false
+      app.javascript_bundles.each_value { |bundle| bundle.rebundle }
+      app.javascript_bundles[:test].needs_rebundle?.should be_false
+      app.compress_bundles = true
+      app.javascript_bundles[:test].needs_rebundle?.should be_true
+    end
+
+    it 'should need rebundle when the stamp of the bundle changes' do
+      app.warm_bundle_cache.should be_true
+      app.javascript_bundles.each_value { |bundle| bundle.rebundle }
+      app.javascript_bundles[:test].needs_rebundle?.should be_false
+      FileUtils.touch(app.javascript_bundles[:test].instance_eval { path(@files.first) })
+      app.javascript_bundles[:test].needs_rebundle?.should be_true
     end
   end
 
@@ -150,10 +188,17 @@ describe 'sinatra-bundles' do
       end.should == "<link type='text/css' href='/stylesheets/bundles/test.css' rel='stylesheet' media='all' />"
     end
 
+    it 'should create a tag without a stamp if stamps are disabled CUSTOM' do
+      app(:custom).new.instance_eval do
+        options.disable(:stamp_bundles)
+        stylesheet_bundle_link_tag(:test)
+      end.should == "<link type='text/css' href='/s/css/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='all' />"
+      end.should == "<link type='text/css' href='/stylesheets/bundles/test/#{css_stamp(%w(test1 test2))}.css' rel='stylesheet' media='all' />"
     end
 
     it 'should create a tag with default media attribute set to all' do
@@ -178,6 +223,15 @@ describe 'sinatra-bundles' do
       last_response.body.should == @styles.map { |path| File.read(path) }.join("\n") + "\n"
     end
 
+    it 'should concat files in order with newlines including one at the end CUSTOM' do
+      def app(env = :custom)
+        CustomApp
+      end
+
+      get '/s/css/bundles/test.css'
+      last_response.body.should == @styles.map { |path| File.read(path) }.join("\n") + "\n"
+    end
+
     it 'should set cache headers' do
       app.enable(:cache_bundles)
       get '/stylesheets/bundles/test.css'
@@ -186,5 +240,22 @@ describe 'sinatra-bundles' do
       last_response.headers['Cache-Control'].should == 'public, must-revalidate, max-age=31536000'
       last_response.headers['Etag'].should == '"6ecd0946412b76dcd1eaa341cdfefa8b"'
     end
+
+    it 'should need rebundle when the value of compress_bundles changes' do
+      app.warm_bundle_cache.should be_true
+      app.compress_bundles.should be_false
+      app.stylesheet_bundles.each_value { |bundle| bundle.rebundle }
+      app.stylesheet_bundles[:test].needs_rebundle?.should be_false
+      app.compress_bundles = true
+      app.stylesheet_bundles[:test].needs_rebundle?.should be_true
+    end
+
+    it 'should need rebundle when the stamp of the bundle changes' do
+      app.warm_bundle_cache.should be_true
+      app.stylesheet_bundles.each_value { |bundle| bundle.rebundle }
+      app.stylesheet_bundles[:test].needs_rebundle?.should be_false
+      FileUtils.touch(app.stylesheet_bundles[:test].instance_eval { path(@files.first) })
+      app.stylesheet_bundles[:test].needs_rebundle?.should be_true
+    end
   end
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra-bundles
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Daniel Huckstep
@@ -9,79 +15,113 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-02 00:00:00 -06:00
+date: 2010-07-01 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rainpress
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: packr
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rack
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
         version: "1.0"
-    version: 
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: sinatra
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
         version: "1.0"
-    version: 
+  type: :runtime
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
         version: 1.2.9
-    version: 
+  type: :development
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rack-test
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 5
+        - 3
         version: 0.5.3
-    version: 
+  type: :development
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: yard
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id007
 description: Bundle CSS and Javascript assets to a single file, compress, and cache them for snappier web experiences.
 email: darkhelmet@darkhelmetlive.com
 executables: []
@@ -105,6 +145,7 @@ files:
 - lib/sinatra/bundles/stylesheet_bundle.rb
 - sinatra-bundles.gemspec
 - spec/app.rb
+- spec/custom_app.rb
 - spec/production_app.rb
 - spec/public/javascripts/eval.js
 - spec/public/javascripts/splat/splat.js
@@ -125,26 +166,33 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Easy asset bundling for sinatra
 test_files: 
 - spec/app.rb
+- spec/custom_app.rb
 - spec/production_app.rb
 - spec/sinatra-bundles_spec.rb
 - spec/spec_helper.rb