generator-chisel 1.0.0 → 2.0.0-alpha.0

package/lib/commands/create/creators/app/chisel-starter-theme/classes/RegisterBlocks.php

@@ -0,0 +1,273 @@
+<?php
+
+namespace Chisel;
+
+/**
+ * Class to register custom blocks.
+ *
+ * @package Chisel
+ */
+abstract class RegisterBlocks {
+
+	/**
+	 * Blocks type.
+	 *
+	 * @var string
+	 */
+	protected $blocks_type;
+
+	/**
+	 * Blocks path.
+	 *
+	 * @var string
+	 */
+	protected $blocks_folder;
+
+	/**
+	 * Blocks src path.
+	 *
+	 * @var string
+	 */
+	protected $blocks_path_src;
+
+	/**
+	 * Blocks path.
+	 *
+	 * @var string
+	 */
+	protected $blocks_path;
+
+	/**
+	 * Blocks url.
+	 *
+	 * @var string
+	 */
+	protected $blocks_url;
+
+	/**
+	 * Blocks.
+	 *
+	 * @var array
+	 */
+	protected $blocks = array();
+
+	/**
+	 * Blocks option name.
+	 *
+	 * @var string
+	 */
+	protected $blocks_option_name;
+
+	/**
+	 * Blocks version option name.
+	 *
+	 * @var string
+	 */
+	protected $blocks_version_option_name;
+
+	/**
+	 * Theme.
+	 *
+	 * @var mixed
+	 */
+	protected $theme = null;
+
+	/**
+	 * Build folder.
+	 *
+	 * @var string
+	 */
+	protected $build_folder = 'build';
+
+	/**
+	 * Src folder.
+	 *
+	 * @var string
+	 */
+	protected $src_folder = 'src';
+
+	/**
+	 * Register scripts. By default block styles are inlined and js is registered by wp. Setting this to true will use custom hndles to register and enqueue scripts and styles and styles will not be inlined.
+	 *
+	 * @var bool
+	 */
+	protected $register_scripts;
+
+	/**
+	 * Class constructor.
+	 *
+	 * @param string $blocks_type The blocks type : acf or wp.
+	 */
+	public function __construct( $blocks_type ) {
+		$this->blocks_type                = $blocks_type;
+		$this->theme                      = wp_get_theme();
+		$this->blocks_folder              = $this->blocks_type === 'acf' ? 'blocks-acf' : 'blocks';
+		$this->blocks_path                = get_template_directory() . '/' . $this->build_folder . '/' . $this->blocks_folder;
+		$this->blocks_path_src            = get_template_directory() . '/' . $this->src_folder . '/' . $this->blocks_folder;
+		$this->blocks_url                 = get_template_directory_uri() . '/' . $this->build_folder . '/' . $this->blocks_folder;
+		$this->blocks                     = $this->get_blocks();
+		$this->blocks_option_name         = 'chisel_' . $this->blocks_type;
+		$this->blocks_version_option_name = 'chisel_' . $this->blocks_type . '_version';
+
+		$this->register_scripts = apply_filters( 'chisel_blocks_register_scripts', true, $this->blocks_type );
+	}
+
+	/**
+	 * Register custom blocks and their assets.
+	 */
+	public function register_custom_blocks() {
+		if ( ! function_exists( 'register_block_type' ) ) {
+			return;
+		}
+
+		if ( ! is_array( $this->blocks ) || ! $this->blocks ) {
+			return;
+		}
+
+		$block_scripts = array(
+			'editorScript',
+			'editorStyle',
+			'style',
+			'script',
+			'viewScript',
+			'viewStyle',
+		);
+
+		foreach ( $this->blocks as $block ) {
+			$block_path = $this->blocks_path . '/' . $block . '/';
+			$block_json = $block_path . 'block.json';
+
+			if ( ! is_file( $block_json ) ) {
+				continue;
+			}
+
+			if ( $this->register_scripts ) {
+				$block_url = $this->blocks_url . '/' . $block . '/';
+
+				// Read json file to array.
+				$block_metadata = wp_json_file_decode( $block_json, array( 'associative' => true ) );
+
+				foreach ( $block_scripts as $script ) {
+					if ( ! isset( $block_metadata[$script] ) ) {
+						continue;
+					}
+
+					$block_files = is_array( $block_metadata[$script] ) ? $block_metadata[$script] : array( $block_metadata[$script] );
+
+					if ( ! $block_files ) {
+						continue;
+					}
+
+					$script_handle = strtolower( $script );
+					$block_handle  = 'block-' . $this->blocks_type . '-' . $block . '-' . $script_handle;
+
+					foreach ( $block_files as $block_file ) {
+						if ( isset( $block_file ) && strpos( $block_file, 'file:' ) !== false ) {
+							$file_name = str_replace( 'file:./', '', $block_file );
+							$is_style  = strpos( $script_handle, 'style' ) !== false;
+							$load_css_only = isset( $block_metadata['loadCssOnly'] ) ? absint( $block_metadata['loadCssOnly'] ) : 0;
+
+							// Set the asset handle.
+							$block_metadata[$script] = $block_handle;
+
+							$file_path    = $block_path . $file_name;
+							$file_url     = $block_url . $file_name;
+							$script_asset = $this->get_block_script_asset( $block, $file_name );
+
+							if ( is_file( $file_path ) && $is_style ) {
+								wp_register_style( $block_handle, $file_url, array(), $script_asset['version'] );
+							}
+
+							if ( is_file( $file_path ) && ! $is_style ) {
+								$register_script_args = apply_filters(
+									'chisel_block_register_script_args',
+									array(
+										'strategy'  => 'defer',
+										'in_footer' => true,
+									),
+									$block_handle
+								);
+
+								if ( ! $load_css_only ) {
+									wp_register_script(
+										$block_handle,
+										$file_url,
+										$script_asset['dependencies'],
+										$script_asset['version'],
+										$register_script_args,
+									);
+								}
+							}
+						}
+					}
+				}
+			}
+
+			if ( $this->register_scripts ) {
+				register_block_type( $block_path, $block_metadata );
+			} else {
+				register_block_type( $block_json );
+			}
+
+			// In case we need to do some custom logic. All variables from this method are available in the init file.
+			if ( file_exists( $block_path . 'init.php' ) ) {
+				include_once $block_path . 'init.php';
+			}
+		}
+	}
+
+	/**
+	 * Get the list of all acf blocks.
+	 *
+	 * @return array
+	 */
+	protected function get_blocks() {
+		$blocks         = get_option( $this->blocks_option_name, array() );
+		$blocks_version = get_option( $this->blocks_version_option_name, 0 );
+
+		if ( ! $blocks || version_compare( $this->theme->get( 'Version' ), $blocks_version ) ) {
+			$blocks_list = is_dir( $this->blocks_path ) ? new \DirectoryIterator( $this->blocks_path ) : array();
+
+			if ( $blocks_list ) {
+				foreach ( $blocks_list as $item ) {
+					if ( $item->isDot() || ! $item->isDir() ) {
+						continue;
+					}
+
+					$blocks[] = $item->getFilename();
+				}
+			}
+
+			if ( ! Assets::is_fast_refresh() ) {
+				update_option( $this->blocks_option_name, $blocks );
+				update_option( $this->blocks_version_option_name, $this->theme->get( 'Version' ) );
+			}
+		}
+
+		return $blocks;
+	}
+
+	/**
+	 * Get script asset.
+	 *
+	 * @param string $block     The block name.
+	 * @param string $file_name The file name.
+	 *
+	 * @return array
+	 */
+	protected function get_block_script_asset( $block, $file_name ) {
+		$block_path        = $this->blocks_path . '/' . $block . '/';
+		$assets_file_name  = preg_replace( '/\.[^.]+$/', '', $file_name ) . '.asset.php';
+		$script_asset_path = $block_path . $assets_file_name;
+		$script_asset      = array(
+			'dependencies' => array(),
+			'version'      => $this->theme->get( 'Version' ),
+		);
+
+		if ( is_file( $script_asset_path ) ) {
+			$script_asset = include $script_asset_path;
+		}
+
+		return $script_asset;
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/classes/Sidebars.php

@@ -0,0 +1,107 @@
+<?php
+
+namespace Chisel;
+
+/**
+ * WordPress Sidebars setup related functionality.
+ *
+ * @package Chisel
+ */
+class Sidebars implements Instance {
+
+	/**
+	 * Sidebars to register.
+	 *
+	 * @var array
+	 */
+	protected $sidebars = array();
+
+	/**
+	 * Class constructor.
+	 */
+	private function __construct() {
+		$this->set_properties();
+		$this->action_hooks();
+		$this->filter_hooks();
+	}
+
+	/**
+	 * Set properties.
+	 */
+	public function set_properties() {
+		$this->sidebars = apply_filters(
+			'chisel_sidebars',
+			array(
+				'blog'      => array(
+					'name'        => __( 'Blog Sidebar', 'chisel' ),
+					'description' => __( 'Sidebar for blog pages', 'chisel' ),
+				),
+				'footer-1'  => array(
+					'name'        => __( 'Footer Column 1', 'chisel' ),
+					'description' => __( 'First column in the footer', 'chisel' ),
+				),
+				'footer-2'  => array(
+					'name'        => __( 'Footer Column 2', 'chisel' ),
+					'description' => __( 'Second column in the footer', 'chisel' ),
+				),
+				'footer-3'  => array(
+					'name'        => __( 'Footer Column 3', 'chisel' ),
+					'description' => __( 'Third column in the footer', 'chisel' ),
+				),
+				'footer-4'  => array(
+					'name'        => __( 'Footer Column 4', 'chisel' ),
+					'description' => __( 'Fourth column in the footer', 'chisel' ),
+				),
+				'copyright' => array(
+					'name'        => __( 'Copyright', 'chisel' ),
+					'description' => __( 'Footer copyright', 'chisel' ),
+				),
+			)
+		);
+	}
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks() {
+		add_action( 'widgets_init', array( $this, 'register_sidebars' ) );
+	}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks() {
+	}
+
+	/**
+	 * Register sidebars.
+	 */
+	public function register_sidebars() {
+		foreach ( $this->sidebars as $id => $data ) {
+			register_sidebar(
+				array(
+					'name'          => $data['name'],
+					'id'            => 'chisel-sidebar-' . $id,
+					'description'   => $data['description'],
+					'before_widget' => '<section id="%1$s" class="c-widget %2$s">',
+					'after_widget'  => '</section>',
+					'before_title'  => '<h3 class="c-widget__title">',
+					'after_title'   => '</h3>',
+				)
+			);
+		}
+	}
+
+	/**
+	 * 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/Site.php

@@ -0,0 +1,123 @@
+<?php
+
+namespace Chisel;
+
+use Automattic\WooCommerce\Internal\Admin\ProductForm\Component;
+use Timber\Timber;
+use Timber\Site as TimberSite;
+
+/**
+ * Site related functionality related to timber.
+ *
+ * @package Chisel
+ */
+class Site extends TimberSite implements Instance {
+
+	/**
+	 * Class constructor.
+	 */
+	private function __construct() {
+		$this->set_properties();
+		$this->action_hooks();
+		$this->filter_hooks();
+
+		parent::__construct();
+	}
+
+	/**
+	 * Set properties.
+	 */
+	public function set_properties() {}
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks() {
+	}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks() {
+		add_filter( 'timber/context', array( $this, 'add_to_context' ) );
+		add_filter( 'timber/context', array( $this, 'set_page_title' ) );
+		add_filter( 'timber/post/classmap', array( $this, 'post_classmap' ) );
+		add_filter( 'timber/term/classmap', array( $this, 'term_classmap' ) );
+	}
+
+	/**
+	 * Add data to the context.
+	 *
+	 * @param array $context The context.
+	 * @return array
+	 */
+	public function add_to_context( $context ) {
+		$context['logo']            = Components::get_logo();
+		$context['menus']           = Components::get_menus();
+		$context['sidebar']         = Components::get_sidebar();
+		$context['footer_sidebars'] = Components::get_footer_sidebars();
+
+		return $context;
+	}
+
+	/**
+	 * Set the page / post title
+	 *
+	 * @param array $context The context.
+	 *
+	 * @return array
+	 */
+	public function set_page_title( $context ) {
+		global $post;
+
+		if ( isset( $post->post_type ) ) {
+			$context['the_title'] = Components::get_the_title( $post->ID );
+		}
+
+		return $context;
+	}
+
+	/**
+	 * Add custom post class map.
+	 *
+	 * @param array $classmap The class map.
+	 * @return array
+	 */
+	public function post_classmap( $classmap ) {
+		$custom_classmap = array(
+			'post'       => ExtendedPost::class,
+			'page'       => ExtendedPost::class,
+			'product'    => ExtendedProduct::class,
+			'attachment' => ExtendedImage::class,
+		);
+
+		return array_merge( $classmap, $custom_classmap );
+	}
+
+	/**
+	 * Add custom term class map.
+	 *
+	 * @param array $classmap The class map.
+	 * @return array
+	 */
+	public function term_classmap( $classmap ) {
+		$custom_classmap = array(
+			'category' => ExtendedTerm::class,
+		);
+
+		return array_merge( $classmap, $custom_classmap );
+	}
+
+	/**
+	 * Get the instance of the class.
+	 */
+	public static function get_instance() {
+		static $instance = null;
+
+		if ( null === $instance ) {
+			$instance = new self();
+		}
+
+		return $instance;
+	}
+}