morganchristiansson-css-sprites 0.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ayose Cazorla
+
+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.rdoc

@@ -0,0 +1,78 @@
+= CssSprites - A Rails plugin for generate CSS sprites
+
+This plugin helps to generate CSS sprites with the images of the
+<tt>public/images/</tt> directory.
+
+
+== Installation
+
+    $ script/plugin install git://github.com/setepo/css-sprites
+
+The installer will copy <tt>blank.gif</tt> in <tt>public/images</tt>, and a
+configuration file in <tt>config/</tt>. Before copy the files it checks if there is any
+file with the same name, and will not override existing files.
+
+
+== Usage
+
+You don't need to change your code.
+
+The first step is generate the index:
+
+    $ rake css_sprites:update
+
+This will find all the images and make a bundle with them. Animated images
+(like GIF or APNG with two or more frames) are always excluded.
+
+The plugin will create one image per format (a file with JPEG images, another
+file with PNGs, ...).
+
+And that is all.
+
+When you use <tt>image_tag</tt> in your views, the plugin will check if the
+requested image is available in the index, and, if it is found, generate
+something like this:
+
+    <img alt="Some text" height="16" src="/images/blank.gif?12345678" style="background: url(/images/css-sprites-image-bundle.png?12345678) -0px -466px; " width="16" />
+
+This HTML is generated with the original <tt>image_tag</tt>, so all the Rails
+features (like assets, timestamp suffix, URL prefix) are available.
+
+If you don't want to use sprites, just remove the generated bundles.
+
+The plugin doesn't check the timestamps, so you have to call <tt>rake
+css_sprites:update</tt> again when you modify the images of the index, or you want
+to add new images.  The bundles are generated from scratch, so if you remove
+images, they will disappear from the bundles after <tt>rake
+css_sprites:update</tt>
+
+== Example configuration
+
+The initial configuration is this:
+
+    max-width: 100
+    max-height: 100
+    background: blank.gif
+    file-bundle: css-sprites-image-bundle
+    max-files-per-bundle: 75
+    files:
+        - **/*.png
+        - **/*.gif
+        - **/*.jpeg
+        - **/*.jpg
+
+The most interesting key is <tt>files</tt>: with it, you can specify what files
+do you want to add to the index. By default it includes all the most common
+files, recursively. Take a look to <tt>Dir.glob</tt> documentation if you want to know
+the details of the patterns.
+
+== Dependencies
+
+* RMagick
+
+== TODO
+
+* Tests
+
+
+Copyright (C) 2009 Ayose Cazorla, released under the MIT license

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the css_sprites plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the css_sprites plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CSSSprites'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "css-sprites"
+    gemspec.summary = "A Rails plugin for generate CSS sprites"
+    gemspec.description = "The first step is generate the index:
+
+    $ rake css_sprites:update
+This will find all the images and make a bundle with them. Animated images (like GIF or APNG with two or more frames) are always excluded.
+
+The plugin will create one image per format (a file with JPEG images, another file with PNGs, ...).
+
+And that is all."
+    gemspec.email = "code@mog.se"
+    gemspec.homepage = "http://github.com/morganchristiansson/css-sprites"
+    gemspec.authors = ["Ayose (setepo)", "Morgan Chrisitansson"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/css-sprites.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{css-sprites}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ayose (setepo)", "Morgan Chrisitansson"]
+  s.date = %q{2009-09-17}
+  s.description = %q{The first step is generate the index:
+
+    $ rake css_sprites:update
+This will find all the images and make a bundle with them. Animated images (like GIF or APNG with two or more frames) are always excluded.
+
+The plugin will create one image per format (a file with JPEG images, another file with PNGs, ...).
+
+And that is all.}
+  s.email = %q{code@mog.se}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "css-sprites.gemspec",
+     "init.rb",
+     "install.rb",
+     "lib/css_sprites.rb",
+     "lib/css_sprites/generator.rb",
+     "lib/css_sprites/view_methods.rb",
+     "lib/tasks/css_sprites.rake",
+     "lib/tasks/css_sprites.rb",
+     "templates/blank.gif",
+     "templates/css-sprites.yml",
+     "test/css_sprites_test.rb",
+     "test/test_helper.rb",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/morganchristiansson/css-sprites}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Rails plugin for generate CSS sprites}
+  s.test_files = [
+    "test/css_sprites_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,5 @@
+
+class ActionView::Base
+    include CSSSprites::ViewMethods
+end
+

data/install.rb

@@ -0,0 +1,16 @@
+
+
+TemplatesDir = File.join(File.dirname(__FILE__), "templates")
+
+[
+    [ "blank.gif", "public/images" ],
+    [ "css-sprites.yml", "config" ]
+].each do |source, dest|
+
+    dest = File.join(dest, source)
+    unless File.exist?(dest)
+        puts "Copying #{source} to #{dest}"
+        FileUtils.cp(File.join(TemplatesDir, source), dest)
+    end
+
+end

data/lib/css_sprites.rb

@@ -0,0 +1,22 @@
+
+module CSSSprites
+
+    ConfigFileName = "css-sprites.yml"
+    IndexFileName = File.join(RAILS_ROOT, "tmp", "css-sprites-index.marshal")
+
+
+    def self.read_config
+        filename = File.join(RAILS_ROOT, "config", ConfigFileName)
+        unless File.exist?(filename)
+            STDERR.puts "Error in CSS Sprites: config/#{ConfigFileName} not found."
+            return {}
+        end
+
+        HashWithIndifferentAccess.new(YAML::load(File.read(filename)))
+    end
+
+    mattr_accessor :config
+    self.config = read_config
+
+end
+

data/lib/css_sprites/generator.rb

@@ -0,0 +1,136 @@
+
+require 'RMagick'
+
+module CSSSprites
+    module Generator
+        extend self
+
+        class BundleFile
+            cattr_accessor :file_count
+            self.file_count = 0
+
+            attr_accessor :file_name, :y
+
+            def initialize(mimetype)
+                @suffix = mimetype.gsub(/^.*\W/, '')
+                new
+            end
+
+            def new
+                close if @draw
+                @draw = Magick::Draw.new
+                @image_count = @width = @height = @y = 0
+
+                self.class.file_count += 1
+                @file_name = "#{CSSSprites.config["file-bundle"] || "css-sprites-image-bundle"}-#{self.class.file_count}.#{@suffix}"
+            end
+
+            def close
+                bundle = Magick::Image.new(@width, @height) {|image| image.background_color = CSSSprites.config["background-color"] || "#ffff" }
+
+                @draw.draw bundle
+                bundle.write(File.join(RAILS_ROOT, "public", "images", file_name))
+
+                @draw = nil
+            end
+
+            def add(image)
+                new if @image_count > (CSSSprites.config["max-files-per-bundle"] || 75)
+                @width = image.columns if image.columns > @width
+                @height += image.rows
+
+                @draw.composite 0, @y, 0, 0, image
+                @y += image.rows
+                @image_count += 1
+            end
+
+        end
+
+        def update!
+            config = CSSSprites.read_config
+
+            if File.exist?(CSSSprites::IndexFileName)
+                index = (Marshal.load(File.read(CSSSprites::IndexFileName)) rescue {})
+
+                bundles = []
+                index.each_value do |item|
+                    bundles << item[:bundle]
+                end
+
+                bundles.uniq.each do |file|
+                    file = File.join(RAILS_ROOT, "public", "images", file)
+                    File.delete(file) if File.exist?(file)
+                end
+            end
+
+            # Find all the images
+            image_types = find_images(:max_width => (config["max-width"] || 100).to_i,
+                                      :max_height => (config["max-height"] || 100).to_i,
+                                      :files => (config["files"] || "**/*"))
+
+
+            index = {}
+
+            # Render the bundle
+
+            image_types.each_pair do |mimetype, images|
+                puts "Generating bundle for #{mimetype} (#{images.size} images)"
+
+                bundle = BundleFile.new(mimetype)
+                images.each do |file_image, image|
+                    index[file_image] = {
+                        :x => 0,
+                        :y => bundle.y,
+                        :width => image.columns,
+                        :height => image.rows,
+                        :bundle => bundle.file_name
+                    }
+
+                    bundle.add image
+                end
+
+                bundle.close
+            end
+
+            # Dump the index
+            File.open(CSSSprites::IndexFileName, "w") {|f| f.write Marshal.dump(index) }
+        end
+
+
+        def find_images(options)
+            puts "Reading images..."
+            max_width = options[:max_width]
+            max_height = options[:max_height]
+            root_dir = File.join(RAILS_ROOT, "public", "images")
+
+            image_types = {}
+
+            options[:files].each do |pattern|
+                Dir.glob(File.join(root_dir, pattern)).each do |filename|
+                    begin
+                        image = Magick::Image.read(filename)
+                    rescue Magick::ImageMagickError
+                        # Ignore this file
+                        next
+                    end
+
+                    # We have to ignore animated images
+                    next if image.size > 1
+
+                    image = image.first
+
+                    # Invalid image
+                    next if image.nil? or image.columns > max_width or image.rows > max_height
+
+                    # Register the image
+                    filename = filename[(root_dir.size + 1).. -1]
+                    image_types[image.mime_type] ||= []
+                    image_types[image.mime_type] << [filename, image]
+                end
+            end
+
+            image_types
+        end
+
+    end
+end

data/lib/css_sprites/view_methods.rb

@@ -0,0 +1,22 @@
+module CSSSprites
+    module ViewMethods
+
+        def self.included(base)
+            base.alias_method_chain :image_tag, :css_sprite
+        end
+
+        def image_tag_with_css_sprite(source, options = {})
+            @__css_sprites_index ||= (Marshal.load(File.read(CSSSprites::IndexFileName)) rescue nil) || {}
+            if info = @__css_sprites_index[source.to_s]
+                source = CSSSprites.config[:background]
+                options[:style] = "background: url(#{image_path info[:bundle]}) -#{info[:x]}px -#{info[:y]}px; #{options[:style]}"
+                options[:width] = info[:width]
+                options[:height] = info[:height]
+            end
+
+            image_tag_without_css_sprite(source, options)
+        end
+
+    end
+end
+

data/lib/tasks/css_sprites.rake

@@ -0,0 +1,12 @@
+
+namespace :css_sprites do
+
+    desc "Updates the CSSSprites index"
+    task :update do
+        $LOAD_PATH << File.join(File.dirname(__FILE__), "..", "lib")
+        require 'css_sprites'
+        require 'css_sprites/generator'
+        CSSSprites::Generator.update!
+    end
+
+end

data/lib/tasks/css_sprites.rb

@@ -0,0 +1,3 @@
+$VERBOSE = nil
+Dir["#{Gem.searcher.find('css_sprites').full_gem_path}/lib/tasks/*.rake"].each { |ext| load ext }
+

data/templates/css-sprites.yml

@@ -0,0 +1,10 @@
+file-bundle: css-sprites-image-bundle
+max-width: 100
+max-height: 100
+background: blank.gif
+max-files-per-bundle: 75
+files:
+    - **/*.png
+    - **/*.gif
+    - **/*.jpeg
+    - **/*.jpg

data/test/css_sprites_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class CssSpritesTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: morganchristiansson-css-sprites
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Ayose (setepo)
+- Morgan Chrisitansson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-17 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: "The first step is generate the index:  $ rake css_sprites:update This will find all the images and make a bundle with them. Animated images (like GIF or APNG with two or more frames) are always excluded.  The plugin will create one image per format (a file with JPEG images, another file with PNGs, ...).  And that is all."
+email: code@mog.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- css-sprites.gemspec
+- init.rb
+- install.rb
+- lib/css_sprites.rb
+- lib/css_sprites/generator.rb
+- lib/css_sprites/view_methods.rb
+- lib/tasks/css_sprites.rake
+- lib/tasks/css_sprites.rb
+- templates/blank.gif
+- templates/css-sprites.yml
+- test/css_sprites_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: false
+homepage: http://github.com/morganchristiansson/css-sprites
+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: A Rails plugin for generate CSS sprites
+test_files: 
+- test/css_sprites_test.rb
+- test/test_helper.rb