rmagick-sprite 0.0.4

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ruby-1.9.3@rmagick-sprite

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    rmagick-sprite (0.0.3)
+      dsl (~> 0.2.2)
+      rmagick (~> 2.13.1)
+      version (~> 1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    dsl (0.2.2)
+      version (~> 1.0.0)
+    rmagick (2.13.1)
+    version (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rmagick-sprite!

data/README.md

@@ -0,0 +1,66 @@
+# RMagick-Sprite
+
+## Example
+
+In this example, I have one character printed on one spritesheet with only one line of 
+evenly spaced/sized sprites.
+
+Here it is:
+
+[Example Spritesheet](http://cl.ly/image/2k320Z2X231T)
+
+```ruby
+sprite = Sprite.new do
+  filename 'foo/bar/character_spritesheet.png'
+  
+  # The default action that the Sprite will use
+  default_action :standing
+  
+  # These options will be reverse-merged into each frame
+  default_frame_options width: 16, height: 25, y: 0
+  
+  standing do
+    frame x: 16 * 1 # Frame 1
+    # x: 0, y: 0 is the top-left corner..
+    # I'm lazy, so I'm just taking the default_frame_options width and multiplying it by the 
+    # frame index to calculate the x coordinate.
+  end
+  
+  walking do
+    frame x: 16 * 0 # Frame 1
+    frame x: 16 * 1 # Frame 2
+    frame x: 16 * 2 # Frame 3
+    frame x: 16 * 1 # Frame 4
+  end
+  
+  running do
+    frame x: 16 * 3 # Frame 1
+    frame x: 16 * 4 # Frame 2
+    frame x: 16 * 5 # Frame 3
+    frame x: 16 * 4 # Frame 4
+  end
+end
+
+# Standing only has one frame so next_image will loop over the same frame
+p sprite.next_image # => Second Image (Magick::Image) same as: sprite.next_frame.image
+p sprite.next_image # => Second Image
+
+sprite.action = :walking
+
+# Here, we loop through the walking animation.. pump these images right into Gosu or your favorite gaming library
+p sprite.next_image # => First Image
+p sprite.next_image # => Second Image
+p sprite.next_image # => Third Image
+p sprite.next_image # => Second Image
+p sprite.next_image # => First Image
+
+# Save each action's frame as a separate image
+sprite.actions.each do |action_name, action|
+  action.frames.each_with_index do |frame, index|
+    frame.image.write "foo/bar/#{action_name}_#{index}.png"
+  end
+end
+
+# Saving an action as a gif (note: looks wonky with transparent backgrounds)
+sprite.actions[:running].write 'foo/bar/running.gif'
+```

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rake/version_task'
+require 'rubygems/package_task'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'rmagick-sprite'
+  s.author = 'Ryan Scott Lewis'
+  s.email = 'ryan@rynet.us'
+  
+  s.homepage = "http://github.com/c00lryguy/#{s.name}"
+  s.description = 'Encapsulates a "Sprite" in RMagick.'
+  s.summary = 'Slice up spritesheets into Objects and export as images/animations or use with your favorite gaming library.'
+  s.version = File.read( File.expand_path('./VERSION') )
+  
+  s.require_path = 'lib'
+  s.files = `git ls-files`.lines.collect { |line| line.strip }
+  s.executables = Dir['bin/*'].find_all { |file| File.executable?(file) }.collect { |file| File.basename(file) }
+  
+  s.add_dependency('rmagick', '~> 2.13.1')
+  s.add_dependency('version', '~> 1.0')
+  s.add_dependency('dsl', '~> 0.2.2')
+end
+
+Rake::VersionTask.new do |t|
+  t.with_git_tag = true
+  t.with_gemspec = spec
+end
+
+
+Gem::PackageTask.new(spec) do |t|
+  t.need_zip = true
+  t.need_tar = true
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/lib/sprite/action.rb

@@ -0,0 +1,69 @@
+class Sprite
+  
+  class Action
+    class DSL < ::DSL
+      def frame(options)
+        @parent.add_frame(options)
+      end
+    end
+    
+    attr_reader :sprite, :frames
+    attr_accessor :current_index
+    
+    def initialize(options, &blk)
+      raise 'options must be a Hash' unless options.respond_to?(:to_hash) || options.respond_to?(:to_h)
+      options = options.to_hash rescue options.to_h
+      
+      raise 'options[:sprite] must be given' if options[:sprite].nil?
+      raise 'options[:sprite] must be a Sprite' unless options[:sprite].instance_of?(Sprite)
+      
+      @sprite = options[:sprite]
+      @current_index, @frames = 0, []
+      
+      DSL.call(self, &blk)
+    end
+    
+    def add_frame(options)
+      raise 'options must be a Hash' unless options.respond_to?(:to_hash) || options.respond_to?(:to_h)
+      options = options.to_hash rescue options.to_h
+      options = { action: self }.merge(@sprite.default_frame_options).merge(options)
+      @frames << Frame.new(options)
+    end
+        
+    def current_frame
+      @frames[@current_index]
+    end
+    
+    def current_image
+      current_frame.image
+    end
+    
+    def increase_index
+      @current_index += 1
+      @current_index = 0 if @current_index >= @frames.length
+    end
+    
+    def next_frame
+      increase_index
+      current_frame
+    end
+    
+    def next_image
+      increase_index
+      current_image
+    end
+    
+    def write(filename, &blk)
+     image_list = Magick::ImageList.new
+     @frames.each do |frame|
+       image = frame.image
+       image_list << image
+     end
+     
+     blk.call(image_list) if block_given?
+     
+     image_list.write(filename)
+    end
+  end
+  
+end

data/lib/sprite/frame.rb

@@ -0,0 +1,37 @@
+class Sprite
+  
+  class Frame
+    attr_reader :sprite, :action, :x, :y, :width, :height
+    
+    def initialize(options)
+      raise 'options must be a Hash' unless options.respond_to?(:to_hash) || options.respond_to?(:to_h)
+      options = options.to_hash rescue options.to_h
+      
+      raise 'options[:action] must be given' if options[:action].nil?
+      raise 'options[:action] must be an Action' unless options[:action].instance_of?(Action)
+      raise 'options[:x] must be given' if options[:x].nil?
+      raise 'options[:x] must be a Integer-like object' unless options[:x].respond_to?(:to_i)
+      raise 'options[:y] must be given' if options[:y].nil?
+      raise 'options[:y] must be a Integer-like object' unless options[:y].respond_to?(:to_i)
+      raise 'options[:width] must be given' if options[:width].nil?
+      raise 'options[:width] must be a Integer-like object' unless options[:width].respond_to?(:to_i)
+      raise 'options[:height] must be given' if options[:height].nil?
+      raise 'options[:height] must be a Integer-like object' unless options[:height].respond_to?(:to_i)
+      
+      @action = options[:action]
+      @x, @y, @width, @height = options.values_at(:x, :y, :width, :height).collect(&:to_i)
+      @sprite = @action.sprite
+    end
+    
+    def image
+      reload if @image.nil?
+      
+      @image
+    end
+    
+    def reload
+      @image = @sprite.image.excerpt(@x, @y, @width, @height)
+    end
+  end
+  
+end

data/lib/sprite.rb

@@ -0,0 +1,108 @@
+require 'pathname'
+require 'bundler/setup'
+require 'dsl'
+require 'rmagick'
+
+Dir[ Pathname(__FILE__).join('..', 'sprite', '**', '*.rb').expand_path ].each { |filename| require(filename) }
+
+class Sprite
+  class DSL < ::DSL
+    def_dsl_delegator :filename, :default_action, :default_action_options, :default_frame_options
+    
+    def method_missing(meth, options={}, &blk)
+      @parent.add_action(meth, options, &blk)
+    end
+  end
+  
+  attr_reader :actions, :action, :filename
+  attr_reader :default_action, :default_action_options, :default_frame_options
+  
+  def initialize(&blk)
+    @actions, @default_action_options, @default_frame_options = {}, {}, {}
+    
+    DSL.call(self, &blk)
+  end
+  
+  def filename=(filename)
+    raise 'filename must be a String-like object' unless filename.respond_to?(:to_s)
+    filename = filename.to_s
+    raise 'filename must not be empty' if filename.empty?
+    raise "file '#{filename}' does not exist" unless File.exist?(filename)
+    
+    @filename = filename
+    reload
+    
+    @filename
+  end
+    
+  def default_action_options=(options)
+    raise 'options must be a Hash-like object' unless options.respond_to?(:to_h) || options.respond_to?(:to_hash)
+      
+    @default_action_options = options.to_hash rescue options.to_h
+  end
+    
+  def default_frame_options=(options)
+    raise 'options must be a Hash-like object' unless options.respond_to?(:to_h) || options.respond_to?(:to_hash)
+      
+    @default_frame_options = options.to_hash rescue options.to_h
+  end
+  
+  def default_action=(action)
+    raise 'action must be a Symbol-like object' unless action.respond_to?(:to_sym)
+      
+    @default_action = action.to_sym
+  end
+  
+  def action=(action_name)
+    raise 'action_name must be a Symbol-like object' unless action_name.respond_to?(:to_sym)
+    action_name = action_name.to_sym
+    raise 'action does not exist' unless @actions.has_key?(action_name)
+    
+    @action = @actions[action_name]
+    @action.current_index = 0
+    
+    @action
+  end
+  
+  def action
+    @action ||= @actions[@default_action]
+  end
+  
+  def add_action(name, options={}, &blk)
+    raise 'options must be a Hash' unless options.respond_to?(:to_hash) || options.respond_to?(:to_h)
+    options = options.to_hash rescue options.to_h
+    options = { sprite: self }.merge(@default_action_options).merge(options)
+      
+    @actions[name] = Action.new(options, &blk)
+  end
+  
+  def image
+    raise 'filename must be set' if @filename.nil?
+    reload if @image.nil?
+    
+    @image
+  end
+    
+  def reload
+    @image = Magick::Image.read(@filename).first
+    @actions.each { |name, action| action.frames.each(&:reload) }
+    
+    @image
+  end
+  
+  def current_frame
+    action.current_frame
+  end
+  
+  def current_image
+    action.current_image
+  end
+  
+  def next_frame
+    action.next_frame
+  end
+  
+  def next_image
+    action.next_image
+  end
+end

data/rmagick-sprite.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "rmagick-sprite"
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Scott Lewis"]
+  s.date = "2012-11-05"
+  s.description = "Encapsulates a \"Sprite\" in RMagick."
+  s.email = "ryan@rynet.us"
+  s.files = [".rvmrc", "Gemfile", "Gemfile.lock", "README.md", "Rakefile", "VERSION", "lib/sprite.rb", "lib/sprite/action.rb", "lib/sprite/frame.rb", "rmagick-sprite.gemspec"]
+  s.homepage = "http://github.com/c00lryguy/rmagick-sprite"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Slice up spritesheets into Objects and export as images/animations or use with your favorite gaming library."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rmagick>, ["~> 2.13.1"])
+      s.add_runtime_dependency(%q<version>, ["~> 1.0"])
+      s.add_runtime_dependency(%q<dsl>, ["~> 0.2.2"])
+    else
+      s.add_dependency(%q<rmagick>, ["~> 2.13.1"])
+      s.add_dependency(%q<version>, ["~> 1.0"])
+      s.add_dependency(%q<dsl>, ["~> 0.2.2"])
+    end
+  else
+    s.add_dependency(%q<rmagick>, ["~> 2.13.1"])
+    s.add_dependency(%q<version>, ["~> 1.0"])
+    s.add_dependency(%q<dsl>, ["~> 0.2.2"])
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: rmagick-sprite
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Scott Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dsl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+description: Encapsulates a "Sprite" in RMagick.
+email: ryan@rynet.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- lib/sprite.rb
+- lib/sprite/action.rb
+- lib/sprite/frame.rb
+- rmagick-sprite.gemspec
+homepage: http://github.com/c00lryguy/rmagick-sprite
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1641621572133305106
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Slice up spritesheets into Objects and export as images/animations or use
+  with your favorite gaming library.
+test_files: []