search

arkivanov / MVIKotlin

Extendable MVI framework for Kotlin Multiplatform with powerful debugging tools (logging and time travel)
https://arkivanov.github.io/MVIKotlin
Apache License 2.0
847 stars 32 forks source link

Updated samples #137

Closed arkivanov closed 6 months ago

arkivanov commented 6 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

Walkthrough

The recent changes in the MVIKotlin sample project involve refining import paths and restructuring the Store creation process. Notable updates include eliminating the DetailsStore interface, reorganizing classes, and enhancing Store creation using both DSL and non-DSL methods across various Kotlin files.

Changes

File Path Change Summary
.../details/DetailsController.kt
.../details/Mappers.kt		 Updated import statements for direct referencing.
.../details/store/DetailsStore.kt Major refactoring: Removed DetailsStore interface, added new classes, and a builder function.
.../main/store/add/AddStoreFactory.kt
.../main/store/list/ListStoreFactory.kt		 Introduced new builder functions for simplified Store creation with updated executor logic.

Poem

🐇💻🌟
In the realm of code, where rabbits roam free,
Changes unfold, a refactor spree.
Interfaces vanish, builders take hold,
Kotlin's dance of creation, stories untold.
Hop, skip, commit, to the repository we flee! 🚀🌈

Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 9721595678c447e584731e606b2271b36249ec6c and 0713750a987647b712597bd4bd9a0007eed32ab1.
Files selected for processing (12) * sample/coroutines/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/coroutines/shared/details/DetailsController.kt (1 hunks) * sample/coroutines/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/coroutines/shared/details/Mappers.kt (1 hunks) * sample/coroutines/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/coroutines/shared/details/store/DetailsStore.kt (1 hunks) * sample/coroutines/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/coroutines/shared/main/store/add/AddStoreFactory.kt (3 hunks) * sample/coroutines/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/coroutines/shared/main/store/list/ListStoreFactory.kt (1 hunks) * sample/coroutines/shared/src/commonTest/kotlin/com/arkivanov/mvikotlin/sample/coroutines/shared/details/store/DetailsStoreTest.kt (2 hunks) * sample/reaktive/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/reaktive/shared/details/DetailsController.kt (1 hunks) * sample/reaktive/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/reaktive/shared/details/Mappers.kt (1 hunks) * sample/reaktive/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/reaktive/shared/details/store/DetailsStore.kt (1 hunks) * sample/reaktive/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/reaktive/shared/main/store/add/AddStoreFactory.kt (2 hunks) * sample/reaktive/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/reaktive/shared/main/store/list/ListStoreFactory.kt (2 hunks) * sample/reaktive/shared/src/commonTest/kotlin/com/arkivanov/mvikotlin/sample/reaktive/shared/details/store/DetailsStoreTest.kt (2 hunks)
Files skipped from review as they are similar to previous changes (7) * sample/coroutines/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/coroutines/shared/details/DetailsController.kt * sample/coroutines/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/coroutines/shared/details/Mappers.kt * sample/coroutines/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/coroutines/shared/main/store/add/AddStoreFactory.kt * sample/coroutines/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/coroutines/shared/main/store/list/ListStoreFactory.kt * sample/reaktive/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/reaktive/shared/details/DetailsController.kt * sample/reaktive/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/reaktive/shared/details/Mappers.kt * sample/reaktive/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/reaktive/shared/main/store/list/ListStoreFactory.kt
Additional comments not posted (12)
sample/reaktive/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/reaktive/shared/main/store/add/AddStoreFactory.kt (2)
`6-6`: The change in the import statement aligns with the PR's objectives to refactor store creation methods. --- `19-50`: The implementation of the `addStore` function correctly demonstrates the new way of creating stores without using the DSL API, aligning with the PR's objectives.
sample/coroutines/shared/src/commonTest/kotlin/com/arkivanov/mvikotlin/sample/coroutines/shared/details/store/DetailsStoreTest.kt (2)
`3-3`: The updated import statements are necessary for the new testing setup, ensuring that the tests align with the changes in the store implementation. --- `24-24`: The update to the `store` variable declaration correctly aligns the test setup with the new store implementation.
sample/coroutines/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/coroutines/shared/details/store/DetailsStore.kt (3)
`3-9`: The updated import statements are necessary for the new implementation of the `detailsStore` function, which uses coroutines extensively. --- `15-104`: The new class and function declarations, including `Intent`, `State`, `Label`, `Msg`, and the `detailsStore` function, correctly implement the major overhaul of the `DetailsStore`. These changes enhance modularity and demonstrate creating a store using the DSL API. --- `3-104`: The changes in `DetailsStore.kt` are well-integrated, maintaining consistency and improving the modularity and maintainability of the code.
sample/reaktive/shared/src/commonTest/kotlin/com/arkivanov/mvikotlin/sample/reaktive/shared/details/store/DetailsStoreTest.kt (2)
`3-3`: The updated import statements are necessary for the new testing setup, ensuring that the tests align with the changes in the store implementation. --- `27-27`: The update to the `store` variable declaration correctly aligns the test setup with the new store implementation.
sample/reaktive/shared/src/commonMain/kotlin/com/arkivanov/mvikotlin/sample/reaktive/shared/details/store/DetailsStore.kt (3)
`3-9`: The updated import statements are necessary for the new implementation of the `detailsStore` function, which uses coroutines extensively. --- `21-109`: The new class and function declarations, including `Intent`, `State`, `Label`, `Msg`, and the `detailsStore` function, correctly implement the major overhaul of the `DetailsStore`. These changes enhance modularity and demonstrate creating a store using the DSL API. --- `3-109`: The changes in `DetailsStore.kt` are well-integrated, maintaining consistency and improving the modularity and maintainability of the code.
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.