sinatra-bundles 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Daniel Huckstep
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,20 @@
+sinatra-bundles
+===============
+
+An easy way to bundle CSS and Javascript assets in your sinatra application.
+
+Note on Patches/Pull Requests
+-----------------------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (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.
+
+Copyright
+---------
+
+Copyright (c) 2010 Daniel Huckstep. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sinatra-bundles"
+    gem.summary = %Q{Easy asset bundling for sinatra}
+    gem.description = %Q{Bundle CSS and Javascript assets to a single file, compress, and cache them for snappier web experiences.}
+    gem.email = 'darkhelmet@darkhelmetlive.com'
+    gem.homepage = 'http://github.com/darkhelmet/sinatra-bundles'
+    gem.authors = ['Daniel Huckstep']
+    gem.add_dependency 'rainpress', '>= 0'
+    gem.add_dependency 'packr', '>= 0'
+    gem.add_development_dependency 'rspec', '>= 1.2.9'
+    gem.add_development_dependency 'yard', '>= 0'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort 'YARD is not available. In order to run yardoc, you must: sudo gem install yard'
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/sinatra/bundles.rb

@@ -0,0 +1,111 @@
+require 'rainpress'
+require 'packr'
+
+module Sinatra
+  module Bundles
+    class Bundle
+      def initialize(app, files)
+        @app = app
+        @files = files
+      end
+
+      def each
+        @files.each do |f|
+          content = File.read(path(f))
+          content = compress(content) if @app.compress_bundles
+          yield("#{content}\n")
+        end
+      end
+
+    private
+
+      def stamp
+        @files.map do |f|
+          File.mtime(path(f))
+        end.sort.first.to_i
+      end
+    end
+
+    class StylesheetBundle < Bundle
+      def to_html(name)
+        "<link type='text/css' href='/stylesheets/bundle_#{name}.css#{@app.stamp_bundles ? "?#{stamp}" : ''}' rel='stylesheet' media='screen' />"
+      end
+
+    protected
+
+      def compress(css)
+        Rainpress.compress(css)
+      end
+
+      def path(filename)
+        File.join(@app.public, 'stylesheets', "#{filename}.css")
+      end
+    end
+
+    class JavascriptBundle < Bundle
+      def to_html(name)
+        "<script type='text/javascript' src='/javascripts/bundle_#{name}.js#{@app.stamp_bundles ? "?#{stamp}" : ''}'></script>"
+      end
+
+    protected
+
+      def compress(js)
+        Packr.pack(js, :shrink_vars => true)
+      end
+
+      def path(filename)
+        File.join(@app.public, 'javascripts', "#{filename}.js")
+      end
+    end
+
+    module Helpers
+      def javascript_bundle_include_tag(bundle)
+        options.javascript_bundles[bundle].to_html(bundle)
+      end
+
+      def stylesheet_bundle_link_tag(bundle)
+        options.stylesheet_bundles[bundle].to_html(bundle)
+      end
+    end
+
+    def javascript_bundle(key, files)
+      javascript_bundles[key] = JavascriptBundle.new(self, files)
+    end
+
+    def stylesheet_bundle(key, files)
+      stylesheet_bundles[key] = StylesheetBundle.new(self, files)
+    end
+
+    def self.registered(app)
+      app.set(:javascript_bundles, {})
+      app.set(:stylesheet_bundles, {})
+      app.set(:bundle_cache_time, 60 * 60 * 24 * 365)
+      app.disable(:compress_bundles)
+      app.disable(:cache_bundles)
+      app.enable(:stamp_bundles)
+
+      app.configure :production do
+        app.enable(:compress_bundles)
+        app.enable(:cache_bundles)
+      end
+
+      app.helpers(Helpers)
+
+      app.get('/stylesheets/bundle_: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]
+      end
+
+      app.get('/javascripts/bundle_: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]
+      end
+    end
+  end
+
+  register(Bundles)
+end

data/spec/app.rb

@@ -0,0 +1,11 @@
+class TestApp < Sinatra::Base
+  configure do
+    set(:environment, :test)
+    set(:root, File.dirname(__FILE__))
+  end
+
+  register Sinatra::Bundles
+
+  stylesheet_bundle(:test, %w(test1 test2))
+  javascript_bundle(:test, %w(test1 test2))
+end

data/spec/production_app.rb

@@ -0,0 +1,12 @@
+gem 'sinatra', '>= 0.10.1'
+require 'sinatra/base'
+require 'sinatra/bundles'
+
+class ProductionApp < Sinatra::Base
+  configure do
+    set(:root, File.dirname(__FILE__))
+    set(:environment, :production)
+  end
+
+  register Sinatra::Bundles
+end

data/spec/public/javascripts/test1.js

@@ -0,0 +1,5 @@
+function hello(name) {
+  alert('Hello, ' + name);
+}
+
+hello('Bob');

data/spec/public/javascripts/test2.js

@@ -0,0 +1,5 @@
+function goodbye(name) {
+  alert('Hello, ' + name);
+}
+
+goodbye('Bob');

data/spec/public/stylesheets/test1.css

@@ -0,0 +1,3 @@
+.test1 {
+  color: black;
+}

data/spec/public/stylesheets/test2.css

@@ -0,0 +1,3 @@
+.test2 {
+  color: white;
+}

data/spec/sinatra-bundles_spec.rb

@@ -0,0 +1,154 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'app'
+require 'production_app'
+
+describe 'SinatraBundles' do
+  def app(env = :test)
+    case env
+    when :production
+      ProductionApp
+    else
+      TestApp
+    end
+  end
+
+  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
+
+  def js_stamp(names)
+    stamp('javascripts', 'js', names)
+  end
+
+  def css_stamp(names)
+    stamp('stylesheets', 'css', names)
+  end
+
+  before do
+    @scripts = %w(test1 test2).map do |name|
+      File.expand_path(File.join(File.dirname(__FILE__), 'public', 'javascripts', "#{name}.js"))
+    end
+
+    @styles = %w(test1 test2).map do |name|
+      File.expand_path(File.join(File.dirname(__FILE__), 'public', 'stylesheets', "#{name}.css"))
+    end
+  end
+
+  before(:each) do
+    # reset defaults
+    app.set(:bundle_cache_time, 60 * 60 * 24 * 365)
+    app.disable(:compress_bundles)
+    app.disable(:cache_bundles)
+    app.enable(:stamp_bundles)
+  end
+
+  context 'settings' do
+    it 'should not cache by default' do
+      app.cache_bundles.should be_false
+    end
+
+    it 'should not compress by default' do
+      app.compress_bundles.should be_false
+    end
+
+    it 'should cache by default in production mode' do
+      app(:production).environment.should == :production
+      app(:production).cache_bundles.should be_true
+    end
+
+    it 'should compress by default in production mode' do
+      app(:production).environment.should == :production
+      app(:production).compress_bundles.should be_true
+    end
+
+    it 'should cache for 1 year by default' do
+      app.bundle_cache_time.should == (60 * 60 * 24 * 365)
+    end
+
+    it 'should timestamp by default' do
+      app.stamp_bundles.should be_true
+    end
+  end
+
+  context 'javascript bundles' do
+    it 'should be able to set bundles' do
+      app.javascript_bundle(:all, %w(foo bar baz))
+      app.javascript_bundles.should_not == {}
+      app.javascript_bundles[:all].should be_a_kind_of(Sinatra::Bundles::Bundle)
+    end
+
+    it 'should create a tag without a stamp if stamps are disabled' do
+      app.new.instance_eval do
+        options.disable(:stamp_bundles)
+        javascript_bundle_include_tag(:test)
+      end.should == "<script type='text/javascript' src='/javascripts/bundle_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/bundle_test.js?#{js_stamp(%w(test1 test2))}'></script>"
+    end
+
+    it 'should serve bundles' do
+      get "/javascripts/bundle_test.js"
+      last_response.should be_ok
+    end
+
+    it 'should concat files in order with newlines including one at the end' do
+      get '/javascripts/bundle_test.js'
+      last_response.body.should == @scripts.map { |path| File.read(path) }.join("\n") + "\n"
+    end
+
+    it 'should set cache headers' do
+      app.enable(:cache_bundles)
+      get '/javascripts/bundle_test.js'
+      last_response.should be_ok
+      last_response.headers['Vary'].should == 'Accept-Encoding'
+      last_response.headers['Cache-Control'].should == 'public, must-revalidate, max-age=31536000'
+    end
+  end
+
+  context 'stylesheet bundles' do
+    it 'should be able to set bundles' do
+      app.stylesheet_bundle(:all, %w(foo bar baz))
+      app.stylesheet_bundles.should_not == {}
+      app.stylesheet_bundles[:all].should be_a_kind_of(Sinatra::Bundles::Bundle)
+    end
+
+    it 'should create a tag without a stamp if stamps are disabled' do
+      app.new.instance_eval do
+        options.disable(:stamp_bundles)
+        stylesheet_bundle_link_tag(:test)
+      end.should == "<link type='text/css' href='/stylesheets/bundle_test.css' rel='stylesheet' media='screen' />"
+    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/bundle_test.css?#{css_stamp(%w(test1 test2))}' rel='stylesheet' media='screen' />"
+    end
+
+    it 'should serve bundles' do
+      get "/stylesheets/bundle_test.css"
+      last_response.should be_ok
+    end
+
+    it 'should concat files in order with newlines including one at the end' do
+      get '/stylesheets/bundle_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/bundle_test.css'
+      last_response.should be_ok
+      last_response.headers['Vary'].should == 'Accept-Encoding'
+      last_response.headers['Cache-Control'].should == 'public, must-revalidate, max-age=31536000'
+    end
+  end
+end