Skip to content

Conversation

@RingerJK
Copy link
Contributor

@RingerJK RingerJK commented Dec 10, 2019

Description

Onboard(offline) Route #issue

  • I have added any issue links
  • I have added all related labels (bug, feature, new API(s), SEMVER, etc.)
  • I have added the appropriate milestone and project boards

Goal

Implement OnBoard Route.

Implementation

Provide OnBoard Route. Separate Transfer and Present layers.

Testing

Please describe the manual tests that you ran to verify your changes

  • I have tested locally (including SNAPSHOT upstream dependencies if needed) through testapp/demo app and run all activities to avoid regressions
  • I have tested via a test drive, or a simulation/mock location app
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have updated the CHANGELOG including this PR

@RingerJK RingerJK added feature New feature request. new API(s) labels Dec 10, 2019
@RingerJK RingerJK added this to the v1.0.0 milestone Dec 10, 2019
@RingerJK RingerJK self-assigned this Dec 10, 2019
bearings = bearings,
classes = classes,
entry = entry,
into = `in`,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

renamed in to into because in is reserved in kotlin. cc @Guardiola31337

@codecov-io
Copy link

codecov-io commented Dec 11, 2019

Codecov Report

Merging #2300 into master will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master    #2300   +/-   ##
=========================================
  Coverage     32.77%   32.77%           
  Complexity      624      624           
=========================================
  Files           143      143           
  Lines          5547     5547           
  Branches        427      427           
=========================================
  Hits           1818     1818           
  Misses         3533     3533           
  Partials        196      196

Copy link
Contributor

@Guardiola31337 Guardiola31337 left a comment

Choose a reason for hiding this comment

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

This is a great start of the Onboard implementation, great work @RingerJK 💪

I'm missing end-to-end tests / examples verifying that everything is working as expected. Those will help us 👀 how every component plays to each other and if the overall design looks 👌

As it's easy to mess up 😅, I think we should make sure to build examples in Java and in Kotlin very early on, so that we could see how the API changes would impact both languages.

Also I left a bunch of comments / questions 😬

/**
* Class for specifying options for use with the walking profile.
*/
class NavigationWalkingOptions internal constructor(val walkingOptions: WalkingOptions) {
Copy link
Contributor

Choose a reason for hiding this comment

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

This is already defined in libdirections-offboard and it's never used. Could we reuse the one from Offboard module instead of creating a new duplicated class and remove this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

They are independent, one in old module, another in new one. As I remember we decided don't remove NavigationWalkingOptions in libdirections-offboard because we'll need it for future features

Choose a reason for hiding this comment

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

If those builders and DTOs are shared, they should live in base.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

they are, ptal at model

.walkwayBias(walkwayBias)
.alleyBias(alleyBias)
.build()

Copy link
Contributor

Choose a reason for hiding this comment

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

WalkingOptionsNavigation.mapToWalkingOptions() ☝️ is never used.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it's used in my next PR

* @return array of lane objects that represent the available turn lanes at the intersection
* @since 1.0
*/
class StepIntersectionNavigation(
Copy link
Contributor

Choose a reason for hiding this comment

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

Same comments as above re: DTOs / models

* rotary - a traffic circle
* @since 1.0
*/
class StepManeuverNavigation(
Copy link
Contributor

Choose a reason for hiding this comment

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

Same comments as above re: DTOs / models

* Speech Synthesis Markup Language which helps voice synthesiser read information more humanely.
* @since 1.0
*/
class VoiceInstructionsNavigation(
Copy link
Contributor

Choose a reason for hiding this comment

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

Same comments as above re: DTOs / models

* allowed range of values is from -1 to 1, where -1 indicates indicates preference to avoid
* alleys, 1 indicates preference to favor alleys, and 0 indicates no preference (the default).
*/
data class WalkingOptionsNavigation(
Copy link
Contributor

Choose a reason for hiding this comment

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

Same comments as above re: DTOs / models

@RingerJK RingerJK marked this pull request as ready for review December 18, 2019 14:32
@Lebedinsky Lebedinsky self-assigned this Jan 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature New feature request.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants