aniruby 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f06e5010221982c6ac29ff4f0670f1315236397182aa8df23bbc199b411f959
-  data.tar.gz: 06752b16a07eae712c689130ac7bfaf41b433a6fc18a2bc26339a6fbba0c14eb
+  metadata.gz: 361fe4d0f4dddeca7090d35a7bb225440fd51c94c69d5b7ea0a0be8826437340
+  data.tar.gz: afb5d871c301e09df8559cd66e2609c408e810f9f3d48e68adaf851569f19a4b
 SHA512:
-  metadata.gz: 07dfe64289a335ffc010d07eb7596e8cdea2cdb55084e81a2d789045bb7b3be59471dcc8a8735aee5e5f11ece070566c8ebf05d1e9bf2aadd3af31603c691b7b
-  data.tar.gz: a47f0888419c88b9ea73d742f283894a0fbb07c8d1bebd9c8bd5fc1a9db367bf16d9da62ab434a6e1afc3f44fd4ad97c8527b05eeb787bc0f298a01d43d4e6a1
+  metadata.gz: 9a1d8d7b7c1fabdde8b84c68199463af199ed6bfdf7e5f7e7b684f5fc5a9abba315095655bb22904be5eb29c61877c4ae6f5f348a29971b2103e739506a6950f
+  data.tar.gz: d79b9b2f63047cad421027880c40723472a22fcf4f13e0444a4da89cb99aab772fc8eff1d1cacabb6c38ce568dd6276651f6d9b1d5b9fbf10cb738d19320b454

data/CHANGELOG.md

@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 0.2.0 - 2023-09-02
+
+This release brings mostly improvements and fixes, however there's not that much
+new features yet.
+
+### Added
+
+- aliased `Animation#width` and `Animation#height` to `w` and `h` respectively, the same was done
+for `Frame`.
+
+### Changed
+
+- `Animation#get_current_frame` is now `Animation#current_frame` as to not be redundant. Following that now `Animation#current_frame`(The accessor for the instance variable) is renamed to `Animation#position`.
+
+### Fixed
+
+- Previously methods like `Animation#done?` or `Animation#resume` didn't return `self`, so it wasn't possible to chaint them like this
+  ```ruby
+  # Example
+  my_animation.pause.resume.duration(200)
+  ```
+  now they do so you can do that.
+
 ## 0.1.3 - 2023-08-22
 
 ### Fixed
@@ -23,18 +46,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Downcased the gem name in the gemspec
+- Downcased the gem name in the gemspec.
 
 ## 0.1.1 - 2023-08-20
 
 ### Added
 
-- Add .yardopts to included files
+- Add .yardopts to included files.
 
 ### Fixed
 
-- Required ruby not being used correctly in gemspec
+- Required ruby not being used correctly in gemspec.
 
 ## 0.1.0 - 2023-08-20
 
-Initial release
+Initial release.

data/README.md

@@ -1,6 +1,6 @@
 # AniRuby
 
-[![Gem Version](https://badge.fury.io/rb/aniruby.svg)](https://badge.fury.io/rb/aniruby)
+![Gem (including prereleases)](https://img.shields.io/gem/v/aniruby?style=flat-square&color=blue)
 
 Make sprite animations on Gosu simple and easy.
 
@@ -71,9 +71,9 @@ spritesheet will be divided like this:
 
 ![example spritesheet quads](assets/example_spritesheet_quads.png)
 
-That is the bare minimum, to get an animation, of course you can use Gosu's retro
-option so pixel animations when scaled will still look crisp, looping or the duration
-of the animation (or for every individual frame even!).
+That's the bare minimum to get an animation, of course you can enable Gosu's retro
+option so pixel animations will still look crisp when scaled, enable looping or specify
+the duration of the animation (or for every frame even!).
 
 In the example above we initialize the animation with retro off, looping on and
 with a duration of 0.15 (150ms) for every frame. So we'll get something like this:
@@ -84,7 +84,7 @@ Ain't that nice?
 
 ### Drawing
 
-You can draw an animation like any other `Gosu::Image`! Sn animation has both
+You can draw an animation like any other `Gosu::Image`! An animation has both
 `Animation#draw` and `Animation#draw_rot`, these methods mimic the ones on Gosu, so you don't
 have to learn anything new.
 
@@ -114,4 +114,4 @@ Then you can use rake to build or test gem.
 
 ## License
 
-[MIT](LICENSE)
+This library is licensed under the [MIT](LICENSE) license.

data/Rakefile

@@ -1,6 +1,6 @@
 
 require 'fileutils'
-require "minitest/test_task"
+require 'minitest/test_task'
 
 require_relative 'lib/aniruby/version'
 

data/lib/aniruby/animation.rb

@@ -6,8 +6,8 @@ module AniRuby
     # @return [AniRuby::Frames] The collection of frames this animation uses
     attr_accessor :frames
     # @return [Integer] The current frame index of the animation
-    attr_accessor :current_frame
-    # @return [Boolean] The loop status of the animation
+    attr_accessor :position
+    # @return [Boolean] The loop parameter
     attr_accessor :loop
 
     # Create a new animation
@@ -22,15 +22,18 @@ module AniRuby
     #                              provided they will be mapped to each frame of the
     #                              animation. The default for each frame is 0.1.
     #
-    #
     # @return [Animation] A new animation ready to play
-    def initialize(spritesheet, frame_w, frame_h, retro = false, loop = true, *durations)
+    def initialize(spritesheet,
+                   frame_w, frame_h,
+                   retro = false,
+                   loop = true,
+                   *durations)
       @frame_w = frame_w
       @frame_h = frame_h
 
       @loop = loop
 
-      @current_frame = 0
+      @position = 0
       @pause = false
 
       @frames = AniRuby::Frames.new(Gosu::Image.load_tiles(spritesheet,
@@ -55,22 +58,26 @@ module AniRuby
     #
     # @return [Integer]
     def width
-      @frames[@current_frame].sprite.width
+      @frames[@position].width
     end
 
+    alias :w :width
+
     # Get the height of the current frame's image
     #
     # @return [Integer]
     def height
-      @frames[@current_frame].sprite.height
+      @frames[@position].height
     end
 
+    alias :h :height
+
     # Update the animation, advancing the frame counter. Note that this won't do
     # do anything if the animation is paused or has finished
     def update
       return if done? || paused?
 
-      @current_frame += 1 if frame_expired?
+      @position += 1 if frame_expired?
     end
 
     # Draw the animation
@@ -93,7 +100,7 @@ module AniRuby
 
       frame.sprite.draw(x, y, z, scale_x, scale_y, color, mode)
 
-      @current_frame = 0 if @loop && done?
+      @position = 0 if @loop && done?
     end
 
     # Draw the animation rotated, with its rotational center at (x, y).
@@ -123,7 +130,7 @@ module AniRuby
       frame.sprite.draw_rot(x, y, z, angle, center_x, center_y, scale_x, scale_y, color, mode)
 
       # Loop the animation
-      @current_frame = 0 if @loop && done?
+      @position = 0 if @loop && done?
     end
 
     # Pause the animation
@@ -131,6 +138,8 @@ module AniRuby
     # (see {resume})
     def pause
       @pause = true
+
+      self
     end
 
     # Resume the animation
@@ -138,18 +147,24 @@ module AniRuby
     # (see {pause})
     def resume
       @pause = false
+
+      self
     end
 
     # Set the animation to the beginning frame
     def reset
-      @current_frame = 0
+      @position = 0
+
+      self
     end
 
     # Set the duration for all frames in the animation
     #
     # @param ms [Float] The new duration in milliseconds
     def duration(ms)
-      @frames.each { |frame| frame.duration = ms}
+      @frames.each { |frame| frame.duration = ms }
+
+      self
     end
 
     # Is the animation finished?
@@ -157,7 +172,9 @@ module AniRuby
     # @return [Boolean]
     # @note This method will return true in intervals if the animation loops
     def done?
-      true if @current_frame == @frames.count - 1
+      true if @position == @frames.count - 1
+
+      false
     end
 
     # Is the animation paused?
@@ -172,8 +189,8 @@ module AniRuby
     # Get the current frame
     #
     # @return [AniRuby::Frame]
-    def get_current_frame
-      @frames[@current_frame % @frames.count]
+    def current_frame
+      @frames[@position % @frames.count]
     end
 
     # Has the current frame's duration expired?
@@ -181,7 +198,7 @@ module AniRuby
       now = Gosu.milliseconds / 1000.0
       @last_frame ||= now
 
-      if (now - @last_frame) > @frames[@current_frame].duration
+      if (now - @last_frame) > @frames[@position].duration
         @last_frame = now
       end
     end

data/lib/aniruby/frame.rb

@@ -3,8 +3,17 @@ module AniRuby
   # A frame has a sprite that's Gosu::Image and a duration specified in
   # milliseconds
   class Frame
-    attr_accessor :duration, :sprite
-    attr_reader :w, :h
+    # @return [Float]
+    attr_accessor :duration
+
+    # @return [Gosu::Image]
+    attr_accessor :sprite
+
+    # @return [Integer]
+    attr_reader :width, :height
+
+    alias :w :width
+    alias :h :height
 
     # Create a new frame
     #
@@ -16,8 +25,8 @@ module AniRuby
       @sprite = sprite
       @duration = duration
 
-      @w = @sprite.width
-      @h = @sprite.height
+      @width = @sprite.width
+      @height = @sprite.height
     end
   end
 end

data/lib/aniruby/version.rb

@@ -1,8 +1,8 @@
 
 module AniRuby
   MAJOR = 0
-  MINOR = 1
-  PATCH = 3
+  MINOR = 2
+  PATCH = 0
 
   # See https://semver.org/
   VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}".freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aniruby
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Chadow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-22 00:00:00.000000000 Z
+date: 2023-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.17.0
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
 description: |
   Library for painless sprite animations on Gosu, with a easy
   and nifty API, made in pure Ruby with no dependencies at all!
@@ -74,7 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- Gosu installed and working
 rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4