amiel-sprockets 1.0.4 → 1.0.5

data/lib/sprockets/source_file.rb

@@ -0,0 +1,54 @@
+module Sprockets
+  class SourceFile
+    attr_reader :environment, :pathname
+
+    def initialize(environment, pathname)
+      @environment = environment
+      @pathname = pathname
+    end
+
+    def source_lines
+      @lines ||= begin
+        lines = []
+
+        comments = []
+        File.open(pathname.absolute_location) do |file|
+          file.each do |line|
+            lines << line = SourceLine.new(self, line, file.lineno)
+
+            if line.begins_pdoc_comment? || comments.any?
+              comments << line
+            end
+
+            if line.ends_multiline_comment?
+              if line.ends_pdoc_comment?
+                comments.each { |l| l.comment! }
+              end
+              comments.clear
+            end
+          end
+        end
+
+        lines
+      end
+    end
+
+    def each_source_line(&block)
+      source_lines.each(&block)
+    end
+
+    def find(location, kind = :file)
+      pathname.parent_pathname.find(location, kind)
+    end
+    
+    def ==(source_file)
+      pathname == source_file.pathname
+    end
+    
+    def mtime
+      File.mtime(pathname.absolute_location)
+    rescue Errno::ENOENT
+      Time.now
+    end
+  end
+end

data/lib/sprockets/source_line.rb

@@ -0,0 +1,86 @@
+module Sprockets
+  class SourceLine
+    attr_reader :source_file, :line, :number
+
+    def initialize(source_file, line, number)
+      @source_file = source_file
+      @line = line
+      @number = number
+    end
+
+    def comment
+      @comment ||= line[/^\s*\/\/(.*)/, 1]
+    end
+    
+    def parsable_comment
+      @parsable_comment ||= comment || line[/^\s*\/\*(.*)\s*\*\/$/, 1]
+    end
+
+    def comment?
+      !!comment
+    end
+
+    def comment!
+      @comment = line
+    end
+
+    def begins_multiline_comment?
+      line =~ /^\s*\/\*(.*)/
+    end
+
+    def begins_pdoc_comment?
+      line =~ /^\s*\/\*\*(.*)/
+    end
+
+    def ends_multiline_comment?
+      line =~ /^(.*)\*\/\s*/
+    end
+
+    def ends_pdoc_comment?
+      line =~ /^(.*)\*\*\/\s*/
+    end
+
+    def require
+      @require ||= (parsable_comment || "")[/^=\s+require\s+(\"(.*?)\"|<(.*?)>)\s*$/, 1]
+    end
+    
+    def require?
+      !!require
+    end
+    
+    def provide
+      @provide ||= (parsable_comment || "")[/^=\s+provide\s+\"(.*?)\"\s*$/, 1]
+    end
+    
+    def provide?
+      !!provide
+    end
+    
+    def inspect
+      "line #@number of #{@source_file.pathname}"
+    end
+    
+    def to_s(constants = source_file.environment.constants)
+      result = line.chomp
+      interpolate_constants!(result, constants)
+      strip_trailing_whitespace!(result)
+      result + $/
+    end
+    
+    protected
+      def interpolate_constants!(result, constants)
+        result.gsub!(/<%=(.*?)%>/) do
+          constant = $1.strip
+          if value = constants[constant]
+            value
+          else
+            raise UndefinedConstantError, "couldn't find constant `#{constant}' in #{inspect}"
+          end
+        end
+      end
+      
+      def strip_trailing_whitespace!(result)
+        result.gsub!(/\s+$/, "")
+      end
+  end
+end

data/lib/sprockets/version.rb

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

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/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

@@ -0,0 +1,8 @@
+// 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. */
+/* This is multiline slash-star comment
+*  that should appear in the resulting
+*  output file */
+/**
+  This is not a PDoc 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

@@ -0,0 +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 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 PDoc comment
+ *  that should appear in the resulting output file.
+**/

data/test/fixtures/requiring_a_file_after_it_has_already_been_required_should_do_nothing.js

@@ -0,0 +1,5 @@
+var before_first_require;
+//= require <foo>
+var after_first_require_and_before_second_require;
+//= require <foo>
+var after_second_require;

data/test/fixtures/requiring_a_file_that_does_not_exist_should_raise_an_error.js

@@ -0,0 +1 @@
+//= require <nonexistent>

data/test/fixtures/requiring_a_file_with_css_style_comments_should_replace_the_require_comment_with_file_contents.css

@@ -0,0 +1,4 @@
+.before_require{ color: #000; }
+/*= require <foo> */
+.after_require{ color: #111; }
+

data/test/fixtures/requiring_a_single_file_should_replace_the_require_comment_with_the_file_contents.js

@@ -0,0 +1,3 @@
+var before_require;
+//= require <foo>
+var after_require;

data/test/fixtures/requiring_the_current_file_should_do_nothing.js

@@ -0,0 +1 @@
+//= require "requiring_the_current_file_should_do_nothing"

data/test/fixtures/src/constants.yml

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

data/test/fixtures/src/foo.css

@@ -0,0 +1 @@
+#required_content{ color: #222; }

data/test/fixtures/src/foo.js

@@ -0,0 +1 @@
+var Foo = { };

data/test/fixtures/src/foo/bar.js

@@ -0,0 +1,4 @@
+//= require "bar"
+var FooBar = { };
+
+/* Hello! */

data/test/fixtures/src/foo/foo.js

@@ -0,0 +1 @@
+var FooFoo = { };

data/test/fixtures/src/script_with_assets.js

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

data/test/test_concatenation.rb

@@ -0,0 +1,28 @@
+require "test_helper"
+
+class ConcatenationTest < Test::Unit::TestCase
+  def setup
+    @concatenation = Sprockets::Concatenation.new
+    @environment = environment_for_fixtures
+  end
+  
+  def test_record
+    assert_equal [], @concatenation.source_lines
+    assert_equal "hello\n", @concatenation.record(source_line("hello\n")).to_s
+    assert_equal "world\n", @concatenation.record(source_line("world\n")).to_s
+    assert_equal ["hello\n", "world\n"], @concatenation.source_lines.map { |source_line| source_line.to_s }
+  end
+  
+  def test_to_s
+    @concatenation.record(source_line("hello\n"))
+    @concatenation.record(source_line("world\n"))
+    assert_equal "hello\nworld\n", @concatenation.to_s
+  end
+  
+  def test_save_to
+    filename = File.join(FIXTURES_PATH, "output.js")
+    @concatenation.save_to(filename)
+    assert_equal @concatenation.to_s, IO.read(filename)
+    File.unlink(filename)
+  end
+end

data/test/test_environment.rb

@@ -0,0 +1,64 @@
+require "test_helper"
+
+class EnvironmentTest < Test::Unit::TestCase
+  def test_load_path_locations_become_pathnames_for_absolute_locations_from_the_root
+    environment = Sprockets::Environment.new("/root", ["/a", "b"])
+    assert_load_path_equals ["/a", "/root/b", "/root"], environment
+  end
+  
+  def test_pathname_from_for_location_with_leading_slash_should_return_a_pathname_with_the_location_unchanged
+    environment = Sprockets::Environment.new("/root")
+    assert_absolute_location "/a", environment.pathname_from("/a")
+  end
+  
+  def test_pathname_from_for_relative_location_should_return_a_pathname_for_the_expanded_absolute_location_from_root
+    environment = Sprockets::Environment.new("/root")
+    assert_absolute_location "/root/a", environment.pathname_from("a")
+    assert_absolute_location "/root/a", environment.pathname_from("./a")
+    assert_absolute_location "/a", environment.pathname_from("../a")
+  end
+  
+  def test_register_load_location_should_unshift_the_location_onto_the_load_path
+    environment = Sprockets::Environment.new("/root")
+    environment.register_load_location("a")
+    assert_load_path_equals ["/root/a", "/root"], environment
+    environment.register_load_location("b")
+    assert_load_path_equals ["/root/b", "/root/a", "/root"], environment
+  end
+  
+  def test_register_load_location_should_remove_already_existing_locations_before_unshifting
+    environment = Sprockets::Environment.new("/root")
+    environment.register_load_location("a")
+    environment.register_load_location("b")
+    assert_load_path_equals ["/root/b", "/root/a", "/root"], environment
+    environment.register_load_location("a")
+    assert_load_path_equals ["/root/a", "/root/b", "/root"], environment
+  end
+  
+  def test_find_should_return_the_first_matching_pathname_in_the_load_path
+    environment = environment_for_fixtures
+    first_pathname = environment.find("foo.js")
+    assert_absolute_location_ends_with "src/foo.js", first_pathname
+    
+    environment.register_load_location(File.join(FIXTURES_PATH, "src", "foo"))
+    second_pathname = environment.find("foo.js")
+    assert_not_equal first_pathname, second_pathname
+    assert_absolute_location_ends_with "foo/foo.js", second_pathname
+  end
+  
+  def test_find_should_return_nil_when_no_matching_source_file_is_found
+    environment = environment_for_fixtures
+    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| File.expand_path(location) == pathname.absolute_location }.all?
+    end
+end

data/test/test_helper.rb

@@ -0,0 +1,55 @@
+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)
+  
+  protected
+    def location_for_fixture(fixture)
+      File.join(FIXTURES_PATH, fixture)
+    end
+    
+    def content_of_fixture(fixture)
+      IO.read(location_for_fixture(fixture))
+    end
+  
+    def environment_for_fixtures
+      Sprockets::Environment.new(FIXTURES_PATH, source_directories_in_fixtures_path)
+    end
+  
+    def source_directories_in_fixtures_path
+      Dir[File.join(FIXTURES_PATH, "**", "src")]
+    end
+
+    def assert_absolute_location(location, pathname)
+      assert_equal File.expand_path(location), pathname.absolute_location
+    end
+    
+    def assert_absolute_location_ends_with(location_ending, pathname)
+      assert pathname.absolute_location[/#{Regexp.escape(location_ending)}$/]
+    end
+
+    def pathname(location, environment = @environment)
+      Sprockets::Pathname.new(environment, File.join(FIXTURES_PATH, location))
+    end
+    
+    def source_file(location, environment = @environment)
+      Sprockets::SourceFile.new(environment, pathname(location, environment))
+    end
+
+    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_pathname.rb

@@ -0,0 +1,43 @@
+require "test_helper"
+
+class PathnameTest < Test::Unit::TestCase
+  def setup
+    @environment = environment_for_fixtures
+  end
+  
+  def test_absolute_location_is_automatically_expanded
+    expanded_location = File.expand_path(File.join(FIXTURES_PATH, "foo"))
+    assert_absolute_location expanded_location, pathname("foo")
+    assert_absolute_location expanded_location, pathname("./foo")
+    assert_absolute_location expanded_location, pathname("./foo/../foo")
+  end
+  
+  def test_find_should_return_a_pathname_for_the_location_relative_to_the_absolute_location_of_the_pathname
+    assert_absolute_location_ends_with "src/foo/bar.js", pathname("src/foo").find("bar.js")
+  end
+  
+  def test_find_should_return_nil_when_the_location_relative_to_the_absolute_location_of_the_pathname_is_not_a_file_or_does_not_exist
+    assert_nil pathname("src/foo").find("nonexistent.js")
+  end
+  
+  def test_parent_pathname_should_return_a_pathname_for_the_parent_directory
+    assert_absolute_location_ends_with "src", pathname("src/foo").parent_pathname
+    assert_absolute_location_ends_with "foo", pathname("src/foo/foo.js").parent_pathname
+  end
+  
+  def test_source_file_should_return_a_source_file_for_the_pathname
+    source_file = pathname("src/foo.js").source_file
+    assert_kind_of Sprockets::SourceFile, source_file
+    assert_equal pathname("src/foo.js"), source_file.pathname
+  end
+
+  def test_equality_of_pathnames
+    assert_equal pathname("src/foo.js"), pathname("src/foo.js")
+    assert_equal pathname("src/foo.js"), pathname("src/foo/../foo.js")
+    assert_not_equal pathname("src/foo.js"), pathname("src/foo/foo.js")
+  end
+  
+  def test_to_s_should_return_absolute_location
+    assert_equal pathname("src/foo.js").to_s, pathname("src/foo.js").absolute_location
+  end
+end

data/test/test_preprocessor.rb

@@ -0,0 +1,116 @@
+require "test_helper"
+
+class PreprocessorTest < Test::Unit::TestCase
+  def setup
+    @environment  = environment_for_fixtures
+    @preprocessor = Sprockets::Preprocessor.new(@environment)
+  end
+
+  def test_double_slash_comments_that_are_not_requires_should_be_removed_by_default
+    require_file_for_this_test
+    assert_concatenation_does_not_contain_line "// This is a double-slash comment that should not appear in the resulting output file."
+    assert_concatenation_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_concatenation_contains_line "// This is a double-slash comment that should appear in the resulting output file."
+    assert_concatenation_contains_line "/* This is a slash-star comment that should appear in the resulting output file. */"
+
+    assert_concatenation_contains_line "/* This is multiline slash-star comment"
+    assert_concatenation_contains_line "*  that should appear in the resulting"
+    assert_concatenation_contains_line "*  output file */"
+
+    assert_concatenation_contains_line "This is not a PDoc 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_concatenation_does_not_contain_line "/**"
+    assert_concatenation_does_not_contain_line " *  This is a PDoc comment"
+    assert_concatenation_does_not_contain_line " *  that should appear in the resulting output file."
+    assert_concatenation_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_concatenation_contains <<-LINES
+      var before_require;
+      var Foo = { };
+      var after_require;
+    LINES
+  end
+  
+  def test_requiring_a_file_that_does_not_exist_should_raise_an_error
+    assert_raises(Sprockets::LoadError) do
+      require_file_for_this_test
+    end
+  end
+  
+  def test_requiring_the_current_file_should_do_nothing
+    require_file_for_this_test
+    assert_equal "", output_text
+  end
+  
+  def test_requiring_a_file_after_it_has_already_been_required_should_do_nothing
+    require_file_for_this_test
+    assert_concatenation_contains <<-LINES
+      var before_first_require;
+      var Foo = { };
+      var after_first_require_and_before_second_require;
+      var after_second_require;
+    LINES
+  end
+  
+  def test_requiring_a_file_with_css_style_comments_should_replace_the_require_comment_with_file_contents
+    require_file_for_this_test(:css)
+    assert_concatenation_contains <<-LINES
+      .before_require{ color: #000; }
+      #required_content{ color: #222; }
+      .after_require{ color: #111; }
+    LINES
+  end
+  
+  protected
+    attr_reader :environment, :preprocessor
+    
+    def concatenation
+      preprocessor.concatenation
+    end
+    
+    def output_text
+      preprocessor.concatenation.to_s
+    end
+    
+    def source_lines_matching(line)
+      concatenation.source_lines.select { |source_line| source_line.line.strip == line }
+    end
+    
+    def require_file(location)
+      preprocessor.require(environment.find(location).source_file)
+    end
+    
+    def require_file_for_this_test(ext = 'js')
+      require_file(file_for_this_test(ext))
+    end
+    
+    def file_for_this_test(ext)
+      caller.map { |c| c[/`(.*?)'$/, 1] }.grep(/^test_/).first[5..-1] + ".#{ext.to_s}"
+    end
+    
+    def assert_concatenation_does_not_contain_line(line)
+      assert source_lines_matching(line).empty?, "Expected #{line.inspect} to not exist"
+    end
+    
+    def assert_concatenation_contains_line(line)
+      assert source_lines_matching(line).any?, "Expected #{line.inspect} to exist"
+    end
+    
+    def assert_concatenation_contains(indented_text)
+      lines = indented_text.split($/)
+      initial_indent  = lines.first[/^\s*/].length
+      unindented_text = lines.map { |line| line[initial_indent..-1] }.join($/)
+      assert output_text[unindented_text]
+    end
+end