Commit c6a29d7372aa99851e602ebd585659dc0c4213a2 to chriseppstein's haml

c6a29d7
all branches
- master
- partials
- stable
all tags
- 1.8.2
- 1.8.1
- 1.8.0
- 1.7.2
- 1.7.1
- 1.7.0
- 1.5.2
- 1.5.1
- 1.5.0
- 1.0.5
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
comments

chriseppstein / haml

Run the following if you haven't already:

gem sources -a http://gems.github.com

Install the gem(s):

sudo gem install chriseppstein-haml

Fork of nex3/haml
Description:	HTML Abstraction Markup Language - A Markup Haiku
Homepage:	http://haml.hamptoncatlin.com
Clone URL:	git://github.com/chriseppstein/haml.git Give this clone URL to anyone. `git clone git://github.com/chriseppstein/haml.git`
Search Repo:

:template_location now accepts a map of template locations to css output 
locations in addition to a string.
:css_location is ignored if :template location is a map.

chriseppstein (author)

Thu Jun 19 16:10:50 -0700 2008

commit c6a29d7372aa99851e602ebd585659dc0c4213a2
tree 6c4bfe3f61acd7cfac72e69fd160399960ab951f
parent f42e750f65c93c0cf6f0ee87f259b219f2d7491e

lib/sass.rb

0
@@ -846,12 +846,18 @@ $LOAD_PATH << dir unless $LOAD_PATH.include?(dir)
0
 #                               Defaults to false in production mode, true otherwise.
0
 #                               Only has meaning within Ruby on Rails or Merb.
0
 #
0
-# [<tt>:template_location</tt>] The directory where Sass templates should be read from.
0
+# [<tt>:template_location</tt>] A path to the root sass template directory for you application.
0
+#                               If a hash, :css_location is ignored and this option designates
0
+#                               both a mapping between input and output directories.
0
+#                               May also be given a list of 2-element lists, instead of a hash.
0
 #                               Defaults to <tt>RAILS_ROOT + "/public/stylesheets/sass"</tt>
0
 #                               or <tt>MERB_ROOT + "/public/stylesheets/sass"</tt>.
0
 #                               Only has meaning within Ruby on Rails or Merb.
2
+#                               This will be derived from the :css_location path list if not provided 
0
+#                               by appending a folder of "sass" to each corresponding css location.
0
 #
0
-# [<tt>:css_location</tt>]      The directory where CSS output should be written to.
2
+# [<tt>:css_location</tt>]      The colon(:) delimited path list where CSS output should be written to.
0
+#                               This option is ignored when :template_location is a Hash.
0
 #                               Defaults to <tt>RAILS_ROOT + "/public/stylesheets"</tt>
0
 #                               or <tt>MERB_ROOT + "/public/stylesheets"</tt>.
0
 #                               Only has meaning within Ruby on Rails or Merb.

lib/sass/plugin.rb

0
@@ -7,7 +7,6 @@ module Sass
0
   module Plugin
0
     class << self
0
       @@options = {
0
-        :template_location  => './public/stylesheets/sass',
0
         :css_location       => './public/stylesheets',
0
         :always_update      => false,
0
         :always_check       => true,
0
@@ -34,52 +33,92 @@ module Sass
0
         @@options.merge!(value)
0
       end
0
 
0
-      # Checks each stylesheet in <tt>options[:css_location]</tt>
0
-      # to see if it needs updating,
0
-      # and updates it using the corresponding template
0
-      # from <tt>options[:templates]</tt>
0
-      # if it does.
0
+      # Checks each css stylesheet to see if it needs updating,
0
+      # and updates it using the corresponding sass template if it does.
0
       def update_stylesheets
0
         return if options[:never_update]
0
 
0
         @@checked_for_updates = true
0
-        Dir.glob(File.join(options[:template_location], "**", "*.sass")).entries.each do |file|
0
-
0
-          # Get the relative path to the file with no extension
0
-          name = file.sub(options[:template_location] + "/", "")[0...-5]
0
-
0
-          if !forbid_update?(name) && (options[:always_update] || stylesheet_needs_update?(name))
0
-            css = css_filename(name)
0
-            File.delete(css) if File.exists?(css)
0
-
0
-            filename = template_filename(name)
0
-            l_options = @@options.dup
0
-            l_options[:filename] = filename
2
-            l_options[:load_paths] = load_paths
0
-            engine = Engine.new(File.read(filename), l_options)
0
-            result = begin
0
-                       engine.render
0
-                     rescue Exception => e
0
-                       exception_string(e)
0
-                     end
0
-
0
-            # Create any directories that might be necessary
0
-            dirs = [l_options[:css_location]]
0
-            name.split("/")[0...-1].each { |dir| dirs << "#{dirs[-1]}/#{dir}" }
0
-            dirs.each { |dir| Dir.mkdir(dir) unless File.exist?(dir) }
0
-
0
-            # Finally, write the file
0
-            File.open(css, 'w') do |file|
0
-              file.print(result)
0
+        template_location_map.each do |template_location, css_location|
0
+
0
+          Dir.glob(File.join(template_location, "**", "*.sass")).entries.each do |file|
0
+            # Get the relative path to the file with no extension
0
+            name = file.sub(template_location + "/", "")[0...-5]
0
+
0
+            if !forbid_update?(name) && (options[:always_update] || stylesheet_needs_update?(name, template_location, css_location))
0
+              update_stylesheet(name, template_location, css_location)
0
             end
0
+
0
           end
0
         end
0
       end
0
 
2
       private
0
 
0
+      def update_stylesheet(name, template_location, css_location)
0
+        css = css_filename(name, css_location)
0
+        File.delete(css) if File.exists?(css)
0
+
0
+        filename = template_filename(name, template_location)
0
+        l_options = @@options.dup
0
+        l_options[:filename] = filename
0
+        l_options[:load_paths] = load_paths
0
+        engine = Engine.new(File.read(filename), l_options)
0
+        result = begin
0
+                   engine.render
0
+                 rescue Exception => e
0
+                   exception_string(e)
0
+                 end
0
+
0
+        # Create any directories that might be necessary
0
+        mkpath(css_location,name)
0
+
0
+        # Finally, write the file
0
+        File.open(css, 'w') do |file|
0
+          file.print(result)
2
+        end
0
+      end
0
+      
0
+      # Create any successive directories required to be able to write a file to: File.join(base,name)
0
+      def mkpath(base,name)
0
+        dirs = [base]
0
+        name.split(File::SEPARATOR)[0...-1].each { |dir| dirs << File.join(dirs[-1],dir) }
0
+        dirs.each { |dir| Dir.mkdir(dir) unless File.exist?(dir) }
0
+      end
0
+
0
       def load_paths
2
-        (options[:load_paths] || []) + [options[:template_location]]
0
+        (options[:load_paths] || []) + template_locations
0
+      end
0
+      
0
+      def template_locations
0
+        case location = (options[:template_location] || default_template_location)
0
+        when String
0
+          [location]
0
+        when Array
0
+          #in case we get passed a list of tuples.
0
+          location.map{ |t| t.first }
0
+        when Hash
0
+          location.keys
0
+        end
2
+      end
0
+      
0
+      def css_locations
0
+        case options[:template_location]
0
+        when Hash
0
+          template_locations.map{ |m|options[:template_location][m] }
0
+        when Array
0
+          #in case we get passed a list of tuples.
0
+          options[:template_location].map{ |t| t.last }
0
+        else
2
+          Array(options[:css_location] || default_css_location)
0
+        end
0
+      end
0
+      
0
+      # map of template locations to css locations
2
+      def template_location_map
0
+        template_locations.zip(css_locations).inject([]) do |memo, pair|
0
+          memo << [pair.first || memo.first.first, pair.last || memo.first.last]
0
+        end
0
       end
0
 
2
       def exception_string(e)
0
@@ -96,10 +135,14 @@ module Sass
0
                 e_string << "\n\n"
0
 
0
                 min = [e.sass_line - 5, 0].max
0
-                File.read(e.sass_filename).rstrip.split("\n")[
0
-                  min .. e.sass_line + 5
0
-                ].each_with_index do |line, i|
0
-                  e_string << "#{min + i + 1}: #{line}\n"
0
+                begin
0
+                  File.read(e.sass_filename).rstrip.split("\n")[
0
+                    min .. e.sass_line + 5
0
+                  ].each_with_index do |line, i|
0
+                    e_string << "#{min + i + 1}: #{line}\n"
0
+                  end
2
+                rescue
0
+                  e_string << "Couldn't read sass file: #{e.sass_filename}"
0
                 end
0
               end
0
             end
0
@@ -121,25 +164,39 @@ END
0
         end
0
       end
0
 
0
-      def template_filename(name)
0
-        "#{options[:template_location]}/#{name}.sass"
0
+      def default_css_location
0
+        Array(options[:css_location]).first
0
+      end
0
+
0
+      def default_template_location
0
+        if options[:template_location]
0
+          Array(options[:template_location]).first
0
+        else
2
+          File.join(default_css_location,'sass')
0
+        end
0
+      end
0
+
0
+      def template_filename(name, path = default_template_location)
0
+        "#{path}/#{name}.sass"
0
       end
0
 
0
-      def css_filename(name)
0
-        "#{options[:css_location]}/#{name}.css"
0
+      def css_filename(name, path = default_css_location)
0
+        "#{path}/#{name}.css"
0
       end
0
 
0
       def forbid_update?(name)
0
         name.sub(/^.*\//, '')[0] == ?_
0
       end
0
 
0
-      def stylesheet_needs_update?(name)
0
-        if !File.exists?(css_filename(name))
0
+      def stylesheet_needs_update?(name, template_path = default_template_location, css_path = default_css_location)
0
+        css_file = css_filename(name, css_path)
0
+        template_file = template_filename(name, template_path)
0
+        if !File.exists?(css_file)
0
           return true
0
         else
0
-          css_mtime = File.mtime(css_filename(name))
0
-          File.mtime(template_filename(name)) > css_mtime ||
0
-            dependencies(template_filename(name)).any?(&dependency_updated?(css_mtime))
0
+          css_mtime = File.mtime(css_file)
2
+          File.mtime(template_file) > css_mtime ||
0
+            dependencies(template_file).any?(&dependency_updated?(css_mtime))
0
         end
0
       end
0

test/sass/plugin_test.rb

0
@@ -15,12 +15,14 @@ class SassPluginTest < Test::Unit::TestCase
0
 
0
   def setup
0
     FileUtils.mkdir File.dirname(__FILE__) + '/tmp'
0
+    FileUtils.mkdir File.dirname(__FILE__) + '/more_tmp'
0
     set_plugin_opts
0
     Sass::Plugin.update_stylesheets
0
   end
0
 
0
   def teardown
0
     FileUtils.rm_r File.dirname(__FILE__) + '/tmp'
0
+    FileUtils.rm_r File.dirname(__FILE__) + '/more_tmp'
0
   end
0
 
0
   def test_templates_should_render_correctly
0
@@ -69,6 +71,14 @@ class SassPluginTest < Test::Unit::TestCase
0
 
0
     Sass::Plugin.options[:full_exception] = true
0
   end
0
+  
0
+  def test_two_template_directories
2
+    templates = ['templates', 'more_templates'].map{ |t| File.dirname(__FILE__) + "/#{t}" }
0
+    csses = ['tmp', 'more_tmp'].map{ |c| File.dirname(__FILE__) + "/#{c}" }
0
+    set_plugin_opts :template_location => templates.zip(csses)
0
+    Sass::Plugin.update_stylesheets
0
+    ['more1', 'more_import'].each { |name| assert_renders_correctly(name, 'more_') }
0
+  end
0
 
0
   def test_rails_update    
0
     File.delete(tempfile_loc('basic'))
0
@@ -105,33 +115,33 @@ class SassPluginTest < Test::Unit::TestCase
0
 
0
  private
0
 
0
-  def assert_renders_correctly(name)
0
-    File.read(result_loc(name)).split("\n").zip(File.read(tempfile_loc(name)).split("\n")).each_with_index do |pair, line|
0
+  def assert_renders_correctly(name, prefix = nil)
0
+    File.read(result_loc(name,prefix)).split("\n").zip(File.read(tempfile_loc(name,prefix)).split("\n")).each_with_index do |pair, line|
0
       message = "template: #{name}\nline:     #{line + 1}"
0
       assert_equal(pair.first, pair.last, message)
0
     end
0
   end
2
 
0
-  def template_loc(name)
0
-    File.dirname(__FILE__) + "/templates/#{name}.sass"
0
+  def template_loc(name, prefix = nil)
0
+    File.dirname(__FILE__) + "/#{prefix}templates/#{name}.sass"
0
   end
0
 
0
-  def tempfile_loc(name)
0
-    File.dirname(__FILE__) + "/tmp/#{name}.css"
0
+  def tempfile_loc(name, prefix = nil)
0
+    File.dirname(__FILE__) + "/#{prefix}tmp/#{name}.css"
0
   end
0
 
0
-  def result_loc(name)
0
-    File.dirname(__FILE__) + "/results/#{name}.css"
0
+  def result_loc(name, prefix = nil)
0
+    File.dirname(__FILE__) + "/#{prefix}results/#{name}.css"
0
   end
0
 
0
-  def set_plugin_opts
0
+  def set_plugin_opts(overides = {})
0
     Sass::Plugin.options = {
0
       :template_location => File.dirname(__FILE__) + '/templates',
0
       :css_location => File.dirname(__FILE__) + '/tmp',
0
       :style => :compact,
3
       :load_paths => [File.dirname(__FILE__) + '/results'],
0
       :always_update => true,
0
-    }
0
+    }.merge(overides)
0
   end
0
 end
0

Comments

nex3 Sun Jul 13 10:12:48 -0700 2008 at lib/sass.rb L861

This still says colon-delimited…
nex3 Sun Jul 13 10:15:05 -0700 2008 at lib/sass.rb L857

I don’t think there should be this many ways to set different paths. Let’s just leave it at setting strings for both or a hash for :template_location.
nex3 Sun Jul 13 10:22:57 -0700 2008 at lib/sass/plugin.rb L41

Isn’t .entries here redundant?
nex3 Sun Jul 13 10:23:56 -0700 2008 at lib/sass/plugin.rb L71

Another stylistic thing: no extra lines between two ends.
nex3 Sun Jul 13 10:24:59 -0700 2008 at lib/sass/plugin.rb L94

Style: space after comma
nex3 Sun Jul 13 10:29:20 -0700 2008 at lib/sass/plugin.rb L119

What about

if location.is_a?(String) [location] else location.to_a.map { |l| l.first } end

That should handle arrays, hashes, and be more duck-typey anyway.
nex3 Sun Jul 13 10:30:53 -0700 2008 at lib/sass/plugin.rb L129

Again, it’d probably be easier to just call to_a here and treat it like an array of tuples.
nex3 Sun Jul 13 10:34:30 -0700 2008 at lib/sass/plugin.rb L140

I thought we were dropping support for pairwise arrays.
nex3 Sun Jul 13 10:35:55 -0700 2008 at lib/sass/plugin.rb L105

If splitting on ”/” breaks on windows, that should be fixed in a separate commit that I can pull separately into stable.
nex3 Sun Jul 13 10:36:22 -0700 2008 at lib/sass/plugin.rb L155

This is also a logically separate change, and should have its own commit.
nex3 Sun Jul 13 10:42:29 -0700 2008 at lib/sass/plugin.rb L134

This doesn’t make sense: if options[:css_location] is nil, default_css_location will be nil, too.
nex3 Sun Jul 13 10:44:29 -0700 2008 at lib/sass/plugin.rb L174

When does this or css_filename ever get called with only one argument? I don’t think we need those default_ methods at all.
nex3 Sun Jul 13 10:45:31 -0700 2008 at lib/sass/plugin.rb L174

Sorry, meant that comment for def template_filename
nex3 Sun Jul 13 10:46:30 -0700 2008 at lib/sass/plugin.rb L204

Again, I don’t think there’s any reason for this to have optional args.
nex3 Sun Jul 13 10:48:28 -0700 2008 at test/sass/plugin_test.rb L35

If we’re expecting people to use hashes, we should test this with a hash.
nex3 Sun Jul 13 10:48:53 -0700 2008 at test/sass/plugin_test.rb L56

Style: Space after comma
nex3 Sun Jul 13 10:49:11 -0700 2008 at test/sass/plugin_test.rb L81

“overrides”
chriseppstein Mon Jul 14 09:29:18 -0700 2008 at lib/sass/plugin.rb L140

No we were dropping support for colon delimited paths. Pairwise arrays are really handy and are just another representation of a map.
chriseppstein Mon Jul 14 09:29:30 -0700 2008 at lib/sass/plugin.rb L134

Good point.
chriseppstein Mon Jul 14 09:29:42 -0700 2008 at lib/sass/plugin.rb L129

I like that.
chriseppstein Mon Jul 14 09:29:53 -0700 2008 at lib/sass/plugin.rb L119

I like that better.
chriseppstein Mon Jul 14 09:30:03 -0700 2008 at lib/sass/plugin.rb L105

ok.
chriseppstein Mon Jul 14 09:30:12 -0700 2008 at lib/sass/plugin.rb L94

fixed.
chriseppstein Mon Jul 14 09:30:21 -0700 2008 at lib/sass/plugin.rb L71

fixed.
chriseppstein Mon Jul 14 09:30:49 -0700 2008 at lib/sass.rb L861

oops.
chriseppstein Mon Jul 14 09:40:48 -0700 2008 at test/sass/plugin_test.rb L35

This is one of the examples where using pairwise arrays is more natural than a hash. I agree so I’ll add a test case that asserts that hashes are not treated differently than pairwise arrays.
chriseppstein Mon Jul 14 11:10:50 -0700 2008 at lib/sass/plugin.rb L41

Yes, so I just learned.
chriseppstein Mon Jul 14 11:11:49 -0700 2008 at lib/sass/plugin.rb L155

I’m going to unsquash this change set and rewrite it again, taking care to avoid combining logically separate changes.
chriseppstein Mon Jul 14 11:12:49 -0700 2008 at lib/sass/plugin.rb L204

Agreed, it was useful for backwards compatibility with the test cases, but I updated them to pass the locations explicitly
chriseppstein Mon Jul 14 11:13:23 -0700 2008 at test/sass/plugin_test.rb L56

Fixed, I also cleaned up this line as it was too long to be readable.
chriseppstein Mon Jul 14 11:13:47 -0700 2008 at test/sass/plugin_test.rb L81

i’m a CS major not an engrish major!
chriseppstein Mon Jul 14 11:14:49 -0700 2008 at test/sass/plugin_test.rb L81

Well change that to I have a CS degree not a an engrish degree. I’ve not been in college for a while now!
chriseppstein Mon Jul 14 11:16:11 -0700 2008 at lib/sass.rb L857

Thanks for taking time to do such a thorough review. I’ve addressed all the issues you’ve raised except this one. I feel that making the change would be a mistake and I’ll follow up with you in a separate email.