css_sprite 1.4.5 → 1.4.6

data/README.textile

@@ -27,6 +27,10 @@ css sprite generates css_sprite image and css files automatically for you follow
 | twitter-icon-hover.png | .twitter-icon:hover |
 | logos_hover/gmail_logo.png | .logos:hover .gmail_logo |
 | logos-hover/gmail-logo.png | .logos:hover .gmail-logo |
+| gmail_logo_active.png | .gmail_logo.active |
+| gmail-logo-active.png | .gmail-logo.active |
+| logos_active/gmail_logo.png | .logos.active .gmail_logo |
+| logos-active/gmail-logo.png | .logos.active .gmail-logo |
 
 css_sprite directory is the directory whose name is "css_sprite" or "css_sprite" suffixed under public/images directory.
 css_sprite image is the image file automatically generated under public/images directory.

data/VERSION

@@ -1 +1 @@
-1.4.5
+1.4.6

data/css_sprite.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{css_sprite}
-  s.version = "1.4.5"
+  s.version = "1.4.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
-  s.date = %q{2010-04-13}
+  s.date = %q{2010-04-19}
   s.description = %q{css_sprite is a rails plugin/gem to generate css sprite image automatically.}
   s.email = %q{flyerhzm@gmail.com}
   s.extra_rdoc_files = [
@@ -27,12 +27,14 @@ Gem::Specification.new do |s|
      "spec/css_sprite/sprite_spec.rb",
      "spec/public/images/another_css_sprite/no_image",
      "spec/public/images/css_sprite/gmail_logo.png",
+     "spec/public/images/css_sprite/gmail_logo_active.png",
      "spec/public/images/css_sprite/hotmail_logo.png",
      "spec/public/images/css_sprite/icons/facebook_icon.png",
      "spec/public/images/css_sprite/icons/facebook_icon_hover.png",
      "spec/public/images/css_sprite/icons/twitter_icon.png",
      "spec/public/images/css_sprite/icons/twitter_icon_hover.png",
      "spec/public/images/css_sprite/logos/gmail_logo.png",
+     "spec/public/images/css_sprite/logos/gmail_logo_active.png",
      "spec/public/images/css_sprite/logos_hover/gmail_logo.png",
      "spec/public/images/css_sprite/not_image.txt",
      "spec/spec.opts",
@@ -42,7 +44,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/flyerhzm/css_sprite}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{css_sprite is a rails plugin/gem to generate css sprite image automatically.}
   s.test_files = [
     "spec/css_sprite/sprite_spec.rb",

data/lib/css_sprite/sprite.rb

@@ -16,16 +16,19 @@ class Sprite
     end
   end
   
+  # execute the css sprite operation
   def build
     directories = css_sprite_directories
     directories.each { |directory| execute(directory) }
   end
   
+  # execute the css sprite operation if stylesheet is expired
   def check
     directories = css_sprite_directories
     directories.each { |directory| execute(directory) if expire?(directory) }
   end
   
+  # output the css sprite image and stylesheet
   def execute(directory)
     results = output_image(directory)
     unless results.empty?
@@ -34,6 +37,7 @@ class Sprite
     end
   end
   
+  # detect if the stylesheet is expired or not?
   def expire?(directory)
     if sass?
       stylesheet_path = dest_sass_path(directory)
@@ -43,12 +47,12 @@ class Sprite
     return true unless File.exist?(stylesheet_path)
     stylesheet_mtime = File.new(stylesheet_path).mtime
     Dir["**/*"].each do |path|
-      # it is a directory
       return true if path !~ /.*\..*/ and File.new(path).mtime > stylesheet_mtime
     end
     return false
   end
   
+  # output stylesheet, sass or css
   def output_stylesheet(directory, results)
     if sass?
       output_sass(directory, results)
@@ -57,16 +61,19 @@ class Sprite
     end
   end
   
+  # use sass or css?
   def sass?
     @config['engine'] == 'sass'
   end
   
+  # detect all the css sprite directories. e.g. public/images/css_sprite, public/images/widget_css_sprite
   def css_sprite_directories
     Dir.entries(@image_path).collect do |d|
       File.join(@image_path, d) if File.directory?(File.join(@image_path, d)) and d =~ /css_sprite$/
     end.compact
   end
   
+  # output the css sprite image and return all the images properies.
   def output_image(directory)
     results = []
     sources = all_images(directory)
@@ -89,6 +96,7 @@ class Sprite
     results
   end
   
+  # opitmize the css sprite image
   def optimize_image(directory)
     unless @config['disable_optimization']
       dest_image_path = dest_image_path(directory)
@@ -98,6 +106,7 @@ class Sprite
     end
   end
 
+  # output the css sprite css
   def output_css(directory, results)
     unless results.empty?
       dest_image_name = dest_image_name(directory)
@@ -130,6 +139,7 @@ class Sprite
     end
   end
   
+  # output the css sprite sass file
   def output_sass(directory, results)
     unless results.empty?
       dest_image_name = dest_image_name(directory)
@@ -161,6 +171,7 @@ class Sprite
     end
   end
   
+  # get all the class names within the same css sprite image
   def class_names(results, options={})
     options = {:count_per_line => 5}.merge(options)
     class_names = []
@@ -171,10 +182,12 @@ class Sprite
     class_names
   end
   
+  # get the css class name from image name
   def class_name(name)
-    ".#{name.gsub('/', ' .').sub(/[_-]hover\b/, ':hover')}"
+    ".#{name.gsub('/', ' .').gsub(/[_-]hover\b/, ':hover').gsub(/[_-]active\b/, '.active')}"
   end
   
+  # read all images under the css sprite directory
   def all_images(directory)
     images = []
     Find.find(directory) do |path|
@@ -185,22 +198,27 @@ class Sprite
     images
   end
   
+  # destination css sprite image path
   def dest_image_path(directory)
     directory + ".png"
   end
   
+  # destination css sprite image name
   def dest_image_name(directory)
     File.basename(directory) + ".png"
   end
   
+  # destination css file path
   def dest_css_path(directory)
     File.join(@stylesheet_path, File.basename(directory) + '.css')
   end
 
+  # destination sass file path
   def dest_sass_path(directory)
     File.join(@stylesheet_path, 'sass', File.basename(directory) + '.sass')
   end
   
+  # append src_image to the dest_image with position (x, y)
   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
@@ -210,27 +228,48 @@ class Sprite
     image
   end
   
+  # get the Magick::Image
   def get_image(image_filename)
     Magick::Image::read(image_filename).first
   end
   
+  # get image properties, including name, width and height
   def image_properties(image, directory)
-    directory_length = directory.length + 1
-    extname_length = File.extname(image.filename).length
-    name = image.filename.slice(directory_length...-extname_length)
-    without = false
-    if hover?(name)
-      not_hover_file = image.filename.sub(/[_-]hover\./, '.').sub(/[_-]hover\//, '/')
-      if File.exist?(not_hover_file)
-        not_hover_image = get_image(not_hover_file)
-        without = true if image.columns == not_hover_image.columns and image.rows == not_hover_image.rows
+    name = get_image_name(image, directory)
+    need_wh?(image, directory) ? {:name => name, :width => image.columns, :height => image.rows} : {:name => name}
+  end
+  
+  # check if the hover class needs width and height
+  # if the hover class has the same width and height property with not hover class, 
+  # then the hover class does not need width and height
+  def need_wh?(image, directory)
+    name = get_image_name(image, directory)
+    if hover?(name) or active?(name)
+      not_file = image.filename.sub(/[_-](hover|active)\./, '.').sub(/[_-](hover|active)\//, '/')
+      if File.exist?(not_file)
+        not_image = get_image(not_file)
+        return false if image.columns == not_image.columns and image.rows == not_image.rows
       end
     end
-    without ? {:name => name} : {:name => name, :width => image.columns, :height => image.rows}
+    return true
   end
-
-  def hover?(name)
-    name =~ /[_-]hover$|[_-]hover\//
+  
+  # get the image name substracting base directory and extname
+  def get_image_name(image, directory)
+    directory_length = directory.length + 1
+    extname_length = File.extname(image.filename).length
+    image.filename.slice(directory_length...-extname_length)
+  end
+  
+  # test if the filename contains a hover or active. 
+  # e.g. icons/twitter_hover, icons_hover/twitter 
+  # e.g. icons/twitter_active, icons_active/twitter
+  [:active, :hover].each do |method|
+    class_eval <<-EOF
+      def #{method}?(name)
+        name =~ /[_-]#{method}$|[_-]#{method}\\//
+      end
+    EOF
   end
     
 end

data/spec/css_sprite/sprite_spec.rb

@@ -54,8 +54,10 @@ describe Sprite do
                          File.join(IMAGE_PATH, 'css_sprite/icons/facebook_icon_hover.png'),
                          File.join(IMAGE_PATH, 'css_sprite/hotmail_logo.png'),
                          File.join(IMAGE_PATH, 'css_sprite/gmail_logo.png'),
+                         File.join(IMAGE_PATH, 'css_sprite/gmail_logo_active.png'),
                          File.join(IMAGE_PATH, 'css_sprite/logos_hover/gmail_logo.png'),
-                         File.join(IMAGE_PATH, 'css_sprite/logos/gmail_logo.png')]
+                         File.join(IMAGE_PATH, 'css_sprite/logos/gmail_logo.png'),
+                         File.join(IMAGE_PATH, 'css_sprite/logos/gmail_logo_active.png')]
       actual_images = @sprite.all_images(File.join(IMAGE_PATH, 'css_sprite'))
       actual_images.size.should == expected_images.size
       expected_images.each do |expected_image|
@@ -99,6 +101,12 @@ describe Sprite do
       @sprite.class_name("twitter_hover_icon_hover").should == ".twitter_hover_icon:hover"
       @sprite.class_name("logos_hover/gmail_logo").should == ".logos:hover .gmail_logo"
     end
+    
+    it "should get class_name with active class" do
+      @sprite.class_name("gmail_logo_active").should == ".gmail_logo.active"
+      @sprite.class_name("logos_active/gmail_logo").should == ".logos.active .gmail_logo"
+      @sprite.class_name("logos/gmail_logo_active").should == ".logos .gmail_logo.active"
+    end
   end
   
   describe "dest_image_path" do

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: css_sprite
 version: !ruby/object:Gem::Version 
-  version: 1.4.5
+  prerelease: false
+  segments: 
+  - 1
+  - 4
+  - 6
+  version: 1.4.6
 platform: ruby
 authors: 
 - Richard Huang
@@ -9,19 +14,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-13 00:00:00 -06:00
+date: 2010-04-19 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rmagick
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: css_sprite is a rails plugin/gem to generate css sprite image automatically.
 email: flyerhzm@gmail.com
 executables: []
@@ -42,12 +49,14 @@ files:
 - spec/css_sprite/sprite_spec.rb
 - spec/public/images/another_css_sprite/no_image
 - spec/public/images/css_sprite/gmail_logo.png
+- spec/public/images/css_sprite/gmail_logo_active.png
 - spec/public/images/css_sprite/hotmail_logo.png
 - spec/public/images/css_sprite/icons/facebook_icon.png
 - spec/public/images/css_sprite/icons/facebook_icon_hover.png
 - spec/public/images/css_sprite/icons/twitter_icon.png
 - spec/public/images/css_sprite/icons/twitter_icon_hover.png
 - spec/public/images/css_sprite/logos/gmail_logo.png
+- spec/public/images/css_sprite/logos/gmail_logo_active.png
 - spec/public/images/css_sprite/logos_hover/gmail_logo.png
 - spec/public/images/css_sprite/not_image.txt
 - spec/spec.opts
@@ -66,18 +75,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: css_sprite is a rails plugin/gem to generate css sprite image automatically.