padrino-assets 0.2.2 → 0.3.0

data/lib/padrino-assets/version.rb

@@ -1,5 +1,6 @@
-module Padrino
-  module Assets
-    VERSION = '0.2.2'
-  end
+# encoding: utf-8
+module Padrino
+  module Assets
+    VERSION = '0.3.0'
+  end
 end

data/lib/tasks/cleanup.rake

@@ -1,8 +1,9 @@
-namespace :assets do
-  desc 'Removes backups for existing assets'
-  task :cleanup, :quanity do |task, args|
-    quanity  = args['quanity'] || 2
-    manifest = Padrino::Assets.manifest
-    manifest.cleanup(quanity)
-  end
+# encoding: utf-8
+namespace :assets do
+  desc 'Removes backups for existing assets'
+  task :cleanup, :quanity do |task, args|
+    quanity  = args['quanity'] || 2
+    manifest = Padrino::Assets.manifest
+    manifest.cleanup(quanity)
+  end
 end

data/lib/tasks/clobber.rake

@@ -1,7 +1,8 @@
-namespace :assets do
-  desc 'Deletes all compiled assets'
-  task :clobber do
-    manifest = Padrino::Assets.manifest
-    manifest.clobber
-  end
+# encoding: utf-8
+namespace :assets do
+  desc 'Deletes all compiled assets'
+  task :clobber do
+    manifest = Padrino::Assets.manifest
+    manifest.clobber
+  end
 end

data/lib/tasks/compress.rake

@@ -1,14 +1,15 @@
-namespace :assets do
-  desc 'Compresses all compiled assets'
-  task :compress do
-    environment = Padrino::Assets.environment
-    manifest = Padrino::Assets.manifest
-
-    manifest.assets.each do |asset, digested_asset|
-      if asset = environment[asset]
-        compressed_asset = File.join(manifest.dir, digested_asset)
-        asset.write_to(compressed_asset + '.gz') if compressed_asset =~ /\.(?:css|html|js|svg|txt|xml)$/
-      end
-    end
-  end
+# encoding: utf-8
+namespace :assets do
+  desc 'Compresses all compiled assets'
+  task :compress do
+    environment = Padrino::Assets.environment
+    manifest = Padrino::Assets.manifest
+
+    manifest.assets.each do |asset, digested_asset|
+      if asset = environment[asset]
+        compressed_asset = File.join(manifest.dir, digested_asset)
+        asset.write_to(compressed_asset + '.gz') if compressed_asset =~ /\.(?:css|html|js|svg|txt|xml)$/
+      end
+    end
+  end
 end

data/lib/tasks/precompile.rake

@@ -1,30 +1,33 @@
-namespace :assets do
-  desc 'Compiles all assets'
-  task :precompile do
-    environment = Padrino::Assets.environment
-    manifest = Padrino::Assets.manifest
-    apps = Padrino.mounted_apps
-    apps.each do |app|
-      app = app.app_obj
-
-      app.precompile_assets.each do |path|
-        environment.each_logical_path.each do |logical_path|
-          case path
-          when Regexp
-            next unless path.match(logical_path)
-          when Proc
-            next unless path.call(logical_path)
-          else
-            next unless File.fnmatch(path.to_s, logical_path)
-          end
-
-          manifest.compile(logical_path)
-        end
-      end
-
-      if app.compress_assets?
-        Rake::Task['assets:compress'].invoke
-      end
-    end
-  end
+# encoding: utf-8
+namespace :assets do
+  desc 'Compiles all assets'
+  task :precompile do
+    environment = Padrino::Assets.environment
+    manifest = Padrino::Assets.manifest
+    apps = Padrino.mounted_apps
+    apps.each do |app|
+      app = app.app_obj
+
+      next unless app.extensions.include?(Padrino::Assets)
+
+      app.precompile_assets.each do |path|
+        environment.each_logical_path.each do |logical_path|
+          case path
+          when Regexp
+            next unless path.match(logical_path)
+          when Proc
+            next unless path.call(logical_path)
+          else
+            next unless File.fnmatch(path.to_s, logical_path)
+          end
+
+          manifest.compile(logical_path)
+        end
+      end
+
+      if app.compress_assets?
+        Rake::Task['assets:compress'].invoke
+      end
+    end
+  end
 end

data/padrino-assets.gemspec

@@ -1,25 +1,26 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
-require 'padrino-assets/version'
-
-Gem::Specification.new do |s|
-  s.name        = 'padrino-assets'
-  s.version     = Padrino::Assets::VERSION
-  s.authors     = ['Benjamin Bloch']
-  s.email       = ['cirex@gamesol.org']
-  s.homepage    = 'https://github.com/Cirex/padrino-assets'
-  s.description = 'A plugin for the Padrino web framework which uses Sprockets to manage and compile assets'
-  s.summary     = s.description
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ['lib']
-
-  s.add_dependency 'sprockets', '~> 2.3.0'
-  s.add_dependency 'padrino-core'
-  s.add_dependency 'padrino-helpers'
-
-  s.add_development_dependency 'minitest'
-  s.add_development_dependency 'webrat'
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+require 'padrino-assets/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'padrino-assets'
+  s.version     = Padrino::Assets::VERSION
+  s.authors     = ['Benjamin Bloch']
+  s.email       = ['cirex@gamesol.org']
+  s.homepage    = 'https://github.com/Cirex/padrino-assets'
+  s.description = 'A plugin for the Padrino web framework which uses Sprockets to manage and compile assets'
+  s.summary     = s.description
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'sprockets', '~> 2.3.0'
+  s.add_dependency 'padrino-core'
+  s.add_dependency 'padrino-helpers'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '>= 2.0.0'
+  s.add_development_dependency 'rspec-html-matchers'
 end

data/spec/assets_spec.rb

@@ -0,0 +1,61 @@
+require_relative 'spec'
+
+class TestCompressor;    end
+class AnotherCompressor; end
+
+describe Padrino::Assets do
+  before do
+    app.set :css_compressor, nil
+    app.set :js_compressor,  nil
+  end
+
+  it 'can append paths to the Sprockets environment' do
+    Padrino::Assets.load_paths << my_path = File.dirname(__FILE__) + '/fixtures/paths_test'
+
+    Padrino.after_load.each(&:call)
+    Padrino.clear!
+
+    environment.paths.should include(my_path)
+  end
+
+  it 'can register a css compressor for use' do
+    Padrino::Assets.register_compressor :css, :test => 'TestCompressor'
+    Padrino::Assets.compressors[:css][:test].should == 'TestCompressor'
+  end
+
+  it 'can register a js compressor for use' do
+    Padrino::Assets.register_compressor :js, :another => 'AnotherCompressor'
+    Padrino::Assets.compressors[:js][:another].should == 'AnotherCompressor'
+  end
+
+  context '#find_registered_compressor' do
+    before { Padrino::Assets.compressors.clear }
+
+    it 'should allow you to manually locate a js compressor object' do
+      Padrino::Assets.register_compressor :js, :test    => 'TestCompressor'
+      Padrino::Assets.register_compressor :js, :another => 'AnotherCompressor'
+
+      compressor = Padrino::Assets.find_registered_compressor(:js, :test)
+      compressor.class.should == TestCompressor
+
+      compressor = Padrino::Assets.find_registered_compressor(:js, :another)
+      compressor.class.should == AnotherCompressor
+    end
+
+    it 'should allow you to manually locate a css compressor object' do
+      Padrino::Assets.register_compressor :css, :test    => 'TestCompressor'
+      Padrino::Assets.register_compressor :css, :another => 'AnotherCompressor'
+
+      compressor = Padrino::Assets.find_registered_compressor(:css, :test)
+      compressor.class.should == TestCompressor
+
+      compressor = Padrino::Assets.find_registered_compressor(:css, :another)
+      compressor.class.should == AnotherCompressor
+    end
+
+    it 'should return nil when no compressor object is found' do
+      compressor = Padrino::Assets.find_registered_compressor(:css, :simple)
+      compressor.should be_nil
+    end
+  end
+end

data/spec/fixtures/assets/application.css

@@ -0,0 +1,11 @@
+* {
+  margin: 0;
+  padding: 0; }
+
+body {
+  background: black;
+  color: white;
+  text-align: center; }
+
+article, section, header, footer {
+  display: block; }

data/spec/fixtures/assets/application.js

@@ -0,0 +1 @@
+alert('Hello World');

data/spec/fixtures/compiled_assets/application-b8588c6975a4539fbf2c11471870bdca.css

@@ -0,0 +1,11 @@
+* {
+  margin: 0;
+  padding: 0; }
+
+body {
+  background: black;
+  color: white;
+  text-align: center; }
+
+article, section, header, footer {
+  display: block; }

data/spec/fixtures/compiled_assets/manifest.json

@@ -0,0 +1 @@
+{"files":{"application-b8588c6975a4539fbf2c11471870bdca.css":{"logical_path":"application.css","mtime":"2012-02-13T05:18:43-05:00","digest":"b8588c6975a4539fbf2c11471870bdca"}},"assets":{"application.css":"application-b8588c6975a4539fbf2c11471870bdca.css"}}

data/spec/helpers_spec.rb

@@ -0,0 +1,293 @@
+require_relative 'spec'
+
+describe Padrino::Assets::Helpers do
+  include Padrino::Helpers::OutputHelpers
+  include Padrino::Helpers::TagHelpers
+  include Padrino::Assets::Helpers
+
+  context '#assets_path' do
+    before do
+      Padrino.after_load.each(&:call)
+      Padrino.clear!
+    end
+
+    it 'should prepend :assets_host when present' do
+      app.set :assets_host, 'http://www.test.com'
+      asset = asset_path('application.css')
+      asset.should == 'http://www.test.com/assets/application.css'
+    end
+
+    it 'should allow :assets_host to use a Proc' do
+      app.set :assets_host, ->(asset, request) { 'http://test.com' }
+      asset = asset_path('application.css')
+      asset.should == 'http://test.com/assets/application.css'
+    end
+
+    it 'should pass the current source to :assets_host when a Proc is used' do
+      app.set :assets_host, ->(asset, request) do
+        if asset =~ /application.css/
+          'http://true.com'
+        else
+          'http://false.com'
+        end
+      end
+      asset = asset_path('application.css')
+      asset.should == 'http://true.com/assets/application.css'
+    end
+
+    it 'should pass the current request to :assets_host when a Proc is used' do
+      app.set :assets_host, ->(asset, request) do
+        if request.ssl?
+          'https://test.com'
+        else
+          'http://test.com'
+        end
+      end
+      asset = asset_path('application.css')
+      asset.should == 'http://test.com/assets/application.css'
+    end
+
+    it 'should append extension when provided' do
+      asset = asset_path(:application, :css)
+      asset.should == '/assets/application.css'
+    end
+
+    it 'should not append extension when one is present' do
+      asset = asset_path('application.css', :css)
+      asset.should_not == '/assets/application.css.css'
+    end
+
+    it 'should prepend :assets_prefix when present' do
+      app.set :assets_prefix, '/test'
+      asset = asset_path('application.css')
+      asset.should == '/test/application.css'
+    end
+
+    it 'should prepend a forward slash to :assets_prefix when missing' do
+      app.set :assets_prefix, 'test'
+      asset = asset_path('application.css')
+      asset.should == '/test/application.css'
+    end
+
+    it 'should not interfere with a reference URI' do
+      asset = asset_path('/application.css')
+      asset.should == '/application.css'
+
+      asset = asset_path('//test.com/application.css')
+      asset.should == '//test.com/application.css'
+    end
+
+    it 'should not interfere with an absolute URI' do
+      asset = asset_path('http://test.com/application.css')
+      asset.should == 'http://test.com/application.css'
+
+      asset = asset_path('https://test.com/application.css')
+      asset.should == 'https://test.com/application.css'
+    end
+
+    it 'should use precompiled asset when assets are indexed' do
+      app.enable :index_assets
+      asset = asset_path('application.css')
+      asset.should == '/assets/application-b8588c6975a4539fbf2c11471870bdca.css'
+    end
+
+    it 'should allow assets that have not been precompiled when assets are index' do
+      app.enable :index_assets
+      asset = asset_path('application.js')
+      asset.should == '/assets/application.js'
+    end
+  end
+
+  context '#is_uri?' do
+    it 'should return true when given an absolute URI' do
+      is_uri?('https://example.com/application.css').should be_true
+      is_uri?('http://example.com/application.css').should be_true
+      is_uri?('ftp://example.com/application.css').should be_true
+    end
+
+    it 'should return true when given a reference URI' do
+      is_uri?('//example.com/assets/application.css').should be_true
+      is_uri?('/assets/application.css').should be_true
+    end
+
+    it 'should return false when given a host without a protocol' do
+      is_uri?('example.com/assets/application.css').should be_false
+    end
+
+    it 'should return false when given an asset' do
+      is_uri?('application.css').should be_false
+    end
+  end
+
+  context '#stylesheet' do
+    it 'should accept multiple sources' do
+      stylesheets = stylesheets(:application, :theme)
+      stylesheets.should have_tag(:link, count: 1, with: { href: '/assets/application.css' })
+      stylesheets.should have_tag(:link, count: 1, with: { href: '/assets/theme.css' })
+    end
+
+    it 'should accept multiple sources with attributes' do
+      stylesheets = stylesheets(:application, :theme, media: 'handheld')
+      stylesheets.should have_tag(:link, count: 1, with: { href: '/assets/application.css', media: 'handheld' })
+      stylesheets.should have_tag(:link, count: 1, with: { href: '/assets/theme.css', media: 'handheld' })
+    end
+
+    it 'should accept a single source' do
+      stylesheet = stylesheet(:application)
+      stylesheet.should have_tag(:link, count: 1, with: { href: '/assets/application.css' })
+    end
+
+    it 'should accept a single source with attributes' do
+      stylesheet = stylesheet(:application, media: 'handheld')
+      stylesheet.should have_tag(:link, count: 1, with: { href: '/assets/application.css', media: 'handheld' })
+    end
+
+    it 'should be aliased for compatibility' do
+      respond_to?(:stylesheet_link_tag).should be_true
+    end
+  end
+
+  context '#javascript' do
+    it 'should accept multiple sources' do
+      javascripts = javascripts(:application, :jquery)
+      javascripts.should have_tag(:script, count: 1, with: { src: '/assets/application.js' })
+      javascripts.should have_tag(:script, count: 1, with: { src: '/assets/jquery.js' })
+    end
+
+    it 'should accept a single source' do
+      javascripts = javascript(:application)
+      javascripts.should have_tag(:script, count: 1, with: { src: '/assets/application.js' })
+    end
+
+    it 'should be aliased for compatibility' do
+      respond_to?(:javascript_include_tag).should be_true
+    end
+  end
+
+  context '#image' do
+    it 'should accept multiple sources' do
+      images = images('application.jpg', 'application.png')
+      images.should have_tag(:img, count: 1, with: { src: '/assets/application.jpg' })
+      images.should have_tag(:img, count: 1, with: { src: '/assets/application.png' })
+    end
+
+    it 'should accept multiple sources with attributes' do
+      images = images('application.jpg', 'application.png', width: 40, height: 40)
+      images.should have_tag(:img, count: 1, with: { src: '/assets/application.jpg', width: 40, height: 40 })
+      images.should have_tag(:img, count: 1, with: { src: '/assets/application.png', width: 40, height: 40 })
+    end
+
+    it 'should accept a single source' do
+      image = image('application.jpg')
+      image.should have_tag(:img, count: 1, with: { src: '/assets/application.jpg' })
+    end
+
+    it 'should accept a single source with attributes' do
+      image = image('application.jpg', width: 40, height: 40)
+      image.should have_tag(:img, count: 1, with: { src: '/assets/application.jpg', width: 40, height: 40 })
+    end
+
+    it 'should allow you to set the :width and :height with :size' do
+      image = image('application.jpg', size: '40x40')
+      image.should have_tag(:img, with: { width: 40, height: 40 })
+    end
+
+    it 'should allow you to use an array with :size' do
+      image = image('application.jpg', size: [40, 40])
+      image.should have_tag(:img, with: { width: 40, height: 40 })
+    end
+
+    it 'should automatically set an alternate text when none present' do
+      images = images('application.jpg', 'test.jpg')
+      images.should have_tag(:img, with: { alt: 'Application' })
+      images.should have_tag(:img, with: { alt: 'Test' })
+    end
+
+    it 'should allow you to manually set the alternate text' do
+      image = image('application.jpg', alt: 'My Little Pony')
+      image.should have_tag(:img, with: { alt: 'My Little Pony' })
+    end
+
+    it 'should be aliased for compatibility' do
+      respond_to?(:image_tag).should be_true
+    end
+  end
+
+  context '#alternate_text' do
+    it 'should capitalize the first letter' do
+      alternate_text = alternate_text('application.jpg')
+      alternate_text.should == 'Application'
+    end
+
+    it 'should seperate underscores' do
+      alternate_text = alternate_text('my_pony.jpg')
+      alternate_text.should == 'My pony'
+    end
+  end
+
+  context '#video' do
+    it 'should accept multiple sources' do
+      videos = videos('test.webm', 'test.mov')
+      videos.should have_tag(:video, count: 1) do
+        with_tag(:source, count: 1, with: { src: '/assets/test.webm' })
+        with_tag(:source, count: 1, with: { src: '/assets/test.mov' })
+      end
+    end
+
+    it 'should accept multiple sources with attributes' do
+      videos = videos('test.webm', 'test.mov', width: 40, height: 40)
+      videos.should have_tag(:video, count: 1, with: { width: 40, height: 40 }) do
+        with_tag(:source, count: 1, with: { src: '/assets/test.webm' })
+        with_tag(:source, count: 1, with: { src: '/assets/test.mov' })
+      end
+    end
+
+    it 'should accept a single source' do
+      video = video('test.webm')
+      video.should have_tag(:video, count: 1, with: { src: '/assets/test.webm' })
+    end
+
+    it 'should accept a single source with attributes' do
+      video = video('test.webm', width: 40, height: 40)
+      video.should have_tag(:video, count: 1, with: { src: '/assets/test.webm', width: 40, height: 40 })
+    end
+
+    it 'should allow you to set the :width and :height with :size' do
+      video = video('test.webm', size: '40x40')
+      video.should have_tag(:video, with: { width: 40, height: 40 })
+    end
+
+    it 'should allow you to use an array with :size' do
+      video = video('test.webm', size: [40, 40])
+      video.should have_tag(:video, with: { width: 40, height: 40 })
+    end
+  end
+
+  context '#audio' do
+    it 'should accept multiple sources' do
+      audios = audios('test.ogg', 'test.aac')
+      audios.should have_tag(:audio, count: 1) do
+        with_tag(:source, count: 1, with: { src: '/assets/test.ogg' })
+        with_tag(:source, count: 1, with: { src: '/assets/test.aac' })
+      end
+    end
+
+    it 'should accept multiple sources with attributes' do
+      audios = audios('test.ogg', 'test.aac', id: 'audio')
+      audios.should have_tag(:audio, count: 1, with: { id: 'audio' }) do
+        with_tag(:source, count: 1, with: { src: '/assets/test.ogg' })
+        with_tag(:source, count: 1, with: { src: '/assets/test.aac' })
+      end
+    end
+
+    it 'should accept a single source' do
+      audio = audio('test.ogg')
+      audio.should have_tag(:audio, count: 1, with: { src: '/assets/test.ogg' })
+    end
+
+    it 'should accept a single source with attributes' do
+      audio = audio('test.ogg', id: 'audio')
+      audio.should have_tag(:audio, count: 1, with: { src: '/assets/test.ogg', id: 'audio' })
+    end
+  end
+end