Skip to content

Conversation

@15g-lucas
Copy link
Member

@15g-lucas 15g-lucas commented Apr 17, 2025

This PR Fix generates a control.

The “\n” are not interpreted in the heredoc syntax.

So I made the following changes

Summary by CodeRabbit

  • Style
    • Improved formatting of generated code by removing unnecessary blank lines and adjusting indentation in code templates.
    • Refined array formatting in control stubs for better readability.
    • Updated query conditions and cleaned up indentation in example class definitions.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 17, 2025

Walkthrough

This change updates the generated code for perimeter implementations in the ControlMakeCommand class by swapping the order and signatures of the chained method calls (allowed and should) on perimeter instances and adjusting their formatting. Additionally, the control stub file is reformatted to spread the perimeters() method's return array over multiple lines for improved readability. The README is updated to remove scoutQuery callbacks from perimeter definitions and modifies the query condition in the client perimeter. No public API or entity declarations are changed.

Changes

File(s) Change Summary
src/Console/ControlMakeCommand.php Swapped the order and changed signatures of allowed and should methods in perimeter instantiation; removed leading/trailing newlines and adjusted spacing.
src/Console/stubs/control.stub Reformatted the perimeters() method's return array to place the placeholder on a new indented line within the brackets.
README.md Removed scoutQuery callbacks from GlobalPerimeter and ClientPerimeter; changed client perimeter query callback from orWhere to where; fixed indentation in PostPolicy class declaration.

Possibly related PRs

  • ✨ commands #10: Refines formatting and string construction in the ControlMakeCommand class and its stub, which is directly related to the changes in this PR.

Poem

A rabbit hopped through code so neat,
Tidying lines where newlines meet.
Arrays now breathe, indented right,
Perimeters trimmed, concise and light.
With every hop, the code’s more clear—
A bunny’s touch brings order here!
🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 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 9f07acb and 5fa5c3e.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

🪧 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 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
README.md (1)

49-49: Correct noun-verb confusion in documentation
The phrase “Then setup your policy:” uses “setup” as a noun. It should read “Then set up your policy:” for proper verb usage.

🧰 Tools
🪛 LanguageTool

[grammar] ~49-~49: The word “setup” is a noun. The verb is spelled with a space.
Context: ... }), // ... Then setup your policy: php class PostPolicy e...

(NOUN_VERB_CONFUSION)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 48201ef and 9f07acb.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • src/Console/ControlMakeCommand.php (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/Console/ControlMakeCommand.php
🧰 Additional context used
🪛 LanguageTool
README.md

[grammar] ~49-~49: The word “setup” is a noun. The verb is spelled with a space.
Context: ... }), // ... Then setup your policy: php class PostPolicy e...

(NOUN_VERB_CONFUSION)

🔇 Additional comments (2)
README.md (2)

43-45: Confirm the updated query condition
Switching from orWhere('client_id', …) to a strict where('client_id', …) will exclusively filter to the current client. Please verify this matches your intended access control logic and doesn’t omit any valid scenarios.


52-52: Class declaration formatting approved
Removing the extra indentation before class PostPolicy improves consistency with other PHP class definitions.

@GautierDele GautierDele changed the title Fix make control ControlMakeCommand - badly interpreted perimeter generation Apr 18, 2025
@GautierDele GautierDele merged commit dd5890b into Lomkit:master Apr 18, 2025
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants