Added tests for Preview Parameters.

Author: colinmurphy

plugins/hwp-previews/src/Plugin.php

@@ -34,6 +34,8 @@ public static function instance(): self {
 
 		/**
 		 * Fire off init action.
+		 *
+		 * @param \HWP\Previews\Plugin $instance the instance of the plugin class.
 		 */
 		do_action( 'hwp_previews_init', self::$instance );
 

plugins/hwp-previews/src/Preview/Parameter/Contracts/Preview_Parameter_Interface.php

@@ -4,13 +4,12 @@
 
 namespace HWP\Previews\Preview\Parameter;
 
-use HWP\Previews\Preview\Parameter\Contracts\Preview_Parameter_Interface;
 use WP_Post;
 
 /**
  * Class Callable_Preview_Parameter.
  */
-class Preview_Parameter implements Preview_Parameter_Interface {
+class Preview_Parameter {
 	/**
 	 * The name of the parameter.
 	 *

plugins/hwp-previews/src/Preview/Parameter/Preview_Parameter.php

@@ -4,7 +4,7 @@
 
 namespace HWP\Previews\Preview\Parameter;
 
-use HWP\Previews\Preview\Parameter\Contracts\Preview_Parameter_Interface;
+use HWP\Previews\Preview\Parameter\Preview_Parameter;
 use WP_Post;
 
 /**
@@ -23,7 +23,7 @@ class Preview_Parameter_Registry {
 	/**
 	 * Registered parameters.
 	 *
-	 * @var array<\HWP\Previews\Preview\Parameter\Contracts\Preview_Parameter_Interface>
+	 * @var array<\HWP\Previews\Preview\Parameter\Preview_Parameter>
 	 */
 	private array $parameters = [];
 
@@ -72,9 +72,9 @@ public static function add_initial_parameters( self $instance ): self {
 	/**
 	 * Register a parameter.
 	 *
-	 * @param \HWP\Previews\Preview\Parameter\Contracts\Preview_Parameter_Interface $parameter The parameter object.
+	 * @param \HWP\Previews\Preview\Parameter\Preview_Parameter $parameter The parameter object.
 	 */
-	public function register( Preview_Parameter_Interface $parameter ): self {
+	public function register( Preview_Parameter $parameter ): self {
 		$this->parameters[ $parameter->get_name() ] = $parameter;
 
 		return $this;
@@ -93,15 +93,6 @@ public function unregister( string $name ): self {
 		return $this;
 	}
 
-	/**
-	 * Get all registered parameters.
-	 *
-	 * @return array<string, \HWP\Previews\Preview\Parameter\Contracts\Preview_Parameter_Interface>
-	 */
-	public function get_all(): array {
-		return $this->parameters;
-	}
-
 	/**
 	 * Get all registered parameters as an array of their names and descriptions.
 	 *
@@ -121,7 +112,7 @@ public function get_descriptions(): array {
 	 *
 	 * @param string $name The parameter name.
 	 */
-	public function get( string $name ): ?Preview_Parameter_Interface {
+	public function get( string $name ): ?Preview_Parameter {
 		return $this->parameters[ $name ] ?? null;
 	}
 }

plugins/hwp-previews/src/Preview/Parameter/Preview_Parameter_Registry.php

@@ -4,7 +4,7 @@
 
 namespace HWP\Previews\Preview\Url;
 
-use HWP\Previews\Preview\Parameter\Contracts\Preview_Parameter_Interface;
+use HWP\Previews\Preview\Parameter\Preview_Parameter;
 use HWP\Previews\Preview\Parameter\Preview_Parameter_Registry;
 use WP_Post;
 
@@ -63,7 +63,7 @@ public function resolve( WP_Post $post, string $url ): ?string {
 	 */
 	public function resolve_token( string $key, WP_Post $post ): string {
 		$parameter = $this->parameter_registry->get( $key );
-		if ( ! $parameter instanceof Preview_Parameter_Interface ) {
+		if ( ! $parameter instanceof Preview_Parameter ) {
 			return self::PLACEHOLDER_NOT_FOUND;
 		}
 

plugins/hwp-previews/src/Preview/Url/Preview_Url_Resolver_Service.php

@@ -35,9 +35,6 @@ public function test_init_returns_singleton_instance(): void {
 		$this->assertSame( $instance1, $instance2, 'init() should return the same singleton instance' );
 	}
 
-//	public function test_is_faust_enabled_asserts_false() {
-//
-//	}
 
 	public function test_is_faust_enabled_asserts_true() {
 

plugins/hwp-previews/tests/wpunit/Integration/FaustIntegrationTest.php

@@ -0,0 +1,50 @@
+<?php
+
+declare( strict_types=1 );
+
+namespace HWP\Previews\Tests\Unit\Preview\Parameter;
+
+use HWP\Previews\Preview\Parameter\Preview_Parameter;
+use HWP\Previews\Preview\Parameter\Preview_Parameter_Registry;
+use lucatume\WPBrowser\TestCase\WPTestCase;
+use ReflectionClass;
+
+class Preview_Parameter_Registry_Test extends WPTestCase {
+
+
+	public function test_instance_creates_and_sets_up_preview_parameter_registry_when_not_set() {
+		$reflection       = new ReflectionClass( Preview_Parameter_Registry::class );
+		$instanceProperty = $reflection->getProperty( 'instance' );
+		$instanceProperty->setAccessible( true );
+		$instanceProperty->setValue( null );
+
+		$this->assertNull( $instanceProperty->getValue() );
+		$instance = Preview_Parameter_Registry::get_instance();
+
+		$this->assertInstanceOf( Preview_Parameter_Registry::class, $instanceProperty->getValue() );
+		$this->assertSame( $instance, $instanceProperty->getValue(), 'Preview_Parameter_Registry::get_instance() should set the static instance property' );
+	}
+
+	public function test_registering_new_parameter() {
+		$registry = Preview_Parameter_Registry::get_instance();
+		$registry->register(
+			new Preview_Parameter( 'test_param', static fn() => 'test_value', 'Test parameter' )
+		);
+
+		$parameter = $registry->get( 'test_param' );
+		$this->assertInstanceOf( Preview_Parameter::class, $parameter );
+		$this->assertSame( 'test_param', $parameter->get_name() );
+		$this->assertSame( 'test_value', $parameter->get_value( new \WP_Post( (object) [ 'ID' => 1 ] ) ) );
+
+		$registry->unregister( 'test_param' );
+		$this->assertNull( $registry->get( 'test_param' ) );
+	}
+
+
+	public function test_get_all_descriptions() {
+		$registry = Preview_Parameter_Registry::get_instance();
+		$descriptions = $registry->get_descriptions();
+		$this->assertNotEmpty( $descriptions );
+	}
+
+}

plugins/hwp-previews/tests/wpunit/Preview/Parameter/PreviewParameterRegsitryTest.php

@@ -0,0 +1,31 @@
+<?php
+
+declare( strict_types=1 );
+
+namespace HWP\Previews\Tests\Unit\Preview\Parameter;
+
+use HWP\Previews\Preview\Parameter\Preview_Parameter;
+use lucatume\WPBrowser\TestCase\WPTestCase;
+use WP_Post;
+
+class Preview_Parameter_Test extends WPTestCase {
+
+
+	public function test_create_instance_check_name_description() {
+		$preview = new Preview_Parameter('ID', static fn( WP_Post $post ) => (string) $post->ID, 'Post ID.');
+		$this->assertEquals( 'Post ID.', $preview->get_description() );
+		$this->assertEquals( 'ID', $preview->get_name() );
+	}
+
+	public function test_create_instance_get_value() {
+		$preview = new Preview_Parameter('status', static fn( WP_Post $post ) => $post->post_status, 'The post status.');
+
+		$post = WPTestCase::factory()->post->create_and_get( [
+			'post_title' => 'Test Post',
+			'post_status' => 'publish',
+			'post_content' => 'This is a test post.',
+		] );
+
+		$this->assertEquals($post->post_status, $preview->get_value($post));
+	}
+}

plugins/hwp-previews/tests/wpunit/Preview/Parameter/PreviewParameterTest.php

@@ -19,4 +19,6 @@ public function test_class_instance(): void {
 
 		$this->assertInstanceOf(Preview_Url_Resolver_Service::class, $service);
 	}
+
+	// @TODO add more tests for resolve method
 }