sass 3.1.0 → 3.3.0

data/lib/sass/version.rb

@@ -1,6 +1,4 @@
-# This is necessary for loading Sass when Haml is required in Rails 3.
-# Once the split is complete, we can remove it.
-require File.dirname(__FILE__) + '/../sass'
+require 'date'
 require 'sass/util'
 
 module Sass
@@ -9,13 +7,13 @@ module Sass
   # but its Git revision hash as well,
   # if it was installed from Git.
   module Version
-    include Sass::Util
-
     # Returns a hash representing the version of Sass.
     # The `:major`, `:minor`, and `:teeny` keys have their respective numbers as Fixnums.
     # The `:name` key has the name of the version.
     # The `:string` key contains a human-readable string representation of the version.
     # The `:number` key is the major, minor, and teeny keys separated by periods.
+    # The `:date` key, which is not guaranteed to be defined, is the `DateTime`
+    #   at which this release was cut.
     # If Sass is checked out from Git, the `:rev` key will have the revision hash.
     # For example:
     #
@@ -23,6 +21,7 @@ module Sass
     #       :string => "2.1.0.9616393",
     #       :rev    => "9616393b8924ef36639c7e82aa88a51a24d16949",
     #       :number => "2.1.0",
+    #       :date   => DateTime.parse("Apr 30 13:52:01 2009 -0700"),
     #       :major  => 2, :minor => 1, :teeny => 0
     #     }
     #
@@ -36,18 +35,21 @@ module Sass
     #     {
     #       :string => "3.0.beta.1",
     #       :number => "3.0.beta.1",
+    #       :date   => DateTime.parse("Mar 31 00:38:04 2010 -0700"),
     #       :major => 3, :minor => 0, :teeny => -1,
     #       :prerelease => "beta",
     #       :prerelease_number => 1
     #     }
     #
     # @return [{Symbol => String/Fixnum}] The version hash
+    # @comment
+    #   rubocop:disable ClassVars
     def version
       return @@version if defined?(@@version)
 
-      numbers = File.read(scope('VERSION')).strip.split('.').
+      numbers = File.read(Sass::Util.scope('VERSION')).strip.split('.').
         map {|n| n =~ /^[0-9]+$/ ? n.to_i : n}
-      name = File.read(scope('VERSION_NAME')).strip
+      name = File.read(Sass::Util.scope('VERSION_NAME')).strip
       @@version = {
         :major => numbers[0],
         :minor => numbers[1],
@@ -55,6 +57,10 @@ module Sass
         :name => name
       }
 
+      if (date = version_date)
+        @@version[:date] = date
+      end
+
       if numbers[3].is_a?(String)
         @@version[:teeny] = -1
         @@version[:prerelease] = numbers[3]
@@ -64,7 +70,7 @@ module Sass
       @@version[:number] = numbers.join('.')
       @@version[:string] = @@version[:number].dup
 
-      if rev = revision_number
+      if (rev = revision_number)
         @@version[:rev] = rev
         unless rev[0] == ?(
           @@version[:string] << "." << rev[0...7]
@@ -74,22 +80,23 @@ module Sass
       @@version[:string] << " (#{name})"
       @@version
     end
+    # rubocop:enable ClassVars
 
     private
 
     def revision_number
-      if File.exists?(scope('REVISION'))
-        rev = File.read(scope('REVISION')).strip
+      if File.exists?(Sass::Util.scope('REVISION'))
+        rev = File.read(Sass::Util.scope('REVISION')).strip
         return rev unless rev =~ /^([a-f0-9]+|\(.*\))$/ || rev == '(unknown)'
       end
 
-      return unless File.exists?(scope('.git/HEAD'))
-      rev = File.read(scope('.git/HEAD')).strip
+      return unless File.exists?(Sass::Util.scope('.git/HEAD'))
+      rev = File.read(Sass::Util.scope('.git/HEAD')).strip
       return rev unless rev =~ /^ref: (.*)$/
 
       ref_name = $1
-      ref_file = scope(".git/#{ref_name}")
-      info_file = scope(".git/info/refs")
+      ref_file = Sass::Util.scope(".git/#{ref_name}")
+      info_file = Sass::Util.scope(".git/info/refs")
       return File.read(ref_file).strip if File.exists?(ref_file)
       return unless File.exists?(info_file)
       File.open(info_file) do |f|
@@ -99,7 +106,12 @@ module Sass
           return sha
         end
       end
-      return nil
+      nil
+    end
+
+    def version_date
+      return unless File.exists?(Sass::Util.scope('VERSION_DATE'))
+      DateTime.parse(File.read(Sass::Util.scope('VERSION_DATE')).strip)
     end
   end
 

data/lib/sass.rb

@@ -17,6 +17,36 @@ require 'sass/version'
 #
 # Also see the {file:SASS_REFERENCE.md full Sass reference}.
 module Sass
+  class << self
+    # @private
+    attr_accessor :tests_running
+  end
+
+  # The global load paths for Sass files. This is meant for plugins and
+  # libraries to register the paths to their Sass stylesheets to that they may
+  # be `@imported`. This load path is used by every instance of {Sass::Engine}.
+  # They are lower-precedence than any load paths passed in via the
+  # {file:SASS_REFERENCE.md#load_paths-option `:load_paths` option}.
+  #
+  # If the `SASS_PATH` environment variable is set,
+  # the initial value of `load_paths` will be initialized based on that.
+  # The variable should be a colon-separated list of path names
+  # (semicolon-separated on Windows).
+  #
+  # Note that files on the global load path are never compiled to CSS
+  # themselves, even if they aren't partials. They exist only to be imported.
+  #
+  # @example
+  #   Sass.load_paths << File.dirname(__FILE__ + '/sass')
+  # @return [Array<String, Pathname, Sass::Importers::Base>]
+  def self.load_paths
+    @load_paths ||= if ENV['SASS_PATH']
+                      ENV['SASS_PATH'].split(Sass::Util.windows? ? ';' : ':')
+                    else
+                      []
+                    end
+  end
+
   # Compile a Sass or SCSS string to CSS.
   # Defaults to SCSS.
   #
@@ -34,9 +64,6 @@ module Sass
 
   # Compile a file on disk to CSS.
   #
-  # @param filename [String] The path to the Sass, SCSS, or CSS file on disk.
-  # @param options [{Symbol => Object}] An options hash;
-  #   see {file:SASS_REFERENCE.md#sass_options the Sass options documentation}
   # @raise [Sass::SyntaxError] if there's an error in the document
   # @raise [Encoding::UndefinedConversionError] if the source encoding
   #   cannot be converted to UTF-8
@@ -45,11 +72,17 @@ module Sass
   # @overload compile_file(filename, options = {})
   #   Return the compiled CSS rather than writing it to a file.
   #
+  #   @param filename [String] The path to the Sass, SCSS, or CSS file on disk.
+  #   @param options [{Symbol => Object}] An options hash;
+  #     see {file:SASS_REFERENCE.md#sass_options the Sass options documentation}
   #   @return [String] The compiled CSS.
   #
   # @overload compile_file(filename, css_filename, options = {})
   #   Write the compiled CSS to a file.
   #
+  #   @param filename [String] The path to the Sass, SCSS, or CSS file on disk.
+  #   @param options [{Symbol => Object}] An options hash;
+  #     see {file:SASS_REFERENCE.md#sass_options the Sass options documentation}
   #   @param css_filename [String] The location to which to write the compiled CSS.
   def self.compile_file(filename, *args)
     options = args.last.is_a?(Hash) ? args.pop : {}
@@ -57,7 +90,7 @@ module Sass
     result = Sass::Engine.for_file(filename, options).render
     if css_filename
       options[:css_filename] ||= css_filename
-      open(css_filename,"w") {|css_file| css_file.write(result)}
+      open(css_filename, "w") {|css_file| css_file.write(result)}
       nil
     else
       result
@@ -65,8 +98,10 @@ module Sass
   end
 end
 
+require 'sass/logger'
 require 'sass/util'
 
 require 'sass/engine'
 require 'sass/plugin' if defined?(Merb::Plugins)
 require 'sass/railtie'
+require 'sass/features'

data/test/sass/cache_test.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 require File.dirname(__FILE__) + '/../test_helper'
+require File.dirname(__FILE__) + '/test_helper'
 require 'sass/engine'
 
 class CacheTest < Test::Unit::TestCase
@@ -11,6 +12,7 @@ class CacheTest < Test::Unit::TestCase
 
   def teardown
     FileUtils.rm_rf @@cache_dir
+    clean_up_sassc
   end
 
   def test_file_cache_writes_a_file
@@ -64,6 +66,19 @@ class CacheTest < Test::Unit::TestCase
     assert_equal an_object, cache.retrieve("an_object", "")
   end
 
+  class Unmarshalable
+    def _dump(_)
+      raise 'Unmarshalable'
+    end
+  end
+
+  def test_cache_node_with_unmarshalable_option
+    engine = Sass::Engine.new("foo {a: b + c}",
+      :syntax => :scss, :object => Unmarshalable.new, :filename => 'file.scss',
+      :importer => Sass::Importers::Filesystem.new(absolutize('templates')))
+    engine.to_tree
+  end
+
   private
   def root_node
     Sass::Engine.new(<<-SCSS, :syntax => :scss).to_tree

data/test/sass/compiler_test.rb

@@ -0,0 +1,223 @@
+#!/usr/bin/env ruby
+require 'test/unit'
+require File.dirname(__FILE__) + '/../test_helper'
+require 'sass/plugin'
+require 'sass/plugin/compiler'
+
+class CompilerTest < Test::Unit::TestCase
+  class FakeListener
+    attr_accessor :options
+    attr_accessor :directories
+    attr_reader :start_called
+    attr_reader :thread
+
+    def initialize(*args, &on_filesystem_event)
+      self.options = args.last.is_a?(Hash) ? args.pop : {}
+      self.directories = args
+      @on_filesystem_event = on_filesystem_event
+      @start_called = false
+      reset_events!
+    end
+    
+    def fire_events!(*args)
+      @on_filesystem_event.call(@modified, @added, @removed)
+      reset_events!
+    end
+
+    def changed(filename)
+      @modified << File.expand_path(filename)
+    end
+
+    def added(filename)
+      @added << File.expand_path(filename)
+    end
+
+    def removed(filename)
+      @removed << File.expand_path(filename)
+    end
+
+    def on_start!(&run_during_start)
+      @run_during_start = run_during_start
+    end
+
+    # used for Listen < 2.0
+    def start!
+      @run_during_start.call(self) if @run_during_start
+    end
+
+    # used for Listen >= 2.0
+    def start
+      @thread = Thread.new {@run_during_start.call(self) if @run_during_start}
+    end
+
+    def stop
+    end
+
+    def reset_events!
+      @modified = []
+      @added = []
+      @removed = []
+    end
+  end
+
+  module MockWatcher
+    attr_accessor :run_during_start
+    attr_accessor :update_stylesheets_times
+    attr_accessor :update_stylesheets_called_with
+    attr_accessor :deleted_css_files
+
+    def fake_listener
+      @fake_listener
+    end
+
+    def update_stylesheets(individual_files)
+      @update_stylesheets_times ||= 0
+      @update_stylesheets_times += 1
+      (@update_stylesheets_called_with ||= []) << individual_files
+    end
+
+    def try_delete_css(css_filename)
+      (@deleted_css_files ||= []) << css_filename
+    end
+
+    private
+    def create_listener(*args, &on_filesystem_event)
+      @fake_listener = FakeListener.new(*args, &on_filesystem_event)
+      @fake_listener.on_start!(&run_during_start)
+      @fake_listener
+    end
+  end
+
+  def test_initialize
+    watcher
+  end
+
+  def test_watch_starts_the_listener
+    start_called = false
+    c = watcher do |listener|
+      start_called = true
+    end
+    c.watch
+    assert start_called, "start! was not called"
+  end
+
+  def test_sass_callbacks_fire_from_listener_events
+    c = watcher do |listener|
+      listener.changed "changed.scss"
+      listener.added "added.scss"
+      listener.removed "removed.scss"
+      listener.fire_events!
+    end
+
+    modified_fired = false
+    c.on_template_modified do |sass_file|
+      modified_fired = true
+      assert_equal "changed.scss", sass_file
+    end
+
+    added_fired = false
+    c.on_template_created do |sass_file|
+      added_fired = true
+      assert_equal "added.scss", sass_file
+    end
+
+    removed_fired = false
+    c.on_template_deleted do |sass_file|
+      removed_fired = true
+      assert_equal "removed.scss", sass_file
+    end
+
+    c.watch
+
+    assert_equal 2, c.update_stylesheets_times
+    assert modified_fired
+    assert added_fired
+    assert removed_fired
+  end
+
+  def test_removing_a_sass_file_removes_corresponding_css_file
+    c = watcher do |listener|
+      listener.removed "remove_me.scss"
+      listener.fire_events!
+    end
+
+    c.watch
+
+    assert_equal "./remove_me.css", c.deleted_css_files.first
+  end
+
+  def test_an_importer_can_watch_an_image
+    image_importer = Sass::Importers::Filesystem.new(".")
+    class << image_importer
+      def watched_file?(filename)
+        filename =~ /\.png$/
+      end
+    end
+    c = watcher(:load_paths => [image_importer]) do |listener|
+      listener.changed "image.png"
+      listener.fire_events!
+    end
+
+    modified_fired = false
+    c.on_template_modified do |f|
+      modified_fired = true
+      assert_equal "image.png", f
+    end
+
+    c.watch
+
+    assert_equal 2, c.update_stylesheets_times
+    assert modified_fired
+  end
+
+  def test_watching_specific_files_and_one_is_deleted
+    directories = nil
+    c = watcher do |listener|
+      directories = listener.directories
+      listener.removed "/asdf/foobar/sass/foo.scss"
+      listener.fire_events!
+    end
+    c.watch([["/asdf/foobar/sass/foo.scss", "/asdf/foobar/css/foo.css", nil]])
+    assert directories.include?("/asdf/foobar/sass"), directories.inspect
+    assert_equal "/asdf/foobar/css/foo.css", c.deleted_css_files.first, "the corresponding css file was not deleted"
+    assert_equal [], c.update_stylesheets_called_with[1], "the sass file should not have been compiled"
+  end
+
+  def test_watched_directories_are_dedupped
+    directories = nil
+    c = watcher(:load_paths => [".", "./foo", "."]) do |listener|
+      directories = listener.directories
+    end
+    c.watch
+    assert_equal [File.expand_path(".")], directories
+  end
+
+  def test_a_changed_css_in_a_watched_directory_does_not_force_a_compile
+    c = watcher do |listener|
+      listener.changed "foo.css"
+      listener.fire_events!
+    end
+
+    c.on_template_modified do |f|
+      assert false, "Should not have been called"
+    end
+
+    c.watch
+
+    assert_equal 1, c.update_stylesheets_times
+  end
+
+  private
+
+  def default_options
+    {:template_location => [[".","."]]}
+  end
+
+  def watcher(options = {}, &run_during_start)
+    options = default_options.merge(options)
+    watcher = Sass::Plugin::Compiler.new(options)
+    watcher.extend(MockWatcher)
+    watcher.run_during_start = run_during_start
+    watcher
+  end
+end