haml 3.0.0 → 3.0.1

data/VERSION

@@ -1 +1 @@
-3.0.0
+3.0.1

data/lib/haml/exec.rb

@@ -200,18 +200,29 @@ END
         opts.on('--rails RAILS_DIR', "Install Haml and Sass from the Gem to a Rails project") do |dir|
           original_dir = dir
 
+          env = File.join(dir, "config", "environment.rb")
+          if File.exists?(File.join(dir, "Gemfile"))
+            puts("haml --rails isn't needed for Rails 3 or greater.",
+              "Add 'gem \"haml\"' to your Gemfile instead.", "",
+              "haml --rails will no longer work in the next version of #{@name}.", "")
+          elsif File.exists?(env) && File.open(f) {|f| f.grep(/config\.gem/)}
+            puts("haml --rails isn't needed for Rails 2.1 or greater.",
+              "Add 'gem \"haml\"' to config/environment.rb instead.", "",
+              "haml --rails will no longer work in the next version of #{@name}.", "")
+          end
+
           dir = File.join(dir, 'vendor', 'plugins')
 
           unless File.exists?(dir)
             puts "Directory #{dir} doesn't exist"
-            exit
+            exit 1
           end
 
           dir = File.join(dir, 'haml')
 
           if File.exists?(dir)
             print "Directory #{dir} already exists, overwrite [y/N]? "
-            exit if gets !~ /y/i
+            exit 2 if gets !~ /y/i
             FileUtils.rm_rf(dir)
           end
 
@@ -219,7 +230,7 @@ END
             Dir.mkdir(dir)
           rescue SystemCallError
             puts "Cannot create #{dir}"
-            exit
+            exit 1
           end
 
           File.open(File.join(dir, 'init.rb'), 'w') do |file|

data/lib/haml/railtie.rb

@@ -6,5 +6,6 @@
 # Rails 3.0.0.beta.2+
 if defined?(ActiveSupport) && Haml::Util.has?(:public_method, ActiveSupport, :on_load)
   require 'haml/template/options'
+  require 'sass/plugin/configuration'
   ActiveSupport.on_load(:action_view) {Haml.init_rails(binding)}
 end

data/lib/haml/template.rb

@@ -37,7 +37,7 @@ module Haml
   end
 end
 
-if Haml::Util.rails_env == "production"
+unless Haml::Util.rails_env == "development"
   Haml::Template.options[:ugly] = true
 end
 

data/lib/sass/callbacks.rb

@@ -1,39 +1,40 @@
-# A lightweight infrastructure for defining and running callbacks.
-# Callbacks are defined using \{#define\_callback\} at the class level,
-# and called using `run_#{name}` at the instance level.
-#
-# Clients can add callbacks by calling the generated `on_#{name}` method,
-# and passing in a block that's run when the callback is activated.
-#
-# @example Define a callback
-# class Munger
-#   extend Sass::Callbacks
-#   define_callback :string_munged
-#
-#   def munge(str)
-#     res = str.gsub(/[a-z]/, '\1\1')
-#     run_string_munged str, res
-#     res
-#   end
-# end
-#
-# @example Use a callback
-# m = Munger.new
-# m.on_string_munged {|str, res| puts "#{str} was munged into #{res}!"}
-# m.munge "bar" #=> bar was munged into bbaarr!
-module Sass::Callbacks
-  protected
-
-  # Define a callback with the given name.
-  # This will define an `on_#{name}` method
-  # that registers a block,
-  # and a `run_#{name}` method that runs that block
-  # (optionall with some arguments).
+module Sass
+  # A lightweight infrastructure for defining and running callbacks.
+  # Callbacks are defined using \{#define\_callback\} at the class level,
+  # and called using `run_#{name}` at the instance level.
+  #
+  # Clients can add callbacks by calling the generated `on_#{name}` method,
+  # and passing in a block that's run when the callback is activated.
+  #
+  # @example Define a callback
+  # class Munger
+  #   extend Sass::Callbacks
+  #   define_callback :string_munged
   #
-  # @param name [Symbol] The name of the callback
-  # @return [void]
-  def define_callback(name)
-    class_eval <<RUBY
+  #   def munge(str)
+  #     res = str.gsub(/[a-z]/, '\1\1')
+  #     run_string_munged str, res
+  #     res
+  #   end
+  # end
+  #
+  # @example Use a callback
+  # m = Munger.new
+  # m.on_string_munged {|str, res| puts "#{str} was munged into #{res}!"}
+  # m.munge "bar" #=> bar was munged into bbaarr!
+  module Callbacks
+    protected
+
+    # Define a callback with the given name.
+    # This will define an `on_#{name}` method
+    # that registers a block,
+    # and a `run_#{name}` method that runs that block
+    # (optionall with some arguments).
+    #
+    # @param name [Symbol] The name of the callback
+    # @return [void]
+    def define_callback(name)
+      class_eval <<RUBY
 def on_#{name}(&block)
   @_sass_callbacks ||= {}
   (@_sass_callbacks[#{name.inspect}] ||= []) << block
@@ -46,5 +47,6 @@ def run_#{name}(*args)
 end
 private :run_#{name}
 RUBY
+    end
   end
 end

data/lib/sass/plugin.rb

@@ -2,7 +2,7 @@ require 'fileutils'
 require 'rbconfig'
 
 require 'sass'
-require 'sass/callbacks'
+require 'sass/plugin/configuration'
 require 'sass/plugin/staleness_checker'
 
 module Sass
@@ -31,124 +31,8 @@ module Sass
   #   #=> Compiling app/sass/ie.scss to public/stylesheets/ie.css
   module Plugin
     include Haml::Util
-    include Sass::Callbacks
-    extend self
-
-    @options = {
-      :css_location       => './public/stylesheets',
-      :always_update      => false,
-      :always_check       => true,
-      :full_exception     => true
-    }
-    @checked_for_updates = false
-
-    # Register a callback to be run before stylesheets are mass-updated.
-    # This is run whenever \{#update\_stylesheets} is called,
-    # unless the \{file:SASS_REFERENCE.md#never_update-option `:never_update` option}
-    # is enabled.
-    #
-    # @yield [individual_files]
-    # @yieldparam individual_files [<(String, String)>]
-    #   Individual files to be updated, in addition to the directories
-    #   specified in the options.
-    #   The first element of each pair is the source file,
-    #   the second is the target CSS file.
-    define_callback :updating_stylesheets
-
-    # Register a callback to be run before a single stylesheet is updated.
-    # The callback is only run if the stylesheet is guaranteed to be updated;
-    # if the CSS file is fresh, this won't be run.
-    #
-    # Even if the \{file:SASS_REFERENCE.md#full_exception-option `:full_exception` option}
-    # is enabled, this callback won't be run
-    # when an exception CSS file is being written.
-    # To run an action for those files, use \{#on\_compilation\_error}.
-    #
-    # @yield [template, css]
-    # @yieldparam template [String]
-    #   The location of the Sass/SCSS file being updated.
-    # @yieldparam css [String]
-    #   The location of the CSS file being generated.
-    define_callback :updating_stylesheet
-
-    # Register a callback to be run when Sass decides not to update a stylesheet.
-    # In particular, the callback is run when Sass finds that
-    # the template file and none of its dependencies
-    # have been modified since the last compilation.
-    #
-    # Note that this is **not** run when the
-    # \{file:SASS_REFERENCE.md#never-update_option `:never_update` option} is set,
-    # nor when Sass decides not to compile a partial.
-    #
-    # @yield [template, css]
-    # @yieldparam template [String]
-    #   The location of the Sass/SCSS file not being updated.
-    # @yieldparam css [String]
-    #   The location of the CSS file not being generated.
-    define_callback :not_updating_stylesheet
-
-    # Register a callback to be run when there's an error
-    # compiling a Sass file.
-    # This could include not only errors in the Sass document,
-    # but also errors accessing the file at all.
-    #
-    # @yield [error, template, css]
-    # @yieldparam error [Exception] The exception that was raised.
-    # @yieldparam template [String]
-    #   The location of the Sass/SCSS file being updated.
-    # @yieldparam css [String]
-    #   The location of the CSS file being generated.
-    define_callback :compilation_error
-
-    # Register a callback to be run when Sass creates a directory
-    # into which to put CSS files.
-    #
-    # Note that even if multiple levels of directories need to be created,
-    # the callback may only be run once.
-    # For example, if "foo/" exists and "foo/bar/baz/" needs to be created,
-    # this may only be run for "foo/bar/baz/".
-    # This is not a guarantee, however;
-    # it may also be run for "foo/bar/".
-    #
-    # @yield [dirname]
-    # @yieldparam dirname [String]
-    #   The location of the directory that was created.
-    define_callback :creating_directory
-
-    # Register a callback to be run when Sass detects
-    # that a template has been modified.
-    # This is only run when using \{#watch}.
-    #
-    # @yield [template]
-    # @yieldparam template [String]
-    #   The location of the template that was modified.
-    define_callback :template_modified
-
-    # Register a callback to be run when Sass detects
-    # that a new template has been created.
-    # This is only run when using \{#watch}.
-    #
-    # @yield [template]
-    # @yieldparam template [String]
-    #   The location of the template that was created.
-    define_callback :template_created
-
-    # Register a callback to be run when Sass detects
-    # that a template has been deleted.
-    # This is only run when using \{#watch}.
-    #
-    # @yield [template]
-    # @yieldparam template [String]
-    #   The location of the template that was deleted.
-    define_callback :template_deleted
 
-    # Register a callback to be run when Sass deletes a CSS file.
-    # This happens when the corresponding Sass/SCSS file has been deleted.
-    #
-    # @yield [filename]
-    # @yieldparam filename [String]
-    #   The location of the CSS file that was deleted.
-    define_callback :deleting_css
+    @checked_for_updates = false
 
     # Whether or not Sass has **ever** checked if the stylesheets need to be updated
     # (in this Ruby instance).
@@ -156,30 +40,6 @@ module Sass
     # @return [Boolean]
     attr_reader :checked_for_updates
 
-    # An options hash.
-    # See {file:SASS_REFERENCE.md#sass_options the Sass options documentation}.
-    #
-    # @return [{Symbol => Object}]
-    attr_reader :options
-
-    # Sets the options hash.
-    # See {file:SASS_REFERENCE.md#sass_options the Sass options documentation}.
-    #
-    # @param value [{Symbol => Object}] The options hash
-    def options=(value)
-      @options.merge!(value)
-    end
-
-    # Non-destructively modifies \{#options} so that default values are properly set.
-    #
-    # @param additional_options [{Symbol => Object}] An options hash with which to merge \{#options}
-    # @return [{Symbol => Object}] The modified options hash
-    def engine_options(additional_options = {})
-      opts = options.dup.merge(additional_options)
-      opts[:load_paths] = load_paths(opts)
-      opts
-    end
-
     # Same as \{#update\_stylesheets}, but respects \{#checked\_for\_updates}
     # and the {file:SASS_REFERENCE.md#always_update-option `:always_update`}
     # and {file:SASS_REFERENCE.md#always_check-option `:always_check`} options.
@@ -214,7 +74,7 @@ module Sass
       @checked_for_updates = true
       staleness_checker = StalenessChecker.new
 
-      template_locations.zip(css_locations).each do |template_location, css_location|
+      template_location_array.each do |template_location, css_location|
 
         Dir.glob(File.join(template_location, "**", "*.s[ca]ss")).each do |file|
           # Get the relative path to the file
@@ -303,7 +163,7 @@ module Sass
       # TODO: Keep better track of what depends on what
       # so we don't have to run a global update every time anything changes.
       FSSM.monitor do |mon|
-        template_locations.zip(css_locations).each do |template_location, css_location|
+        template_location_array.each do |template_location, css_location|
           mon.path template_location do |path|
             path.glob '**/*.s[ac]ss'
 
@@ -383,20 +243,11 @@ module Sass
     end
 
     def template_locations
-      location = (options[:template_location] || File.join(options[:css_location],'sass'))
-      if location.is_a?(String)
-        [location]
-      else
-        location.to_a.map { |l| l.first }
-      end
+      template_location_array.to_a.map {|l| l.first}
     end
 
     def css_locations
-      if options[:template_location] && !options[:template_location].is_a?(String)
-        options[:template_location].to_a.map { |l| l.last }
-      else
-        [options[:css_location]]
-      end
+      template_location_array.to_a.map {|l| l.last}
     end
 
     def css_filename(name, path)

data/lib/sass/plugin/configuration.rb

@@ -0,0 +1,224 @@
+# We keep configuration in its own self-contained file
+# so that we can load it independently in Rails 3,
+# where the full plugin stuff is lazy-loaded.
+
+require 'sass/callbacks'
+
+module Sass
+  module Plugin
+    include Sass::Callbacks
+    extend self
+
+    # Register a callback to be run before stylesheets are mass-updated.
+    # This is run whenever \{#update\_stylesheets} is called,
+    # unless the \{file:SASS_REFERENCE.md#never_update-option `:never_update` option}
+    # is enabled.
+    #
+    # @yield [individual_files]
+    # @yieldparam individual_files [<(String, String)>]
+    #   Individual files to be updated, in addition to the directories
+    #   specified in the options.
+    #   The first element of each pair is the source file,
+    #   the second is the target CSS file.
+    define_callback :updating_stylesheets
+
+    # Register a callback to be run before a single stylesheet is updated.
+    # The callback is only run if the stylesheet is guaranteed to be updated;
+    # if the CSS file is fresh, this won't be run.
+    #
+    # Even if the \{file:SASS_REFERENCE.md#full_exception-option `:full_exception` option}
+    # is enabled, this callback won't be run
+    # when an exception CSS file is being written.
+    # To run an action for those files, use \{#on\_compilation\_error}.
+    #
+    # @yield [template, css]
+    # @yieldparam template [String]
+    #   The location of the Sass/SCSS file being updated.
+    # @yieldparam css [String]
+    #   The location of the CSS file being generated.
+    define_callback :updating_stylesheet
+
+    # Register a callback to be run when Sass decides not to update a stylesheet.
+    # In particular, the callback is run when Sass finds that
+    # the template file and none of its dependencies
+    # have been modified since the last compilation.
+    #
+    # Note that this is **not** run when the
+    # \{file:SASS_REFERENCE.md#never-update_option `:never_update` option} is set,
+    # nor when Sass decides not to compile a partial.
+    #
+    # @yield [template, css]
+    # @yieldparam template [String]
+    #   The location of the Sass/SCSS file not being updated.
+    # @yieldparam css [String]
+    #   The location of the CSS file not being generated.
+    define_callback :not_updating_stylesheet
+
+    # Register a callback to be run when there's an error
+    # compiling a Sass file.
+    # This could include not only errors in the Sass document,
+    # but also errors accessing the file at all.
+    #
+    # @yield [error, template, css]
+    # @yieldparam error [Exception] The exception that was raised.
+    # @yieldparam template [String]
+    #   The location of the Sass/SCSS file being updated.
+    # @yieldparam css [String]
+    #   The location of the CSS file being generated.
+    define_callback :compilation_error
+
+    # Register a callback to be run when Sass creates a directory
+    # into which to put CSS files.
+    #
+    # Note that even if multiple levels of directories need to be created,
+    # the callback may only be run once.
+    # For example, if "foo/" exists and "foo/bar/baz/" needs to be created,
+    # this may only be run for "foo/bar/baz/".
+    # This is not a guarantee, however;
+    # it may also be run for "foo/bar/".
+    #
+    # @yield [dirname]
+    # @yieldparam dirname [String]
+    #   The location of the directory that was created.
+    define_callback :creating_directory
+
+    # Register a callback to be run when Sass detects
+    # that a template has been modified.
+    # This is only run when using \{#watch}.
+    #
+    # @yield [template]
+    # @yieldparam template [String]
+    #   The location of the template that was modified.
+    define_callback :template_modified
+
+    # Register a callback to be run when Sass detects
+    # that a new template has been created.
+    # This is only run when using \{#watch}.
+    #
+    # @yield [template]
+    # @yieldparam template [String]
+    #   The location of the template that was created.
+    define_callback :template_created
+
+    # Register a callback to be run when Sass detects
+    # that a template has been deleted.
+    # This is only run when using \{#watch}.
+    #
+    # @yield [template]
+    # @yieldparam template [String]
+    #   The location of the template that was deleted.
+    define_callback :template_deleted
+
+    # Register a callback to be run when Sass deletes a CSS file.
+    # This happens when the corresponding Sass/SCSS file has been deleted.
+    #
+    # @yield [filename]
+    # @yieldparam filename [String]
+    #   The location of the CSS file that was deleted.
+    define_callback :deleting_css
+
+    @options = {
+      :css_location       => './public/stylesheets',
+      :always_update      => false,
+      :always_check       => true,
+      :full_exception     => true
+    }
+
+    # An options hash.
+    # See {file:SASS_REFERENCE.md#sass_options the Sass options documentation}.
+    #
+    # @return [{Symbol => Object}]
+    attr_reader :options
+
+    # Sets the options hash.
+    # See {file:SASS_REFERENCE.md#sass_options the Sass options documentation}.
+    #
+    # @param value [{Symbol => Object}] The options hash
+    def options=(value)
+      @options.merge!(value)
+    end
+
+    # Non-destructively modifies \{#options} so that default values are properly set.
+    #
+    # @param additional_options [{Symbol => Object}] An options hash with which to merge \{#options}
+    # @return [{Symbol => Object}] The modified options hash
+    def engine_options(additional_options = {})
+      opts = options.dup.merge(additional_options)
+      opts[:load_paths] = load_paths(opts)
+      opts
+    end
+
+    # Adds a new template-location/css-location mapping.
+    # This means that Sass/SCSS files in `template_location`
+    # will be compiled to CSS files in `css_location`.
+    #
+    # This is preferred over manually manipulating the {file:SASS_REFERENCE.md#template_location-option `:template_location` option}
+    # since the option can be in multiple formats.
+    #
+    # Note that this method will change `options[:template_location]`
+    # to be in the Array format.
+    # This means that even if `options[:template_location]`
+    # had previously been a Hash or a String,
+    # it will now be an Array.
+    #
+    # @param template_location [String] The location where Sass/SCSS files will be.
+    # @param css_location [String] The location where compiled CSS files will go.
+    def add_template_location(template_location, css_location = options[:css_location])
+      normalize_template_location!
+      template_location_array << [template_location, css_location]
+    end
+
+    # Removes a template-location/css-location mapping.
+    # This means that Sass/SCSS files in `template_location`
+    # will no longer be compiled to CSS files in `css_location`.
+    #
+    # This is preferred over manually manipulating the {file:SASS_REFERENCE.md#template_location-option `:template_location` option}
+    # since the option can be in multiple formats.
+    #
+    # Note that this method will change `options[:template_location]`
+    # to be in the Array format.
+    # This means that even if `options[:template_location]`
+    # had previously been a Hash or a String,
+    # it will now be an Array.
+    #
+    # @param template_location [String]
+    #   The location where Sass/SCSS files were,
+    #   which is now going to be ignored.
+    # @param css_location [String]
+    #   The location where compiled CSS files went, but will no longer go.
+    # @return [Boolean]
+    #   Non-`nil` if the given mapping already existed and was removed,
+    #   or `nil` if nothing was changed.
+    def remove_template_location(template_location, css_location = options[:css_location])
+      normalize_template_location!
+      template_location_array.delete([template_location, css_location])
+    end
+
+    # Returns the template locations configured for Sass
+    # as an array of `[template_location, css_location]` pairs.
+    # See the {file:SASS_REFERENCE.md#template_location-option `:template_location` option}
+    # for details.
+    #
+    # @return [Array<(String, String)>]
+    #   An array of `[template_location, css_location]` pairs.
+    def template_location_array
+      old_template_location = options[:template_location]
+      normalize_template_location!
+      options[:template_location]
+    ensure
+      options[:template_location] = old_template_location
+    end
+
+    private
+
+    def normalize_template_location!
+      return if options[:template_location].is_a?(Array)
+      options[:template_location] =
+        case options[:template_location]
+        when nil; [[File.join(options[:css_location], 'sass'), options[:css_location]]]
+        when String; [[options[:template_location], options[:css_location]]]
+        else; options[:template_location].to_a
+        end
+    end
+  end
+end

data/lib/sass/plugin/rack.rb

@@ -1,5 +1,3 @@
-require 'sass/plugin'
-
 module Sass
   module Plugin
     # Rack middleware for compiling Sass code.
@@ -45,3 +43,5 @@ module Sass
     end
   end
 end
+
+require 'sass/plugin'

data/test/sass/plugin_test.rb

@@ -148,6 +148,41 @@ CSS
     assert !File.exists?(tempfile_loc('_partial'))
   end
 
+  def test_template_location_array
+    assert_equal [[template_loc, tempfile_loc]], Sass::Plugin.template_location_array
+  end
+
+  def test_add_template_location
+    Sass::Plugin.add_template_location(template_loc(nil, "more_"), tempfile_loc(nil, "more_"))
+    assert_equal(
+      [[template_loc, tempfile_loc], [template_loc(nil, "more_"), tempfile_loc(nil, "more_")]],
+      Sass::Plugin.template_location_array)
+
+    touch 'more1', 'more_'
+    touch 'basic'
+    assert_needs_update "more1", "more_"
+    assert_needs_update "basic"
+    update_all_stylesheets!
+    assert_doesnt_need_update "more1", "more_"
+    assert_doesnt_need_update "basic"
+  end
+
+  def test_remove_template_location
+    Sass::Plugin.add_template_location(template_loc(nil, "more_"), tempfile_loc(nil, "more_"))
+    Sass::Plugin.remove_template_location(template_loc, tempfile_loc)
+    assert_equal(
+      [[template_loc(nil, "more_"), tempfile_loc(nil, "more_")]],
+      Sass::Plugin.template_location_array)
+
+    touch 'more1', 'more_'
+    touch 'basic'
+    assert_needs_update "more1", "more_"
+    assert_needs_update "basic"
+    update_all_stylesheets!
+    assert_doesnt_need_update "more1", "more_"
+    assert_needs_update "basic"
+  end
+
   # Callbacks
 
   def test_updating_stylesheets_callback
@@ -346,14 +381,14 @@ CSS
     end
   end
 
-  def assert_needs_update(name)
-    assert(Sass::Plugin::StalenessChecker.stylesheet_needs_update?(tempfile_loc(name), template_loc(name)),
-      "Expected #{template_loc(name)} to need an update.")
+  def assert_needs_update(*args)
+    assert(Sass::Plugin::StalenessChecker.stylesheet_needs_update?(tempfile_loc(*args), template_loc(*args)),
+      "Expected #{template_loc(*args)} to need an update.")
   end
 
-  def assert_doesnt_need_update(name)
-    assert(!Sass::Plugin::StalenessChecker.stylesheet_needs_update?(tempfile_loc(name), template_loc(name)),
-      "Expected #{template_loc(name)} not to need an update.")
+  def assert_doesnt_need_update(*args)
+    assert(!Sass::Plugin::StalenessChecker.stylesheet_needs_update?(tempfile_loc(*args), template_loc(*args)),
+      "Expected #{template_loc(*args)} not to need an update.")
   end
 
   def touch(*args)

data/test/sass/scss/rx_test.rb

@@ -57,7 +57,6 @@ class ScssRxTest < Test::Unit::TestCase
     assert_no_match IDENT, "-1foo"
     assert_no_match IDENT, "--foo"
     assert_no_match IDENT, "_1foo"
-    assert_no_match IDENT, "__foo"
     assert_no_match IDENT, "-_foo"
     assert_no_match IDENT, "_-foo"
     assert_no_match IDENT, "foo bar"

data/test/test_helper.rb

@@ -7,6 +7,8 @@ $:.unshift lib_dir unless $:.include?(lib_dir)
 require 'haml'
 require 'sass'
 
+Haml::Template.options[:ugly] = false
+
 Sass::RAILS_LOADED = true unless defined?(Sass::RAILS_LOADED)
 
 module Sass::Script::Functions

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 3
   - 0
-  - 0
-  version: 3.0.0
+  - 1
+  version: 3.0.1
 platform: ruby
 authors: 
 - Nathan Weizenbaum
@@ -105,6 +105,7 @@ files:
 - lib/sass/tree/variable_node.rb
 - lib/sass/plugin/rails.rb
 - lib/sass/plugin/rack.rb
+- lib/sass/plugin/configuration.rb
 - lib/sass/plugin/merb.rb
 - lib/sass/plugin/staleness_checker.rb
 - lib/sass/environment.rb