RubyGems - amikula-sprite - Versions diffs - 0.1.8 - Mend

amikula-sprite 0.1.8

Files changed (24) hide show

data/MIT-LICENSE +20 -0
data/README.md +193 -0
data/Rakefile +38 -0
data/VERSION +1 -0
data/bin/sprite +8 -0
data/lib/sprite.rb +28 -0
data/lib/sprite/builder.rb +185 -0
data/lib/sprite/config.rb +48 -0
data/lib/sprite/image_combiner.rb +35 -0
data/lib/sprite/image_config.rb +40 -0
data/lib/sprite/image_reader.rb +10 -0
data/lib/sprite/image_resizer.rb +19 -0
data/lib/sprite/image_writer.rb +27 -0
data/lib/sprite/runner.rb +32 -0
data/lib/sprite/sass_extensions.rb +81 -0
data/lib/sprite/styles.rb +22 -0
data/lib/sprite/styles/css_generator.rb +36 -0
data/lib/sprite/styles/sass_generator.rb +43 -0
data/lib/sprite/styles/sass_mixin_generator.rb +46 -0
data/lib/sprite/styles/sass_yml_generator.rb +53 -0
data/lib/sprite/styles/templated_css_generator.rb +41 -0
data/rails/init.rb +2 -0
data/tasks/sprite_tasks.rake +13 -0
metadata +78 -0

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [Richard Huang (flyerhzm@gmail.com)]
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md ADDED Viewed

@@ -0,0 +1,193 @@
+# sprite #
+`sprite` is a gem that helps generate css sprite images automagically. It's aim is to support all web frameworks (Merb/Rails/Sinatra), and have extensible output generator. By default, it supports CSS and SASS output (via mixins).
+## INSTALL  ##
+### Install the `rmagick` gem ###
+`sprite` currently requires the rmagick gem. to install it, use
+    gem install rmagick
+if you have any problems with the rmagick gem, install imagemagick via macports first:
+    sudo port install libxml2
+    sudo port install ImageMagick
+or via installer: http://github.com/maddox/magick-installer/tree/master
+### Install the `sprite` gem ###
+Install the `sprite` gem from gemcutter
+    gem sources -a http://gemcutter.org
+    gem install sprite
+## USAGE ##
+if installed as a gem, at your root project folder you can just run
+    sprite
+### Intelligent Defaults ###
+Without having to configure anything, `sprite` will allow you to easily generate sprites based on a couple default folder settings we give you right off the bat.
+For example, given you have the following setup:
+    public/
+      images/
+        sprites/
+          black-icons/
+            stop.png
+            go.png
+            back.png
+            forward.png
+          weather/
+            sunny.gif
+            rainy.gif
+            cloudy.gif
+Running `sprite` with no configuration file will generate the following new files:
+    public/
+      stylesheets/
+        sprites.css
+      images/
+        sprites/
+          black-icons.png
+          weather.png
+Any folders within `public/images/sprites/` will get compressed into a merged image file at the same
+location. Then `sprites.css` will get generated in the stylesheets folder with all the class definitions for
+these files. Just add a link to `sprites.css` into your html <head> and you're ready to go!
+## CONFIGURATION ##
+Configuration of `sprite` is done via `config/sprite.yml`. It allows you to set sprite configuration options, and fine tune exactly which sprites get generated where.
+* `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`)
+  - `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/`)
+  - `css_image_path:` defines the path used in css to find sprite image files (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`)
+  - `default_spacing:` defines the default pixel spacing between sprites (defaults to 0)
+  - `resize_to:` width and height (in the format "120x60") to resize all source images to before composition. (defaults to no nil, or no resizing)
+  - `class_separator:` used to generated the class name by separating the image name and sprite name (defaults to `-`)
+  - `add_datestamps`: whether or not to add datestamps to the generated background image urls. this will allow proper cache versioning (defaults to `true`)
+* `images:` section provides an array of configurations which define which image files are built, and where they get their sprites from. each image setup provides the following config options:
+  - `name:` name of image (required)
+  - `sources:` defines a list of source image filenames to build the target image from (required). They are parsed by <code>Dir.glob</code>
+  - `align:` defines the composite gravity type, horizontal or vertical. (defaults to `vertical`)
+  - `spaced_by:` spacing (in pixels) between the combined images. (defaults to `0`)
+  - `resize_to:` width and height (in the format "120x60") to resize all source images to before composition. (defaults to no nil, or no resizing)
+  - `format:` define what image file format gets created (optional, uses `default_format` setting if not set)
+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
+      style_output_path: stylesheets/sprites
+      image_output_path: images/sprites/
+      image_source_path: images/
+      public_path: public/
+      sprites_class: 'sprites'
+      class_separator: '-'
+      default_format: png
+      default_spacing: 50
+    # defines what sprite collections get created
+    images:
+      # creates a public/images/sprites/blue_stars.png image with 4 sprites in it
+      - name: blue_stars
+        format: png
+        align: horizontal
+        spaced_by: 50
+        sources:
+          - icons/blue-stars/small.png
+          - icons/blue-stars/medium.png
+          - icons/blue-stars/large.png
+          - icons/blue-stars/xlarge.png
+      # creates a public/images/sprites/green-stars.jpg image with
+      # all the gif files contained within /images/icons/green-stars/
+      - name: green_stars
+        format: png
+        align: vertical
+        spaced_by: 50
+        sources:
+          - icons/green-stars/*.gif
+### Style Settings ###
+By default, it will use with `style: css` and generate the file at `public/stylesheets/sprites.css`
+    .sprites.blue-stars-small {
+      background: url('/images/icons/blue-stars/small.png') no-repeat 0px 0px;
+      width: 12px;
+      height: 6px;
+    }
+    .sprites.blue-stars-medium {
+      background: url('/images/icons/blue-stars/medium.png') no-repeat 0px 6px;
+      width: 30px;
+      height: 15px;
+    }
+    .sprites.blue-stars-large {
+      background: url('/images/icons/blue-stars/large.png') no-repeat 0px 21px;
+      width: 60px;
+      height: 30px;
+    }
+    .sprites.blue-stars-xlarge {
+      background: url('/images/icons/blue-stars/xlarge.png') no-repeat 0px 96px;
+      width: 100px;
+      height: 75px;
+    }
+We also support mixin syntax via `style: sass_mixin`. If set, it will generate a SASS mixin which you can use in order to mix in these sprites anywhere within your SASS stylesheets. For this option, set `style_output_path:` to `stylesheets/sass/_sprites` in order to generate the sass mixin file at `stylesheets/sass/_sprites.sass`
+    @import "sass/mixins/sprites.sass"
+    // you can then use your sprite like this
+    .largebluestar
+      +sprite("blue-stars", "large")
+    .mysmallbluestar
+      +sprite("blue-stars", "small")
+Additional style generators are very easy to add. We have one for `style: sass` and `style: sass_ext`. The `sass_ext` style is a work in progress, as it's attempting to write the sprite data to yml and use a dynamic sass extension to provide the mixin. Eventually, if it works, this will be the default for `sass_mixin`
+## Framework Integration?? ##
+`sprite` is provided as a command line helper. Deep web framework integration is not implemented at this time, however it shouldn't be needed. Just generate your sprites on your dev machine by running the command line, check in the resulting sprite images and stylesheets to your source control, and deploy!
+You can also easily script it out via capistrano. You could also run `sprite` on application start, or just about anywhere. Let me know what limitations you run into.
+## ABOUT `sprite` ##
+`sprite` was originally based off of Richard Huang's excellent Rails plugin: [css_sprite](http://github.com/flyerhzm/css_sprite)
+Since then it's been rebuilt (with some reuse of the image generation code) to be a general purpose ruby executable, with hooks for merb/rails/sinatra
+## LICENSE  ##
+Released under the MIT License
+## COPYRIGHT ##
+Copyright (c) 2009 Gist
+Original Codebase Copyright (c) 2009 [Richard Huang]

data/Rakefile ADDED Viewed

@@ -0,0 +1,38 @@
+require 'rake'
+require 'spec/rake/spectask'
+require 'jeweler'
+desc 'Default: run unit tests.'
+task :default => :spec
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ["--exclude spec/*,gems/*,lib/tasks/*,app/analytics/application_metrics.rb"]
+  end
+end
+Jeweler::Tasks.new do |gemspec|
+  gemspec.name = "amikula-sprite"
+  gemspec.summary = "generate your css sprites automagically"
+  gemspec.description = "sprite is a rails/merb plugin that generates sprites for css, sass"
+  gemspec.email = "amikula@gmail.com"
+  gemspec.homepage = "http://github.com/amikula/sprite"
+  gemspec.authors = ["Jacques Crocker", "Alf Mikula"]
+  gemspec.files.exclude '.gitignore'
+  # removing test files and specs from the gem to save space
+  gemspec.files -= Dir.glob("spec/**/*")
+  gemspec.test_files = []
+end
+Jeweler::GemcutterTasks.new

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 0.1.8

data/bin/sprite ADDED Viewed

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# The compass command line utility
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'sprite'))
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'sprite', 'runner'))
+command = Sprite::Runner.new(ARGV)
+exit command.run!

data/lib/sprite.rb ADDED Viewed

@@ -0,0 +1,28 @@
+module Sprite
+  # provides the root directory to use when reading and writing files
+  def self.root
+    @root ||= nil
+    # set the root to the framework setting (if not already set)
+    @root ||= begin
+      if defined?(Rails)
+        Rails.root
+      elsif defined?(Merb)
+        Merb.root
+      else
+        "."
+      end
+    end
+    @root
+  end
+end
+require 'sprite/builder'
+require 'sprite/config'
+require 'sprite/image_combiner'
+require 'sprite/image_config'
+require 'sprite/image_reader'
+require 'sprite/image_resizer'
+require 'sprite/image_writer'
+require 'sprite/styles'

data/lib/sprite/builder.rb ADDED Viewed

@@ -0,0 +1,185 @@
+require 'fileutils'
+module Sprite
+  class Builder
+    attr_reader :config
+    attr_reader :images
+    def self.from_config(path = nil)
+      results = Config.read_config(path)
+      new(results["config"], results["images"])
+    end
+    def initialize(config = nil, images = nil)
+      @config = config || {}
+      set_config_defaults
+      @images = images || []
+      if @images.empty?
+        @images = default_images
+      end
+      expand_image_paths
+      # initialize datestamp
+      @datestamp_query = "?#{Time.now.to_i}" if @config["add_datestamps"]
+      # initialize sprite files
+      @sprite_files = {}
+    end
+    def build
+      @sprite_files = {}
+      if images.size > 0
+        # create images
+        images.each do |image|
+          write_image(image)
+        end
+        if @sprite_files.values.length > 0
+          # write css
+          write_styles
+        end
+      end
+    end
+    # get the disk path for the style output file
+    def style_output_path(relative = false)
+      style = Styles.get(config["style"]).new(self)
+      path = config['style_output_path']
+      unless path.include?(".#{style.extension}")
+        path = "#{path}.#{style.extension}"
+      end
+      Config.new(config).public_path(path, relative)
+    end
+    def image_path(group)
+      image_info = images.detect{|image| image['name'] == group}
+      image_config = ImageConfig.new(image_info, config)
+      sprite_file = "#{image_config.name}.#{image_config.format}"
+      "#{config['css_image_path']}#{sprite_file}"
+    end
+  protected
+    def write_image(image_info)
+      results = []
+      image_config = ImageConfig.new(image_info, config)
+      sources = image_config.sources
+      return unless sources.length > 0
+      name = image_config.name
+      resizer = ImageResizer.new(image_config.resize_to)
+      combiner = ImageCombiner.new(image_config)
+      # Let's get the sprite started with the first image
+      first_image = ImageReader.read(sources.shift)
+      resizer.resize(first_image)
+      dest_image = first_image
+      results << combiner.image_properties(dest_image).merge(:x => 0, :y => 0, :group => name)
+      # Now let's add the rest of the images in turn
+      sources.each do |source|
+        source_image = ImageReader.read(source)
+        resizer.resize(source_image)
+        if image_config.horizontal_layout?
+          x = dest_image.columns + image_config.spaced_by
+          y = 0
+          align = "horizontal"
+        else
+          x = 0
+          y = dest_image.rows + image_config.spaced_by
+          align = "vertical"
+        end
+        results << combiner.image_properties(source_image).merge(:x => -x, :y => -y, :group => name, :align => align)
+        dest_image = combiner.composite_images(dest_image, source_image, x, y)
+      end
+      ImageWriter.new(config).write(dest_image, name, image_config.format, image_config.quality, image_config.background_color)
+      @sprite_files["#{name}.#{image_config.format}#{@datestamp_query}"] = results
+    end
+    def write_styles
+      # use the absolute style output path to make sure we have the directory set up
+      path = style_output_path
+      FileUtils.mkdir_p(File.dirname(path))
+      # send the style the relative path
+      style.write(style_output_path(true), @sprite_files)
+    end
+    def style
+      @style ||= Styles.get(config["style"]).new(self)
+    end
+    # sets all the default values on the config
+    def set_config_defaults
+      @config['style']              ||= 'css'
+      @config['style_output_path']  ||= 'stylesheets/sprites'
+      @config['image_output_path']  ||= 'images/sprites/'
+      @config['css_image_path']     ||= "/#{@config['image_output_path']}"
+      @config['image_source_path']  ||= 'images/'
+      @config['public_path']        ||= 'public/'
+      @config['default_format']     ||= 'png'
+      @config['class_separator']    ||= '-'
+      @config["sprites_class"]      ||= 'sprites'
+      @config["default_spacing"]    ||= 0
+      unless @config.has_key?("add_datestamps")
+        @config["add_datestamps"] = true
+      end
+    end
+    # if no image configs are detected, set some intelligent defaults
+    def default_images
+      sprites_path = image_source_path("sprites")
+      collection = []
+      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
+          collection << {
+            "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
+      collection
+    end
+    # expands out sources, taking the Glob paths and turning them into separate entries in the array
+    def expand_image_paths
+      # cycle through image sources and expand out globs
+      @images.each do |image|
+        # expand out all the globs
+        image['sources'] = image['sources'].to_a.map{ |source|
+          Dir.glob(image_source_path(source))
+        }.flatten.compact
+      end
+    end
+    # get the disk path for an image source file
+    def image_source_path(location, relative = false)
+      path_parts = []
+      path_parts << Config.chop_trailing_slash(config["image_source_path"]) if Config.path_present?(config['image_source_path'])
+      path_parts << location
+      Config.new(config).public_path(File.join(*path_parts), relative)
+    end
+    def style_template_source_path(image, relative = false)
+      location = image["style_output_template"]
+      path_parts = []
+      path_parts << location
+      Config.new(config).public_path(File.join(*path_parts), relative)
+    end
+  end
+end

data/lib/sprite/config.rb ADDED Viewed

@@ -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 ADDED Viewed

@@ -0,0 +1,35 @@
+module Sprite
+  class ImageCombiner
+    def initialize(image_config)
+      # avoid loading rmagick till the last possible moment
+      require 'rmagick'
+      @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)
+      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)
+      image
+    end
+    # Image Utility Methods
+    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

data/lib/sprite/image_config.rb ADDED Viewed

@@ -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 ADDED Viewed

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

data/lib/sprite/image_resizer.rb ADDED Viewed

@@ -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 ADDED Viewed

@@ -0,0 +1,27 @@
+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'])
+      path_parts << "#{name}.#{format}"
+      Config.new(@config).public_path(File.join(*path_parts), relative)
+    end
+  end
+end

data/lib/sprite/runner.rb ADDED Viewed

@@ -0,0 +1,32 @@
+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
+        Sprite::Builder.from_config(options[:path]).build
+      # rescue Exception => e
+      #   # catch errors
+      #   puts "ERROR"
+      #   puts e
+      #   return 1
+      end
+      0
+    end
+  end
+end

data/lib/sprite/sass_extensions.rb ADDED Viewed

@@ -0,0 +1,81 @@
+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)
+          "url('#{sprite_path}') no-repeat #{sprite[:x]}px #{sprite[:y]}px"
+        else
+          ""
+        end
+      end
+      def sprite_width(*args)
+        sprite_attr(:width, *args)
+      end
+      def sprite_height(*args)
+        sprite_attr(:height, *args)
+      end
+      def sprite_x_offset(*args)
+        sprite_attr(:x, *args)
+      end
+      def sprite_y_offset(*args)
+        sprite_attr(:y, *args)
+      end
+      def sprite_image(group)
+        sprite_builder.image_path(group.value)
+      end
+      def sprite_url(group)
+        "url('#{sprite_image(group)}')"
+      end
+      def sprite_offset(group, image, x=nil, y=nil)
+        x ||= sprite_x_offset(group, image)
+        y ||= sprite_y_offset(group, image)
+        "#{x} #{y}"
+      end
+    protected
+      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.to_s]
+        if group_data
+          return group_data[image.to_s]
+        else
+          nil
+        end
+      end
+    end
+  end
+end
+if defined?(Sass)
+  module Sass::Script::Functions
+    include Sprite::Sass::Extensions
+  end
+end

data/lib/sprite/styles.rb ADDED Viewed

@@ -0,0 +1,22 @@
+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
+    CssGenerator
+  end
+end

data/lib/sprite/styles/css_generator.rb ADDED Viewed

@@ -0,0 +1,36 @@
+module Sprite
+  module Styles
+    # renders standard css style rules
+    class CssGenerator
+      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|
+          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|
+          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
+        end
+      end
+      def extension
+        "css"
+      end
+    end
+  end
+end

data/lib/sprite/styles/sass_generator.rb ADDED Viewed

@@ -0,0 +1,43 @@
+module Sprite
+  module Styles
+    # renders standard sass rules
+    class SassGenerator
+      def initialize(builder)
+        @builder = builder
+      end
+      def write(path, sprite_files)
+        @level = 0
+        File.open(File.join(Sprite.root, 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('/#{@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
+      end
+      # write sass output with correct tab spaces prepended
+      def sass_line(sass)
+        "#{'  '*@level}#{sass}"
+      end
+      def extension
+        "sass"
+      end
+    end
+  end
+end

data/lib/sprite/styles/sass_mixin_generator.rb ADDED Viewed

@@ -0,0 +1,46 @@
+module Sprite
+  module Styles
+    # 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 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|
+            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 "    width: #{sprite[:width]}px"
+              f.puts "    height: #{sprite[:height]}px"
+            end
+          end
+        end
+      end
+      def extension
+        "sass"
+      end
+    end
+  end
+end

data/lib/sprite/styles/sass_yml_generator.rb ADDED Viewed

@@ -0,0 +1,53 @@
+require 'yaml'
+module Sprite
+  module Styles
+    # renders a yml file that is later parsed by a sass extension when generating the mixins
+    class SassYmlGenerator
+      def initialize(builder)
+        @builder = builder
+      end
+      def write(path, sprite_files)
+        # build the yml file
+        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, 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)"
+          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
+        File.open(File.join(Sprite.root, path), 'w') do |f|
+          YAML.dump(result, f)
+        end
+      end
+      def extension
+        "yml"
+      end
+    end
+  end
+end

data/lib/sprite/styles/templated_css_generator.rb ADDED Viewed

@@ -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/rails/init.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ require 'sprite'
2	+

data/tasks/sprite_tasks.rake ADDED Viewed

@@ -0,0 +1,13 @@
+require File.join(File.dirname(__FILE__), '../lib/sprite/sprite.rb')
+namespace :sprite do
+  desc "build sprite images based on config/sprite.yml"
+  task :build do
+    Sprite.new.build
+  end
+  task :list => [:build] do
+    # TODO
+    # list all the currently configured sprites
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: amikula-sprite
+version: !ruby/object:Gem::Version
+  version: 0.1.8
+platform: ruby
+authors:
+- Jacques Crocker
+- Alf Mikula
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-03-14 00:00:00 -08:00
+default_executable: sprite
+dependencies: []
+description: sprite is a rails/merb plugin that generates sprites for css, sass
+email: amikula@gmail.com
+executables:
+- sprite
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/sprite
+- lib/sprite.rb
+- lib/sprite/builder.rb
+- lib/sprite/config.rb
+- lib/sprite/image_combiner.rb
+- lib/sprite/image_config.rb
+- lib/sprite/image_reader.rb
+- lib/sprite/image_resizer.rb
+- lib/sprite/image_writer.rb
+- lib/sprite/runner.rb
+- lib/sprite/sass_extensions.rb
+- lib/sprite/styles.rb
+- lib/sprite/styles/css_generator.rb
+- lib/sprite/styles/sass_generator.rb
+- lib/sprite/styles/sass_mixin_generator.rb
+- lib/sprite/styles/sass_yml_generator.rb
+- lib/sprite/styles/templated_css_generator.rb
+- rails/init.rb
+- tasks/sprite_tasks.rake
+has_rdoc: true
+homepage: http://github.com/amikula/sprite
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.5
+signing_key:
+specification_version: 3
+summary: generate your css sprites automagically
+test_files: []