From b52f464a83b1942a6e473d55beebe56fb4ce7fea Mon Sep 17 00:00:00 2001 From: jrfnl Date: Fri, 22 Dec 2023 01:42:51 +0100 Subject: [PATCH] Rename classes and interfaces --- .phpcs.xml.dist | 7 +- composer.json | 2 +- ...ip_Configuration.php => Configuration.php} | 22 ++-- ...ip_EmptyProperty.php => EmptyProperty.php} | 2 +- ...eratorType.php => InvalidOperatorType.php} | 2 +- .../{Whip_InvalidType.php => InvalidType.php} | 2 +- ...php => InvalidVersionComparisonString.php} | 2 +- src/Facades/wordpress.php | 20 ++-- src/{Whip_Host.php => Host.php} | 2 +- ..._DismissStorage.php => DismissStorage.php} | 4 +- .../{Whip_Listener.php => Listener.php} | 4 +- .../{Whip_Message.php => Message.php} | 4 +- ...sagePresenter.php => MessagePresenter.php} | 4 +- .../{Whip_Requirement.php => Requirement.php} | 4 +- ...ersionDetector.php => VersionDetector.php} | 2 +- ...sageDismisser.php => MessageDismisser.php} | 16 +-- ...sageFormatter.php => MessageFormatter.php} | 2 +- ...Whip_BasicMessage.php => BasicMessage.php} | 20 ++-- .../{Whip_HostMessage.php => HostMessage.php} | 18 +-- ...p => InvalidVersionRequirementMessage.php} | 16 +-- .../{Whip_NullMessage.php => NullMessage.php} | 6 +- ...dePhpMessage.php => UpgradePhpMessage.php} | 36 +++--- ...essagesManager.php => MessagesManager.php} | 16 +-- ...gePresenter.php => WPMessagePresenter.php} | 28 ++--- ...ntsChecker.php => RequirementsChecker.php} | 42 +++---- ...Requirement.php => VersionRequirement.php} | 42 +++---- ...PDismissOption.php => WPDismissOption.php} | 6 +- ...tener.php => WPMessageDismissListener.php} | 12 +- tests/Unit/BasicMessageTest.php | 20 ++-- tests/Unit/ConfigurationTest.php | 34 +++--- tests/Unit/Doubles/DismissStorageMock.php | 4 +- tests/Unit/MessageDismisserTest.php | 16 +-- tests/Unit/MessagesManagerTest.php | 6 +- tests/Unit/RequirementsCheckerTest.php | 110 +++++++++--------- tests/Unit/VersionRequirementTest.php | 90 +++++++------- tests/Unit/WPMessageDismissListenerTest.php | 14 +-- 36 files changed, 322 insertions(+), 315 deletions(-) rename src/{Whip_Configuration.php => Configuration.php} (61%) rename src/Exceptions/{Whip_EmptyProperty.php => EmptyProperty.php} (87%) rename src/Exceptions/{Whip_InvalidOperatorType.php => InvalidOperatorType.php} (91%) rename src/Exceptions/{Whip_InvalidType.php => InvalidType.php} (91%) rename src/Exceptions/{Whip_InvalidVersionComparisonString.php => InvalidVersionComparisonString.php} (88%) rename src/{Whip_Host.php => Host.php} (99%) rename src/Interfaces/{Whip_DismissStorage.php => DismissStorage.php} (82%) rename src/Interfaces/{Whip_Listener.php => Listener.php} (76%) rename src/Interfaces/{Whip_Message.php => Message.php} (74%) rename src/Interfaces/{Whip_MessagePresenter.php => MessagePresenter.php} (67%) rename src/Interfaces/{Whip_Requirement.php => Requirement.php} (88%) rename src/Interfaces/{Whip_VersionDetector.php => VersionDetector.php} (92%) rename src/{Whip_MessageDismisser.php => MessageDismisser.php} (72%) rename src/{Whip_MessageFormatter.php => MessageFormatter.php} (95%) rename src/Messages/{Whip_BasicMessage.php => BasicMessage.php} (56%) rename src/Messages/{Whip_HostMessage.php => HostMessage.php} (69%) rename src/Messages/{Whip_InvalidVersionRequirementMessage.php => InvalidVersionRequirementMessage.php} (55%) rename src/Messages/{Whip_NullMessage.php => NullMessage.php} (59%) rename src/Messages/{Whip_UpgradePhpMessage.php => UpgradePhpMessage.php} (58%) rename src/{Whip_MessagesManager.php => MessagesManager.php} (81%) rename src/Presenters/{Whip_WPMessagePresenter.php => WPMessagePresenter.php} (69%) rename src/{Whip_RequirementsChecker.php => RequirementsChecker.php} (72%) rename src/{Whip_VersionRequirement.php => VersionRequirement.php} (66%) rename src/{Whip_WPDismissOption.php => WPDismissOption.php} (78%) rename src/{Whip_WPMessageDismissListener.php => WPMessageDismissListener.php} (79%) diff --git a/.phpcs.xml.dist b/.phpcs.xml.dist index 5d60707..fbe9ab3 100644 --- a/.phpcs.xml.dist +++ b/.phpcs.xml.dist @@ -140,14 +140,15 @@ - /src/Messages/Whip_HostMessage\.php$ - /src/Messages/Whip_UpgradePhpMessage\.php$ + /src/Messages/HostMessage\.php$ + /src/Messages/UpgradePhpMessage\.php$ - /src/Whip_Host\.php$ + /src/Host\.php$ + /src/Messages/UpgradePhpMessage\.php$ diff --git a/composer.json b/composer.json index 5a1be0a..7aad5d8 100644 --- a/composer.json +++ b/composer.json @@ -56,7 +56,7 @@ "Yoast\\WHIP\\Config\\Composer\\Actions::check_coding_standards" ], "check-cs-thresholds": [ - "@putenv YOASTCS_THRESHOLD_ERRORS=8", + "@putenv YOASTCS_THRESHOLD_ERRORS=10", "@putenv YOASTCS_THRESHOLD_WARNINGS=0", "Yoast\\WHIP\\Config\\Composer\\Actions::check_cs_thresholds" ], diff --git a/src/Whip_Configuration.php b/src/Configuration.php similarity index 61% rename from src/Whip_Configuration.php rename to src/Configuration.php index b853d3c..1d6fdc1 100644 --- a/src/Whip_Configuration.php +++ b/src/Configuration.php @@ -2,13 +2,13 @@ namespace Yoast\WHIPv2; -use Yoast\WHIPv2\Exceptions\Whip_InvalidType; -use Yoast\WHIPv2\Interfaces\Whip_Requirement; +use Yoast\WHIPv2\Exceptions\InvalidType; +use Yoast\WHIPv2\Interfaces\Requirement; /** - * Class Whip_Configuration. + * Class Configuration. */ -class Whip_Configuration { +class Configuration { /** * The configuration to use. @@ -18,15 +18,15 @@ class Whip_Configuration { private $configuration; /** - * Whip_Configuration constructor. + * Configuration constructor. * * @param array $configuration The configuration to use. * - * @throws Whip_InvalidType When the $configuration parameter is not of the expected type. + * @throws InvalidType When the $configuration parameter is not of the expected type. */ public function __construct( $configuration = array() ) { if ( ! \is_array( $configuration ) ) { - throw new Whip_InvalidType( 'Configuration', $configuration, 'array' ); + throw new InvalidType( 'Configuration', $configuration, 'array' ); } $this->configuration = $configuration; @@ -35,12 +35,12 @@ public function __construct( $configuration = array() ) { /** * Retrieves the configured version of a particular requirement. * - * @param Whip_Requirement $requirement The requirement to check. + * @param Requirement $requirement The requirement to check. * * @return string|int The version of the passed requirement that was detected as a string. * If the requirement does not exist, this returns int -1. */ - public function configuredVersion( Whip_Requirement $requirement ) { + public function configuredVersion( Requirement $requirement ) { if ( ! $this->hasRequirementConfigured( $requirement ) ) { return -1; } @@ -51,11 +51,11 @@ public function configuredVersion( Whip_Requirement $requirement ) { /** * Determines whether the passed requirement is present in the configuration. * - * @param Whip_Requirement $requirement The requirement to check. + * @param Requirement $requirement The requirement to check. * * @return bool Whether or not the requirement is present in the configuration. */ - public function hasRequirementConfigured( Whip_Requirement $requirement ) { + public function hasRequirementConfigured( Requirement $requirement ) { return \array_key_exists( $requirement->component(), $this->configuration ); } } diff --git a/src/Exceptions/Whip_EmptyProperty.php b/src/Exceptions/EmptyProperty.php similarity index 87% rename from src/Exceptions/Whip_EmptyProperty.php rename to src/Exceptions/EmptyProperty.php index 141d209..844372b 100644 --- a/src/Exceptions/Whip_EmptyProperty.php +++ b/src/Exceptions/EmptyProperty.php @@ -7,7 +7,7 @@ /** * Class EmptyProperty. */ -class Whip_EmptyProperty extends Exception { +class EmptyProperty extends Exception { /** * EmptyProperty constructor. diff --git a/src/Exceptions/Whip_InvalidOperatorType.php b/src/Exceptions/InvalidOperatorType.php similarity index 91% rename from src/Exceptions/Whip_InvalidOperatorType.php rename to src/Exceptions/InvalidOperatorType.php index b9ea117..7fedcac 100644 --- a/src/Exceptions/Whip_InvalidOperatorType.php +++ b/src/Exceptions/InvalidOperatorType.php @@ -7,7 +7,7 @@ /** * Class InvalidOperatorType. */ -class Whip_InvalidOperatorType extends Exception { +class InvalidOperatorType extends Exception { /** * InvalidOperatorType constructor. diff --git a/src/Exceptions/Whip_InvalidType.php b/src/Exceptions/InvalidType.php similarity index 91% rename from src/Exceptions/Whip_InvalidType.php rename to src/Exceptions/InvalidType.php index 1cb13fa..6ed1daf 100644 --- a/src/Exceptions/Whip_InvalidType.php +++ b/src/Exceptions/InvalidType.php @@ -7,7 +7,7 @@ /** * Class InvalidType. */ -class Whip_InvalidType extends Exception { +class InvalidType extends Exception { /** * InvalidType constructor. diff --git a/src/Exceptions/Whip_InvalidVersionComparisonString.php b/src/Exceptions/InvalidVersionComparisonString.php similarity index 88% rename from src/Exceptions/Whip_InvalidVersionComparisonString.php rename to src/Exceptions/InvalidVersionComparisonString.php index 55a7019..0356fef 100644 --- a/src/Exceptions/Whip_InvalidVersionComparisonString.php +++ b/src/Exceptions/InvalidVersionComparisonString.php @@ -7,7 +7,7 @@ /** * Exception for an invalid version comparison string. */ -class Whip_InvalidVersionComparisonString extends Exception { +class InvalidVersionComparisonString extends Exception { /** * InvalidVersionComparisonString constructor. diff --git a/src/Facades/wordpress.php b/src/Facades/wordpress.php index 2897af2..e5adc44 100644 --- a/src/Facades/wordpress.php +++ b/src/Facades/wordpress.php @@ -5,11 +5,11 @@ * @package Yoast\WHIP */ -use Yoast\WHIPv2\Presenters\Whip_WPMessagePresenter; -use Yoast\WHIPv2\Whip_MessageDismisser; -use Yoast\WHIPv2\Whip_RequirementsChecker; -use Yoast\WHIPv2\Whip_VersionRequirement; -use Yoast\WHIPv2\Whip_WPDismissOption; +use Yoast\WHIPv2\MessageDismisser; +use Yoast\WHIPv2\Presenters\WPMessagePresenter; +use Yoast\WHIPv2\RequirementsChecker; +use Yoast\WHIPv2\VersionRequirement; +use Yoast\WHIPv2\WPDismissOption; if ( ! function_exists( 'whip_wp_check_versions' ) ) { /** @@ -26,10 +26,10 @@ function whip_wp_check_versions( $requirements ) { } $config = include __DIR__ . '/../Configs/default.php'; - $checker = new Whip_RequirementsChecker( $config ); + $checker = new RequirementsChecker( $config ); foreach ( $requirements as $component => $versionComparison ) { - $checker->addRequirement( Whip_VersionRequirement::fromCompareString( $component, $versionComparison ) ); + $checker->addRequirement( VersionRequirement::fromCompareString( $component, $versionComparison ) ); } $checker->check(); @@ -41,9 +41,9 @@ function whip_wp_check_versions( $requirements ) { $dismissThreshold = ( WEEK_IN_SECONDS * 4 ); $dismissMessage = __( 'Remind me again in 4 weeks.', 'default' ); - $dismisser = new Whip_MessageDismisser( time(), $dismissThreshold, new Whip_WPDismissOption() ); + $dismisser = new MessageDismisser( time(), $dismissThreshold, new WPDismissOption() ); - $presenter = new Whip_WPMessagePresenter( $checker->getMostRecentMessage(), $dismisser, $dismissMessage ); + $presenter = new WPMessagePresenter( $checker->getMostRecentMessage(), $dismisser, $dismissMessage ); // Prevent duplicate notices across multiple implementing plugins. if ( ! has_action( 'whip_register_hooks' ) ) { @@ -53,7 +53,7 @@ function whip_wp_check_versions( $requirements ) { /** * Fires during hooks registration for the message presenter. * - * @param Whip_WPMessagePresenter $presenter Message presenter instance. + * @param WPMessagePresenter $presenter Message presenter instance. */ do_action( 'whip_register_hooks', $presenter ); } diff --git a/src/Whip_Host.php b/src/Host.php similarity index 99% rename from src/Whip_Host.php rename to src/Host.php index 22e0e26..fce2013 100644 --- a/src/Whip_Host.php +++ b/src/Host.php @@ -5,7 +5,7 @@ /** * Represents a host. */ -class Whip_Host { +class Host { /** * Key to an environment variable which should be set to the name of the host. diff --git a/src/Interfaces/Whip_DismissStorage.php b/src/Interfaces/DismissStorage.php similarity index 82% rename from src/Interfaces/Whip_DismissStorage.php rename to src/Interfaces/DismissStorage.php index 96a4f46..bd7bd8c 100644 --- a/src/Interfaces/Whip_DismissStorage.php +++ b/src/Interfaces/DismissStorage.php @@ -3,9 +3,9 @@ namespace Yoast\WHIPv2\Interfaces; /** - * Interface Whip_DismissStorage. + * Interface DismissStorage. */ -interface Whip_DismissStorage { +interface DismissStorage { /** * Saves the value. diff --git a/src/Interfaces/Whip_Listener.php b/src/Interfaces/Listener.php similarity index 76% rename from src/Interfaces/Whip_Listener.php rename to src/Interfaces/Listener.php index c124b4c..f7796aa 100644 --- a/src/Interfaces/Whip_Listener.php +++ b/src/Interfaces/Listener.php @@ -3,9 +3,9 @@ namespace Yoast\WHIPv2\Interfaces; /** - * Interface Whip_Listener. + * Interface Listener. */ -interface Whip_Listener { +interface Listener { /** * Method that should implement the listen functionality. diff --git a/src/Interfaces/Whip_Message.php b/src/Interfaces/Message.php similarity index 74% rename from src/Interfaces/Whip_Message.php rename to src/Interfaces/Message.php index 27899b2..a9d2ddf 100644 --- a/src/Interfaces/Whip_Message.php +++ b/src/Interfaces/Message.php @@ -3,9 +3,9 @@ namespace Yoast\WHIPv2\Interfaces; /** - * Interface Whip_Message. + * Interface Message. */ -interface Whip_Message { +interface Message { /** * Retrieves the message body. diff --git a/src/Interfaces/Whip_MessagePresenter.php b/src/Interfaces/MessagePresenter.php similarity index 67% rename from src/Interfaces/Whip_MessagePresenter.php rename to src/Interfaces/MessagePresenter.php index ecbac5b..80ebd99 100644 --- a/src/Interfaces/Whip_MessagePresenter.php +++ b/src/Interfaces/MessagePresenter.php @@ -3,9 +3,9 @@ namespace Yoast\WHIPv2\Interfaces; /** - * Interface Whip_MessagePresenter. + * Interface MessagePresenter. */ -interface Whip_MessagePresenter { +interface MessagePresenter { /** * Renders the message. diff --git a/src/Interfaces/Whip_Requirement.php b/src/Interfaces/Requirement.php similarity index 88% rename from src/Interfaces/Whip_Requirement.php rename to src/Interfaces/Requirement.php index e2d66e4..38e7db9 100644 --- a/src/Interfaces/Whip_Requirement.php +++ b/src/Interfaces/Requirement.php @@ -3,9 +3,9 @@ namespace Yoast\WHIPv2\Interfaces; /** - * Interface Whip_Requirement. + * Interface Requirement. */ -interface Whip_Requirement { +interface Requirement { /** * Retrieves the component name defined for the requirement. diff --git a/src/Interfaces/Whip_VersionDetector.php b/src/Interfaces/VersionDetector.php similarity index 92% rename from src/Interfaces/Whip_VersionDetector.php rename to src/Interfaces/VersionDetector.php index 48f5e95..3cbb172 100644 --- a/src/Interfaces/Whip_VersionDetector.php +++ b/src/Interfaces/VersionDetector.php @@ -5,7 +5,7 @@ /** * An interface that represents a version detector and message. */ -interface Whip_VersionDetector { +interface VersionDetector { /** * Detects the version of the installed software. diff --git a/src/Whip_MessageDismisser.php b/src/MessageDismisser.php similarity index 72% rename from src/Whip_MessageDismisser.php rename to src/MessageDismisser.php index 7db8fd8..2bc6fb3 100644 --- a/src/Whip_MessageDismisser.php +++ b/src/MessageDismisser.php @@ -2,17 +2,17 @@ namespace Yoast\WHIPv2; -use Yoast\WHIPv2\Interfaces\Whip_DismissStorage; +use Yoast\WHIPv2\Interfaces\DismissStorage; /** * A class to dismiss messages. */ -class Whip_MessageDismisser { +class MessageDismisser { /** * Storage object to manage the dismissal state. * - * @var Whip_DismissStorage + * @var DismissStorage */ protected $storage; @@ -31,13 +31,13 @@ class Whip_MessageDismisser { protected $threshold; /** - * Whip_MessageDismisser constructor. + * MessageDismisser constructor. * - * @param int $currentTime The current time. - * @param int $threshold The number of seconds the message will be dismissed. - * @param Whip_DismissStorage $storage Storage object to manage the dismissal state. + * @param int $currentTime The current time. + * @param int $threshold The number of seconds the message will be dismissed. + * @param DismissStorage $storage Storage object to manage the dismissal state. */ - public function __construct( $currentTime, $threshold, Whip_DismissStorage $storage ) { + public function __construct( $currentTime, $threshold, DismissStorage $storage ) { $this->currentTime = $currentTime; $this->threshold = $threshold; $this->storage = $storage; diff --git a/src/Whip_MessageFormatter.php b/src/MessageFormatter.php similarity index 95% rename from src/Whip_MessageFormatter.php rename to src/MessageFormatter.php index 86bb0d4..b94d953 100644 --- a/src/Whip_MessageFormatter.php +++ b/src/MessageFormatter.php @@ -5,7 +5,7 @@ /** * A helper class to format messages. */ -final class Whip_MessageFormatter { +final class MessageFormatter { /** * Wraps a piece of text in HTML strong tags. diff --git a/src/Messages/Whip_BasicMessage.php b/src/Messages/BasicMessage.php similarity index 56% rename from src/Messages/Whip_BasicMessage.php rename to src/Messages/BasicMessage.php index 396cd01..41205b0 100644 --- a/src/Messages/Whip_BasicMessage.php +++ b/src/Messages/BasicMessage.php @@ -2,14 +2,14 @@ namespace Yoast\WHIPv2\Messages; -use Yoast\WHIPv2\Exceptions\Whip_EmptyProperty; -use Yoast\WHIPv2\Exceptions\Whip_InvalidType; -use Yoast\WHIPv2\Interfaces\Whip_Message; +use Yoast\WHIPv2\Exceptions\EmptyProperty; +use Yoast\WHIPv2\Exceptions\InvalidType; +use Yoast\WHIPv2\Interfaces\Message; /** - * Class Whip_Message. + * Class BasicMessage. */ -class Whip_BasicMessage implements Whip_Message { +class BasicMessage implements Message { /** * Message body. @@ -19,7 +19,7 @@ class Whip_BasicMessage implements Whip_Message { private $body; /** - * Whip_Message constructor. + * Message constructor. * * @param string $body Message body. */ @@ -45,16 +45,16 @@ public function body() { * * @return void * - * @throws Whip_EmptyProperty When the $body parameter is empty. - * @throws Whip_InvalidType When the $body parameter is not of the expected type. + * @throws EmptyProperty When the $body parameter is empty. + * @throws InvalidType When the $body parameter is not of the expected type. */ private function validateParameters( $body ) { if ( empty( $body ) ) { - throw new Whip_EmptyProperty( 'Message body' ); + throw new EmptyProperty( 'Message body' ); } if ( ! \is_string( $body ) ) { - throw new Whip_InvalidType( 'Message body', $body, 'string' ); + throw new InvalidType( 'Message body', $body, 'string' ); } } } diff --git a/src/Messages/Whip_HostMessage.php b/src/Messages/HostMessage.php similarity index 69% rename from src/Messages/Whip_HostMessage.php rename to src/Messages/HostMessage.php index ac7265b..90ad290 100644 --- a/src/Messages/Whip_HostMessage.php +++ b/src/Messages/HostMessage.php @@ -2,14 +2,14 @@ namespace Yoast\WHIPv2\Messages; -use Yoast\WHIPv2\Interfaces\Whip_Message; -use Yoast\WHIPv2\Whip_Host; -use Yoast\WHIPv2\Whip_MessageFormatter; +use Yoast\WHIPv2\Host; +use Yoast\WHIPv2\Interfaces\Message; +use Yoast\WHIPv2\MessageFormatter; /** - * Class Whip_HostMessage. + * Class HostMessage. */ -class Whip_HostMessage implements Whip_Message { +class HostMessage implements Message { /** * Text domain to use for translations. @@ -26,7 +26,7 @@ class Whip_HostMessage implements Whip_Message { private $messageKey; /** - * Whip_Message constructor. + * Message constructor. * * @param string $messageKey The environment key to use to retrieve the message from. * @param string $textdomain The text domain to use for translations. @@ -44,8 +44,8 @@ public function __construct( $messageKey, $textdomain ) { public function body() { $message = array(); - $message[] = Whip_MessageFormatter::strong( $this->title() ) . '
'; - $message[] = Whip_MessageFormatter::paragraph( Whip_Host::message( $this->messageKey ) ); + $message[] = MessageFormatter::strong( $this->title() ) . '
'; + $message[] = MessageFormatter::paragraph( Host::message( $this->messageKey ) ); return \implode( "\n", $message ); } @@ -57,6 +57,6 @@ public function body() { */ public function title() { /* translators: 1: name. */ - return \sprintf( \__( 'A message from %1$s', $this->textdomain ), Whip_Host::name() ); + return \sprintf( \__( 'A message from %1$s', $this->textdomain ), Host::name() ); } } diff --git a/src/Messages/Whip_InvalidVersionRequirementMessage.php b/src/Messages/InvalidVersionRequirementMessage.php similarity index 55% rename from src/Messages/Whip_InvalidVersionRequirementMessage.php rename to src/Messages/InvalidVersionRequirementMessage.php index 1b0c6f8..db30012 100644 --- a/src/Messages/Whip_InvalidVersionRequirementMessage.php +++ b/src/Messages/InvalidVersionRequirementMessage.php @@ -2,18 +2,18 @@ namespace Yoast\WHIPv2\Messages; -use Yoast\WHIPv2\Interfaces\Whip_Message; -use Yoast\WHIPv2\Whip_VersionRequirement; +use Yoast\WHIPv2\Interfaces\Message; +use Yoast\WHIPv2\VersionRequirement; /** * Class Whip_InvalidVersionMessage. */ -class Whip_InvalidVersionRequirementMessage implements Whip_Message { +class InvalidVersionRequirementMessage implements Message { /** * Object containing the version requirement for a component. * - * @var Whip_VersionRequirement + * @var VersionRequirement */ private $requirement; @@ -25,12 +25,12 @@ class Whip_InvalidVersionRequirementMessage implements Whip_Message { private $detected; /** - * Whip_InvalidVersionRequirementMessage constructor. + * InvalidVersionRequirementMessage constructor. * - * @param Whip_VersionRequirement $requirement Object containing the version requirement for a component. - * @param string|int $detected Detected version requirement or -1 if not found. + * @param VersionRequirement $requirement Object containing the version requirement for a component. + * @param string|int $detected Detected version requirement or -1 if not found. */ - public function __construct( Whip_VersionRequirement $requirement, $detected ) { + public function __construct( VersionRequirement $requirement, $detected ) { $this->requirement = $requirement; $this->detected = $detected; } diff --git a/src/Messages/Whip_NullMessage.php b/src/Messages/NullMessage.php similarity index 59% rename from src/Messages/Whip_NullMessage.php rename to src/Messages/NullMessage.php index 5667d4d..bbb364c 100644 --- a/src/Messages/Whip_NullMessage.php +++ b/src/Messages/NullMessage.php @@ -2,12 +2,12 @@ namespace Yoast\WHIPv2\Messages; -use Yoast\WHIPv2\Interfaces\Whip_Message; +use Yoast\WHIPv2\Interfaces\Message; /** - * Class Whip_Message. + * Class NullMessage. */ -class Whip_NullMessage implements Whip_Message { +class NullMessage implements Message { /** * Retrieves the message body. diff --git a/src/Messages/Whip_UpgradePhpMessage.php b/src/Messages/UpgradePhpMessage.php similarity index 58% rename from src/Messages/Whip_UpgradePhpMessage.php rename to src/Messages/UpgradePhpMessage.php index 3f3364b..4aa5040 100644 --- a/src/Messages/Whip_UpgradePhpMessage.php +++ b/src/Messages/UpgradePhpMessage.php @@ -2,14 +2,14 @@ namespace Yoast\WHIPv2\Messages; -use Yoast\WHIPv2\Interfaces\Whip_Message; -use Yoast\WHIPv2\Whip_Host; -use Yoast\WHIPv2\Whip_MessageFormatter; +use Yoast\WHIPv2\Host; +use Yoast\WHIPv2\Interfaces\Message; +use Yoast\WHIPv2\MessageFormatter; /** - * Class Whip_UpgradePhpMessage + * Class UpgradePhpMessage */ -class Whip_UpgradePhpMessage implements Whip_Message { +class UpgradePhpMessage implements Message { /** * The text domain to use for the translations. @@ -19,7 +19,7 @@ class Whip_UpgradePhpMessage implements Whip_Message { private $textdomain; /** - * Whip_UpgradePhpMessage constructor. + * UpgradePhpMessage constructor. * * @param string $textdomain The text domain to use for the translations. */ @@ -37,11 +37,11 @@ public function body() { $message = array(); - $message[] = Whip_MessageFormatter::strongParagraph( \__( 'Your site could be faster and more secure with a newer PHP version.', $textdomain ) ) . '
'; - $message[] = Whip_MessageFormatter::paragraph( \__( 'Hey, we\'ve noticed that you\'re running an outdated version of PHP. PHP is the programming language that WordPress and all its plugins and themes are built on. The version that is currently used for your site is no longer supported. Newer versions of PHP are both faster and more secure. In fact, your version of PHP no longer receives security updates, which is why we\'re sending you to this notice.', $textdomain ) ); - $message[] = Whip_MessageFormatter::paragraph( \__( 'Hosts have the ability to update your PHP version, but sometimes they don\'t dare to do that because they\'re afraid they\'ll break your site.', $textdomain ) ); - $message[] = Whip_MessageFormatter::strongParagraph( \__( 'To which version should I update?', $textdomain ) ) . '
'; - $message[] = Whip_MessageFormatter::paragraph( + $message[] = MessageFormatter::strongParagraph( \__( 'Your site could be faster and more secure with a newer PHP version.', $textdomain ) ) . '
'; + $message[] = MessageFormatter::paragraph( \__( 'Hey, we\'ve noticed that you\'re running an outdated version of PHP. PHP is the programming language that WordPress and all its plugins and themes are built on. The version that is currently used for your site is no longer supported. Newer versions of PHP are both faster and more secure. In fact, your version of PHP no longer receives security updates, which is why we\'re sending you to this notice.', $textdomain ) ); + $message[] = MessageFormatter::paragraph( \__( 'Hosts have the ability to update your PHP version, but sometimes they don\'t dare to do that because they\'re afraid they\'ll break your site.', $textdomain ) ); + $message[] = MessageFormatter::strongParagraph( \__( 'To which version should I update?', $textdomain ) ) . '
'; + $message[] = MessageFormatter::paragraph( \sprintf( /* translators: 1: link open tag; 2: link close tag. */ \__( 'You should update your PHP version to either 5.6 or to 7.0 or 7.1. On a normal WordPress site, switching to PHP 5.6 should never cause issues. We would however actually recommend you switch to PHP7. There are some plugins that are not ready for PHP7 though, so do some testing first. We have an article on how to test whether that\'s an option for you %1$shere%2$s. PHP7 is much faster than PHP 5.6. It\'s also the only PHP version still in active development and therefore the better option for your site in the long run.', $textdomain ), @@ -50,17 +50,17 @@ public function body() { ) ); - if ( Whip_Host::name() !== '' ) { - $hostMessage = new Whip_HostMessage( 'WHIP_MESSAGE_FROM_HOST_ABOUT_PHP', $textdomain ); + if ( Host::name() !== '' ) { + $hostMessage = new HostMessage( 'WHIP_MESSAGE_FROM_HOST_ABOUT_PHP', $textdomain ); $message[] = $hostMessage->body(); } - $hostingPageUrl = Whip_Host::hostingPageUrl(); + $hostingPageUrl = Host::hostingPageUrl(); - $message[] = Whip_MessageFormatter::strongParagraph( \__( 'Can\'t update? Ask your host!', $textdomain ) ) . '
'; + $message[] = MessageFormatter::strongParagraph( \__( 'Can\'t update? Ask your host!', $textdomain ) ) . '
'; - if ( \function_exists( 'apply_filters' ) && \apply_filters( Whip_Host::HOSTING_PAGE_FILTER_KEY, false ) ) { - $message[] = Whip_MessageFormatter::paragraph( + if ( \function_exists( 'apply_filters' ) && \apply_filters( Host::HOSTING_PAGE_FILTER_KEY, false ) ) { + $message[] = MessageFormatter::paragraph( \sprintf( /* translators: 1: link open tag; 2: link close tag; 3: link open tag. */ \__( 'If you cannot upgrade your PHP version yourself, you can send an email to your host. We have %1$sexamples here%2$s. If they don\'t want to upgrade your PHP version, we would suggest you switch hosts. Have a look at one of the recommended %3$sWordPress hosting partners%2$s.', $textdomain ), @@ -71,7 +71,7 @@ public function body() { ); } else { - $message[] = Whip_MessageFormatter::paragraph( + $message[] = MessageFormatter::paragraph( \sprintf( /* translators: 1: link open tag; 2: link close tag; 3: link open tag. */ \__( 'If you cannot upgrade your PHP version yourself, you can send an email to your host. We have %1$sexamples here%2$s. If they don\'t want to upgrade your PHP version, we would suggest you switch hosts. Have a look at one of our recommended %3$sWordPress hosting partners%2$s, they\'ve all been vetted by the Yoast support team and provide all the features a modern host should provide.', $textdomain ), diff --git a/src/Whip_MessagesManager.php b/src/MessagesManager.php similarity index 81% rename from src/Whip_MessagesManager.php rename to src/MessagesManager.php index a257582..939c7ac 100644 --- a/src/Whip_MessagesManager.php +++ b/src/MessagesManager.php @@ -2,16 +2,16 @@ namespace Yoast\WHIPv2; -use Yoast\WHIPv2\Interfaces\Whip_Message; -use Yoast\WHIPv2\Messages\Whip_NullMessage; +use Yoast\WHIPv2\Interfaces\Message; +use Yoast\WHIPv2\Messages\NullMessage; /** * Manages messages using a global to prevent duplicate messages. */ -class Whip_MessagesManager { +class MessagesManager { /** - * Whip_MessagesManager constructor. + * MessagesManager constructor. */ public function __construct() { if ( ! \array_key_exists( 'whip_messages', $GLOBALS ) ) { @@ -22,11 +22,11 @@ public function __construct() { /** * Adds a message to the Messages Manager. * - * @param Whip_Message $message The message to add. + * @param Message $message The message to add. * * @return void */ - public function addMessage( Whip_Message $message ) { + public function addMessage( Message $message ) { $whipVersion = require __DIR__ . '/Configs/version.php'; $GLOBALS['whip_messages'][ $whipVersion ] = $message; @@ -62,11 +62,11 @@ public function deleteMessages() { /** * Gets the latest message. * - * @return Whip_Message The message. Returns a NullMessage if none is found. + * @return Message The message. Returns a NullMessage if none is found. */ public function getLatestMessage() { if ( ! $this->hasMessages() ) { - return new Whip_NullMessage(); + return new NullMessage(); } $messages = $this->sortByVersion( $this->listMessages() ); diff --git a/src/Presenters/Whip_WPMessagePresenter.php b/src/Presenters/WPMessagePresenter.php similarity index 69% rename from src/Presenters/Whip_WPMessagePresenter.php rename to src/Presenters/WPMessagePresenter.php index dedd8a7..aa071f6 100644 --- a/src/Presenters/Whip_WPMessagePresenter.php +++ b/src/Presenters/WPMessagePresenter.php @@ -2,15 +2,17 @@ namespace Yoast\WHIPv2\Presenters; -use Yoast\WHIPv2\Interfaces\Whip_Message; -use Yoast\WHIPv2\Interfaces\Whip_MessagePresenter; -use Yoast\WHIPv2\Whip_MessageDismisser; -use Yoast\WHIPv2\Whip_WPMessageDismissListener; +use Yoast\WHIPv2\Interfaces\Message; +use Yoast\WHIPv2\Interfaces\MessagePresenter; +use Yoast\WHIPv2\MessageDismisser; +use Yoast\WHIPv2\WPMessageDismissListener; /** * A message presenter to show a WordPress notice. + * + * @phpcs:disable Yoast.NamingConventions.ObjectNameDepth.MaxExceeded -- Sniff does not count acronyms correctly. */ -class Whip_WPMessagePresenter implements Whip_MessagePresenter { +class WPMessagePresenter implements MessagePresenter { /** * The string to show to dismiss the message. @@ -22,25 +24,25 @@ class Whip_WPMessagePresenter implements Whip_MessagePresenter { /** * The message to be displayed. * - * @var Whip_Message + * @var Message */ private $message; /** * Dismisser object. * - * @var Whip_MessageDismisser + * @var MessageDismisser */ private $dismisser; /** - * Whip_WPMessagePresenter constructor. + * WPMessagePresenter constructor. * - * @param Whip_Message $message The message to use in the presenter. - * @param Whip_MessageDismisser $dismisser Dismisser object. - * @param string $dismissMessage The copy to show to dismiss the message. + * @param Message $message The message to use in the presenter. + * @param MessageDismisser $dismisser Dismisser object. + * @param string $dismissMessage The copy to show to dismiss the message. */ - public function __construct( Whip_Message $message, Whip_MessageDismisser $dismisser, $dismissMessage ) { + public function __construct( Message $message, MessageDismisser $dismisser, $dismissMessage ) { $this->message = $message; $this->dismisser = $dismisser; $this->dismissMessage = $dismissMessage; @@ -63,7 +65,7 @@ public function registerHooks() { * @return void */ public function renderMessage() { - $dismissListener = new Whip_WPMessageDismissListener( $this->dismisser ); + $dismissListener = new WPMessageDismissListener( $this->dismisser ); $dismissListener->listen(); if ( $this->dismisser->isDismissed() ) { diff --git a/src/Whip_RequirementsChecker.php b/src/RequirementsChecker.php similarity index 72% rename from src/Whip_RequirementsChecker.php rename to src/RequirementsChecker.php index 4982780..73f491b 100644 --- a/src/Whip_RequirementsChecker.php +++ b/src/RequirementsChecker.php @@ -2,16 +2,16 @@ namespace Yoast\WHIPv2; -use Yoast\WHIPv2\Exceptions\Whip_InvalidType; -use Yoast\WHIPv2\Interfaces\Whip_Message; -use Yoast\WHIPv2\Interfaces\Whip_Requirement; -use Yoast\WHIPv2\Messages\Whip_InvalidVersionRequirementMessage; -use Yoast\WHIPv2\Messages\Whip_UpgradePhpMessage; +use Yoast\WHIPv2\Exceptions\InvalidType; +use Yoast\WHIPv2\Interfaces\Message; +use Yoast\WHIPv2\Interfaces\Requirement; +use Yoast\WHIPv2\Messages\InvalidVersionRequirementMessage; +use Yoast\WHIPv2\Messages\UpgradePhpMessage; /** * Main controller class to require a certain version of software. */ -class Whip_RequirementsChecker { +class RequirementsChecker { /** * Requirements the environment should comply with. @@ -23,14 +23,14 @@ class Whip_RequirementsChecker { /** * The configuration to check. * - * @var Whip_Configuration + * @var Configuration */ private $configuration; /** * Message Manager. * - * @var Whip_MessagesManager + * @var MessagesManager */ private $messageManager; @@ -42,28 +42,28 @@ class Whip_RequirementsChecker { private $textdomain; /** - * Whip_RequirementsChecker constructor. + * RequirementsChecker constructor. * * @param array $configuration The configuration to check. * @param string $textdomain The text domain to use for translations. * - * @throws Whip_InvalidType When the $configuration parameter is not of the expected type. + * @throws InvalidType When the $configuration parameter is not of the expected type. */ public function __construct( $configuration = array(), $textdomain = 'default' ) { $this->requirements = array(); - $this->configuration = new Whip_Configuration( $configuration ); - $this->messageManager = new Whip_MessagesManager(); + $this->configuration = new Configuration( $configuration ); + $this->messageManager = new MessagesManager(); $this->textdomain = $textdomain; } /** * Adds a requirement to the list of requirements if it doesn't already exist. * - * @param Whip_Requirement $requirement The requirement to add. + * @param Requirement $requirement The requirement to add. * * @return void */ - public function addRequirement( Whip_Requirement $requirement ) { + public function addRequirement( Requirement $requirement ) { // Only allow unique entries to ensure we're not checking specific combinations multiple times. if ( $this->requirementExistsForComponent( $requirement->component() ) ) { return; @@ -110,11 +110,11 @@ public function requirementExistsForComponent( $component ) { /** * Determines whether a requirement has been fulfilled. * - * @param Whip_Requirement $requirement The requirement to check. + * @param Requirement $requirement The requirement to check. * * @return bool Whether or not the requirement is fulfilled. */ - private function requirementIsFulfilled( Whip_Requirement $requirement ) { + private function requirementIsFulfilled( Requirement $requirement ) { $availableVersion = $this->configuration->configuredVersion( $requirement ); $requiredVersion = $requirement->version(); @@ -146,17 +146,17 @@ public function check() { /** * Adds a message to the message manager for requirements that cannot be fulfilled. * - * @param Whip_Requirement $requirement The requirement that cannot be fulfilled. + * @param Requirement $requirement The requirement that cannot be fulfilled. * * @return void */ - private function addMissingRequirementMessage( Whip_Requirement $requirement ) { + private function addMissingRequirementMessage( Requirement $requirement ) { switch ( $requirement->component() ) { case 'php': - $this->messageManager->addMessage( new Whip_UpgradePhpMessage( $this->textdomain ) ); + $this->messageManager->addMessage( new UpgradePhpMessage( $this->textdomain ) ); break; default: - $this->messageManager->addMessage( new Whip_InvalidVersionRequirementMessage( $requirement, $this->configuration->configuredVersion( $requirement ) ) ); + $this->messageManager->addMessage( new InvalidVersionRequirementMessage( $requirement, $this->configuration->configuredVersion( $requirement ) ) ); break; } } @@ -173,7 +173,7 @@ public function hasMessages() { /** * Gets the most recent message from the message manager. * - * @return Whip_Message The latest message. + * @return Message The latest message. */ public function getMostRecentMessage() { return $this->messageManager->getLatestMessage(); diff --git a/src/Whip_VersionRequirement.php b/src/VersionRequirement.php similarity index 66% rename from src/Whip_VersionRequirement.php rename to src/VersionRequirement.php index ae25f8b..f29c641 100644 --- a/src/Whip_VersionRequirement.php +++ b/src/VersionRequirement.php @@ -2,16 +2,16 @@ namespace Yoast\WHIPv2; -use Yoast\WHIPv2\Exceptions\Whip_EmptyProperty; -use Yoast\WHIPv2\Exceptions\Whip_InvalidOperatorType; -use Yoast\WHIPv2\Exceptions\Whip_InvalidType; -use Yoast\WHIPv2\Exceptions\Whip_InvalidVersionComparisonString; -use Yoast\WHIPv2\Interfaces\Whip_Requirement; +use Yoast\WHIPv2\Exceptions\EmptyProperty; +use Yoast\WHIPv2\Exceptions\InvalidOperatorType; +use Yoast\WHIPv2\Exceptions\InvalidType; +use Yoast\WHIPv2\Exceptions\InvalidVersionComparisonString; +use Yoast\WHIPv2\Interfaces\Requirement; /** * A value object containing a version requirement for a component version. */ -class Whip_VersionRequirement implements Whip_Requirement { +class VersionRequirement implements Requirement { /** * The component name. @@ -35,7 +35,7 @@ class Whip_VersionRequirement implements Whip_Requirement { private $operator; /** - * Whip_Requirement constructor. + * Requirement constructor. * * @param string $component The component name. * @param string $version The component version. @@ -82,9 +82,9 @@ public function operator() { * @param string $component The component for this version requirement. * @param string $comparisonString The comparison string for this version requirement. * - * @return Whip_VersionRequirement The parsed version requirement. + * @return VersionRequirement The parsed version requirement. * - * @throws Whip_InvalidVersionComparisonString When an invalid version comparison string is passed. + * @throws InvalidVersionComparisonString When an invalid version comparison string is passed. */ public static function fromCompareString( $component, $comparisonString ) { @@ -98,13 +98,13 @@ public static function fromCompareString( $component, $comparisonString ) { `x'; if ( ! \preg_match( $matcher, $comparisonString, $match ) ) { - throw new Whip_InvalidVersionComparisonString( $comparisonString ); + throw new InvalidVersionComparisonString( $comparisonString ); } $version = $match[2]; $operator = $match[1]; - return new Whip_VersionRequirement( $component, $version, $operator ); + return new VersionRequirement( $component, $version, $operator ); } /** @@ -116,38 +116,38 @@ public static function fromCompareString( $component, $comparisonString ) { * * @return void * - * @throws Whip_EmptyProperty When any of the parameters is empty. - * @throws Whip_InvalidOperatorType When the $operator parameter is invalid. - * @throws Whip_InvalidType When any of the parameters is not of the expected type. + * @throws EmptyProperty When any of the parameters is empty. + * @throws InvalidOperatorType When the $operator parameter is invalid. + * @throws InvalidType When any of the parameters is not of the expected type. */ private function validateParameters( $component, $version, $operator ) { if ( empty( $component ) ) { - throw new Whip_EmptyProperty( 'Component' ); + throw new EmptyProperty( 'Component' ); } if ( ! \is_string( $component ) ) { - throw new Whip_InvalidType( 'Component', $component, 'string' ); + throw new InvalidType( 'Component', $component, 'string' ); } if ( empty( $version ) ) { - throw new Whip_EmptyProperty( 'Version' ); + throw new EmptyProperty( 'Version' ); } if ( ! \is_string( $version ) ) { - throw new Whip_InvalidType( 'Version', $version, 'string' ); + throw new InvalidType( 'Version', $version, 'string' ); } if ( empty( $operator ) ) { - throw new Whip_EmptyProperty( 'Operator' ); + throw new EmptyProperty( 'Operator' ); } if ( ! \is_string( $operator ) ) { - throw new Whip_InvalidType( 'Operator', $operator, 'string' ); + throw new InvalidType( 'Operator', $operator, 'string' ); } $validOperators = array( '=', '==', '===', '<', '>', '<=', '>=' ); if ( ! \in_array( $operator, $validOperators, true ) ) { - throw new Whip_InvalidOperatorType( $operator, $validOperators ); + throw new InvalidOperatorType( $operator, $validOperators ); } } } diff --git a/src/Whip_WPDismissOption.php b/src/WPDismissOption.php similarity index 78% rename from src/Whip_WPDismissOption.php rename to src/WPDismissOption.php index 10a4dc5..aecd9df 100644 --- a/src/Whip_WPDismissOption.php +++ b/src/WPDismissOption.php @@ -2,12 +2,14 @@ namespace Yoast\WHIPv2; -use Yoast\WHIPv2\Interfaces\Whip_DismissStorage; +use Yoast\WHIPv2\Interfaces\DismissStorage; /** * Represents the WordPress option for saving the dismissed messages. + * + * @phpcs:disable Yoast.NamingConventions.ObjectNameDepth.MaxExceeded -- Sniff does not count acronyms correctly. */ -class Whip_WPDismissOption implements Whip_DismissStorage { +class WPDismissOption implements DismissStorage { /** * WordPress option name. diff --git a/src/Whip_WPMessageDismissListener.php b/src/WPMessageDismissListener.php similarity index 79% rename from src/Whip_WPMessageDismissListener.php rename to src/WPMessageDismissListener.php index ae3236a..b3d0bda 100644 --- a/src/Whip_WPMessageDismissListener.php +++ b/src/WPMessageDismissListener.php @@ -2,12 +2,14 @@ namespace Yoast\WHIPv2; -use Yoast\WHIPv2\Interfaces\Whip_Listener; +use Yoast\WHIPv2\Interfaces\Listener; /** * Listener for dismissing a message. + * + * @phpcs:disable Yoast.NamingConventions.ObjectNameDepth.MaxExceeded -- Sniff does not count acronyms correctly. */ -class Whip_WPMessageDismissListener implements Whip_Listener { +class WPMessageDismissListener implements Listener { /** * The name of the dismiss action expected to be passed via $_GET. @@ -19,16 +21,16 @@ class Whip_WPMessageDismissListener implements Whip_Listener { /** * The object for dismissing a message. * - * @var Whip_MessageDismisser + * @var MessageDismisser */ protected $dismisser; /** * Sets the dismisser attribute. * - * @param Whip_MessageDismisser $dismisser The object for dismissing a message. + * @param MessageDismisser $dismisser The object for dismissing a message. */ - public function __construct( Whip_MessageDismisser $dismisser ) { + public function __construct( MessageDismisser $dismisser ) { $this->dismisser = $dismisser; } diff --git a/tests/Unit/BasicMessageTest.php b/tests/Unit/BasicMessageTest.php index b8be6fd..96ef778 100644 --- a/tests/Unit/BasicMessageTest.php +++ b/tests/Unit/BasicMessageTest.php @@ -2,7 +2,7 @@ namespace Yoast\WHIP\Tests\Unit; -use Yoast\WHIPv2\Messages\Whip_BasicMessage; +use Yoast\WHIPv2\Messages\BasicMessage; /** * Message Unit tests. @@ -10,14 +10,14 @@ final class BasicMessageTest extends TestCase { /** - * Tests if Whip_BasicMessage correctly handles a string for its body argument. + * Tests if BasicMessage correctly handles a string for its body argument. * - * @covers \Yoast\WHIPv2\Messages\Whip_BasicMessage::body + * @covers \Yoast\WHIPv2\Messages\BasicMessage::body * * @return void */ public function testMessageHasBody() { - $message = new Whip_BasicMessage( 'This is a message' ); + $message = new BasicMessage( 'This is a message' ); $this->assertNotEmpty( $message->body() ); } @@ -25,26 +25,26 @@ public function testMessageHasBody() { /** * Tests if an Exception is correctly thrown when an empty string is passed as argument. * - * @covers \Yoast\WHIPv2\Messages\Whip_BasicMessage::validateParameters + * @covers \Yoast\WHIPv2\Messages\BasicMessage::validateParameters * * @return void */ public function testMessageCannotBeEmpty() { - $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\Whip_EmptyProperty', 'Message body cannot be empty.' ); + $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\EmptyProperty', 'Message body cannot be empty.' ); - new Whip_BasicMessage( '' ); + new BasicMessage( '' ); } /** * Tests if an Exception is correctly thrown when an invalid type is passed as argument. * - * @covers \Yoast\WHIPv2\Messages\Whip_BasicMessage::validateParameters + * @covers \Yoast\WHIPv2\Messages\BasicMessage::validateParameters * * @return void */ public function testMessageMustBeString() { - $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\Whip_InvalidType', 'Message body should be of type string. Found integer.' ); + $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\InvalidType', 'Message body should be of type string. Found integer.' ); - new Whip_BasicMessage( 123 ); + new BasicMessage( 123 ); } } diff --git a/tests/Unit/ConfigurationTest.php b/tests/Unit/ConfigurationTest.php index 8bfe07f..2f81818 100644 --- a/tests/Unit/ConfigurationTest.php +++ b/tests/Unit/ConfigurationTest.php @@ -2,7 +2,7 @@ namespace Yoast\WHIP\Tests\Unit; -use Yoast\WHIPv2\Whip_Configuration; +use Yoast\WHIPv2\Configuration; /** * Configuration unit tests. @@ -10,28 +10,28 @@ final class ConfigurationTest extends TestCase { /** - * Tests the creation of a Whip_Configuration with invalid input. + * Tests the creation of a Configuration with invalid input. * - * @covers \Yoast\WHIPv2\Whip_Configuration::__construct + * @covers \Yoast\WHIPv2\Configuration::__construct * * @return void */ public function testItThrowsAnErrorIfAFaultyConfigurationIsPassed() { - $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\Whip_InvalidType', 'Configuration should be of type array. Found string.' ); + $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\InvalidType', 'Configuration should be of type array. Found string.' ); - new Whip_Configuration( 'Invalid configuration' ); + new Configuration( 'Invalid configuration' ); } /** - * Tests if Whip_Configuration correctly returns -1 when passed an unknown requirement. + * Tests if Configuration correctly returns -1 when passed an unknown requirement. * - * @covers \Yoast\WHIPv2\Whip_Configuration::configuredVersion + * @covers \Yoast\WHIPv2\Configuration::configuredVersion * * @return void */ public function testItReturnsANegativeNumberIfRequirementCannotBeFound() { - $configuration = new Whip_Configuration( array( 'php' => '5.6' ) ); - $requirement = $this->getMockBuilder( '\Yoast\WHIPv2\Interfaces\Whip_Requirement' ) + $configuration = new Configuration( array( 'php' => '5.6' ) ); + $requirement = $this->getMockBuilder( '\Yoast\WHIPv2\Interfaces\Requirement' ) ->setMethods( array( 'component', 'version', 'operator' ) ) ->getMock(); @@ -44,15 +44,15 @@ public function testItReturnsANegativeNumberIfRequirementCannotBeFound() { } /** - * Tests if Whip_Configuration correctly returns the version number when passed a valid requirement. + * Tests if Configuration correctly returns the version number when passed a valid requirement. * - * @covers \Yoast\WHIPv2\Whip_Configuration::configuredVersion + * @covers \Yoast\WHIPv2\Configuration::configuredVersion * * @return void */ public function testItReturnsAnEntryIfRequirementIsFound() { - $configuration = new Whip_Configuration( array( 'php' => '5.6' ) ); - $requirement = $this->getMockBuilder( '\Yoast\WHIPv2\Interfaces\Whip_Requirement' ) + $configuration = new Configuration( array( 'php' => '5.6' ) ); + $requirement = $this->getMockBuilder( '\Yoast\WHIPv2\Interfaces\Requirement' ) ->setMethods( array( 'component', 'version', 'operator' ) ) ->getMock(); @@ -67,13 +67,13 @@ public function testItReturnsAnEntryIfRequirementIsFound() { /** * Tests if hasRequirementConfigures correctly returns true/false when called with valid/invalid values. * - * @covers \Yoast\WHIPv2\Whip_Configuration::hasRequirementConfigured + * @covers \Yoast\WHIPv2\Configuration::hasRequirementConfigured * * @return void */ public function testIfRequirementIsConfigured() { - $configuration = new Whip_Configuration( array( 'php' => '5.6' ) ); - $requirement = $this->getMockBuilder( '\Yoast\WHIPv2\Interfaces\Whip_Requirement' ) + $configuration = new Configuration( array( 'php' => '5.6' ) ); + $requirement = $this->getMockBuilder( '\Yoast\WHIPv2\Interfaces\Requirement' ) ->setMethods( array( 'component', 'version', 'operator' ) ) ->getMock(); @@ -82,7 +82,7 @@ public function testIfRequirementIsConfigured() { ->method( 'component' ) ->will( $this->returnValue( 'php' ) ); - $falseRequirement = $this->getMockBuilder( '\Yoast\WHIPv2\Interfaces\Whip_Requirement' ) + $falseRequirement = $this->getMockBuilder( '\Yoast\WHIPv2\Interfaces\Requirement' ) ->setMethods( array( 'component', 'version', 'operator' ) ) ->getMock(); diff --git a/tests/Unit/Doubles/DismissStorageMock.php b/tests/Unit/Doubles/DismissStorageMock.php index 152a961..b91c627 100644 --- a/tests/Unit/Doubles/DismissStorageMock.php +++ b/tests/Unit/Doubles/DismissStorageMock.php @@ -2,12 +2,12 @@ namespace Yoast\WHIP\Tests\Unit\Doubles; -use Yoast\WHIPv2\Interfaces\Whip_DismissStorage; +use Yoast\WHIPv2\Interfaces\DismissStorage; /** * Test helper. */ -final class DismissStorageMock implements Whip_DismissStorage { +final class DismissStorageMock implements DismissStorage { /** * Holds the dismissed state. diff --git a/tests/Unit/MessageDismisserTest.php b/tests/Unit/MessageDismisserTest.php index 9fbd374..04cf022 100644 --- a/tests/Unit/MessageDismisserTest.php +++ b/tests/Unit/MessageDismisserTest.php @@ -3,7 +3,7 @@ namespace Yoast\WHIP\Tests\Unit; use Yoast\WHIP\Tests\Unit\Doubles\DismissStorageMock; -use Yoast\WHIPv2\Whip_MessageDismisser; +use Yoast\WHIPv2\MessageDismisser; /** * Message Dismisser unit tests. @@ -11,17 +11,17 @@ final class MessageDismisserTest extends TestCase { /** - * Tests if Whip_MessageDismisser correctly updates Whip_DismissStorage. + * Tests if MessageDismisser correctly updates DismissStorage. * - * @covers \Yoast\WHIPv2\Whip_MessageDismisser::__construct - * @covers \Yoast\WHIPv2\Whip_MessageDismisser::dismiss + * @covers \Yoast\WHIPv2\MessageDismisser::__construct + * @covers \Yoast\WHIPv2\MessageDismisser::dismiss * * @return void */ public function testDismiss() { $currentTime = \time(); $storage = new DismissStorageMock(); - $dismisser = new Whip_MessageDismisser( $currentTime, ( \WEEK_IN_SECONDS * 4 ), $storage ); + $dismisser = new MessageDismisser( $currentTime, ( \WEEK_IN_SECONDS * 4 ), $storage ); $this->assertSame( 0, $storage->get() ); @@ -35,8 +35,8 @@ public function testDismiss() { * * @dataProvider versionNumbersProvider * - * @covers \Yoast\WHIPv2\Whip_MessageDismisser::__construct - * @covers \Yoast\WHIPv2\Whip_MessageDismisser::isDismissed + * @covers \Yoast\WHIPv2\MessageDismisser::__construct + * @covers \Yoast\WHIPv2\MessageDismisser::isDismissed * * @param int $savedTime The saved time. * @param int $currentTime The current time. @@ -47,7 +47,7 @@ public function testDismiss() { public function testIsDismissibleWithVersions( $savedTime, $currentTime, $expected ) { $storage = new DismissStorageMock(); $storage->set( $savedTime ); - $dismisser = new Whip_MessageDismisser( $currentTime, ( \WEEK_IN_SECONDS * 4 ), $storage ); + $dismisser = new MessageDismisser( $currentTime, ( \WEEK_IN_SECONDS * 4 ), $storage ); $this->assertSame( $expected, $dismisser->isDismissed() ); } diff --git a/tests/Unit/MessagesManagerTest.php b/tests/Unit/MessagesManagerTest.php index 7c52b0a..3fc7f95 100644 --- a/tests/Unit/MessagesManagerTest.php +++ b/tests/Unit/MessagesManagerTest.php @@ -2,7 +2,7 @@ namespace Yoast\WHIP\Tests\Unit; -use Yoast\WHIPv2\Whip_MessagesManager; +use Yoast\WHIPv2\MessagesManager; /** * Message Manager unit tests. @@ -13,12 +13,12 @@ final class MessagesManagerTest extends TestCase { * Creates a MessagesManager, calls hasMessages and tests if it returns false * without a message, true when given a message. * - * @covers \Yoast\WHIPv2\Whip_MessagesManager::hasMessages + * @covers \Yoast\WHIPv2\MessagesManager::hasMessages * * @return void */ public function testHasMessages() { - $manager = new Whip_MessagesManager(); + $manager = new MessagesManager(); $this->assertFalse( $manager->hasMessages() ); diff --git a/tests/Unit/RequirementsCheckerTest.php b/tests/Unit/RequirementsCheckerTest.php index 08abc23..e51c824 100644 --- a/tests/Unit/RequirementsCheckerTest.php +++ b/tests/Unit/RequirementsCheckerTest.php @@ -5,8 +5,8 @@ use Error; use Exception; use stdClass; -use Yoast\WHIPv2\Whip_RequirementsChecker; -use Yoast\WHIPv2\Whip_VersionRequirement; +use Yoast\WHIPv2\RequirementsChecker; +use Yoast\WHIPv2\VersionRequirement; /** * Requirements checker unit tests. @@ -14,25 +14,25 @@ final class RequirementsCheckerTest extends TestCase { /** - * Tests if Whip_RequirementsChecker is successfully created when given valid arguments. + * Tests if RequirementsChecker is successfully created when given valid arguments. * - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::addRequirement - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::totalRequirements + * @covers \Yoast\WHIPv2\RequirementsChecker::addRequirement + * @covers \Yoast\WHIPv2\RequirementsChecker::totalRequirements * * @return void */ public function testItReceivesAUsableRequirementObject() { - $checker = new Whip_RequirementsChecker(); - $checker->addRequirement( new Whip_VersionRequirement( 'php', '5.2' ) ); + $checker = new RequirementsChecker(); + $checker->addRequirement( new VersionRequirement( 'php', '5.2' ) ); $this->assertTrue( $checker->hasRequirements() ); $this->assertSame( 1, $checker->totalRequirements() ); } /** - * Tests if Whip_RequirementsChecker throws an error when passed an invalid requirement. + * Tests if RequirementsChecker throws an error when passed an invalid requirement. * - * @covers Whip_RequirementsChecker::addRequirement + * @covers RequirementsChecker::addRequirement * @requires PHP 7 * * @return void @@ -44,7 +44,7 @@ public function testItThrowsAnTypeErrorWhenInvalidRequirementIsPassed() { $exceptionCaught = false; - $checker = new Whip_RequirementsChecker(); + $checker = new RequirementsChecker(); try { $checker->addRequirement( new stdClass() ); @@ -56,9 +56,9 @@ public function testItThrowsAnTypeErrorWhenInvalidRequirementIsPassed() { } /** - * Tests if Whip_RequirementsChecker throws an error when passed an invalid requirement. + * Tests if RequirementsChecker throws an error when passed an invalid requirement. * - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::addRequirement + * @covers \Yoast\WHIPv2\RequirementsChecker::addRequirement * * @return void */ @@ -69,7 +69,7 @@ public function testItThrowsAnTypeErrorWhenInvalidRequirementIsPassedInPHP5() { $exceptionCaught = false; - $checker = new Whip_RequirementsChecker(); + $checker = new RequirementsChecker(); try { $checker->addRequirement( new stdClass() ); @@ -81,41 +81,41 @@ public function testItThrowsAnTypeErrorWhenInvalidRequirementIsPassedInPHP5() { } /** - * Tests if Whip_RequirementsChecker only saves unique components. + * Tests if RequirementsChecker only saves unique components. * - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::addRequirement - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::totalRequirements + * @covers \Yoast\WHIPv2\RequirementsChecker::addRequirement + * @covers \Yoast\WHIPv2\RequirementsChecker::totalRequirements * * @return void */ public function testItOnlyContainsUniqueComponents() { - $checker = new Whip_RequirementsChecker(); + $checker = new RequirementsChecker(); - $checker->addRequirement( new Whip_VersionRequirement( 'php', '5.2' ) ); - $checker->addRequirement( new Whip_VersionRequirement( 'mysql', '5.6' ) ); + $checker->addRequirement( new VersionRequirement( 'php', '5.2' ) ); + $checker->addRequirement( new VersionRequirement( 'mysql', '5.6' ) ); $this->assertTrue( $checker->hasRequirements() ); $this->assertSame( 2, $checker->totalRequirements() ); - $checker->addRequirement( new Whip_VersionRequirement( 'php', '6' ) ); + $checker->addRequirement( new VersionRequirement( 'php', '6' ) ); $this->assertSame( 2, $checker->totalRequirements() ); } /** - * Tests if Whip_RequirementsChecker::requirementExistsForComponent correctly + * Tests if RequirementsChecker::requirementExistsForComponent correctly * returns true for existing components. * - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::addRequirement - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::requirementExistsForComponent + * @covers \Yoast\WHIPv2\RequirementsChecker::addRequirement + * @covers \Yoast\WHIPv2\RequirementsChecker::requirementExistsForComponent * * @return void */ public function testIfRequirementExists() { - $checker = new Whip_RequirementsChecker(); + $checker = new RequirementsChecker(); - $checker->addRequirement( new Whip_VersionRequirement( 'php', '5.2' ) ); - $checker->addRequirement( new Whip_VersionRequirement( 'mysql', '5.6' ) ); + $checker->addRequirement( new VersionRequirement( 'php', '5.2' ) ); + $checker->addRequirement( new VersionRequirement( 'mysql', '5.6' ) ); $this->assertTrue( $checker->requirementExistsForComponent( 'php' ) ); $this->assertFalse( $checker->requirementExistsForComponent( 'mongodb' ) ); @@ -126,17 +126,17 @@ public function testIfRequirementExists() { * * Verifies that a php upgrade message is created and successfully transferred to a variable. * - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::addRequirement - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::check - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::hasMessages - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::getMostRecentMessage + * @covers \Yoast\WHIPv2\RequirementsChecker::addRequirement + * @covers \Yoast\WHIPv2\RequirementsChecker::check + * @covers \Yoast\WHIPv2\RequirementsChecker::hasMessages + * @covers \Yoast\WHIPv2\RequirementsChecker::getMostRecentMessage * * @return void */ public function testCheckIfPHPRequirementIsNotFulfilled() { - $checker = new Whip_RequirementsChecker( array( 'php' => 4 ) ); + $checker = new RequirementsChecker( array( 'php' => 4 ) ); - $checker->addRequirement( new Whip_VersionRequirement( 'php', '5.6' ) ); + $checker->addRequirement( new VersionRequirement( 'php', '5.6' ) ); $checker->check(); $this->assertTrue( $checker->hasMessages() ); @@ -155,22 +155,22 @@ public function testCheckIfPHPRequirementIsNotFulfilled() { } $this->assertFalse( $checker->hasMessages() ); - $this->assertInstanceOf( '\Yoast\WHIPv2\Messages\Whip_UpgradePhpMessage', $recentMessage ); + $this->assertInstanceOf( '\Yoast\WHIPv2\Messages\UpgradePhpMessage', $recentMessage ); } /** * Tests if there no message when the requirement is fulfilled. * - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::addRequirement - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::check - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::getMostRecentMessage + * @covers \Yoast\WHIPv2\RequirementsChecker::addRequirement + * @covers \Yoast\WHIPv2\RequirementsChecker::check + * @covers \Yoast\WHIPv2\RequirementsChecker::getMostRecentMessage * * @return void */ public function testCheckIfRequirementIsFulfilled() { - $checker = new Whip_RequirementsChecker( array( 'php' => \phpversion() ) ); + $checker = new RequirementsChecker( array( 'php' => \phpversion() ) ); - $checker->addRequirement( new Whip_VersionRequirement( 'php', '5.2' ) ); + $checker->addRequirement( new VersionRequirement( 'php', '5.2' ) ); $checker->check(); $this->assertEmpty( $checker->getMostRecentMessage()->body() ); @@ -181,17 +181,17 @@ public function testCheckIfRequirementIsFulfilled() { * * Verifies that an invalid version message is created and successfully transferred to a variable. * - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::addRequirement - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::check - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::getMostRecentMessage - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::hasMessages + * @covers \Yoast\WHIPv2\RequirementsChecker::addRequirement + * @covers \Yoast\WHIPv2\RequirementsChecker::check + * @covers \Yoast\WHIPv2\RequirementsChecker::getMostRecentMessage + * @covers \Yoast\WHIPv2\RequirementsChecker::hasMessages * * @return void */ public function testCheckIfRequirementIsNotFulfilled() { - $checker = new Whip_RequirementsChecker( array( 'mysql' => 4 ) ); + $checker = new RequirementsChecker( array( 'mysql' => 4 ) ); - $checker->addRequirement( new Whip_VersionRequirement( 'mysql', '5.6' ) ); + $checker->addRequirement( new VersionRequirement( 'mysql', '5.6' ) ); $checker->check(); $this->assertTrue( $checker->hasMessages() ); @@ -201,23 +201,23 @@ public function testCheckIfRequirementIsNotFulfilled() { $this->assertNotEmpty( $recentMessage ); $this->assertFalse( $checker->hasMessages() ); - $this->assertInstanceOf( '\Yoast\WHIPv2\Messages\Whip_InvalidVersionRequirementMessage', $recentMessage ); + $this->assertInstanceOf( '\Yoast\WHIPv2\Messages\InvalidVersionRequirementMessage', $recentMessage ); $this->assertStringStartsWith( 'Invalid version detected', $recentMessage->body() ); } /** * Tests if a specific comparison with a non-default operator is correctly handled. * - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::addRequirement - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::check - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::hasMessages + * @covers \Yoast\WHIPv2\RequirementsChecker::addRequirement + * @covers \Yoast\WHIPv2\RequirementsChecker::check + * @covers \Yoast\WHIPv2\RequirementsChecker::hasMessages * * @return void */ public function testCheckIfRequirementIsFulfilledWithSpecificComparison() { - $checker = new Whip_RequirementsChecker( array( 'php' => 4 ) ); + $checker = new RequirementsChecker( array( 'php' => 4 ) ); - $checker->addRequirement( new Whip_VersionRequirement( 'php', '5.2', '<' ) ); + $checker->addRequirement( new VersionRequirement( 'php', '5.2', '<' ) ); $checker->check(); $this->assertFalse( $checker->hasMessages() ); @@ -226,16 +226,16 @@ public function testCheckIfRequirementIsFulfilledWithSpecificComparison() { /** * Tests if a specific comparison with a non-default operator is correctly handled. * - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::addRequirement - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::check - * @covers \Yoast\WHIPv2\Whip_RequirementsChecker::hasMessages + * @covers \Yoast\WHIPv2\RequirementsChecker::addRequirement + * @covers \Yoast\WHIPv2\RequirementsChecker::check + * @covers \Yoast\WHIPv2\RequirementsChecker::hasMessages * * @return void */ public function testCheckIfRequirementIsNotFulfilledWithSpecificComparison() { - $checker = new Whip_RequirementsChecker( array( 'php' => 4 ) ); + $checker = new RequirementsChecker( array( 'php' => 4 ) ); - $checker->addRequirement( new Whip_VersionRequirement( 'php', '5.2', '>=' ) ); + $checker->addRequirement( new VersionRequirement( 'php', '5.2', '>=' ) ); $checker->check(); $this->assertTrue( $checker->hasMessages() ); diff --git a/tests/Unit/VersionRequirementTest.php b/tests/Unit/VersionRequirementTest.php index 2420c9e..1add33a 100644 --- a/tests/Unit/VersionRequirementTest.php +++ b/tests/Unit/VersionRequirementTest.php @@ -2,7 +2,7 @@ namespace Yoast\WHIP\Tests\Unit; -use Yoast\WHIPv2\Whip_VersionRequirement; +use Yoast\WHIPv2\VersionRequirement; /** * Version requirements unit tests. @@ -10,133 +10,133 @@ final class VersionRequirementTest extends TestCase { /** - * Creates a new Whip_VersionRequirement with component php and version 5.2 and + * Creates a new VersionRequirement with component php and version 5.2 and * tests if this is correctly created. * - * @covers \Yoast\WHIPv2\Whip_VersionRequirement::component - * @covers \Yoast\WHIPv2\Whip_VersionRequirement::version + * @covers \Yoast\WHIPv2\VersionRequirement::component + * @covers \Yoast\WHIPv2\VersionRequirement::version * * @return void */ public function testNameAndVersionAreNotEmpty() { - $requirement = new Whip_VersionRequirement( 'php', '5.2' ); + $requirement = new VersionRequirement( 'php', '5.2' ); $this->assertNotEmpty( $requirement->component() ); $this->assertNotEmpty( $requirement->version() ); } /** - * Tests if an Exception message is correctly thrown when a Whip_VersionRequirement + * Tests if an Exception message is correctly thrown when a VersionRequirement * is created with an empty component. * - * @covers \Yoast\WHIPv2\Whip_VersionRequirement::validateParameters + * @covers \Yoast\WHIPv2\VersionRequirement::validateParameters * * @return void */ public function testComponentCannotBeEmpty() { - $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\Whip_EmptyProperty', 'Component cannot be empty.' ); + $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\EmptyProperty', 'Component cannot be empty.' ); - new Whip_VersionRequirement( '', '5.2' ); + new VersionRequirement( '', '5.2' ); } /** - * Tests if an Exception message is correctly thrown when a Whip_VersionRequirement + * Tests if an Exception message is correctly thrown when a VersionRequirement * is created with an empty version. * - * @covers \Yoast\WHIPv2\Whip_VersionRequirement::validateParameters + * @covers \Yoast\WHIPv2\VersionRequirement::validateParameters * * @return void */ public function testVersionCannotBeEmpty() { - $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\Whip_EmptyProperty', 'Version cannot be empty.' ); + $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\EmptyProperty', 'Version cannot be empty.' ); - new Whip_VersionRequirement( 'php', '' ); + new VersionRequirement( 'php', '' ); } /** - * Tests if an Exception message is correctly thrown when a Whip_VersionRequirement + * Tests if an Exception message is correctly thrown when a VersionRequirement * is created with a false type for a component. * - * @covers \Yoast\WHIPv2\Whip_VersionRequirement::validateParameters + * @covers \Yoast\WHIPv2\VersionRequirement::validateParameters * * @return void */ public function testComponentMustBeString() { - $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\Whip_InvalidType', 'Component should be of type string. Found integer.' ); + $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\InvalidType', 'Component should be of type string. Found integer.' ); - new Whip_VersionRequirement( 123, '5.2' ); + new VersionRequirement( 123, '5.2' ); } /** - * Tests if an Exception message is correctly thrown when a Whip_VersionRequirement + * Tests if an Exception message is correctly thrown when a VersionRequirement * is created with a false type for a version. * - * @covers \Yoast\WHIPv2\Whip_VersionRequirement::validateParameters + * @covers \Yoast\WHIPv2\VersionRequirement::validateParameters * * @return void */ public function testVersionMustBeString() { - $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\Whip_InvalidType', 'Version should be of type string. Found integer.' ); + $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\InvalidType', 'Version should be of type string. Found integer.' ); - new Whip_VersionRequirement( 'php', 123 ); + new VersionRequirement( 'php', 123 ); } /** - * Tests if an Exception message is correctly thrown when a Whip_VersionRequirement + * Tests if an Exception message is correctly thrown when a VersionRequirement * is created with an empty operator. * - * @covers \Yoast\WHIPv2\Whip_VersionRequirement::validateParameters + * @covers \Yoast\WHIPv2\VersionRequirement::validateParameters * * @return void */ public function testOperatorCannotBeEmpty() { - $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\Whip_EmptyProperty', 'Operator cannot be empty.' ); + $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\EmptyProperty', 'Operator cannot be empty.' ); - new Whip_VersionRequirement( 'php', '5.6', '' ); + new VersionRequirement( 'php', '5.6', '' ); } /** - * Tests if an Exception message is correctly thrown when a Whip_VersionRequirement + * Tests if an Exception message is correctly thrown when a VersionRequirement * is created with a false type for an operator. * - * @covers \Yoast\WHIPv2\Whip_VersionRequirement::validateParameters + * @covers \Yoast\WHIPv2\VersionRequirement::validateParameters * * @return void */ public function testOperatorMustBeString() { - $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\Whip_InvalidType', 'Operator should be of type string. Found integer.' ); + $this->expectExceptionHelper( '\Yoast\WHIPv2\Exceptions\InvalidType', 'Operator should be of type string. Found integer.' ); - new Whip_VersionRequirement( 'php', '5.2', 6 ); + new VersionRequirement( 'php', '5.2', 6 ); } /** - * Tests if an Exception message is correctly thrown when a Whip_VersionRequirement + * Tests if an Exception message is correctly thrown when a VersionRequirement * is created with an invalid operator. * - * @covers \Yoast\WHIPv2\Whip_VersionRequirement::validateParameters + * @covers \Yoast\WHIPv2\VersionRequirement::validateParameters * * @return void */ public function testOperatorMustBeValid() { $this->expectExceptionHelper( - '\Yoast\WHIPv2\Exceptions\Whip_InvalidOperatorType', + '\Yoast\WHIPv2\Exceptions\InvalidOperatorType', 'Invalid operator of -> used. Please use one of the following operators: =, ==, ===, <, >, <=, >=' ); - new Whip_VersionRequirement( 'php', '5.2', '->' ); + new VersionRequirement( 'php', '5.2', '->' ); } /** - * Creates a new Whip_VersionRequirement and tests if this is correctly created with its given arguments. + * Creates a new VersionRequirement and tests if this is correctly created with its given arguments. * - * @covers \Yoast\WHIPv2\Whip_VersionRequirement::component - * @covers \Yoast\WHIPv2\Whip_VersionRequirement::version - * @covers \Yoast\WHIPv2\Whip_VersionRequirement::operator + * @covers \Yoast\WHIPv2\VersionRequirement::component + * @covers \Yoast\WHIPv2\VersionRequirement::version + * @covers \Yoast\WHIPv2\VersionRequirement::operator * * @return void */ public function testGettingComponentProperties() { - $requirement = new Whip_VersionRequirement( 'php', '5.6' ); + $requirement = new VersionRequirement( 'php', '5.6' ); $this->assertSame( 'php', $requirement->component() ); $this->assertSame( '5.6', $requirement->version() ); @@ -148,9 +148,9 @@ public function testGettingComponentProperties() { * * @dataProvider dataFromCompareString * - * @covers \Yoast\WHIPv2\Whip_VersionRequirement::component - * @covers \Yoast\WHIPv2\Whip_VersionRequirement::version - * @covers \Yoast\WHIPv2\Whip_VersionRequirement::operator + * @covers \Yoast\WHIPv2\VersionRequirement::component + * @covers \Yoast\WHIPv2\VersionRequirement::version + * @covers \Yoast\WHIPv2\VersionRequirement::operator * * @param string $expectation The expected output string. * @param string $component The component for this version requirement. @@ -159,7 +159,7 @@ public function testGettingComponentProperties() { * @return void */ public function testFromCompareString( $expectation, $component, $compareString ) { - $requirement = Whip_VersionRequirement::fromCompareString( $component, $compareString ); + $requirement = VersionRequirement::fromCompareString( $component, $compareString ); $this->assertSame( $expectation[0], $requirement->component() ); $this->assertSame( $expectation[1], $requirement->version() ); @@ -188,16 +188,16 @@ public static function dataFromCompareString() { * Tests whether fromCompareString() correctly throws an exception when provided * with an invalid comparison string. * - * @covers \Yoast\WHIPv2\Whip_VersionRequirement::fromCompareString + * @covers \Yoast\WHIPv2\VersionRequirement::fromCompareString * * @return void */ public function testFromCompareStringException() { $this->expectExceptionHelper( - '\Yoast\WHIPv2\Exceptions\Whip_InvalidVersionComparisonString', + '\Yoast\WHIPv2\Exceptions\InvalidVersionComparisonString', 'Invalid version comparison string. Example of a valid version comparison string: >=5.3. Passed version comparison string: > 2.3' ); - Whip_VersionRequirement::fromCompareString( 'php', '> 2.3' ); + VersionRequirement::fromCompareString( 'php', '> 2.3' ); } } diff --git a/tests/Unit/WPMessageDismissListenerTest.php b/tests/Unit/WPMessageDismissListenerTest.php index 9873e7a..964d2dc 100644 --- a/tests/Unit/WPMessageDismissListenerTest.php +++ b/tests/Unit/WPMessageDismissListenerTest.php @@ -2,12 +2,12 @@ namespace Yoast\WHIP\Tests\Unit; -use Yoast\WHIPv2\Whip_WPMessageDismissListener; +use Yoast\WHIPv2\WPMessageDismissListener; /** * Message Dismiss Listener unit tests. * - * @coversDefaultClass Whip_WPMessageDismissListener + * @coversDefaultClass WPMessageDismissListener * * @phpcs:disable Yoast.NamingConventions.ObjectNameDepth.MaxExceeded -- Acronym throws the count off. */ @@ -16,7 +16,7 @@ final class WPMessageDismissListenerTest extends TestCase { /** * Tests the listen method. * - * @covers \Yoast\WHIPv2\Whip_WPMessageDismissListener::listen + * @covers \Yoast\WHIPv2\WPMessageDismissListener::listen * * @dataProvider listenProvider * @@ -29,11 +29,11 @@ final class WPMessageDismissListenerTest extends TestCase { * @return void */ public function testDismiss( $action, $nonce, $verifyNonceTimes, $isCorrectNonce, $dismissTimes ) { - $dismisser = $this->getMockBuilder( '\Yoast\WHIPv2\Whip_MessageDismisser' ) + $dismisser = $this->getMockBuilder( '\Yoast\WHIPv2\MessageDismisser' ) ->disableOriginalConstructor() ->getMock(); - $instance = new Whip_WPMessageDismissListener( $dismisser ); + $instance = new WPMessageDismissListener( $dismisser ); $_GET['action'] = $action; $_GET['nonce'] = $nonce; @@ -57,7 +57,7 @@ public function testDismiss( $action, $nonce, $verifyNonceTimes, $isCorrectNonce public static function listenProvider() { return array( 'correct action and nonce' => array( - 'action' => Whip_WPMessageDismissListener::ACTION_NAME, + 'action' => WPMessageDismissListener::ACTION_NAME, 'nonce' => 'the_right_nonce', 'verifyNonceTimes' => 1, 'isCorrectNonce' => true, @@ -71,7 +71,7 @@ public static function listenProvider() { 'dismissTimes' => 0, ), 'correct action incorrect nonce' => array( - 'action' => Whip_WPMessageDismissListener::ACTION_NAME, + 'action' => WPMessageDismissListener::ACTION_NAME, 'nonce' => 'wrong_nonce', 'verifyNonceTimes' => 1, 'isCorrectNonce' => false,