Use stable sort

[ciscorn]

• Use stable sort
  • Sorting algorithm has changed in Rust 1.81, which is causing our tests to fail: New sort implementations - Announcing Rust 1.81.0
    
• Update README to reflect earcut(-js) 3.0.0 release: earcut v3.0.0 Release
  • Note: The triangulation algorithm hasn’t changed since version 2.2.4.

[coderabbitai]

Walkthrough

The changes in this pull request involve updates to the README.md file for the earcut-rs project, where the version number has been changed from 2.2.4 to 3.0.0. The description regarding memory allocation has been clarified, and the author section has been reformatted to remove an unnecessary line break. Additionally, modifications were made in src/lib.rs to change the sorting method in the eliminate_holes function, and several test functions in tests/fixture.rs were renamed to resolve naming conflicts and enhance error reporting.

Changes

File	Change Summary
README.md	Updated version from 2.2.4 to 3.0.0; clarified memory allocation description; reformatted author section.
src/lib.rs	Changed sorting method in eliminate_holes from sort_unstable_by to sort_by.
tests/fixture.rs	Enhanced assertions in test_fixture; renamed fixture_water to fixture_water1 and fixture_water_huge to fixture_water_huge1.

Poem

In the garden where code does bloom,
A version change dispels the gloom.
With memory clear and authors bright,
The earcut-rs shines in the light!
Hopping forward, we celebrate,
A leap in logic, oh, isn’t it great! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5c1c3d2 and 3dc4dfd.

⛔ Files ignored due to path filters (1)

• Cargo.toml is excluded by !**/*.toml

📒 Files selected for processing (2)

• src/lib.rs (1 hunks)
• tests/fixture.rs (3 hunks)

🧰 Additional context used

🔇 Additional comments (5)

tests/fixture.rs (4)

30-35: Improved error reporting in assertion.

The changes enhance the error message for the triangle count assertion, providing both the actual and expected counts. This improvement will make debugging easier if the test fails.

---

77-77: Consistent function renaming.

The renaming of fixture_water_huge to fixture_water_huge1 is consistent with the earlier renaming of fixture_water. This change maintains the naming convention established earlier.

To ensure this renaming is part of a consistent refactoring effort, please check if there are any remaining test functions that might need similar renaming:

#!/bin/bash
# Description: Check for any remaining water-related test functions that might need renaming.
rg -n 'fn fixture_water(?!.*\d)' tests/fixture.rs

---

Line range hint 1-241: Summary of changes in tests/fixture.rs

The modifications in this file focus on improving error reporting and test organization:

1. Enhanced error message in the test_fixture function for better debugging.
2. Renamed fixture_water to fixture_water1 and fixture_water_huge to fixture_water_huge1 for better organization and to avoid potential naming conflicts.

These changes improve the maintainability and clarity of the test suite without altering the underlying test logic. The consistent renaming suggests a possible larger refactoring effort to organize water-related tests.

To ensure these changes are part of a consistent refactoring effort, please review the entire test file for any remaining inconsistencies in test function naming:

#!/bin/bash
# Description: List all test function names to verify naming consistency.
rg -n '^\s*fn fixture_' tests/fixture.rs | sort

---

52-52: Function renamed for clarity.

The renaming of fixture_water to fixture_water1 helps avoid potential naming conflicts. This change improves test organization without affecting functionality.

Please ensure that this renaming is consistent with other test functions and doesn't introduce confusion. You may want to check if there are other similar test functions that might benefit from a similar naming convention.

src/lib.rs (1)

291-291: 🛠️ Refactor suggestion

Consider the performance implications of changing the sorting method.

The change from sort_unstable_by to sort_by ensures that the order of equal elements is preserved. While this might be necessary for the correct functioning of the algorithm, it's worth noting that sort_unstable_by is generally faster.

To ensure this change doesn't negatively impact performance or introduce unexpected behavior, please run the following verification:

If there are no performance tests or benchmarks, consider adding some to measure the impact of this change.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

README.md (1)

10-10: Improved clarity on memory allocation. Consider minor rewording.

The updated description provides better clarity on the reusability of internal buffers and output index vectors. This is a good improvement in explaining the library's behavior.

For even better clarity, consider rewording slightly:

- Designed to avoid unnecessary memory allocations. The internal buffer and output index vector can be reused across multiple triangulations.
+ Optimized for memory efficiency. The internal buffer and output index vector are designed to be reusable across multiple triangulations, reducing unnecessary allocations.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5782ed0 and 5c1c3d2.

📒 Files selected for processing (1)

• README.md (2 hunks)

🧰 Additional context used

🔇 Additional comments (2)

README.md (2)

43-43: Improved formatting in Authors section.

The removal of the unnecessary line break after "MIERUNE Inc." improves the readability of the Authors section. This is a good formatting change.

---

9-9: Version update looks good. Consider documenting breaking changes.

The update to version 3.0.0 aligns with the PR objective. As this is a major version bump, it's important to ensure that any breaking changes are properly documented.

To verify if there are any breaking changes that need documentation, please run the following script:

✅ Verification successful

Version update verified. No breaking changes found.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for potential breaking changes in the codebase

# Test: Look for BREAKING CHANGE or BREAKING CHANGES in commit messages
git log --oneline --grep="BREAKING CHANGE" --grep="BREAKING CHANGES" $(git describe --tags --abbrev=0)..HEAD

# Test: Check for changes in public API (assuming public functions are prefixed with 'pub')
git diff $(git describe --tags --abbrev=0)..HEAD | grep '^[+-]pub'

# Test: Check for changes in Cargo.toml
git diff $(git describe --tags --abbrev=0)..HEAD Cargo.toml

Length of output: 391

---

Script:

#!/bin/bash
# Description: Check for potential breaking changes in the codebase, handling repositories without tags.

# Determine the base commit. Use the latest tag if available; otherwise, use the initial commit.
BASE_COMMIT=$(git describe --tags --abbrev=0 2>/dev/null || git rev-list --max-parents=0 HEAD)

# Verify if BASE_COMMIT was successfully determined
if [ -z "$BASE_COMMIT" ]; then
  echo "Error: Unable to determine the base commit."
  exit 1
fi

echo "Base commit for comparison: $BASE_COMMIT"

# Test 1: Look for BREAKING CHANGE or BREAKING CHANGES in commit messages since the base commit
echo "Checking commit messages for breaking changes..."
git log --oneline --grep="BREAKING CHANGE" --grep="BREAKING CHANGES" $BASE_COMMIT..HEAD

# Test 2: Check for changes in public API (assuming public functions are prefixed with 'pub')
echo "Checking for changes in public API..."
git diff $BASE_COMMIT..HEAD | grep '^[+-]pub'

# Test 3: Check for changes in Cargo.toml
echo "Checking for changes in Cargo.toml..."
git diff $BASE_COMMIT..HEAD Cargo.toml

Length of output: 866

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.56%. Comparing base (5782ed0) to head (3dc4dfd).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #17      +/-   ##
==========================================
- Coverage   99.56%   99.56%   -0.01%     
==========================================
  Files           2        2              
  Lines         928      927       -1     
==========================================
- Hits          924      923       -1     
  Misses          4        4              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.