generator-chisel 2.0.0-alpha.9 → 2.0.0

package/lib/commands/create/creators/app/chisel-starter-theme/{classes → inc/WP}/Blocks.php

@@ -1,22 +1,47 @@
 <?php
 
-namespace Chisel;
+namespace Chisel\WP;
 
 use Timber\Timber;
 
+use Chisel\Interfaces\InstanceInterface;
+use Chisel\Interfaces\HooksInterface;
+use Chisel\Traits\Singleton;
+use Chisel\Factory\RegisterBlocks;
+use Chisel\Helper\BlocksHelpers;
+use Chisel\Helper\ThemeHelpers;
+use Chisel\Traits\PageBlocks;
+
 /**
  * Blocks related functionalities.
  *
  * @package Chisel
  */
-class Blocks extends RegisterBlocks implements Instance {
+class Blocks implements InstanceInterface, HooksInterface {
+
+	use Singleton;
+	use PageBlocks;
+
+	/**
+	 * Register blocks factory.
+	 *
+	 * @var RegisterBlocks
+	 */
+	private $register_blocks_factory;
+
+	/**
+	 * Blocks.
+	 *
+	 * @var array
+	 */
+	private $blocks = array();
 
 	/**
 	 * Chisel blocks category.
 	 *
 	 * @var string
 	 */
-	protected $blocks_category;
+	private $blocks_category;
 
 
 	/**
@@ -24,22 +49,23 @@ class Blocks extends RegisterBlocks implements Instance {
 	 *
 	 * @var array
 	 */
-	protected $block_patterns_categories = array();
+	private $block_patterns_categories = array();
 
 	/**
 	 * Blocks twig file base path.
 	 *
 	 * @var string
 	 */
-	protected $blocks_twig_base_path = 'build/blocks/';
+	private $blocks_twig_base_path = 'build/blocks/';
 
 	/**
 	 * Class constructor.
 	 */
 	private function __construct() {
-		$this->set_properties();
+		$this->register_blocks_factory = new RegisterBlocks( 'wp' );
+		$this->blocks                  = $this->register_blocks_factory->get_blocks();
 
-		parent::__construct( 'wp' );
+		add_action( 'after_setup_theme', array( $this, 'set_properties' ), 7 );
 
 		$this->action_hooks();
 		$this->filter_hooks();
@@ -65,6 +91,7 @@ class Blocks extends RegisterBlocks implements Instance {
 		add_action( 'init', array( $this, 'register_blocks' ) );
 		add_action( 'after_setup_theme', array( $this, 'blocks_theme_supports' ) );
 		add_action( 'init', array( $this, 'register_block_patterns_categories' ) );
+		add_action( 'wp_print_styles', array( $this, 'dequeue_blocks_styles' ), 999 );
 	}
 
 	/**
@@ -84,7 +111,7 @@ class Blocks extends RegisterBlocks implements Instance {
 	 * Register blocks and their assets.
 	 */
 	public function register_blocks() {
-		$this->register_custom_blocks();
+		$this->register_blocks_factory->register_custom_blocks();
 	}
 
 	/**
@@ -119,7 +146,7 @@ class Blocks extends RegisterBlocks implements Instance {
 				$categories,
 				array(
 					'slug'  => $this->blocks_category,
-					'title' => __( 'Chisel Blocks', 'chisel' ),
+					'title' => sprintf( '%s %s', ThemeHelpers::get_theme_name(), esc_html__( 'Blocks', 'chisel' ) ),
 					'icon'  => '<svg width="44" height="44" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 44.16 44.16"><path d="M22.08,0a22,22,0,0,0-12,3.55.83.83,0,0,0-.25,1.16A.84.84,0,0,0,11,5,20.41,20.41,0,1,1,8.37,7,.84.84,0,1,0,7.23,5.74,22.08,22.08,0,1,0,22.08,0Zm15,12.07a.84.84,0,1,0-1.4.93,16.3,16.3,0,1,1-2.16-2.61.84.84,0,0,0,1.19,0,.85.85,0,0,0,0-1.19,18.14,18.14,0,1,0,2.38,2.88Zm-15-2.86a12.83,12.83,0,0,0-7.65,2.52.85.85,0,0,0-.17,1.18.84.84,0,0,0,1.18.18A11.18,11.18,0,1,1,24.8,32.93.84.84,0,0,0,25,34.59l.2,0A12.87,12.87,0,0,0,22.08,9.21ZM15,30.74A11.19,11.19,0,0,1,13,15.62a.84.84,0,1,0-1.37-1,12.86,12.86,0,0,0,2.36,17.4.84.84,0,0,0,.53.19.86.86,0,0,0,.66-.31A.85.85,0,0,0,15,30.74Z" fill="#2a1468"></path><path d="M28.49,25.69a.85.85,0,0,0-1.18.19,6.46,6.46,0,1,1-1.43-9,.84.84,0,1,0,1-1.36,8.15,8.15,0,1,0,1.8,11.38A.85.85,0,0,0,28.49,25.69Zm-6.41-7a3.43,3.43,0,1,0,3.43,3.43A3.44,3.44,0,0,0,22.08,18.65Zm0,5.17a1.74,1.74,0,1,1,1.74-1.74A1.74,1.74,0,0,1,22.08,23.82Z" fill="#ff6d54"></path></svg>',
 				)
 			);
@@ -139,7 +166,7 @@ class Blocks extends RegisterBlocks implements Instance {
 		}
 
 		foreach ( $this->block_patterns_categories as $slug => $category ) {
-			$category['label'] = '[Chisel] ' . $category['label'];
+			$category['label'] = sprintf( '[%s] %s', ThemeHelpers::get_theme_name(), esc_attr( $category['label'] ) );
 			register_block_pattern_category( 'chisel-patterns/' . $slug, $category );
 		}
 	}
@@ -156,7 +183,7 @@ class Blocks extends RegisterBlocks implements Instance {
 		}
 
 		foreach ( $this->blocks as $block ) {
-			$locations[] = array( $this->blocks_path_src . '/' . $block . '/' );
+			$locations[] = array( $this->register_blocks_factory->get_blocks_path_src() . '/' . $block . '/' );
 		}
 
 		return $locations;
@@ -176,14 +203,14 @@ class Blocks extends RegisterBlocks implements Instance {
 			return $block_content;
 		}
 
-		$custom_classnames = self::get_block_object_classnames( $block['blockName'] );
+		$custom_classnames = BlocksHelpers::get_block_object_classnames( $block['blockName'] );
 
 		if ( empty( $custom_classnames ) ) {
 			return $block_content;
 		}
 
 		$block_content = preg_replace( '/<([^>]+) class="([^"]+)">/', '<$1 class="$2 ' . $custom_classnames . '">', $block_content, 1 );
-		$block_content = preg_replace( '/class="([^"]*) is-layout-flow ([^"]*)"/', 'class="$1 $2"', $block_content ); // It overwrites margin styles. Let's get rid of it.
+		$block_content = preg_replace( '/class="([^"]*) (is-layout-flow|is-layout-constrained) ([^"]*)"/', 'class="$1 $3"', $block_content ); // It overwrites margin styles. Let's get rid of it.
 
 		if ( $block['blockName'] === 'core/table' ) {
 			$block_content = preg_replace( '/<([^>]+) class="([^"]+)">/', '<$1 class="$2 u-table-responsive">', $block_content, 1 );
@@ -234,52 +261,37 @@ class Blocks extends RegisterBlocks implements Instance {
 	}
 
 	/**
-	 * Get block object classnames
-	 *
-	 * @param string $block_name
+	 * Dequeue blocks styles that are not used on current page and add inline critical css for blocks.
 	 *
-	 * @return string
+	 * @return void
 	 */
-	public static function get_block_object_classnames( $block_name ) {
-		if ( ! $block_name ) {
-			return '';
-		}
-
-		$block_name_parts = explode( '/', $block_name );
-
-		if ( empty( $block_name_parts ) || ! isset( $block_name_parts[1] ) ) {
-			return '';
+	public function dequeue_blocks_styles() {
+		if ( is_admin() ) {
+			return;
 		}
 
-		return 'c-block c-block--' . $block_name_parts[0] . ' c-block--' . $block_name_parts[1];
-	}
+		$blocks_used_on_page = $this->get_content_blocks_names();
+		$blocks              = $this->blocks;
 
-	/**
-	 * Render twig file for a block
-	 *
-	 * @param string $block_name
-	 * @param array  $context
-	 *
-	 * @return void
-	 */
-	public static function render_twig_file( $block_name, $context ) {
-		$block_name = explode( '/', $block_name );
-		$block_name = end( $block_name );
+		if ( $blocks ) {
+			$blocks_path = $this->register_blocks_factory->get_blocks_path();
+			$blocks_url  = $this->register_blocks_factory->get_blocks_url();
 
-		$twig_file = self::get_instance()->blocks_twig_base_path . $block_name . '/render.twig';
-		Timber::render( $twig_file, $context );
-	}
+			foreach ( $blocks as $block_name ) {
+				if ( ! in_array( $block_name, $blocks_used_on_page, true ) ) {
+					wp_dequeue_style( 'block-wp-' . $block_name . '-style' );
+				} else {
+					$block_critical_css = $blocks_path . '/' . $block_name . '/script.css';
 
-	/**
-	 * Get the instance of the class.
-	 */
-	public static function get_instance() {
-		static $instance = null;
+					if ( is_file( $block_critical_css ) ) {
+						$css = BlocksHelpers::get_block_inline_css( $blocks_url, $block_name );
 
-		if ( null === $instance ) {
-			$instance = new self();
+						if ( $css ) {
+							$add = wp_add_inline_style( AssetsHelpers::get_final_handle( 'main' ), $css );
+						}
+					}
+				}
+			}
 		}
-
-		return $instance;
 	}
 }

package/lib/commands/create/creators/app/chisel-starter-theme/inc/WP/Cache.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace Chisel\WP;
+
+use Timber\Loader;
+
+use Chisel\Interfaces\InstanceInterface;
+use Chisel\Interfaces\HooksInterface;
+use Chisel\Traits\Singleton;
+use Chisel\Helper\ThemeHelpers;
+
+/**
+ * Cache related functionalities.
+ *
+ * @package Chisel
+ */
+class Cache implements InstanceInterface, HooksInterface {
+
+	use Singleton;
+
+	/**
+	 * Cache expiry time.
+	 *
+	 * @var int
+	 */
+	public $cache_expiry = HOUR_IN_SECONDS;
+
+	/**
+	 * Cache everything mode. The whole template you render and its data will be cached.
+	 *
+	 * @var int
+	 */
+	public $cache_everything = false;
+
+	/**
+	 * Environment cache.
+	 *
+	 * @var int
+	 */
+	private $environment_cache = true;
+
+	/**
+	 * Class constructor.
+	 */
+	private function __construct() {
+		add_action( 'after_setup_theme', array( $this, 'set_properties' ), 7 );
+
+		$this->action_hooks();
+		$this->filter_hooks();
+	}
+
+	/**
+	 * Set properties.
+	 */
+	public function set_properties() {
+		$this->cache_expiry      = apply_filters( 'chisel_cache_expiry', $this->cache_expiry );
+		$this->cache_everything  = apply_filters( 'chisel_cache_everything', $this->cache_everything );
+		$this->environment_cache = apply_filters( 'chisel_environment_cache', $this->environment_cache );
+	}
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks() {
+	}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks() {
+		add_filter( 'timber/cache/mode', array( $this, 'cache_mode' ) );
+		add_filter( 'timber/twig/environment/options', array( $this, 'environment_cache' ) );
+	}
+
+	/**
+	 * Set Timber cache mode for cache everything mode.
+	 *
+	 * @param string $cache_mode The cache mode.
+	 *
+	 * @return string
+	 */
+	public function cache_mode( $cache_mode ) {
+		// Available cache modes: 'CACHE_NONE', 'CACHE_OBJECT' (WP Object Cache), 'CACHE_TRANSIENT', 'CACHE_SITE_TRANSIENT', 'CACHE_USE_DEFAULT'.
+		$cache_mode = Loader::CACHE_USE_DEFAULT;
+
+		return $cache_mode;
+	}
+
+	/**
+	 * Set Timber environment cache. Uses twig cache. Caches the twig file, but not the data. In order for the cache to work WP_DEBUG must be set to false.
+	 *
+	 * @param array $options
+	 *
+	 * @return array
+	 */
+	public function environment_cache( $options ) {
+		$options['cache']       = $this->environment_cache;
+		$options['auto_reload'] = ThemeHelpers::is_dev_env();
+		$options['debug']       = ThemeHelpers::is_dev_env();
+
+		return $options;
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/{classes/ExtendedImage.php → inc/WP/ChiselImage.php}

@@ -1,6 +1,6 @@
 <?php
 
-namespace Chisel;
+namespace Chisel\WP;
 
 use Timber\Image as TimberImage;
 
@@ -9,7 +9,7 @@ use Timber\Image as TimberImage;
  *
  * @package Chisel
  */
-class ExtendedImage extends TimberImage {
+class ChiselImage extends TimberImage {
 
 	/**
 	 * Get responsive image html

package/lib/commands/create/creators/app/chisel-starter-theme/{classes/ExtendedPost.php → inc/WP/ChiselPost.php}

@@ -1,16 +1,17 @@
 <?php
 
-namespace Chisel;
+namespace Chisel\WP;
 
 use Timber\Post as TimberPost;
 use Timber\Timber;
+use Chisel\Helper\ImageHelpers;
 
 /**
  * Extend Timber Post class with custom functionality.
  *
  * @package Chisel
  */
-class ExtendedPost extends TimberPost {
+class ChiselPost extends TimberPost {
 
 	/**
 	 * Post thumbnail.
@@ -27,7 +28,7 @@ class ExtendedPost extends TimberPost {
 	 */
 	public function get_thumbnail( $size = 'medium' ) {
 		if ( ! $this->thumbnail_html ) {
-			$this->thumbnail_html = has_post_thumbnail( $this->ID ) ? Helpers::get_responsive_image( get_post_thumbnail_id( $this->ID ), $size ) : '';
+			$this->thumbnail_html = has_post_thumbnail( $this->ID ) ? ImageHelpers::get_responsive_image( get_post_thumbnail_id( $this->ID ), $size ) : '';
 		}
 
 		return $this->thumbnail_html;

package/lib/commands/create/creators/app/chisel-starter-theme/{classes/ExtendedProduct.php → inc/WP/ChiselProduct.php}

@@ -1,16 +1,17 @@
 <?php
 
-namespace Chisel;
+namespace Chisel\WP;
 
 use Timber\Post as TimberPost;
 use Timber\Timber;
+use Chisel\Helper\ImageHelpers;
 
 /**
  * Extend Timber Post class with custom functionality. This is a woocommerce product class.
  *
  * @package Chisel
  */
-class ExtendedProduct extends TimberPost {
+class ChiselProduct extends TimberPost {
 
 	/**
 	 * Product thumbnail.
@@ -27,7 +28,7 @@ class ExtendedProduct extends TimberPost {
 	 */
 	public function get_thumbnail( $size = 'woocommerce_thumbnail' ) {
 		if ( ! $this->thumbnail_html ) {
-			$thumbnail_html = has_post_thumbnail( $this->ID ) ? Helpers::get_responsive_image( get_post_thumbnail_id( $this->ID ), $size ) : '';
+			$thumbnail_html = has_post_thumbnail( $this->ID ) ? ImageHelpers::get_responsive_image( get_post_thumbnail_id( $this->ID ), $size ) : '';
 
 			if ( ! $thumbnail_html ) {
 				$thumbnail_html = wc_placeholder_img( $size );

package/lib/commands/create/creators/app/chisel-starter-theme/{classes/ExtendedTerm.php → inc/WP/ChiselTerm.php}

@@ -1,6 +1,6 @@
 <?php
 
-namespace Chisel;
+namespace Chisel\WP;
 
 use Timber\Term as TimberTerm;
 
@@ -9,5 +9,5 @@ use Timber\Term as TimberTerm;
  *
  * @package Chisel
  */
-class ExtendedTerm extends TimberTerm {
+class ChiselTerm extends TimberTerm {
 }

package/lib/commands/create/creators/app/chisel-starter-theme/{classes → inc/WP}/Comments.php

@@ -1,27 +1,33 @@
 <?php
 
-namespace Chisel;
+namespace Chisel\WP;
+
+use Chisel\Interfaces\InstanceInterface;
+use Chisel\Interfaces\HooksInterface;
+use Chisel\Traits\Singleton;
 
 /**
  * Comments related functionalities.
  *
  * @package Chisel
  */
-class Comments implements Instance {
+class Comments implements InstanceInterface, HooksInterface {
+
+	use Singleton;
 
 	/**
 	 * Disable comments
 	 *
 	 * @var bool
 	 */
-	protected $disable_comments;
+	private $disable_comments;
 
 	/**
 	 *  Post types for which comments are disabled.
 	 *
 	 * @var array
 	 */
-	protected $post_types = array(
+	private $post_types = array(
 		'post',
 		'page',
 	);
@@ -294,32 +300,4 @@ class Comments implements Instance {
 
 		return $headers;
 	}
-
-	/**
-	 * Display comments template - the comments and the form.
-	 *
-	 * @return void
-	 */
-	public static function comments_template() {
-		if ( ! post_type_supports( get_post_type(), 'comments' ) ) {
-			return;
-		}
-
-		if ( comments_open() ) {
-			return apply_filters( 'the_content', '<!-- wp:pattern {"slug":"chisel/comments"} /-->' );
-		}
-	}
-
-	/**
-	 * Get the instance of the class.
-	 */
-	public static function get_instance() {
-		static $instance = null;
-
-		if ( null === $instance ) {
-			$instance = new self();
-		}
-
-		return $instance;
-	}
 }

package/lib/commands/create/creators/app/chisel-starter-theme/{classes → inc/WP}/Components.php

@@ -1,9 +1,11 @@
 <?php
 
-namespace Chisel;
+namespace Chisel\WP;
 
 use Timber\Timber;
-use Chisel\ChiselCache;
+use Chisel\Helper\ImageHelpers;
+use Chisel\Helper\AcfHelpers;
+use Chisel\Helper\CacheHelpers;
 
 /**
  * Use this class to get site components.
@@ -17,35 +19,42 @@ class Components {
 	 *
 	 * @var array
 	 */
-	protected static $menus = array();
+	private static $menus = array();
 
 	/**
-	 * The logo image html.
+	 * The logo.
 	 *
-	 * @var html
+	 * @var array
 	 */
-	protected static $logo_image = '';
+	private static $logo = array();
 
 	/**
 	 * The sidebar widgets.
 	 *
 	 * @var array
 	 */
-	protected static $sidebar = array();
+	private static $sidebar = array();
 
 	/**
 	 * The footer sidebars.
 	 *
 	 * @var array
 	 */
-	protected static $footer_sidebars = array();
+	private static $footer_sidebars = array();
 
 	/**
 	 * The page / post title.
 	 *
-	 * @var string|html
+	 * @var array
+	 */
+	private static $the_title = array();
+
+	/**
+	 * The svg icons.
+	 *
+	 * @var array
 	 */
-	protected static $the_title = null;
+	private static $icons = array();
 
 	/**
 	 * Get the site nav menus.
@@ -80,23 +89,17 @@ class Components {
 	 * @return string
 	 */
 	public static function get_logo() {
-		$context = Timber::context();
-
-		if ( ! self::$logo_image ) {
-			$logo_id = get_theme_mod( 'custom_logo', 0 );
+		if ( self::$logo ) {
+			return self::$logo;
+		}
 
-			if ( $logo_id ) {
-				self::$logo_image = Helpers::get_responsive_image( $logo_id );
-			}
+		$logo_id = get_theme_mod( 'custom_logo', 0 );
 
-			$context['logo_image'] = self::$logo_image;
+		if ( $logo_id ) {
+			self::$logo = ImageHelpers::get_responsive_image( $logo_id );
 		}
 
-		return Timber::compile(
-			'partials/logo.twig',
-			$context,
-			ChiselCache::expiry( DAY_IN_SECONDS )
-		);
+		return self::$logo;
 	}
 
 	/**
@@ -174,23 +177,23 @@ class Components {
 	/**
 	 * Get the current page title.
 	 *
-	 * @return string|html
+	 * @return array
 	 */
 	public static function get_the_title() {
+		if ( self::$the_title ) {
+			return self::$the_title;
+		}
+
 		$classname   = 'c-title';
 		$the_title   = array();
 		$title_text  = '';
 		$title_class = '';
 
-		if ( self::$the_title !== null ) {
-			return self::$the_title;
-		}
-
 		if ( is_singular() ) {
 			global $post;
 
 			if ( isset( $post->ID ) ) {
-				$display_title = Acf::get_field( 'page_title_display', $post->ID ) ?: 'show';
+				$display_title = AcfHelpers::get_field( 'page_title_display', $post->ID ) ?: 'show';
 
 				if ( $display_title !== 'hide' ) {
 					$title_text  = get_the_title( $post->ID );
@@ -228,18 +231,40 @@ class Components {
 		}
 
 		if ( $title_text ) {
-			$the_title = array(
+			self::$the_title = array(
 				'text'  => esc_html( $title_text ),
 				'class' => $title_class ? esc_attr( $title_class ) : $classname,
 			);
 		}
 
-		self::$the_title = apply_filters( 'chisel_the_title', $the_title );
+		return self::$the_title;
+	}
 
-		return Timber::compile(
-			'partials/the-title.twig',
-			array( 'the_title' => self::$the_title ),
-			ChiselCache::expiry()
-		);
+	/**
+	 * Get svg icon. The arguments are described in objects/icon.twig file
+	 *
+	 * @param array $args
+	 *
+	 * @return html
+	 */
+	public static function get_icon( $args ) {
+		$icon_slug = sanitize_title( $args['name'] );
+
+		$icon_key = '';
+		foreach ( $args as $key => $value ) {
+			if ( is_bool( $value ) ) {
+				$value = $value ? 'yes' : 'no';
+			}
+
+			$icon_key .= sanitize_title( $key . $value );
+		}
+
+		if ( isset( self::$icons[$icon_key] ) ) {
+			return self::$icons[$icon_key];
+		}
+
+		self::$icons[$icon_key] = Timber::compile( 'objects/icon.twig', $args, CacheHelpers::expiry() );
+
+		return self::$icons[$icon_key];
 	}
 }