Reorganizing style outputs

merbjedi · merbjedi · commit 7a40b779c149 · 2009-11-18T01:15:18.000-08:00
diff --git a/lib/sprite/builder.rb b/lib/sprite/builder.rb
@@ -31,26 +31,28 @@ def initialize(config = nil, images = nil)
       set_image_defaults
       expand_image_paths
       
-      # initialize output
-      @output = {}
+      # initialize sprite files
+      @sprite_files = {}
     end
   
     def build    
-      @output = {}
+      @sprite_files = {}
       
       if images.size > 0
         # create images
         images.each do |image|
-          output_image(image)
+          write_image(image)
         end
     
-        # write css
-        output_file
+        if @sprite_files.values.length > 0
+          # write css
+          write_styles
+        end
       end
     end
     
     protected
-    def output_image(image)
+    def write_image(image)
       results = []
       sources = image['sources'].to_a
       return unless sources.length > 0
@@ -82,53 +84,17 @@ def output_image(image)
       
       # write sprite image file to disk
       dest_image.write(path)
-      @output["#{name}.#{format}"] = results
+      @sprite_files["#{name}.#{format}"] = results
     end
-
-    def output_file
+    
+    def write_styles
       style = Styles.get(config["style"]).new(self)
       
       # set up path
       path = style_output_path(style.extension)
       FileUtils.mkdir_p(File.dirname(path))
       
-      # write styles to disk
-      File.open(path, 'w') do |f|
-        f << style.generate(@output)
-      end      
-    end
-    
-    # get the disk path for the style output file
-    def style_output_path(file_ext)
-      path = config['style_output_path']
-      unless path.include?(".#{file_ext}")
-        path = "#{path}.#{file_ext}"
-      end
-      public_path(path)
-    end
-    
-    # get the disk path for a location within the image output folder
-    def image_output_path(name, format)
-      path_parts = []
-      path_parts << chop_trailing_slash(config['image_output_path'])
-      path_parts << "#{name}.#{format}"
-      public_path(File.join(*path_parts))
-    end
-    
-    # get the disk path for a location within the public folder (if set)
-    def public_path(location)
-      path_parts = []
-      path_parts << Sprite.root
-      path_parts << chop_trailing_slash(config['public_path']) if config['public_path'] and config['public_path'].length > 0
-      path_parts << location
-      
-      File.join(*path_parts)
-    end
-    
-    # chop off the trailing slash on a directory path (if it exists)
-    def chop_trailing_slash(path)
-      path = path[0...-1] if path[-1] == File::SEPARATOR
-      path
+      style.write(path, @sprite_files)
     end
     
     # sets all the default values on the config
@@ -147,7 +113,7 @@ def set_config_defaults
     def set_image_defaults
       return unless @images.size == 0
       
-      sprites_path = File.join(Sprite.root, config['public_path'], config['image_source_path'], "sprites")
+      sprites_path = image_source_path("sprites")
       
       if File.exists?(sprites_path)
         Dir.glob(File.join(sprites_path, "*")) do |dir|
@@ -166,7 +132,6 @@ def set_image_defaults
           }
         end
       end
-      
     end
     
     # expands out sources, taking the Glob paths and turning them into separate entries in the array
@@ -175,10 +140,55 @@ def expand_image_paths
       @images.each do |image|
         # expand out all the globs
         image['sources'] = image['sources'].to_a.map{ |source|
-          Dir.glob(File.join(Sprite.root, config['public_path'], @config['image_source_path'], source))
+          Dir.glob(image_source_path(source))
         }.flatten.compact
       end
     end
     
+    # get the disk path for the style output file
+    def style_output_path(file_ext, relative = false)
+      path = config['style_output_path']
+      unless path.include?(".#{file_ext}")
+        path = "#{path}.#{file_ext}"
+      end
+      public_path(path, relative)
+    end
+    
+    # get the disk path for a location within the image output folder
+    def image_output_path(name, format, relative = false)
+      path_parts = []
+      path_parts << chop_trailing_slash(config['image_output_path']) if path_present?(config['image_output_path'])
+      path_parts << "#{name}.#{format}"
+      public_path(File.join(*path_parts), relative)
+    end
+    
+    # get the disk path for an image source file
+    def image_source_path(location, relative = false)
+      path_parts = []
+      path_parts << chop_trailing_slash(config["image_source_path"]) if path_present?(config['image_source_path'])
+      path_parts << location
+      public_path(File.join(*path_parts), relative)
+    end
+    
+    # get the disk path for a location within the public folder (if set)
+    def public_path(location, relative = false)
+      path_parts = []
+      path_parts << Sprite.root unless relative
+      path_parts << chop_trailing_slash(config['public_path']) if path_present?(config['public_path'])
+      path_parts << location
+      
+      File.join(*path_parts)
+    end
+        
+    # chop off the trailing slash on a directory path (if it exists)
+    def chop_trailing_slash(path)
+      path = path[0...-1] if path[-1] == File::SEPARATOR
+      path
+    end
+    
+    # check if the path is set
+    def path_present?(path)
+      path.to_s.strip != ""
+    end
   end
 end
diff --git a/lib/sprite/image_combiner.rb b/lib/sprite/image_combiner.rb
@@ -24,6 +24,10 @@ def get_image(image_filename)
     def image_properties(image)
       {:name => File.basename(image.filename).split('.')[0], :width => image.columns, :height => image.rows}
     end
+        
+    # REMOVE RMAGICK AND USE IMAGEMAGICK FROM THE COMMAND LINE
+    # identify => find properties for an image
+    # composite => combine 2 images
 
   end
 end
diff --git a/lib/sprite/sass_extensions.rb b/lib/sprite/sass_extensions.rb
@@ -0,0 +1,50 @@
+module Sprite::Sass::Extensions
+  def sprite_background(group, image)
+    sprite = sprite_data(group, image)
+    # TODO
+    ""
+  end
+
+  def sprite_width(group, image)
+    sprite = sprite_data(group, image)
+    # TODO
+    ""
+  end
+  
+  def sprite_height(group, image)
+    sprite = sprite_data(group, image)
+    # TODO
+    ""
+  end
+  
+  protected
+  def sprite_data(group, image)
+    unless @__sprite_data
+      @__sprite_data = {
+        "group_name" => {
+          "image_name" => {
+            :width => "",
+            :height => "",
+            :group => "dkajsdfk",
+            :x => "",
+            :y => ""
+          }
+        }
+      }
+    end
+    
+    group_data = @__sprite_data[group]
+    if group_data
+      return group_data[image]
+    else
+      nil
+    end
+  end
+  
+end
+
+if defined?(Sass)
+  module Sass::Script::Functions
+    include Sprite::Sass::Extensions
+  end
+end
diff --git a/lib/sprite/styles/css_generator.rb b/lib/sprite/styles/css_generator.rb
@@ -6,24 +6,23 @@ def initialize(builder)
         @builder = builder
       end
   
-      def generate(sprite_files)
-        output = ""
-    
+      def write(path, sprite_files)
         # set up class_name to append to each rule
         sprites_class = @builder.config['sprites_class'] ? ".#{@builder.config['sprites_class']}" : ""
     
-        # write stylesheet file to disk
-        sprite_files.each do |sprite_file, sprites|
-          sprites.each do |sprite|
-            output << "#{sprites_class}.#{sprite[:group]}#{@builder.config['class_separator']}#{sprite[:name]} {\n"
-            output << "  background: url('http://github.com/#{@builder.config['image_output_path']}#{sprite_file}') no-repeat #{sprite[:x]}px #{sprite[:y]}px;\n"
-            output << "  width: #{sprite[:width]}px;\n"
-            output << "  height: #{sprite[:height]}px;\n"
-            output << "}\n"
+        # write styles to disk
+        File.open(path, 'w') do |f|
+          # write stylesheet file to disk
+          sprite_files.each do |sprite_file, sprites|
+            sprites.each do |sprite|
+              f.puts "#{sprites_class}.#{sprite[:group]}#{@builder.config['class_separator']}#{sprite[:name]} {"
+              f.puts "  background: url('http://github.com/#{@builder.config['image_output_path']}#{sprite_file}') no-repeat #{sprite[:x]}px #{sprite[:y]}px;"
+              f.puts "  width: #{sprite[:width]}px;"
+              f.puts "  height: #{sprite[:height]}px;"
+              f.puts "}"
+            end
           end
-        end
-    
-        output
+        end      
       end
   
       def extension
diff --git a/lib/sprite/styles/sass_generator.rb b/lib/sprite/styles/sass_generator.rb
@@ -7,24 +7,32 @@ def initialize(builder)
         @builder = builder
       end
 
-      def generate(sprite_files)
-        output = ""
-    
-        # set up class_name to append to each rule
-        sprites_class = @builder.config['sprites_class'] ? ".#{@builder.config['sprites_class']}" : ""
-    
-        output << "#{sprites_class}\n"
-        sprite_files.each do |sprite_file, sprites|
-          sprites.each do |sprite|
-            output << "  &.#{sprite[:group]}#{@builder.config['class_separator']}#{sprite[:name]}\n"
-            output << "    background: url('http://github.com/#{@builder.config['image_output_path']}#{sprite_file}') no-repeat #{sprite[:x]}px #{sprite[:y]}px\n"
-            output << "    width: #{sprite[:width]}px\n"
-            output << "    height: #{sprite[:height]}px\n"
-            output << "\n"
+      def write(path, sprite_files)
+        @level = 0
+
+        File.open(path, 'w') do |f|
+          if @builder.config['sprites_class']
+            f.puts ".#{@builder.config['sprites_class']}"
+            @level += 1
+          end
+          
+          sprite_files.each do |sprite_file, sprites|
+            sprites.each do |sprite|
+              f.puts sass_line("&.#{sprite[:group]}#{@builder.config['class_separator']}#{sprite[:name]}")
+              @level += 1
+              f.puts sass_line("background: url('http://github.com/#{@builder.config['image_output_path']}#{sprite_file}') no-repeat #{sprite[:x]}px #{sprite[:y]}px")
+              f.puts sass_line("width: #{sprite[:width]}px")
+              f.puts sass_line("height: #{sprite[:height]}px")
+              f.puts sass_line("")
+              @level -= 1
+            end
           end
         end
-    
-        output
+      end
+      
+      # write sass output with correct tab spaces prepended
+      def sass_line(sass)
+        "#{'  '*@level}#{sass}"
       end
   
       def extension
diff --git a/lib/sprite/styles/sass_mixin_generator.rb b/lib/sprite/styles/sass_mixin_generator.rb
@@ -1,17 +1,52 @@
+require 'yaml'
 module Sprite
   module Styles
-    # renders a yml file that is parsed by a sass extension
+    # renders a yml file that is later parsed by a sass extension when generating the mixins
     class SassMixinGenerator
       def initialize(builder)
         @builder = builder
       end
-
-      def generate(output)
-        "NOT DONE YET"
+      
+      def write(path, sprite_files)        
+        # build the yml file
+        config_location = write_config(path, sprite_files)
+        
+        # write the sass mixins to disk
+        File.open(path, 'w') do |f|
+          f.puts "!sprite_data = '#{config_location}'"
+          f.puts ""
+          f.puts "= sprite(!group_name, !image_name)"
+          f.puts "  background= sprite_background(!group_name, !image_name)"
+          f.puts "  width= sprite_width(!group_name, !image_name)"
+          f.puts "  height= sprite_height(!group_name, !image_name)"
+          f.puts ""
+        end
       end
-  
+      
+      # write the sprite configuration file (used by the yml extension)
+      def write_config(path, sprite_files)
+        # build a grouped hash with all the sprites in it
+        result = {}
+        sprite_files.each do |sprite_file, sprites|
+          sprites.each do |sprite|
+            if sprite[:group]
+              result[sprite[:group]] ||= {}
+              result[sprite[:group]][sprite[:name]] = sprite
+            end
+          end
+        end
+        
+        # write the config yml to disk
+        config_path = path.gsub(".sass", ".yml")
+        File.open(config_path, 'w') do |f|
+          YAML.dump(result, f)
+        end
+        
+        config_path
+      end
+      
       def extension
-        "yml"
+        "sass"
       end
   
     end
