sprite 0.1.2 → 0.1.3

data/README.md

@@ -24,31 +24,12 @@ Install the `sprite` gem from gemcutter
     gem sources -a http://gemcutter.org
     gem install sprite
 
-### if using Merb ###
-
-With Merb 1.1 and Bundler, just add the line `gem 'sprite'` your ./Gemfile and then run `gem bundle`
-
-### if using Rails ###
-
-add to environment.rb
-    
-    config.gem "sprite"
-
-or install as a plugin
-
-    script/plugin install git://github.com/gistinc/sprite.git
-
 ## USAGE ##
 
 if installed as a gem, at your root project folder you can just run 
   
     sprite
 
-if you would rather not install the gem, you can also use it with rake
-
-    rake sprite:build
-
-
 ### 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.
@@ -177,6 +158,13 @@ We also support mixin syntax via `style: sass_mixin`. If set, sprite will only g
 
     .mysmallbluestar
       +sprite("blue-stars", "small")
+      
+      
+## 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` ##
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/sprite/builder.rb

@@ -5,7 +5,6 @@ module Sprite
     
     attr_reader :config
     attr_reader :images
-    attr_reader :output
     
     def self.from_config(path = nil) 
       results = {}
@@ -32,37 +31,40 @@ module Sprite
       set_image_defaults
       expand_image_paths
       
-      # initialize output
-      @output = {}
+      # initialize sprite files
+      @sprite_files = {}
     end
   
     def build    
-      @output = {}
+      @sprite_files = {}
       
       if images.size > 0
         # create images
         images.each do |image|
-          output_image(image)
+          write_image(image)
         end
     
-        # write css
-        output_file
+        if @sprite_files.values.length > 0
+          # write css
+          write_styles
+        end
       end
     end
     
     protected
-    def output_image(image)
+    def write_image(image)
       results = []
       sources = image['sources'].to_a
       return unless sources.length > 0
       
       name = image['name']
+      format = image['format'] || config["default_format"]
       spaced_by = image['spaced_by'] || 0
       
       combiner = ImageCombiner.new
       
       dest_image = combiner.get_image(sources.shift)
-      results << combiner.image_properties(dest_image).merge(:x => 0, :y => 0)
+      results << combiner.image_properties(dest_image).merge(:x => 0, :y => 0, :group => name)
       sources.each do |source|
         source_image = combiner.get_image(source)
         if image['align'].to_s == 'horizontal'
@@ -77,75 +79,31 @@ module Sprite
       end
       
       # set up path
-      path = image_output_path(name, image['format'] || config["default_format"])
+      path = image_output_path(name, 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 = style_output_path("css")
-      FileUtils.mkdir_p(File.dirname(path))
-      
-      # set up class_name to append to each rule
-      sprites_class = config['sprites_class'] ? ".#{config['sprites_class']}" : ""
-      
-      # write stylesheet file to disk
-      File.open(path, 'w') do |f|
-        @output.each do |dest, results|
-          results.each do |result|
-            f.puts "#{sprites_class}.#{result[:group]}#{config['class_separator']}#{result[:name]} {"
-            f.puts "  background: url('/#{config['image_output_path']}#{dest}') no-repeat #{result[:x]}px #{result[:y]}px;"
-            f.puts "  width: #{result[:width]}px;"
-            f.puts "  height: #{result[:height]}px;"
-            f.puts "}"
-          end
-        end
-      end
-    end
-    
-    # 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)
+      @sprite_files["#{name}.#{format}"] = results
     end
     
-    # 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
-    
-    # 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
+    def write_styles
+      style = Styles.get(config["style"]).new(self)
       
-      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
+      # use the absolute style output path to make sure we have the directory set up
+      path = style_output_path(style.extension, false)
+      FileUtils.mkdir_p(File.dirname(path))
+      
+      # send the style the relative path
+      style.write(style_output_path(style.extension, true), @sprite_files)
     end
     
     # sets all the default values on the config
     def set_config_defaults
       @config['style']              ||= 'css'
-      @config['style_output_path']        ||= 'stylesheets/sprites'
+      @config['style_output_path']  ||= 'stylesheets/sprites'
       @config['image_output_path']  ||= 'images/sprites/'
-      @config['image_source_path']        ||= 'images/'
+      @config['image_source_path']  ||= 'images/'
       @config['public_path']        ||= 'public/'
       @config['default_format']     ||= 'png'
       @config['class_separator']    ||= '-'
@@ -156,7 +114,7 @@ module Sprite
     def set_image_defaults
       return unless @images.size == 0
       
-      sprites_path = File.join(Sprite.root, config['public_path'], config['image_source_path'], "sprites")
+      sprites_path = image_source_path("sprites")
       
       if File.exists?(sprites_path)
         Dir.glob(File.join(sprites_path, "*")) do |dir|
@@ -175,7 +133,6 @@ module Sprite
           }
         end
       end
-      
     end
     
     # expands out sources, taking the Glob paths and turning them into separate entries in the array
@@ -184,10 +141,55 @@ module Sprite
       @images.each do |image|
         # expand out all the globs
         image['sources'] = image['sources'].to_a.map{ |source|
-          Dir.glob(File.join(Sprite.root, config['public_path'], @config['image_source_path'], source))
+          Dir.glob(image_source_path(source))
         }.flatten.compact
       end
     end
     
+    # get the disk path for the style output file
+    def style_output_path(file_ext, relative = false)
+      path = config['style_output_path']
+      unless path.include?(".#{file_ext}")
+        path = "#{path}.#{file_ext}"
+      end
+      public_path(path, relative)
+    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 << chop_trailing_slash(config['image_output_path']) if path_present?(config['image_output_path'])
+      path_parts << "#{name}.#{format}"
+      public_path(File.join(*path_parts), relative)
+    end
+    
+    # get the disk path for an image source file
+    def image_source_path(location, relative = false)
+      path_parts = []
+      path_parts << chop_trailing_slash(config["image_source_path"]) if path_present?(config['image_source_path'])
+      path_parts << location
+      public_path(File.join(*path_parts), relative)
+    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 << chop_trailing_slash(config['public_path']) if path_present?(config['public_path'])
+      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
+    
+    # check if the path is set
+    def path_present?(path)
+      path.to_s.strip != ""
+    end
   end
 end

data/lib/sprite/image_combiner.rb

@@ -16,7 +16,6 @@ module Sprite
       image
     end
 
-
     # Image Utility Methods
     def get_image(image_filename)
       image = Magick::Image::read(image_filename).first
@@ -25,6 +24,10 @@ module Sprite
     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/sass_extensions.rb

@@ -0,0 +1,57 @@
+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
+
+  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
+    end
+  end
+  
+end
+
+if defined?(Sass)
+  module Sass::Script::Functions
+    include Sprite::Sass::Extensions
+  end
+end

data/lib/sprite/styles/css_generator.rb

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

data/lib/sprite/styles/sass_generator.rb

@@ -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_if_generator.rb

@@ -0,0 +1,39 @@
+module Sprite
+  module Styles
+    # renders a yml file that is later parsed by a sass extension when generating the mixins
+    class SassIfGenerator
+      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)"
+          sprite_files.each do |sprite_file, sprites|
+            sprites.each do |sprite|
+              
+              f << "  @"
+              if add_else
+                f << "else "
+              end
+              add_else = true
+              
+              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 #{sprite[:x]}px #{sprite[:y]}px"
+              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_mixin_generator.rb

@@ -0,0 +1,54 @@
+require 'yaml'
+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)        
+        # build the yml file
+        config_location = write_config(path, sprite_files)
+        
+        # write the sass mixins to disk
+        File.open(File.join(Sprite.root, path), 'w') do |f|
+          f.puts "!sprite_data = '#{config_location}'"
+          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
+        config_path = path.gsub(".sass", ".yml")
+        File.open(File.join(Sprite.root, config_path), 'w') do |f|
+          YAML.dump(result, f)
+        end
+        
+        config_path
+      end
+      
+      def extension
+        "sass"
+      end
+  
+    end
+  end
+end

data/lib/sprite/styles.rb

@@ -0,0 +1,20 @@
+require 'sprite/styles/sass_generator'
+require 'sprite/styles/css_generator'
+require 'sprite/styles/sass_mixin_generator'
+require 'sprite/styles/sass_if_generator'
+
+module Sprite::Styles
+  GENERATORS = {
+    "css" => "CssGenerator",
+    "sass" => "SassGenerator",
+    "sass_mixin" => "SassMixinGenerator",
+    "sass_if" => "SassIfGenerator"
+  }
+  
+  def self.get(config)
+    const_get(GENERATORS[config])
+  rescue
+    CssGenerator
+  end
+
+end

data/lib/sprite.rb

@@ -20,3 +20,4 @@ end
 
 require 'sprite/builder'
 require 'sprite/image_combiner'
+require 'sprite/styles'

data/sprite.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sprite}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jacques Crocker", "Richard Huang"]
-  s.date = %q{2009-11-17}
+  s.date = %q{2009-11-18}
   s.default_executable = %q{sprite}
   s.description = %q{sprite is a rails/merb plugin that generates sprites for css, sass}
   s.email = %q{merbjedi@gmail.com}
@@ -27,6 +27,12 @@ Gem::Specification.new do |s|
      "lib/sprite/builder.rb",
      "lib/sprite/image_combiner.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_if_generator.rb",
+     "lib/sprite/styles/sass_mixin_generator.rb",
      "rails/init.rb",
      "sprite.gemspec",
      "tasks/sprite_tasks.rake"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sprite
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Jacques Crocker
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-17 00:00:00 -08:00
+date: 2009-11-18 00:00:00 -08:00
 default_executable: sprite
 dependencies: []
 
@@ -32,6 +32,12 @@ files:
 - lib/sprite/builder.rb
 - lib/sprite/image_combiner.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_if_generator.rb
+- lib/sprite/styles/sass_mixin_generator.rb
 - rails/init.rb
 - sprite.gemspec
 - tasks/sprite_tasks.rake