arkivanov / Essenty

The most essential libraries for Kotlin Multiplatform development
Apache License 2.0
468 stars 15 forks source link

Added Bundle#putSerializable and Bundle#getSerializable extensions #166

Closed arkivanov closed 3 months ago

arkivanov commented 3 months ago

Closes #165.

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The update in the state-keeper repository enhances the Android Bundle handling by integrating kotlinx.serialization for serializable operations. New functions for serialization and deserialization (putSerializable and getSerializable) are introduced, alongside a SerializableHolder for efficient serialization management. Additionally, the testing suite is updated to align with these changes.

Changes

File Path Change Summary
.../state-keeper.api, .../BundleExt.kt Added putSerializable and getSerializable functions, supporting kotlinx.serialization.
.../AndroidStateKeeperTest.kt Updated to use standard Android Parcel methods.
.../BundleExtTest.kt, .../TestUtils.android.kt New test cases and utilities for serializing and deserializing Android Bundle.

Assessment against linked issues

Objective Addressed Explanation
Consider adding Bundle#putSerializable and Bundle#getSerializable extensions (#165)

🐇✨ In the land of code where bundles bind, A rabbit hopped, improvements in mind. Serializable tales, now smoothly told, In bytes and bundles, new and old. Cheers to the devs, with every commit pushed, In the burrow of code, bugs are shushed. 🌟📦


Recent Review Details **Configuration used: CodeRabbit UI**
Commits Files that changed from the base of the PR and between 3ee3fc04025e44ef1afbe748f1410bd10fc10725 and a518bed0211a67ebc71c4e1118e5049c6f28f7fa.
Files selected for processing (5) * state-keeper/api/android/state-keeper.api (1 hunks) * state-keeper/src/androidMain/kotlin/com/arkivanov/essenty/statekeeper/BundleExt.kt (1 hunks) * state-keeper/src/androidUnitTest/kotlin/com/arkivanov/essenty/statekeeper/AndroidStateKeeperTest.kt (1 hunks) * state-keeper/src/androidUnitTest/kotlin/com/arkivanov/essenty/statekeeper/BundleExtTest.kt (1 hunks) * state-keeper/src/androidUnitTest/kotlin/com/arkivanov/essenty/statekeeper/TestUtils.android.kt (1 hunks)
Files skipped from review as they are similar to previous changes (5) * state-keeper/api/android/state-keeper.api * state-keeper/src/androidMain/kotlin/com/arkivanov/essenty/statekeeper/BundleExt.kt * state-keeper/src/androidUnitTest/kotlin/com/arkivanov/essenty/statekeeper/AndroidStateKeeperTest.kt * state-keeper/src/androidUnitTest/kotlin/com/arkivanov/essenty/statekeeper/BundleExtTest.kt * state-keeper/src/androidUnitTest/kotlin/com/arkivanov/essenty/statekeeper/TestUtils.android.kt
--- 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.