style: improve rector config, static calls invocation in tests, and add missing @throws in phpdocs

[martin-georgiev]

Summary by CodeRabbit

• Chores
  • Streamlined version control and build configurations for smoother project management.
• Tests
  • Standardized assertion calls across test suites to enhance consistency and maintainability.
• Enhancements
  • Refined error handling for clearer feedback during exceptional scenarios.

[coderabbitai]

Walkthrough

This pull request updates configuration and test assertions. The .gitignore now excludes the /var/ directory, and the CI configuration removes the ArraySpreadInsteadOfArrayMergeRector. In the core code, the BaseVariadicFunction class is enhanced with explicit exception handling and updated PHPDoc annotations. In many test files, assertion calls have been standardized by replacing instance calls with static calls. No public API or exported entity declarations were changed.

Changes

File(s)	Change Summary
.gitignore	Added /var/ directory to the ignore list.
ci/rector/config.php	Removed ArraySpreadInsteadOfArrayMergeRector from the skip list, altering the transformation behavior.
src/.../BaseVariadicFunction.php	Imported InvalidArgumentForVariadicFunctionException and updated PHPDoc annotations with @throws ParserException and @throws InvalidArgumentForVariadicFunctionException.
tests/.../*.php	Updated assertions: replaced instance calls (e.g., $this->assertEquals) with static calls (self::assertEquals) across multiple test classes.

Poem

In my burrow of code so deep,
I hop to see changes neat and sleek,
Ignoring /var/ without a fuss,
Errors now caught—no muss, no cuss!
Static hops in tests are all the rage,
Celebrating neat fixes on this page.
Happy coding from one rabbit to your stage!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 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 4a26400 and 167f5de.

📒 Files selected for processing (14)

• .gitignore (1 hunks)
• ci/rector/config.php (0 hunks)
• src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/BaseVariadicFunction.php (3 hunks)
• tests/MartinGeorgiev/Doctrine/DBAL/Types/BaseArrayTest.php (2 hunks)
• tests/MartinGeorgiev/Doctrine/DBAL/Types/BaseIntegerArrayTestCase.php (3 hunks)
• tests/MartinGeorgiev/Doctrine/DBAL/Types/BigIntArrayTest.php (1 hunks)
• tests/MartinGeorgiev/Doctrine/DBAL/Types/BooleanArrayTest.php (3 hunks)
• tests/MartinGeorgiev/Doctrine/DBAL/Types/IntegerArrayTest.php (1 hunks)
• tests/MartinGeorgiev/Doctrine/DBAL/Types/JsonbArrayTest.php (3 hunks)
• tests/MartinGeorgiev/Doctrine/DBAL/Types/JsonbTest.php (3 hunks)
• tests/MartinGeorgiev/Doctrine/DBAL/Types/SmallIntArrayTest.php (1 hunks)
• tests/MartinGeorgiev/Doctrine/DBAL/Types/TextArrayTest.php (3 hunks)
• tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/TestCase.php (1 hunks)
• tests/MartinGeorgiev/Utils/DataStructureTest.php (2 hunks)

💤 Files with no reviewable changes (1)

• ci/rector/config.php

🧰 Additional context used

📓 Path-based instructions (1)

`tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/**/*....

tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/**/*.php: Use the PostgreSQL official documentation to verify that tests include comprehensive use cases and example SQL queries for the tested SQL functions and operators.

• tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/TestCase.php

🔇 Additional comments (22)

.gitignore (1)

2-2: Good addition to the .gitignore file

Adding /var/ to the ignore list is a good practice. This directory is commonly used for temporary files, logs, caches, or other generated content that shouldn't be tracked in version control.

tests/MartinGeorgiev/Doctrine/DBAL/Types/IntegerArrayTest.php (1)

23-23: Improved assertion style by using static method calls

Changing from $this->assertEquals to self::assertEquals follows modern PHPUnit best practices. Static assertion methods are more explicit about their scope and slightly more performant.

tests/MartinGeorgiev/Doctrine/DBAL/Types/BigIntArrayTest.php (1)

23-23: Improved assertion style by using static method calls

Changing from $this->assertEquals to self::assertEquals follows modern PHPUnit best practices. Static assertion methods are more explicit about their scope and slightly more performant.

tests/MartinGeorgiev/Doctrine/DBAL/Types/JsonbTest.php (3)

33-33: Improved assertion style by using static method calls

Changing from $this->assertEquals to self::assertEquals follows modern PHPUnit best practices. Static assertion methods are more explicit about their scope and slightly more performant.

---

43-43: Consistent use of static assertions

Good continuation of the static assertion pattern throughout the test class.

---

53-53: Consistent use of static assertions

Good continuation of the static assertion pattern throughout the test class.

tests/MartinGeorgiev/Doctrine/DBAL/Types/JsonbArrayTest.php (2)

34-34: Good update to use static assertion methods

Switching from $this->assertEquals to self::assertEquals follows modern PHPUnit best practices. Static assertion methods are recommended in newer PHPUnit versions.

---

44-44: Consistent use of static assertion methods

Good job consistently updating all assertion calls to use the static method syntax. This improves code consistency and follows PHPUnit's recommended practices.

Also applies to: 54-54

tests/MartinGeorgiev/Doctrine/DBAL/Types/BooleanArrayTest.php (1)

33-33: Well-executed standardization of assertion methods

Excellent work standardizing all assertion calls to use static method calls (self::assertEquals) instead of instance method calls ($this->assertEquals). This follows modern PHPUnit conventions and improves consistency across the test suite.

Also applies to: 47-47, 61-61

tests/MartinGeorgiev/Doctrine/DBAL/Types/SmallIntArrayTest.php (1)

23-23: Good practice using static assertion method

Converting to self::assertEquals aligns with PHPUnit's recommended practices for using static assertion methods. This change is consistent with the updates in other test files.

tests/MartinGeorgiev/Doctrine/DBAL/Types/TextArrayTest.php (1)

33-33: Well-implemented test assertion standardization

Good job updating all assertion calls to use static methods. This improves code consistency and follows modern PHPUnit conventions, making the test suite more maintainable and aligned with best practices.

Also applies to: 43-43, 53-53

tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/TestCase.php (1)

105-106: Assertion call updated to static method

Good change to use self::assertEquals() instead of $this->assertEquals(). This follows PHPUnit's recommendation to use static assertion methods, improving consistency and avoiding potential issues with method overriding.

tests/MartinGeorgiev/Utils/DataStructureTest.php (2)

20-21: Static assertion method call replaces instance method

Great update to use self::assertEquals() instead of $this->assertEquals(). Using static assertion calls is the recommended approach in PHPUnit and improves code consistency.

---

32-33: Static assertion method call replaces instance method

Good change to use self::assertEquals() instead of $this->assertEquals(). This matches the pattern applied throughout the test suite and follows PHPUnit best practices.

tests/MartinGeorgiev/Doctrine/DBAL/Types/BaseArrayTest.php (2)

46-46: Static assertion method call replaces instance method

Good change to use self::assertSame() instead of $this->assertSame(). Using static assertion calls is the recommended approach in PHPUnit and improves consistency across the test suite.

---

56-56: Static assertion method call replaces instance method

Good update to use self::assertEquals() instead of $this->assertEquals(). This change aligns with modern PHPUnit best practices for assertions.

tests/MartinGeorgiev/Doctrine/DBAL/Types/BaseIntegerArrayTestCase.php (3)

25-25: Static assertion method call replaces instance method

Good change to use self::assertFalse() instead of $this->assertFalse(). Using static assertion calls follows PHPUnit's recommendation and improves code consistency.

---

50-50: Static assertion method call replaces instance method

Good update to use self::assertTrue() instead of $this->assertTrue(). This change maintains consistency with the pattern applied throughout the test suite.

---

60-60: Static assertion method call replaces instance method

Good change to use self::assertEquals() instead of $this->assertEquals(). This follows modern PHPUnit best practices for assertion calls.

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/BaseVariadicFunction.php (3)

12-12: Good improvement to exception handling!

Adding the explicit import for InvalidArgumentForVariadicFunctionException enhances code clarity and maintainability. This makes it clear what exception type is referenced in the @throws annotation later in the file.

---

23-25: Excellent addition of exception documentation!

Adding the @throws ParserException annotation properly documents the method's exception behavior. This helps users of this method implement appropriate error handling, which aligns with PHP best practices for PHPDoc completeness.

---

63-65: Great improvement to API documentation!

Adding the @throws InvalidArgumentForVariadicFunctionException annotation properly documents the expected exception behavior for implementers of this abstract method. This makes the contract of the method clearer and helps maintainers understand when this exception should be thrown.

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