Add Puzzle Hints

[CloudyDino]

Add Puzzle Hints

For #1158
Based on #1224
Merge after #1445

Changes

• Adds button to puzzle screen bottom bar to show hint
• Once hint is shown, we mark hint shown for the puzzle state
• If hint has been shown for puzzle, we set puzzle to not be rated
• When hint is shown, we use green circle for the piece to move and we use blue circles to show where the piece can move. This is slightly different from what Web does in that it preselects the piece we can move so we can see all the places it moves to. I'm not sure how to do that with the current BoardTable widget.

Screenshots / Recordings

puzzle.hint.-.only.circle.piece.mp4

Phone	Tablet

[veloce]

Looks very good!

I'm not sure why the piece is preselected on the website. Since we're not doing that, I think we can just add the circle around the hinted piece. But not showing the possible destinations. It just adds noise in my opinion. If you're playing puzzle it means you know where the piece can move to ;)

[CloudyDino]

Thanks for the review @veloce! Just updated to only circle the square the piece to move is on.

[CloudyDino]

Whoops, accidentally closed the PR.
Fixed the merge conflicts and used the _viewSolutionCompleter.future in PuzzleScreen to show the hint.

[veloce]

Looks good except a small comment.

Same as with the rated feature, we should add a widget test here. Since we have already the "view solution" puzzle test it should be easy to adapt from it.
The new tests should check:

• that the right square is highlighted
• that the solution is marked as not rated if the hint was shown, even though rated is enabled in preferences
• that the hint shown bool is correctly reset in the next puzzle (tested by solving another puzzle without hint and verifying that it is rated).

[veloce]

This can be private. And also a getter instead of a method.

Also I'd name it nextSolutionMove since it depends on the current move index.

[ijm8710]

Per Veloces last comment if you have it on rated and use a hint do future puzzles stay rated or does it change it?

[CloudyDino]

Per Veloces last comment if you have it on rated and use a hint do future puzzles stay rated or does it change it?

Future puzzles will continue to be rated. I tested that manually and I added that as a part of our test case.

Right now I think the only thing left is to check that the correct square is being circled after the hint button is pressed which is a bit tricky since I don't see a ValueKey being set for ShapeWidget in flutter-chessground/.

[veloce]

Per Veloces last comment if you have it on rated and use a hint do future puzzles stay rated or does it change it?

Future puzzles will continue to be rated. I tested that manually and I added that as a part of our test case.

Right now I think the only thing left is to check that the correct square is being circled after the hint button is pressed which is a bit tricky since I don't see a ValueKey being set for ShapeWidget in flutter-chessground/.

Right I didn't think about that. I guess we can skip that test for now, the tests regarding rating were much more important.