fewer 0.1.0 → 0.2.0

data/README.md

@@ -1,6 +1,38 @@
-# fewer
+# Fewer
 
-Rack middleware to bundle assets and help you make fewer HTTP requests.
+Fewer is a Rack endpoint to bundle and cache assets and help you make fewer HTTP requests. Fewer extracts and combines a list of assets encoded in the URL and serves the response with far-future HTTP caching headers.
+
+## How to use in Rails 3
+
+Using Fewer in your Rails app is easy, just initialize your Fewer apps and add them to your routes then include the helper methods in your `ApplicationHelper` with a one-liner.
+
+    # Gemfile
+    gem 'fewer'
+    gem 'closure-compiler', :group => :production
+
+    # config/initializers/fewer.rb
+    Fewer::App.new(:javascripts,
+      :engine => Fewer::Engines::Js,
+      :engine_options => { :min => Rails.env.production? }
+      :root => Rails.root.join('app', 'javascripts')
+    )
+    Fewer::App.new(:stylesheets,
+      :engine => Fewer::Engines::Css,
+      :root => Rails.root.join('app', 'stylesheets')
+    )
+
+    # config/routes.rb
+    match '/javascripts/:data.js', :to => Fewer::App[:javascripts]
+    match '/stylesheets/:data.css', :to => Fewer::App[:stylesheets]
+
+    # app/helpers/application_helper.rb
+    module ApplicationHelper
+      include Fewer::RailsHelpers
+    end
+
+    # app/views/layouts/application.html.erb
+    <%= fewer_javascripts_tag 'long', 'list', 'of/nested', 'js/files' %>
+    <%= fewer_stylesheets_tag 'some', 'css', 'files' %>
 
 ## How to use as a Rack app (config.ru example)
 
@@ -18,21 +50,6 @@ Rack middleware to bundle assets and help you make fewer HTTP requests.
 
     run app
 
-## How to use in Rails 3 router
-
-    match '/stylesheets/:data.css', :to => Fewer::App.new(
-      :engine => Fewer::Engines::Less,
-      :root => Rails.root.join('app', 'stylesheets')
-    )
-
-## How to use in Rails as middleware
-
-    config.middleware.use Fewer::MiddleWare, {
-      :engine => Fewer::Engines::Less,
-      :mount => '/stylesheets',
-      :root => Rails.root.join('app', 'stylesheets')
-    }
-
 ## Copyright
 
 Copyright (c) 2010 Ben Pickles. See LICENSE for details.

data/Rakefile

@@ -5,8 +5,8 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "fewer"
-    gem.summary = %q{Rack middleware to bundle assets and help you make fewer HTTP requests.}
-    gem.description = %q{Rack middleware to bundle assets and help you make fewer HTTP requests.}
+    gem.summary = 'Fewer is a Rack endpoint to bundle and cache assets and help you make fewer HTTP requests.'
+    gem.description = 'Fewer is a Rack endpoint to bundle and cache assets and help you make fewer HTTP requests. Fewer extracts and combines a list of assets encoded in the URL and serves the response with far-future HTTP caching headers.'
     gem.email = 'spideryoung@gmail.com'
     gem.homepage = 'http://github.com/benpickles/fewer'
     gem.authors = ['Ben Pickles']

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/fewer.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{fewer}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Pickles"]
-  s.date = %q{2010-08-10}
-  s.description = %q{Rack middleware to bundle assets and help you make fewer HTTP requests.}
+  s.date = %q{2010-08-17}
+  s.description = %q{Fewer is a Rack endpoint to bundle and cache assets and help you make fewer HTTP requests. Fewer extracts and combines a list of assets encoded in the URL and serves the response with far-future HTTP caching headers.}
   s.email = %q{spideryoung@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -29,21 +29,23 @@ Gem::Specification.new do |s|
      "lib/fewer/engines/abstract.rb",
      "lib/fewer/engines/css.rb",
      "lib/fewer/engines/js.rb",
-     "lib/fewer/engines/js_min.rb",
      "lib/fewer/engines/less.rb",
      "lib/fewer/errors.rb",
      "lib/fewer/middleware.rb",
+     "lib/fewer/rails_helpers.rb",
      "lib/fewer/serializer.rb",
      "test/app_test.rb",
      "test/engine_test.rb",
      "test/middleware_test.rb",
+     "test/templates/rounded.less",
+     "test/templates/style.less",
      "test/test_helper.rb"
   ]
   s.homepage = %q{http://github.com/benpickles/fewer}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Rack middleware to bundle assets and help you make fewer HTTP requests.}
+  s.summary = %q{Fewer is a Rack endpoint to bundle and cache assets and help you make fewer HTTP requests.}
   s.test_files = [
     "test/app_test.rb",
      "test/engine_test.rb",

data/lib/fewer.rb

@@ -2,4 +2,5 @@ require 'fewer/app'
 require 'fewer/engines'
 require 'fewer/errors'
 require 'fewer/middleware'
+require 'fewer/rails_helpers'
 require 'fewer/serializer'

data/lib/fewer/app.rb

@@ -1,31 +1,47 @@
 module Fewer
   class App
-    attr_reader :engine_klass, :cache, :root
+    class << self
+      def [](name)
+        apps[name]
+      end
+
+      def apps
+        @apps ||= {}
+      end
+    end
 
-    def initialize(options = {})
+    attr_reader :cache, :engine_klass, :engine_options, :name, :root
+
+    def initialize(name, options = {})
       @engine_klass = options[:engine]
+      @engine_options = options[:engine_options] || {}
       @mount = options[:mount]
       @root = options[:root]
       @cache = options[:cache] || 3600 * 24 * 365
       raise 'You need to define an :engine class' unless @engine_klass
       raise 'You need to define a :root path' unless @root
+      self.class.apps[name] = self
     end
 
     def call(env)
-      names = names_from_path(env['PATH_INFO'])
-      engine = engine_klass.new(root, names)
+      eng = engine(names_from_path(env['PATH_INFO']))
       headers = {
-        'Content-Type' => engine.content_type,
-        'Cache-Control' => "public, max-age=#{cache}"
+        'Content-Type' => eng.content_type,
+        'Cache-Control' => "public, max-age=#{cache}",
+        'Last-Modified' => eng.mtime.rfc2822
       }
 
-      [200, headers, [engine.read]]
+      [200, headers, [eng.read]]
     rescue Fewer::MissingSourceFileError => e
       [404, { 'Content-Type' => 'text/plain' }, [e.message]]
     rescue => e
       [500, { 'Content-Type' => 'text/plain' }, ["#{e.class}: #{e.message}"]]
     end
 
+    def engine(names)
+      engine_klass.new(root, names, engine_options)
+    end
+
     private
       def names_from_path(path)
         encoded = File.basename(path, '.*')

data/lib/fewer/engines.rb

@@ -3,7 +3,6 @@ module Fewer
     autoload :Abstract, 'fewer/engines/abstract'
     autoload :Css,      'fewer/engines/css'
     autoload :Js,       'fewer/engines/js'
-    autoload :JsMin,    'fewer/engines/js_min'
     autoload :Less,     'fewer/engines/less'
   end
 end

data/lib/fewer/engines/abstract.rb

@@ -1,11 +1,15 @@
 module Fewer
   module Engines
     class Abstract
-      attr_reader :names, :root
+      SANITISE_REGEXP = /^#{File::Separator}|\.\.#{File::Separator}/
 
-      def initialize(root, names)
+      attr_reader :names, :options, :root
+
+      def initialize(root, names, options = {})
         @root = root
-        @names = names
+        @names = names.is_a?(Array) ? names : [names]
+        @options = options
+        sanitise_names!
         check_paths!
       end
 
@@ -13,18 +17,22 @@ module Fewer
         'text/plain'
       end
 
+      def encoded
+        Serializer.encode(names)
+      end
+
       def extension
       end
 
       def mtime
         paths.map { |path|
-          File.mtime(path).to_i
-        }.sort.last
+          File.mtime(path)
+        }.max
       end
 
       def paths
-        names.map { |name|
-          File.join(root, "#{File.basename(name.to_s)}#{extension}")
+        @paths ||= names.map { |name|
+          File.join(root, "#{name}#{extension}")
         }
       end
 
@@ -41,6 +49,12 @@ module Fewer
             raise Fewer::MissingSourceFileError.new("Missing source file#{'s' if missing.size > 1}:\n#{files}")
           end
         end
+
+        def sanitise_names!
+          names.map! { |name|
+            name.to_s.gsub(SANITISE_REGEXP, '')
+          }
+        end
     end
   end
 end

data/lib/fewer/engines/js.rb

@@ -1,3 +1,5 @@
+autoload :Closure, 'closure-compiler'
+
 module Fewer
   module Engines
     class Js < Abstract
@@ -8,6 +10,14 @@ module Fewer
       def extension
         '.js'
       end
+
+      def read
+        if options[:min]
+          ::Closure::Compiler.new.compress(super)
+        else
+          super
+        end
+      end
     end
   end
 end

data/lib/fewer/engines/less.rb

@@ -12,7 +12,9 @@ module Fewer
       end
 
       def read
-        ::Less::Engine.new(super).to_css
+        Dir.chdir root do
+          ::Less::Engine.new(super).to_css
+        end
       end
     end
   end

data/lib/fewer/middleware.rb

@@ -1,6 +1,7 @@
 module Fewer
   class MiddleWare
-    def initialize(app, options = {})
+    def initialize(app, name, options = {})
+      @name = name
       @options = options
       @app = app
       @mount = @options[:mount]
@@ -8,7 +9,7 @@ module Fewer
 
     def call(env)
       if env['PATH_INFO'] =~ /^#{@mount}/
-        App.new(@options).call(env)
+        App.new(@name, @options).call(env)
       else
         @app.call(env)
       end

data/lib/fewer/rails_helpers.rb

@@ -0,0 +1,13 @@
+module Fewer
+  module RailsHelpers
+    def fewer_javascripts_tag(*names)
+      engine = Fewer::App[:javascripts].engine(names)
+      javascript_include_tag "#{engine.encoded}.js?#{engine.mtime.to_i}"
+    end
+
+    def fewer_stylesheets_tag(*names)
+      engine = Fewer::App[:stylesheets].engine(names)
+      stylesheet_link_tag "#{engine.encoded}.css?#{engine.mtime.to_i}"
+    end
+  end
+end

data/test/app_test.rb

@@ -8,25 +8,31 @@ class AppTest < Test::Unit::TestCase
     @engine = stub(
       :check_request_extension => true,
       :content_type => 'text/css',
+      :mtime => Time.utc(2010, 8, 17, 21, 5, 24),
       :read => 'content'
     )
     @engine_klass = stub(:new => @engine)
-    @fewer_app = Fewer::App.new({
+    @fewer_app = Fewer::App.new(:name,
       :engine => @engine_klass,
       :root => 'root'
-    })
+    )
     @browser = Rack::Test::Session.new(Rack::MockSession.new(@fewer_app))
   end
 
+  def test_can_retrieve_app_by_name
+    assert_nil Fewer::App[:not_name]
+    assert_equal @fewer_app, Fewer::App[:name]
+  end
+
   def test_initialises_a_new_engine_with_a_single_file
     file = 'file'
-    @engine_klass.expects(:new).with('root', file).returns(@engine)
+    @engine_klass.expects(:new).with('root', file, {}).returns(@engine)
     @browser.get "/path/#{encode(file)}.css"
   end
 
   def test_initialises_a_new_engine_with_multiple_files
     files = ['file1', 'file2']
-    @engine_klass.expects(:new).with('root', files).returns(@engine)
+    @engine_klass.expects(:new).with('root', files, {}).returns(@engine)
     @browser.get "/path/#{encode(files)}.css"
   end
 
@@ -40,6 +46,11 @@ class AppTest < Test::Unit::TestCase
     assert_equal 'public, max-age=31536000', @browser.last_response.headers['Cache-Control']
   end
 
+  def test_responds_with_last_modified
+    @browser.get "/path/#{encode('file')}.css"
+    assert_equal 'Tue, 17 Aug 2010 21:05:24 -0000', @browser.last_response.headers['Last-Modified']
+  end
+
   def test_responds_with_bundled_content
     @engine.expects(:read).returns('content')
     @browser.get "/path/#{encode('file')}.css"

data/test/engine_test.rb

@@ -1,10 +1,24 @@
 require 'test_helper'
 
 class EngineTest < Test::Unit::TestCase
+  include TestHelper
+
   def test_sanitise_paths
-    bad_files = ['./../private.txt', '/etc/passwd']
-    engine = engine_klass_no_checking.new('./happy-place', bad_files)
-    assert_equal ['./happy-place/private.txt', './happy-place/passwd'], engine.paths
+    files = [
+      'dir/ectory/file.js',
+      'sub/dir/ectory/file.js',
+      './../private.txt',
+      '/etc/passwd',
+      '/etc/../passwd'
+    ]
+    engine = engine_klass_no_checking.new('./happy-place', files)
+    assert_equal [
+      './happy-place/dir/ectory/file.js',
+      './happy-place/sub/dir/ectory/file.js',
+      './happy-place/./private.txt',
+      './happy-place/etc/passwd',
+      './happy-place/etc/passwd'
+    ], engine.paths
   end
 
   def test_stringify_paths
@@ -12,6 +26,31 @@ class EngineTest < Test::Unit::TestCase
     assert_equal ['./symbol', './ab'], engine.paths
   end
 
+  def test_converts_names_to_an_array
+    engine = engine_klass_no_checking.new(template_root, 'style')
+    assert_equal ['style'], engine.names
+  end
+
+  def test_raises_error_for_missing_file
+    assert_raises Fewer::MissingSourceFileError do
+      Fewer::Engines::Abstract.new(template_root, ['does-not-exist'])
+    end
+  end
+
+  def test_can_deal_with_encoding_for_you
+    names = ['a', 'b']
+    engine = engine_klass_no_checking.new(template_root, names)
+    Fewer::Serializer.expects(:encode).with(names)
+    engine.encoded
+  end
+
+  def test_less_import_command
+    engine = Fewer::Engines::Less.new(template_root, ['style'])
+    assert_nothing_raised do
+      engine.read
+    end
+  end
+
   private
     def engine_klass(&block)
       Class.new(Fewer::Engines::Abstract, &block)

data/test/middleware_test.rb

@@ -8,13 +8,14 @@ class MiddlewareTest < Test::Unit::TestCase
     @engine = stub(
       :check_request_extension => true,
       :content_type => 'text/css',
+      :mtime => Time.utc(2010, 8, 17, 21, 5, 24),
       :read => 'content'
     )
     Fewer::Engines::Css.stubs(:new).returns(@engine)
 
     @app = Rack::Builder.new do
       map '/' do
-        use Fewer::MiddleWare,
+        use Fewer::MiddleWare, :name,
               :root => '/some/root/path',
               :engine => Fewer::Engines::Css,
               :mount => '/css'

data/test/templates/rounded.less

@@ -0,0 +1,5 @@
+.rounded_corners (@radius: 5px) {
+  -moz-border-radius: @radius;
+  -webkit-border-radius: @radius;
+  border-radius: @radius;
+}

data/test/templates/style.less

@@ -0,0 +1,5 @@
+@import "rounded";
+
+div {
+  .rounded_corners(10px);
+}

data/test/test_helper.rb

@@ -11,6 +11,7 @@ rescue LoadError
 end
 
 require 'fewer'
+require 'less'
 
 module TestHelper
   private
@@ -21,4 +22,8 @@ module TestHelper
     def encode(obj)
       Fewer::Serializer.encode(obj)
     end
+
+    def template_root
+      File.expand_path('../templates', __FILE__)
+    end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: fewer
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ben Pickles
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-10 00:00:00 +01:00
+date: 2010-08-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-description: Rack middleware to bundle assets and help you make fewer HTTP requests.
+description: Fewer is a Rack endpoint to bundle and cache assets and help you make fewer HTTP requests. Fewer extracts and combines a list of assets encoded in the URL and serves the response with far-future HTTP caching headers.
 email: spideryoung@gmail.com
 executables: []
 
@@ -54,14 +54,16 @@ files:
 - lib/fewer/engines/abstract.rb
 - lib/fewer/engines/css.rb
 - lib/fewer/engines/js.rb
-- lib/fewer/engines/js_min.rb
 - lib/fewer/engines/less.rb
 - lib/fewer/errors.rb
 - lib/fewer/middleware.rb
+- lib/fewer/rails_helpers.rb
 - lib/fewer/serializer.rb
 - test/app_test.rb
 - test/engine_test.rb
 - test/middleware_test.rb
+- test/templates/rounded.less
+- test/templates/style.less
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/benpickles/fewer
@@ -96,7 +98,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Rack middleware to bundle assets and help you make fewer HTTP requests.
+summary: Fewer is a Rack endpoint to bundle and cache assets and help you make fewer HTTP requests.
 test_files: 
 - test/app_test.rb
 - test/engine_test.rb

data/lib/fewer/engines/js_min.rb

@@ -1,19 +0,0 @@
-autoload :Closure, 'closure-compiler'
-
-module Fewer
-  module Engines
-    class JsMin < Abstract
-      def content_type
-        'application/x-javascript'
-      end
-
-      def extension
-        '.js'
-      end
-
-      def read
-        ::Closure::Compiler.new.compress(super)
-      end
-    end
-  end
-end