aniruby 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07c57ae1df17b975510ec7c10d3e92f5d3de577a3e59d90fa1237e3b25b9cb8a
-  data.tar.gz: f6e1cef73f7016f0c1438720b94250ca0be9f57ffc837241af09d7445a7dbc22
+  metadata.gz: 91784f282491084327d6f2317ad87316de4eae20a1bd06a4c63cebb56eb8a159
+  data.tar.gz: 5425f60a700e2ab366a15583c5bf3860f3bd7ff5cf540d45a21cfd7e4176b44b
 SHA512:
-  metadata.gz: 7de44afd2d12a498a42ff63bd48ccfecce6a69ede7b22c0a8e4cf0df4b58898de45de19aec652c28dc84fadcfe9d525bc6677d1466b4cfd4c5cea60ab17f74f8
-  data.tar.gz: d6cc64703ade970bda443b91a15c400f510d102d8d6371dad2c559806f6e019b2150829d9fa004663e52c5141377f1d2436b4e81a94bcc778cda608869f3b781
+  metadata.gz: 40b40a12aad67d97800e999db54887428c89314b35a2aa2a6102fbcdbc544b8cfa5079bc21b2e9b2be3397862e729d676bdb1ba456b9ffdaae6e1ec1d3b05325
+  data.tar.gz: f37a4474aecf9e50c87e8340a218ba4845ba2900b0a3b4b5874b8b79db73d18897a315567e9402173e47aa1931380ef9208831f52d603525f689f40e1b5629f1

data/CHANGELOG.md

@@ -7,7 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
-## 0.2.1 - 2023-09-07
+## [0.2.2] - 2023-12-27
+
+### Added
+
+- Aliased `Animation#reset` to `Animation#reset!`.
+
+### Changed
+
+- Arguments `retro` and `loop` from `Animation#new` are now keyword arguments.
+- Renamed "position" attribute from `Animation` to "cursor".
+- Passing a negative value as duration to `Animation#new` will default to 0.1.
+
+## [0.2.1] - 2023-09-07
 
 ### Fixed
 
@@ -18,12 +30,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **Important**: There was a error in `Animation#done?` too, where it'll return `false` always    
   independently of if the animation was finished, this was because I forgot to add a `return` in
   the condition check for the `true`.
-- `Animation#update` now resets the animation, instead of `Animation#draw`  
-or `Animation#draw_rot` (I know, that sounds unintuitive). This (I think) fixes a precision problem when drawing the last frame
+- Internally, `Animation#update` now resets the animation, instead of `Animation#draw`  
+or `Animation#draw_rot` (I know, that sounds counterintuitive). This (I think) fixes a precision problem when drawing the last frame
 of an animation, in the which it was drawn for less time than required.
 
-
-## 0.2.0 - 2023-09-02
+## [0.2.0] - 2023-09-02
 
 This release brings mostly improvements and fixes, however there's not that much
 new features yet.
@@ -39,7 +50,7 @@ for `Frame`.
 
 ### Fixed
 
-- Previously methods like `Animation#done?` or `Animation#resume` didn't return `self`, so it wasn't possible to chaint them like this
+- Previously methods like `Animation#pause?` or `Animation#resume` didn't return `self`, so it wasn't possible to chain them like this
   ```ruby
   # Example
   my_animation.pause.resume.duration(200)
@@ -58,13 +69,13 @@ for `Frame`.
 - The way milliseconds are used as duration, before you'll have to use whole numbers
   (1000 is a second, 500 half a second and so on), now we can just use floats for that (1.0 as a second, 0.5 half a second and so on).
 
-## 0.1.2 - 2023-08-20
+## [0.1.2] - 2023-08-20
 
 ### Changed
 
 - Downcased the gem name in the gemspec.
 
-## 0.1.1 - 2023-08-20
+## [0.1.1] - 2023-08-20
 
 ### Added
 
@@ -74,6 +85,15 @@ for `Frame`.
 
 - Required ruby not being used correctly in gemspec.
 
-## 0.1.0 - 2023-08-20
+## [0.1.0] - 2023-08-20
 
 Initial release.
+
+[unreleased]: https://github.com/Chadowo/aniruby/compare/v0.2.2...HEAD
+[0.2.2]: https://github.com/Chadowo/aniruby/compare/v0.2.1...v0.2.2
+[0.2.1]: https://github.com/Chadowo/aniruby/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/Chadowo/aniruby/compare/v0.1.3...v0.2.0
+[0.1.3]: https://github.com/Chadowo/aniruby/compare/v0.1.2...v0.1.3
+[0.1.2]: https://github.com/Chadowo/aniruby/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/Chadowo/aniruby/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/Chadowo/aniruby/releases/v0.1.0

data/README.md

@@ -1,8 +1,8 @@
 # AniRuby
 
-![Gem (including prereleases)](https://img.shields.io/gem/v/aniruby?style=flat-square&logo=rubygems&logoColor=white&color=blue)
+![Gem (including prereleases)](https://img.shields.io/gem/v/aniruby?style=flat-square&logo=rubygems&logoColor=white&color=blue) ![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/chadowo/aniruby/minitest.yml?style=flat-square&logo=github&label=minitest&link=https%3A%2F%2Fgithub.com%2FChadowo%2Faniruby%2Factions%2Fworkflows%2Fminitest.yml) ![GitHub](https://img.shields.io/github/license/chadowo/aniruby?style=flat-square)
 
-Make sprite animations on Gosu simple and easy.
+Make sprite animations on Gosu, simply and easily.
 
 ## Summary
 
@@ -10,13 +10,15 @@ This library will provide you with a nice n easy interface to do sprite animatio
 on [Gosu](https://www.libgosu.org/), while being as nifty and simple as possible.
 
 The library is made in pure Ruby with no dependencies at all (except Gosu, of course) so
-its quite lightweight.
+it's quite lightweight.
 
 ## Install
 
 You can install the gem with the following command:
 
-`gem install aniruby`
+```console
+gem install aniruby
+```
 
 or use it with a bundle:
 
@@ -40,8 +42,7 @@ class MyWindow < Gosu::Window
     super(800, 600, false)
 
     @animation = AniRuby::Animation.new('my_spritesheet.png', 32, 32,
-                                        false, true,
-                                        0.15)
+                                        0.15, retro: false, loop: true)
   end
 
   def update
@@ -92,17 +93,29 @@ have to learn anything new.
 
 Each `Animation` has extra helpful methods, like `pause` & `unpause`, `reset`,
 `done?`, etc. I recommend you to look on the source, its pretty small and easy to
-understand, or build the YARD documentation with
+understand, or build the YARD documentation with:
 
-`rake doc`
+```console
+rake doc
+```
 
 ## Development
 
+### Setup
+
 First clone this repo locally:
 
-`git clone https://github.com/Chadowo/aniruby`
+```console
+git clone https://github.com/Chadowo/aniruby
+```
+
+Next you'll need to install the development dependencies of this gem with
+`bundle install`, Then you can use `rake` to build or test the gem.
+
+### Testing
 
-Then you can use rake to build or test gem.
+[Minitest](https://github.com/minitest/minitest) is used to unit test this gem.
+To run the tests just call `rake`.
 
 ## Roadmap
 

data/Rakefile

@@ -1,5 +1,4 @@
-
-require 'fileutils'
+require 'bundler/gem_tasks'
 require 'minitest/test_task'
 
 require_relative 'lib/aniruby/version'
@@ -8,25 +7,6 @@ Minitest::TestTask.create
 
 task :default => :test
 
-desc 'Build the gem'
-task :build do
-  Dir.mkdir('pkg') unless Dir.exist?('pkg')
-
-  sh 'gem build aniruby.gemspec'
-
-  FileUtils.mv("aniruby-#{AniRuby::VERSION}.gem", 'pkg')
-end
-
-desc 'Clean the build enviroment'
-task :clean do
-  FileUtils.rm_rf('pkg')
-end
-
-desc 'Push the gem to RubyGems'
-task :push do
-  sh "gem push pkg/aniruby-#{AniRuby::VERSION}.gem"
-end
-
 desc 'Use YARD to generate documentation'
 task :doc do
   sh 'yardoc'

data/lib/aniruby/animation.rb

@@ -1,4 +1,3 @@
-
 module AniRuby
   # Has a AniRuby::Frames colletion, with a simple counter to keep track of
   # current frame plus looping and pausing functionality
@@ -6,7 +5,7 @@ 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 :position
+    attr_accessor :cursor
     # @return [Boolean] The loop parameter
     attr_accessor :loop
 
@@ -15,32 +14,37 @@ module AniRuby
     # @param spritesheet [String] Path to the spritesheet file
     # @param frame_w [Integer] The width of each individual frame
     # @param frame_h [Integer] The height of each individual frame
-    # @param retro [Boolean] If true, the animation will not be interpolated when scaled
-    # @param loop [Boolean] If true, the animation will loop indefinitely
     # @param durations [Float] The duration of the frames in MS (0.5 is half a second,
     #                              1.0 a second, etc). If there's more than one duration
     #                              provided they will be mapped to each frame of the
     #                              animation. The default for each frame is 0.1.
+    #                              If the value is negative it'll default to 0.1.
+    # @param retro [Boolean] If true, the animation will not be interpolated when scaled
+    # @param loop [Boolean] If true, the animation will loop indefinitely
     #
     # @return [Animation] A new animation ready to play
     def initialize(spritesheet,
                    frame_w, frame_h,
-                   retro = false,
-                   loop = true,
-                   *durations)
+                   *durations,
+                   retro: false,
+                   loop: true)
       @frame_w = frame_w
       @frame_h = frame_h
 
       @loop = loop
-
-      @position = 0
       @pause = false
 
+      @cursor = 0
+      @step = 1
+
       @frames = AniRuby::Frames.new(Gosu::Image.load_tiles(spritesheet,
                                                            @frame_w,
                                                            @frame_h,
                                                            retro: retro))
 
+      # Default to 0.1 if the duration is negative
+      durations.map! { |dur| dur.negative? ? 0.1 : dur }
+
       # TODO: Maybe I could shorten this, adding an extra argument to
       #       AniRuby::Frames
       if durations.one?
@@ -58,19 +62,21 @@ module AniRuby
     #
     # @return [Integer]
     def width
-      @frames[@position].width
+      @frames[@cursor].width
     end
 
-    alias :w :width
+    alias w width
 
     # Get the height of the current frame's image
     #
     # @return [Integer]
     def height
-      @frames[@position].height
+      @frames[@cursor].height
     end
 
-    alias :h :height
+    alias h height
+
+    # @!group Drawing
 
     # Update the animation, advancing the frame counter. Note that this won't do
     # do anything if the animation is paused or has finished
@@ -78,9 +84,9 @@ module AniRuby
       return unless frame_expired? && !paused?
 
       if !done?
-        @position += 1
+        @cursor += @step
       elsif done? && @loop
-        @position = 0
+        @cursor = 0
       end
     end
 
@@ -94,13 +100,13 @@ module AniRuby
     # @param color [Gosu::Color] The color to usw when drawing
     # @param mode [:default, :additive] The blending mode
     #
-    # (see {draw_rot})
+    # (see also {draw_rot})
     def draw(x, y, z = 0,
              scale_x = 1,
              scale_y = 1,
              color = Gosu::Color::WHITE,
              mode = :default)
-      frame = @frames[@position]
+      frame = @frames[@cursor]
 
       frame.sprite.draw(x, y, z, scale_x, scale_y, color, mode)
     end
@@ -118,7 +124,7 @@ module AniRuby
     # @param color [Gosu::Color] The color to usw when drawing
     # @param mode [:default, :additive] The blending mode
     #
-    # (see {draw})
+    # (see also {draw})
     def draw_rot(x, y, z = 0,
                  angle = 0,
                  center_x = 0.5,
@@ -127,14 +133,18 @@ module AniRuby
                  scale_y = 1,
                  color = Gosu::Color::WHITE,
                  mode = :default)
-      frame = @frames[@position]
+      frame = @frames[@cursor]
 
       frame.sprite.draw_rot(x, y, z, angle, center_x, center_y, scale_x, scale_y, color, mode)
     end
 
+    # @!endgroup
+
+    # @!group Utility
+
     # Pause the animation
     #
-    # (see {resume})
+    # (see also {resume})
     def pause
       @pause = true
 
@@ -143,7 +153,7 @@ module AniRuby
 
     # Resume the animation
     #
-    # (see {pause})
+    # (see also {pause})
     def resume
       @pause = false
 
@@ -152,11 +162,13 @@ module AniRuby
 
     # Set the animation to the beginning frame
     def reset
-      @position = 0
+      @cursor = 0
 
       self
     end
 
+    alias reset! reset
+
     # Set the duration for all frames in the animation
     #
     # @param ms [Float] The new duration in milliseconds
@@ -171,7 +183,7 @@ module AniRuby
     # @return [Boolean]
     # @note This method will return true in intervals if the animation loops
     def done?
-      return true if @position == @frames.count - 1
+      return true if @cursor == @frames.count - 1
 
       false
     end
@@ -189,15 +201,17 @@ module AniRuby
     #
     # @return [AniRuby::Frame]
     def current_frame
-      @frames[@position % @frames.count]
+      @frames[@cursor % @frames.count]
     end
 
+    # @!endgroup
+
     # Has the current frame's duration expired?
     def frame_expired?
       now = Gosu.milliseconds / 1000.0
       @last_frame ||= now
 
-      if (now - @last_frame) > @frames[@position].duration
+      if (now - @last_frame) > @frames[@cursor].duration
         @last_frame = now
       end
     end

data/lib/aniruby/frame.rb

@@ -1,4 +1,3 @@
-
 module AniRuby
   # A frame has a sprite that's Gosu::Image and a duration specified in
   # milliseconds
@@ -12,8 +11,8 @@ module AniRuby
     # @return [Integer]
     attr_reader :width, :height
 
-    alias :w :width
-    alias :h :height
+    alias w width
+    alias h height
 
     # Create a new frame
     #

data/lib/aniruby/frames.rb

@@ -1,4 +1,3 @@
-
 module AniRuby
   # Collection of frames
   class Frames

data/lib/aniruby/version.rb

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

data/lib/aniruby.rb

@@ -1,6 +1,4 @@
-
-require_relative 'aniruby/version'
-
-require_relative 'aniruby/frame'
-require_relative 'aniruby/frames'
-require_relative 'aniruby/animation'
+require 'aniruby/frame'
+require 'aniruby/frames'
+require 'aniruby/animation'
+require 'aniruby/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aniruby
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Chadow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-07 00:00:00.000000000 Z
+date: 2023-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 13.0.0
 description: |
-  Library for painless sprite animations on Gosu, with a easy
+  Library for painless sprite animations on Gosu, with an easy
   and nifty API, made in pure Ruby with no dependencies at all!
 email: 
 executables: []
@@ -87,7 +87,11 @@ files:
 homepage: https://github.com/Chadowo/aniruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/Chadowo/aniruby/issues
+  changelog_uri: https://github.com/Chadowo/aniruby/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/Chadowo/aniruby
+  source_code_uri: https://github.com/Chadowo/aniruby
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -104,8 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Gosu installed and working
-rubygems_version: 3.4.19
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
-summary: Make sprite animations on Gosu simple and easy
+summary: Make sprite animations on Gosu, simply and easily
 test_files: []