From 0ae997d3e9bdb760f7dee353b6c04e06e38f6dc1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alba=20Rinc=C3=B3n?= Date: Fri, 12 Aug 2022 13:09:37 +0200 Subject: [PATCH] Register patterns under `patterns` folder and add filters pattern (#6861) * POC about registering patterns * POC load patterns from `/patterns` folder * Change class name and remove unnecessary comment * Add all four blocks to the filters pattern * Add all 4 blocks to the block type to allow for transformations * Add internal * Improve filters name * Extract regex to constants * Add class description * Rename and move class * Fix wrong imports * Address feedback * Early return from condition * Fix wrong block type --- patterns/filters.php | 24 +++++ phpcs.xml | 5 + src/BlockPatterns.php | 201 +++++++++++++++++++++++++++++++++++++++ src/Domain/Bootstrap.php | 16 +++- 4 files changed, 242 insertions(+), 4 deletions(-) create mode 100644 patterns/filters.php create mode 100644 src/BlockPatterns.php diff --git a/patterns/filters.php b/patterns/filters.php new file mode 100644 index 00000000000..66d6c44162e --- /dev/null +++ b/patterns/filters.php @@ -0,0 +1,24 @@ + + + +
+ + + +
+ + + +
+ + + +
+ diff --git a/phpcs.xml b/phpcs.xml index 70199828a4b..eac8154c883 100644 --- a/phpcs.xml +++ b/phpcs.xml @@ -43,12 +43,17 @@ src/ tests/php + patterns src/ tests/php + + patterns + + tests/ diff --git a/src/BlockPatterns.php b/src/BlockPatterns.php new file mode 100644 index 00000000000..290ad440837 --- /dev/null +++ b/src/BlockPatterns.php @@ -0,0 +1,201 @@ +

+ * + * Other settable fields include: + * + * - Description + * - Viewport Width + * - Categories (comma-separated values) + * - Keywords (comma-separated values) + * - Block Types (comma-separated values) + * - Inserter (yes/no) + * + * @internal + */ +class BlockPatterns { + const SLUG_REGEX = '/^[A-z0-9\/_-]+$/'; + const COMMA_SEPARATED_REGEX = '/[\s,]+/'; + + /** + * Path to the patterns directory. + * + * @var string $patterns_path + */ + private $patterns_path; + + /** + * Constructor for class + * + * @param Package $package An instance of Package. + */ + public function __construct( Package $package ) { + $this->patterns_path = $package->get_path( 'patterns' ); + + add_action( 'init', array( $this, 'register_block_patterns' ) ); + } + + /** + * Registers the block patterns and categories under `./patterns/`. + */ + public function register_block_patterns() { + if ( ! class_exists( 'WP_Block_Patterns_Registry' ) ) { + return; + } + + $default_headers = array( + 'title' => 'Title', + 'slug' => 'Slug', + 'description' => 'Description', + 'viewportWidth' => 'Viewport Width', + 'categories' => 'Categories', + 'keywords' => 'Keywords', + 'blockTypes' => 'Block Types', + 'inserter' => 'Inserter', + ); + + if ( ! file_exists( $this->patterns_path ) ) { + return; + } + + $files = glob( $this->patterns_path . '/*.php' ); + if ( ! $files ) { + return; + } + + foreach ( $files as $file ) { + $pattern_data = get_file_data( $file, $default_headers ); + + if ( empty( $pattern_data['slug'] ) ) { + _doing_it_wrong( + 'register_block_patterns', + esc_html( + sprintf( + /* translators: %s: file name. */ + __( 'Could not register file "%s" as a block pattern ("Slug" field missing)', 'woo-gutenberg-products-block' ), + $file + ) + ), + '6.0.0' + ); + continue; + } + + if ( ! preg_match( self::SLUG_REGEX, $pattern_data['slug'] ) ) { + _doing_it_wrong( + 'register_block_patterns', + esc_html( + sprintf( + /* translators: %1s: file name; %2s: slug value found. */ + __( 'Could not register file "%1$s" as a block pattern (invalid slug "%2$s")', 'woo-gutenberg-products-block' ), + $file, + $pattern_data['slug'] + ) + ), + '6.0.0' + ); + continue; + } + + if ( \WP_Block_Patterns_Registry::get_instance()->is_registered( $pattern_data['slug'] ) ) { + continue; + } + + // Title is a required property. + if ( ! $pattern_data['title'] ) { + _doing_it_wrong( + 'register_block_patterns', + esc_html( + sprintf( + /* translators: %1s: file name; %2s: slug value found. */ + __( 'Could not register file "%s" as a block pattern ("Title" field missing)', 'woo-gutenberg-products-block' ), + $file + ) + ), + '6.0.0' + ); + continue; + } + + // For properties of type array, parse data as comma-separated. + foreach ( array( 'categories', 'keywords', 'blockTypes' ) as $property ) { + if ( ! empty( $pattern_data[ $property ] ) ) { + $pattern_data[ $property ] = array_filter( + preg_split( + self::COMMA_SEPARATED_REGEX, + (string) $pattern_data[ $property ] + ) + ); + } else { + unset( $pattern_data[ $property ] ); + } + } + + // Parse properties of type int. + foreach ( array( 'viewportWidth' ) as $property ) { + if ( ! empty( $pattern_data[ $property ] ) ) { + $pattern_data[ $property ] = (int) $pattern_data[ $property ]; + } else { + unset( $pattern_data[ $property ] ); + } + } + + // Parse properties of type bool. + foreach ( array( 'inserter' ) as $property ) { + if ( ! empty( $pattern_data[ $property ] ) ) { + $pattern_data[ $property ] = in_array( + strtolower( $pattern_data[ $property ] ), + array( 'yes', 'true' ), + true + ); + } else { + unset( $pattern_data[ $property ] ); + } + } + + // phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText, WordPress.WP.I18n.LowLevelTranslationFunction + $pattern_data['title'] = translate_with_gettext_context( $pattern_data['title'], 'Pattern title', 'woo-gutenberg-products-block' ); + if ( ! empty( $pattern_data['description'] ) ) { + // phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText, WordPress.WP.I18n.LowLevelTranslationFunction + $pattern_data['description'] = translate_with_gettext_context( $pattern_data['description'], 'Pattern description', 'woo-gutenberg-products-block' ); + } + + // The actual pattern content is the output of the file. + ob_start(); + include $file; + $pattern_data['content'] = ob_get_clean(); + if ( ! $pattern_data['content'] ) { + continue; + } + + foreach ( $pattern_data['categories'] as $key => $category ) { + $category_slug = _wp_to_kebab_case( $category ); + + $pattern_data['categories'][ $key ] = $category_slug; + + register_block_pattern_category( + $category_slug, + // phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText + array( 'label' => __( $category, 'woo-gutenberg-products-block' ) ) + ); + } + + register_block_pattern( $pattern_data['slug'], $pattern_data ); + } + } +} diff --git a/src/Domain/Bootstrap.php b/src/Domain/Bootstrap.php index 186c18c52cc..892ab36f58d 100644 --- a/src/Domain/Bootstrap.php +++ b/src/Domain/Bootstrap.php @@ -3,8 +3,8 @@ use Automattic\WooCommerce\Blocks\Assets\Api as AssetApi; use Automattic\WooCommerce\Blocks\Assets\AssetDataRegistry; -use Automattic\WooCommerce\Blocks\Migration; use Automattic\WooCommerce\Blocks\AssetsController; +use Automattic\WooCommerce\Blocks\BlockPatterns; use Automattic\WooCommerce\Blocks\BlockTemplatesController; use Automattic\WooCommerce\Blocks\BlockTypesController; use Automattic\WooCommerce\Blocks\Domain\Services\CreateAccount; @@ -13,8 +13,7 @@ use Automattic\WooCommerce\Blocks\Domain\Services\GoogleAnalytics; use Automattic\WooCommerce\Blocks\InboxNotifications; use Automattic\WooCommerce\Blocks\Installer; -use Automattic\WooCommerce\Blocks\Templates\ProductSearchResultsTemplate; -use Automattic\WooCommerce\Blocks\Templates\ClassicTemplatesCompatibility; +use Automattic\WooCommerce\Blocks\Migration; use Automattic\WooCommerce\Blocks\Payments\Api as PaymentsApi; use Automattic\WooCommerce\Blocks\Payments\Integrations\BankTransfer; use Automattic\WooCommerce\Blocks\Payments\Integrations\CashOnDelivery; @@ -22,10 +21,12 @@ use Automattic\WooCommerce\Blocks\Payments\Integrations\PayPal; use Automattic\WooCommerce\Blocks\Payments\PaymentMethodRegistry; use Automattic\WooCommerce\Blocks\Registry\Container; +use Automattic\WooCommerce\Blocks\Templates\ClassicTemplatesCompatibility; use Automattic\WooCommerce\Blocks\Templates\ProductAttributeTemplate; -use Automattic\WooCommerce\StoreApi\StoreApi; +use Automattic\WooCommerce\Blocks\Templates\ProductSearchResultsTemplate; use Automattic\WooCommerce\StoreApi\RoutesController; use Automattic\WooCommerce\StoreApi\SchemaController; +use Automattic\WooCommerce\StoreApi\StoreApi; /** * Takes care of bootstrapping the plugin. @@ -119,6 +120,7 @@ function() { $this->container->get( ProductSearchResultsTemplate::class ); $this->container->get( ProductAttributeTemplate::class ); $this->container->get( ClassicTemplatesCompatibility::class ); + $this->container->get( BlockPatterns::class ); if ( $this->package->feature()->is_feature_plugin_build() ) { $this->container->get( PaymentsApi::class ); } @@ -332,6 +334,12 @@ function( Container $container ) { return $container->get( StoreApi::class )::container()->get( RoutesController::class ); } ); + $this->container->register( + BlockPatterns::class, + function () { + return new BlockPatterns( $this->package ); + } + ); } /**