Updating Default Settings for Sprite::Builder

Author: merbjedi

README.md

@@ -88,8 +88,8 @@ 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. the file extension not needed as it will be determined by the style setting above (defaults to `public/stylesheets/sprite`)
-  - `image_output_path:` defines the folder path where the combined sprite images files are written (defaults to `public/images/sprite/`)
+  - `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/`)
   - `default_format:` defines the default file image format of the generated files. (defaults to `png`)
   - `class_separator:` used within the generated class names between the image name and sprite name (defaults to `_`)

lib/sprite/builder.rb

@@ -6,15 +6,21 @@ class Builder
 
     attr_reader :config
     attr_reader :images
+    attr_reader :output
+    
+    def self.from_config(path)
+      results = read_config(path)
+      new(results["config"], results["images"])
+    end
 
     def initialize(config = nil, images = nil)
-      results = config_results
+      results = self.class.read_config unless config.is_a?(Hash) and images.is_a?(Array)
 
       # use the override
       if config.is_a?(Hash)
         @config = config
       else
-        @config = config["config"] || {}
+        @config = results["config"] || {}
       end
 
       # set defaults
@@ -24,30 +30,32 @@ def initialize(config = nil, images = nil)
       if images.is_a?(Array)
         @images = images
       else
-        @images = config["images"] || []
+        @images = results["images"] || []
       end
 
-      # process images
-      process_image_settings
+      expand_image_paths
+      
+      # initialize output
+      @output = {}
     end
 
-    def build
+    def build    
       @output = {}
-    
+
       # build up config
-      @image_path = sprite_config['config']['base_image_path'] ? Sprite.root+"/"+sprite_config['config']['base_image_path']+"/" : DEFAULT_IMAGE_PATH
-      @file_path = sprite_config['config']['output_file'] ? Sprite.root+"/"+sprite_config['config']['output_file'] : DEFAULT_FILE_PATH
+      # @image_path = sprite_config['base_image_path'] ? Sprite.root+"/"+sprite_config['config']['base_image_path']+"/" : DEFAULT_IMAGE_PATH
+      # @file_path = sprite_config['config']['output_file'] ? Sprite.root+"/"+sprite_config['config']['output_file'] : DEFAULT_FILE_PATH
 
       # create images
-      sprite_config['images'].each do |configuration|
-        output_image(configuration)
+      images.each do |image|
+        output_image(image)
       end
 
       # write css
-      output_css(sprite_config)
+      output_file
     end
 
-    def output_image(configuration)
+    def output_image(image)
       results = []
       sources = configuration['sources'].to_a
 
@@ -91,7 +99,7 @@ def output_file(configuration)
     protected
 
     # reads config config from the given path
-    def read_config(path = nil)
+    def self.read_config(path = nil)
       config_results = {}
       config_path = File.join(Sprite.root, path || DEFAULT_CONFIG_PATH)
       begin
@@ -105,34 +113,29 @@ def read_config(path = nil)
 
     # sets all the default values on the config
     def set_config_defaults
-      @config['style']             ||= ''
-      @config['output_path']       ||= 'public/sass/mixins/sprites'
-      @config['image_output_path'] ||= 'public/images/sprite/'
-      @config['source_path']       ||= ''
+      @config['style']             ||= 'css'
+      @config['output_path']       ||= 'public/stylesheets/sprites'
+      @config['image_output_path'] ||= 'public/images/sprites/'
+      @config['source_path']       ||= 'public/images/'
       @config['default_format']    ||= 'png'
       @config['class_separator']   ||= '_'
     end
 
     # expands out sources
-    def process_image_config
+    def expand_image_paths
       # cycle through image sources and expand out globs
       @images.each do |image|
-        # find all the files
-        image['sources'] = image['sources'].to_a.map do |source|
+
+        # expand out all the globs
+        image['sources'] = image['sources'].to_a.map{ |source|
           Dir.glob(File.join(Sprite.root, @config['source_path'], source))
-        end
+        }.flatten.compact
 
-        # remove the prefix on them
-        new_sources = new_sources.flatten.map do |source|
+        # remove the prefixes on them
+        image['sources'].each do |source|
           source.gsub!(Sprite.root, "")
         end
-        
-        image_config['sources'] = new_sources
       end
-      
-    rescue => e
-      puts "Invalid sprite configuration syntax:"
-      puts e.to_s
     end
 
   end

spec/sprite/builder_spec.rb

@@ -2,18 +2,46 @@
 
 describe Sprite::Builder do
 
-  context "Configuration Parsing" do
+  context "configuration parsing" do
     before(:all) do
-      @sprite = Sprite::Builder.new("resources/configs/full_config.yml")
+      @sprite = Sprite::Builder.from_config("resources/configs/full_config.yml")
     end
 
     it "should load the settings keys from file" do
-      @sprite.config.keys.size.should == 2
+      @sprite.config.keys.size.should == 6
+    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
 
-    it "should glob the files together" do
-      @sprite.config["images"].first["sources"].size.should == 30
+  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
+        
 
   end