sass 3.3.0.alpha.201 → 3.3.0.alpha.211

data/REVISION

@@ -1 +1 @@
-3a64325d2550f0bc57f6490854c0a7d0bc5c9db5
+33078d3298227e86d5cc9628b17270b823bf9003

data/VERSION

@@ -1 +1 @@
-3.3.0.alpha.201
+3.3.0.alpha.211

data/VERSION_DATE

@@ -1 +1 @@
-17 July 2013 20:29:34 GMT
+18 July 2013 18:31:42 GMT

data/lib/sass/engine.rb

@@ -191,6 +191,14 @@ module Sass
         options[:filesystem_importer].new(p.to_s)
       end
 
+      # Remove any deprecated importers if the location is imported explicitly
+      options[:load_paths].reject! do |importer|
+        importer.is_a?(Sass::Importers::DeprecatedPath) &&
+          options[:load_paths].find {|other_importer| other_importer.is_a?(Sass::Importers::Filesystem) &&
+                                                      other_importer != importer &&
+                                                      other_importer.root == importer.root}
+      end
+
       # Backwards compatibility
       options[:property_syntax] ||= options[:attribute_syntax]
       case options[:property_syntax]

data/lib/sass/exec.rb

@@ -197,7 +197,7 @@ MESSAGE
       def initialize(args)
         super
         @options[:for_engine] = {
-          :load_paths => ['.'] + (ENV['SASSPATH'] || '').split(File::PATH_SEPARATOR)
+          :load_paths => default_sass_path
         }
         @default_syntax = :sass
       end
@@ -433,17 +433,14 @@ MSG
         ::Sass::Plugin.on_updated_stylesheet do |_, css, sourcemap|
           [css, sourcemap].each do |file|
             next unless file
-            if File.exists? file
-              puts_action :overwrite, :yellow, file
-            else
-              puts_action :create, :green, file
-            end
+            puts_action :write, :green, file
           end
         end
 
         had_error = false
         ::Sass::Plugin.on_creating_directory {|dirname| puts_action :directory, :green, dirname}
         ::Sass::Plugin.on_deleting_css {|filename| puts_action :delete, :yellow, filename}
+        ::Sass::Plugin.on_deleting_sourcemap {|filename| puts_action :delete, :yellow, filename}
         ::Sass::Plugin.on_compilation_error do |error, _, _|
           if error.is_a?(SystemCallError) && !@options[:stop_on_error]
             had_error = true
@@ -505,6 +502,16 @@ MSG
         return false if colon_path?(path)
         return ::Sass::Util.glob(File.join(path, "*.s[ca]ss")).empty?
       end
+
+      def default_sass_path
+        if ENV['SASSPATH']
+          # The select here prevents errors when the environment's load paths specified do not exist.
+          ENV['SASSPATH'].split(File::PATH_SEPARATOR).select {|d| File.directory?(d)}
+        else
+          [::Sass::Importers::DeprecatedPath.new(".")]
+        end
+      end
+
     end
 
     class Scss < Sass

data/lib/sass/importers.rb

@@ -20,3 +20,4 @@ end
 
 require 'sass/importers/base'
 require 'sass/importers/filesystem'
+require 'sass/importers/deprecated_path'

data/lib/sass/importers/base.rb

@@ -144,8 +144,27 @@ module Sass
       def to_s
         Sass::Util.abstract(self)
       end
+
+      # If the importer is based on files on the local filesystem
+      # this method should return folders which should be watched
+      # for changes.
+      #
+      # @return [Array<String>] List of absolute paths of directories to watch
+      def directories_to_watch
+        []
+      end
+
+      # If this importer is based on files on the local filesystem This method
+      # should return true if the file, when changed, should trigger a
+      # recompile.
+      #
+      # It is acceptable for non-sass files to be watched and trigger a recompile.
+      #
+      # @param filename [String] The absolute filename for a file that has changed.
+      # @return [Boolean] When the file changed should cause a recompile.
+      def watched_file?(filename)
+        false
+      end
     end
   end
 end
-
-      

data/lib/sass/importers/deprecated_path.rb

@@ -0,0 +1,45 @@
+module Sass
+  module Importers
+    # This importer emits a deprecation warning the first time it is used to
+    # import a file. It is used to deprecate the current working
+    # directory from the list of automatic sass load paths.
+    class DeprecatedPath < Filesystem
+
+      # @param root [String] The absolute, expanded path to the folder that is deprecated.
+      def initialize(root)
+        @specified_root = root
+        @warning_given = false
+        super
+      end
+
+      # @see Sass::Importers::Base#find
+      def find(*args)
+        found = super
+        if found && !@warning_given
+          @warning_given = true
+          Sass::Util.sass_warn deprecation_warning
+        end
+        found
+      end
+
+      # @see Sass::Importers::Base#to_s
+      def to_s
+        "#{@root} (DEPRECATED)"
+      end
+
+      protected
+
+      # @return [String] The deprecation warning that will be printed the first
+      #   time an import occurs.
+      def deprecation_warning
+        path = (@specified_root == ".") ? "the current working directory" : @specified_root
+        <<WARNING
+DEPRECATION WARNING: Importing from #{path} will not be
+automatic in future versions of Sass.  To avoid future errors, you can add it
+to your environment explicitly by setting `SASSPATH=#{@specified_root}`, by using the -I command
+line option, or by changing your Sass configuration options.
+WARNING
+      end
+    end
+  end
+end

data/lib/sass/importers/filesystem.rb

@@ -55,6 +55,17 @@ module Sass
         root.eql?(other.root)
       end
 
+      # @see Base#directories_to_watch
+      def directories_to_watch
+        [root]
+      end
+
+      # @see Base#watched_file?
+      def watched_file?(filename)
+        filename =~ /\.s[ac]ss$/ &&
+          filename.start_with?(root + File::SEPARATOR)
+      end
+
       protected
 
       # If a full uri is passed, this removes the root from it

data/lib/sass/plugin/compiler.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'pathname'
 
 require 'sass'
 # XXX CE: is this still necessary now that we have the compiler class?
@@ -148,6 +149,14 @@ module Sass::Plugin
     #   The location of the CSS file that was deleted.
     define_callback :deleting_css
 
+    # Register a callback to be run when Sass deletes a sourcemap file.
+    # This happens when the corresponding Sass/SCSS file has been deleted.
+    #
+    # @yield [filename]
+    # @yieldparam filename [String]
+    #   The location of the sourcemap file that was deleted.
+    define_callback :deleting_sourcemap
+
     # Updates out-of-date stylesheets.
     #
     # Checks each Sass/SCSS file in {file:SASS_REFERENCE.md#template_location-option `:template_location`}
@@ -213,53 +222,57 @@ module Sass::Plugin
     def watch(individual_files = [])
       update_stylesheets(individual_files)
 
-      require 'listen'
-
-      template_paths = template_locations # cache the locations
-      individual_files_hash = individual_files.inject({}) do |h, files|
-        parent = File.dirname(files.first)
-        (h[parent] ||= []) << files unless template_paths.include?(parent)
-        h
+      directories = watched_paths
+      individual_files.each do |(source, _, _)|
+        directories << File.dirname(File.expand_path(source))
       end
-      directories = template_paths + individual_files_hash.keys +
-        [{:relative_paths => true}]
+      directories = remove_redundant_directories(directories)
 
       # TODO: Keep better track of what depends on what
       # so we don't have to run a global update every time anything changes.
-      listener = Listen::MultiListener.new(*directories) do |modified, added, removed|
-        modified.each do |f|
-          parent = File.dirname(f)
-          if files = individual_files_hash[parent]
-            next unless files.first == f
-          else
-            next unless f =~ /\.s[ac]ss$/
-          end
-          run_template_modified(f)
+      listener = create_listener(*(directories + [{:relative_paths => false}])) do |modified, added, removed|
+        recompile_required = false
+
+        modified.uniq.each do |f|
+          next unless watched_file?(f)
+          recompile_required = true
+          run_template_modified(relative_to_pwd(f))
         end
 
-        added.each do |f|
-          parent = File.dirname(f)
-          if files = individual_files_hash[parent]
-            next unless files.first == f
-          else
-            next unless f =~ /\.s[ac]ss$/
-          end
-          run_template_created(f)
+        added.uniq.each do |f|
+          next unless watched_file?(f)
+          recompile_required = true
+          run_template_created(relative_to_pwd(f))
         end
 
-        removed.each do |f|
-          parent = File.dirname(f)
-          if files = individual_files_hash[parent]
-            next unless files.first == f
+        removed.uniq.each do |f|
+          if files = individual_files.find {|(source,_,_)| File.expand_path(source) == f}
+            recompile_required = true
+            # This was a file we were watching explicitly and compiling to a particular location.
+            # Delete the corresponding file.
             try_delete_css files[1]
           else
-            next unless f =~ /\.s[ac]ss$/
-            try_delete_css f.gsub(/\.s[ac]ss$/, '.css')
+            next unless watched_file?(f)
+            recompile_required = true
+            # Look for the sass directory that contained the sass file
+            # And try to remove the css file that corresponds to it
+            template_location_array.each do |(sass_dir, css_dir)|
+              sass_dir = File.expand_path(sass_dir)
+              if child_of_directory?(sass_dir, f)
+                remainder = f[(sass_dir.size + 1)..-1]
+                try_delete_css(css_filename(remainder, css_dir))
+                break
+              end
+            end
           end
-          run_template_deleted(f)
+          run_template_deleted(relative_to_pwd(f))
         end
 
-        update_stylesheets(individual_files)
+        if recompile_required
+          # In case a file we're watching is removed and then recreated we prune out the non-existant files here.
+          watched_files_remaining = individual_files.select {|(source, _, _)| File.exists?(source)}
+          update_stylesheets(watched_files_remaining)
+        end
       end
 
       # The native windows listener is much slower than the polling
@@ -267,7 +280,7 @@ module Sass::Plugin
       listener.force_polling(true) if @options[:poll] || Sass::Util.windows?
 
       begin
-        listener.start
+        listener.start!
       rescue Exception => e
         raise e unless e.is_a?(Interrupt)
       end
@@ -291,6 +304,23 @@ module Sass::Plugin
 
     private
 
+    def create_listener(*args, &block)
+      require 'listen'
+      Listen::Listener.new(*args, &block)
+    end
+
+    def remove_redundant_directories(directories)
+      dedupped = []
+      directories.each do |new_directory|
+        # no need to add a directory that is already watched.
+        next if dedupped.any? {|existing_directory| child_of_directory?(existing_directory, new_directory)}
+        # get rid of any sub directories of this new directory
+        dedupped.reject! {|existing_directory| child_of_directory?(new_directory, existing_directory)}
+        dedupped << new_directory
+      end
+      dedupped
+    end
+
     def update_stylesheet(filename, css, sourcemap)
       dir = File.dirname(css)
       unless File.exists?(dir)
@@ -329,9 +359,27 @@ module Sass::Plugin
     end
 
     def try_delete_css(css)
-      return unless File.exists?(css)
-      run_deleting_css css
-      File.delete css
+      if File.exists?(css)
+        run_deleting_css css
+        File.delete css
+      end
+      map = Sass::Util.sourcemap_name(css)
+      if File.exists?(map)
+        run_deleting_sourcemap map
+        File.delete map
+      end
+    end
+
+    def watched_file?(file)
+      normalized_load_paths.find {|lp| lp.watched_file?(file)}
+    end
+
+    def watched_paths
+      @watched_paths ||= normalized_load_paths.map {|lp| lp.directories_to_watch}.compact.flatten
+    end
+
+    def normalized_load_paths
+      @normalized_load_paths ||= Sass::Engine.normalize_options(:load_paths=> load_paths)[:load_paths]
     end
 
     def load_paths(opts = options)
@@ -347,7 +395,18 @@ module Sass::Plugin
     end
 
     def css_filename(name, path)
-      "#{path}/#{name}".gsub(/\.s[ac]ss$/, '.css')
+      "#{path}#{File::SEPARATOR unless path.end_with?(File::SEPARATOR)}#{name}".gsub(/\.s[ac]ss$/, '.css')
+    end
+
+    def relative_to_pwd(f)
+      Pathname.new(f).relative_path_from(Pathname.new(Dir.pwd)).to_s
+    rescue ArgumentError # when a relative path cannot be computed
+      f
+    end
+
+    def child_of_directory?(parent, child)
+      parent_dir = parent.end_with?(File::SEPARATOR) ? parent : (parent + File::SEPARATOR)
+      child.start_with?(parent_dir) || parent == child
     end
   end
 end

data/test/Gemfile

@@ -1,3 +1,3 @@
-source :gemcutter
+source 'https://rubygems.org'
 
 gem 'rake'

data/test/sass/compiler_test.rb

@@ -0,0 +1,213 @@
+#!/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
+
+    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
+
+    def start!
+      @run_during_start.call(self) if @run_during_start
+    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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: sass
 version: !ruby/object:Gem::Version 
-  hash: 592302751
+  hash: 592302763
   prerelease: 6
   segments: 
   - 3
   - 3
   - 0
   - alpha
-  - 201
-  version: 3.3.0.alpha.201
+  - 211
+  version: 3.3.0.alpha.211
 platform: ruby
 authors: 
 - Nathan Weizenbaum
@@ -19,7 +19,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-07-17 00:00:00 -04:00
+date: 2013-07-18 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,11 +30,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 19
         segments: 
+        - 1
+        - 1
         - 0
-        - 7
-        version: "0.7"
+        version: 1.1.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -98,6 +99,7 @@ files:
 - lib/sass/importers.rb
 - lib/sass/importers/base.rb
 - lib/sass/importers/filesystem.rb
+- lib/sass/importers/deprecated_path.rb
 - lib/sass/logger.rb
 - lib/sass/logger/base.rb
 - lib/sass/logger/log_level.rb
@@ -314,6 +316,7 @@ files:
 - test/sass/util/multibyte_string_scanner_test.rb
 - test/sass/util/subset_map_test.rb
 - test/sass/source_map_test.rb
+- test/sass/compiler_test.rb
 - test/test_helper.rb
 - extra/update_watch.rb
 - Rakefile
@@ -384,3 +387,4 @@ test_files:
 - test/sass/util/multibyte_string_scanner_test.rb
 - test/sass/util/subset_map_test.rb
 - test/sass/source_map_test.rb
+- test/sass/compiler_test.rb