Refactor settings to make it easier to test.

Author: colinmurphy

plugins/hwp-previews/ACTIONS_AND_FILTERS.md

@@ -9,9 +9,9 @@
 ## PHP Filters
 
 - `hwp_previews_register_parameters` - Allows modification of the URL parameters used for previews for the class `Preview_Parameter_Registry`
-- `hwp_previews_filter_post_type_setting` - Filter or modify what post types appear in the settings UI
 - `hwp_previews_template_path` - To use our own template for iframe previews
 - `hwp_previews_core` - Register or unregister URL parameters, and adjust types/statuses
+- `hwp_previews_filter_available_post_types` - Filter to modify the available post types for Previews.
 - `hwp_previews_settings_group_option_key` - Filter to modify the settings group option key. Default is HWP_PREVIEWS_SETTINGS_KEY
 - `hwp_previews_settings_group_settings_group` - Filter to modify the settings group name. Default is HWP_PREVIEWS_SETTINGS_GROUP
 - `hwp_previews_settings_group_settings_config` - Filter to modify the settings array. See `Settings_Group`
@@ -21,7 +21,7 @@
 - `hwp_previews_hooks_post_status_config` - Filter for post status config service for the Hook class
 - `hwp_previews_hooks_preview_link_service` - Filter for preview link service for the Hook class
 - `hwp_previews_hooks_post_statuses` - Filter for post statuses for previews for the Hook Class
-
+- `hwp_previews_settings_fields` - Allows a user to register, modify, or remove settings fields for the settings page
 
 ## Usage Examples
 

plugins/hwp-previews/activation.php

@@ -5,7 +5,7 @@
  * @package HWP\Previews
  */
 
-declare( strict_types = 1 );
+declare(strict_types=1);
 
 /**
  * Runs when the plugin is activated.

plugins/hwp-previews/bin/run-qa.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+# Running PHP Code Quality Analysis locally
+composer run check-cs
+composer run phpstan
+composer run php:psalm

plugins/hwp-previews/codeception.dist.yml

@@ -94,9 +94,7 @@ modules:
             adminEmail: "%WORDPRESS_ADMIN_EMAIL%"
             title: 'Test'
             plugins:
-                - wp-graphql/wp-graphql.php
                 - hwp-previews/hwp-previews.php
             activatePlugins:
-                - wp-graphql/wp-graphql.php
                 - hwp-previews/hwp-previews.php
             configFile: 'tests/_data/config.php'

plugins/hwp-previews/composer.json

@@ -101,6 +101,7 @@
 	"autoload-dev": {
 		"psr-4": {
 			"HWP\\Previews\\Unit\\": "tests/unit/",
+			"HWP\\Previews\\Functional\\": "tests/functional/",
 			"HWP\\Previews\\Integration\\": "tests/integration/",
 			"HWP\\Previews\\PHPStan\\": "phpstan/",
 			"HWPStandard\\": "phpcs/HWPStandard"
@@ -130,8 +131,6 @@
 		"php:psalm:info": "psalm --show-info=true",
 		"php:psalm:fix": "psalm --alter"
 	},
-	"scripts-descriptions": {
-	},
 	"support": {
 		"docs": "https://github.com/wpengine/hwptoolkit/tree/main/docs",
 		"email": "[email protected]",

plugins/hwp-previews/hwp-previews.php

@@ -48,25 +48,41 @@
 
 /**
  * Define plugin constants.
+ *
+ * phpcs:disable Generic.Metrics.CyclomaticComplexity.TooHigh
+ * phpcs:disable SlevomatCodingStandard.Complexity.Cognitive.ComplexityTooHigh
  */
 function hwp_previews_constants(): void {
-	$constants = [
-		'HWP_PREVIEWS_VERSION'        => '0.0.1',
-		'HWP_PREVIEWS_PLUGIN_DIR'     => plugin_dir_path( __FILE__ ),
-		'HWP_PREVIEWS_PLUGIN_URL'     => plugin_dir_url( __FILE__ ),
-		'HWP_PREVIEWS_PLUGIN_FILE'    => __FILE__,
-		'HWP_PREVIEWS_AUTOLOAD'       => true,
-		'HWP_PREVIEWS_SETTINGS_GROUP' => 'hwp_previews_settings_group',
-		'HWP_PREVIEWS_SETTINGS_KEY'   => 'hwp_previews_settings',
-		'HWP_PREVIEWS_TEXT_DOMAIN'    => 'hwp-previews',
-	];
-
-	foreach ( $constants as $name => $value ) {
-		if ( ! defined( $name ) ) {
-			// phpcs:disable WordPress.NamingConventions.PrefixAllGlobals.VariableConstantNameFound
-			define( $name, $value );
-			// phpcs:enable WordPress.NamingConventions.PrefixAllGlobals.VariableConstantNameFound
-		}
+	if ( ! defined( 'HWP_PREVIEWS_VERSION' ) ) {
+		define( 'HWP_PREVIEWS_VERSION', '0.0.1' );
+	}
+
+	if ( ! defined( 'HWP_PREVIEWS_PLUGIN_DIR' ) ) {
+		define( 'HWP_PREVIEWS_PLUGIN_DIR', plugin_dir_path( __FILE__ ) );
+	}
+
+	if ( ! defined( 'HWP_PREVIEWS_PLUGIN_URL' ) ) {
+		define( 'HWP_PREVIEWS_PLUGIN_URL', plugin_dir_url( __FILE__ ) );
+	}
+
+	if ( ! defined( 'HWP_PREVIEWS_PLUGIN_FILE' ) ) {
+		define( 'HWP_PREVIEWS_PLUGIN_FILE', __FILE__ );
+	}
+
+	if ( ! defined( 'HWP_PREVIEWS_AUTOLOAD' ) ) {
+		define( 'HWP_PREVIEWS_AUTOLOAD', true );
+	}
+
+	if ( ! defined( 'HWP_PREVIEWS_SETTINGS_GROUP' ) ) {
+		define( 'HWP_PREVIEWS_SETTINGS_GROUP', 'hwp_previews_settings_group' );
+	}
+
+	if ( ! defined( 'HWP_PREVIEWS_SETTINGS_KEY' ) ) {
+		define( 'HWP_PREVIEWS_SETTINGS_KEY', 'hwp_previews_settings' );
+	}
+
+	if ( ! defined( 'HWP_PREVIEWS_TEXT_DOMAIN' ) ) {
+		define( 'HWP_PREVIEWS_TEXT_DOMAIN', 'hwp-previews' );
 	}
 
 	// Plugin Template Directory.
@@ -75,6 +91,9 @@ function hwp_previews_constants(): void {
 	}
 }
 
+// phpcs:enable Generic.Metrics.CyclomaticComplexity.TooHigh
+// phpcs:enable SlevomatCodingStandard.Complexity.Cognitive.ComplexityTooHigh
+
 /**
  * Initializes plugin.
  */

plugins/hwp-previews/phpcs.xml

@@ -7,6 +7,8 @@
 
 	<description>Coding standards for the HWP Previews plugin</description>
 	<file>./hwp-previews.php</file>
+	<file>./activation.php</file>
+	<file>./deactivation.php</file>
 	<file>./vendor/autoload.php</file>
 	<file>./src/</file>
 	<exclude-pattern>*/languages/*</exclude-pattern>