harmonica 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a44f86b9f43f12624407af947f1e81c1fa191bccc81263cb2b4228af8582f377
-  data.tar.gz: 414eabc26823d5e03fe022406753472f8dc1e9e0a4b99ebce150b6b8a624cbab
+  metadata.gz: e6afb3b138a76ef0890ade727f4c54101bc82500e7f62414f07cb9354869b81e
+  data.tar.gz: '029cf0ad698ed254933e784c38d061aa1888c1605c7d00a19d84071bde203e26'
 SHA512:
-  metadata.gz: 1225b332b512135e1044afd04b1d4c74c281f93992b26999abd46147d5d55da7830df1fadd5527a5db2cc996c828345a42e0d9dac27e380eeb6d674a298e6ec3
-  data.tar.gz: f4057ff79e4105e693e8359423dd7d1249ca3cc803ba2839519f7478f5b303691540d603617327c8caa765eaa4842680873c9b7ce9e9dce6527546c08fc7ff71
+  metadata.gz: c03e033b71d53191187bc3384fc9e6f71d6186be710ad3dcbc1090bd251b7ec77663b9a9b0882b4dee15949b3c8747d0bae539481b41788423bb5ad443dd95d9
+  data.tar.gz: dbebfb079e65c125ed16ad557db8d550201cecb62db2e29b4f1a54ba0f120980867709c4c9ee3fd5d545b6b4fda8189671fd6814defe4b8f7b8ec29327da6199

data/README.md

@@ -231,7 +231,7 @@ end
 ## Development
 
 **Requirements:**
-- Ruby 3.0+
+- Ruby 3.2+
 
 **Install dependencies:**
 
@@ -262,4 +262,14 @@ The gem is available as open source under the terms of the MIT License.
 
 ## Acknowledgments
 
-This gem is a Ruby implementation of [charmbracelet/harmonica](https://github.com/charmbracelet/harmonica), part of the excellent [Charm](https://charm.sh) ecosystem. The spring algorithm is based on Ryan Juckett's [damped springs](https://www.ryanjuckett.com/damped-springs/).
+This gem is a Ruby implementation of [charmbracelet/harmonica](https://github.com/charmbracelet/harmonica), part of the excellent [Charm](https://charm.sh) ecosystem. The spring algorithm is based on Ryan Juckett's [damped springs](https://www.ryanjuckett.com/damped-springs/). Charm Ruby is not affiliated with or endorsed by Charmbracelet, Inc.
+
+---
+
+Part of [Charm Ruby](https://charm-ruby.dev).
+
+<a href="https://charm-ruby.dev"><img alt="Charm Ruby" src="https://marcoroth.dev/images/heros/glamorous-christmas.png" width="400"></a>
+
+[Lipgloss](https://github.com/marcoroth/lipgloss-ruby) • [Bubble Tea](https://github.com/marcoroth/bubbletea-ruby) • [Bubbles](https://github.com/marcoroth/bubbles-ruby) • [Glamour](https://github.com/marcoroth/glamour-ruby) • [Huh?](https://github.com/marcoroth/huh-ruby) • [Harmonica](https://github.com/marcoroth/harmonica-ruby) • [Bubblezone](https://github.com/marcoroth/bubblezone-ruby) • [Gum](https://github.com/marcoroth/gum-ruby) • [ntcharts](https://github.com/marcoroth/ntcharts-ruby)
+
+The terminal doesn't have to be boring.

data/harmonica.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
     "harmonica.gemspec",
     "LICENSE.txt",
     "README.md",
-    "lib/**/*.rb"
+    "{lib,sig}/**/*"
   ]
 
   spec.bindir = "exe"

data/lib/harmonica/version.rb

@@ -2,5 +2,5 @@
 # rbs_inline: enabled
 
 module Harmonica
-  VERSION = "0.1.0" #: String
+  VERSION = "0.1.1" #: String
 end

data/sig/harmonica/point.rbs

@@ -0,0 +1,42 @@
+# Generated from lib/harmonica/point.rb with RBS::Inline
+
+module Harmonica
+  # Point represents a point in 3D space.
+  #
+  # @example
+  #   point = Harmonica::Point.new(10.0, 20.0, 0.0)
+  #   point.x  # => 10.0
+  #   point.y  # => 20.0
+  #   point.z  # => 0.0
+  class Point
+    @x: Float
+
+    @y: Float
+
+    @z: Float
+
+    attr_accessor x: Float
+
+    attr_accessor y: Float
+
+    attr_accessor z: Float
+
+    # @rbs x: Integer | Float -- x coordinate
+    # @rbs y: Integer | Float -- y coordinate
+    # @rbs z: Integer | Float -- z coordinate
+    # @rbs return: void
+    def initialize: (?Integer | Float x, ?Integer | Float y, ?Integer | Float z) -> void
+
+    # : () -> Array[Float]
+    def to_a: () -> Array[Float]
+
+    # : (untyped other) -> bool
+    def ==: (untyped other) -> bool
+
+    # : () -> String
+    def to_s: () -> String
+
+    # : () -> String
+    def inspect: () -> String
+  end
+end

data/sig/harmonica/projectile.rbs

@@ -0,0 +1,56 @@
+# Generated from lib/harmonica/projectile.rb with RBS::Inline
+
+module Harmonica
+  # Projectile simulates physics projectile motion.
+  #
+  # @example
+  #   projectile = Harmonica::Projectile.new(
+  #     delta_time: Harmonica.fps(60),
+  #     position: Harmonica::Point.new(0, 100, 0),
+  #     velocity: Harmonica::Vector.new(2, 0, 0),
+  #     acceleration: Harmonica::GRAVITY
+  #   )
+  #
+  #   loop do
+  #     position = projectile.update
+  #     break if position.y <= 0
+  #   end
+  class Projectile
+    @delta_time: Float
+
+    @position: Point
+
+    @velocity: Vector
+
+    @acceleration: Vector
+
+    attr_reader position: Point
+
+    attr_reader velocity: Vector
+
+    attr_reader acceleration: Vector
+
+    attr_reader delta_time: Float
+
+    # Create a new Projectile.
+    #
+    # @rbs delta_time: Float -- time step per frame (use Harmonica.fps)
+    # @rbs position: Point -- initial position
+    # @rbs velocity: Vector -- initial velocity
+    # @rbs acceleration: Vector -- constant acceleration (e.g., gravity)
+    # @rbs return: void
+    def initialize: (delta_time: Float, position: Point, velocity: Vector, acceleration: Vector) -> void
+
+    # Update the projectile position and velocity for one time step.
+    #
+    # : () -> Point
+    def update: () -> Point
+
+    # Reset the projectile to a new state.
+    #
+    # @rbs position: Point -- new position
+    # @rbs velocity: Vector -- new velocity
+    # @rbs return: void
+    def reset: (position: Point, velocity: Vector) -> void
+  end
+end

data/sig/harmonica/spring.rbs

@@ -0,0 +1,81 @@
+# Generated from lib/harmonica/spring.rb with RBS::Inline
+
+module Harmonica
+  # Spring is a damped harmonic oscillator for smooth, realistic spring-like motion.
+  #
+  # This is ported from Ryan Juckett's simple damped harmonic motion, originally
+  # written in C++. For background on the algorithm see:
+  # https://www.ryanjuckett.com/damped-springs/
+  #
+  # @example
+  #   # Initialize once
+  #   spring = Harmonica::Spring.new(
+  #     delta_time: Harmonica.fps(60),
+  #     angular_frequency: 6.0,
+  #     damping_ratio: 0.2
+  #   )
+  #
+  #   # Update on every frame
+  #   position = 0.0
+  #   velocity = 0.0
+  #   target = 100.0
+  #
+  #   loop do
+  #     position, velocity = spring.update(position, velocity, target)
+  #   end
+  class Spring
+    EPSILON: Float
+
+    @velocity_velocity_coefficient: Float
+
+    @velocity_position_coefficient: Float
+
+    @position_velocity_coefficient: Float
+
+    @position_position_coefficient: Float
+
+    @angular_frequency: Float
+
+    @damping_ratio: Float
+
+    @delta_time: Float
+
+    attr_reader position_position_coefficient: Float
+
+    attr_reader position_velocity_coefficient: Float
+
+    attr_reader velocity_position_coefficient: Float
+
+    attr_reader velocity_velocity_coefficient: Float
+
+    # Create a new Spring with precomputed coefficients.
+    #
+    # @rbs delta_time: Float -- time step (use Harmonica.fps for frame rate)
+    # @rbs angular_frequency: Float -- angular frequency of motion (affects speed)
+    # @rbs damping_ratio: Float -- damping ratio (> 1: over-damped, = 1: critical, < 1: under-damped)
+    # @rbs return: void
+    def initialize: (delta_time: Float, angular_frequency: Float, damping_ratio: Float) -> void
+
+    # Update position and velocity towards equilibrium position.
+    #
+    # @rbs position: Float -- current position
+    # @rbs velocity: Float -- current velocity
+    # @rbs equilibrium_position: Float -- target/equilibrium position
+    # @rbs return: [Float, Float]
+    def update: (Float position, Float velocity, Float equilibrium_position) -> [ Float, Float ]
+
+    private
+
+    # : () -> void
+    def compute_coefficients: () -> void
+
+    # : () -> void
+    def compute_over_damped: () -> void
+
+    # : () -> void
+    def compute_under_damped: () -> void
+
+    # : () -> void
+    def compute_critically_damped: () -> void
+  end
+end

data/sig/harmonica/vector.rbs

@@ -0,0 +1,71 @@
+# Generated from lib/harmonica/vector.rb with RBS::Inline
+
+module Harmonica
+  # Vector represents a vector in 3D space with magnitude and direction.
+  #
+  # @example
+  #   velocity = Harmonica::Vector.new(2.0, 0.0, 0.0)
+  #   gravity = Harmonica::GRAVITY
+  class Vector
+    @x: Float
+
+    @y: Float
+
+    @z: Float
+
+    attr_accessor x: Float
+
+    attr_accessor y: Float
+
+    attr_accessor z: Float
+
+    # @rbs x: Integer | Float -- x component
+    # @rbs y: Integer | Float -- y component
+    # @rbs z: Integer | Float -- z component
+    # @rbs return: void
+    def initialize: (?Integer | Float x, ?Integer | Float y, ?Integer | Float z) -> void
+
+    # : () -> Array[Float]
+    def to_a: () -> Array[Float]
+
+    # : (untyped other) -> bool
+    def ==: (untyped other) -> bool
+
+    # : () -> String
+    def to_s: () -> String
+
+    # : () -> String
+    def inspect: () -> String
+
+    # Vector addition
+    #
+    # : (Vector other) -> Vector
+    def +: (Vector other) -> Vector
+
+    # Vector subtraction
+    #
+    # : (Vector other) -> Vector
+    def -: (Vector other) -> Vector
+
+    # Scalar multiplication
+    #
+    # : (Integer | Float other) -> Vector
+    def *: (Integer | Float other) -> Vector
+
+    # Magnitude (length) of the vector
+    #
+    # : () -> Float
+    def magnitude: () -> Float
+
+    # Normalize the vector (unit vector)
+    #
+    # : () -> Vector
+    def normalize: () -> Vector
+  end
+
+  # origin at bottom-left, Y pointing up
+  GRAVITY: Vector
+
+  # origin at top-left, Y pointing down
+  TERMINAL_GRAVITY: Vector
+end

data/sig/harmonica/version.rbs

@@ -0,0 +1,5 @@
+# Generated from lib/harmonica/version.rb with RBS::Inline
+
+module Harmonica
+  VERSION: String
+end

data/sig/harmonica.rbs

@@ -0,0 +1,13 @@
+# Generated from lib/harmonica.rb with RBS::Inline
+
+module Harmonica
+  # Calculate time delta for a given frames per second.
+  # Use this when initializing Spring or Projectile.
+  #
+  # @example
+  #   spring = Harmonica::Spring.new(delta_time: Harmonica.fps(60), ...)
+  #
+  # @rbs frames_per_second: Integer -- frames per second
+  # @rbs return: Float
+  def self.fps: (Integer frames_per_second) -> Float
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: harmonica
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Marco Roth
@@ -26,6 +26,12 @@ files:
 - lib/harmonica/spring.rb
 - lib/harmonica/vector.rb
 - lib/harmonica/version.rb
+- sig/harmonica.rbs
+- sig/harmonica/point.rbs
+- sig/harmonica/projectile.rbs
+- sig/harmonica/spring.rbs
+- sig/harmonica/vector.rbs
+- sig/harmonica/version.rbs
 homepage: https://github.com/marcoroth/harmonica-ruby
 licenses:
 - MIT