Add unit testing factory for Co Authors Plus and Byline Manager

.gitattributes

@@ -9,6 +9,7 @@
 /phpstan-baseline.neon export-ignore
 /phpstan.neon export-ignore
 /phpunit.xml export-ignore
+/phpunit-9.xml export-ignore
 /tests export-ignore
 
 #

.github/workflows/tests.yml

@@ -17,7 +17,7 @@ jobs:
     if: github.event.pull_request.draft == false
     timeout-minutes: 10
     runs-on: ubuntu-latest
-    name: "Lint Tests"
+    name: "Composer and Monorepo Validate"
     steps:
       - uses: actions/checkout@v4
 
@@ -30,7 +30,7 @@ jobs:
           php-version: '8.4'
           skip-services: 'true'
           skip-wordpress-install: 'true'
-          test-command: 'composer monorepo-validate'
+          test-command: 'composer validate --strict && composer monorepo-validate'
   lint-tests:
     if: github.event.pull_request.draft == false
     timeout-minutes: 10
@@ -77,7 +77,8 @@ jobs:
           install-command: composer update --${{ matrix.dependencies }} --prefer-dist --no-interaction --no-progress
           php-version: '${{ matrix.php }}'
           skip-wordpress-install: 'true'
-          test-command: 'composer phpunit'
+          # Only run PHPUnit for the lowest dependencies.
+          test-command: ${{ matrix.dependencies == 'prefer-lowest' && 'composer phpunit-9' || 'composer phpunit' }}
           wordpress-host: 'false'
           wordpress-multisite: '${{ matrix.multisite }}'
           wordpress-version: '${{ matrix.wordpress }}'

CHANGELOG.md

@@ -9,6 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Added a unit testing factory for Byline Manager profiles and Co-Authors-Plus guest authors.
+
+### Changed
+
+- Passing a `\Stringable` as a model attribute will now be cast to a string
+  before being set on the model.
 - Added `with_debug()` and `with_multisite()` methods to the installation manager.
 
 ### Fixed
@@ -96,9 +102,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   by setting the `MANTLE_EXPERIMENTAL_TESTING_USE_HOME_URL_HOST` environment
   variable.
 
-	Once enabled, the home URL will be used as the base URL for testing rather
-	the hard-coded `WP_TESTS_DOMAIN`. It will also infer the HTTPS status from
-	the home URL.
+  Once enabled, the home URL will be used as the base URL for testing rather
+  the hard-coded `WP_TESTS_DOMAIN`. It will also infer the HTTPS status from
+  the home URL.
 - Added `with_option()`/`with_home_url()`/`with_site_url()` methods to the installation manager.
 - Add a `without_local_object_cache()` method to prevent the `object-cache.php` drop-in from being loaded locally.
 - Added a better `dump()` method to the response object when testing HTTP
@@ -111,7 +117,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Upgraded to Symfony 7.0 packages.
 - Disable `spatie/once`'s cache if found during unit testing.
 - Ensure that the `QUERY_STRING` server variable is set when testing HTTP
-	requests.
+  requests.
 
 ### Fixed
 

composer.json

@@ -148,15 +148,14 @@
         "phpcs": "phpcs --standard=./phpcs.xml .",
         "phpstan": "phpstan --memory-limit=1536M",
         "phpunit:multisite": "WP_MULTISITE=1 phpunit",
+        "phpunit-9": "phpunit --configuration=phpunit-9.xml",
         "phpunit": "phpunit",
         "rector:fix": "rector process",
         "rector": "rector process --dry-run",
         "release:patch": "monorepo-builder release patch --ansi",
         "release": "monorepo-builder release --ansi",
         "test": [
-            "@phpcs",
-            "@phpstan",
-            "@rector",
+            "@lint",
             "@phpunit"
         ]
     },

phpstan.neon

@@ -18,6 +18,7 @@ parameters:
 			identifier: require.fileNotFound
 		-
 			identifier: requireOnce.fileNotFound
+		# Will be fixed in PHPStan soon.
 		-
 			identifier: unset.possiblyHookedProperty
 		-

phpunit-9.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<phpunit
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	bootstrap="tests/bootstrap.php"
+	backupGlobals="false"
+	colors="true"
+	xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.6/phpunit.xsd"
+	convertErrorsToExceptions="true"
+  convertNoticesToExceptions="true"
+  convertWarningsToExceptions="true"
+	convertDeprecationsToExceptions="true"
+>
+	<testsuites>
+		<testsuite name="mantle-framework">
+			<directory suffix="Test.php">./tests/</directory>
+		</testsuite>
+	</testsuites>
+</phpunit>

phpunit.xml

@@ -4,10 +4,12 @@
 	bootstrap="tests/bootstrap.php"
 	backupGlobals="false"
 	colors="true"
-	xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
+	xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.5/phpunit.xsd"
 	displayDetailsOnTestsThatTriggerDeprecations="true"
 	displayDetailsOnTestsThatTriggerWarnings="true"
 	failOnNotice="true"
+	failOnPhpunitDeprecation="true"
+	failOnWarning="true"
 	failOnDeprecation="true"
 >
 	<testsuites>

src/mantle/database/factory/class-factory-container.php

@@ -38,6 +38,20 @@ class Factory_Container {
 	 */
 	public Blog_Factory $blog;
 
+	/**
+	 * Byline Manager Factory
+	 *
+	 * @var Plugins\Byline_Manager_Factory<\Mantle\Database\Model\Post, \Byline_Manager\Models\Profile, \Byline_Manager\Models\Profile>
+	 */
+	public Plugins\Byline_Manager_Factory $byline_manager_profile;
+
+	/**
+	 * Co Author Guest Author Factory
+	 *
+	 * @var Plugins\Co_Authors_Plus_Factory<\Mantle\Database\Model\Post, \stdClass, \stdClass>
+	 */
+	public Plugins\Co_Authors_Plus_Factory $cap_guest_author;
+
 	/**
 	 * Category Factory
 	 *
@@ -115,6 +129,10 @@ public function __construct( Container $container ) {
 			$this->blog    = $container->make( Blog_Factory::class );
 			$this->network = $container->make( Network_Factory::class );
 		}
+
+		// Plugin-specific factories.
+		$this->byline_manager_profile = $container->make( Plugins\Byline_Manager_Factory::class );
+		$this->cap_guest_author       = $container->make( Plugins\Co_Authors_Plus_Factory::class );
 	}
 
 	/**

src/mantle/database/factory/class-factory.php

@@ -129,9 +129,8 @@ public function as_objects() {
 	 * Create a new factory instance with middleware.
 	 *
 	 * @param callable(array $args, \Closure $next): mixed $middleware Middleware to run the factory through.
-	 * @return static
 	 */
-	public function with_middleware( callable $middleware ) {
+	public function with_middleware( callable $middleware ): static {
 		return tap(
 			clone $this,
 			fn ( Factory $factory ) => $factory->middleware = $this->middleware->merge( $middleware ),
@@ -189,9 +188,8 @@ public function get_model(): string {
 	 * middleware but supports returning an array of attributes vs a closure.
 	 *
 	 * @param (callable(array<string, mixed>): array<string, mixed>|array<string, mixed>) $state The state transformation.
-	 * @return static
 	 */
-	public function state( array|callable $state ) {
+	public function state( array|callable $state ): static {
 		return $this->with_middleware(
 			function ( array $args, Closure $next ) use ( $state ) {
 				$args = array_merge(

src/mantle/database/factory/class-post-factory.php

@@ -28,6 +28,8 @@
  * @extends Factory<TModel, TObject, TReturnValue>
  */
 class Post_Factory extends Factory {
+	use Concerns\With_Byline_Manager_Profiles;
+	use Concerns\With_Guest_Authors;
 	use Concerns\With_Meta;
 
 	/**
@@ -92,7 +94,11 @@ public function with_terms( ...$terms ): static {
 		$terms = collect( $terms )->all();
 
 		return $this->with_middleware(
-			fn ( array $args, Closure $next ) => $next( $args )->set_terms( $terms, append: $this->append_terms, create: $this->create_terms ),
+			fn ( array $args, Closure $next ) => $next( $args )->set_terms(
+				terms: $terms,
+				append: $this->append_terms,
+				create: $this->create_terms,
+			),
 		);
 	}
 

src/mantle/database/factory/class-user-factory.php

@@ -10,6 +10,7 @@
 use Mantle\Database\Model\User;
 
 use function Mantle\Support\Helpers\get_user_object;
+use function Mantle\Support\Helpers\stringable;
 
 /**
  * User Factory
@@ -36,12 +37,18 @@ class User_Factory extends Factory {
 	 * @return array<string, mixed>
 	 */
 	public function definition(): array {
+		$first_name = $this->faker->firstName();
+		$last_name  = $this->faker->lastName();
+
 		return [
 			'description' => $this->faker->sentence(),
+			'first_name'  => $first_name,
+			'last_name'   => $last_name,
 			'role'        => 'subscriber',
 			'user_email'  => $this->faker->email(),
-			'user_login'  => $this->faker->userName(),
+			'user_login'  => stringable( "{$first_name} {$last_name}" )->slugify(),
 			'user_pass'   => 'password',
+			'user_url'    => substr( $this->faker->url(), 0, 100 ),
 		];
 	}
 
@@ -54,4 +61,13 @@ public function definition(): array {
 	public function get_object_by_id( int $object_id ) {
 		return $this->as_models ? $this->model::find( $object_id ) : get_user_object( $object_id );
 	}
+
+	/**
+	 * Create a user with a specific role.
+	 *
+	 * @param string $role The role to assign to the user.
+	 */
+	public function with_role( string $role ): static {
+		return $this->state( [ 'role' => $role ] );
+	}
 }

src/mantle/database/factory/concerns/trait-with-byline-manager-profiles.php

@@ -0,0 +1,91 @@
+<?php
+/**
+ * With_Byline_Manager_Profiles trait file
+ *
+ * @package Mantle
+ */
+
+namespace Mantle\Database\Factory\Concerns;
+
+use Byline_Manager\Models\Profile;
+use Byline_Manager\Utils;
+use Closure;
+use Mantle\Database\Factory\Plugins\Byline_Manager_Factory;
+use WP_User;
+
+use function Mantle\Support\Helpers\collect;
+
+/**
+ * Manage Byline Manager authors on posts.
+ *
+ * @phpstan-type BylineManagerEntry array{type: string, attrs: array<string, mixed>}
+ *
+ * @mixin \Mantle\Database\Factory\Post_Factory
+ */
+trait With_Byline_Manager_Profiles {
+	/**
+	 * Add a bylines to a post with Byline Manager.
+	 *
+	 * @throws \RuntimeException If Byline Manager is not installed or initialized.
+	 *
+	 * @param string|int|Profile|WP_User ...$authors The profile ID/object, WP_User object, or text string.
+	 */
+	public function with_byline_manager_authors( ...$authors ): static {
+		if ( ! class_exists( Profile::class ) ) {
+			throw new \RuntimeException( 'Byline Manager is not installed.' );
+		}
+
+		return $this->with_middleware( function ( array $args, Closure $next ) use ( $authors ) {
+			/** @var \Mantle\Database\Model\Post $profile */
+			$profile = $next( $args );
+
+			Utils::set_post_byline(
+				$profile->id(),
+				[
+					'byline_entries' => collect( $authors )
+						->map( $this->resolve_byline_manager_entry( ... ) )
+						->filter()
+						->values()
+						->all(),
+				],
+			);
+
+			return $profile;
+		} );
+	}
+
+	/**
+	 * Resolve the author to the underlying term ID for the Profile.
+	 *
+	 * @param string|int|Profile|WP_User $item The profile ID/object, WP_User object, or text string.
+	 * @return array
+	 * @phpstan-return BylineManagerEntry
+	 */
+	protected function resolve_byline_manager_entry( string|int|WP_User|Profile $item ): ?array {
+		if ( is_string( $item ) ) {
+			return [
+				'type' => 'text',
+				'atts' => [
+					'text' => $item,
+				],
+			];
+		}
+
+		if ( is_int( $item ) || $item instanceof Profile ) {
+			$profile = $item instanceof Profile ? $item : Profile::get_by_post( $item );
+		} elseif ( $item instanceof WP_User ) {
+			$profile = Byline_Manager_Factory::get_byline_manager_profile_by_user_id( $item->ID, create: true );
+		}
+
+		if ( empty( $profile ) ) {
+			return null;
+		}
+
+		return [
+			'type' => 'byline_id',
+			'atts' => [
+				'byline_id' => $profile->byline_id,
+			],
+		];
+	}
+}