sprite-generator 0.1.7 → 0.1.8

data/README.md

@@ -72,6 +72,8 @@ Configuration of `sprite-generator` is done via `config/sprite.yml`. It allows y
   - `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)
   - `class_separator:` used to generated the class name by separating the image name and sprite name (defaults to `-`)
+  - `pseudo_classes`: array of strings. Example: if some image name will end with `_hover` and `pseudo_classes` will equal `['hover']`, then the style for that picture will end with `:hover` instead of `_hover`. (defaults to ['hover'])
+  - `parameters`: hash of parameters that will be substituted in other options. In order to be used parameter must be declared in parameters hash and have a default value. Parameter can be overriden in command line: `sprite -p param_name=new_param_value`. (defaults to `{}`)
 
 * `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)
@@ -88,14 +90,16 @@ All image and style paths should be set relative to the public folder (which is
 
     config:
       style: css
-      style_output_path: stylesheets/sprites
-      image_output_path: images/sprites/
-      image_source_path: images/
+      style_output_path: ${theme}/stylesheets/sprites
+      image_output_path: ${theme}/images/sprites/
+      image_source_path: ${theme}/images/
       public_path: public/
       sprites_class: 'sprites'
       class_separator: '-'
       default_format: png
       default_spacing: 50
+      parameters:
+        theme: mytheme
 
     # defines what sprite collections get created
     images:
@@ -110,6 +114,7 @@ All image and style paths should be set relative to the public folder (which is
           - icons/blue-stars/medium.png
           - icons/blue-stars/large.png
           - icons/blue-stars/xlarge.png
+          - icons/blue-stars/large_hover.png
 
       # creates a public/images/sprites/green-stars.jpg image with
       # all the gif files contained within /images/icons/green-stars/
@@ -125,22 +130,27 @@ All image and style paths should be set relative to the public folder (which is
 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;
+      background: url('/mytheme/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;
+      background: url('/mytheme/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;
+      background: url('/mytheme/images/icons/blue-stars/large.png') no-repeat 0px 21px;
+      width: 60px;
+      height: 30px;
+    }
+    .sprites.blue-stars-large:hover {
+      background: url('/mytheme/images/icons/blue-stars/large_hover.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;
+      background: url('/mytheme/images/icons/blue-stars/xlarge.png') no-repeat 0px 96px;
       width: 100px;
       height: 75px;
     }

data/Rakefile

@@ -11,14 +11,14 @@ Spec::Rake::SpecTask.new(:spec) do |t|
 end
 
 Jeweler::Tasks.new do |gemspec|
-  gemspec.name = "sprite"
+  gemspec.name = "sprite-generator"
   gemspec.summary = "generate your css sprites automagically"
-  gemspec.description = "sprite is a rails/merb plugin that generates sprites for css, sass"
-  gemspec.email = "merbjedi@gmail.com"
-  gemspec.homepage = "http://github.com/merbjedi/sprite" 
-  gemspec.authors = ["Jacques Crocker"]
+  gemspec.description = "sprite-generator is a rails/merb plugin that generates sprites for css, sass"
+  gemspec.email = "astyagun@gmail.com"
+  gemspec.homepage = "http://github.com/iast/sprite-generator"
+  gemspec.authors = ["Jacques Crocker", "Anton Styagun"]
   gemspec.files.exclude '.gitignore'
-  
+
   # removing test files and specs from the gem to save space
   gemspec.files -= Dir.glob("spec/**/*")
   gemspec.test_files = []

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.8

data/lib/sprite/builder.rb

@@ -1,17 +1,19 @@
 require 'fileutils'
+
 module Sprite
-  class Builder  
+  class Builder
     DEFAULT_CONFIG_PATH = 'config/sprite.yml'
-    
+
     attr_reader :config
     attr_reader :images
-    
-    def self.from_config(path = nil) 
+
+    def self.from_config(parameters)
       results = {}
-      config_path = File.join(Sprite.root, path || DEFAULT_CONFIG_PATH)
-      
+      config_path = File.join(Sprite.root, parameters[:path] || DEFAULT_CONFIG_PATH)
+      parameters[:path] &= nil
+
       # read configuration
-      if File.exists?(config_path) 
+      if File.exists?(config_path)
         begin
           results = File.open(config_path) {|f| YAML::load(f)} || {}
         rescue => e
@@ -20,105 +22,111 @@ module Sprite
         end
       end
 
-      new(results["config"], results["images"])
+      new(results["config"], results["images"], parameters)
     end
 
-    def initialize(config = nil, images = nil)
+    def initialize(config = nil, images = nil, parameters = {})
+      @parameters = parameters
+
       @config = config || {}
       set_config_defaults
-      
+
       @images = images || []
       set_image_defaults
+      expand_parameters
       expand_image_paths
-      
+
       # initialize sprite files
       @sprite_files = {}
+
     end
-  
-    def build    
+
+    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
-    
+
     protected
     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'] || config["default_spacing"] || 0
-      
+      align = image['align'] || config['default_align']
+
       combiner = ImageCombiner.new
-      
+
       dest_image = combiner.get_image(sources.shift)
       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'
+        if align == 'horizontal'
           x = dest_image.columns + spaced_by
           y = 0
-          align = "horizontal"
         else
           x = 0
           y = dest_image.rows + 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
-      
+
       # set up path
       path = image_output_path(name, format)
       FileUtils.mkdir_p(File.dirname(path))
-      
+
       # write sprite image file to disk
       dest_image.write(path)
       @sprite_files["#{name}.#{format}"] = results
     end
-    
+
     def write_styles
       style = Styles.get(config["style"]).new(self)
-      
+
       # 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['image_output_path']  ||= 'images/sprites/'
-      @config['image_source_path']  ||= 'images/'
-      @config['public_path']        ||= 'public/'
-      @config['default_format']     ||= 'png'
-      @config['class_separator']    ||= '-'
-      @config["sprites_class"]      ||= 'sprites'
-      @config["default_spacing"]    ||= 0
+      @config['style']                ||= 'css'
+      @config['style_output_path']    ||= 'stylesheets/sprites'
+      @config['image_output_path']    ||= 'images/sprites/'
+      @config['image_source_path']    ||= 'images/'
+      @config['public_path']          ||= 'public/'
+      @config['default_format']       ||= 'png'
+      @config['class_separator']      ||= '-'
+      @config['sprites_class']        ||= 'sprites'
+      @config['default_spacing']      ||= 0
+      @config['pseudo_classes']       ||= ['hover']
+      @config['parameters']           ||= {}
+      @config['default_orientation']  ||= 'horizontal'
     end
-    
+
     # if no image configs are detected, set some intelligent defaults
     def set_image_defaults
       return unless @images.size == 0
-      
+
       sprites_path = image_source_path("sprites")
-      
+
       if File.exists?(sprites_path)
         Dir.glob(File.join(sprites_path, "*")) do |dir|
           next unless File.directory?(dir)
@@ -137,7 +145,7 @@ module Sprite
         end
       end
     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
@@ -148,7 +156,25 @@ module Sprite
         }.flatten.compact
       end
     end
-    
+
+    def expand_parameters
+      @config.each do |k, v|
+        next if k == "parameters" or not v.is_a? String
+        if @config['parameters']
+          @config['parameters'].each do |parameter_name, parameter_default_value|
+            parameter_value = @parameters[parameter_name.to_sym] || parameter_default_value
+            puts "Warning! Parameter #{parameter_name.to_sym} has no value!" unless parameter_value
+            v.gsub! /\$\{#{parameter_name.to_s}\}/, parameter_value.to_s
+          end
+        else
+          parameters_used = v.match(/\$\{([\w\s_]+)\}/)
+          parameters_used.each do |param|
+            puts "Warning! Parameter #{param.to_sym} has no definition, but is used in config file!"
+          end if parameters_used
+        end
+      end
+    end
+
     # get the disk path for the style output file
     def style_output_path(file_ext, relative = false)
       path = config['style_output_path']
@@ -157,7 +183,7 @@ module Sprite
       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 = []
@@ -165,7 +191,7 @@ module Sprite
       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 = []
@@ -173,26 +199,26 @@ module Sprite
       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
+end

data/lib/sprite/runner.rb

@@ -1,22 +1,47 @@
+require 'getoptlong'
+
 module Sprite
   class Runner
-    
-    attr_accessor :options
+
     def initialize(args)
-      self.options = set_options(args)
+      @parameters = {}
+      set_options(args)
     end
-    
+
     def set_options(args)
-      opts = {}
-      # TODO
-      # edit options with passed in args
-      opts
+      opts = GetoptLong.new(
+        ['--help', '-h', GetoptLong::NO_ARGUMENT],
+        ['--param', '-p', GetoptLong::REQUIRED_ARGUMENT],
+        ['--path', GetoptLong::REQUIRED_ARGUMENT]
+      )
+      opts.each do |option, argument|
+        case option
+        when '--help'
+          puts
+          puts "  sprite [--path /path/to/config/file] [(--param | -p) param_name=param_value] ..."
+          puts
+          puts "  Notes:"
+          puts "    * `sprite --path /path/to/config/file` is equal to `sprite -p path=/path/to/config/file`"
+          puts "    * param_name can contain only letters, numbers and underscores"
+          puts
+          exit 0
+        when '--param'
+          parsed_argument = argument.match(/([^=]+)=(.+)/)
+          unless parsed_argument[0] =~ /[\w\d_]/
+            puts "Error: parameter name can contain only letters, digits and underscores."
+            exit 1
+          end
+          @parameters[parsed_argument[1].to_sym] = parsed_argument[2]
+        when '--path'
+          @parameters[:path] = argument if argument
+        end
+      end
     end
-    
+
     # run sprite creator
     def run!
       begin
-        Sprite::Builder.from_config(options[:path]).build
+        Sprite::Builder.from_config(@parameters).build
       # rescue Exception => e
       #   # catch errors
       #   puts "ERROR"
@@ -25,6 +50,6 @@ module Sprite
       end
       0
     end
-    
+
   end
-end
+end

data/lib/sprite/styles/css_generator.rb

@@ -5,29 +5,33 @@ 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]} {"
+              # if sprite name ends with some of special states, consider this a state
+              # for example if the sprite name is 'image_hover' and 'hover' is among states, set sprite_name to image:hover
+              sprite_name = sprite[:name].gsub /(.*)(_)(#{@builder.config['pseudo_classes'].join "|"})$/, '\1:\3'
+
+              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
       end
-  
+
       def extension
         "css"
       end
     end
   end
-end
+end

data/sprite-generator.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sprite-generator}
-  s.version = "0.1.7"
+  s.version = "0.1.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jacques Crocker", "Anton Styagun"]
-  s.date = %q{2009-11-27}
+  s.date = %q{2009-12-01}
   s.default_executable = %q{sprite}
   s.description = %q{sprite-generator is a rails/merb plugin that generates sprites for css, sass}
   s.email = %q{astyagun@gmail.com}
@@ -37,7 +37,7 @@ Gem::Specification.new do |s|
      "sprite-generator.gemspec",
      "tasks/sprite_tasks.rake"
   ]
-  s.homepage = %q{http://github.com/iast/sprite}
+  s.homepage = %q{http://github.com/iast/sprite-generator}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sprite-generator
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors: 
 - Jacques Crocker
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-27 00:00:00 +02:00
+date: 2009-12-01 00:00:00 +02:00
 default_executable: sprite
 dependencies: []
 
@@ -42,7 +42,7 @@ files:
 - sprite-generator.gemspec
 - tasks/sprite_tasks.rake
 has_rdoc: true
-homepage: http://github.com/iast/sprite
+homepage: http://github.com/iast/sprite-generator
 licenses: []
 
 post_install_message: