lash-sprites 0.3.1

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in lash-sprites.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README

@@ -0,0 +1,38 @@
+Originally forked from https://github.com/ckwalsh/RubySprites
+
+
+= RubySprites
+
+Provides a library for generating image sprites from multiple images, as
+well as a few basic tools to manage sprites and act as example
+implementations.
+
+== Dependencies
+
+Gems
+* RMagick 2.x.x OR
+* GD2
+
+== Special Thanks
+
+Special thanks to the team at WhitePages.com.  This module was invisioned
+and developed during my internship there, and would not be what it is
+today without their help.
+
+== License
+
+RubySprites Copyright (c) 2009 Cullen Walsh
+GNU Lesser General Public License
+
+RubySprites is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+RubySprites is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with RubySprites.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,38 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+ 
+require 'rubygems'
+
+desc 'Determine server compatibility and test components'
+task :test do
+  $:.unshift 'lib'
+  require 'ruby_sprites/sprite'
+
+  puts 'Availible Image Managers'
+  RubySprites::Sprite.graphics_managers.values.each { |x|
+    puts "\t#{x.const_get(:DESCRIPTION)}"
+  }
+
+  puts 'Availible packing algorithms'
+  Dir.entries('lib/ruby_sprites/packer').sort.each { |x|
+    next unless x.match(/\.rb$/)
+    class_name = x.gsub('.rb', '').capitalize.gsub(/_([a-z]+)/) {|x| $1.capitalize}
+    puts "\t#{class_name}"
+  }
+
+  puts ""
+
+  require 'test/t_rmagick'
+  require 'test/t_gd2'
+  puts ""
+
+end
+
+desc 'Benchmark availible graphics backends and packing algorithms'
+task :benchmark do
+  puts "== Benchmarking Graphics Engines =="
+  require 'test/b_graphics'
+  puts "== Benchmarking Packing algorithms =="
+  require 'test/b_packers'
+end
+

data/examples/css/css.rb

@@ -0,0 +1,17 @@
+current_dir = File.dirname(__FILE__)
+
+$:.unshift File.join(current_dir, '../../lib')
+
+require 'ruby_sprites/sprite'
+require 'ruby_sprites/css'
+
+sprite = RubySprites::Sprite.new('css/sprite.png', current_dir + '/..')
+    
+(1..60).each do |x|
+  sprite.add_image("example_imgs/#{x}.png")
+end
+
+sprite.update
+
+puts RubySprites::CSS.generate(sprite)
+RubySprites::CSS.generate(sprite, 'css/css.css')

data/examples/css/css_cli.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby
+
+current_dir = File.dirname(__FILE__)
+$:.unshift File.join(current_dir, '../../lib')
+
+require 'ruby_sprites/sprite'
+require 'ruby_sprites/css'
+
+if ARGV.length < 3
+  puts "Usage: ruby css_cli.rb repeat-type sprite_image.ext img1.ext [img2.ext] [...]"
+  puts "repeat-type may be 'default', 'vertical', or 'horizontal'"
+  puts "sprite_image.ext is the output sprite file"
+  exit
+end
+
+repeat = ARGV.shift
+sp_file = ARGV.shift
+
+options = {
+  :repeat => (repeat == 'default') ? false : repeat.to_sym,
+}
+
+sprite = RubySprites::Sprite.new(sp_file, '.', options)
+
+sprite.add_images(ARGV)
+
+sprite.update
+
+RubySprites::CSS.generate(sprite, "#{sp_file}.css")

data/examples/packing/packing.rb

@@ -0,0 +1,19 @@
+current_dir = File.dirname(__FILE__)
+
+$:.unshift File.join(current_dir, '../../lib')
+
+require 'ruby_sprites/sprite'
+
+
+pack_types = [:vertical_stack, :horizontal_stack, :vertical_smart, :horizontal_smart, :both_smart, :even, :ratio, :both_split, :vertical_split, :horizontal_split]
+
+pack_types = [:both_smart, :both_split, :vertical_split, :horizontal_split]
+
+pack_types.each do |pack|
+  sprite = RubySprites::Sprite.new("packing/#{pack.to_s}.png", current_dir + '/..', {:pack_type => pack, :force_update => true})
+  (1..60).each do |x|
+    sprite.add_image("example_imgs/#{x}.png")
+  end
+
+  sprite.update
+end

data/lash-sprites.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "lash-sprites/version"
+
+Gem::Specification.new do |s|
+  s.name        = "lash-sprites"
+  s.version     = Lash::Sprites::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Cullen Walsh", "Paul Alexander"]
+  s.email       = ["gems@appsinyourpants.com"]
+  s.homepage    = "https://github.com/appsinyourpants/lash-sprites"
+  s.summary = 'A library to ease the dynamic generation of CSS spritesfrom a list of images or a css file.  Supports multiple image libraries, including GD2 and ImageMagick, and multiple different packing algorithms.'
+
+  s.rubyforge_project = "lash-sprites"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+end

data/lib/lash-sprites/block.rb

@@ -0,0 +1,34 @@
+module RubySprites
+  class Block
+
+    attr_reader :x, :y, :width, :height
+
+    def initialize(x, y, width, height)
+      @x = x
+      @y = y
+      @width = width
+      @height = height
+    end
+
+    def fits?(img)
+      return img.width <= @width && img.height <= @height
+    end
+
+    def split(img)
+      blocks = []
+      if (@width - img.width) * img.height > (@height - img.height) * img.width
+        blocks.push Block.new(@x + img.width, @y, @width - img.width, @height) if @width != img.width
+        blocks.push Block.new(@x, @y + img.height, img.width, @height - img.height) if @height != img.height
+      else
+        blocks.push Block.new(@x + img.width, @y, @width - img.width, img.height) if @width != img.width
+        blocks.push Block.new(@x, @y + img.height, @width, @height - img.height) if @height != img.height
+      end
+      return blocks
+    end
+
+    def area
+      @area = @width * @height if @area.nil?
+      return @area
+    end
+  end
+end

data/lib/lash-sprites/css.rb

@@ -0,0 +1,27 @@
+require 'ruby_sprites/sprite'
+
+module RubySprites
+  class CSS
+
+    def self.generate(sprite, file = nil)
+      css = ''
+      css_template = ".%s {
+  background: url(%s) %dpx %dpx no-repeat;
+  height: %dpx;
+  width: %dpx;
+}\n\n"
+      sprite.images.each do |path, image|
+        class_name = path[0,path.rindex('.')].gsub('/','_')
+        css += sprintf(css_template, class_name, sprite.filename, -image.x, -image.y, image.height, image.width)
+      end
+
+      if file.nil?
+        return css
+      else
+        fp = File.open(sprite.file_root + file, 'w')
+        fp.write(css)
+        fp.close
+      end
+    end
+  end
+end

data/lib/lash-sprites/graphics_manager/gd2.rb

@@ -0,0 +1,43 @@
+require 'ruby_sprites/graphics_manager/graphics_manager'
+
+module RubySprites
+  module GraphicsManager
+    class Gd2 < GraphicsManager
+
+      DESCRIPTION = 'GD2'
+
+      def self.availible?
+        begin
+          require 'rubygems'
+          require 'gd2'
+        rescue LoadError
+          return false
+        end
+
+        return true
+      end
+
+      def combine(images, width, height)
+        image = GD2::Image.new(width, height)
+        images.each do |path, img|
+          next unless img.exists?
+          i = GD2::Image.import(@sprite.file_root + path)
+          w = width - img.x
+          w = img.width if img.width < w
+          h = height - img.y
+          h = img.height if img.height < h
+          image.copy_from(i, img.x, img.y, 0, 0, w, h)
+          i = nil
+        end
+        image.export(@sprite.image_file)
+      end
+
+      def get_info(path)
+        img = GD2::Image.import(@sprite.file_root + path)
+        info = {:width => img.width, :height => img.height}
+        img = nil
+        return info
+      end
+    end
+  end
+end

data/lib/lash-sprites/graphics_manager/graphics_manager.rb

@@ -0,0 +1,22 @@
+module RubySprites
+  module GraphicsManager
+    class GraphicsManager
+      
+      def initialize(sprite)
+        @sprite = sprite
+      end
+
+      def self.availible?
+        return false
+      end
+
+      def combine(images, width, height)
+        raise "Must be overridden"
+      end
+
+      def get_info(image)
+        raise "Must be overridden"
+      end
+    end
+  end
+end