Improved column in tests

[MekDrop]

Summary by CodeRabbit

• Documentation

  • Updated usage examples in the documentation to reflect new namespace imports.
  • Removed unnecessary annotations from documentation comments.

• New Features

  • Added string conversion support to criteria elements, allowing them to be represented as strings.

• Refactor

  • Removed string conversion methods from certain classes to streamline functionality.

• Tests

  • Updated test data generation and removed unused exception annotations.

[coderabbitai]

Walkthrough

The updates modify namespace imports in the README example, adjust magic __toString() method implementations across several classes, and clean up annotations in both source and test files. Specifically, __toString() is centralized in the abstract class, removed from subclasses, and related imports and docblocks are updated accordingly.

Changes

File(s)	Change Summary
README.md	Updated usage example to import classes from Imponeer\Database\Criteria namespace.
src/CriteriaCompo.php, src/CriteriaItem.php	Removed __toString() methods and related imports/docblocks.
src/CriteriaElement.php	Added __toString() method calling render(true); imported Exception.
src/Traits/PartialResultsTrait.php	Removed @noinspection PhpDocSignatureInspection annotations from two methods.
tests/CriteriaItemTest.php	Removed @throws RandomException annotation; changed $column assignment to use Faker word.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CriteriaElement
    participant Subclass (CriteriaItem/CriteriaCompo)

    User->>CriteriaElement: (string) $element
    activate CriteriaElement
    CriteriaElement->>CriteriaElement: render(true)
    CriteriaElement-->>User: string result

Loading

Possibly related PRs

• Fixed Readme.md example #33: Updates namespace imports for CriteriaItem and CriteriaCompo in the README usage example, directly related to this PR.

Poem

In the warren of code, the strings align,
Centralized magic—now everything’s fine!
No more stray toStrings in the fields of green,
Just one in the abstract, tidy and clean.
The rabbits rejoice, documentation anew,
Hopping through namespaces, with a clearer view!
🐇✨

---

📜 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 b9789e1 and ce1ed3a.

📒 Files selected for processing (1)

• src/CriteriaElement.php (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/CriteriaElement.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

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

[coderabbitai]

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 97baa87 and b9789e1.

📒 Files selected for processing (6)

• README.md (1 hunks)
• src/CriteriaCompo.php (0 hunks)
• src/CriteriaElement.php (2 hunks)
• src/CriteriaItem.php (0 hunks)
• src/Traits/PartialResultsTrait.php (0 hunks)
• tests/CriteriaItemTest.php (1 hunks)

💤 Files with no reviewable changes (3)

• src/CriteriaItem.php
• src/Traits/PartialResultsTrait.php
• src/CriteriaCompo.php

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/CriteriaElement.php (3)

src/CriteriaCompo.php (1)

• render (96-110)

src/CriteriaItem.php (1)

• render (89-156)

src/Traits/RenderingTrait.php (1)

• render (30-30)

🔇 Additional comments (4)

tests/CriteriaItemTest.php (2)

22-22: LGTM: Accurate annotation removal.

The removal of @throws RandomException is correct since $faker->word() doesn't throw this exception, unlike the previous $faker->sha1() method.

---

29-29: Excellent improvement to test data quality.

Changing from $faker->sha1() to 'field_' . $faker->word() creates more realistic and meaningful database field names for testing. This makes the tests more readable and better represents actual use cases.

src/CriteriaElement.php (1)

5-5: LGTM: Necessary import added.

The Exception import is correctly added to support the @throws Exception annotation in the new __toString() method.

README.md (1)

24-25: LGTM: Namespace imports correctly updated.

The namespace imports are properly updated to reflect the new Imponeer\Database\Criteria namespace structure, ensuring the documentation examples remain accurate.