This repository has been archived by the owner on Feb 23, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 219
Fix corrupt Classic Template placeholders for specific products. #7033
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import { getTemplateDetailsBySlug } from '../utils'; | ||
|
|
||
| const TEMPLATES = { | ||
| 'single-product': { | ||
| title: 'Single Product Title', | ||
| placeholder: 'Single Product Placeholder', | ||
| }, | ||
| 'archive-product': { | ||
| title: 'Product Archive Title', | ||
| placeholder: 'Product Archive Placeholder', | ||
| }, | ||
| 'archive-product': { | ||
| title: 'Product Archive Title', | ||
| placeholder: 'Product Archive Placeholder', | ||
| }, | ||
| 'taxonomy-product_cat': { | ||
| title: 'Product Taxonomy Title', | ||
| placeholder: 'Product Taxonomy Placeholder', | ||
| }, | ||
| }; | ||
|
|
||
| describe( 'getTemplateDetailsBySlug', function () { | ||
| it( 'should return single-product object when given an exact match', () => { | ||
| expect( | ||
| getTemplateDetailsBySlug( 'single-product', TEMPLATES ) | ||
| ).toBeTruthy(); | ||
| expect( | ||
| getTemplateDetailsBySlug( 'single-product', TEMPLATES ) | ||
| ).toStrictEqual( TEMPLATES[ 'single-product' ] ); | ||
| } ); | ||
|
|
||
| it( 'should return single-product object when given a partial match', () => { | ||
| expect( | ||
| getTemplateDetailsBySlug( 'single-product-hoodie', TEMPLATES ) | ||
| ).toBeTruthy(); | ||
| expect( | ||
| getTemplateDetailsBySlug( 'single-product-hoodie', TEMPLATES ) | ||
| ).toStrictEqual( TEMPLATES[ 'single-product' ] ); | ||
| } ); | ||
|
|
||
| it( 'should return null object when given an incorrect match', () => { | ||
| expect( getTemplateDetailsBySlug( 'void', TEMPLATES ) ).toBeNull(); | ||
| } ); | ||
| } ); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export type TemplateDetails = Record< string, Record< string, string > >; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| /** | ||
| * External dependencies | ||
| */ | ||
| import { Block } from '@wordpress/blocks'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import { TEMPLATES } from './constants'; | ||
| import { TemplateDetails } from './types'; | ||
|
|
||
| // Finds the most appropriate template details object for specific template keys such as single-product-hoodie. | ||
| export function getTemplateDetailsBySlug( | ||
| parsedTemplate: string, | ||
| templates: TemplateDetails | ||
| ) { | ||
| const templateKeys = Object.keys( templates ); | ||
| let templateDetails = null; | ||
|
|
||
| for ( let i = 0; templateKeys.length > i; i++ ) { | ||
| const keyToMatch = parsedTemplate.substr( 0, templateKeys[ i ].length ); | ||
| const maybeTemplate = templates[ keyToMatch ]; | ||
| if ( maybeTemplate ) { | ||
| templateDetails = maybeTemplate; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| return templateDetails; | ||
| } | ||
|
|
||
| export function isClassicTemplateBlockRegisteredWithAnotherTitle( | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| block: Block< any > | undefined, | ||
| parsedTemplate: string | ||
| ) { | ||
| const templateDetails = getTemplateDetailsBySlug( | ||
| parsedTemplate, | ||
| TEMPLATES | ||
| ); | ||
| return block?.title !== templateDetails?.title; | ||
| } | ||
|
|
||
| export function hasTemplateSupportForClassicTemplateBlock( | ||
| parsedTemplate: string, | ||
| templates: TemplateDetails | ||
| ): boolean { | ||
| return getTemplateDetailsBySlug( parsedTemplate, templates ) ? true : false; | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do these functions really need to accept a second argument for
templates? Is there a circumstance in which we won't useTEMPLATESfromconstantsas this second argument?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sunyatasattva I intentionally made this a pure function. I find they're easier to read, reuse and predict. Also much easier to unit test (and debug should those tests fail)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright then! Everything else looks good to me.