Refactored checking if classic editor is available. Added tests.

Author: colinmurphy

plugins/hwp-previews/src/Admin/Settings_Page.php

@@ -8,8 +8,7 @@
 use HWP\Previews\Admin\Settings\Menu\Menu_Page;
 use HWP\Previews\Admin\Settings\Settings_Form_Manager;
 use HWP\Previews\Preview\Parameter\Preview_Parameter_Registry;
-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\Post\Post_Preview_Service;
 
 class Settings_Page {
 	/**
@@ -23,9 +22,11 @@ class Settings_Page {
 	protected Preview_Parameter_Registry $parameters;
 
 	/**
-	 * @var \HWP\Previews\Preview\Post\Type\Contracts\Post_Types_Config_Interface The post types available for previews.
+	 * Post-preview service to get post types and statuses for the settings page.
+	 *
+	 * @var \HWP\Previews\Preview\Post\Post_Preview_Service
 	 */
-	protected Post_Types_Config_Interface $types_config;
+	protected Post_Preview_Service $post_preview_service;
 
 	/**
 	 * The instance of the plugin.
@@ -40,8 +41,8 @@ class Settings_Page {
 	 * Initializes the settings page, registers settings fields, and loads scripts and styles.
 	 */
 	public function __construct() {
-		$this->parameters   = Preview_Parameter_Registry::get_instance();
-		$this->types_config = Post_Types_Config_Registry::get_post_type_config();
+		$this->parameters           = Preview_Parameter_Registry::get_instance();
+		$this->post_preview_service = new Post_Preview_Service();
 
 		$this->register_settings_pages();
 		$this->register_settings_fields();
@@ -72,9 +73,9 @@ public static function init(): Settings_Page {
 	public function register_settings_pages(): void {
 		add_action( 'admin_menu', function (): void {
 
-			// Note: We didn't initalize in the constructor because we need to ensure
-			// the post types are registered before we can use them.
-			$post_types = $this->types_config->get_public_post_types();
+			// Note: We didn't initalise in the constructor because we need to ensure
+			// the post-types are registered before we can use them.
+			$post_types = $this->post_preview_service->get_post_types();
 
 			$page = new Menu_Page(
 				__( 'HWP Previews Settings', 'hwp-previews' ),
@@ -100,7 +101,7 @@ public function register_settings_pages(): void {
 	public function register_settings_fields(): void {
 		add_action( 'admin_init', function (): void {
 			$settings_manager = new Settings_Form_Manager(
-				$this->types_config->get_public_post_types(),
+				$this->post_preview_service->get_post_types(),
 				new Settings_Field_Collection()
 			);
 			$settings_manager->render_form();

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

@@ -6,24 +6,16 @@
 
 use HWP\Previews\Admin\Settings\Fields\Settings_Field_Collection;
 use HWP\Previews\Preview\Parameter\Preview_Parameter_Registry;
+use HWP\Previews\Preview\Post\Post_Editor_Service;
 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\Type\Contracts\Post_Types_Config_Interface;
-use HWP\Previews\Preview\Post\Type\Post_Types_Config_Registry;
 use HWP\Previews\Preview\Template\Template_Resolver_Service;
 use HWP\Previews\Preview\Url\Preview_Url_Resolver_Service;
 use WP_Post;
 use WP_REST_Response;
 
 class Preview_Hooks {
-	/**
-	 * Post types configuration.
-	 *
-	 * @var \HWP\Previews\Preview\Post\Type\Contracts\Post_Types_Config_Interface
-	 */
-	protected Post_Types_Config_Interface $types_config;
-
 	/**
 	 * Post-settings service that provides access to post-settings.
 	 *
@@ -51,14 +43,6 @@ class Preview_Hooks {
 	 * Initializes the settings helper, post types and statuses configurations, and the preview link service.
 	 */
 	public function __construct() {
-
-		// @TODO - Refactor to use a factory or service locator pattern and analyze what is is actually needed.
-
-		$this->types_config = apply_filters(
-			'hwp_previews_hooks_post_type_config',
-			Post_Types_Config_Registry::get_post_type_config()
-		);
-
 		$this->post_preview_service  = new Post_Preview_Service();
 		$this->post_settings_service = new Post_Settings_Service();
 	}
@@ -72,11 +56,15 @@ public function setup(): void {
 		add_filter( 'page_attributes_dropdown_pages_args', [ $this, 'enable_post_statuses_as_parent' ], 10, 1 );
 		add_filter( 'quick_edit_dropdown_pages_args', [ $this, 'enable_post_statuses_as_parent' ], 10, 1 );
 
-		foreach ( $this->types_config->get_post_types() as $post_type ) {
-			if ( ! $this->types_config->gutenberg_editor_enabled( $post_type ) ) {
+		$post_editor_service = new Post_Editor_Service();
+		$post_types          = $this->post_preview_service->get_post_types();
+
+		// Enable post-statuses as parent for the post-types specified in the post-types config.
+		foreach ( $post_types as $post_type => $label ) {
+			if ( ! $post_editor_service->gutenberg_editor_enabled( $post_type ) ) {
 				continue;
 			}
-			// @TODO - Add unit tests for this filter.
+
 			add_filter( 'rest_' . $post_type . '_query', [ $this, 'enable_post_statuses_as_parent' ], 10, 1 );
 		}
 
@@ -91,13 +79,13 @@ public function setup(): void {
 		 * Hack Function that changes the preview link for draft articles,
 		 * this must be removed when properly fixed https://github.com/WordPress/gutenberg/issues/13998.
 		 */
-		foreach ( $this->types_config->get_public_post_types() as $key => $label ) {
-			add_filter( 'rest_prepare_' . $key, [ $this, 'filter_rest_prepare_link' ], 10, 2 );
+		foreach ( $post_types as $post_type => $label ) {
+			add_filter( 'rest_prepare_' . $post_type, [ $this, 'filter_rest_prepare_link' ], 10, 2 );
 		}
 	}
 
 	/**
-	 * Enable post statuses as parent for the post types specified in the post types config.
+	 * Enable post-statuses as parent for the post types specified in the post types config.
 	 *
 	 * @param array<mixed> $args The arguments for the dropdown pages.
 	 *

plugins/hwp-previews/src/Preview/Post/Post_Editor_Service.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HWP\Previews\Preview\Post;
+
+use WP_Post_Type;
+
+class Post_Editor_Service {
+	/**
+	 * Check if the post-type supports Gutenberg editor and if the classic editor is not being forced.
+	 *
+	 * @param string $post_type Post Type slug.
+	 */
+	public function gutenberg_editor_enabled(string $post_type): bool {
+		$post_type_object = get_post_type_object( $post_type );
+		if ( ! $post_type_object instanceof WP_Post_Type ) {
+			return false;
+		}
+
+		return $this->is_gutenberg_supported( $post_type_object ) &&
+				! $this->is_classic_editor_forced( $post_type );
+	}
+
+	/**
+	 * Checks if the post type supports Gutenberg.
+	 *
+	 * @param \WP_Post_Type $post_type Post Type object.
+	 */
+	public function is_gutenberg_supported( WP_Post_Type $post_type ): bool {
+
+		if (empty($post_type->show_in_rest)) {
+			return false;
+		}
+
+		if (!post_type_supports($post_type->name, 'editor')) {
+			return false;
+		}
+
+		return $post_type->show_in_rest;
+	}
+
+	/**
+	 * Checks if the post type is supported by Classic Editor.
+	 */
+	public function is_classic_editor_forced(string $post_type): bool {
+		if (
+			! function_exists( 'is_plugin_active' ) ||
+			! is_plugin_active( 'classic-editor/classic-editor.php' )
+		) {
+			return false;
+		}
+
+		// If this post type is listed in Classic Editor settings, Gutenberg is disabled.
+		$settings = (array) get_option( 'classic-editor-settings', [] );
+
+		return ! empty( $settings['post_types'] ) &&
+				is_array( $settings['post_types'] ) &&
+				in_array( $post_type, $settings['post_types'], true );
+	}
+}