fewer 0.2.0 → 0.3.0

data/.gitignore

@@ -1,3 +1,5 @@
+*.gem
+.bundle
 /coverage
-/pkg
-/rdoc
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fewer.gemspec
+gemspec

data/README.md

@@ -22,8 +22,8 @@ Using Fewer in your Rails app is easy, just initialize your Fewer apps and add t
     )
 
     # config/routes.rb
-    match '/javascripts/:data.js', :to => Fewer::App[:javascripts]
-    match '/stylesheets/:data.css', :to => Fewer::App[:stylesheets]
+    match '/javascripts/*data.js', :to => Fewer::App[:javascripts]
+    match '/stylesheets/*data.css', :to => Fewer::App[:stylesheets]
 
     # app/helpers/application_helper.rb
     module ApplicationHelper

data/Rakefile

@@ -1,22 +1,7 @@
-require 'rubygems'
-require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "fewer"
-    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']
-    gem.add_dependency('rack')
-    # 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
+task :default => :test
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -31,23 +16,10 @@ begin
     test.libs << 'test'
     test.pattern = 'test/**/*_test.rb'
     test.verbose = true
+    test.rcov_opts << '--exclude "gems/*"'
   end
 rescue LoadError
   task :rcov do
     abort 'RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov'
   end
 end
-
-task :test => :check_dependencies
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "fewer #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/fewer.gemspec

@@ -1,69 +1,28 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fewer/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{fewer}
-  s.version = "0.2.0"
+  s.name        = "fewer"
+  s.version     = Fewer::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ben Pickles"]
+  s.email       = ["spideryoung@gmail.com"]
+  s.homepage    = 'https://github.com/benpickles/fewer'
+  s.summary     = 'Fewer is a Rack endpoint to bundle and cache assets and help you make fewer HTTP requests.'
+  s.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.'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Ben Pickles"]
-  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",
-     "README.md"
-  ]
-  s.files = [
-    ".gitignore",
-     "LICENSE",
-     "README.md",
-     "Rakefile",
-     "VERSION",
-     "fewer.gemspec",
-     "lib/fewer.rb",
-     "lib/fewer/app.rb",
-     "lib/fewer/engines.rb",
-     "lib/fewer/engines/abstract.rb",
-     "lib/fewer/engines/css.rb",
-     "lib/fewer/engines/js.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.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.rubygems_version = %q{1.3.7}
-  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",
-     "test/middleware_test.rb",
-     "test/test_helper.rb"
-  ]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.add_runtime_dependency('rack', '>= 0')
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rack>, [">= 0"])
-    else
-      s.add_dependency(%q<rack>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rack>, [">= 0"])
-  end
+  s.add_development_dependency('activesupport')
+  s.add_development_dependency('leftright') if RUBY_VERSION < '1.9'
+  s.add_development_dependency('less')
+  s.add_development_dependency('mocha')
+  s.add_development_dependency('rack-test')
+  s.add_development_dependency('fakefs')
 end
-

data/lib/fewer.rb

@@ -1,6 +1,24 @@
+module Fewer
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= begin
+        defined?(Rails) ? Rails.logger : begin
+          require 'logger'
+          log = Logger.new(STDOUT)
+          log.level = Logger::INFO
+          log
+        end
+      end
+    end
+  end
+end
+
 require 'fewer/app'
 require 'fewer/engines'
 require 'fewer/errors'
 require 'fewer/middleware'
 require 'fewer/rails_helpers'
 require 'fewer/serializer'
+require 'fewer/version'

data/lib/fewer/app.rb

@@ -18,23 +18,30 @@ module Fewer
       @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
+      raise ArgumentError.new('You need to define an :engine class') unless @engine_klass
+      raise ArgumentError.new('You need to define a :root path') unless @root
       self.class.apps[name] = self
     end
 
     def call(env)
-      eng = engine(names_from_path(env['PATH_INFO']))
-      headers = {
-        'Content-Type' => eng.content_type,
-        'Cache-Control' => "public, max-age=#{cache}",
-        'Last-Modified' => eng.mtime.rfc2822
-      }
-
-      [200, headers, [eng.read]]
+      eng = engine(sources_from_path(env['PATH_INFO']))
+
+      if env["HTTP_IF_NONE_MATCH"] && env["HTTP_IF_NONE_MATCH"] == eng.etag
+        Fewer.logger.debug "Fewer: returning 304 not modified"
+        [304, {}, []]
+      else
+        headers = {
+          'Content-Type' => engine_klass.content_type || 'text/plain',
+          'Cache-Control' => "public, max-age=#{cache}",
+          'Last-Modified' => eng.mtime.rfc2822,
+          'ETag' => eng.etag
+        }
+
+        [200, headers, [eng.read]]
+      end
     rescue Fewer::MissingSourceFileError => e
       [404, { 'Content-Type' => 'text/plain' }, [e.message]]
-    rescue => e
+    rescue StandardError => e
       [500, { 'Content-Type' => 'text/plain' }, ["#{e.class}: #{e.message}"]]
     end
 
@@ -43,9 +50,9 @@ module Fewer
     end
 
     private
-      def names_from_path(path)
-        encoded = File.basename(path, '.*')
-        Serializer.decode(encoded)
+      def sources_from_path(path)
+        encoded = File.basename(path, '.*').split('-').first
+        Serializer.decode(root, encoded)
       end
   end
 end

data/lib/fewer/engines/abstract.rb

@@ -1,58 +1,66 @@
+require 'digest/md5'
+
 module Fewer
   module Engines
     class Abstract
-      SANITISE_REGEXP = /^#{File::Separator}|\.\.#{File::Separator}/
+      SANITISE_REGEXP = /\.?\.#{File::Separator}/
+
+      class << self
+        attr_accessor :content_type, :extension
+      end
 
-      attr_reader :names, :options, :root
+      attr_reader :options, :paths, :root
 
-      def initialize(root, names, options = {})
-        @root = root
-        @names = names.is_a?(Array) ? names : [names]
+      def initialize(root, paths, options = {})
+        @root = root.to_s
+        @paths = paths
         @options = options
-        sanitise_names!
+        sanitise_paths!
         check_paths!
       end
 
-      def content_type
-        'text/plain'
-      end
-
       def encoded
-        Serializer.encode(names)
-      end
-
-      def extension
+        Serializer.encode(root, paths)
       end
 
       def mtime
         paths.map { |path|
           File.mtime(path)
-        }.max
+        }.max || Time.now
       end
 
-      def paths
-        @paths ||= names.map { |name|
-          File.join(root, "#{name}#{extension}")
-        }
+      def etag
+        # MD5 for concatenation of all files
+        Digest::MD5.hexdigest(source)
       end
 
       def read
-        paths.map { |path|
+        source
+      end
+
+      def source
+        @source ||= paths.map { |path|
           File.read(path)
         }.join("\n")
       end
 
       private
         def check_paths!
-          if (missing = paths.reject { |path| File.exist?(path) }).any?
-            files = missing.map { |path| path.to_s }.join("\n")
-            raise Fewer::MissingSourceFileError.new("Missing source file#{'s' if missing.size > 1}:\n#{files}")
+          missing = paths.reject { |path| File.exist?(path) }
+
+          if missing.any?
+            raise Fewer::MissingSourceFileError.new(
+              "Missing source file#{'s' if missing.size > 1}:\n" +
+              missing.join("\n"))
           end
         end
 
-        def sanitise_names!
-          names.map! { |name|
-            name.to_s.gsub(SANITISE_REGEXP, '')
+        def sanitise_paths!
+          paths.map! { |path|
+            path = path.to_s
+            path.gsub!(SANITISE_REGEXP, '')
+            path.replace(File.join(root, path)) if path[0, root.length] != root
+            path
           }
         end
     end

data/lib/fewer/engines/css.rb

@@ -1,13 +1,8 @@
 module Fewer
   module Engines
     class Css < Abstract
-      def content_type
-        'text/css'
-      end
-
-      def extension
-        '.css'
-      end
+      self.content_type = 'text/css'
+      self.extension = '.css'
     end
   end
 end

data/lib/fewer/engines/js.rb

@@ -3,13 +3,8 @@ autoload :Closure, 'closure-compiler'
 module Fewer
   module Engines
     class Js < Abstract
-      def content_type
-        'application/x-javascript'
-      end
-
-      def extension
-        '.js'
-      end
+      self.content_type = 'application/x-javascript'
+      self.extension = '.js'
 
       def read
         if options[:min]

data/lib/fewer/engines/less.rb

@@ -3,17 +3,12 @@ autoload :Less, 'less'
 module Fewer
   module Engines
     class Less < Abstract
-      def content_type
-        'text/css'
-      end
-
-      def extension
-        '.less'
-      end
+      self.content_type = 'text/css'
+      self.extension = '.less'
 
       def read
         Dir.chdir root do
-          ::Less::Engine.new(super).to_css
+          ::Less::Engine.new(source).to_css
         end
       end
     end

data/lib/fewer/middleware.rb

@@ -16,4 +16,3 @@ module Fewer
     end
   end
 end
-

data/lib/fewer/rails_helpers.rb

@@ -1,13 +1,35 @@
 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}"
+    def fewer_encode_sources(app, sources, friendly_ext = nil)
+      ext = app.engine_klass.extension
+      sources.map! { |source|
+        ext && source[-ext.length, ext.length] != ext ? "#{source}#{ext}" : source
+      }
+
+      if config.perform_caching
+        engine = app.engine(sources)
+        ["#{engine.mtime.to_i.to_s(36)}/#{engine.encoded}#{friendly_ext}"]
+      else
+        sources.map { |source|
+          engine = app.engine([source])
+          friendly_name = File.basename(source, '.*')
+          "#{engine.mtime.to_i.to_s(36)}/#{engine.encoded}-#{friendly_name}#{friendly_ext}"
+        }
+      end
+    end
+
+    def fewer_javascripts_tag(*sources)
+      options = sources.extract_options!
+      options.delete(:cache)
+      app = Fewer::App[:javascripts]
+      javascript_include_tag fewer_encode_sources(app, sources, '.js'), options
     end
 
-    def fewer_stylesheets_tag(*names)
-      engine = Fewer::App[:stylesheets].engine(names)
-      stylesheet_link_tag "#{engine.encoded}.css?#{engine.mtime.to_i}"
+    def fewer_stylesheets_tag(*sources)
+      options = sources.extract_options!
+      options.delete(:cache)
+      app = Fewer::App[:stylesheets]
+      stylesheet_link_tag fewer_encode_sources(app, sources, '.css'), options
     end
   end
 end

data/lib/fewer/serializer.rb

@@ -1,30 +1,33 @@
-require 'base64'
-
 module Fewer
   module Serializer
-    class BadString < RuntimeError; end
-
     class << self
-      def b64_decode(string)
-        padding_length = string.length % 4
-        Base64.decode64(string + '=' * padding_length)
-      end
+      def decode(root, encoded)
+        files = ls(root)
+        delimeter = files.length > 36 ? ',' : ''
 
-      def b64_encode(string)
-        Base64.encode64(string).tr("\n=",'')
+        encoded.split(delimeter).map { |char|
+          files[char.to_i(36)]
+        }.compact
       end
 
-      def marshal_decode(string)
-        Marshal.load(b64_decode(string))
-      rescue TypeError, ArgumentError => e
-        raise BadString, "couldn't decode #{string} - got #{e}"
-      end
-      alias_method :decode, :marshal_decode
+      def encode(root, paths)
+        files = ls(root)
+        delimeter = files.length > 36 ? ',' : ''
 
-      def marshal_encode(object)
-        b64_encode(Marshal.dump(object))
+        paths.map { |path|
+          index = files.index(path)
+          index ? index.to_s(36) : nil
+        }.compact.join(delimeter)
       end
-      alias_method :encode, :marshal_encode
+
+      private
+        def ls(root)
+          pattern = File.join(root, '**', '*.*')
+
+          Dir.glob(pattern).sort.delete_if { |path|
+            File.directory?(path)
+          }
+        end
     end
   end
 end