sstephenson-sprockets 0.4.0 → 0.5.0

data/bin/sprocketize

@@ -5,6 +5,7 @@ require "optparse"
 
 load_path = (ENV["SPROCKETS_PATH"] || "").split(":")
 filenames = []
+options = { :load_path => load_path, :source_files => filenames, :expand_paths => false }
 
 OptionParser.new do |opts|
   opts.summary_width = 28
@@ -23,6 +24,10 @@ OptionParser.new do |opts|
     load_path << directory
   end
   
+  opts.on("-a DIRECTORY", "--asset-root=DIRECTORY", "Copy provided assets into DIRECTORY") do |directory|
+    options[:asset_root] = directory
+  end
+  
   opts.on_tail("-h", "--help", "Shows this help message") do
     opts.show_usage
   end
@@ -44,5 +49,6 @@ OptionParser.new do |opts|
   end
 end
 
-secretary = Sprockets::Secretary.new(:load_path => load_path, :source_files => filenames, :expand_paths => false)
+secretary = Sprockets::Secretary.new(options)
+secretary.install_assets if options[:asset_root]
 print secretary.output_file

data/lib/sprockets/pathname.rb

@@ -8,9 +8,9 @@ module Sprockets
     end
 
     # Returns a Pathname for the location relative to this pathname's absolute location.
-    def find(location)
+    def find(location, kind = :file)
       location = File.join(absolute_location, location)
-      File.file?(location) ? Pathname.new(environment, location) : nil
+      File.send("#{kind}?", location) ? Pathname.new(environment, location) : nil
     end
 
     def parent_pathname

data/lib/sprockets/preprocessor.rb

@@ -1,11 +1,12 @@
 module Sprockets
   class Preprocessor
-    attr_reader :environment, :output_file, :source_files
+    attr_reader :environment, :output_file, :source_files, :asset_paths
     
     def initialize(environment, options = {})
       @environment = environment
       @output_file = OutputFile.new
       @source_files = []
+      @asset_paths = []
       @options = options
     end
     
@@ -16,12 +17,19 @@ module Sprockets
       source_file.each_source_line do |source_line|
         if source_line.require?
           require_from_source_line(source_line)
+        elsif source_line.provide?
+          provide_from_source_line(source_line)
         else
           record_source_line(source_line)
         end
       end
     end
     
+    def provide(asset_path)
+      return if !asset_path || asset_paths.include?(asset_path)
+      asset_paths << asset_path
+    end
+    
     protected
       attr_reader :options
     
@@ -29,6 +37,10 @@ module Sprockets
         require pathname_from(source_line).source_file
       end
       
+      def provide_from_source_line(source_line)
+        provide asset_path_from(source_line)
+      end
+      
       def record_source_line(source_line)
         skip_pdoc_comments(source_line) do
           unless source_line.comment? && strip_comments?
@@ -84,6 +96,10 @@ module Sprockets
         File.join(File.dirname(location), File.basename(location, ".js") + ".js")
       end
       
+      def asset_path_from(source_line)
+        source_line.source_file.find(source_line.provide, :directory)
+      end
+
       def raise_load_error_for(source_line)
         kind = kind_of_require_from(source_line).to_s.tr("_", " ")
         file = File.split(location_from(source_line)).last

data/lib/sprockets/secretary.rb

@@ -46,6 +46,14 @@ module Sprockets
       preprocessor.output_file
     end
     
+    def install_assets
+      if @options[:asset_root]
+        preprocessor.asset_paths.each do |asset_path|
+          copy_assets_from(asset_path.absolute_location)
+        end
+      end
+    end
+    
     protected
       def expand_paths(paths, options = {})
         if options.has_key?(:expand_paths) ? options[:expand_paths] : @options[:expand_paths]
@@ -62,5 +70,29 @@ module Sprockets
           File.join(@options[:root], path)
         end
       end
+      
+      def copy_assets_from(asset_path)
+        relative_file_paths_beneath(asset_path).each do |filename|
+          source, destination = File.join(asset_path, filename), File.join(asset_root, File.dirname(filename))
+          if !File.directory?(source)
+            FileUtils.mkdir_p(destination)
+            FileUtils.cp(source, destination)
+          end
+        end
+      end
+      
+      def relative_file_paths_beneath(path)
+        Dir[File.join(path, "**", "*")].map do |filename|
+          File.join(*path_pieces(filename)[path_pieces(path).length..-1])
+        end
+      end
+      
+      def asset_root
+        from_root(@options[:asset_root])
+      end
+      
+      def path_pieces(path)
+        path.split(File::SEPARATOR)
+      end
   end
 end

data/lib/sprockets/source_file.rb

@@ -15,8 +15,8 @@ module Sprockets
       end
     end
     
-    def find(location)
-      pathname.parent_pathname.find(location)
+    def find(location, kind = :file)
+      pathname.parent_pathname.find(location, kind)
     end
     
     def ==(source_file)

data/lib/sprockets/source_line.rb

@@ -32,6 +32,14 @@ module Sprockets
       !!require
     end
     
+    def provide
+      @provide ||= (comment || "")[/^=\s+provide\s+\"(.*?)\"\s*$/, 1]
+    end
+    
+    def provide?
+      !!provide
+    end
+    
     def inspect
       "line #@number of #{@source_file.pathname}"
     end

data/lib/sprockets/version.rb

@@ -1,7 +1,7 @@
 module Sprockets
   module Version
     MAJOR  = 0
-    MINOR  = 4
+    MINOR  = 5
     TINY   = 0
 
     STRING = [MAJOR, MINOR, TINY].join(".")

data/lib/sprockets.rb

@@ -1,6 +1,7 @@
 $:.unshift File.dirname(__FILE__)
 
 require "yaml"
+require "fileutils"
 
 require "sprockets/version"
 require "sprockets/error"

data/test/fixtures/assets/images/script_with_assets/one.png

@@ -0,0 +1 @@
+one

data/test/fixtures/assets/images/script_with_assets/two.png

@@ -0,0 +1 @@
+two

data/test/fixtures/assets/stylesheets/script_with_assets.css

@@ -0,0 +1 @@
+/* nothing */

data/test/fixtures/src/script_with_assets.js

@@ -0,0 +1,3 @@
+//= provide "../assets"
+
+var ScriptWithAssets = { };

data/test/test_helper.rb

@@ -1,5 +1,7 @@
 require File.join(File.dirname(__FILE__), *%w".. lib sprockets")
 require "test/unit"
+require "fileutils"
+require "tmpdir"
 
 class Test::Unit::TestCase
   FIXTURES_PATH = File.expand_path(File.join(File.dirname(__FILE__), "fixtures")) unless defined?(FIXTURES_PATH)
@@ -40,4 +42,14 @@ class Test::Unit::TestCase
     def source_line(line, source_file = nil, line_number = 1)
       Sprockets::SourceLine.new(source_file || source_file("dummy"), line, line_number)
     end
+    
+    def with_temporary_directory
+      path = File.join(Dir.tmpdir, [caller[0][/`(.*)'/, 1], Time.now.to_f].join("_"))
+      begin
+        FileUtils.mkdir(path)
+        yield path
+      ensure
+        FileUtils.rm_rf(path)
+      end
+    end
 end

data/test/test_secretary.rb

@@ -31,4 +31,53 @@ class SecretaryTest < Test::Unit::TestCase
     assert_equal [File.join(FIXTURES_PATH, "src", "foo.js")],
                  secretary.preprocessor.source_files.map { |source_file| source_file.pathname.absolute_location }
   end
+  
+  def test_install_assets_into_empty_directory
+    with_temporary_directory do |temp|
+      secretary = Sprockets::Secretary.new(:root => FIXTURES_PATH, :asset_root => temp)
+      secretary.add_source_files("src/script_with_assets.js")
+
+      assert_equal [], Dir[File.join(temp, "**", "*")]
+      secretary.install_assets
+      assert_equal paths_relative_to(temp, 
+        "images", "images/script_with_assets", "images/script_with_assets/one.png", 
+        "images/script_with_assets/two.png", "stylesheets", "stylesheets/script_with_assets.css"),
+        Dir[File.join(temp, "**", "*")]
+    end
+  end
+  
+  def test_install_assets_into_nonexistent_directory
+    with_temporary_directory do |temp|
+      temp = File.join(temp, "assets")
+      secretary = Sprockets::Secretary.new(:root => FIXTURES_PATH, :asset_root => temp)
+      secretary.add_source_files("src/script_with_assets.js")
+
+      assert_equal [], Dir[File.join(temp, "**", "*")]
+      secretary.install_assets
+      assert_equal paths_relative_to(temp, 
+        "images", "images/script_with_assets", "images/script_with_assets/one.png", 
+        "images/script_with_assets/two.png", "stylesheets", "stylesheets/script_with_assets.css"),
+        Dir[File.join(temp, "**", "*")]
+    end
+  end
+  
+  def test_install_assets_into_subdirectories_that_already_exist
+    with_temporary_directory do |temp|
+      secretary = Sprockets::Secretary.new(:root => FIXTURES_PATH, :asset_root => temp)
+      secretary.add_source_files("src/script_with_assets.js")
+
+      FileUtils.mkdir_p(File.join(temp, "images", "script_with_assets"))
+      assert_equal paths_relative_to(temp, "images", "images/script_with_assets"), Dir[File.join(temp, "**", "*")]
+      secretary.install_assets
+      assert_equal paths_relative_to(temp, 
+        "images", "images/script_with_assets", "images/script_with_assets/one.png", 
+        "images/script_with_assets/two.png", "stylesheets", "stylesheets/script_with_assets.css"),
+        Dir[File.join(temp, "**", "*")]
+    end
+  end
+  
+  protected
+    def paths_relative_to(root, *paths)
+      paths.map { |path| File.join(root, path) }
+    end
 end

data/test/test_source_line.rb

@@ -45,6 +45,17 @@ class SourceLineTest < Test::Unit::TestCase
     assert_equal "\"foo\"", source_line("//= require \"foo\"").require
   end
 
+  def test_line_that_contains_a_provide_comment_should_be_a_provide
+    assert source_line("//= provide \"../assets\"").provide?
+    assert !source_line("//= provide").provide?
+    assert !source_line("//= provide <../assets>").provide?
+  end
+  
+  def test_provide_should_be_extracted_from_provide_lines
+    assert_nil source_line("//= provide").provide
+    assert_equal "../assets", source_line("//= provide \"../assets\"").provide
+  end
+
   def test_inspect_should_include_source_file_location_and_line_number
     environment = environment_for_fixtures
     pathname    = Sprockets::Pathname.new(environment, "/a/b/c.js")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sstephenson-sprockets
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Sam Stephenson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-29 00:00:00 -08:00
+date: 2009-01-30 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -47,8 +47,16 @@ files:
 - test/fixtures/src/foo/foo.js
 - test/fixtures/src/foo.js
 - test/fixtures/src/constants.yml
+- test/fixtures/src/script_with_assets.js
 - test/fixtures/multiline_comments_should_be_removed_by_default.js
 - test/fixtures/requiring_a_single_file_should_replace_the_require_comment_with_the_file_contents.js
+- test/fixtures/assets
+- test/fixtures/assets/stylesheets
+- test/fixtures/assets/stylesheets/script_with_assets.css
+- test/fixtures/assets/images
+- test/fixtures/assets/images/script_with_assets
+- test/fixtures/assets/images/script_with_assets/two.png
+- test/fixtures/assets/images/script_with_assets/one.png
 - test/fixtures/double_slash_comments_that_are_not_requires_should_be_removed_by_default.js
 - test/fixtures/constants.yml
 - test/fixtures/requiring_a_file_that_does_not_exist_should_raise_an_error.js