haml-edge 2.3.198 → 2.3.199

data/EDGE_GEM_VERSION

@@ -1 +1 @@
-2.3.198
+2.3.199

data/VERSION

@@ -1 +1 @@
-2.3.198
+2.3.199

data/lib/sass/plugin/staleness_checker.rb

@@ -0,0 +1,123 @@
+module Sass
+  module Plugin
+    # The class handles `.s[ca]ss` file staleness checks via their mtime timestamps.
+    #
+    # To speed things up two level of caches are employed:
+    #
+    # * A class-level dependency cache which stores @import paths for each file.
+    #   This is a long-lived cache that is reused by every StalenessChecker instance.
+    # * Two short-lived instance-level caches, one for file mtimes
+    #   and one for whether a file is stale during this particular run.
+    #   These are only used by a single StalenessChecker instance.
+    #
+    # Usage:
+    #
+    # * For a one-off staleness check of a single `.s[ca]ss` file,
+    #   the class-level {stylesheet_needs_update?} method
+    #   should be used.
+    # * For a series of staleness checks (e.g. checking all files for staleness)
+    #   a StalenessChecker instance should be created,
+    #   and the instance-level \{#stylesheet\_needs\_update?} method should be used.
+    #   the caches should make the whole process significantly faster.
+    #   *WARNING*: It is important not to retain the instance for too long,
+    #   as its instance-level caches are never explicitly expired.
+    class StalenessChecker
+      @dependencies_cache = {}
+
+      class << self
+        # @private
+        attr_accessor :dependencies_cache
+      end
+
+      # Creates a new StalenessChecker
+      # for checking the staleness of several stylesheets at once.
+      def initialize
+        @dependencies = self.class.dependencies_cache
+
+        # Entries in the following instance-level caches are never explicitly expired.
+        # Instead they are supposed to automaticaly go out of scope when a series of staleness checks
+        # (this instance of StalenessChecker was created for) is finished.
+        @mtimes, @dependencies_stale = {}, {}
+      end
+
+      # Returns whether or not a given CSS file is out of date
+      # and needs to be regenerated.
+      #
+      # @param css_file [String] The location of the CSS file to check.
+      # @param template_file [String] The location of the Sass or SCSS template
+      #   that is compiled to `css_file`.
+      def stylesheet_needs_update?(css_file, template_file)
+        template_file = File.expand_path(template_file)
+
+        unless File.exists?(css_file) && File.exists?(template_file)
+          @dependencies.delete(template_file)
+          true
+        else
+          css_mtime = mtime(css_file)
+          mtime(template_file) > css_mtime || dependencies_stale?(template_file, css_mtime)
+        end
+      end
+
+      # Returns whether or not a given CSS file is out of date
+      # and needs to be regenerated.
+      #
+      # The distinction between this method and the instance-level \{#stylesheet\_needs\_update?}
+      # is that the instance method preserves mtime and stale-dependency caches,
+      # so it's better to use when checking multiple stylesheets at once.
+      #
+      # @param css_file [String] The location of the CSS file to check.
+      # @param template_file [String] The location of the Sass or SCSS template
+      #   that is compiled to `css_file`.
+      def self.stylesheet_needs_update?(css_file, template_file)
+        new.stylesheet_needs_update?(css_file, template_file)
+      end
+
+      private
+
+      def dependencies_stale?(template_file, css_mtime)
+        timestamps = @dependencies_stale[template_file] ||= {}
+        timestamps.each_pair do |checked_css_mtime, is_stale|
+          if checked_css_mtime <= css_mtime && !is_stale
+            return false
+          elsif checked_css_mtime > css_mtime && is_stale
+            return true
+          end
+        end
+        timestamps[css_mtime] = dependencies(template_file).any?(&dependency_updated?(css_mtime))
+      end
+
+      def mtime(filename)
+        @mtimes[filename] ||= File.mtime(filename)
+      end
+
+      def dependencies(filename)
+        stored_mtime, dependencies = @dependencies[filename]
+
+        if !stored_mtime || stored_mtime < mtime(filename)
+          @dependencies[filename] = [mtime(filename), dependencies = compute_dependencies(filename)]
+        end
+
+        dependencies
+      end
+
+      def dependency_updated?(css_mtime)
+        lambda do |dep|
+          begin
+            mtime(dep) > css_mtime || dependencies_stale?(dep, css_mtime)
+          rescue Sass::SyntaxError
+            # If there's an error finding depenencies, default to recompiling.
+            true
+          end
+        end
+      end
+
+      def compute_dependencies(filename)
+        Files.tree_for(filename, Plugin.engine_options).grep(Tree::ImportNode) do |n|
+          File.expand_path(n.full_filename) unless n.full_filename =~ /\.css$/
+        end.compact
+      rescue Sass::SyntaxError => e
+        [] # If the file has an error, we assume it has no dependencies
+      end
+    end
+  end
+end

data/lib/sass/plugin.rb

@@ -3,6 +3,7 @@ require 'rbconfig'
 
 require 'sass'
 require 'sass/callbacks'
+require 'sass/plugin/staleness_checker'
 
 module Sass
   # This module handles the compilation of Sass/SCSS files.
@@ -211,6 +212,8 @@ module Sass
       individual_files.each {|t, c| update_stylesheet(t, c)}
 
       @checked_for_updates = true
+      staleness_checker = StalenessChecker.new
+
       template_locations.zip(css_locations).each do |template_location, css_location|
 
         Dir.glob(File.join(template_location, "**", "*.s[ca]ss")).each do |file|
@@ -219,7 +222,7 @@ module Sass
           css = css_filename(name, css_location)
 
           next if forbid_update?(name)
-          if options[:always_update] || stylesheet_needs_update?(css, file)
+          if options[:always_update] || staleness_checker.stylesheet_needs_update?(css, file)
             update_stylesheet file, css
           else
             run_not_updating_stylesheet file, css
@@ -374,33 +377,9 @@ module Sass
       name.sub(/^.*\//, '')[0] == ?_
     end
 
+    # Compass expects this to exist
     def stylesheet_needs_update?(css_file, template_file)
-      return true unless File.exists?(css_file) && File.exists?(template_file)
-
-      css_mtime = File.mtime(css_file)
-      File.mtime(template_file) > css_mtime ||
-        dependencies(template_file).any?(&dependency_updated?(css_mtime))
-    end
-
-    def dependency_updated?(css_mtime)
-      lambda do |dep|
-        begin
-          File.mtime(dep) > css_mtime ||
-            dependencies(dep).any?(&dependency_updated?(css_mtime))
-        rescue Sass::SyntaxError
-          # If there's an error finding depenencies, default to recompiling.
-          true
-        end
-      end
-    end
-
-    def dependencies(filename)
-      Files.tree_for(filename, engine_options).select {|n| n.is_a?(Tree::ImportNode)}.map do |n|
-        next if n.full_filename =~ /\.css$/
-        n.full_filename
-      end.compact
-    rescue Sass::SyntaxError => e
-      [] # If the file has an error, we assume it has no dependencies
+      StalenessChecker.stylesheet_needs_update?(css_file, template_file)
     end
   end
 end

data/test/sass/plugin_test.rb

@@ -347,12 +347,12 @@ CSS
   end
 
   def assert_needs_update(name)
-    assert(Sass::Plugin.stylesheet_needs_update?(tempfile_loc(name), template_loc(name)),
+    assert(Sass::Plugin::StalenessChecker.stylesheet_needs_update?(tempfile_loc(name), template_loc(name)),
       "Expected #{template_loc(name)} to need an update.")
   end
 
   def assert_doesnt_need_update(name)
-    assert(!Sass::Plugin.stylesheet_needs_update?(tempfile_loc(name), template_loc(name)),
+    assert(!Sass::Plugin::StalenessChecker.stylesheet_needs_update?(tempfile_loc(name), template_loc(name)),
       "Expected #{template_loc(name)} not to need an update.")
   end
 
@@ -361,6 +361,7 @@ CSS
   end
 
   def reset_mtimes
+    Sass::Plugin::StalenessChecker.dependencies_cache = {}
     atime = Time.now
     mtime = Time.now - 5
     Dir["{#{template_loc},#{tempfile_loc}}/**/*.{css,sass,scss}"].each {|f| File.utime(atime, mtime, f)}
@@ -407,12 +408,6 @@ CSS
   end
 end
 
-module Sass::Plugin
-  class << self
-    public :stylesheet_needs_update?
-  end
-end
-
 class Sass::Engine
   alias_method :old_render, :render
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: haml-edge
 version: !ruby/object:Gem::Version 
-  version: 2.3.198
+  version: 2.3.199
 platform: ruby
 authors: 
 - Nathan Weizenbaum
@@ -85,6 +85,7 @@ files:
 - lib/sass/plugin/merb.rb
 - lib/sass/plugin/rack.rb
 - lib/sass/plugin/rails.rb
+- lib/sass/plugin/staleness_checker.rb
 - lib/sass/script.rb
 - lib/sass/scss.rb
 - lib/sass/script/bool.rb