🐛 base control exists check

[GautierDele]

Summary by CodeRabbit

• Documentation

  • Updated the README to clarify how to link a model control class with an Eloquent model, including a new code example.

• Style

  • Improved code consistency by updating property visibility and type hints in test models.

• Refactor

  • Adjusted internal logic for handling namespace imports and class inheritance when generating control classes.

[coderabbitai]

Walkthrough

The changes update documentation and modify code related to class inheritance and property visibility. The README.md now includes clearer instructions for linking a model to its control class using a trait. In the console command for generating control classes, the logic for handling namespace imports and class inheritance is adjusted to use fixed import statements and modifies how inheritance is handled based on the existence of a base Control class. Additionally, the visibility and type of a static property in a test model class are updated for stricter encapsulation and type safety.

Changes

File(s)	Summary
README.md	Added explicit instruction and code snippet for specifying the control in the Eloquent model using a trait.
src/Console/ControlMakeCommand.php	Modified logic for handling namespace imports and class inheritance in the control class generator.
tests/Support/Models/Model.php	Changed static property $control from public to protected and added a string type declaration.

Poem

In README’s warren, a new step appears,
Traits and controls now hop with fewer fears.
The generator’s logic, with imports anew,
Models grow safer, as all rabbits do.
With code more precise and documentation bright,
We leap through the changes with whiskers of delight!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5212205 and 1c577ce.

📒 Files selected for processing (3)

• README.md (1 hunks)
• src/Console/ControlMakeCommand.php (1 hunks)
• tests/Support/Models/Model.php (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

tests/Support/Models/Model.php (2)

src/Controls/HasControl.php (1)

• control (22-27)

tests/Support/Access/Controls/ModelControl.php (1)

• ModelControl (13-74)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Tests on PHP 8.4 with Laravel ^12.0 and sqlite
• GitHub Check: Tests on PHP 8.2 with Laravel ^12.0 and sqlite
• GitHub Check: Tests on PHP 8.3 with Laravel ^12.0 and pgsql

🔇 Additional comments (3)

tests/Support/Models/Model.php (1)

18-18: Improved encapsulation and type safety.

Changing $control from public to protected with a string type declaration improves encapsulation and type safety. This aligns with the updated README guidance on using the HasControl trait to link models with control classes.

src/Console/ControlMakeCommand.php (1)

93-97: Fixed control class import logic.

The import statement handling has been fixed to properly address different scenarios:

1. When base Control exists: Remove Lomkit\Access\Controls\Control import
2. When base Control doesn't exist: Remove import from the control namespace, but keep the extends clause

This change ensures the generated control classes will have proper imports based on whether a base Control class exists.

README.md (1)

49-57: Improved documentation for model-control linkage.

Adding clear instructions for specifying the control in models using the HasControl trait fills an important documentation gap. This explicit guidance helps developers understand the correct pattern for linking models with their controls.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @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.

CodeRabbit Configuration 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 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 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.