Fix syntax and improve documentation in core modules

[crStiv]

Description:

• Fix missing closing parenthesis in inconsistent_namespaces error message
• Add comprehensive documentation for World contract storage fields
• Improve documentation for event structures in world contract

Summary by CodeRabbit

• New Features

  • Added new world events that notify when a world is created or upgraded, with improved state tracking.

• Bug Fixes

  • Corrected a string formatting issue in error messages to ensure clarity.

• Refactor

  • Updated key handling and data parsing for enhanced performance and maintainability.

[coderabbitai]

Ohayo, sensei! Below is the summary of the PR details.

Walkthrough

This pull request redefines the KeyParser trait in the model module by introducing additional type parameters and enhancing documentation. The Model trait's keys method is updated to utilize the new trait. A minor formatting fix in the world errors module corrects a missing closing parenthesis in the string output. Additionally, the world contract now includes new event structs (WorldSpawned and WorldUpgraded) and a comprehensive Storage struct with detailed field comments to improve structural clarity.

Changes

File(s)	Change Summary
crates/dojo/.../model.cairo	Redefined KeyParser trait with additional type parameters and documentation; updated Model trait’s keys method to use the new trait structure.
crates/dojo/.../errors.cairo	Fixed string formatting in inconsistent_namespaces by adding a missing closing parenthesis.
crates/dojo/.../world_contract.cairo	Added new event structs (WorldSpawned, WorldUpgraded) with documentation for respective fields; introduced a Storage struct with detailed fields and comments.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant M as Model
    participant KP as KeyParser
    C->>M: Call keys()
    M->>KP: parse_key()
    KP-->>M: Return parsed key
    M-->>C: Return key set

Loading

sequenceDiagram
    participant U as User
    participant WC as WorldContract
    participant EL as Event Listener
    U->>WC: Request to spawn world
    WC->>EL: Emit WorldSpawned event
    U->>WC: Request world upgrade
    WC->>EL: Emit WorldUpgraded event

Loading

Possibly related PRs

• feat(dojo-core): add support to read/write the same member from multiple models #2939: Involves modifications to the KeyParser and Model traits, aligning with the current changes in key parsing.
• Re added members and converted ModelPtr to a struct #2634: Addresses adjustments in model structures and member re-additions related to key parsing logic.
• refactor(lang): update convention for keys and values naming  #2660: Focuses on updated key and value handling, complementing the improvements introduced in this PR.

Suggested labels

audit

Suggested reviewers

• glihm

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 12d9c8d and 8f1280a.

📒 Files selected for processing (3)

• crates/dojo/core/src/model/model.cairo (1 hunks)
• crates/dojo/core/src/world/errors.cairo (1 hunks)
• crates/dojo/core/src/world/world_contract.cairo (2 hunks)

✅ Files skipped from review due to trivial changes (1)

• crates/dojo/core/src/world/errors.cairo

🔇 Additional comments (5)

crates/dojo/core/src/model/model.cairo (2)

20-31: Ohayo! Beautiful trait documentation, sensei!

The KeyParser trait is well-documented with clear explanations of type parameters and method purpose.

---

76-77: Clean and precise implementation, sensei!

The keys method signature is properly updated to utilize the new KeyParser trait.

crates/dojo/core/src/world/world_contract.cairo (3)

82-88: Excellent event documentation, sensei!

The WorldSpawned event struct is well-documented with clear explanations for each field.

---

91-95: Clean event documentation, sensei!

The WorldUpgraded event struct is well-documented with a clear explanation of its purpose and field.

---

242-258: Masterful storage documentation, sensei!

The Storage struct is exceptionally well-documented with clear explanations for each field's purpose and usage.

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[glihm]

Will close since the PR only target very random spot in the code, without being consistent.
Please don't hesitate to re-open a more complete PR if you aim at adding more context for the reader while going into the core, or don't hesitate to pickup open issues. 🫡