philiprehberger-approx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ddae870e2bf316dae4d17e6328f0ac6258d1d0555e8abd1fa9968b91738cfc3
+  data.tar.gz: f7fd4f79dc256eaed4eb797b12ae76f42e8596aed8c9007f002edb9c8fea2049
+SHA512:
+  metadata.gz: 78a636564c186efc79cdb832ceeebd4f43446b85f122036de671f4b656ee73858d27fe6c8ec0ac7fdb7e0615570d4a8c2ca9040bd34514259112efe71f5c741e
+  data.tar.gz: fc2bee9cab8c3dff75447785ba877c8579039c7906b60b5c7b24c2d1e9a1909c08360b4d9729af8cbe627e518803218b995055b00b1cb29c66622b14fcde75ef

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this gem will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-03-22
+
+### Added
+- Initial release
+- Epsilon-based approximate equality for floats
+- Deep comparison for arrays and hashes
+- Assert method that raises on mismatch

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 philiprehberger
+
+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

@@ -0,0 +1,84 @@
+# philiprehberger-approx
+
+[![Tests](https://github.com/philiprehberger/rb-approx/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/rb-approx/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/philiprehberger-approx.svg)](https://rubygems.org/gems/philiprehberger-approx)
+[![License](https://img.shields.io/github/license/philiprehberger/rb-approx)](LICENSE)
+
+Epsilon-based approximate equality for floats, arrays, and hashes
+
+## Requirements
+
+- Ruby >= 3.1
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'philiprehberger-approx'
+```
+
+Or install directly:
+
+```bash
+gem install philiprehberger-approx
+```
+
+## Usage
+
+```ruby
+require 'philiprehberger/approx'
+
+Philiprehberger::Approx.equal?(1.0, 1.0 + 1e-10)
+# => true
+
+Philiprehberger::Approx.equal?(1.0, 1.1)
+# => false
+```
+
+### Custom Epsilon
+
+```ruby
+Philiprehberger::Approx.equal?(1.0, 1.05, epsilon: 0.1)
+# => true
+```
+
+### Array and Hash Comparison
+
+```ruby
+Philiprehberger::Approx.equal?([1.0, 2.0], [1.0 + 1e-10, 2.0])
+# => true
+
+Philiprehberger::Approx.equal?({ x: 1.0 }, { x: 1.0 + 1e-10 })
+# => true
+```
+
+### Assert Near
+
+```ruby
+Philiprehberger::Approx.assert_near(1.0, 1.0 + 1e-10)
+# => nil (no error)
+
+Philiprehberger::Approx.assert_near(1.0, 2.0)
+# => raises Philiprehberger::Approx::Error
+```
+
+## API
+
+| Method | Description |
+|--------|-------------|
+| `.equal?(a, b, epsilon: 1e-9)` | Check approximate equality within epsilon |
+| `.near?(a, b, epsilon: 1e-9)` | Alias for `.equal?` |
+| `.assert_near(a, b, epsilon: 1e-9)` | Raise `Error` if values differ by more than epsilon |
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec
+bundle exec rubocop
+```
+
+## License
+
+MIT

data/lib/philiprehberger/approx/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module Approx
+    VERSION = '0.1.0'
+  end
+end

data/lib/philiprehberger/approx.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative 'approx/version'
+
+module Philiprehberger
+  module Approx
+    class Error < StandardError; end
+
+    # Check if two values are approximately equal within epsilon
+    #
+    # @param a [Numeric, Array, Hash] first value
+    # @param b [Numeric, Array, Hash] second value
+    # @param epsilon [Float] maximum allowed difference
+    # @return [Boolean] true if values are approximately equal
+    def self.equal?(a, b, epsilon: 1e-9)
+      compare(a, b, epsilon)
+    end
+
+    # Alias for equal? with explicit epsilon
+    #
+    # @param a [Numeric, Array, Hash] first value
+    # @param b [Numeric, Array, Hash] second value
+    # @param epsilon [Float] maximum allowed difference
+    # @return [Boolean] true if values are near each other
+    def self.near?(a, b, epsilon: 1e-9)
+      equal?(a, b, epsilon: epsilon)
+    end
+
+    # Assert that two values are approximately equal, raising on mismatch
+    #
+    # @param a [Numeric, Array, Hash] first value
+    # @param b [Numeric, Array, Hash] second value
+    # @param epsilon [Float] maximum allowed difference
+    # @raise [Error] if values differ by more than epsilon
+    def self.assert_near(a, b, epsilon: 1e-9)
+      return if equal?(a, b, epsilon: epsilon)
+
+      raise Error, "expected #{a.inspect} to be near #{b.inspect} (epsilon: #{epsilon})"
+    end
+
+    class << self
+      private
+
+      def compare(a, b, epsilon)
+        case [a, b]
+        in [Numeric, Numeric]
+          (a - b).abs <= epsilon
+        in [Array, Array]
+          return false unless a.length == b.length
+
+          a.zip(b).all? { |x, y| compare(x, y, epsilon) }
+        in [Hash, Hash]
+          return false unless a.keys.sort == b.keys.sort
+
+          a.all? { |k, v| compare(v, b[k], epsilon) }
+        else
+          a == b
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: philiprehberger-approx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philip Rehberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-22 00:00:00.000000000 Z
+dependencies: []
+description: Compare numeric values, arrays, and hashes for approximate equality using
+  configurable epsilon tolerance with deep comparison support.
+email:
+- me@philiprehberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/philiprehberger/approx.rb
+- lib/philiprehberger/approx/version.rb
+homepage: https://github.com/philiprehberger/rb-approx
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philiprehberger/rb-approx
+  source_code_uri: https://github.com/philiprehberger/rb-approx
+  changelog_uri: https://github.com/philiprehberger/rb-approx/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/philiprehberger/rb-approx/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Epsilon-based approximate equality for floats, arrays, and hashes
+test_files: []