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.

Sign up for GitHub

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

Jump to bottom

refactor: cleanup class routing profile #1958

Merged
merged 6 commits into from
Jan 27, 2025
Merged

refactor: cleanup class routing profile #1958

merged 6 commits into from
Jan 27, 2025

Conversation

sfendrich
Copy link
Contributor

Pull Request Checklist

  • 1. I have [rebased][rebase] the latest version of the main 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].

Information about the changes

  • Key functionality added: Move unrelated methods from class RoutingProfile to more appropriate places
  • Reason for change: improve readabilty and maintainability

Sascha Fendrich added 5 commits January 27, 2025 10:47
refactor: replace usage of field by getter
ab09996 
This is a preparatory step for moving ithe methods `setSpeedups`
and `requiresTimeDependentAlgorithm` from RoutingProfile to
RoutingRequest.
refactor: prepare method movement
84edcb8 
Replace the direct access to SearchParameters by an indirect
access through RoutingRequest, where the method will be
moved to.
refactor: move method and simplify method signature
a0354fd
refactor: prepare method movement
a4ee961 
This commit adds a parameter of type RoutingRequest to setSpeedups
in order to move this method from RoutingProfile to RoutingReqest.
refactor: move method
34a90ca
@sfendrich sfendrich changed the title Refactor/cleanup class routing profile Refactor: cleanup class routing profile Jan 27, 2025
@sfendrich sfendrich changed the title Refactor: cleanup class routing profile refactor: cleanup class routing profile Jan 27, 2025
fix: tool versions in dockerfile
b697c17 
Fixed tool versions in Builder.Dockerfile lead to failure
building the integration test container.
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
91.1% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

koebi
koebi approved these changes Jan 27, 2025
View reviewed changes
Copy link
Collaborator

@koebi koebi left a comment

Choose a reason for hiding this comment

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

LGTM

@sfendrich sfendrich merged commit 726b1ac into main Jan 27, 2025
27 checks passed
@sfendrich sfendrich deleted the refactor/cleanup-class-RoutingProfile branch January 27, 2025 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@koebi koebi koebi approved these changes

Assignees
No one assigned
Labels
refactor
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sfendrich @koebi