fix: Blueprint::indexCommand signature broke in v12.21.0

[taka-oyama]

broken by laravel/framework#56324

[coderabbitai]

Walkthrough

The changes update the Laravel framework version constraint in the composer.json file from ^12.0 to ^12.21, restricting supported versions to Laravel 12.21 and above. Additionally, the indexCommand method in the Blueprint class is modified to accept an optional $operatorClass parameter, which is then included in the arguments for the IndexDefinition constructor. The method's PHPDoc is also updated to use @inheritDoc.

Estimated code review effort

1 (~2 minutes)

Suggested labels

enhancement, waiting for review

---

📜 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 e01b70e and c0bc4f4.

📒 Files selected for processing (2)

• composer.json (1 hunks)
• src/Schema/Blueprint.php (2 hunks)

🧠 Learnings (1)

src/Schema/Blueprint.php (1)

Learnt from: taka-oyama
PR: #243
File: tests/Schema/BlueprintTest.php:697-698
Timestamp: 2024-12-16T09:35:32.707Z
Learning: In tests/Schema/BlueprintTest.php, the argument 'bit_reversed_positive start counter with 2' passed to the generatedAs method is correct syntax for defining identity columns.

🧰 Additional context used

🧠 Learnings (1)

src/Schema/Blueprint.php (1)

Learnt from: taka-oyama
PR: #243
File: tests/Schema/BlueprintTest.php:697-698
Timestamp: 2024-12-16T09:35:32.707Z
Learning: In tests/Schema/BlueprintTest.php, the argument 'bit_reversed_positive start counter with 2' passed to the generatedAs method is correct syntax for defining identity columns.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Run-PHPUnit

🔇 Additional comments (4)

composer.json (1)

14-14: Version constraint update aligns with breaking change fix.

The Laravel framework constraint update from ^12.0 to ^12.21 correctly restricts compatibility to Laravel versions that support the new indexCommand signature, ensuring users don't encounter the breaking change with older framework versions.

src/Schema/Blueprint.php (3)

466-466: Good use of @inheritdoc for overridden method.

Simplifying the PHPDoc to use @inheritDoc is appropriate since this method overrides the parent class method.

---

470-470: Method signature properly updated to fix Laravel 12.21.0 breaking change.

The addition of the optional $operatorClass parameter with a default value of null correctly addresses the breaking change in Laravel 12.21.0 while maintaining backward compatibility.

---

484-484: Parameter properly passed to IndexDefinition constructor.

The operatorClass parameter is correctly included in the arguments array passed to the IndexDefinition constructor, ensuring the new functionality is properly supported.

✨ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

[Copilot]

Pull Request Overview

This PR fixes a compatibility issue with Laravel framework v12.21.0 by updating the indexCommand method signature in the Blueprint class to include a new optional operatorClass parameter.

• Updates the indexCommand method signature to accept an additional operatorClass parameter
• Updates the minimum Laravel framework version requirement from ^12.0 to ^12.21
• Adds the operatorClass parameter to the command array structure

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
src/Schema/Blueprint.php	Updates indexCommand method signature and implementation to support operatorClass parameter
composer.json	Updates Laravel framework dependency to require minimum version 12.21