gosu-spritesheet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f816d42837a8669558a069096ade4bf64d232df70079bbefdcb2c085aba8e5e8
+  data.tar.gz: 381319501277c0c07fa7cc47c891fc97226e9d32f0cac57adcdb0eb87af7a4cf
+SHA512:
+  metadata.gz: 007a14d835267d101a4cd70731a006582733c54db30572477b6322b785b3e0aee0bdeb81b2995da23382af5f2b79e85437c9ed7e4e81fc6e130b9166bce2de9b
+  data.tar.gz: 0b5810e298823daeabefd5aeda2d7cb2e13e7c8c0914c6054d92b055036a4e32a5f68b9ac34adb069aac2e3289665c0edd142950152fa5b383dee6bc16212da2

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 pogist
+
+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.md

@@ -0,0 +1,153 @@
+# Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gosu-spritesheet'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gosu-spritesheet
+
+# Usage
+
+### Creating a simple spritesheet animation
+
+```ruby
+require 'gosu'
+require 'gosu/spritesheet'
+
+class Game < Gosu::Window
+  def initialize
+    tiles = Gosu::Image.load_tiles 'path/to/your/tiles.png', 10, 10
+    @spritesheet = Gosu::Spritesheet.new { :tiles => tiles }
+  end
+
+  def draw
+    x, y, z = #...the position of your animation on screen.
+
+    # Just draws the next animation frame on each iteration.
+    @spritesheet.animation(:default).step.draw x, y, z
+  end
+end
+
+Game.new.show
+```
+
+### A more complex example using custom animations
+
+Consider that your game object may have more than one animation with different
+frames each, but those frames are on the same image. That way, you can define 
+different animations for each set of frames:
+
+```ruby
+require 'gosu'
+require 'gosu/spritesheet'
+
+class Character
+  # x, y, z are our character's initial position.
+  def initialize(x, y, z)
+    @x, @y, @z = x, y, z
+    tiles = Gosu::Image.load_tiles 'path/to/your/tiles.png', 10, 10
+    
+    # Suppose your tile has 8 frames.
+    #
+    # The first 4 frames are your character walking left.
+    # And the other 4 your character walking right.
+    @spritesheet = Gosu::Spritesheet.new({
+      :tiles => tiles,
+      :animations => {
+        # Here we are taking the first 4 frames as the walking left
+        # animation frames.
+        :walk_left => { range: [0..3], duration: 0.2 },
+        # The other 4 are the frames of walking right.
+        :walk_right => { range: [4..7], duration: 0.2 }
+      }
+    })
+
+    # By default our character starts facing left and stopped.
+    @move_direction = :left
+    @moving = false
+  end
+  
+  def draw
+    # Let's decide which animation to draw.
+    animation_key = @move_direction == :left ? :walk_left : :walk_right
+
+    if @moving
+      # If our character is moving let's animate it!
+      @spritesheet.animation(animation_key).step.draw @x, @y, @z
+    else
+      # When our character isn't moving let's just draw its stopped frame.
+      @spritesheet.animation(animation_key).stop.draw @x, @y, @z
+    end
+  end
+
+  def walk(direction, speed)
+    @moving = true
+    @x += direction == :right ? speed : -speed
+  end
+  
+  def stop_moving
+    @moving = false
+  end
+end
+```
+
+Now that we have our character class ready let's use it!
+
+```ruby
+class Game < Gosu::Window
+  def initialize
+    super 800, 600 
+    # Let's start our character at the center of the screen.
+    @char = Character.new 400, 300
+  end
+
+  def draw
+    @char.draw
+  end
+
+  def update
+    if pressing_right?
+      @char.walk :right, 2
+    end
+
+    if pressing_left?
+      @char.walk :left, 2
+    end
+  end
+
+  def button_up(id)
+    # When the user stops pressing any button let's tell our character to stop
+    # moving.
+    @char.stop_moving
+  end
+
+  # Let's define some helper functions
+  def pressing_right?
+    Gosu::button_down?(Gosu::KbRight) or Gosu::button_down?(Gosu::GpRight)
+  end
+
+  def pressing_left?
+    Gosu::button_down?(Gosu::KbLeft) or Gosu::button_down?(Gosu::GpLeft)
+  end
+end
+
+Game.new.show
+```
+
+That's it.
+
+## Contributing
+
+Just open a pull request. I'll read it, I promise.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/gosu-spritesheet.gemspec

@@ -0,0 +1,40 @@
+require File.expand_path("../lib/gosu/spritesheet/version.rb", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "gosu-spritesheet"
+  spec.version       = Gosu::Spritesheet.version
+  spec.authors       = ["pogist"]
+  spec.email         = ["murilo.paixao.2@gmail.com"]
+
+  spec.summary       = "Useful spritesheet extension for Gosu."
+  spec.description   = "A useful and yet simple spritesheet extension for Gosu."
+  spec.homepage      = "https://github.com/pogist/gosu-spritesheet"
+  spec.license       = "MIT"
+  spec.files         = Dir['lib/**/*.rb'] + [
+    "README.md",
+    "LICENSE.md",
+    "Rakefile",
+    "gosu-spritesheet.gemspec"
+  ]
+  spec.test_files = Dir['test/**/*.rb', 'test/*.rb']
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata = {
+      "homepage_uri" => spec.homepage,
+      "source_code_uri" => spec.homepage
+    }
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.add_dependency "gosu", "~> 0.14"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.3"
+  spec.add_development_dependency "byebug", "~> 10.0"
+end

data/lib/gosu/spritesheet.rb

@@ -0,0 +1,51 @@
+require "gosu/spritesheet/version"
+require "gosu/spritesheet/animation_block"
+
+module Gosu
+  class MissingAnimationKeys < StandardError; end
+  class UnknownAnimationKeys < StandardError; end
+
+  class Spritesheet
+    def initialize(tiles: [], animations: nil, duration: 0.2)
+      @tiles = tiles
+      @default_duration = duration
+      setup_animations(animations)
+    end
+
+    def animation(anim_key)
+      @animations[anim_key.to_sym]
+    end
+
+    private
+    def setup_animations(animations)
+      @animations = Hash.new
+
+      if animations.nil?
+        @animations[:default] = Gosu::AnimationBlock.new(
+          @tiles, 
+          @default_duration
+        )
+      else
+        animations.each do |key, value|
+          @animations[key] = animation_from_spec(value)
+        end
+      end
+    end
+
+    def animation_from_spec(spec)
+      frames_range = spec.fetch(:range, nil)
+      duration = spec.fetch(:duration, nil)
+
+      missing_keys = []
+      missing_keys << ":range" if frames_range.nil?
+      missing_keys << ":duration" if duration.nil?
+
+      if not missing_keys.empty?
+        message = "Missing #{missing_keys.join(' and ')} on block: #{spec}" 
+        raise MissingAnimationKeys, message
+      end
+
+      Gosu::AnimationBlock.new(@tiles[frames_range.first], duration)
+    end
+  end
+end

data/lib/gosu/spritesheet/animation_block.rb

@@ -0,0 +1,25 @@
+require 'gosu'
+
+module Gosu
+  class AnimationBlock
+    attr_reader :frames, :duration, :duration_in_millisecs
+
+    def initialize(frames, duration)
+      @frames = frames
+      @duration = duration
+      @duration_in_millisecs = @duration * 1000
+    end
+
+    ##
+    # Calculates the next animation frame.
+    #
+    def step
+      @frames[Gosu::milliseconds / @duration_in_millisecs % @frames.size]
+    end
+
+    def stop
+      # Just gets back to the first frame.
+      @frames[0]
+    end
+  end
+end

data/lib/gosu/spritesheet/version.rb

@@ -0,0 +1,7 @@
+module Gosu
+  class Spritesheet
+    def self.version
+      "0.1.0"
+    end
+  end
+end

data/test/gosu/animation_block_test.rb

@@ -0,0 +1,27 @@
+require "test_helper"
+require "gosu"
+
+describe Gosu::AnimationBlock do
+  let(:dude_tiles) { 
+    path = File.expand_path('../resources/dude.png', __FILE__)
+    Gosu::Image.load_tiles path, 32, 48 
+  }
+
+  before do
+    @animation = Gosu::AnimationBlock.new(dude_tiles, 0.2)
+  end
+
+  after do
+    @animation = nil
+  end
+
+  it "calculates the next animation frame" do
+    # When
+    next_frame = @animation.step
+
+    # Then
+    next_frame.must_equal dude_tiles[
+      Gosu::milliseconds / @animation.duration_in_millisecs % dude_tiles.size
+    ]
+  end
+end

data/test/gosu/spritesheet_test.rb

@@ -0,0 +1,117 @@
+require "test_helper"
+require "gosu"
+
+describe Gosu::Spritesheet do
+  let(:dude_tiles) { 
+    path = File.expand_path('../resources/dude.png', __FILE__)
+    Gosu::Image.load_tiles path, 32, 48 
+  }
+  
+  describe "when initialized from a tile set" do
+    describe "and a custom animation block is provided" do
+      let (:spritesheet) {
+        Gosu::Spritesheet.new({
+          :tiles => dude_tiles,
+          :animations => {
+            :my_custom_animation => { range: [0..3], duration: 0.3 }
+          }
+        })
+      }
+
+      it "must be able to fetch the custom animation" do
+        spritesheet.animation(:my_custom_animation).wont_be_nil
+        spritesheet.animation(:my_custom_animation).frames.must_equal dude_tiles[0..3]
+        spritesheet.animation(:my_custom_animation).duration.must_equal 0.3
+      end
+    end
+
+    describe "and no custom animation blocks are provided" do
+      let(:spritesheet) { Gosu::Spritesheet.new(:tiles => dude_tiles) }
+
+      it "has a default animation block that animates all tiles in sequence" do
+        spritesheet.animation(:default).wont_be_nil
+        spritesheet.animation(:default).frames.must_equal dude_tiles
+        spritesheet.animation(:default).duration.must_equal 0.2
+      end
+    end
+
+    describe "and a duration is provided for the default animation" do
+      let(:spritesheet) {
+        Gosu::Spritesheet.new({
+          :tiles => dude_tiles,
+          :duration => 1.0
+        })
+      }
+
+      it "must specify the default animation duration" do
+        spritesheet.animation(:default).duration.must_equal 1.0
+      end
+    end
+    
+    describe "and a animation block called default is provided" do
+      let(:spritesheet) { 
+        Gosu::Spritesheet.new({
+          :tiles => dude_tiles,
+          :animations => {
+            :default => { range: [0..3], duration: 0.3 }
+          }
+        })
+      }
+
+      # Default animation options set during `default`'s initialization
+      let(:default_frames) { dude_tiles }
+      let(:default_duration) { 0.2 }
+
+      it "wont override the new block called `default`" do
+        spritesheet.animation(:default).frames.wont_equal default_frames
+        spritesheet.animation(:default).duration.wont_equal default_duration
+      end
+    end
+
+    describe "and a custom animation block is in a completely wrong format" do
+      let(:spritesheet) {
+        Gosu::Spritesheet.new({
+          :tiles => dude_tiles,
+          :animations => {
+            :my_custom_animation => { frames: [0..3], anim_duration: 0.2 }
+          }
+        })
+      }
+
+      it "must raise that both keys are missing" do
+        error = proc { spritesheet }.must_raise Gosu::MissingAnimationKeys
+        error.message.must_match(/Missing :range and :duration on block:/)
+      end
+    end
+
+    describe "and a custom animation block is missing one key" do
+      let(:missing_range) {
+        Gosu::Spritesheet.new({
+          :tiles => dude_tiles,
+          :animations => {
+            :my_custom_animation => { duration: 0.2 }
+          }
+        })
+      }
+
+      let(:missing_duration) {
+        Gosu::Spritesheet.new({
+          :tiles => dude_tiles,
+          :animations => {
+            :my_custom_animation => { range: [0..3] }
+          }
+        })
+      }
+
+      it "must say that range key is missing" do
+        error = proc { missing_range }.must_raise Gosu::MissingAnimationKeys
+        error.message.must_match(/Missing :range on block:/)
+      end
+
+      it "must say that duration key is missing" do
+        error = proc { missing_duration }.must_raise Gosu::MissingAnimationKeys
+        error.message.must_match(/Missing :duration on block:/)
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "gosu/spritesheet"
+
+require "minitest/autorun"
+require "minitest/reporters"
+
+Minitest::Reporters.use! [Minitest::Reporters::ProgressReporter.new(:color => true)]
+

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: gosu-spritesheet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pogist
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gosu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A useful and yet simple spritesheet extension for Gosu.
+email:
+- murilo.paixao.2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- gosu-spritesheet.gemspec
+- lib/gosu/spritesheet.rb
+- lib/gosu/spritesheet/animation_block.rb
+- lib/gosu/spritesheet/version.rb
+- test/gosu/animation_block_test.rb
+- test/gosu/spritesheet_test.rb
+- test/test_helper.rb
+homepage: https://github.com/pogist/gosu-spritesheet
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pogist/gosu-spritesheet
+  source_code_uri: https://github.com/pogist/gosu-spritesheet
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Useful spritesheet extension for Gosu.
+test_files:
+- test/gosu/spritesheet_test.rb
+- test/gosu/animation_block_test.rb
+- test/test_helper.rb