Update/patternception saving bug tests

wp-modules/app/js/src/utils/test/convertToSlug.ts → wp-modules/app/js/src/utils/test/toKebabCase.ts

@@ -1,6 +1,6 @@
-import convertToSlug from '../convertToSlug';
+import toKebabCase from '../toKebabCase';
 
-describe( 'convertToSlug', () => {
+describe( 'toKebabCase', () => {
 	it.each( [
 		[ undefined, '' ],
 		[ '', '' ],
@@ -14,7 +14,7 @@ describe( 'convertToSlug', () => {
 		[ 'with&&&***non.,.word$$characters', 'with-non-word-characters' ],
 		[ 'EndingInApostrophe!', 'endinginapostrophe' ],
 		[ 'With 🥁Emojis🏇', 'with-emojis' ],
-	] )( 'should convert to the slug', ( toConvert, expected ) => {
-		expect( convertToSlug( toConvert ) ).toEqual( expected );
+	] )( 'should convert to kebab case', ( toConvert, expected ) => {
+		expect( toKebabCase( toConvert ) ).toEqual( expected );
 	} );
 } );

wp-modules/app/js/src/utils/convertToSlug.ts → wp-modules/app/js/src/utils/toKebabCase.ts

@@ -1,5 +1,5 @@
-/** Converts a string to a slug. */
-export default function convertToSlug( toConvert = '' ) {
+/** Converts a string to kebab-case. */
+export default function toKebabCase( toConvert = '' ) {
 	return toConvert
 		.replace( /[_\W]+(?=\w+)/g, '-' )
 		.replace( /[^-\w]/g, '' )

wp-modules/editor/js/src/blocks/pattern-block/PatternEdit.tsx

@@ -74,6 +74,9 @@ export default function PatternEdit( {
 		className: pattern ? 'alignfull' : 'is-layout-constrained',
 	} );
 	const { currentName } = useSavedPostData();
+	const patternSlug = Object.values( patternManager.patterns ).find(
+		( ownPattern ) => ownPattern.name === currentName
+	)?.slug;
 
 	return (
 		<>
@@ -90,7 +93,7 @@ export default function PatternEdit( {
 						patternCategories={ patternManager.patternCategories }
 						patterns={ filterOutPatterns(
 							patternManager.patterns,
-							currentName
+							patternSlug
 						) }
 						siteUrl={ patternManager.siteUrl }
 					/>

wp-modules/editor/js/src/components/SidebarPanels/TitlePanel.tsx

@@ -5,7 +5,7 @@ import { PluginDocumentSettingPanel } from '@wordpress/edit-post';
 import { PanelRow, TextControl } from '@wordpress/components';
 import { RichText } from '@wordpress/block-editor';
 
-import convertToSlug from '../../utils/convertToSlug';
+import toKebabCase from '../../utils/toKebabCase';
 
 import type { AdditionalSidebarProps, BaseSidebarProps } from './types';
 import type { Pattern } from '../../types';
@@ -15,8 +15,8 @@ function isTitleTaken(
 	currentName: string,
 	patternNames: Array< Pattern[ 'name' ] >
 ) {
-	const newSlug = convertToSlug( patternTitle );
-	return patternNames.includes( newSlug ) && newSlug !== currentName;
+	const newName = toKebabCase( patternTitle );
+	return patternNames.includes( newName ) && newName !== currentName;
 }
 
 export default function TitlePanel( {
@@ -47,7 +47,7 @@ export default function TitlePanel( {
 				value={ title }
 				onChange={ ( newTitle: typeof title ) => {
 					editPost( { title: newTitle } );
-					handleChange( 'name', convertToSlug( newTitle ) );
+					handleChange( 'name', toKebabCase( newTitle ) );
 
 					if ( ! newTitle ) {
 						lockPostSaving();

wp-modules/editor/js/src/utils/filterOutPatterns.ts

@@ -8,7 +8,7 @@ import type { Pattern, Patterns } from '../types';
  */
 export default function filterOutPatterns(
 	patterns: Patterns,
-	patternName: Pattern[ 'name' ]
+	patternSlug: Pattern[ 'slug' ]
 ) {
 	return Object.entries( patterns ).reduce(
 		( accumulator, [ key, pattern ] ) => {
@@ -17,8 +17,8 @@ export default function filterOutPatterns(
 				...( ! hasBlock(
 					'core/pattern',
 					parse( pattern.content ),
-					patternName
-				) && pattern.name !== patternName
+					patternSlug
+				) && pattern.slug !== patternSlug
 					? { [ key ]: pattern }
 					: {} ),
 			};

wp-modules/editor/js/src/utils/hasBlock.ts

@@ -3,13 +3,13 @@ import type { Block, Pattern } from '../types';
 export default function hasBlock(
 	blockName: String,
 	blocks: Block[],
-	patternName: Pattern[ 'name' ]
+	patternSlug: Pattern[ 'slug' ]
 ) {
 	return blocks.some( ( block ) => {
 		return (
 			( block.name === blockName &&
-				block.attributes?.slug === patternName ) ||
-			hasBlock( blockName, block?.innerBlocks ?? [], patternName )
+				block.attributes?.slug === patternSlug ) ||
+			hasBlock( blockName, block?.innerBlocks ?? [], patternSlug )
 		);
 	} );
 }

wp-modules/editor/js/src/utils/convertToSlug.ts → wp-modules/editor/js/src/utils/toKebabCase.ts

@@ -1,5 +1,5 @@
-/** Converts a string to a slug. */
-export default function convertToSlug( toConvert = '' ) {
+/** Converts a string to a kebab-case. */
+export default function toKebabCase( toConvert = '' ) {
 	return toConvert
 		.replace( /[_\W]+(?=\w+)/g, '-' )
 		.replace( /[^-\w]/g, '' )

wp-modules/editor/model.php

@@ -44,7 +44,7 @@ function populate_pattern_from_file( $post ) {
 add_action( 'the_post', __NAMESPACE__ . '\populate_pattern_from_file' );
 
 /**
- * Saves the pattern to the .php file.
+ * Saves the pattern to the .php file, and also removes the mocked post required for the WP editing UI.
  *
  * @param int $post_id The post ID.
  * @param WP_Post $post The post.
@@ -54,13 +54,16 @@ function save_pattern_to_file( WP_Post $post ) {
 		return;
 	}
 
-	$pattern = get_pattern_by_name( $post->post_name );
+	$name    = $post->post_name;
+	$pattern = get_pattern_by_name( $name );
 	update_pattern(
 		array_merge(
-			$pattern ? $pattern : [],
+			// Only set the slug to the name for new patterns.
+			// Patterns created without PM might have a different slug and name.
+			$pattern ? $pattern : [ 'slug' => $name ],
 			[
 				'content' => $post->post_content,
-				'name'    => $post->post_name,
+				'name'    => $name,
 			],
 			$post->post_title
 				? [ 'title' => $post->post_title ]
@@ -108,6 +111,7 @@ function save_metadata_to_pattern_file( $override, $post_id, $meta_key, $meta_va
 
 	$pattern_name = $post->post_name;
 	$pattern      = get_pattern_by_name( $pattern_name );
+	$name_changed = 'name' === $meta_key && $pattern_name !== $meta_value;
 
 	if ( 'name' === $meta_key ) {
 		wp_update_post(
@@ -116,16 +120,20 @@ function save_metadata_to_pattern_file( $override, $post_id, $meta_key, $meta_va
 				'post_name' => $meta_value,
 			]
 		);
+	}
 
-		if ( $pattern_name !== $meta_value ) {
-			delete_pattern( $pattern_name );
-		}
+	if ( $name_changed ) {
+		delete_pattern( $pattern_name );
 	}
 
 	return update_pattern(
 		array_merge(
 			get_pattern_defaults(),
-			$pattern ? $pattern : [ 'title' => $post->post_title ],
+			$pattern ? $pattern : [
+				'title' => $post->post_title,
+				'slug'  => $pattern_name,
+			],
+			$name_changed ? [ 'slug' => $meta_value ] : [],
 			[
 				'name'    => $pattern_name,
 				$meta_key => $meta_value,

wp-modules/editor/tests/ModelTest.php

@@ -81,4 +81,103 @@ public function test_delete_pattern_posts_correct_post() {
 			get_posts( [ 'post_type' => 'pm_pattern ' ] )
 		);
 	}
+
+	/**
+	 * Tests that a pattern newly created with Pattern Manager results in a slug and filename that matches the post_name.
+	 */
+	public function test_new_pattern_title_matches_slug() {
+
+		// Mock a post object so we can test it.
+		$post_id            = -998; // negative ID, to avoid clash with a valid post.
+		$post               = new \stdClass();
+		$post->ID           = $post_id;
+		$post->post_author  = 1;
+		$post->post_title   = 'New Pattern, originally created with Pattern Manager.';
+		$post->post_content = 'test pattern content';
+		$post->post_status  = 'publish';
+		$post->post_name    = 'new-pattern-originally-created-with-pattern-manager';
+		$post->post_type    = get_pattern_post_type();
+		$post->filter       = 'raw';
+
+		// Convert to WP_Post object.
+		$wp_post = new \WP_Post( $post );
+
+		// Save the mocked pattern to the disk.
+		\PatternManager\Editor\save_pattern_to_file( $wp_post );
+
+		// Get the contents of the file that was saved.
+		$pattern = \PatternManager\PatternDataHandlers\get_pattern_by_name( $post->post_name );
+
+		// Make sure the post_name (aka "slug") of the post and the slug in the file match.
+		$this->assertSame( $post->post_name, $pattern['slug'] );
+
+		// Make sure the post_name (aka "slug") of the post and the filename match.
+		$this->assertSame( $post->post_name, $pattern['name'] );
+	}
+
+	/**
+	 * Tests a pattern with a slug that does not match the filename remains the same if something other than the title was not changed.
+	 */
+	public function test_slug_and_filename_stay_the_same_after_content_update() {
+
+		// Mock a post object so we can test it.
+		$post_id            = -997; // negative ID, to avoid clash with a valid post.
+		$post               = new \stdClass();
+		$post->ID           = $post_id;
+		$post->post_author  = 1;
+		$post->post_title   = 'This title remains the same after content changes.';
+		$post->post_content = 'test pattern content';
+		$post->post_status  = 'publish';
+		$post->post_name    = 'this-slug-remains-the-same-after-content-changes';
+		$post->post_type    = get_pattern_post_type();
+		$post->filter       = 'raw';
+
+		// Convert to WP_Post object.
+		$wp_post = new \WP_Post( $post );
+
+		// Save the pattern to the disk.
+		\PatternManager\Editor\save_pattern_to_file( $wp_post );
+
+		// Rename the pattern's filename to something different than the slug.
+		// This is to mock how it might be for for a non-pm-made pattern, with mismatching filenames and slugs.
+		$wp_filesystem           = \PatternManager\GetWpFilesystem\get_wp_filesystem_api();
+		$patterns_dir            = \PatternManager\PatternDataHandlers\get_patterns_directory();
+		$original_name           = $post->post_name . '.php';
+		$mocked_mismatching_name = 'mismatched-name.php';
+		$wp_filesystem->move( $patterns_dir . $original_name, $patterns_dir . $mocked_mismatching_name );
+		$wp_filesystem->delete( $patterns_dir . $original_name );
+
+		// Get the contents of the file.
+		$pattern = \PatternManager\PatternDataHandlers\get_pattern_by_name( 'mismatched-name' );
+
+		// Mock a post object so we can test modifying only the content.
+		$post_id            = -997; // negative ID, to avoid clash with a valid post.
+		$post               = new \stdClass();
+		$post->ID           = $post_id;
+		$post->post_author  = 1;
+		$post->post_title   = $pattern['title'];
+		$post->post_content = 'This is modified pattern content, but nothing else is changed!';
+		$post->post_status  = 'publish';
+		$post->post_name    = $pattern['slug'];
+		$post->post_type    = get_pattern_post_type();
+		$post->filter       = 'raw';
+
+		// Convert to WP_Post object.
+		$wp_post = new \WP_Post( $post );
+
+		// Save the pattern to the disk.
+		\PatternManager\Editor\save_pattern_to_file( $wp_post );
+
+		// Get the contents of the file.
+		$content_modified_pattern = \PatternManager\PatternDataHandlers\get_pattern_by_name( 'mismatched-name' );
+
+		// Make sure the slug does not get changed when only the content is modified.
+		$this->assertSame( 'this-slug-remains-the-same-after-content-changes', $content_modified_pattern['slug'] );
+
+		// Make sure the title does not get changed when only the content is modified.
+		$this->assertSame( 'This title remains the same after content changes.', $content_modified_pattern['title'] );
+
+		// Make sure the filename does not get changed when only the content is modified.
+		$this->assertSame( 'mismatched-name', $content_modified_pattern['name'] );
+	}
 }

wp-modules/pattern-data-handlers/pattern-data-handlers.php

@@ -356,7 +356,7 @@ function construct_pattern_php_file_contents( $pattern_data ) {
 	$file_contents = '<?php
 /**
  * Title: ' . addcslashes( $pattern['title'], '\'' ) . '
- * Slug: ' . $pattern['name'] . '
+ * Slug: ' . $pattern['slug'] . '
  * Description: ' . $pattern['description'] . '
  * Categories: ' . implode( ', ', $pattern['categories'] ) . '
  * Keywords: ' . implode( ', ', $pattern['keywords'] ) . '

wp-modules/pattern-data-handlers/tests/PatternDataHandlersTest.php

@@ -99,6 +99,7 @@ public function test_construct_pattern_php_file_contents_empty() {
 				construct_pattern_php_file_contents(
 					[
 						'name'  => 'empty',
+						'slug'  => 'empty',
 						'title' => 'Empty',
 					]
 				)