rack-sprockets 1.0.4 → 1.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+/pkg/
+/doc/
+/coverage/
+*.log
+*.bundle/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    rack-sprockets (1.0.4)
+      rack (~> 1.0)
+      sprockets (~> 1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    json (1.5.1)
+    kelredd-useful (0.4.1)
+      json
+    leftright (0.9.0)
+    nokogiri (1.4.4)
+    rack (1.2.2)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    shoulda (2.11.3)
+    sinatra (1.2.1)
+      rack (~> 1.1)
+      tilt (>= 1.2.2, < 2.0)
+    sprockets (1.0.2)
+    test-belt (0.2.1)
+      kelredd-useful (~> 0.4.0)
+      leftright (~> 0.9.0)
+      shoulda (~> 2.11)
+    tilt (1.2.2)
+    webrat (0.7.3)
+      nokogiri (>= 1.2.0)
+      rack (>= 1.0)
+      rack-test (>= 0.5.3)
+    yui-compressor (0.9.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  rack (~> 1.0)
+  rack-sprockets!
+  rack-test (>= 0.5.3)
+  sinatra (>= 0.9.4)
+  sprockets (~> 1.0)
+  test-belt (= 0.2.1)
+  webrat (>= 0.6.0)
+  yui-compressor (>= 0.9.1)

data/README.rdoc

@@ -60,10 +60,10 @@ These are similar to sprockets options and, where applicable, map directly to a
   - The path where static files are located.  Maps to the `:asset_root` Sprockets option.
 
 * :*source* ["app/javascripts"]
-  - The path where Sprockets source files are located.  Notice this does not map to the `:source_files` Sprockets option.  It is assumed that any requested resource found in `:source` be treated as a Sprockets source file.
+  - The root path where Sprockets source resources are located.  Notice this does not map to the `:source_files` Sprockets option.  It is assumed that any requested resource found in `:source` be treated as a Sprockets source file.
   
 * :*hosted_at* ["/javascripts"]
-  - The public hosted HTTP path for static javascripts files.
+  - The public hosted HTTP path for static javascript files.
 
 * :*load_path* [["app/javascripts/", "vendor/javascripts/"]]
   - An ordered array of directory names to search for dependencies in.  Maps to the `:load_path` Sprockets option.

data/Rakefile

@@ -1,62 +1,7 @@
-require 'rubygems'
-require 'rake/gempackagetask'
-require 'rake/testtask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-require File.expand_path('../lib/rack/sprockets/version', __FILE__)
+require 'test_belt/rake_tasks'
+TestBelt::RakeTasks.for :test
 
-spec = Gem::Specification.new do |s|
-  s.name             = 'rack-sprockets'
-  s.version          = RackSprockets::Version.to_s
-  s.has_rdoc         = true
-  s.extra_rdoc_files = %w(README.rdoc)
-  s.rdoc_options     = %w(--main README.rdoc)
-  s.summary          = "Sprockets javascript preprocessing for Rack apps."
-  s.author           = 'Kelly Redding'
-  s.email            = 'kelly@kelredd.com'
-  s.homepage         = 'http://github.com/kelredd/rack-sprockets'
-  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib}/**/*")
-  # s.executables    = ['rack-sprockets']
-
-  s.add_development_dependency("shoulda", [">= 2.10.0"])
-  s.add_development_dependency("sinatra", [">= 0.9.4"])
-  s.add_development_dependency("rack-test", [">= 0.5.3"])
-  s.add_development_dependency("webrat", [">= 0.6.0"])
-  s.add_development_dependency("yui-compressor", [">=0.9.1"])
-
-  s.add_dependency("rack", [">= 0.4"])
-  s.add_dependency("sprockets", [">= 1.0.0"])
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
-end
-
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList["test/**/*_test.rb"]
-  t.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-
-  Rcov::RcovTask.new(:coverage) do |t|
-    t.libs       = ['test']
-    t.test_files = FileList["test/**/*_test.rb"]
-    t.verbose    = true
-    t.rcov_opts  = ['--text-report', "-x #{Gem.path}", '-x /Library/Ruby', '-x /usr/lib/ruby']
-  end
-  
-  task :default => :coverage
-  
-rescue LoadError
-  warn "\n**** Install rcov (sudo gem install relevance-rcov) to get coverage stats ****\n"
-  task :default => :test
-end
-
-desc 'Generate the gemspec to serve this gem'
-task :gemspec do
-  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
-  File.open(file, 'w') {|f| f << spec.to_ruby }
-  puts "Created gemspec: #{file}"
-end
+task :default => :build

data/demos/yui_compressed/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem 'sinatra'
+gem 'rack-sprockets', '~>1.0.4', :require => "rack/sprockets"
+gem 'yui-compressor'

data/demos/yui_compressed/Gemfile.lock

@@ -0,0 +1,19 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    rack (1.2.1)
+    rack-sprockets (1.0.4)
+      rack (>= 0.4)
+      sprockets (>= 1.0.0)
+    sinatra (1.0)
+      rack (>= 1.0)
+    sprockets (1.0.2)
+    yui-compressor (0.9.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-sprockets (~> 1.0.4)
+  sinatra
+  yui-compressor

data/demos/yui_compressed/REAME.rdoc

@@ -0,0 +1,13 @@
+== YUI Compressor Rack Sprockets demo
+
+This demo will use rack sprockets to define an /javascripts/app.js resource.  To run and test this demo, do the following:
+
+1. Pull the latest rack-sprockets repo
+2. cd demos/yui_compressed
+3. bundle install
+4. ruby app.rb #starts up sinatra app on localhost:4567
+5. Browse to http://localhost:4567/javascripts/app.rb
+6. see a compressed js resource
+7. see a new cached file named app.js written to demos/yui-compressed/public/javascripts
+
+Hope this helps as a working usage demo.  This was written to help resolve issue #2: http://github.com/kelredd/rack-sprockets/issues/#issue/2

data/demos/yui_compressed/app.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'sinatra'
+Bundler.require(:default)
+
+# use the rack-sprockets middleware with default options:
+# => http://github.com/kelredd/rack-sprockets --> README --> "Available Options" for details
+use Rack::Sprockets
+
+# configure rack-sprockets with custom configuration settings
+# => http://github.com/kelredd/rack-sprockets --> README --> "Available Configurations" for details
+Rack::Sprockets.configure do |config|
+  config.cache = true
+  config.compress = :yui
+end

data/demos/yui_compressed/app/javascripts/alert_one.js

@@ -0,0 +1,4 @@
+function one_message() {
+  var one_msg = 'alert one';
+  alert(one_msg);
+}

data/demos/yui_compressed/app/javascripts/alert_two.js

@@ -0,0 +1,4 @@
+function two_message() {
+  var two_msg = 'alert 2';
+  alert(two_msg);
+}

data/demos/yui_compressed/app/javascripts/app.js

@@ -0,0 +1,16 @@
+//= require <alert_one>
+//= require <alert_two>
+
+function app_message() {
+  var app_msg = 'full app';
+  alert(app_msg);
+}
+
+function () {
+  var foo = {};
+  foo["bar"] = "baz";
+}
+
+one_message();
+two_message();
+app_message();

data/demos/yui_compressed/public/javascripts/app.js

@@ -0,0 +1 @@
+function one_message(){var a="alert one";alert(a)}function two_message(){var a="alert 2";alert(a)}function app_message(){var a="full app";alert(a)}function(){var a={};a.bar="baz"}one_message();two_message();app_message();

data/demos/yui_compressed/public/javascripts/uncompressed_app.js

@@ -0,0 +1,12 @@
+var one_message = 'alert one';
+alert(one_message);
+var two_message = 'alert 2';
+alert(two_message);
+
+var app_message = 'full app';
+alert(app_message);
+
+function () {
+  var foo = {};
+  foo["bar"] = "baz";
+}

data/lib/rack/.rb

@@ -0,0 +1 @@
+# require 'rack_sprockets//...'

data/lib/rack/sprockets/request.rb

@@ -11,7 +11,7 @@ module Rack::Sprockets
 
   class Request < Rack::Request
     include Rack::Sprockets::Options
-    
+
     JS_PATH_FORMATS = ['.js']
 
     # The HTTP request method. This is the standard implementation of this
@@ -21,25 +21,43 @@ module Rack::Sprockets
     def request_method
       @env['REQUEST_METHOD']
     end
-    
+
+    def http_accept
+      @env['HTTP_ACCEPT']
+    end
+
     def path_info
       @env['PATH_INFO']
     end
-    
-    def http_accept
-      @env['HTTP_ACCEPT']
+
+    def hosted_at_option
+      # sanitized :hosted_at option
+      #  remove any trailing '/'
+      #  ensure single leading '/'
+      @hosted_at_option ||= options(:hosted_at).sub(/\/+$/, '').sub(/^\/*/, '/')
     end
-    
-    def path_resource_name
-      File.basename(path_info, path_resource_format)
+
+    def path_info_resource
+      # sanitized path to the resource being requested
+      #  ensure single leading '/'
+      #  remove any resource format
+      #  ex:
+      #  '/something.js' => '/something'
+      #  '/nested/something.js' => '/nested/something'
+      #  '///something.js' => '/something'
+      #  '/nested///something.js' => '/nested/something'
+      @path_info_resource ||= File.join(
+        File.dirname(path_info.gsub(/\/+/, '/')).sub(/^#{hosted_at_option}/, ''),
+        File.basename(path_info.gsub(/\/+/, '/'), path_info_format)
+      ).sub(/^\/*/, '/')
     end
-    
-    def path_resource_format
-      File.extname(path_info)
+
+    def path_info_format
+      @path_info_format ||= File.extname(path_info.gsub(/\/+/, '/'))
     end
 
     def cache
-      File.join(options(:root), options(:public), options(:hosted_at))
+      File.join(options(:root), options(:public), hosted_at_option)
     end
 
     # The Rack::Sprockets::Source that the request is for
@@ -55,36 +73,36 @@ module Rack::Sprockets
             :expand_paths => options(:expand_paths)
           }
         }
-        Source.new(path_resource_name, source_opts)
+        Source.new(path_info_resource, source_opts)
       end
     end
 
     def for_js?
       (http_accept && http_accept.include?(Rack::Sprockets::MIME_TYPE)) ||
       (media_type  && media_type.include?(Rack::Sprockets::MIME_TYPE )) ||
-      JS_PATH_FORMATS.include?(path_resource_format)
+      JS_PATH_FORMATS.include?(path_info_format)
     end
 
     def hosted_at?
-      File.basename(File.dirname(path_info)) == File.basename(options(:hosted_at))
+      path_info =~ /^#{hosted_at_option}/
     end
-    
-    def exists?
-      File.exists?(File.join(cache, "#{path_resource_name}#{path_resource_format}"))
+
+    def cached?
+      File.exists?(File.join(cache, "#{path_info_resource}#{path_info_format}"))
     end
 
-    # Determine if the request is for an existing Sprockets source file
+    # Determine if the request is for a non-cached existing Sprockets source file
     # This will be called on every request so speed is an issue
     # => first check if the request is a GET on a js resource in :hosted_at (fast)
-    # => don't process if a file already exists in :hosted_at
+    # => don't process if a file has already been cached
     # => otherwise, check for sprockets source files that match the request (slow)
     def for_sprockets?
-      get? && 
+      get? &&               # GET on js resource in :hosted_at (fast, check first)
       for_js? &&
       hosted_at? &&
-      !exists? &&
-      !source.files.empty?
+      !cached? &&           # resource not cached (little slower)
+      !source.files.empty?  # there is source for the resource (slow, check last)
     end
-    
+
   end
 end

data/lib/rack/sprockets/source.rb

@@ -10,7 +10,7 @@ end
 module Rack::Sprockets
 
   class Source
-    
+
     PREFERRED_EXTENSIONS = [:js]
     SECRETARY_DEFAULTS = {
       :expand_paths => true
@@ -18,18 +18,18 @@ module Rack::Sprockets
     YUI_OPTS = {
       :munge => true
     }
-    
-    attr_reader :js_name
-    
-    def initialize(js_name, options={})
-      @js_name  = js_name
+
+    attr_reader :js_resource
+
+    def initialize(js_resource, options={})
+      @js_resource  = js_resource.gsub(/^\/+/, '')
       @compress = options[:compress]
       @cache    = options[:cache]
 
       @folder   = get_required_path(options, :folder)
       @secretary = SECRETARY_DEFAULTS.merge(options[:secretary] || {})
     end
-    
+
     def compress?
       !!@compress
     end
@@ -39,11 +39,11 @@ module Rack::Sprockets
     def cache
       @cache
     end
-    
+
     def files
       @files ||= js_sources
-    end    
-    
+    end
+
     def secretary
       @secretary_obj ||= Sprockets::Secretary.new(@secretary.merge({
         :source_files => files
@@ -53,7 +53,7 @@ module Rack::Sprockets
     def compiled
       @compiled ||= begin
         compiled_js = secretary.concatenation.to_s
-        
+
         compiled_js = case @compress
         when :whitespace, true
           compiled_js.delete("\n")
@@ -67,52 +67,52 @@ module Rack::Sprockets
           compiled_js
         end
 
-        if cache? && !File.exists?(cf = File.join(@cache, "#{@js_name}.js"))
-          FileUtils.mkdir_p(@cache)
+        if cache? && !File.exists?(cf = File.join(@cache, "#{@js_resource}.js"))
+          FileUtils.mkdir_p(File.dirname(cf))
           File.open(cf, "w") do |file|
             file.write(compiled_js)
           end
         end
-        
+
         compiled_js
       end
     end
     alias_method :to_js, :compiled
     alias_method :js, :compiled
-    
+
     protected
-    
+
     # Source files matching the js name
     def js_sources
-      @js_sources ||= preferred_sources([*@js_name])
+      @js_sources ||= preferred_source_files([*@js_resource])
     end
-    
+
     private
-    
-    # Given a list of file names, return a list of
-    # existing source files with the corresponding names
+
+    # Given a list of file resources, return a list of
+    # existing source files with the corresponding resource names
     # honoring the preferred extension list
-    def preferred_sources(file_names)
-      file_names.collect do |name|
+    def preferred_source_files(file_resources)
+      file_resources.collect do |resource|
         PREFERRED_EXTENSIONS.inject(nil) do |source_file, extension|
           source_file || begin
-            path = File.join(@folder, "#{name}.#{extension}")
+            path = File.join(@folder, "#{resource}.#{extension}")
             File.exists?(path) ? path : nil
           end
         end
       end.compact
     end
-    
+
     def get_required_path(options, path_key)
       unless options.has_key?(path_key)
         raise(ArgumentError, "no :#{path_key} option specified")
       end
       unless File.exists?(options[path_key])
-        raise(ArgumentError, "the :#{path_key} ('#{options[path_key]}') does not exist") 
+        raise(ArgumentError, "the :#{path_key} ('#{options[path_key]}') does not exist")
       end
       options[path_key]
     end
 
   end
-  
+
 end