vector2d 2.2.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc16e15dbb07e3fe138a13fdc3cc8edd6c1369e53bf337a47b8034359b826fa2
-  data.tar.gz: b4077e6730cd248749960253a22b78a89a9f876ebfd5ca4a097d42c44c246aa7
+  metadata.gz: 02eaa1a646eca603d58bc80b84ad7c1d3f4973df2a9837caa722a6e706b8ad4b
+  data.tar.gz: 29b5dbc22b83bc53946c9da06caf119fa07d5e2c8cf39d940e7f751ec4426065
 SHA512:
-  metadata.gz: a93da54adf875ed88cc5f2fc7ab31a8f919d8352ddf2ee7259290ac2ed0a160b8edbf178f40788fd0e1f57c1c125877a20b6f3bbc3f8320d3929efb64da6862c
-  data.tar.gz: d1ed6fab76e6c0cd4c74104ed997927fb377dad0fd75790f576777392fc73d235b5e828a73b2d7c3bc2b00c54246c21a48fc36539f00870eb23c07767a80b477
+  metadata.gz: 206db7be3e3cd57909d8200f09504dc8c539ec1a6c1f4fa6e1015cd21496577445004c3cb319547d1bbdab3dd8bf25fb6fa94428bb564432c41d86a32016f234
+  data.tar.gz: 94213c539359dd0f7ccac221a5a3361838d84612115d20c7bdc91788a579cccbe397b8bc8d6147ab06420f72fbaa566f18f4e700654633b152833029ac9e73a9

data/.github/dependabot.yml

@@ -0,0 +1,39 @@
+---
+version: 2
+
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "tuesday"
+      time: "06:00"
+      timezone: "Europe/Oslo"
+    cooldown:
+      default-days: 3
+      semver-major-days: 7
+      semver-minor-days: 5
+      semver-patch-days: 3
+    groups:
+      all-dependencies:
+        patterns:
+          - "*"
+    open-pull-requests-limit: 5
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "tuesday"
+      time: "05:30"
+      timezone: "Europe/Oslo"
+    cooldown:
+      default-days: 3
+    ignore:
+      - dependency-name: "*"
+        update-types: ["version-update:semver-major"]
+    groups:
+      all-dependencies:
+        patterns:
+          - "*"
+    open-pull-requests-limit: 5

data/.github/workflows/build.yml

@@ -6,15 +6,20 @@ on:
       - main
       - develop
   pull_request:
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+  id-token: write
 jobs:
   rubocop-test:
     name: Rubocop
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - uses: ruby/setup-ruby@v1
+      - uses: actions/checkout@v6.1.0
+      - uses: ruby/setup-ruby@v1.321.0
         with:
-          ruby-version: 3.2
+          ruby-version: "4.0"
           bundler-cache: true
       - name: Check code
         run: bundle exec rubocop
@@ -24,18 +29,51 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: ['2.7', '3.0', '3.1', '3.2']
+        ruby: ["3.4", "4.0"]
     steps:
-      - uses: actions/checkout@v1
-      - uses: ruby/setup-ruby@v1
+      - uses: actions/checkout@v6.1.0
+      - uses: ruby/setup-ruby@v1.321.0
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
       - name: Run tests
         run: bundle exec rspec
-      - name: Send results to Code Climate
-        uses: paambaati/codeclimate-action@v3.2.0
+
+  automerge:
+    name: "Auto-merge Dependabot"
+    needs: [rubocop-test, rspec-test]
+    if: github.actor == 'dependabot[bot]'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Enable auto-merge
+        run: gh pr merge --auto --squash "$PR_URL"
         env:
-          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  release-please:
+    needs: [rubocop-test, rspec-test]
+    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release
         with:
-          coverageCommand: ls
+          token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
+
+  publish:
+    needs: release-please
+    if: ${{ needs.release-please.outputs.release_created }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6.1.0
+        with:
+          ref: ${{ needs.release-please.outputs.tag_name }}
+      - uses: ruby/setup-ruby@v1.321.0
+        with:
+          ruby-version: "4.0"
+          bundler-cache: true
+      - uses: rubygems/release-gem@v1

data/.gitignore

@@ -1,3 +1,5 @@
+.yardoc
 coverage
-rdoc
+doc
 pkg
+rdoc

data/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "3.0.0"
+}

data/.rubocop.yml

@@ -1,10 +1,10 @@
-require:
+plugins:
   - rubocop-rake
   - rubocop-rspec
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.4
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
@@ -24,3 +24,6 @@ Naming/MethodParameterName:
   AllowedNames:
     - "x"
     - "y"
+
+RSpec/IndexedLet:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 4.0

data/.yardopts

@@ -0,0 +1,11 @@
+--markup rdoc
+--readme README.md
+--title "Vector2d"
+--output-dir doc
+lib/vector2d.rb
+lib/vector2d/**/*.rb
+-
+CHANGELOG.md
+CONTRIBUTING.md
+CODE_OF_CONDUCT.md
+LICENSE

data/CHANGELOG.md

@@ -0,0 +1,224 @@
+# Changelog
+
+## [3.0.0](https://github.com/elektronaut/vector2d/compare/vector2d/v2.3.0...vector2d/v3.0.0) (2026-09-20)
+
+The public API grows from 43 methods to 115. Vectors are now genuinely
+immutable and safe to share between ractors, they can be pattern matched,
+and they convert to and from the standard library `Matrix` and `Vector`.
+
+Nothing was removed. The seven deprecated methods still work, and stay
+silent unless deprecation warnings are enabled.
+
+Most of the breaking changes correct behavior that was undefined or plainly
+wrong in 2.x: input that used to produce an unusable vector now raises where
+the bad input is, rather than somewhere further along. Four changes can
+affect code that works today, and they come first.
+
+### Breaking changes
+
+#### Ruby 3.4 is now the minimum, up from 3.2
+
+`MatrixInterop#to_matrix`, `#to_vector` and `#transform` are not
+ractor-safe before 3.4. Ruby 3.2 raises `Ractor::IsolationError` from the
+`require`, and 3.3 raises out of `::Vector[]` even with `matrix` already
+loaded. The floor moves so the matrix paths are safe across the whole
+supported range, and the gemspec stops claiming versions CI never ran.
+
+#### Vectors are frozen
+
+Instances are frozen on construction, which is what makes them shareable
+between ractors when their coordinates are. `#dup` and `clone(freeze: false)`
+return frozen objects, matching `Data`, `Rational` and `Complex`.
+
+A subclass that adds instance variables must assign them before calling
+`super`, as the object is frozen by the time `super` returns.
+
+#### Strings keep their coordinate type
+
+`Vector2d.parse("50x70")` returns `Vector2d(50,70)` with `Integer`
+coordinates. It previously returned floats, which made strings the one
+input type that did not preserve what it was given.
+
+Parsing is stricter about malformed input and more permissive about valid
+input. `"1.2.3x4"` was accepted and silently truncated, and now raises.
+Negative coordinates, an uppercase `X` separator and comma-separated pairs
+are now accepted.
+
+#### Coordinates must be `Numeric`
+
+Coordinates were never validated, so any unrecognized argument fell through
+to the constructor. `Vector2d.parse(nil)` returned `Vector2d(nil,nil)` and
+raised `NoMethodError` later at an unrelated call site.
+
+Every parse path now checks both coordinates. `Integer`, `Float`, `Rational`,
+`BigDecimal` and custom `Numeric` subclasses are unaffected. Objects that
+are numeric by duck typing alone are no longer accepted.
+
+#### Tightened validation
+
+These raise where 2.x returned something unusable. Code that was working is
+unlikely to notice.
+
+- `Vector2d(2, 0).aspect_ratio` returned `Infinity` and the zero vector
+  returned `NaN`. Both now raise `ArgumentError`.
+- `Complex` passed the coordinate check, and the resulting vector raised
+  `RangeError` out of `Math` from `#aspect_ratio` and `.from_angle`. It is
+  now rejected: `ArgumentError` from `.parse`, `.new` and `.from_angle`,
+  `TypeError` from the operators.
+- `Vector2d.parse(5, nil)` read the explicit `nil` as an omitted argument
+  and returned `Vector2d(5,5)`. An explicit `nil` second argument now
+  raises `ArgumentError`.
+- `Vector2d(2, 3).clamp_length(-1.0)` returned a reversed unit vector
+  rather than anything shorter. A negative maximum now raises
+  `ArgumentError`, following `Comparable#clamp`. This applies to
+  `#truncate` as well. Pass `max.clamp(0..)` to saturate instead.
+  `#resize` is unchanged, where a negative length is a signed magnitude
+  that reverses the vector.
+- `#fit` and `#fit_either` returned early on the zero vector, before the
+  argument was coerced, so `Vector2d(0, 0).fit("garbage")` returned the
+  zero vector. Both now raise `ArgumentError`, as every other receiver
+  already did.
+
+#### Subclasses
+
+Two places where a subclass could be dropped on the way through:
+
+- `#coerce` built the left-hand operand with `.parse`, so `2 * subvector`
+  returned a `Vector2d` where `subvector * 2` returned the subclass. It now
+  builds through `#build`, so coercion is symmetric. `#coerce_vector` is
+  unchanged, so methods that only read an operand's coordinates still parse
+  into the base class.
+- `.parse` returned any `Vector2d` argument untouched, so `Sub.parse(vector)`
+  handed back the plain vector. An argument is returned as it is only when
+  it is already an instance of the class parsing it; anything else is
+  rebuilt through `.build`.
+
+### Deprecations
+
+All of these still work. They warn under `Warning[:deprecated] = true` or
+`ruby -w`, and each one names its replacement.
+
+| Deprecated          | Replacement                     |
+| ------------------- | ------------------------------- |
+| `#truncate`         | `#limit_length`                 |
+| `#squared_length`   | `#length_squared`               |
+| `#squared_distance` | `#distance_squared`             |
+| `#fit_either`       | `#cover`                        |
+| `#constrain_both`   | `#fit`                          |
+| `#constrain_one`    | `#cover`                        |
+| `#contain`          | `other.fit(self, upscale: false)` |
+
+`#truncate` is the one worth looking at. It took a maximum length, where
+`Numeric#truncate` takes a digit count, and the name went to the wrong
+method. `#limit_length` replaces it.
+
+### Features
+
+#### Construction
+
+`.build` and `#build` are the hooks every returning method routes through,
+so a subclass overrides construction in one place.
+
+- `Vector2d.from_angle(angle, length = 1.0)` and `#to_polar`
+- `Vector2d.from_degrees(angle, length = 1.0)`
+- `Vector2d.random(length = 1.0, random: Random)`
+- `Vector2d.zero`, `.one`, `.up`, `.down`, `.left` and `.right`
+
+#### Angles and rotation
+
+- `#angle_to` returns a signed angle in `-PI..PI`, positive when the other
+  vector is counterclockwise. `#angle_between` stays unsigned in `0..PI`.
+- `Vector2d.degrees` and `.radians` convert between the two
+- `#angle_in_degrees` and `#rotate_degrees`
+- `#rotate_around(center, angle)`
+- `#perpendicular_cw`, alongside the existing counterclockwise
+  `#perpendicular`
+
+#### Length and distance
+
+- `#length_squared` and `#distance_squared`, which skip the square root
+- `#manhattan_distance` and `#chebyshev_distance`
+- `#limit_length(max)` scales down only if longer
+- `#clamp_length(min, max = nil)` takes a range or a pair, mirroring
+  `Comparable#clamp`
+- `#direction_to`
+- `#magnitude` and `#norm` as aliases of `#length`
+
+#### Projection and reflection
+
+- `#project`, `#reject` and `#scalar_projection`
+- `#reflect(normal)` and `#refract(normal, refractive_index)`
+- `#dot` and `#inner_product` as aliases of `#dot_product`
+
+#### Interpolation
+
+- `#lerp`, `#inverse_lerp` and `#slerp`
+- `#midpoint`
+- `#move_toward(target, distance)`
+
+#### Comparison
+
+- `#eql?` and `#hash`, so vectors work as hash keys
+- `#approx_equal?(other, tolerance = nil)` and `#approx_zero?`
+- `#zero?`, `#finite?` and `#nan?`
+- `#parallel?`, `#perpendicular?`, `#opposite?` and `#independent?`
+
+#### Component-wise operations
+
+- Unary `+@` and `-@`
+- `#abs`, `#sign` and `#snap(step)`
+- `#with_x` and `#with_y`
+- `#min` and `#max`
+- `#floor` and `#ceil` take a digit count
+
+#### Dimensions and fitting
+
+- `#cover(other, upscale: true)` scales to the smallest size that fills the
+  box, the counterpart to `#fit`
+- `#fit(other, upscale: false)` never scales up
+- `#fits?` and `#covers?`
+- `#area`, `#square?`, `#portrait?` and `#landscape?`
+
+#### Standard library compatibility
+
+- `#to_matrix`, `#to_vector` and `#transform(matrix)`
+- `#deconstruct` and `#deconstruct_keys` for pattern matching
+
+### Bug fixes
+
+- `#angle_between` is computed with `atan2` rather than
+  `Math.acos(dot_product)`, which raised `Math::DomainError` whenever float
+  normalization pushed the dot product past ±1.0. That happened for roughly
+  15% of parallel and antiparallel pairs in a random probe. The zero vector
+  now gives `0.0` instead of `NaN`. The range is unchanged.
+- The angle converters always return floats, so a `BigDecimal` angle no
+  longer leaks through.
+- `#perpendicular` and `#rotate` preserve the receiver's class.
+- `#inspect` renders the receiver's class.
+- `#normalize` and `#resize` return the zero vector unchanged, where they
+  previously returned `NaN` coordinates.
+- `#reflect` guards against a zero normal, returning the vector unchanged.
+- `#project` returns a float zero when projecting onto the zero vector.
+- `#lerp` requires a real number as the amount.
+- `#fit` and `#fit_either` handle negative vectors and zero coordinates by
+  magnitude.
+- `#==` returns false for non-vectors instead of raising.
+- Scalar arguments are validated in the transformations.
+- Internal files are loaded with `require_relative`.
+- The gemspec has a `changelog_uri`.
+
+### Performance improvements
+
+Roughly 1.6x faster than the standard library `Vector` on the common
+operations.
+
+- Operands that are already usable skip the parser
+- Coercion skips the parser for vectors
+- The common coordinate types are checked first
+
+## [2.3.0](https://github.com/elektronaut/vector2d/compare/vector2d-v2.2.4...vector2d/v2.3.0) (2026-08-30)
+
+
+### Features
+
+* Add Vector2d#clamp ([de77e58](https://github.com/elektronaut/vector2d/commit/de77e584f8f5668f24186179b720b4db9a70f6d2))

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,92 @@
+
+# Contributor Covenant 3.0 Code of Conduct
+
+## Our Pledge
+
+We pledge to make our community welcoming, safe, and equitable for all.
+
+We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
+
+## Encouraged Behaviors
+
+While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
+
+With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
+
+1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
+2. Engaging **kindly and honestly** with others.
+3. Respecting **different viewpoints** and experiences.
+4. **Taking responsibility** for our actions and contributions.
+5. Gracefully giving and accepting **constructive feedback**.
+6. Committing to **repairing harm** when it occurs.
+7. Behaving in other ways that promote and sustain the **well-being of our community**.
+
+
+## Restricted Behaviors
+
+We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
+
+1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
+2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
+3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
+4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
+5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
+6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
+7. Behaving in other ways that **threaten the well-being** of our community.
+
+### Other Restrictions
+
+1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
+2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
+3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
+4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
+
+
+## Reporting an Issue
+
+Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
+
+When an incident does occur, it is important to report it promptly. To report a possible violation, **contact the project maintainer at inge@elektronaut.no.**
+
+Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
+
+
+## Addressing and Repairing Harm
+
+****
+
+If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
+
+1) Warning
+   1) Event: A violation involving a single incident or series of incidents.
+   2) Consequence: A private, written warning from the Community Moderators.
+   3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
+2) Temporarily Limited Activities
+   1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
+   2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
+   3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
+3) Temporary Suspension
+   1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
+   2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
+   3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
+4) Permanent Ban
+   1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
+   2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
+   3) Repair: There is no possible repair in cases of this severity.
+
+This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
+
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
+
+Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
+
+For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).
+

data/CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing
+
+Bug reports and pull requests are welcome on
+[GitHub](https://github.com/elektronaut/vector2d). Everyone participating is
+expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Getting started
+
+Install the dependencies and run the test suite:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+Check style before pushing:
+
+```sh
+bundle exec rubocop
+```
+
+## Pull requests
+
+- Add tests for any behavior you change.
+- Write commit messages using
+  [Conventional Commits](https://www.conventionalcommits.org). The
+  changelog and releases are generated from them, so the `feat:` and
+  `fix:` prefixes decide what ends up in the next release.
+- Leave the version and the changelog alone. Both are updated
+  automatically when a release is cut.

data/Gemfile

@@ -5,11 +5,15 @@ source "https://rubygems.org"
 gemspec
 
 group :development, :test do
+  gem "bigdecimal"
+  gem "irb"
+  gem "matrix"
   gem "rake"
   gem "rspec", "~> 3.8"
-  gem "rspec-its", "~> 1.3"
+  gem "rspec-its", "~> 2.0"
   gem "rubocop", require: false
   gem "rubocop-rake", require: false
   gem "rubocop-rspec", require: false
-  gem "simplecov", "~> 0.17.1"
+  gem "simplecov", "~> 1.2.0"
+  gem "yard", require: false
 end