osb 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfa8c9fd46a2c0c25b5ae9b9d88d1043e2f16a74b01ff0ae1f8f7561d448f7f0
-  data.tar.gz: 44a5c46b92e37bdb8f8f5694e8da2b28dabecc77d27793d43b15238ddc97382c
+  metadata.gz: 32ca949f86da7674ea4bb25916deb932a6f104ab36660947c8edc6130515a164
+  data.tar.gz: b3ab443117c2e9e5a192f097731fd723ad953ecb7488aaaf1af5abf28bbad8d2
 SHA512:
-  metadata.gz: 96064b59c3bbca5233109df31a39cf1867a1c598bfdb4f5583f992af578d43c9b4659c46f81ef8fcedd870e112aaa415bc27e88c290025700d8f7ea35a26e812
-  data.tar.gz: 601067ee4dd65cd6781b0a8719e988b5ba4f7888760a9dc4069b1d5369bfe497358314cf97ed01b3be9aee48a6cca0368e9bd6d0b31e59b930be818ba8be920b
+  metadata.gz: 59ad469e27d5872abe498740c708edbfc11816f80b37ed64dc155c2da802451640fdb23928f2fe1c67eb5d4ceb916fe95bb18cc3e3927465d49075a6eee8a54b
+  data.tar.gz: d93b6b82cf34bdcc6adaba0bd5a0816f5bf560a757227445180b673a8cbf10e49d3b588ac6ee8204651e5f8dbc3d7fc4ce493c67745bd0cc0bc3d022d997b7f6

data/.yardopts

@@ -0,0 +1,2 @@
+--no-private
+--markup=markdown

data/lib/osb/assert.rb

@@ -31,7 +31,6 @@ module Osb
     end
 
     # @private
-    # @type [Hash{Class => Hash{Class => Object}}]
     T = {
       Array => {
         Numeric => TypedArray.new(Numeric),

data/lib/osb/background.rb

@@ -6,7 +6,7 @@ module Osb
     # @private
     attr_reader :command
 
-    # @param [String] file_name location of the background image relative to the beatmap directory.
+    # @param [String] file_path location of the background image relative to the beatmap directory.
     def initialize(file_path:)
       Internal.assert_type!(file_path, String, "file_path")
       Internal.assert_file_name_ext!(file_path, %w[png jpg jpeg])

data/lib/osb/color.rb

@@ -3,16 +3,17 @@
 module Osb
   # Represents an RGB color.
   class Color
-    attr_accessor :r, :g, :b
-    # @attribute [rw] r
-    #   @return Red value.
-    # @attribute [rw] g
-    #   @return Green value.
-    # @attribute [rw] b
-    #   @return Blue value.
-
-    # @param [Integer, String, Array<Integer>] r red value, a hex +String+, 
-    #   or an +Array+ of 3 +{Integer}+s.
+    # @return [Integer] Red value.
+    attr_accessor :r
+     
+    # @return [Integer] Green value.
+    attr_accessor :g
+ 
+    # @return [Integer] Blue value.
+    attr_accessor :b
+
+    # @param [Integer, String, Array<Integer>] r red value, a hex String, 
+    #   or an Array of 3 {Integer}s.
     # @param [Integer] g green value
     # @param [Integer] b blue value
     def initialize(r, g = nil, b = nil)
@@ -47,6 +48,7 @@ module Osb
 
     # Returns whether 2 colors are not equal.
     # @param [Color] color
+    # @return [Boolean]
     def !=(color)
       Internal.assert_type!(color, Color, "color")
 
@@ -54,9 +56,9 @@ module Osb
     end
 
     # Converts an HSL color value to RGB.
-    # @param [Integer] hue
-    # @param [Integer] saturation
-    # @param [Integer] lightness
+    # @param [Integer] h hue
+    # @param [Integer] s saturation
+    # @param [Integer] l lightness
     # @return [Color]
     def self.from_hsl(h, s, l)
       Internal.assert_type!(h, Integer, "h")
@@ -100,7 +102,7 @@ module Osb
       return p
     end
 
-    # Create a +{Color}+ object from hex string.
+    # Create a {Osb::Color} object from hex string.
     # @param [String] hex
     # @return [Color]
     def self.from_hex(hex)
@@ -112,9 +114,9 @@ module Osb
     end
   end
 
-  # Create a new rgb +{Color}+.
-  # @param [Integer, String, Array<Integer>] r red value, a hex +String+, 
-  #   or an +Array+ of 3 +{Integer}+s.
+  # Create a new rgb {Osb::Color}.
+  # @param [Integer, String, Array<Integer>] r red value, a hex String, 
+  #   or an Array of 3 {Integer}s.
   # @param [Integer] g green value
   # @param [Integer] b blue value
   # @return [Color]
@@ -122,10 +124,10 @@ module Osb
     Color.new(r, g, b)
   end
 
-  # Create a new hsl +{Color}+.
-  # @param [Integer] hue
-  # @param [Integer] saturation
-  # @param [Integer] lightness
+  # Create a new hsl {Osb::Color}.
+  # @param [Integer] h hue
+  # @param [Integer] s saturation
+  # @param [Integer] l lightness
   # @return [Color]
   def hsl(h, s, l)
     Color.from_hsl(h, s, l)

data/lib/osb/dsl/object.rb

@@ -105,7 +105,7 @@ module Osb
   end
 
   # Set the background image for the beatmap.
-  # @param [String] file_name location of the background image relative to the beatmap directory.
+  # @param [String] file_path location of the background image relative to the beatmap directory.
   # @return [void]
   def background(file_path:)
     self.raise_unless_inside_storyboard!
@@ -114,7 +114,7 @@ module Osb
   end
 
   # Set the video for the beatmap.
-  # @param [String] file_name location of the video file relative to the beatmap directory.
+  # @param [String] file_path location of the video file relative to the beatmap directory.
   # @param [Integer] start_time when the video starts.
   # @return [void]
   def video(file_path:, start_time:)

data/lib/osb/enums/easing.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Osb
+  # Easing enums.
   module Easing
     Linear = 0
     Out = 1
@@ -37,6 +38,7 @@ module Osb
     InBounce = 32
     OutBounce = 33
     InOutBounce = 34
+    # @private
     ALL = 0..34
   end
 end

data/lib/osb/enums/layer.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 module Osb
+  # Storyboard layer enums.
   module Layer
     Background = "Background"
     Fail = "Fail"
     Pass = "Pass"
     Foreground = "Foreground"
     Overlay = "Overlay"
+    # @private
     ALL = %w[Background Fail Pass Foreground Overlay]
   end
 end

data/lib/osb/enums/origin.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Osb
+  # Storyboard object origin enums.
   module Origin
     TopLeft = "TopLeft"
     TopCentre = "TopCentre"
@@ -16,6 +17,7 @@ module Osb
     BottomCentre = "BottomCentre"
     BottomCenter = "BottomCentre"
     BottomRight = "BottomRight"
+    # @private
     ALL = %w[
       TopLeft
       TopCentre

data/lib/osb/integer.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# A number of methods have been added to the Ruby Integer class to do units conversions.
 class Integer
   # Does nothing. Just a way to tell people it's represented in milliseconds.
   # @return [Integer]

data/lib/osb/storyboard.rb

@@ -67,9 +67,10 @@ module Osb
 
   # When designing storyboard, we often want to group storyboard elements
   # that are used in a similar context (eg. a scene), so this class' purpose
-  # is only to act as a container. You can add the elements directly to the
-  # +Osb::Storyboard+ object, but we recommend you to split the project into multiple
-  # +Osb::Group+ so it will be easier to manage.
+  # is only to act as a container. You can add every element directly to the
+  # {Osb::Storyboard} object, but we recommend you to split the project into
+  # multiple {Osb::Group} so it will be easier to manage. A {Osb::Group} can
+  # have multiple nested {Osb::Group}s in itself.
   class Group
     # @private
     attr_reader :layers
@@ -78,7 +79,7 @@ module Osb
       @layers = Internal::LayerManager.new
     end
 
-    # Add an +Osb::Sprite+, +Osb::Animation+, +Osb::Sample+ or +Osb::Group+ to
+    # Add an {Osb::Sprite}, {Osb::Animation}, {Osb::Sample} or {Group} to
     # this group.
     # @param [Osb::Group, Osb::Sprite, Osb::Animation, Osb::Sample] object
     # @return [self]
@@ -106,8 +107,9 @@ module Osb
       return self
     end
 
-    # Add an +Osb::Sprite+, +Osb::Animation+, +Osb::Sample+ or +Osb::Group+ to
-    # this group. Alias for +#add+.
+    # Alias for {#add}.
+    # Add a {Osb::Sprite}, {Osb::Animation}, {Osb::Sample} or {Group} to
+    # this group.
     # @param [Osb::Group, Osb::Sprite, Osb::Animation, Osb::Sample] object
     # @return [self]
     def <<(object)
@@ -116,8 +118,8 @@ module Osb
   end
 
   # Represent an osu! storyboard. Each sprite or animation can be added directly
-  # to the storyboard instance, or through an intermediate group. A group can
-  # have multiple nested groups in itself.
+  # to the storyboard instance, or through an intermediate group. A {Osb::Group}
+  # can have multiple nested {Osb::Group}s in itself.
   class Storyboard
     # @private
     attr_reader :layers
@@ -126,8 +128,8 @@ module Osb
       @layers = Internal::LayerManager.new
     end
 
-    # Add an +Osb::Sprite+, +Osb::Animation+, +Osb::Sample+, +Osb::Video+,
-    # +Osb::Background+ or +Osb::Group+ to this storyboard.
+    # Add a {Osb::Sprite}, {Osb::Animation}, {Osb::Sample}, {Osb::Video},
+    # {Osb::Background} or {Osb::Group} to this storyboard.
     # @param [Osb::Group, Osb::Sprite, Osb::Animation, Osb::Sample, Osb::Video,
     #         Osb::Background] object
     # @return [self]
@@ -155,8 +157,9 @@ module Osb
       return self
     end
 
-    # Add an +Osb::Sprite+, +Osb::Animation+, +Osb::Sample+, +Osb::Video+,
-    # +Osb::Background+ or +Osb::Group+ to this storyboard. Alias for +#add+.
+    # Alias for {#add}.
+    # Add a {Osb::Sprite}, {Osb::Animation}, {Osb::Sample}, {Osb::Video},
+    # {Osb::Background} or {Osb::Group} to this storyboard.
     # @param [Osb::Group, Osb::Sprite, Osb::Animation, Osb::Sample, Osb::Video,
     #         Osb::Background] object
     # @return [self]

data/lib/osb/vector2.rb

@@ -3,15 +3,14 @@
 module Osb
   # Represents a 2d point or vector.
   class Vector2
-    attr_accessor :x, :y
-    # @!attribute [rw] x
-    #   @return x coordinate of this vector
-    # @!attribute [rw] y
-    #   @return y coordinate of this vector
+    # @return [Numeric] x coordinate of this vector
+    attr_accessor :x
+    # @return [Numeric] y coordinate of this vector
+    attr_accessor :y
 
     # @param [Numeric, Array<Numeric>] x
-    #   x coordinate of this +{Vector2}+, or an +Array+ of 2 numbers.
-    # @param [Numeric] y y coordinate of this +{Vector2}+
+    #   x coordinate of this vector, or an +Array+ of 2 {Numeric} values.
+    # @param [Numeric] y y coordinate of this vector
     def initialize(x = 0, y = 0)
       Internal.assert_type!(x, [Numeric, Internal::T[Array][Numeric]], "x")
       Internal.assert_type!(y, Numeric, "y")
@@ -28,7 +27,7 @@ module Osb
       end
     end
 
-    # Add another +{Vector2}+ to this one.
+    # Add another 2d vector to this one.
     # @param [Vector2] vector
     # @return [Vector2]
     def +(vector)
@@ -36,7 +35,7 @@ module Osb
       Vector2.new(self.x + vector.x, self.y + vector.y)
     end
 
-    # Subtract another +{Vector2}+ from this one.
+    # Subtract another 2d vector from this one.
     # @param [Vector2] vector
     # @return [Vector2]
     def -(vector)
@@ -44,7 +43,7 @@ module Osb
       Vector2.new(self.x - vector.x, self.y - vector.y)
     end
 
-    # Returns whether two +{Vector2}+ are equal within tolerance
+    # Returns whether two 2d vector are equal within tolerance
     # @param [Vector2] vector
     # @return [Boolean]
     def ==(vector)
@@ -52,14 +51,14 @@ module Osb
       Math.fuzzy_equal(self.x, vector.x) && Math.fuzzy_equal(self.y, vector.y)
     end
 
-    # Returns whether two +{Vector2}+ are not equal within tolerance
+    # Returns whether two 2d vector are not equal within tolerance
     # @param [Vector2] vector
     # @return [Boolean]
     def !=(vector)
       !(self == vector)
     end
 
-    # Makes a copy of this +{Vector2}+.
+    # Makes a copy of this 2d vector.
     # @return [Vector2]
     def clone
       Vector2.new(self.x, self.y)
@@ -71,23 +70,24 @@ module Osb
       [self.x, self.y]
     end
 
-    # Returns a string representation of this +{Vector2}+.
+    # Returns a string representation of this 2d vector.
     # @return [String]
     def to_s
       self.to_a.to_s
     end
 
-    # Returns the length of this +{Vector2}+.
+    # Returns the length of this 2d vector.
     # @return [Float]
     def length
       Math.sqrt(self.x**2 + self.y**2)
     end
   end
 
-  # Create a +{Vector2}+.
+  # Create a 2d vector.
   # @param [Numeric, Array<Numeric>] x
-  #   x coordinate of this +{Vector2}+, or an +Array+ of 2 numbers.
-  # @param [Numeric] y y coordinate of this +{Vector2}+
+  #   x coordinate of this 2d vector, or an +Array+ of 2 numbers.
+  # @param [Numeric] y y coordinate of this 2d vector
+  # @return [Vector2]
   def vec2(x = 0, y = 0)
     Vector2.new(x, y)
   end

data/lib/osb.rb

@@ -20,7 +20,7 @@ require_relative "osb/dsl/object"
 require_relative "osb/dsl/commands"
 
 module Osb
-  VERSION = "1.1.0"
+  VERSION = "1.1.2"
 end
 
 # Extend the main object with the DSL commands.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osb
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Dinh Vu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-21 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies: []
 description: A simple framework for building osu! storyboard.
 email: dinhvu2509@gmail.com
@@ -16,6 +16,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - lib/osb.rb
 - lib/osb/animation.rb
 - lib/osb/assert.rb