Reorganizing the configuration so its relative to a public folder (overridable)

Author: merbjedi

README.md

@@ -90,9 +90,10 @@ Configuration of `sprite` is done via `config/sprite.yml`. It allows you to set
 
 * `config:` section defines all the global properties for sprite generation. Such as how it generates the styles, where it looks for images, where it writes it output file to, and what image file format it uses by default
   - `style:` defines how the style rules are outputted. built in options are `css`, `sass`, and `sass_mixin`. (defaults to `css`)
-  - `output_path:` defines the file path where your style settings get written (defaults to `public/stylesheets/sprites`). the file extension not needed as it will be set based on the `style:` setting 
-  - `image_output_path:` defines the folder path where the combined sprite images files are written (defaults to `public/images/sprites/`)
-  - `source_path:` defines the folder where source image files are read from (defaults to `public/images/`)
+  - `style_output_path:` defines the file path where your style settings get written (defaults to `stylesheets/sprites`). the file extension not needed as it will be set based on the `style:` setting 
+  - `image_output_path:` defines the folder path where the combined sprite images files are written (defaults to `images/sprites/`)
+  - `image_source_path:` defines the folder where source image files are read from (defaults to `images/`)
+  - `public_path:` defines the root folder where static assets live (defaults to `public/`)
   - `sprites_class:` defines the class name that gets added to all sprite stylesheet rules (defaults to `sprites`)
   - `default_format:` defines the default file image format of the generated files. (defaults to `png`)
   - `class_separator:` used to generated the class name by separating the image name and sprite name (defaults to `-`)
@@ -104,17 +105,18 @@ Configuration of `sprite` is done via `config/sprite.yml`. It allows you to set
   - `spaced_by:` spacing (in pixels) between the combined images. (defaults to `0`)
   - `format:` define what image file format gets created (optional, uses `default_format` setting if not set)
 
-you can define any number of destination image files.
+All image and style paths should be set relative to the public folder (which is configurable via public_path setting).
 
 ### Sample Configuration `config/sprite.yml` ###
 
     # defines the base configuration options (file paths, etc, default style, etc)
 
     config:
       style: css
-      output_path: public/sass/mixins/sprites.sass
-      image_output_path: public/images/sprites/
-      source_path: public/images/
+      style_output_path: sass/mixins/sprites.sass
+      image_output_path: images/sprites/
+      image_source_path: images/
+      public_path: public/
       sprites_class: 'sprites'
       class_separator: '-'
       default_format: png

VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

lib/sprite/builder.rb

@@ -8,16 +8,19 @@ class Builder
     attr_reader :output
 
     def self.from_config(path = nil) 
-
       results = {}
-      config_path = File.join(Sprite.root, path || DEFAULT_CONFIG_PATH)      
-      begin
-        results = File.open(config_path) {|f| YAML::load(f)} || {}
-      rescue => e
-        puts "Unable to read sprite config: #{Sprite.root+"/"+config_path}"
-        puts e.to_s
-      end
+      config_path = File.join(Sprite.root, path || DEFAULT_CONFIG_PATH)
 
+      # read configuration
+      if File.exists?(config_path) 
+        begin
+          results = File.open(config_path) {|f| YAML::load(f)} || {}
+        rescue => e
+          puts "Error reading sprite config: #{config_path}"
+          puts e.to_s
+        end
+      end
+
       new(results["config"], results["images"])
     end
 
@@ -26,12 +29,9 @@ def initialize(config = nil, images = nil)
       set_config_defaults
 
       @images = images || []
+      set_image_defaults
       expand_image_paths
 
-      # freeze hashes
-      @config = @config.dup.freeze
-      @images = @images.dup.freeze
-
       # initialize output
       @output = {}
     end
@@ -49,7 +49,8 @@ def build
         output_file
       end
     end
-  
+    
+    protected
     def output_image(image)
       results = []
       sources = image['sources'].to_a
@@ -74,19 +75,19 @@ def output_image(image)
         results << combiner.image_properties(source_image).merge(:x => x, :y => y, :group => name)
         dest_image = combiner.composite_images(dest_image, source_image, x, y)
       end
-      @output[name] = results
 
       # set up path
-      path = image_path(name, image['format'])
+      path = image_output_path(name, image['format'] || config["default_format"])
       FileUtils.mkdir_p(File.dirname(path))
 
       # write sprite image file to disk
       dest_image.write(path)
+      @output[name] = results
     end
-    
+
     def output_file
       # set up path
-      path = output_path("css")
+      path = style_output_path("css")
       FileUtils.mkdir_p(File.dirname(path))
 
       # set up class_name to append to each rule
@@ -97,7 +98,7 @@ def output_file
         @output.each do |dest, results|
           results.each do |result|
             f.puts "#{sprites_class}.#{result[:group]}#{config['class_separator']}#{result[:name]} {"
-            f.puts "  background: url('http://github.com/%3Cspan%20class=%22x%20x-first%20x-last%22%3Eimages/%3C/span%3E%3Cspan%20class=%22pl-s1%22%3E%3Cspan%20class=%22pl-kos%22%3E#{%3C/span%3E%3Cspan%20class=%22pl-s1%22%3Edest%3C/span%3E%3Cspan%20class=%22pl-kos%22%3E}%3C/span%3E%3C/span%3E') no-repeat #{result[:x]}px #{result[:y]}px;"
+            f.puts "  background: url('http://github.com/%3Cspan%20class=%22pl-s1%22%3E%3Cspan%20class=%22pl-kos%20x%20x-first%22%3E#{%3C/span%3E%3Cspan%20class=%22pl-en%20x%22%3Econfig%3C/span%3E%3Cspan%20class=%22pl-kos%20x%22%3E[%3C/span%3E%3Cspan%20class=%22pl-s%20x%22%3E'image_output_path'%3C/span%3E%3Cspan%20class=%22pl-kos%20x%22%3E]%3C/span%3E%3Cspan%20class=%22pl-kos%20x%20x-last%22%3E}%3C/span%3E%3C/span%3E%3Cspan%20class=%22pl-s1%22%3E%3Cspan%20class=%22pl-kos%22%3E#{%3C/span%3E%3Cspan%20class=%22pl-s1%22%3Edest%3C/span%3E%3Cspan%20class=%22pl-kos%22%3E}%3C/span%3E%3C/span%3E') no-repeat #{result[:x]}px #{result[:y]}px;"
             f.puts "  width: #{result[:width]}px;"
             f.puts "  height: #{result[:height]}px;"
             f.puts "}"
@@ -106,25 +107,75 @@ def output_file
       end
     end
 
-    protected
+    # 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
 
-    def output_path(file_ext)
-      "#{Sprite.root}/#{config['output_path']}.#{file_ext}"
+    # 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
 
-    def image_path(name, format)
-      "#{Sprite.root}/#{config['image_output_path']}#{name}.#{format}"
+    # 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
     end
 
     # sets all the default values on the config
     def set_config_defaults
       @config['style']              ||= 'css'
-      @config['output_path']        ||= 'public/stylesheets/sprites'
-      @config['image_output_path']  ||= 'public/images/sprites/'
-      @config['source_path']        ||= 'public/images/'
+      @config['style_output_path']        ||= 'stylesheets/sprites'
+      @config['image_output_path']  ||= 'images/sprites/'
+      @config['image_source_path']        ||= 'images/'
+      @config['public_path']        ||= 'public/'
       @config['default_format']     ||= 'png'
       @config['class_separator']    ||= '-'
-      @config["sprites_class"] ||= 'sprites'
+      @config["sprites_class"]      ||= 'sprites'
+    end
+    
+    # if no image configs are detected, set some intelligent defaults
+    def set_image_defaults
+      return unless @images.size == 0
+      
+      sprites_path = File.join(Sprite.root, config['public_path'], config['image_source_path'], "sprites")
+      
+      if File.exists?(sprites_path)
+        Dir.glob(File.join(sprites_path, "*")) do |dir|
+          next unless File.directory?(dir)
+          source_name = File.basename(dir)
+
+          # default to finding all png, gif, jpg, and jpegs within the directory
+          images << {
+            "name" => source_name,
+            "sources" => [
+              File.join("sprites", source_name, "*.png"),
+              File.join("sprites", source_name, "*.gif"),
+              File.join("sprites", source_name, "*.jpg"),
+              File.join("sprites", source_name, "*.jpeg"),
+            ]
+          }
+        end
+      end
+      
     end
 
     # expands out sources, taking the Glob paths and turning them into separate entries in the array
@@ -133,7 +184,7 @@ 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['source_path'], source))
+          Dir.glob(File.join(Sprite.root, config['public_path'], @config['image_source_path'], source))
         }.flatten.compact
       end
     end

spec/resources/configs/android-icons.yml

@@ -1,8 +1,9 @@
 config:
   style: css
-  output_path: output/stylesheets/android-icons
+  style_output_path: output/stylesheets/android-icons
   image_output_path: output/images/sprites/
-  source_path: resources/images/
+  image_source_path: resources/images/
+  public_path: ''
   class_separator: '-'
   default_format: png
 

spec/resources/configs/config-test.yml

@@ -1,8 +1,9 @@
 config:
   style: css
-  output_path: output/stylesheets/sprites
+  style_output_path: output/stylesheets/sprites
   image_output_path: output/images/sprites/
-  source_path: resources/images/
+  image_source_path: resources/images/
+  public_path: ''
   class_separator: '-'
   default_format: png
 

spec/sprite/builder_spec.rb

@@ -1,59 +1,6 @@
 require File.dirname(__FILE__) + '/../spec_helper.rb'
 
 describe Sprite::Builder do
-
-  context "configuration parsing" do
-    before(:all) do
-      @sprite = Sprite::Builder.from_config("resources/configs/config-test.yml")
-    end 
-    
-    it "should load the settings keys from file" do
-      @sprite.config.keys.size.should == 7
-    end
-
-    it "should load the image keys from file" do
-      @sprite.images.size.should == 2
-    end
-    
-    it "should expand any globs within the source paths" do
-      @sprite.images.first["sources"].size.should == 30
-    end
-    
-  end
-  
-  context "default settings" do
-    before(:all) do
-      @sprite = Sprite::Builder.new
-    end
-    
-    it "'style:' setting should default to 'css'" do
-      @sprite.config['style'].should == "css"
-    end
-
-    it "'output_path:' setting should default to 'public/stylesheets/sprites'" do
-      @sprite.config['output_path'].should == "public/stylesheets/sprites"
-    end
-
-    it "'image_output_path:' setting should default to 'public/images/sprites/'" do
-      @sprite.config['image_output_path'].should == "public/images/sprites/"
-    end
-
-    it "'source_path:' setting should default to 'public/images/'" do
-      @sprite.config['source_path'].should == "public/images/"
-    end
-
-    it "'default_format:' setting should default to 'png'" do
-      @sprite.config['default_format'].should == "png"
-    end
-
-    it "'sprites_class:' setting should default to 'sprites'" do
-      @sprite.config['sprites_class'].should == "sprites"
-    end
-
-    it "'class_separator:' setting should default to '-'" do
-      @sprite.config['class_separator'].should == "-"
-    end    
-  end
 
   context "generate android icon sprites" do
     before(:all) do

spec/sprite/config_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Sprite::Builder do
+
+  context "configuration parsing" do
+    before(:all) do
+      @sprite = Sprite::Builder.from_config("resources/configs/config-test.yml")
+    end 
+    
+    it "should load the settings keys from file" do
+      @sprite.config.keys.size.should == 8
+    end
+
+    it "should load the image keys from file" do
+      @sprite.images.size.should == 2
+    end
+    
+    it "should expand any globs within the source paths" do
+      @sprite.images.first["sources"].size.should == 30
+    end
+    
+  end
+  
+  context "default settings" do
+    before(:all) do
+      @sprite = Sprite::Builder.new
+    end
+    
+    it "'style:' setting should default to 'css'" do
+      @sprite.config['style'].should == "css"
+    end
+
+    it "'style_output_path:' setting should default to 'stylesheets/sprites'" do
+      @sprite.config['style_output_path'].should == "stylesheets/sprites"
+    end
+
+    it "'image_output_path:' setting should default to 'images/sprites/'" do
+      @sprite.config['image_output_path'].should == "images/sprites/"
+    end
+
+    it "'image_source_path:' setting should default to 'images/'" do
+      @sprite.config['image_source_path'].should == "images/"
+    end
+
+    it "'public_path:' setting should default to 'public/'" do
+      @sprite.config['public_path'].should == "public/"
+    end
+
+    it "'default_format:' setting should default to 'png'" do
+      @sprite.config['default_format'].should == "png"
+    end
+
+    it "'sprites_class:' setting should default to 'sprites'" do
+      @sprite.config['sprites_class'].should == "sprites"
+    end
+
+    it "'class_separator:' setting should default to '-'" do
+      @sprite.config['class_separator'].should == "-"
+    end    
+  end
+  
+end