Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: move APIEnums into api module #1640

Merged
merged 1 commit into from
Jan 17, 2024

Conversation

sfendrich
Copy link
Contributor

APIEnums are concerned with API code and should not be used by the engine core. This refactoring removes the last dependencies of engine code on APIEnums and moves the APIEnums class into the api module.

Pull Request Checklist

  • 1. I have [rebased][rebase] the latest version of the master branch into my feature branch and all conflicts
    have been resolved.
  • 2. I have added information about the change/addition to functionality to the CHANGELOG.md file under the
    [Unreleased] heading.
  • 3. I have documented my code using JDocs tags.
  • 4. I have removed unnecessary commented out code, imports and System.out.println statements.
  • 5. I have written JUnit tests for any new methods/classes and ensured that they pass.
  • 6. I have created API tests for any new functionality exposed to the API.
  • 7. If changes/additions are made to the ors-config.json file, I have added these to the [ors config documentation][config]
    along with a short description of what it is for, and documented this in the Pull Request (below).
  • 8. I have built graphs with my code of the Heidelberg.osm.gz file and run the api-tests with all test passing
  • 9. I have referenced the Issue Number in the Pull Request (if the changes were from an issue).
  • 10. For new features or changes involving building of graphs, I have tested on a larger dataset
    (at least Germany), and the graphs build without problems (i.e. no out-of-memory errors).
  • 11. For new features or changes involving the graphbuilding process (i.e. changing encoders, updating the
    importer etc.), I have generated longer distance routes for the affected profiles with different options
    (avoid features, max weight etc.) and compared these with the routes of the same parameters and start/end
    points generated from the current live ORS.
    If there are differences then the reasoning for these MUST be documented in the pull request.
  • 12. I have written in the Pull Request information about the changes made including their intended usage
    and why the change was needed.
  • 13. For changes touching the API documentation, I have tested that the API playground [renders correctly][api].

Fixes #1634 .

Information about the changes

  • Key functionality added: refactor to get better seperation of engine code and api code
  • Reason for change: Improve maintainability

@sfendrich sfendrich requested a review from takb December 20, 2023 12:02
Copy link
Contributor

@takb takb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks, finally!

@sfendrich sfendrich force-pushed the refactor/move-APIEnums-into-api branch from 44951bd to 25746d3 Compare January 17, 2024 08:25
APIEnums are concerned with API code and should not be used by
the engine core. This refactoring removes the last dependencies
of engine code on APIEnums and moves the APIEnums class into
the api module.
@sfendrich sfendrich force-pushed the refactor/move-APIEnums-into-api branch from 25746d3 to 9cb966d Compare January 17, 2024 08:36
@sfendrich sfendrich merged commit 4051c2a into master Jan 17, 2024
12 checks passed
@sfendrich sfendrich deleted the refactor/move-APIEnums-into-api branch January 17, 2024 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Status: Awaiting release
Development

Successfully merging this pull request may close these issues.

Refactor: APIEnums class still in engine module
2 participants