Add makeFooterIcon() wrapper

[malberts]

Fixes #450

Summary by CodeRabbit

• New Features
  • Added flexible functionality for generating footer icons in the application.
• Refactor
  • Streamlined the footer icon generation process for a more consistent rendering approach.
• Tests
  • Updated tests to directly validate footer icon rendering, ensuring improved reliability.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request introduces changes related to footer icon generation. A new public method makeFooterIcon has been added to the main template class to delegate footer icon creation. The method invocation in the footer icons component has been updated to call makeFooterIcon directly on a different skin template object. Additionally, the unit tests have been streamlined by removing an intermediate variable and setting expectations directly on the template method call.

Changes

File(s)	Summary of Changes
src/ChameleonTemplate.php, src/Components/FooterIcons.php	Added new public method makeFooterIcon in ChameleonTemplate (which calls getSkin()->makeFooterIcon). Modified FooterIcons to invoke the method via getSkinTemplate()->makeFooterIcon.
tests/.../FooterIconsTest.php	Removed the $skin variable and updated test expectations to directly verify that makeFooterIcon on $chameleonTemplate is called correctly with a simplified return value.

---

📜 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 f33f39b and 4499c1b.

📒 Files selected for processing (3)

• src/ChameleonTemplate.php (1 hunks)
• src/Components/FooterIcons.php (1 hunks)
• tests/phpunit/Unit/Components/FooterIconsTest.php (1 hunks)

🔇 Additional comments (3)

tests/phpunit/Unit/Components/FooterIconsTest.php (1)

50-58: LGTM! Test refactoring improves readability.

The test has been simplified by:

• Directly setting expectations on $chameleonTemplate instead of using an intermediate variable.
• Using a simpler return value syntax.

src/Components/FooterIcons.php (1)

74-74: LGTM! Method call chain simplified.

The change reduces the method call chain by directly using getSkinTemplate() instead of going through getSkin().

src/ChameleonTemplate.php (1)

161-163:

✅ Verification successful

LGTM! New method properly delegates footer icon creation.

The new makeFooterIcon method:

• Uses modern PHP 8 union type syntax.
• Correctly delegates to skin's implementation.

Since PHP 8's union type syntax is used, let's verify the minimum PHP version requirement:

---

🏁 Script executed:

#!/bin/bash
# Description: Check composer.json for PHP version requirement

# Find composer.json in the repository
fd -t f "composer.json" -x cat {} \; | jq -r '.require.php'

Length of output: 68

---

Verification Complete: PHP version requirement confirmed

The new makeFooterIcon method in src/ChameleonTemplate.php (lines 161-163) correctly utilizes PHP 8's union type (string|array) and delegates footer icon creation to the skin's implementation. The project's composer.json specifies a PHP requirement of >=8.0.0, confirming that the union type syntax is fully supported.

LGTM!

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

🪧 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. (Beta)
• @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.

[malberts]

Not ideal to add a wrapper to "fix" a final method being mocked in a test. However, usage is limited and it allows the test to still be useful until the current mocking approach is re-evaluated.