sstephenson-sprockets 0.1.1 → 0.3.0

data/lib/sprockets/environment.rb

@@ -22,7 +22,16 @@ module Sprockets
     end
     
     def find(location)
-      load_path.map { |pathname| pathname.find(location) }.compact.first
+      find_all(location).first
+    end
+    
+    def constants(reload = false)
+      @constants = nil if reload
+      @constants ||= find_all("constants.yml").inject({}) do |constants, pathname|
+        contents = YAML.load(pathname.contents) rescue nil
+        contents = {} unless contents.is_a?(Hash)
+        constants.merge(contents)
+      end
     end
     
     protected
@@ -31,5 +40,9 @@ module Sprockets
         location = File.join(root.absolute_location, location) unless location[/^\//]
         File.expand_path(location)
       end
+      
+      def find_all(location)
+        load_path.map { |pathname| pathname.find(location) }.compact
+      end
   end
 end

data/lib/sprockets/error.rb

@@ -1,4 +1,5 @@
 module Sprockets
-  class Error < ::StandardError; end
-  class LoadError < Error;       end
+  class Error < ::StandardError;        end
+  class LoadError < Error;              end
+  class UndefinedConstantError < Error; end
 end

data/lib/sprockets/output_file.rb

@@ -4,17 +4,33 @@ module Sprockets
     
     def initialize
       @source_lines = []
+      @source_file_mtimes = {}
     end
     
     def record(source_line)
-      @source_lines << source_line
+      source_lines << source_line
+      record_mtime_for(source_line.source_file)
       source_line
     end
     
     def to_s
-      @source_lines.map do |source_line|
-        source_line.line
-      end.join
+      source_lines.join
     end
+
+    def mtime
+      @source_file_mtimes.values.max
+    end
+    
+    def save_to(filename)
+      timestamp = mtime
+      File.open(filename, "w") { |file| file.write(to_s) }
+      File.utime(timestamp, timestamp, filename)
+      true
+    end
+
+    protected
+      def record_mtime_for(source_file)
+        @source_file_mtimes[source_file] ||= source_file.mtime
+      end
   end
 end

data/lib/sprockets/pathname.rb

@@ -21,6 +21,10 @@ module Sprockets
       SourceFile.new(environment, self)
     end
     
+    def contents
+      IO.read(absolute_location)
+    end
+    
     def ==(pathname)
       environment == pathname.environment &&
         absolute_location == pathname.absolute_location

data/lib/sprockets/preprocessor.rb

@@ -30,11 +30,29 @@ module Sprockets
       end
       
       def record_source_line(source_line)
-        unless source_line.comment? && strip_comments?
-          output_file.record(source_line)
+        skip_pdoc_comments(source_line) do
+          unless source_line.comment? && strip_comments?
+            output_file.record(source_line)
+          end
         end
       end
-      
+
+      def skip_pdoc_comments(source_line)
+        yield unless strip_comments?
+
+        @commented ||= false
+
+        if source_line.begins_multiline_comment?
+          @commented = true
+        end
+
+        yield unless @commented
+
+        if source_line.closes_multiline_comment?
+          @commented = false
+        end
+      end
+
       def strip_comments?
         options[:strip_comments] != false
       end

data/lib/sprockets/source_file.rb

@@ -22,5 +22,11 @@ module Sprockets
     def ==(source_file)
       pathname == source_file.pathname
     end
+    
+    def mtime
+      File.mtime(pathname.absolute_location)
+    rescue Errno::ENOENT
+      0
+    end
   end
 end

data/lib/sprockets/source_line.rb

@@ -16,6 +16,14 @@ module Sprockets
       !!comment
     end
 
+    def begins_multiline_comment?
+      line =~ /^\s*\/\*\*(.*)/
+    end
+
+    def closes_multiline_comment?
+      line =~ /^(.*)*\*\*\/\s*/
+    end
+
     def require
       @require ||= (comment || "")[/^=\s+require\s+(\"(.*?)\"|<(.*?)>)\s*$/, 1]
     end
@@ -27,5 +35,16 @@ module Sprockets
     def inspect
       "line #@number of #{@source_file.pathname}"
     end
+    
+    def to_s(constants = source_file.environment.constants)
+      line.chomp.gsub(/<%=(.*?)%>/) do
+        constant = $1.strip
+        if value = constants[constant]
+          value
+        else
+          raise UndefinedConstantError, "couldn't find constant `#{constant}' in #{inspect}"
+        end
+      end + $/
+    end
   end
 end

data/lib/sprockets.rb

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

data/test/fixtures/constants.yml

@@ -0,0 +1 @@
+VERSION: 1.0

data/test/fixtures/double_slash_comments_that_are_not_requires_should_be_ignored_when_strip_comments_is_false.js

@@ -1 +1,2 @@
 // This is a double-slash comment that should appear in the resulting output file.
+/* This is a slash-star comment that should appear in the resulting output file. */

data/test/fixtures/double_slash_comments_that_are_not_requires_should_be_removed_by_default.js

@@ -1,2 +1,2 @@
 // This is a double-slash comment that should not appear in the resulting output file.
-/* This is a slash-star comment that should appear in the resulting output file. */
+/* This is a slash-star comment that should not appear in the resulting output file. */

data/test/fixtures/multiline_comments_should_be_removed_by_default.js

@@ -0,0 +1,4 @@
+/**
+ *  This is a slash-star comment
+ *  that should appear in the resulting output file.
+**/

data/test/fixtures/src/constants.yml

@@ -0,0 +1,3 @@
+ONE: one
+TWO: two
+HELLO: Hello world!

data/test/test_environment.rb

@@ -51,6 +51,12 @@ class EnvironmentTest < Test::Unit::TestCase
     assert_nil environment.find("nonexistent.js")
   end
   
+  def test_constants_should_return_a_hash_of_all_constants_defined_in_the_load_path
+    constants = environment_for_fixtures.constants
+    assert_kind_of Hash, constants
+    assert_equal %w(HELLO ONE TWO VERSION), constants.keys.sort
+  end
+  
   protected
     def assert_load_path_equals(load_path_absolute_locations, environment)
       assert load_path_absolute_locations.zip(environment.load_path).map { |location, pathname| location == pathname.absolute_location }.all?

data/test/test_helper.rb

@@ -38,6 +38,6 @@ class Test::Unit::TestCase
     end
 
     def source_line(line, source_file = nil, line_number = 1)
-      Sprockets::SourceLine.new(source_file, line, line_number)
+      Sprockets::SourceLine.new(source_file || source_file("dummy"), line, line_number)
     end
 end

data/test/test_output_file.rb

@@ -3,13 +3,14 @@ require "test_helper"
 class OutputFileTest < Test::Unit::TestCase
   def setup
     @output_file = Sprockets::OutputFile.new
+    @environment = environment_for_fixtures
   end
   
   def test_record
     assert_equal [], @output_file.source_lines
-    assert_equal "hello\n", @output_file.record("hello\n")
-    assert_equal "world\n", @output_file.record("world\n")
-    assert_equal ["hello\n", "world\n"], @output_file.source_lines
+    assert_equal "hello\n", @output_file.record(source_line("hello\n")).to_s
+    assert_equal "world\n", @output_file.record(source_line("world\n")).to_s
+    assert_equal ["hello\n", "world\n"], @output_file.source_lines.map { |source_line| source_line.to_s }
   end
   
   def test_to_s
@@ -17,4 +18,11 @@ class OutputFileTest < Test::Unit::TestCase
     @output_file.record(source_line("world\n"))
     assert_equal "hello\nworld\n", @output_file.to_s
   end
+  
+  def test_save_to
+    filename = File.join(FIXTURES_PATH, "output.js")
+    @output_file.save_to(filename)
+    assert_equal @output_file.to_s, IO.read(filename)
+    File.unlink(filename)
+  end
 end

data/test/test_preprocessor.rb

@@ -9,15 +9,24 @@ class PreprocessorTest < Test::Unit::TestCase
   def test_double_slash_comments_that_are_not_requires_should_be_removed_by_default
     require_file_for_this_test
     assert_output_file_does_not_contain_line "// This is a double-slash comment that should not appear in the resulting output file."
-    assert_output_file_contains_line "/* This is a slash-star comment that should appear in the resulting output file. */"
+    assert_output_file_contains_line "/* This is a slash-star comment that should not appear in the resulting output file. */"
   end
 
   def test_double_slash_comments_that_are_not_requires_should_be_ignored_when_strip_comments_is_false
     @preprocessor = Sprockets::Preprocessor.new(@environment, :strip_comments => false)
     require_file_for_this_test
     assert_output_file_contains_line "// This is a double-slash comment that should appear in the resulting output file."
+    assert_output_file_contains_line "/* This is a slash-star comment that should appear in the resulting output file. */"
   end
-  
+
+  def test_multiline_comments_should_be_removed_by_default
+    require_file_for_this_test
+    assert_output_file_does_not_contain_line "/**"
+    assert_output_file_does_not_contain_line " *  This is a slash-star comment"
+    assert_output_file_does_not_contain_line " *  that should appear in the resulting output file."
+    assert_output_file_does_not_contain_line "**/"
+  end
+
   def test_requiring_a_single_file_should_replace_the_require_comment_with_the_file_contents
     require_file_for_this_test
     assert_output_file_contains <<-LINES
@@ -76,11 +85,11 @@ class PreprocessorTest < Test::Unit::TestCase
     end
     
     def assert_output_file_does_not_contain_line(line)
-      assert source_lines_matching(line).empty?
+      assert source_lines_matching(line).empty?, "Expected #{line.inspect} to not exist"
     end
     
     def assert_output_file_contains_line(line)
-      assert source_lines_matching(line).any?
+      assert source_lines_matching(line).any?, "Expected #{line.inspect} to exist"
     end
     
     def assert_output_file_contains(indented_text)

data/test/test_source_line.rb

@@ -9,7 +9,17 @@ class SourceLineTest < Test::Unit::TestCase
     assert source_line(" //").comment?
     assert source_line("\t//").comment?
   end
-  
+
+  def test_line_that_begins_a_multiline_comment
+    assert !source_line(" /*").begins_multiline_comment?
+    assert source_line(" /**").begins_multiline_comment?
+  end
+
+  def test_line_that_closes_a_multiline_comment
+    assert !source_line(" */").closes_multiline_comment?
+    assert source_line(" **/").closes_multiline_comment?
+  end
+
   def test_line_that_contains_but_does_not_begin_with_double_slash_should_not_be_a_comment
     assert !source_line("f //").comment?
     assert !source_line("f //= require <foo>").comment?
@@ -41,4 +51,14 @@ class SourceLineTest < Test::Unit::TestCase
     source_file = Sprockets::SourceFile.new(environment, pathname)
     assert_equal "line 25 of /a/b/c.js", source_line("hello", source_file, 25).inspect
   end
+  
+  def test_interpolation_of_constants
+    assert_equal %(var VERSION = "1.0";\n), source_line('var VERSION = "<%= VERSION %>";').to_s("VERSION" => "1.0")
+  end
+  
+  def test_interpolation_of_missing_constant_raises_undefined_constant_error
+    assert_raises(Sprockets::UndefinedConstantError) do
+      source_line('<%= NONEXISTENT %>').to_s("VERSION" => "1.0")
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sstephenson-sprockets
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Sam Stephenson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-01 00:00:00 -07:00
+date: 2009-01-28 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -44,8 +44,11 @@ files:
 - test/fixtures/src/foo/bar.js
 - test/fixtures/src/foo/foo.js
 - test/fixtures/src/foo.js
+- test/fixtures/src/constants.yml
+- 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/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
 - test/fixtures/requiring_a_file_after_it_has_already_been_required_should_do_nothing.js
 - test/fixtures/double_slash_comments_that_are_not_requires_should_be_ignored_when_strip_comments_is_false.js
@@ -75,15 +78,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.0.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: JavaScript dependency management and concatenation
-test_files: 
-- test/test_preprocessor.rb
-- test/test_source_line.rb
-- test/test_source_file.rb
-- test/test_output_file.rb
-- test/test_pathname.rb
-- test/test_helper.rb
-- test/test_environment.rb
+test_files: []
+