Refactor: Improve SalesBanner Maintainability

[JoshuaHungDinh]

Resolves: GIVE-1020

Description

This pull request enhances the extensibility of the main SalesBanner class by refactoring the GivingTuesdayBanner details into its own dedicated class. This separation improves maintainability and makes it easier to extend the functionality in the future.

In relation to GIVE-1020, a user was encountering a fatal error that we were unable to replicate. However, Rick provided a workaround that alleviated the issue for the user. This involved ensuring that the isShowing logic for GivingTuesdayBanner returns false when it should not load. One issue we noticed in the original implementation is that the SalesBanner class was unnecessarily loading scripts because this logic only checked if a user was on a "give-forms" page.

In the newly created GivingTuesdayBanner class, the isShowing method has been updated with a conditional check, ensuring that banner scripts only load when banners are available. This change aims to provide relief to users experiencing similar issues and improves the overall maintainability of the class.

Affects

SalesBanners

Visuals

Testing Instructions

We should retest the current banners to ensure they continue to work.

Admin Banners

• Create a new test site & install/activate GiveWP or use a local server.
• Add New Plugin > Upload Plugin > upload the attached file or activate the give plugin.
• Click through the Donations, Donors, and Reports pages.
• Verify the banners alternate between: GiveWP Plus plan & Peer-to-Peer.
• Add a Basic license.
• Click back through the same pages.
• Verify you see the same banners that were shown before you added a license.
• Now, add a Plus license instead.
• Click back through the same pages.
• Verify the banners alternate between: GiveWP Pro plan & Peer-to-Peer.
• Now, add a Pro and Agency license instead.
• Click back through the same pages.
• Verify only a stellar banner is shown.
• Test that the P2P banner never displays if P2P is active.
• Test that once a banner is closed it remains closed.
• Verify the links for each banner match the pricing plan.

Reports Widget Banners

• Visit the WordPress dashboard.
• Locate the GiveWP widget on the page.
• Verify the banner is displayed and the link takes you to the appropriate page.
• Verify after closing the banner, it is removed and remains closed.

Pre-review Checklist

• Acceptance criteria satisfied and marked in related issue
• Relevant @unreleased tags included in DocBlocks
• Includes unit tests
• Reviewed by the designer (if follows a design)
• Self Review of code and UX completed

[pauloiankoski]

It does look good!

[JoshuaHungDinh]

Closed reference: GIVE-1020

Will reconsider these changes during the next round of banners.