Skip to content

Support bracket object#10

Merged
koriym merged 5 commits intoray-di:1.xfrom
apple-x-co:bracket-object
Jul 16, 2025
Merged

Support bracket object#10
koriym merged 5 commits intoray-di:1.xfrom
apple-x-co:bracket-object

Conversation

@apple-x-co
Copy link
Contributor

@apple-x-co apple-x-co commented Jul 13, 2025

author のようにネストしたデータ形式の対応

<form method="post">
<input type="text" name="title" value="Buy milk">
<input type="text" name="author[name]" value="John">
<input type="text" name="author[email]" value="john@example.com">
</form>
[
  'title' => 'Buy milk',
  'author' => [
    'name' => 'John',
    'email' => 'john@example.com',
  ],
]

Summary by Sourcery

Add support for bracket object notation in InputQuery to create nested input objects from direct nested arrays and include a corresponding unit test.

New Features:

  • Support instantiating nested input objects from direct array entries keyed by the parameter name

Tests:

  • Add testCreateBracketObject to verify bracket notation object instantiation

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Enhanced support for nested associative arrays in input queries, allowing for direct object creation from nested structures.
  • Tests

    • Added a new test to verify correct handling and instantiation of objects from nested associative array inputs.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jul 13, 2025

Reviewer's Guide

Adds support for treating direct nested array entries as input objects (bracket notation) in resolveObjectType and includes a corresponding test to verify this behavior.

Class diagram for updated resolveObjectType logic in InputQuery

classDiagram
    class InputQuery {
        +resolveObjectType(param: ReflectionParameter, query: array, ...): mixed
        +newInstance(className: string, data: array): object
        +extractNestedQuery(paramName: string, query: array): array
    }
    InputQuery : +resolveObjectType now supports direct nested array (bracket object) as input object
Loading

File-Level Changes

Change Details Files
Implement direct nested array handling in resolveObjectType
  • Add check for parameter name existence and array type in query
  • Assert target class exists and call newInstance with the sub-array
src/InputQuery.php
Add test case for bracket-style object instantiation
  • Create testCreateBracketObject with nested author array in query
  • Assert TodoInput and nested AuthorInput instances and their properties
tests/InputQueryTest.php

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link

coderabbitai bot commented Jul 13, 2025

Walkthrough

A new conditional block was added to the resolveObjectType method in InputQuery.php to support instantiation of nested objects when the query array contains a direct nested associative array keyed by the parameter name. A corresponding test, testCreateBracketObject, was added to verify this behavior in InputQueryTest.php.

Changes

File(s) Change Summary
src/InputQuery.php Enhanced resolveObjectType to instantiate objects from direct nested associative arrays.
tests/InputQueryTest.php Added testCreateBracketObject to verify object creation from nested associative array input.

Possibly related PRs

  • Add array and ArrayObject support for Input attribute #1: Refactors and extends InputQuery to support array and ArrayObject parameters with the Input attribute, including new methods for array handling; related by modifying input resolution logic but addresses different aspects than the current PR.

Poem

A hop and a leap through arrays so neat,
Now nested objects are easy to greet!
With brackets embraced, the code’s full of cheer,
Testing ensures that the logic is clear.
A rabbit applauds this tidy new feat—
Arrays within arrays, oh, how sweet! 🐇


📜 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 f859c39 and faf0f06.

📒 Files selected for processing (1)
  • src/InputQuery.php (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/InputQuery.php
✨ 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
🪧 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.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @apple-x-co - I've reviewed your changes and they look great!

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/InputQuery.php:268` </location>
<code_context>

+        // Check if the parameter name exists as a direct nested array in query
+        if (array_key_exists($paramName, $query) && is_array($query[$paramName])) {
+            assert(class_exists($className));
+            /** @var class-string<T> $className */
+            return $this->newInstance($className, $query[$paramName]);
</code_context>

<issue_to_address>
Using assert(class_exists(...)) may be insufficient for production environments.

Since assert() can be disabled, replace it with an explicit exception or error handling to ensure $className exists in all environments.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
        if (array_key_exists($paramName, $query) && is_array($query[$paramName])) {
            assert(class_exists($className));
            /** @var class-string<T> $className */
            return $this->newInstance($className, $query[$paramName]);
=======
        if (array_key_exists($paramName, $query) && is_array($query[$paramName])) {
            if (!class_exists($className)) {
                throw new \InvalidArgumentException("Class '$className' does not exist.");
            }
            /** @var class-string<T> $className */
            return $this->newInstance($className, $query[$paramName]);
>>>>>>> REPLACE

</suggested_fix>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@apple-x-co
Copy link
Contributor Author

@koriym レビューお願いします!

※ sourcery-ai に指摘された箇所は、 throw をするのであれば今回追加した if の中だけの話ではないと思ったので
本 PR では修正しておりません。

@koriym
Copy link
Member

koriym commented Jul 16, 2025

@coderabbitai review

@coderabbitai
Copy link

coderabbitai bot commented Jul 16, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Added descriptive message to assert(class_exists($className)) to explain:
- This is an internal logic error, not invalid user input
- $className comes from ReflectionParameter type info, so it should always exist
- assert() is the appropriate tool for checking "impossible" conditions
- Can be disabled in production for performance, unlike explicit exceptions

This addresses code review concerns about assert() usage while maintaining
the correct semantic distinction between internal logic errors (assert)
and user input validation (exceptions).

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@koriym
Copy link
Member

koriym commented Jul 16, 2025

@apple-x-co sourcery-aiの言及しているケースはそもそもLogicExceptionでテストの書き用のないバグがあった時のケースですね。assertに理由を書いてこれは起こり得ないものなのだということを明らかにしました。

@koriym koriym merged commit 9d29544 into ray-di:1.x Jul 16, 2025
9 checks passed
@apple-x-co apple-x-co deleted the bracket-object branch July 16, 2025 23:21
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