feat: Integration of flame_riverpod #2367

markvideon · 2023-02-25T22:50:59Z

Description

Previously discussed with @spydon and referenced in issue #2353, flame_riverpod is to be integrated into the monorepo

Checklist

I have followed the Contributor Guide when preparing my PR.
I have updated/added tests for ALL new/updated/fixed functionality.
I have updated/added relevant documentation in docs and added dartdoc comments with ///.
I have updated/added relevant examples in examples or docs.

Breaking Change?

Yes, this PR is a breaking change.
No, this PR is not a breaking change.

Related Issues

Contribution toward #2353

markvideon · 2023-02-26T01:46:55Z

The example Flutter project contains a widget test that accesses lifecycle methods (eg processQueue), which is currently annotated as protected. Perhaps it could be visibleForTesting?

The widget test in question is a standard Flutter widget test that compares the contents of a Flutter Text Widget against a Flame Text Component for equality. This is to validate that both widgets are reading from the StreamProvider defined in the project.

st-pasha

Could you please remove all the files that are not part of the library? Such as linux/, macos/, web/, and windows/ folders.

spydon · 2023-02-26T11:24:14Z

The example Flutter project contains a widget test that accesses lifecycle methods (eg processQueue), which is currently annotated as protected. Perhaps it could be visibleForTesting?

It can be both, so you can just add that meta tag there and it should be fine.

…nt].

packages/flame_riverpod/LICENSE

packages/flame_riverpod/README.md

packages/flame_riverpod/example/.gitignore

packages/flame_riverpod/example/README.md

packages/flame_riverpod/example/lib/main.dart

packages/flame_riverpod/example/test/widget_test.dart

packages/flame_riverpod/lib/src/has_component_ref_mixin.dart

packages/flame_riverpod/pubspec.yaml

packages/flame_riverpod/README.md

packages/flame_riverpod/example/.metadata

packages/flame_riverpod/README.md

packages/flame_riverpod/example/test/widget_test.dart

Added package name to beginning of file as per suggestion Co-authored-by: Lukas Klingsbo <[email protected]>

…nually in test. (Change yet to be committed)

…nge requests: - Updated flame_riverpod website field - Updated flame_riverpod description - Bumped up flame version number to 1.6.0 Additionally, removed whitespace

…included in previous commit

…ents, added relevant comments

…Test due to error in automated Github action

…->initializeWithGame)

packages/flame_riverpod/README.md

packages/flame_riverpod/lib/src/component_ref.dart

packages/flame_riverpod/lib/src/has_component_ref_mixin.dart

garysm · 2023-09-18T16:54:16Z

@markvideon Can we expect an update for this?

markvideon · 2023-10-03T20:06:06Z

@markvideon Can we expect an update for this?

Yes

… to test/widget_test.dart, adjusted spelling in a comment in test/widget_test.dart.

spydon

Looks great! 😍
Just a few minor comments, nothing on the implementation.

.github/.cspell/words_dictionary.txt

packages/flame_riverpod/example/.gitignore

packages/flame_riverpod/example/lib/main.dart

packages/flame_riverpod/example/pubspec.yaml

packages/flame_riverpod/lib/src/widget.dart

…elative path.

packages/flame_riverpod/example/lib/main.dart

Updated comments as per suggestion. Co-authored-by: Lukas Klingsbo <[email protected]>

spydon

Lgtm! 🥳

Not active anymore :(

spydon · 2023-11-30T15:42:11Z

@markvideon I missed one thing in my review, docs are missing.
Similar to these ones: https://github.com/flame-engine/flame/tree/main/doc/bridge_packages/flame_bloc

spydon

Two minor comments, otherwise I think we're good to go! 😍

doc/bridge_packages/flame_riverpod/flame_riverpod.md

doc/bridge_packages/flame_riverpod/riverpod.md

fix: Spacing as per suggestion Co-authored-by: Lukas Klingsbo <[email protected]>

docs: Change of link as per suggestion Co-authored-by: Lukas Klingsbo <[email protected]>

markvideon added 3 commits February 1, 2023 15:18

Committing flame_riverpod project files

98861eb

Added widget test for the example.

855749f

Ran dart format . --set-exit-if-changed

c2e93b5

st-pasha previously requested changes Feb 26, 2023

View reviewed changes

Removed platform folders from the example.

1eb5b84

Added visibleForTesting annotation to the lifecycle field of [Compone…

185482f

…nt].

spydon reviewed Feb 26, 2023

View reviewed changes

packages/flame_riverpod/README.md Show resolved Hide resolved

st-pasha reviewed Feb 26, 2023

View reviewed changes

packages/flame_riverpod/example/.metadata Show resolved Hide resolved

packages/flame_riverpod/README.md Outdated Show resolved Hide resolved

packages/flame_riverpod/example/test/widget_test.dart Outdated Show resolved Hide resolved

markvideon and others added 15 commits February 27, 2023 14:18

Update packages/flame_riverpod/README.md

127810b

Added package name to beginning of file as per suggestion Co-authored-by: Lukas Klingsbo <[email protected]>

Removed visibleForTesting annotation - no longer calling lifecycle ma…

e0672cf

…nually in test. (Change yet to be committed)

Merge branch 'main' of github.com:markvideon/flame

d295958

Changed LICENSE to MIT

461aba3

Updated pubspec for flame_riverpod and the example project as per cha…

dad9a27

…nge requests: - Updated flame_riverpod website field - Updated flame_riverpod description - Bumped up flame version number to 1.6.0 Additionally, removed whitespace

Removed example project .gitignore and .metadata files

7b09c50

Made the list of subscriptions final as per comment

1194a80

Refactor of unitialisedGame -> unitializedGame that should have been …

5a66380

…included in previous commit

Changes to widgetTest to remove need to manually trigger lifecycle ev…

bbd0de9

…ents, added relevant comments

Added suggested self-credit copy to package README

44b0174

Removed access of hasPendingLifecycleEvents inside the example widget…

eb3242a

…Test due to error in automated Github action

Americanised name: RiverpodGameWidget constructor (initialiseWithGame…

a3c48aa

…->initializeWithGame)

Updated description of flame_riverpod to provide context.

26c1a0a

More Americanisation of the word initialise

da49352

Updated READMEs

9ff8c05

markvideon requested a review from spydon February 27, 2023 05:06

markvideon added 2 commits February 27, 2023 16:30

Adjustments based on feedback in Markdown, Format github actions

f3f241d

Addressed feedback from markdown lint github action

80da27c

spydon mentioned this pull request Feb 27, 2023

docs: Add missing dictionary words #2372

Merged

6 tasks

st-pasha reviewed Mar 1, 2023

View reviewed changes

spydon marked this pull request as draft April 16, 2023 14:18

markvideon added 6 commits November 30, 2023 13:50

Merge branch 'flame-engine:main' into main

d6027fd

flame_riverpod v5

7e0de63

Added link to flutter_riverpod within README

7bb44b1

Chore: adjusted end of line spacing in README, renamed test/test.dart…

1aec2d1

… to test/widget_test.dart, adjusted spelling in a comment in test/widget_test.dart.

Chore: Addressed markdown lint warnings.

7931d5d

Chore: Added words to cspell

838bd23

markvideon marked this pull request as ready for review November 30, 2023 05:02

spydon reviewed Nov 30, 2023

View reviewed changes

markvideon added 3 commits November 30, 2023 19:24

Chore: Moved name to people_usernames.txt from words_dictionary.txt

76e6e7c

Removed example gitignore

189a001

Chore: Modified flame_riverpod example to use a version rather than r…

83b7457

…elative path.

spydon reviewed Nov 30, 2023

View reviewed changes

packages/flame_riverpod/example/lib/main.dart Outdated Show resolved Hide resolved

markvideon and others added 2 commits November 30, 2023 19:48

Docs: Dartdoc for RiverpodAwareGameWidget

7d4783d

Update packages/flame_riverpod/example/lib/main.dart

fdf8273

Updated comments as per suggestion. Co-authored-by: Lukas Klingsbo <[email protected]>

spydon approved these changes Nov 30, 2023

View reviewed changes

markvideon added 3 commits December 1, 2023 18:37

docs: Bridge packages documentation for flame_riverpod

b1bcc27

fix: Trailing space deteced by markdownlint

b78ed9c

Merge branch 'main' of github.com:markvideon/flame

3bd0534

spydon approved these changes Dec 1, 2023

View reviewed changes

doc/bridge_packages/flame_riverpod/flame_riverpod.md Outdated Show resolved Hide resolved

doc/bridge_packages/flame_riverpod/riverpod.md Outdated Show resolved Hide resolved

markvideon and others added 3 commits December 1, 2023 18:57

Update doc/bridge_packages/flame_riverpod/flame_riverpod.md

52d2a6d

fix: Spacing as per suggestion Co-authored-by: Lukas Klingsbo <[email protected]>

Update doc/bridge_packages/flame_riverpod/riverpod.md

4074151

docs: Change of link as per suggestion Co-authored-by: Lukas Klingsbo <[email protected]>

Merge branch 'main' into main

d77a620

spydon enabled auto-merge (squash) December 1, 2023 08:32

spydon merged commit 0c74560 into flame-engine:main Dec 1, 2023
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Integration of flame_riverpod #2367

feat: Integration of flame_riverpod #2367

markvideon commented Feb 25, 2023

markvideon commented Feb 26, 2023

st-pasha left a comment

spydon commented Feb 26, 2023

garysm commented Sep 18, 2023

markvideon commented Oct 3, 2023

spydon left a comment

spydon left a comment

spydon commented Nov 30, 2023

spydon left a comment

feat: Integration of flame_riverpod #2367

feat: Integration of flame_riverpod #2367

Conversation

markvideon commented Feb 25, 2023

Description

Checklist

Breaking Change?

Related Issues

markvideon commented Feb 26, 2023

st-pasha left a comment

Choose a reason for hiding this comment

spydon commented Feb 26, 2023

garysm commented Sep 18, 2023

markvideon commented Oct 3, 2023

spydon left a comment

Choose a reason for hiding this comment

spydon left a comment

Choose a reason for hiding this comment

spydon commented Nov 30, 2023

spydon left a comment

Choose a reason for hiding this comment