sinatra-assetpack 0.0.6 → 0.0.8

data/.gitignore

@@ -1 +1,3 @@
 /Gemfile.lock
+/.rvmrc
+/.sass-cache

data/HISTORY.md

@@ -1,3 +1,27 @@
+v0.0.8 - Sep 06, 2011
+---------------------
+
+### Fixed:
+  * Fixed the CSS preprocessing bug that gives invalid 'url()' properties to 
+  non-existing images. Closes #1.
+
+### Added:
+  * Allow adding CSS/JS files that don't exist. Closes #8.
+  * Support any Tilt-compatible CSS or JS engine. Related to #5.
+
+### Changed:
+  * Default to '/assets/x.js' then using assets.css without a path. Inspiration 
+  from Jammit.
+  * Ask browsers to cache assets for 1 month.
+
+### Misc:
+  * Add a note on the ImageMagick requirement.
+  * Stop the 'img' helper from invoking ImageMagick more times than it needs to.
+  * Make "rake test!" abort when it encounters an error.
+  * Stylus tests to stub stylus compilation.
+  * Added .rvmrc and .sass-cache to gitignore.
+  * Allow overridable multiple RVM environments in tests.
+
 v0.0.6 - Aug 30, 2011
 ---------------------
 

data/README.md

@@ -194,6 +194,7 @@ Images
 
 To show images, use the `img` helper.
 This automatically adds width, height, and a cache buster thingie.
+ImageMagick is required to generate full image tags with width and height.
 
 ``` html
 <!-- Original: --> <%= img '/images/email.png' %>
@@ -401,7 +402,8 @@ __Usage:__ `img 'SRC'`
 __Usage:__ `img 'SRC', OPTIONS_HASH`
 
 Shows an `<img>` tag from the given `SRC`. If the images is found in the asset 
-directories, `width` and `height` attributes will be added.
+directories (and ImageMagick is available), `width` and `height` attributes 
+will be added.
 
 If `OPTIONS_HASH` is given, they will we passed onto the `<img>` tag to be 
 generated as attributes.

data/Rakefile

@@ -1,11 +1,14 @@
-desc "Invokes the test suite in multiple rubies"
-task :test do
-  system "rvm 1.9.2@sinatra,1.8.7@sinatra rake run_test"
+desc "Invokes the test suite in multiple RVM environments"
+task :'test!' do
+  # Override this by adding RVM_TEST_ENVS=".." in .rvmrc
+  envs = ENV['RVM_TEST_ENVS'] || '1.9.2@sinatra,1.8.7@sinatra'
+  puts "* Testing in the following RVM environments: #{envs.gsub(',', ', ')}"
+  system "rvm #{envs} rake test" or abort
 end
 
 desc "Runs tests"
-task :run_test do
+task :test do
   Dir['test/*_test.rb'].each { |f| load f }
 end
 
-task :default => :run_test
+task :default => :test

data/lib/sinatra/assetpack.rb

@@ -19,12 +19,17 @@ module Sinatra
 
     # Returns a map of what MIME format each Tilt type returns.
     def self.tilt_formats
-      @formats ||= {
-        'scss' => 'css',
-        'sass' => 'css',
-        'less' => 'css',
-        'coffee' => 'js'
-      }
+      @formats ||= begin
+        hash = Hash.new
+        Tilt.mappings.each do |format, (engine, _)|
+          case engine.default_mime_type
+          when 'text/css' then hash[format] = 'css'
+          when 'application/javascript' then hash[format] = 'js'
+          end
+        end
+
+        hash
+      end
     end
 
     # Returns the inverse of tilt_formats.

data/lib/sinatra/assetpack/buster_helpers.rb

@@ -5,16 +5,31 @@ module Sinatra
       # Returns the cache buster suffix for given file(s).
       # This implementation somewhat obfuscates the mtime to not reveal deployment dates.
       def cache_buster_hash(*files)
-        i = files.map { |f| File.mtime(f).to_i }.max
-        (i * 4567).to_s.reverse[0...6]
+        i = mtime_for(files)
+        (i * 4567).to_s.reverse[0...6]  if i
+      end
+
+      # Returns the maximum mtime for a given list of files.
+      # It will return nil if none of them are found.
+      def mtime_for(files)
+        files.map { |f| File.mtime(f).to_i  if f.is_a?(String) && File.file?(f) }.compact.max
       end
 
       # Adds a cache buster for the given path.
       #
+      # The 2nd parameter (and beyond) are the files to take mtime from.
+      # If the files are not found, the paths will be left as they are.
+      #
       #   add_cache_buster('/images/email.png', '/var/www/x/public/images/email.png')
       #
       def add_cache_buster(path, *files)
-        path.gsub(/(\.[^.]+)$/) { |ext| ".#{cache_buster_hash *files}#{ext}" }
+        hash = cache_buster_hash *files
+
+        if hash
+          path.gsub(/(\.[^.]+)$/) { |ext| ".#{hash}#{ext}" }
+        else
+          path
+        end
       end
     end
   end

data/lib/sinatra/assetpack/class_methods.rb

@@ -20,7 +20,7 @@ module Sinatra
         assets.packages.each do |name, package|
           get package.route_regex do
             content_type package.type
-            last_modified package.mtime
+            last_modified package.mtime  if package.mtime
 
             settings.assets.cache[package.hash] ||= package.minify
           end
@@ -40,6 +40,7 @@ module Sinatra
             # Send headers
             content_type fmt.to_sym
             last_modified File.mtime(fn).to_i
+            expires 86400*30, :public
 
             format = File.extname(fn)[1..-1]
 

data/lib/sinatra/assetpack/configurator.rb

@@ -1,14 +1,20 @@
 module Sinatra
   module AssetPack
     module Configurator
-      def attrib(name)
-        define_method(:"#{name}") { |*a|
-          value = a.first
-          self.instance_variable_set :"@#{name}", value  unless value.nil?
-          self.instance_variable_get :"@#{name}"
-        }
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def attrib(name)
+          define_method(:"#{name}") { |*a|
+            value = a.first
+            self.instance_variable_set :"@#{name}", value  unless value.nil?
+            self.instance_variable_get :"@#{name}"
+          }
 
-        alias_method(:"#{name}=", :"#{name}")
+          alias_method(:"#{name}=", :"#{name}")
+        end
       end
     end
   end

data/lib/sinatra/assetpack/css.rb

@@ -3,7 +3,8 @@ module Sinatra
     module Css
       def self.preproc(str, assets)
         str.gsub(/url\(["']?(.*?)["']?\)/) { |url|
-          file, options = $1.split('?')
+          path = $1
+          file, options = path.split('?')
           local = assets.local_file_for file
 
           url = if local
@@ -13,7 +14,7 @@ module Sinatra
               BusterHelpers.add_cache_buster(file, local)
             end
           else
-            url
+            path
           end
 
           "url(#{url})"

data/lib/sinatra/assetpack/helpers.rb

@@ -14,7 +14,7 @@ module Sinatra
 
         local = settings.assets.local_file_for src
         if local
-          i = Image.new(local)
+          i = Image[local]
           attrs[:src] = BusterHelpers.add_cache_buster(src, local)
           if i.dimensions?
             attrs[:width]  ||= i.width

data/lib/sinatra/assetpack/image.rb

@@ -1,6 +1,28 @@
 module Sinatra
   module AssetPack
+    # An image.
+    #
+    # == Common usage
+    #
+    #     i = Image['/app/images/background.png']    # Local file path
+    #
+    #     i.dimensions     # Tuple for [ width, height ]
+    #     i.width
+    #     i.height
+    #
+    #     i.dimensions?    # True if dimensions are available
+    #                      # (e.g., if ImageMagick is installed and working)
+    #
     class Image
+      # Looks up an image.
+      # This makes each image only have one associated instance forever.
+      def self.[](fname)
+        fname = File.expand_path(fname) || fname
+
+        @cache        ||= Hash.new
+        @cache[fname] ||= new fname
+      end
+
       def initialize(file)
         @file = file
       end

data/lib/sinatra/assetpack/options.rb

@@ -34,11 +34,11 @@ module Sinatra
     #     a.local_path_for('/images/bg.gif')
     #     a.served?('/images/bg.gif')
     #
-    #     a.glob('/js/*.js', '/js/vendor/**/*.js')
+    #     a.glob(['/js/*.js', '/js/vendor/**/*.js'])
     #     # Returns a HashArray of (local => remote)
     #
     class Options
-      extend Configurator
+      include Configurator
 
       def initialize(app, &blk)
         @app             = app
@@ -100,7 +100,7 @@ module Sinatra
 
         # Account for "css :name, [ files ]"
         elsif args[0].respond_to?(:each)
-          path  = "/#{type}/#{name}.#{type}" # /css/foobar.css by default
+          path  = "/assets/#{name}.#{type}" # /assets/foobar.css by default
           files = args[0]
 
         else
@@ -216,9 +216,24 @@ module Sinatra
       end
 
       # Returns an array of URI paths of those matching given globs.
-      def glob(*match)
+      #
+      #     glob('spec')
+      #     glob(['spec1', 'spec2' ...])
+      #     glob('spec', preserve: true)
+      #
+      # If `preserve` is set to true, it will preserve any specs that are not
+      # wildcards that don't match anything.
+      #
+      def glob(match, options={})
+
+        match = [*match]  # Force array-ness
+
         paths = match.map { |spec|
-          files.keys.select { |f| File.fnmatch?(spec, f) }.sort
+          if options[:preserve] && !spec.include?('*')
+            spec
+          else
+            files.keys.select { |f| File.fnmatch?(spec, f) }.sort
+          end
         }.flatten
 
         paths  = paths.uniq

data/lib/sinatra/assetpack/package.rb

@@ -37,7 +37,7 @@ module Sinatra
 
       # Returns a list of URIs
       def paths_and_files
-        @assets.glob *@filespecs
+        @assets.glob @filespecs, :preserve => true
       end
 
       def files
@@ -49,7 +49,7 @@ module Sinatra
       end
 
       def mtime
-        files.map { |f| File.mtime(f).to_i }.max
+        BusterHelpers.mtime_for(files)
       end
 
       # Returns the regex for the route, including cache buster crap.
@@ -92,7 +92,10 @@ module Sinatra
 
       def combined
         session = Rack::Test::Session.new(@assets.app)
-        paths.map { |path| session.get(path).body }.join("\n")
+        paths.map { |path|
+          result = session.get(path)
+          result.body  if result.status == 200
+        }.join("\n")
       end
 
       def js?()  @type == :js; end

data/lib/sinatra/assetpack/version.rb

@@ -1,7 +1,7 @@
 module Sinatra
   module AssetPack
     def self.version
-      "0.0.6"
+      "0.0.8"
     end
   end
 end

data/sinatra-assetpack.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.strip.split("\n")
   s.executables = Dir["bin/*"].map { |f| File.basename(f) }
 
+  s.add_dependency "tilt", ">= 1.3.0"
   s.add_dependency "sinatra"
   s.add_dependency "jsmin"
   s.add_dependency "rack-test"
@@ -20,4 +21,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "coffee-script"
   s.add_development_dependency "contest"
   s.add_development_dependency "mocha"
+  s.add_development_dependency "stylus"
 end

data/test/app/app/css/style.css

@@ -1,2 +1,3 @@
 div { color: red; }
 body { background: url(/images/background.jpg); }
+#nonexistent { background: url(/images/404.png); }

data/test/app/app/css/stylus.styl

@@ -0,0 +1,3 @@
+body
+  background red
+  color blue

data/test/app/app/css_stylus/stylus.styl

@@ -0,0 +1,3 @@
+body
+  background red
+  color blue

data/test/arity_test.rb

@@ -18,8 +18,8 @@ class ArityTest < UnitTest
 
   test "arity in #assets" do
     paths = App.assets.packages['a.css'].paths
-    assert paths ==
-      ["/css/screen.css", "/css/sqwishable.css", "/css/style.css", "/css/js2c.css"]
+    assert_equal paths,
+      [ "/css/screen.css", "/css/sqwishable.css", "/css/style.css", "/css/stylus.css", "/css/js2c.css" ]
 
     assert App.assets.js_compression == :closure
     assert App.assets.css_compression == :yui

data/test/build_test.rb

@@ -6,6 +6,7 @@ class BuildTest < UnitTest
   end
 
   test "build" do
+    Stylus.expects(:compile).returns("body{background:#f00;color:#00f;}")
     app.assets.css_compression = :simple
     app.assets.build!
 

data/test/img_test.rb

@@ -1,6 +1,8 @@
 require File.expand_path('../test_helper', __FILE__)
 
 class ImgTest < UnitTest
+  Image = Sinatra::AssetPack::Image
+
   test "get img" do
     get '/images/email.png'
     assert_equal last_response.headers['Content-Length'], File.size(r("/app/images/email.png")).to_s
@@ -10,4 +12,20 @@ class ImgTest < UnitTest
     get '/images/email.893748.png'
     assert_equal last_response.headers['Content-Length'], File.size(r("/app/images/email.png")).to_s
   end
+
+  test "Image[]" do
+    i = Image['/app/images/email.png']
+    j = Image['/app/images/email.png']
+
+    assert j === i
+  end
+
+  test "Image[]" do
+    i = Image['/app/images/email.png']
+    j = Image['/app/images/email.png']
+
+    Image.any_instance.expects(:`).times(1)
+    j.dimensions
+    i.dimensions
+  end
 end

data/test/local_file_test.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class LocalFileTest < UnitTest
+  class App < Sinatra::Base
+    set :root, File.expand_path('../app', __FILE__)
+    register Sinatra::AssetPack
+
+    assets {
+      css :application, [ '/css/*.css' ]
+    }
+  end
+
+  test "local file for (in existing files)" do
+    fn = App.assets.local_file_for '/images/background.jpg'
+    assert_equal r('app/images/background.jpg'), fn
+  end
+
+  test "local file for (in nonexisting files)" do
+    fn = App.assets.local_file_for '/images/404.jpg'
+    assert fn.nil?
+  end
+end

data/test/non_existent_test.rb

@@ -0,0 +1,46 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class NonExistentTest < UnitTest
+  class App < Sinatra::Base
+    set :root, File.expand_path('../app', __FILE__)
+    register Sinatra::AssetPack
+
+    assets do |a|
+      a.js :script, '/script.min.js', [
+        '/js/h*.js',
+        '/js/combine.js'
+      ]
+
+      a.js_compression :closure
+      a.css_compression = :yui
+    end
+
+    get '/js/combine.js' do
+      "alert('Spin spin sugar');"
+    end
+
+    get '/' do
+      js :script
+    end
+  end
+
+  def app
+    App
+  end
+
+  test "non-existent files in js helper" do
+    get '/'
+    assert body.include?('combine.js')
+  end
+
+  test "dev non-existent files in js helper" do
+    App.expects(:environment).returns(:development).times(1..100)
+    get '/'
+    assert body.include?('combine.js')
+  end
+
+  test "non-existent files in js minifier" do
+    get '/script.min.js'
+    assert body.include?('Spin spin sugar')
+  end
+end

data/test/options_test.rb

@@ -1,6 +1,5 @@
 require File.expand_path('../test_helper', __FILE__)
 
-
 class OptionsTest < UnitTest
   class App < Sinatra::Base
     set :root, File.expand_path('../app', __FILE__)
@@ -18,6 +17,6 @@ class OptionsTest < UnitTest
 
   test "options" do
     assert App.assets.js_compression == :closure
-    assert App.assets.packages['application.css'].path == "/css/application.css"
+    assert App.assets.packages['application.css'].path == "/assets/application.css"
   end
 end

data/test/order_test.rb

@@ -15,7 +15,7 @@ class OrderTest < UnitTest
 
   test "order" do
     paths = App.assets.packages['a.css'].paths
-    assert paths ==
-      ["/css/screen.css", "/css/sqwishable.css", "/css/style.css", "/css/js2c.css"]
+    assert_equal paths.sort,
+      [ "/css/screen.css", "/css/sqwishable.css", "/css/style.css", "/css/stylus.css", "/css/js2c.css" ].sort
   end
 end

data/test/preproc_test.rb

@@ -11,6 +11,11 @@ class PreprocTest < UnitTest
     assert body =~ %r{background.[0-9]+.jpg}
   end
 
+  test "no cache-busting number for non-existent images" do
+    get '/css/style.css'
+    assert body.include?('background: url(/images/404.png)')
+  end
+
   test "preproc on minify" do
     get '/css/application.css'
     assert body =~ %r{email.[0-9]+.png}

data/test/stylus_test.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class StylusTest < UnitTest
+  class App < Sinatra::Base
+    set :root, File.expand_path('../app', __FILE__)
+    register Sinatra::AssetPack
+
+    assets do |a|
+      a.css :a, '/css/a.css', [
+        '/css/stylus.css'
+      ]
+    end
+  end
+
+  def app
+    App
+  end
+
+  test "build" do
+    Stylus.expects(:compile).returns("body{background:#f00;color:#00f;}")
+    get '/css/stylus.css'
+    assert body.gsub(/[ \t\r\n]/, '') == "body{background:#f00;color:#00f;}"
+  end
+end

data/test/test_helper.rb

@@ -1,5 +1,7 @@
 require 'contest'
 require 'jsmin'
+require 'tilt'
+require 'stylus'
 require 'rack/test'
 require 'yaml'
 require 'mocha'
@@ -23,6 +25,13 @@ class UnitTest < Test::Unit::TestCase
     puts ""
   end
 
+  def get(*a)
+    super *a
+    has_error = body.include?('sinatra.error')
+    d if has_error
+    assert ! has_error, "Found a Sinatra error."
+  end
+
   def body
     last_response.body.strip
   end

data/test/tilt_test.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class OptionsTest < UnitTest
+  test "tilt mappings" do
+    @formats = Sinatra::AssetPack.tilt_formats
+    assert @formats['sass'] == 'css'
+    assert @formats['scss'] == 'css'
+    assert @formats['coffee'] == 'js'
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-assetpack
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,23 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-30 00:00:00.000000000 +08:00
+date: 2011-09-06 00:00:00.000000000 +08:00
 default_executable: 
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: &2164770720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164770720
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2157093660 !ruby/object:Gem::Requirement
+  requirement: &2164770260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157093660
+  version_requirements: *2164770260
 - !ruby/object:Gem::Dependency
   name: jsmin
-  requirement: &2157093240 !ruby/object:Gem::Requirement
+  requirement: &2164769760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157093240
+  version_requirements: *2164769760
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2153355700 !ruby/object:Gem::Requirement
+  requirement: &2164769320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153355700
+  version_requirements: *2164769320
 - !ruby/object:Gem::Dependency
   name: yui-compressor
-  requirement: &2153355280 !ruby/object:Gem::Requirement
+  requirement: &2164768860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153355280
+  version_requirements: *2164768860
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &2153354860 !ruby/object:Gem::Requirement
+  requirement: &2164768420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153354860
+  version_requirements: *2164768420
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &2153354440 !ruby/object:Gem::Requirement
+  requirement: &2164768000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153354440
+  version_requirements: *2164768000
 - !ruby/object:Gem::Dependency
   name: coffee-script
-  requirement: &2153354020 !ruby/object:Gem::Requirement
+  requirement: &2164767500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153354020
+  version_requirements: *2164767500
 - !ruby/object:Gem::Dependency
   name: contest
-  requirement: &2153353600 !ruby/object:Gem::Requirement
+  requirement: &2164767020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +110,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153353600
+  version_requirements: *2164767020
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2153353180 !ruby/object:Gem::Requirement
+  requirement: &2164766600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164766600
+- !ruby/object:Gem::Dependency
+  name: stylus
+  requirement: &2164766180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,7 +132,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153353180
+  version_requirements: *2164766180
 description: Package your assets for Sinatra.
 email:
 - rico@sinefunc.com
@@ -155,6 +177,8 @@ files:
 - test/app/app/css/screen.sass
 - test/app/app/css/sqwishable.css
 - test/app/app/css/style.css
+- test/app/app/css/stylus.styl
+- test/app/app/css_stylus/stylus.styl
 - test/app/app/images/background.jpg
 - test/app/app/images/email.png
 - test/app/app/js/hello.js
@@ -165,13 +189,17 @@ files:
 - test/cache_test.rb
 - test/helpers_test.rb
 - test/img_test.rb
+- test/local_file_test.rb
+- test/non_existent_test.rb
 - test/options_test.rb
 - test/order_test.rb
 - test/preproc_test.rb
 - test/redundant_test.rb
 - test/simplecss_test.rb
 - test/sqwish_test.rb
+- test/stylus_test.rb
 - test/test_helper.rb
+- test/tilt_test.rb
 - test/unit_test.rb
 - test/yui_test.rb
 has_rdoc: true