URL: Fix code drift in the Editor package by removing duplicate clean…

…ForSlug function (#39033) * URL: Fix code drift in the Editor package by removing duplicate clearForSlug function. * Editor: deprecate cleanForSlug * Editor: remove the unexported getWPAdminURL and update internal references to use addQueryArgs * URL: simplify test * add additional tests for other languages
WordPress · Feb 25, 2022 · ebb4a8a · ebb4a8a
1 parent 4bfe584
commit ebb4a8a
Show file tree

Hide file tree

Showing 10 changed files with 39 additions and 66 deletions.
diff --git a/packages/edit-post/src/components/sidebar/post-link/index.js b/packages/edit-post/src/components/sidebar/post-link/index.js
@@ -10,8 +10,8 @@ import { __ } from '@wordpress/i18n';
 import { PanelBody, TextControl, ExternalLink } from '@wordpress/components';
 import { withSelect, withDispatch } from '@wordpress/data';
 import { compose, ifCondition } from '@wordpress/compose';
-import { cleanForSlug, store as editorStore } from '@wordpress/editor';
-import { safeDecodeURIComponent } from '@wordpress/url';
+import { store as editorStore } from '@wordpress/editor';
+import { safeDecodeURIComponent, cleanForSlug } from '@wordpress/url';
 import { store as coreStore } from '@wordpress/core-data';
 import { useState } from '@wordpress/element';
 

diff --git a/packages/editor/CHANGELOG.md b/packages/editor/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Deprecations
+
+- Deprecated `cleanForSlug` that is now part of `@wordpress/url`.
+
 ## 12.2.0 (2022-02-10)
 
 ### Enhancement

diff --git a/packages/editor/src/components/post-last-revision/index.js b/packages/editor/src/components/post-last-revision/index.js
@@ -5,19 +5,19 @@ import { sprintf, _n } from '@wordpress/i18n';
 import { Button } from '@wordpress/components';
 import { withSelect } from '@wordpress/data';
 import { backup } from '@wordpress/icons';
+import { addQueryArgs } from '@wordpress/url';
 
 /**
  * Internal dependencies
  */
 import PostLastRevisionCheck from './check';
-import { getWPAdminURL } from '../../utils/url';
 import { store as editorStore } from '../../store';
 
 function LastRevision( { lastRevisionId, revisionsCount } ) {
 	return (
 		<PostLastRevisionCheck>
 			<Button
-				href={ getWPAdminURL( 'revision.php', {
+				href={ addQueryArgs( 'revision.php', {
 					revision: lastRevisionId,
 					gutenberg: true,
 				} ) }

diff --git a/packages/editor/src/components/post-locked-modal/index.js b/packages/editor/src/components/post-locked-modal/index.js
@@ -24,7 +24,6 @@ import { store as coreStore } from '@wordpress/core-data';
 /**
  * Internal dependencies
  */
-import { getWPAdminURL } from '../../utils/url';
 import { store as editorStore } from '../../store';
 
 export default function PostLockedModal() {
@@ -164,7 +163,7 @@ export default function PostLockedModal() {
 		action: 'edit',
 		_wpnonce: postLockUtils.nonce,
 	} );
-	const allPostsUrl = getWPAdminURL( 'edit.php', {
+	const allPostsUrl = addQueryArgs( 'edit.php', {
 		post_type: get( postType, [ 'slug' ] ),
 	} );
 	const allPostsLabel = __( 'Exit editor' );

diff --git a/packages/editor/src/components/post-slug/index.js b/packages/editor/src/components/post-slug/index.js
@@ -5,13 +5,12 @@ import { withDispatch, withSelect } from '@wordpress/data';
 import { Component } from '@wordpress/element';
 import { __ } from '@wordpress/i18n';
 import { withInstanceId, compose } from '@wordpress/compose';
-import { safeDecodeURIComponent } from '@wordpress/url';
+import { safeDecodeURIComponent, cleanForSlug } from '@wordpress/url';
 
 /**
  * Internal dependencies
  */
 import PostSlugCheck from './check';
-import { cleanForSlug } from '../../utils/url';
 import { store as editorStore } from '../../store';
 
 export class PostSlug extends Component {

diff --git a/packages/editor/src/store/selectors.js b/packages/editor/src/store/selectors.js
@@ -13,7 +13,7 @@ import {
 	__unstableSerializeAndClean,
 } from '@wordpress/blocks';
 import { isInTheFuture, getDate } from '@wordpress/date';
-import { addQueryArgs } from '@wordpress/url';
+import { addQueryArgs, cleanForSlug } from '@wordpress/url';
 import { createRegistrySelector } from '@wordpress/data';
 import deprecated from '@wordpress/deprecated';
 import { Platform } from '@wordpress/element';
@@ -32,7 +32,6 @@ import {
 	AUTOSAVE_PROPERTIES,
 } from './constants';
 import { getPostRawValue } from './reducer';
-import { cleanForSlug } from '../utils/url';
 import { getTemplatePartIcon } from '../utils/get-template-part-icon';
 
 /**

diff --git a/packages/editor/src/utils/test/url.js b/packages/editor/src/utils/test/url.js
diff --git a/packages/editor/src/utils/url.js b/packages/editor/src/utils/url.js
@@ -1,26 +1,8 @@
-/**
- * External dependencies
- */
-import { deburr, trim } from 'lodash';
-
 /**
  * WordPress dependencies
  */
-import { addQueryArgs } from '@wordpress/url';
-
-/**
- * Returns the URL of a WPAdmin Page.
- *
- * TODO: This should be moved to a module less specific to the editor.
- *
- * @param {string} page  Page to navigate to.
- * @param {Object} query Query Args.
- *
- * @return {string} WPAdmin URL.
- */
-export function getWPAdminURL( page, query ) {
-	return addQueryArgs( page, query );
-}
+import { cleanForSlug as urlCleanForSlug } from '@wordpress/url';
+import deprecated from '@wordpress/deprecated';
 
 /**
  * Performs some basic cleanup of a string for use as a post slug
@@ -39,14 +21,10 @@ export function getWPAdminURL( page, query ) {
  * @return {string} Processed string
  */
 export function cleanForSlug( string ) {
-	if ( ! string ) {
-		return '';
-	}
-	return trim(
-		deburr( string )
-			.replace( /[\s\./]+/g, '-' )
-			.replace( /[^\p{L}\p{N}_-]+/gu, '' )
-			.toLowerCase(),
-		'-'
-	);
+	deprecated( 'wp.editor.cleanForSlug', {
+		since: '12.7',
+		plugin: 'Gutenberg',
+		alternative: 'wp.url.cleanForSlug',
+	} );
+	return urlCleanForSlug( string );
 }
diff --git a/packages/url/src/clean-for-slug.js b/packages/url/src/clean-for-slug.js
@@ -26,7 +26,7 @@ export function cleanForSlug( string ) {
 	return trim(
 		deburr( string )
 			.replace( /[\s\./]+/g, '-' )
-			.replace( /[^\w-]+/g, '' )
+			.replace( /[^\p{L}\p{N}_-]+/gu, '' )
 			.toLowerCase(),
 		'-'
 	);

diff --git a/packages/url/src/test/index.js b/packages/url/src/test/index.js
@@ -974,17 +974,33 @@ describe( 'filterURLForDisplay', () => {
 } );
 
 describe( 'cleanForSlug', () => {
-	it( 'should return string prepared for use as url slug', () => {
+	it( 'Should return string prepared for use as url slug', () => {
 		expect( cleanForSlug( '/Is th@t Déjà_vu? ' ) ).toBe( 'is-tht-deja_vu' );
 	} );
 
-	it( 'should return an empty string for missing argument', () => {
+	it( 'Should return an empty string for missing argument', () => {
 		expect( cleanForSlug() ).toBe( '' );
 	} );
 
-	it( 'should return an empty string for falsy argument', () => {
+	it( 'Should return an empty string for falsy argument', () => {
 		expect( cleanForSlug( null ) ).toBe( '' );
 	} );
+
+	it( 'Should not allow characters used internally in rich-text', () => {
+		//The last space is an object replacement character
+		expect( cleanForSlug( 'the long cat' ) ).toBe( 'the-long-cat' );
+	} );
+
+	it( 'Creates a slug for languages that use multibyte encodings', () => {
+		expect( cleanForSlug( '新荣记 ' ) ).toBe( '新荣记' );
+		expect( cleanForSlug( '私のテンプレートパーツのテスト ' ) ).toBe(
+			'私のテンプレートパーツのテスト'
+		);
+		expect( cleanForSlug( 'ქართული ნაწილი' ) ).toBe( 'ქართული-ნაწილი' );
+		expect( cleanForSlug( 'Καλημέρα Κόσμε' ) ).toBe( 'καλημέρα-κόσμε' );
+		expect( cleanForSlug( '안녕하세요 ' ) ).toBe( '안녕하세요' );
+		expect( cleanForSlug( '繁体字 ' ) ).toBe( '繁体字' );
+	} );
 } );
 
 describe( 'normalizePath', () => {