Skip to content

Conversation

@MekDrop
Copy link
Member

@MekDrop MekDrop commented Jul 15, 2025

Resolves #33

Summary by CodeRabbit

  • Chores
    • Updated supported PHP versions to 8.3 and 8.4 in testing and composer configuration.
    • Enabled strict typing in relevant files.
    • Improved type declarations for properties and method signatures.
    • Added PSR-4 autoloading for test classes.

@coderabbitai
Copy link

coderabbitai bot commented Jul 15, 2025

Walkthrough

The changes update PHP compatibility across the project to require PHP 8.3 or higher. The composer configuration, GitHub Actions workflow, source, and test files are revised to enforce strict types and modern PHP syntax. Test autoloading is also configured in composer for development.

Changes

File(s) Change Summary
.github/workflows/on_pull_request.yml Updated CI matrix to test only PHP 8.3 and 8.4; removed older PHP versions from workflow.
composer.json Set PHP requirement to ^8.3; added autoload-dev for test namespace.
src/IncludeQCompiler.php Enabled strict typing; added void return type to validateArguments method.
tests/IncludeQCompilerTest.php Enabled strict typing; added type declarations for property and method return types.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant Composer
    participant CI
    participant PHP

    Developer->>Composer: Update composer.json (require ^8.3)
    Composer->>PHP: Enforce PHP >= 8.3 on install
    CI->>PHP: Run tests on PHP 8.3 and 8.4 only
    CI->>Composer: Use autoload-dev for tests
Loading

Possibly related issues

Poem

A hop and a skip, we leap ahead,
PHP 8.3 is now our bed!
Old versions gone, the code is tight,
With strict types shining, oh so bright.
Composer sings with autoload cheer—
The future of Smarty is crystal clear!
🐇✨

✨ 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

@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: 2

🧹 Nitpick comments (2)
src/IncludeQCompiler.php (1)

57-57: Add type hints to the public execute() API as well
validateArguments() was upgraded to : void; consider doing the same for execute:

- public function execute($args, Smarty_Internal_SmartyTemplateCompiler $compiler)
+ public function execute(array $args, Smarty_Internal_SmartyTemplateCompiler $compiler): string

This removes the mixed $args parameter, propagates strictness, and documents the generated PHP string return value.

.github/workflows/on_pull_request.yml (1)

15-18: Nightly 8.4 builds can be flaky

shivammathur/setup-php maps 8.4 to the current nightly snapshot. CI might break on upstream changes.
If stability is critical, pin to 8.4snapshot or remove it until 8.4 is released.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2f252d0 and ccf2882.

📒 Files selected for processing (4)
  • .github/workflows/on_pull_request.yml (1 hunks)
  • composer.json (2 hunks)
  • src/IncludeQCompiler.php (2 hunks)
  • tests/IncludeQCompilerTest.php (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
tests/IncludeQCompilerTest.php (1)
src/IncludeQCompiler.php (2)
  • IncludeQCompiler (15-145)
  • getName (141-144)
🔇 Additional comments (4)
src/IncludeQCompiler.php (1)

2-2: 👍 Strict-types declaration is a welcome hardening step
Enabling strict types project-wide reduces accidental scalar coercions and aligns with the PHP-8.3 baseline.

tests/IncludeQCompilerTest.php (2)

2-2: Strict-types in tests keep runtime behaviour consistent
Good to see the test-suite compiled in the same mode as production code.


27-36: Method signatures updated – good, but PHPUnit 8 may not parse them on PHP 8.3

composer.json still allows phpunit/phpunit ^8.0, yet PHPUnit 8 is unmaintained and not tested on PHP 8.3.
Bump to ^10.0 (or at minimum ^9.6) to avoid unexpected runtime issues.

composer.json (1)

21-25: 👍 PSR-4 dev autoload improves IDE discovery
Adding autoload-dev for tests makes running composer dump-autoload sufficient for PHPUnit to find test classes.

* @var Smarty
*/
private $smarty;
private Smarty $smarty;
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Missing typed property triggers deprecation in PHP 8.3

$plugin is created dynamically in setUp(). Dynamic properties raise E_DEPRECATED since PHP 8.2 and will become fatal in a future release.

 class IncludeQCompilerTest extends TestCase
 {
-    private Smarty $smarty;
+    private Smarty $smarty;
+    private IncludeQCompiler $plugin;
 }

Add the declaration (and corresponding use if you prefer a fully-qualified name) to silence the warning and future-proof the test.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
private Smarty $smarty;
class IncludeQCompilerTest extends TestCase
{
private Smarty $smarty;
private IncludeQCompiler $plugin;
// … rest of the test class …
}
🤖 Prompt for AI Agents
In tests/IncludeQCompilerTest.php at line 10, the property $plugin is used
dynamically in setUp() but not declared, causing a deprecation warning in PHP
8.3. To fix this, declare the $plugin property explicitly in the class with the
appropriate type hint, adding a use statement if needed for the type. This will
prevent the dynamic property warning and future-proof the code.

"type": "library",
"require": {
"php": "^7.3 || ^8.0",
"php": "^8.3",
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Composer PHP constraint updated – remember PHPUnit compatibility

Now that the package requires PHP 8.3+, ensure require-dev lists a PHPUnit version that officially supports 8.3 (≥ 9.6 / 10.x).

-    "require-dev": {
-        "phpunit/phpunit": "^8.0 || ^9.0"
+    "require-dev": {
+        "phpunit/phpunit": "^9.6 || ^10.0"

This prevents composer from installing an outdated PHPUnit build during CI.

🤖 Prompt for AI Agents
In composer.json at line 6, the PHP version constraint was updated to "^8.3". To
maintain compatibility, update the require-dev section to specify a PHPUnit
version that supports PHP 8.3, such as version 9.6 or 10.x. Modify the PHPUnit
version constraint accordingly to prevent composer from installing an
incompatible or outdated PHPUnit version during continuous integration.

@MekDrop MekDrop merged commit 584ece5 into imponeer:main Jul 16, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Bump to min PHP 8.3

1 participant