harmonica 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d12e0ae1f838550ab02b756bbe2881b24804079fadab5f9da68712effd6d31b4
-  data.tar.gz: e5713b0f482006a2b40cf5f39dce6cfa4bf738c536ed4c00d3b14ee28dcffe9f
+  metadata.gz: a44f86b9f43f12624407af947f1e81c1fa191bccc81263cb2b4228af8582f377
+  data.tar.gz: 414eabc26823d5e03fe022406753472f8dc1e9e0a4b99ebce150b6b8a624cbab
 SHA512:
-  metadata.gz: 2c10d14d813f1d1d66a47fb03253a78f82a57bb123502b7f4c655ea5f80446f0509ee5680e6bad2cc110d84e389c64b2eb6560a71e466c7c01d0a128b1ceb58e
-  data.tar.gz: 5dac6408c89fd254986ac093fcf74fabe993461f49eb40022c9e970d249e0ff5218f0057bb4982319a9c79f4803ec3eb72a8c97ff9f8a0987e55fd7a99b87c7b
+  metadata.gz: 1225b332b512135e1044afd04b1d4c74c281f93992b26999abd46147d5d55da7830df1fadd5527a5db2cc996c828345a42e0d9dac27e380eeb6d674a298e6ec3
+  data.tar.gz: f4057ff79e4105e693e8359423dd7d1249ca3cc803ba2839519f7478f5b303691540d603617327c8caa765eaa4842680873c9b7ce9e9dce6527546c08fc7ff71

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Marco Roth
+
+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

@@ -1,39 +1,265 @@
-# Harmonica
+<div align="center">
+  <h1>Harmonica for Ruby</h1>
+  <h4>A simple, physics-based animation library for Ruby.</h4>
 
-TODO: Delete this and the text below, and describe your gem
+  <p>
+    <a href="https://rubygems.org/gems/harmonica"><img alt="Gem Version" src="https://img.shields.io/gem/v/harmonica"></a>
+    <a href="https://github.com/marcoroth/harmonica-ruby/blob/main/LICENSE.txt"><img alt="License" src="https://img.shields.io/github/license/marcoroth/harmonica-ruby"></a>
+  </p>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/harmonica`. To experiment with that code, run `bin/console` for an interactive prompt.
+  <p>Ruby implementation of <a href="https://github.com/charmbracelet/harmonica">charmbracelet/harmonica</a>.<br/>A simple, efficient spring animation library for smooth, natural motion.</p>
+</div>
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+**Add to your Gemfile:**
 
-Install the gem and add to the application's Gemfile by executing:
-
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+gem "harmonica"
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+**Or install directly:**
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install harmonica
 ```
 
+## Components
+
+| Component | Description |
+|-----------|-------------|
+| [Spring](#spring) | Damped harmonic oscillator for smooth UI animations |
+| [Projectile](#projectile) | Physics projectile motion for particles |
+| [Point](#point) | 3D point coordinates |
+| [Vector](#vector) | 3D vector with magnitude and direction |
+
 ## Usage
 
-TODO: Write usage instructions here
+### Spring
+
+Spring provides smooth, realistic motion using a damped harmonic oscillator. Perfect for UI animations like scroll positions, element transitions, and interactive feedback.
+
+**Basic usage:**
+
+```ruby
+require "harmonica"
+
+spring = Harmonica::Spring.new(
+  delta_time: Harmonica.fps(60),   # 60 FPS
+  angular_frequency: 6.0,          # Speed of motion
+  damping_ratio: 0.5               # Smoothness
+)
+
+position = 0.0
+velocity = 0.0
+target = 100.0
+
+loop do
+  position, velocity = spring.update(position, velocity, target)
+
+  break if (position - target).abs < 0.01
+end
+```
+
+**Damping ratios:**
+
+| Ratio | Behavior |
+|-------|----------|
+| `< 1.0` | Under-damped: oscillates before settling (bouncy) |
+| `= 1.0` | Critically-damped: fastest without oscillation |
+| `> 1.0` | Over-damped: slow approach, no oscillation |
+
+**Example with Bubbletea:**
+
+```ruby
+class ScrollModel
+  def initialize
+    @scroll_position = 0.0
+    @scroll_velocity = 0.0
+    @target_scroll = 0.0
+
+    @spring = Harmonica::Spring.new(
+      delta_time: Harmonica.fps(60),
+      angular_frequency: 5.0,
+      damping_ratio: 0.8
+    )
+  end
+
+  def update(message)
+    case message
+    when Bubbletea::KeyMessage
+      @target_scroll += 10 if message.to_s == "down"
+      @target_scroll -= 10 if message.to_s == "up"
+    end
+
+    @scroll_position, @scroll_velocity = @spring.update(
+      @scroll_position,
+      @scroll_velocity,
+      @target_scroll
+    )
+
+    [self, nil]
+  end
+end
+```
+
+### Projectile
+
+Projectile simulates physics motion with position, velocity, and acceleration. Great for particles, falling objects, and game physics.
+
+#### Basic usage
+
+```ruby
+require "harmonica"
+
+projectile = Harmonica::Projectile.new(
+  delta_time: Harmonica.fps(60),
+  position: Harmonica::Point.new(0, 100, 0),
+  velocity: Harmonica::Vector.new(10, 20, 0),
+  acceleration: Harmonica::GRAVITY
+)
+
+loop do
+  position = projectile.update
+
+  puts "Position: #{position.x}, #{position.y}"
+  break if position.y <= 0
+end
+```
+
+#### Gravity constants
+
+```ruby
+Harmonica::GRAVITY           # Vector(0, -9.81, 0) - origin at bottom-left
+Harmonica::TERMINAL_GRAVITY  # Vector(0,  9.81, 0) - origin at top-left
+```
+
+#### Custom acceleration
+
+**No gravity (space)**
+
+```ruby
+projectile = Harmonica::Projectile.new(
+  delta_time: Harmonica.fps(60),
+  position: Harmonica::Point.new(0, 0, 0),
+  velocity: Harmonica::Vector.new(5, 5, 0),
+  acceleration: Harmonica::Vector.new(0, 0, 0)
+)
+```
+
+**Strong gravity**
+
+```ruby
+projectile = Harmonica::Projectile.new(
+  delta_time: Harmonica.fps(60),
+  position: Harmonica::Point.new(0, 100, 0),
+  velocity: Harmonica::Vector.new(0, 0, 0),
+  acceleration: Harmonica::Vector.new(0, -20, 0)
+)
+```
+
+### Point
+
+Point represents a position in 3D space.
+
+```ruby
+point = Harmonica::Point.new(10.0, 20.0, 30.0)
+
+point.x  # => 10.0
+point.y  # => 20.0
+point.z  # => 30.0
+
+point.to_a  # => [10.0, 20.0, 30.0]
+```
+
+### Vector
+
+Vector represents direction and magnitude in 3D space.
+
+```ruby
+vector = Harmonica::Vector.new(3.0, 4.0, 0.0)
+
+vector.magnitude   # => 5.0
+vector.normalize   # => Vector(0.6, 0.8, 0.0)
+
+v1 = Harmonica::Vector.new(1, 2, 3)
+v2 = Harmonica::Vector.new(4, 5, 6)
+
+v1 + v2   # => Vector(5, 7, 9)
+v1 - v2   # => Vector(-3, -3, -3)
+v1 * 2    # => Vector(2, 4, 6)
+```
+
+## Frame Rate Helper
+
+Use `Harmonica.fps` to calculate the time delta for a given frame rate:
+
+```ruby
+Harmonica.fps(60)   # => 0.01666... (1/60 second)
+Harmonica.fps(30)   # => 0.03333... (1/30 second)
+Harmonica.fps(120)  # => 0.00833... (1/120 second)
+```
+
+## Complete Example
+
+Animate a value from 0 to 100 with spring physics:
+
+```ruby
+require "harmonica"
+
+spring = Harmonica::Spring.new(
+  delta_time: Harmonica.fps(60),
+  angular_frequency: 6.0,
+  damping_ratio: 0.3  # bouncy
+)
+
+position = 0.0
+velocity = 0.0
+target = 100.0
+
+60.times do |frame|
+  position, velocity = spring.update(position, velocity, target)
+
+  bar_length = (position / 2).to_i
+  bar = "#" * bar_length
+
+  puts "\r#{bar.ljust(50)} #{position.round(1)}"
+  sleep(1.0 / 60)
+end
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+**Requirements:**
+- Ruby 3.0+
+
+**Install dependencies:**
+
+```bash
+bundle install
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+**Run tests:**
+
+```bash
+bundle exec rake test
+```
+
+**Run demos:**
+
+```bash
+./demo/spring
+./demo/damping
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/harmonica. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/marcoroth/harmonica/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/harmonica-ruby.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.
 
-## Code of Conduct
+## Acknowledgments
 
-Everyone interacting in the Harmonica project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marcoroth/harmonica/blob/main/CODE_OF_CONDUCT.md).
+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/).

data/harmonica.gemspec

@@ -8,31 +8,25 @@ Gem::Specification.new do |spec|
   spec.authors = ["Marco Roth"]
   spec.email = ["marco.roth@intergga.ch"]
 
-  spec.summary = "Ruby bindings for the Harmonica physics-based animation library."
-  spec.description = spec.summary
+  spec.summary = "A simple, physics-based animation library for Ruby."
+  spec.description = "Ruby implementation of Charm's Harmonica. A simple, efficient spring animation library for smooth, natural motion."
   spec.homepage = "https://github.com/marcoroth/harmonica-ruby"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.1.0"
+  spec.required_ruby_version = ">= 3.2.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/releases"
   spec.metadata["rubygems_mfa_required"] = "true"
 
   spec.files = Dir[
     "harmonica.gemspec",
     "LICENSE.txt",
     "README.md",
-    "CHANGELOG.md",
-    "lib/**/*.rb",
-    "go/**/*.{go,mod,sum}",
-    "go/build/**/*"
+    "lib/**/*.rb"
   ]
 
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.extensions = []
-
-  spec.add_dependency "lipgloss", "~> 0.1"
 end

data/lib/harmonica/point.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+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
+    # @rbs @x: Float
+    # @rbs @y: Float
+    # @rbs @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(x = 0.0, y = 0.0, z = 0.0)
+      @x = x.to_f
+      @y = y.to_f
+      @z = z.to_f
+    end
+
+    #: () -> Array[Float]
+    def to_a
+      [@x, @y, @z]
+    end
+
+    #: (untyped other) -> bool
+    def ==(other)
+      return false unless other.is_a?(Point)
+
+      @x == other.x && @y == other.y && @z == other.z
+    end
+
+    #: () -> String
+    def to_s
+      "Point(#{@x}, #{@y}, #{@z})"
+    end
+
+    #: () -> String
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/harmonica/projectile.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+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
+    # @rbs @delta_time: Float
+    # @rbs @position: Point
+    # @rbs @velocity: Vector
+    # @rbs @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:, position:, velocity:, acceleration:)
+      @delta_time = delta_time.to_f
+      @position = position
+      @velocity = velocity
+      @acceleration = acceleration
+    end
+
+    # Update the projectile position and velocity for one time step.
+    #
+    #: () -> Point
+    def update
+      @position = Point.new(
+        @position.x + (@velocity.x * @delta_time),
+        @position.y + (@velocity.y * @delta_time),
+        @position.z + (@velocity.z * @delta_time)
+      )
+
+      @velocity = Vector.new(
+        @velocity.x + (@acceleration.x * @delta_time),
+        @velocity.y + (@acceleration.y * @delta_time),
+        @velocity.z + (@acceleration.z * @delta_time)
+      )
+
+      @position
+    end
+
+    # Reset the projectile to a new state.
+    #
+    # @rbs position: Point -- new position
+    # @rbs velocity: Vector -- new velocity
+    # @rbs return: void
+    def reset(position:, velocity:)
+      @position = position
+      @velocity = velocity
+    end
+  end
+end

data/lib/harmonica/spring.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+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::EPSILON #: Float
+
+    # @rbs @delta_time: Float
+    # @rbs @damping_ratio: Float
+    # @rbs @angular_frequency: Float
+    # @rbs @position_position_coefficient: Float
+    # @rbs @position_velocity_coefficient: Float
+    # @rbs @velocity_position_coefficient: Float
+    # @rbs @velocity_velocity_coefficient: 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:, angular_frequency:, damping_ratio:)
+      @delta_time = delta_time
+      @angular_frequency = [0.0, angular_frequency].max
+      @damping_ratio = [0.0, damping_ratio].max
+
+      compute_coefficients
+    end
+
+    # 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(position, velocity, equilibrium_position)
+      old_position = position - equilibrium_position
+      old_velocity = velocity
+
+      new_position = (old_position * @position_position_coefficient) +
+                     (old_velocity * @position_velocity_coefficient) +
+                     equilibrium_position
+
+      new_velocity = (old_position * @velocity_position_coefficient) +
+                     (old_velocity * @velocity_velocity_coefficient)
+
+      [new_position, new_velocity]
+    end
+
+    private
+
+    #: () -> void
+    def compute_coefficients
+      if @angular_frequency < EPSILON
+        @position_position_coefficient = 1.0
+        @position_velocity_coefficient = 0.0
+        @velocity_position_coefficient = 0.0
+        @velocity_velocity_coefficient = 1.0
+        return
+      end
+
+      if @damping_ratio > 1.0 + EPSILON
+        compute_over_damped
+      elsif @damping_ratio < 1.0 - EPSILON
+        compute_under_damped
+      else
+        compute_critically_damped
+      end
+    end
+
+    #: () -> void
+    def compute_over_damped
+      za = -@angular_frequency * @damping_ratio
+      zb = @angular_frequency * Math.sqrt((@damping_ratio * @damping_ratio) - 1.0)
+      z1 = za - zb
+      z2 = za + zb
+
+      e1 = Math.exp(z1 * @delta_time)
+      e2 = Math.exp(z2 * @delta_time)
+
+      inverse_two_zb = 1.0 / (2.0 * zb)
+
+      e1_over_two_zb = e1 * inverse_two_zb
+      e2_over_two_zb = e2 * inverse_two_zb
+
+      z1e1_over_two_zb = z1 * e1_over_two_zb
+      z2e2_over_two_zb = z2 * e2_over_two_zb
+
+      @position_position_coefficient = (e1_over_two_zb * z2) - z2e2_over_two_zb + e2
+      @position_velocity_coefficient = -e1_over_two_zb + e2_over_two_zb
+
+      @velocity_position_coefficient = (z1e1_over_two_zb - z2e2_over_two_zb + e2) * z2
+      @velocity_velocity_coefficient = -z1e1_over_two_zb + z2e2_over_two_zb
+    end
+
+    #: () -> void
+    def compute_under_damped
+      omega_zeta = @angular_frequency * @damping_ratio
+      alpha = @angular_frequency * Math.sqrt(1.0 - (@damping_ratio * @damping_ratio))
+
+      exponential_term = Math.exp(-omega_zeta * @delta_time)
+      cosine_term = Math.cos(alpha * @delta_time)
+      sine_term = Math.sin(alpha * @delta_time)
+
+      inverse_alpha = 1.0 / alpha
+
+      exponential_sine = exponential_term * sine_term
+      exponential_cosine = exponential_term * cosine_term
+      exponential_omega_zeta_sine_over_alpha = exponential_term * omega_zeta * sine_term * inverse_alpha
+
+      @position_position_coefficient = exponential_cosine + exponential_omega_zeta_sine_over_alpha
+      @position_velocity_coefficient = exponential_sine * inverse_alpha
+
+      @velocity_position_coefficient = (-exponential_sine * alpha) - (omega_zeta * exponential_omega_zeta_sine_over_alpha)
+      @velocity_velocity_coefficient = exponential_cosine - exponential_omega_zeta_sine_over_alpha
+    end
+
+    #: () -> void
+    def compute_critically_damped
+      exponential_term = Math.exp(-@angular_frequency * @delta_time)
+      time_exponential = @delta_time * exponential_term
+      time_exponential_frequency = time_exponential * @angular_frequency
+
+      @position_position_coefficient = time_exponential_frequency + exponential_term
+      @position_velocity_coefficient = time_exponential
+
+      @velocity_position_coefficient = -@angular_frequency * time_exponential_frequency
+      @velocity_velocity_coefficient = -time_exponential_frequency + exponential_term
+    end
+  end
+end

data/lib/harmonica/vector.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+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
+    # @rbs @x: Float
+    # @rbs @y: Float
+    # @rbs @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(x = 0.0, y = 0.0, z = 0.0)
+      @x = x.to_f
+      @y = y.to_f
+      @z = z.to_f
+    end
+
+    #: () -> Array[Float]
+    def to_a
+      [@x, @y, @z]
+    end
+
+    #: (untyped other) -> bool
+    def ==(other)
+      return false unless other.is_a?(Vector)
+
+      @x == other.x && @y == other.y && @z == other.z
+    end
+
+    #: () -> String
+    def to_s
+      "Vector(#{@x}, #{@y}, #{@z})"
+    end
+
+    #: () -> String
+    def inspect
+      to_s
+    end
+
+    # Vector addition
+    #
+    #: (Vector other) -> Vector
+    def +(other)
+      Vector.new(@x + other.x, @y + other.y, @z + other.z)
+    end
+
+    # Vector subtraction
+    #
+    #: (Vector other) -> Vector
+    def -(other)
+      Vector.new(@x - other.x, @y - other.y, @z - other.z)
+    end
+
+    # Scalar multiplication
+    #
+    #: (Integer | Float other) -> Vector
+    def *(other)
+      Vector.new(@x * other, @y * other, @z * other)
+    end
+
+    # Magnitude (length) of the vector
+    #
+    #: () -> Float
+    def magnitude
+      Math.sqrt((@x * @x) + (@y * @y) + (@z * @z))
+    end
+
+    # Normalize the vector (unit vector)
+    #
+    #: () -> Vector
+    def normalize
+      mag = magnitude
+      return Vector.new(0, 0, 0) if mag.zero?
+
+      Vector.new(@x / mag, @y / mag, @z / mag)
+    end
+  end
+
+  # origin at bottom-left, Y pointing up
+  GRAVITY = Vector.new(0, -9.81, 0).freeze #: Vector
+
+  # origin at top-left, Y pointing down
+  TERMINAL_GRAVITY = Vector.new(0, 9.81, 0).freeze #: Vector
+end

data/lib/harmonica/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 module Harmonica
-  VERSION = "0.0.1"
+  VERSION = "0.1.0" #: String
 end

data/lib/harmonica.rb

@@ -1,8 +1,22 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 require_relative "harmonica/version"
+require_relative "harmonica/spring"
+require_relative "harmonica/point"
+require_relative "harmonica/vector"
+require_relative "harmonica/projectile"
 
 module Harmonica
-  class Error < StandardError; end
-  # Your code goes here...
+  # 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(frames_per_second)
+    1.0 / frames_per_second
+  end
 end

metadata

@@ -1,39 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: harmonica
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Marco Roth
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: lipgloss
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-description: Ruby bindings for the Harmonica physics-based animation library.
+dependencies: []
+description: Ruby implementation of Charm's Harmonica. A simple, efficient spring
+  animation library for smooth, natural motion.
 email:
 - marco.roth@intergga.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
+- LICENSE.txt
 - README.md
 - harmonica.gemspec
 - lib/harmonica.rb
+- lib/harmonica/point.rb
+- lib/harmonica/projectile.rb
+- lib/harmonica/spring.rb
+- lib/harmonica/vector.rb
 - lib/harmonica/version.rb
 homepage: https://github.com/marcoroth/harmonica-ruby
 licenses:
@@ -41,7 +32,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/marcoroth/harmonica-ruby
   source_code_uri: https://github.com/marcoroth/harmonica-ruby
-  changelog_uri: https://github.com/marcoroth/harmonica-ruby/blob/main/CHANGELOG.md
+  changelog_uri: https://github.com/marcoroth/harmonica-ruby/releases
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -50,14 +41,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
-summary: Ruby bindings for the Harmonica physics-based animation library.
+summary: A simple, physics-based animation library for Ruby.
 test_files: []

data/CHANGELOG.md

@@ -1,5 +0,0 @@
-## [Unreleased]
-
-## [0.1.0] - 2025-12-23
-
-- Initial release