Add Basic Unit Tests and Github Actions Workflow

[keenanjohnson]

Love this project! I am working with the Seattle Aquarium folks as a volunteer and they are heavy users of the CoralNet-Toolbox. I was looking through the project and trying to figure out ways I could give back and noticed there was just a placeholder for tests. I thought this could be a quick / small way to give back a bit and improve the project for others.

[gemini-code-assist]

Summary of Changes

Hello @keenanjohnson, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

I've added comprehensive unit tests for the simplify_polygon utility function within the coralnet_toolbox project. This contribution aims to improve the project's reliability and maintainability by ensuring the correct behavior of this important geometric simplification function across various scenarios, addressing a previous placeholder for tests.

Highlights

• New Unit Tests for simplify_polygon: I've introduced a new test suite specifically for the simplify_polygon utility function, ensuring its robustness and correctness across a wide range of inputs and scenarios.
• Comprehensive Test Coverage: The added tests cover critical aspects such as the simplification of complex polygons, the impact of different simplify_tolerance values, handling of numpy array inputs, and behavior with self-intersecting or multi-polygon geometries. Edge cases like minimal polygons and zero/large tolerance values are also addressed.
• Leveraging pytest and shapely: These tests utilize pytest for its efficient test discovery and assertion capabilities, along with shapely for geometric object creation and validation, ensuring that the simplify_polygon function behaves as expected in real-world applications.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This is a great contribution! Adding a test suite is a fantastic way to improve the project's robustness and maintainability. The tests cover a good range of scenarios for the simplify_polygon function. I've made a few suggestions to make the tests even more precise and comprehensive by using pytest.approx for float comparisons and strengthening some assertions for edge cases. Thank you for your work on this!

[Jordan-Pierce]

Thanks @keenanjohnson will merge it in a bit