search

open-space-collective / open-space-toolkit-physics

Physical units, time, reference frames, environment modeling.
https://open-space-collective.github.io/open-space-toolkit-physics/
Apache License 2.0
25 stars 7 forks source link

refactor!: base manager class #281

Closed vishwa2710 closed 2 weeks ago

vishwa2710 commented 4 weeks ago

This MR refactors the various Managers by creating a Parent "BaseManager" class. It is a breaking change as some of the static methods no longer exist, however all the functionality is maintained.

The unit tests are partially updated. I have to remove some of the common unit tests in the various managers and create a Manager.test.cpp for the Base Manager class. Also the python bindings have to be updated. But this is ready for an initial review.

Summary by CodeRabbit

codecov[bot] commented 4 weeks ago

Codecov Report

Attention: Patch coverage is 90.47619% with 14 lines in your changes missing coverage. Please review.

Project coverage is 81.84%. Comparing base (70b4ca8) to head (6310e75).

Files with missing lines Patch % Lines
src/OpenSpaceToolkit/Physics/Manager.cpp 88.65% 11 Missing :warning:
.../Physics/Environment/Atmospheric/Earth/Manager.cpp 94.73% 1 Missing :warning:
...hysics/Environment/Gravitational/Earth/Manager.cpp 92.30% 1 Missing :warning:
...kit/Physics/Environment/Magnetic/Earth/Manager.cpp 92.30% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #281 +/- ## ========================================== - Coverage 82.05% 81.84% -0.21% ========================================== Files 100 101 +1 Lines 8279 8071 -208 ========================================== - Hits 6793 6606 -187 + Misses 1486 1465 -21 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

coderabbitai[bot] commented 2 weeks ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes involve significant modifications to the Manager class across various modules of the OpenSpaceToolkit Physics library. The Manager class now inherits from BaseManager, leading to the removal of several member functions and variables related to mode and local repository management. The constructor has been simplified to a default constructor without parameters. Additionally, several methods have been renamed or marked as virtual to facilitate overriding in derived classes. The overall structure is streamlined, focusing on leveraging base class functionality and simplifying internal management.

Changes

File Change Summary
include/OpenSpaceToolkit/Physics/Coordinate/Frame/Provider/IERS/Manager.hpp Class now inherits from BaseManager. Removed Mode enum and associated methods. Simplified constructor to default. Marked reset() and setup_() as virtual.
include/OpenSpaceToolkit/Physics/Environment/Atmospheric/Earth/Manager.hpp Class now inherits from BaseManager. Removed Mode enum and related methods. Constructor simplified. Added new methods for CSSI Space Weather management. Renamed setup() to setup_().
include/OpenSpaceToolkit/Physics/Environment/Gravitational/Earth/Manager.hpp Class now inherits from BaseManager. Removed Mode enum and local repository management methods. Renamed getDataFileUrlsForType() and DataFileNameFromType().
include/OpenSpaceToolkit/Physics/Environment/Magnetic/Earth/Manager.hpp Class now inherits from BaseManager. Removed Mode enum and local repository management methods. Renamed getDataFileUrlsForType() and DataFileNameFromType().
include/OpenSpaceToolkit/Physics/Manager.hpp New file introducing a thread-safe base class Manager with methods for managing a local repository and operational modes.
src/OpenSpaceToolkit/Physics/Coordinate/Frame/Provider/IERS/Manager.cpp Removed methods related to mode and repository management. Constructor modified to initialize using BaseManager. Updated reset() and setup_() methods.
src/OpenSpaceToolkit/Physics/Environment/Atmospheric/Earth/Manager.cpp Removed methods related to mode and repository management. Renamed several methods for clarity. Updated reset() to call BaseManager::reset().
src/OpenSpaceToolkit/Physics/Environment/Gravitational/Earth/Manager.cpp Removed multiple methods related to mode and local repository management. Constructor modified to initialize BaseManager. Renamed methods for consistency.
src/OpenSpaceToolkit/Physics/Environment/Magnetic/Earth/Manager.cpp Removed methods related to mode and local repository management. Constructor modified to initialize BaseManager. Renamed methods for consistency.
src/OpenSpaceToolkit/Physics/Manager.cpp Implements the Manager class managing a local repository with methods for mode and repository management.
test/OpenSpaceToolkit/Physics/Coordinate/Frame/Provider/IERS/Manager.test.cpp Removed tests for DefaultMode, DefaultLocalRepository, and DefaultLocalRepositoryLockTimeout.
test/OpenSpaceToolkit/Physics/Environment/Atmospheric/Earth/Manager.test.cpp Removed tests for mode and local repository management.
test/OpenSpaceToolkit/Physics/Environment/Gravitational/Earth.test.cpp Replaced calls to setLocalRepository with reset() in tests.
test/OpenSpaceToolkit/Physics/Environment/Gravitational/Earth/Manager.test.cpp Removed tests for mode and local repository management.
test/OpenSpaceToolkit/Physics/Environment/Magnetic/Earth.test.cpp Replaced calls to setLocalRepository with reset() in tests.
test/OpenSpaceToolkit/Physics/Environment/Magnetic/Earth/Manager.test.cpp Adjusted tests to use reset() instead of direct calls to DefaultMode and DefaultLocalRepository.

Poem

In the toolkit's heart, changes take flight,
Managers revamped, shining so bright.
Modes and repos, now simpler and clear,
A streamlined design, bringing us cheer!
With every new method, a hop and a skip,
The code dances forward, on a joyful trip! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.