Mhd/refactor compass action

[mhdostal]

Closes #25, #266

This takes #281 and updates it a bit:

• Add automaticallyHides view modifier and removes autoHide from the constructors
• Removing autoHide allows the action to be a closure
• Adds Viewpoint.withViewpoint(rotation:) extension for ease of viewpoint creation when only the rotation changed.
• updates the MapView compass example to animate taps on the compass (rotation to 0).

it includes these changes from the original PR:

• Adds an optional action parameter to the Compass initializer(s) that takes an async task. This allows users to perform animated heading changes. If no action is provided, behavior remains unchanged.
• The name "action" is borrowed from Button.init(action:label:)

[dfeinzimer]

It looks like removing the auto hide parameter broke a number of the tests.

Here's a prototyped fix for testHiddenWithAutoHideOff():

func testHiddenWithAutoHideOff() {
    let initialValue = 0.0
    let finalValue = 90.0
    var _viewpoint: Viewpoint? = makeViewpoint(rotation: initialValue)
    let viewpoint = Binding(get: { _viewpoint }, set: { _viewpoint = $0 })
    let compass = Compass(viewpoint: viewpoint).automaticallyHides(false)
    XCTAssertFalse((compass as? Compass)!.shouldHide)
    _viewpoint = makeViewpoint(rotation: finalValue)
    XCTAssertFalse((compass as? Compass)!.shouldHide)
}

[dfeinzimer]

Just the one change and this should be good to go.

Up to you if you want to wait for the moveCamera PR to merge or not.

[mhdostal]

Up to you if you want to wait for the moveCamera PR to merge or not.

No, let's get this merged, it's been pending a while. Making the follow-up change can happen with other changes as well.

[dfeinzimer]

Looking good, I think it should be good to go after these last few changes.

[dfeinzimer]

Looks good!

[rolson]

Should this then be named more like how SwiftUI names modifiers like this?

maybe disableAutoHide(:)?

[mhdostal]

That would be OK. @dfeinzimer?

[dfeinzimer]

#291

disableAutocorrection was deprecated in favor of autocorrectionDisabled so I'll follow the new scheme. e.g. autoHideDisabled.

[rolson]

some doc about when you need to specify this action might be helpful to the user. For example, does the compass set the heading to zero and call the action if I have an action set? What is the behavior when no action is set?

[mhdostal]

The default is to rotate the map view to zero, but without animation.

We'll update the doc.

[rolson]

Is there a lot of point to the compass component if the user has to animate to zero themselves?

[mhdostal]

It still draws the compass, which is non-trivial, automatically allows it to track map view rotation, and will allow tapping to perform an action. The default is to rotate the map view to zero, but without animation, as that requires a MapViewProxy. So yea, there is value in it, but we can re-evaluate the default behavior to see if we can include animation in a seamless way.

[rolson]

Good points. Thank you.