sprite 0.1.7 → 0.2.0

data/lib/sprite/config.rb

@@ -0,0 +1,48 @@
+module Sprite
+  class Config
+    DEFAULT_CONFIG_PATH = 'config/sprite.yml'
+
+    def self.read_config(path = nil)
+      config_path = File.join(Sprite.root, path || DEFAULT_CONFIG_PATH)
+      
+      # read configuration
+      if File.exists?(config_path) 
+        begin
+          File.open(config_path) {|f| YAML::load(f)} || {}
+        rescue => e
+          puts "Error reading sprite config: #{config_path}"
+          puts e.to_s
+          {}
+        end
+      else
+        {}
+      end
+    end
+    
+    # chop off the trailing slash on a directory path (if it exists)
+    def self.chop_trailing_slash(path)
+      path = path[0...-1] if path[-1] == File::SEPARATOR
+      path
+    end
+    
+    # check if the path is set
+    def self.path_present?(path)
+      path.to_s.strip != ""
+    end
+    
+    def initialize(settings_hash)
+      @settings = settings_hash
+    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 << Config.chop_trailing_slash(@settings['public_path']) if Config.path_present?(@settings['public_path'])
+      path_parts << location
+      
+      File.join(*path_parts)
+    end    
+    
+  end
+end  

data/lib/sprite/image_combiner.rb

@@ -1,15 +1,25 @@
 module Sprite
   class ImageCombiner
-    def initialize
-      # avoid loading rmagick till the last possible moment
-      require 'rmagick'
+    def initialize(image_config)
+      begin
+        # avoid loading rmagick till the last possible moment
+        require "RMagick"
+      rescue LoadError
+        require 'rmagick'
+      end
+
+      @image_config = image_config
     end
-    
+
     def composite_images(dest_image, src_image, x, y)
       width = [src_image.columns + x, dest_image.columns].max
       height = [src_image.rows + y, dest_image.rows].max
       image = Magick::Image.new(width, height)
-      image.opacity = Magick::MaxRGB
+      if @image_config.background_color
+        image.opacity = 0
+      else
+        image.opacity = Magick::MaxRGB
+      end
 
       image.composite!(dest_image, 0, 0, Magick::OverCompositeOp)
       image.composite!(src_image, x, y, Magick::OverCompositeOp)
@@ -17,17 +27,14 @@ module Sprite
     end
 
     # Image Utility Methods
-    def get_image(image_filename)
-      image = Magick::Image::read(image_filename).first
-    end
 
     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
+end

data/lib/sprite/image_config.rb

@@ -0,0 +1,40 @@
+module Sprite
+  class ImageConfig
+    def initialize(image_info, global_config_info)
+      @image_info = image_info
+      @global_config_info = global_config_info
+    end
+
+    def sources
+      @image_info['sources'].to_a
+    end
+
+    def name
+      @image_info['name']
+    end
+
+    def format
+      @image_info['format'] || @global_config_info["default_format"]
+    end
+
+    def quality
+      @image_info['quality'] || @global_config_info["default_quality"]
+    end
+
+    def background_color
+      @image_info['background_color'] || @global_config_info["default_background_color"]
+    end
+
+    def spaced_by
+      @image_info['spaced_by'] || @global_config_info["default_spacing"] || 0
+    end
+
+    def resize_to
+      @image_info['resize_to'] || @global_config_info['resize_to']
+    end
+
+    def horizontal_layout?
+      @image_info['align'].to_s == 'horizontal'
+    end
+  end
+end

data/lib/sprite/image_reader.rb

@@ -0,0 +1,14 @@
+module Sprite
+  class ImageReader
+    def self.read(image_filename)
+      # avoid loading rmagick till the last possible moment
+      begin
+        require "RMagick"
+      rescue LoadError
+        require 'rmagick'
+      end
+
+      Magick::Image::read(image_filename).first
+    end
+  end
+end

data/lib/sprite/image_resizer.rb

@@ -0,0 +1,19 @@
+module Sprite
+  class ImageResizer
+    def initialize(resize_to)
+      if resize_to
+        @resizing = true
+        @target_width, @target_height = *(resize_to.split('x').map(&:to_i))
+      end
+    end
+    
+    def resize(image)
+      if @resizing
+        needs_resizing = image.columns != @target_width || image.rows != @target_height
+        if needs_resizing
+          image.scale!(@target_width, @target_height)
+        end
+      end
+    end
+  end
+end

data/lib/sprite/image_writer.rb

@@ -0,0 +1,29 @@
+module Sprite
+  class ImageWriter
+    def initialize(config)
+      @config = config
+    end
+    
+    def write(image, name, format, quality = nil, background_color = nil)
+      # set up path
+      path = image_output_path(name, format)
+      FileUtils.mkdir_p(File.dirname(path))
+      
+      # write sprite image file to disk
+      image.write(path) {
+        self.quality = quality unless quality.nil?
+        self.background_color = background_color unless background_color.nil?
+      }
+    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 << Config.chop_trailing_slash(@config['image_output_path']) if Config.path_present?(@config['image_output_path'])
+
+      cache_buster = "-#{@config['cache_buster']}" if @config['cache_buster']
+      path_parts << "#{name}#{cache_buster}.#{format}"
+      Config.new(@config).public_path(File.join(*path_parts), relative)
+    end
+  end
+end

data/lib/sprite/runner.rb

@@ -1,18 +1,20 @@
 module Sprite
   class Runner
-    
+
     attr_accessor :options
     def initialize(args)
       self.options = set_options(args)
     end
-    
+
     def set_options(args)
       opts = {}
       # TODO
       # edit options with passed in args
+      opts[:path] = args.first if args.any?
+
       opts
     end
-    
+
     # run sprite creator
     def run!
       begin
@@ -25,6 +27,6 @@ module Sprite
       end
       0
     end
-    
+
   end
 end

data/lib/sprite/sass_extensions.rb

@@ -1,57 +1,102 @@
-module Sprite::Sass::Extensions
-  def sprite_background(group, image)
-    sprite = sprite_data(group, image)
-    if sprite
-      "url('#{sprite[:img]}') no-repeat #{sprite[:x]}px #{sprite[:y]}px"
-    else
-      ""
-    end
-  end
+module Sprite
+  module Sass
+    module Extensions
+      def sprite_background(group, image)
+        sprite = sprite_data(group, image)
+        if sprite
+          sprite_path = sprite_builder.image_path(group.value)
+          ::Sass::Script::String.new "url('#{sprite_path}') no-repeat #{sprite[:x]}px #{sprite[:y]}px"
+        else
+          ::Sass::Script::String.new ""
+        end
+      end
 
-  def sprite_width(group, image)
-    sprite = sprite_data(group, image)
-    if sprite
-      "#{sprite[:width]}px"
-    else
-      ""
-    end
-  end
-  
-  def sprite_height(group, image)
-    sprite = sprite_data(group, image)
-    if sprite
-      "#{sprite[:height]}px"
-    else
-      ""
-    end
-  end
-  
-  protected
-  def sprite_data(group, image)
-    unless @__sprite_data
-      
-      # TODO: read template from !sprite_data
-      sprite_data_path = "public/sass/sprites.yml"
-      
-      # figure out the site root
-      root = "./"
-      
-      # read sprite data from yml
-      @__sprite_data = File.open(File.join(root, sprite_data_path)) { |yf| YAML::load( yf ) }
-    end
-    
-    group_data = @__sprite_data[group.to_s]
-    if group_data
-      return group_data[image.to_s]
-    else
-      nil
+      def sprite_width(*args)
+        ::Sass::Script::String.new sprite_attr(:width, *args)
+      end
+
+      def sprite_height(*args)
+        ::Sass::Script::String.new sprite_attr(:height, *args)
+      end
+
+      def sprite_x_offset(*args)
+        ::Sass::Script::String.new sprite_attr(:x, *args)
+      end
+
+      def sprite_y_offset(*args)
+        ::Sass::Script::String.new sprite_attr(:y, *args)
+      end
+
+      def sprite_image(group)
+        ::Sass::Script::String.new sprite_builder.image_path(group.value)
+      end
+
+      def sprite_url(group)
+        ::Sass::Script::String.new "url('#{sprite_image(group)}')"
+      end
+
+      ##
+      # Return a sprite offset for the given image.  When the optional x and y values are passed,
+      # numeric values are treated as additional offsets to the sprite image offset.  Any string
+      # values are treated as replacement offsets.
+      #
+      # Examples:
+      # * sprite_offset("common", "icon", "100%", 5) => offset is "100% x+5" where x is the x offset in the sprite
+      # * sprite_offset("common", "icon", "top", "right") => offset is "top right"
+      def sprite_offset(group, image, x=nil, y=nil)
+        xoff = compute_offset(group, image, :x, x)
+        yoff = compute_offset(group, image, :y, y)
+        ::Sass::Script::String.new "#{xoff} #{yoff}"
+      end
+
+    protected
+      def compute_offset(group, image, axis, offset)
+        if offset
+          val = offset.value
+          if val.is_a? Fixnum
+            (sprite_attr(axis, group, image).to_i + val).to_s + 'px'
+          else
+            val
+          end
+        else
+          sprite_attr(axis, group, image)
+        end
+      end
+
+      def sprite_attr(attr, group, image)
+        sprite = sprite_data(group, image)
+        if sprite
+          "#{sprite[attr]}px"
+        else
+          ""
+        end
+      end
+
+      def sprite_builder
+        @__sprite_builder ||= Builder.from_config
+      end
+
+      def sprite_data(group, image)
+        unless @__sprite_data
+          sprite_data_path = sprite_builder.style_output_path
+
+          # read sprite data from yml
+          @__sprite_data = File.open(sprite_data_path) { |yf| YAML::load( yf ) }
+        end
+
+        group_data = @__sprite_data[group.value]
+        if group_data
+          return group_data[image.value]
+        else
+          nil
+        end
+      end
     end
   end
-  
 end
 
 if defined?(Sass)
   module Sass::Script::Functions
     include Sprite::Sass::Extensions
   end
-end
+end

data/lib/sprite/styles.rb

@@ -2,15 +2,17 @@ require 'sprite/styles/sass_generator'
 require 'sprite/styles/css_generator'
 require 'sprite/styles/sass_yml_generator'
 require 'sprite/styles/sass_mixin_generator'
+require 'sprite/styles/templated_css_generator'
 
 module Sprite::Styles
   GENERATORS = {
     "css" => "CssGenerator",
+    "templated_css" => "TemplatedCssGenerator",
     "sass" => "SassGenerator",
     "sass_mixin" => "SassMixinGenerator",
     "sass_yml" => "SassYmlGenerator"
   }
-  
+
   def self.get(config)
     const_get(GENERATORS[config])
   rescue

data/lib/sprite/styles/css_generator.rb

@@ -5,26 +5,30 @@ module Sprite
       def initialize(builder)
         @builder = builder
       end
-  
+
       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 styles to disk
         File.open(File.join(Sprite.root, 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('/#{@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
+          write_standard_css(f, sprite_files)
+        end
+      end
+
+      def write_standard_css(f, sprite_files)
+        # set up class_name to append to each rule
+        sprites_class = @builder.config['sprites_class'] ? ".#{@builder.config['sprites_class']}" : ""
+
+        sprite_files.each do |sprite_file, sprites|
+          background_url = @builder.background_url(sprite_file)
+          sprites.each do |sprite|
+            f.puts "#{sprites_class}.#{sprite[:group]}#{@builder.config['class_separator']}#{sprite[:name]} {"
+            f.puts "  background: #{background_url} 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
       end
-  
+
       def extension
         "css"
       end