sprite 0.1.7 → 0.2.0

data/lib/sprite/styles/sass_generator.rb

@@ -15,12 +15,13 @@ module Sprite
             f.puts ".#{@builder.config['sprites_class']}"
             @level += 1
           end
-          
+
           sprite_files.each do |sprite_file, sprites|
+            background_url = @builder.background_url(sprite_file)
             sprites.each do |sprite|
               f.puts sass_line("&.#{sprite[:group]}#{@builder.config['class_separator']}#{sprite[:name]}")
               @level += 1
-              f.puts sass_line("background: url('/#{@builder.config['image_output_path']}#{sprite_file}') no-repeat #{sprite[:x]}px #{sprite[:y]}px")
+              f.puts sass_line("background: #{background_url} 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("")
@@ -29,12 +30,12 @@ module Sprite
           end
         end
       end
-      
+
       # write sass output with correct tab spaces prepended
       def sass_line(sass)
         "#{'  '*@level}#{sass}"
       end
-  
+
       def extension
         "sass"
       end

data/lib/sprite/styles/sass_mixin_generator.rb

@@ -5,31 +5,31 @@ module Sprite
       def initialize(builder)
         @builder = builder
       end
-      
-      def write(path, sprite_files)    
+
+      def write(path, sprite_files)
         # write the sass mixins to disk
         File.open(File.join(Sprite.root, path), 'w') do |f|
           add_else = false
 
           f.puts "= sprite(!group_name, !image_name, !offset=0)"
           sprite_files.each do |sprite_file, sprites|
+            background_url = @builder.background_url(sprite_file)
             sprites.each do |sprite|
-              
               f << "  @"
               if add_else
                 f << "else "
               end
               add_else = true
               #{sprite[:x]}px #{sprite[:y]}px
-              
+
               if sprite[:align] == 'horizontal'
                 background_offset = "\#{#{sprite[:x]}+!offset}px #{sprite[:y]}px"
               else
                 background_offset = "#{sprite[:x]}px \#{#{sprite[:y]}+!offset}px"
               end
-              
+
               f.puts %{if !group_name == "#{sprite[:group]}" and !image_name == "#{sprite[:name]}"}
-              f.puts "    background: url('/#{@builder.config['image_output_path']}#{sprite_file}') no-repeat #{background_offset}"
+              f.puts "    background: #{background_url} repeat #{background_offset}"
               f.puts "    width: #{sprite[:width]}px"
               f.puts "    height: #{sprite[:height]}px"
             end
@@ -40,7 +40,7 @@ module Sprite
       def extension
         "sass"
       end
-  
+
     end
   end
 end

data/lib/sprite/styles/sass_yml_generator.rb

@@ -6,14 +6,17 @@ module Sprite
       def initialize(builder)
         @builder = builder
       end
-      
-      def write(path, sprite_files)        
+
+      def write(path, sprite_files)
         # build the yml file
-        config_location = write_config(path, sprite_files)
-        
+        write_config(path, sprite_files)
+
+        # Where to put the sass mixin file
+        sass_path = path.gsub(".yml", ".sass")
+
         # write the sass mixins to disk
-        File.open(File.join(Sprite.root, path), 'w') do |f|
-          f.puts "!sprite_data = '#{config_location}'"
+        File.open(File.join(Sprite.root, sass_path), 'w') do |f|
+          f.puts "!sprite_data = '#{path}'"
           f.puts ""
           f.puts "= sprite(!group_name, !image_name)"
           f.puts "  background= sprite_background(!group_name, !image_name)"
@@ -22,7 +25,7 @@ module Sprite
           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
@@ -35,20 +38,16 @@ module Sprite
             end
           end
         end
-        
+
         # write the config yml to disk
-        config_path = path.gsub(".sass", ".yml")
-        File.open(File.join(Sprite.root, config_path), 'w') do |f|
+        File.open(File.join(Sprite.root, path), 'w') do |f|
           YAML.dump(result, f)
         end
-        
-        config_path
       end
-      
+
       def extension
-        "sass"
+        "yml"
       end
-  
     end
   end
-end
+end

data/lib/sprite/styles/templated_css_generator.rb

@@ -0,0 +1,41 @@
+require 'erb'
+
+module Sprite
+  module Styles
+    # renders css rules from template
+    class TemplatedCssGenerator
+      def initialize(builder)
+        @builder = builder
+      end
+
+      def write(path, sprite_files)
+        # write styles to disk
+        File.open(File.join(Sprite.root, path), 'w') do |f|
+          f.puts "/* Generated by the sprite gem */"
+          sprite_files.each do |sprite_file|
+            @builder.images.each do |image|
+              if "#{image['name']}.#{image['format']}" == sprite_file[0]
+                erb_path = @builder.send :style_template_source_path, image
+                erb_template = ERB.new(File.read(erb_path))
+                sprites = sprite_file[1]
+                sprites.each do |sprite|
+                  name = sprite[:name]
+                  width = sprite[:width]
+                  height = sprite[:height]
+                  left = sprite[:x]
+                  top = sprite[:y]
+                  image_path = ImageWriter.new(@builder.config).image_output_path(image['name'], image['format'])
+                  f.puts erb_template.result(binding)
+                end
+              end
+            end
+          end
+        end
+      end
+
+      def extension
+        "css"
+      end
+    end
+  end
+end

data/spec/output/android_horizontal/stylesheets/android-icons.css

@@ -0,0 +1 @@
+/* Generated by the sprite gem */

data/spec/output/android_vertical/stylesheets/android-icons.css

@@ -0,0 +1 @@
+/* Generated by the sprite gem */

data/spec/resources/android_css.erb

@@ -0,0 +1,5 @@
+.sprite_<%= name %> {
+  background: url('<%= image_path %>') no-repeat <%= left %>px <%= top %>px;
+  width: <%= width %>px;
+  height: <%= height %>px;
+}

data/spec/resources/configs/android-icons.yml

@@ -0,0 +1,19 @@
+config:
+  style: templated_css
+  style_output_path: output/stylesheets/android-icons
+  image_output_path: output/images/sprites/
+  image_source_path: resources/images/
+  public_path: ''
+  class_separator: '-'
+  default_format: png
+
+# defines what sprite collections get created
+images:    
+  - name: android-icons
+    format: png
+    style_output_template: resources/android_css.erb
+    align: vertical
+    spaced_by: 50
+    resize_to: 48x48
+    sources:
+      - android-icons/*.png

data/spec/resources/configs/config-test.yml

@@ -0,0 +1,26 @@
+config:
+  style: css
+  style_output_path: output/stylesheets/sprites
+  image_output_path: output/images/sprites/
+  image_source_path: resources/images/
+  css_image_path: ../images/sprites
+  public_path: ""
+  class_separator: '-'
+  default_format: png
+
+# defines what sprite collections get created
+images:
+  - name: android-icons
+    format: png
+    align: vertical
+    spaced_by: 50
+    sources:
+      - android-icons/*.png
+
+  - name: topics
+    format: gif
+    align: vertical
+    spaced_by: 50
+    sources:
+      - topics/good-topic.gif
+      - topics/mid-topic.gif

data/spec/resources/images/android-icons/LICENSE

@@ -0,0 +1 @@
+This work is licensed under the Creative Commons Attribution 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA.

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "/../lib"))
+require 'sprite'
+require 'bundler/setup'
+
+require 'date'
+require 'fileutils'
+
+# set Sprite.root to be this spec/ folder
+Sprite.module_eval{ @root = File.dirname(__FILE__) }
+
+FileUtils.rm_rf("#{Sprite.root}/output")
+
+RSpec.configure do |c|
+
+  module SpriteSpecHelpers
+    def clear_output
+      FileUtils.rm_rf("#{Sprite.root}/output")
+    end
+  end
+
+  c.include(SpriteSpecHelpers)
+
+  # setup fixtures path
+  c.before(:all) do
+  end
+
+  # returns the file path of a fixture setting file
+  def config_path(filename)
+    @fixture_path.join(filename)
+  end
+
+end

data/spec/sprite/builder_spec.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Sprite::Builder do
+  
+  context "should generate vertical android icon sprites" do
+    before(:all) do
+      @sprite = Sprite::Builder.from_config("resources/configs/android-icons.yml")
+      @sprite.config["style_output_path"] = "output/android_vertical/stylesheets/android-icons"
+      @sprite.config["image_output_path"] = "output/android_vertical/images/sprites/"
+      @sprite.images.first["align"] = "vertical"
+      @sprite.build
+      
+      @output_path = "#{Sprite.root}/output/android_vertical"
+    end
+    
+    context "and the sprite result image" do
+      before(:all) do
+        combiner = Sprite::ImageCombiner.new(mock())
+        @result_image = Sprite::ImageReader.read("#{@output_path}/images/sprites/android-icons.png")
+        @result_properties = combiner.image_properties(@result_image)
+      end
+      
+      it "should be 48x2890" do
+        "#{@result_properties[:width]}x#{@result_properties[:height]}".should == "48x2890"
+      end
+    end
+    
+    context "and the sprite result styles" do
+      before(:all) do
+        @styles = File.read("#{@output_path}/stylesheets/android-icons.css")
+      end
+      
+      it "should have some styles in it" do
+        @styles.should_not be_nil
+        @styles.strip.should_not == ""
+      end
+    end
+  end
+
+  context "should generate horizontal android icon sprites" do
+    before(:all) do
+      @sprite = Sprite::Builder.from_config("resources/configs/android-icons.yml")
+      @sprite.config["style_output_path"] = "output/android_horizontal/stylesheets/android-icons"
+      @sprite.config["image_output_path"] = "output/android_horizontal/images/sprites/"
+      @sprite.images.first["align"] = "horizontal"
+      @sprite.build
+      
+      @output_path = "#{Sprite.root}/output/android_horizontal"
+    end
+    
+    context "and the sprite result image" do
+      before(:all) do
+        combiner = Sprite::ImageCombiner.new(@sprite.config)
+        @result_image = Sprite::ImageReader.read("#{@output_path}/images/sprites/android-icons.png")
+        @result_properties = combiner.image_properties(@result_image)
+      end
+      
+      it "should be 2890x48" do
+        "#{@result_properties[:width]}x#{@result_properties[:height]}".should == "2890x48"
+      end
+    end
+    
+    context "and sprite result styles" do
+      before(:all) do
+        @styles = File.read("#{@output_path}/stylesheets/android-icons.css")
+      end
+      
+      it "should have some styles in it" do
+        @styles.should_not be_nil
+        @styles.strip.should_not == ""
+      end
+    end
+  end
+
+
+end

data/spec/sprite/config_spec.rb

@@ -0,0 +1,64 @@
+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 "loads the image keys from file" do
+      @sprite.images.size.should == 2
+    end
+
+    it "expands any globs within the source paths" do
+      @sprite.images.first["sources"].size.should == 30
+    end
+
+    it "allows override of css_image_path value" do
+      @sprite.config['css_image_path'].should == '../images/sprites'
+    end
+  end
+
+  context "default settings" do
+    before(:all) do
+      @sprite = Sprite::Builder.new
+    end
+
+    it "'style:' setting defaults to 'css'" do
+      @sprite.config['style'].should == "css"
+    end
+
+    it "'style_output_path:' setting defaults to 'stylesheets/sprites'" do
+      @sprite.config['style_output_path'].should == "stylesheets/sprites"
+    end
+
+    it "'image_output_path:' setting defaults to 'images/sprites/'" do
+      @sprite.config['image_output_path'].should == "images/sprites/"
+    end
+
+    it "'css_image_path:' setting defaults to '/images/sprites/'" do
+      @sprite.config['css_image_path'].should == "/images/sprites/"
+    end
+
+    it "'image_source_path:' setting defaults to 'images/'" do
+      @sprite.config['image_source_path'].should == "images/"
+    end
+
+    it "'public_path:' setting defaults to 'public/'" do
+      @sprite.config['public_path'].should == "public/"
+    end
+
+    it "'default_format:' setting defaults to 'png'" do
+      @sprite.config['default_format'].should == "png"
+    end
+
+    it "'sprites_class:' setting defaults to 'sprites'" do
+      @sprite.config['sprites_class'].should == "sprites"
+    end
+
+    it "'class_separator:' setting defaults to '-'" do
+      @sprite.config['class_separator'].should == "-"
+    end
+  end
+end