Refactoring URL resolver functionality.

Author: colinmurphy

plugins/hwp-previews/src/Hooks/Preview_Hooks.php

@@ -5,18 +5,17 @@
 namespace HWP\Previews\Hooks;
 
 use HWP\Previews\Preview\Helper\Settings_Helper;
-use HWP\Previews\Preview\Link\Preview_Link_Placeholder_Resolver;
-use HWP\Previews\Preview\Link\Preview_Link_Service;
 use HWP\Previews\Preview\Parameter\Preview_Parameter_Registry;
 use HWP\Previews\Preview\Post\Parent\Post_Parent_Manager;
+use HWP\Previews\Preview\Post\Post_Preview_Service;
+use HWP\Previews\Preview\Post\Post_Settings_Service;
+use HWP\Previews\Preview\Post\Post_Type_Service;
 use HWP\Previews\Preview\Post\Status\Contracts\Post_Statuses_Config_Interface;
 use HWP\Previews\Preview\Post\Status\Post_Statuses_Config;
 use HWP\Previews\Preview\Post\Type\Contracts\Post_Types_Config_Interface;
 use HWP\Previews\Preview\Post\Type\Post_Types_Config_Registry;
-use HWP\Previews\Preview\Service\Post_Preview_Service;
-use HWP\Previews\Preview\Service\Post_Settings_Service;
-use HWP\Previews\Preview\Service\Post_Type_Service;
-use HWP\Previews\Preview\Service\Template_Resolver_Service;
+use HWP\Previews\Preview\Template\Template_Resolver_Service;
+use HWP\Previews\Preview\Url\Preview_Url_Resolver_Service;
 use WP_Post;
 use WP_REST_Response;
 
@@ -43,11 +42,11 @@ class Preview_Hooks {
 	protected Post_Statuses_Config_Interface $statuses_config;
 
 	/**
-	 * Preview link service class that handles the generation of preview links.
+	 * Post-settings service that provides access to post-settings.
 	 *
-	 * @var \HWP\Previews\Preview\Link\Preview_Link_Service
+	 * @var \HWP\Previews\Preview\Post\Post_Preview_Service
 	 */
-	protected Preview_Link_Service $link_service;
+	protected Post_Preview_Service $post_preview_service;
 
 	/**
 	 * The instance of the Preview_Hooks class.
@@ -56,6 +55,13 @@ class Preview_Hooks {
 	 */
 	protected static ?Preview_Hooks $instance = null;
 
+	/**
+	 * Post-settings service that provides access to post-settings.
+	 *
+	 * @var \HWP\Previews\Preview\Post\Post_Settings_Service
+	 */
+	private Post_Settings_Service $post_settings_service;
+
 	/**
 	 * Constructor for the Preview_Hooks class.
 	 *
@@ -78,15 +84,9 @@ public function __construct() {
 			( new Post_Statuses_Config() )->set_post_statuses( $this->get_post_statuses() )
 		);
 
-		// Initialize the preview link service.
-		$this->link_service = apply_filters(
-			'hwp_previews_hooks_preview_link_service',
-			new Preview_Link_Service(
-				$this->types_config,
-				$this->statuses_config,
-				new Preview_Link_Placeholder_Resolver( Preview_Parameter_Registry::get_instance() )
-			)
-		);
+
+		$this->post_preview_service  = new Post_Preview_Service();
+		$this->post_settings_service = new Post_Settings_Service();
 	}
 
 	/**
@@ -154,12 +154,12 @@ public function get_post_statuses(): array {
 	 */
 	public function enable_post_statuses_as_parent( array $args ): array {
 
-		$post_parent_manager = new Post_Parent_Manager( $this->types_config, $this->statuses_config );
-
 		if ( empty( $args['post_type'] ) ) {
 			return $args;
 		}
 
+		$post_parent_manager = new Post_Parent_Manager( $this->types_config, $this->statuses_config );
+
 		$post_type = (string) $args['post_type'];
 
 		// Check if the correspondent setting is enabled.
@@ -180,7 +180,13 @@ public function enable_post_statuses_as_parent( array $args ): array {
 	 */
 	public function filter_rest_prepare_link( WP_REST_Response $response, WP_Post $post ): WP_REST_Response {
 
-		if ( $this->settings_helper->in_iframe( $post->post_type ) ) {
+		$post_type_service = new Post_Type_Service( $post, $this->post_preview_service, $this->post_settings_service );
+
+		if ( ! $post_type_service->is_allowed_for_previews() ) {
+			return $response;
+		}
+
+		if ( $post_type_service->is_iframe() ) {
 			return $response;
 		}
 
@@ -202,27 +208,28 @@ public function add_iframe_preview_template( string $template ): string {
 		}
 
 		$post = get_post();
-		if ( ! is_object( $post ) || ! ( $post instanceof WP_Post ) ) {
+		if ( ! ( $post instanceof WP_Post ) ) {
 			return $template;
 		}
 
-		// @TODO - Move main classes into properties
-		$post_preview_service  = new Post_Preview_Service();
-		$post_settings_service = new Post_Settings_Service();
-		$post_type_service     = new Post_Type_Service( $post, $post_preview_service, $post_settings_service );
+		$post_type_service = new Post_Type_Service( $post, $this->post_preview_service, $this->post_settings_service );
 
-		if ( ! $post_type_service->is_allowed_for_previews() || ! $post_type_service->is_iframe() ) {
+		if (
+			! $post_type_service->is_allowed_for_previews() ||
+			! $post_type_service->is_iframe()
+		) {
 			return $template;
 		}
 
 		$template_resolver = new Template_Resolver_Service();
 		$iframe_template   = $template_resolver->get_iframe_template();
-		if ( empty( $iframe_template ) ) {
+		$url               = self::generate_preview_url( $post );
+
+		if ( empty( $iframe_template ) || empty( $url ) ) {
 			return $template;
 		}
 
-		// @TODO - Refactor this as part of URL generation refactor.
-		$template_resolver->set_query_variable( self::generate_preview_url( $post ) );
+		$template_resolver->set_query_variable( $url );
 
 		return $iframe_template;
 	}
@@ -234,10 +241,14 @@ public function add_iframe_preview_template( string $template ): string {
 	 */
 	public function update_preview_post_link( string $preview_link, WP_Post $post ): string {
 
-		// @TODO - Need to do more testing and add e2e tests for this filter.
+		$post_type_service = new Post_Type_Service( $post, $this->post_preview_service, $this->post_settings_service );
+
+		if ( ! $post_type_service->is_allowed_for_previews() ) {
+			return $preview_link;
+		}
 
-		// If iframe option is enabled, we need to resolve preview on the template redirect level.
-		if ( $this->settings_helper->in_iframe( $post->post_type ) ) {
+		// If the iframe option is enabled, we need to resolve preview on the template redirect level.
+		if ( $post_type_service->is_iframe() ) {
 			return $preview_link;
 		}
 
@@ -258,14 +269,24 @@ public function update_preview_post_link( string $preview_link, WP_Post $post ):
 	 */
 	public function generate_preview_url( WP_Post $post ): string {
 
-		// Check if the correspondent setting is enabled.
-		$url = $this->settings_helper->url_template( $post->post_type );
+		$post_type_service = new Post_Type_Service( $post, $this->post_preview_service, $this->post_settings_service );
 
+		if ( ! $post_type_service->is_allowed_for_previews() ) {
+			return '';
+		}
+
+		$url = $post_type_service->get_preview_url();
+		if ( empty( $url ) ) {
+			return '';
+		}
+
+		$service = new Preview_Url_Resolver_Service( Preview_Parameter_Registry::get_instance() );
+		$url     = $service->resolve( $post, $url );
 		if ( empty( $url ) ) {
 			return '';
 		}
 
-		return $this->link_service->generate_preview_post_link( $url, $post );
+		return $url;
 	}
 
 	/**

plugins/hwp-previews/src/Preview/Helper/Settings_Group.php

@@ -135,23 +135,6 @@ public function get_post_type_boolean_value( string $name, string $post_type, bo
 		return $default_value;
 	}
 
-	/**
-	 *  Gets a string value for a specific setting in a post type.
-	 *
-	 * @param string $name The setting name.
-	 * @param string $post_type The post type slug.
-	 * @param string $default_value The default value to return if the setting is not found.
-	 */
-	public function get_post_type_string_value( string $name, string $post_type, string $default_value = '' ): string {
-		$settings = $this->get_cached_settings();
-		$type     = $this->settings_config[ $name ] ?? null;
-		if ( 'string' === $type && isset( $settings[ $post_type ][ $name ] ) ) {
-			return (string) $settings[ $post_type ][ $name ];
-		}
-
-		return $default_value;
-	}
-
 	/**
 	 * Gets the option key for the settings group.
 	 */

plugins/hwp-previews/src/Preview/Helper/Settings_Helper.php

@@ -80,30 +80,4 @@ public function post_statuses_as_parent( string $post_type, bool $default_value
 
 		return $this->settings_group->get_post_type_boolean_value( $key, $post_type, $default_value );
 	}
-
-	/**
-	 * Show In iframe value for the given post type.
-	 *
-	 * @param string $post_type The post type to get the setting for.
-	 * @param bool   $default_value The default value to return if the setting is not set.
-	 */
-	public function in_iframe( string $post_type, bool $default_value = false ): bool {
-
-		// @TODO remove as part of Post_Type_Service refactor.
-		$key = $this->settings_group->get_settings_key_in_iframe();
-
-		return $this->settings_group->get_post_type_boolean_value( $key, $post_type, $default_value );
-	}
-
-	/**
-	 * URL template setting value for the given post type.
-	 *
-	 * @param string $post_type The post type to get the setting for.
-	 * @param string $default_value The default value to return if the setting is not set.
-	 */
-	public function url_template( string $post_type, string $default_value = '' ): string {
-		$key = $this->settings_group->get_settings_key_preview_url();
-
-		return $this->settings_group->get_post_type_string_value( $key, $post_type, $default_value );
-	}
 }

plugins/hwp-previews/src/Preview/Link/Preview_Link_Service.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace HWP\Previews\Preview\Service;
+namespace HWP\Previews\Preview\Post;
 
 class Post_Preview_Service {
 	/**

…Preview/Service/Post_Preview_Service.php …rc/Preview/Post/Post_Preview_Service.phpplugins/hwp-previews/src/Preview/Service/Post_Preview_Service.php renamed to plugins/hwp-previews/src/Preview/Post/Post_Preview_Service.php plugins/hwp-previews/src/Preview/Service/Post_Preview_Service.php renamed to plugins/hwp-previews/src/Preview/Post/Post_Preview_Service.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace HWP\Previews\Preview\Service;
+namespace HWP\Previews\Preview\Post;
 
 class Post_Settings_Service {
 	/**