generator-chisel 2.0.0-alpha.8 → 2.0.0

package/lib/commands/create/creators/app/chisel-starter-theme/inc/Helper/DataHelpers.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Chisel\Helper;
+
+use Timber\Timber;
+
+/**
+ * Helper functions.
+ *
+ * @package Chisel
+ */
+class DataHelpers {
+
+	/**
+	 * Json decode data for storing in html attribute
+	 *
+	 * @param array $data
+	 *
+	 * @return string
+	 */
+	public static function json_encode_for_data_attribute( $data ) {
+		return htmlspecialchars( wp_json_encode( $data ) );
+	}
+
+	/**
+	 * Convert an object to an array.
+	 *
+	 * @param object $object_to_convert
+	 *
+	 * @return array
+	 */
+	public static function object_to_array( $object_to_convert ) {
+			return json_decode( wp_json_encode( $object_to_convert ), true );
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/inc/Helper/GravityFormsHelpers.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Chisel\Helper;
+
+/**
+ * Helper functions.
+ *
+ * @package Chisel
+ */
+class GravityFormsHelpers {
+
+	/**
+	 * Check if Gravity Forms plugin is active.
+	 *
+	 * @return bool
+	 */
+	public static function is_gf_active() {
+		return class_exists( '\GFForms' );
+	}
+
+	/**
+	 * Get list of available Gravity Forms. Can be used in acf/load_field filter to populate the select field.
+	 *
+	 * @return array
+	 */
+	public static function get_forms_list() {
+		if ( ! class_exists( 'GFForms' ) ) {
+			return array();
+		}
+
+		$forms = \GFAPI::get_forms();
+
+		$list = array();
+
+		if ( $forms ) {
+			foreach ( $forms as $form ) {
+				$list[$form['id']] = $form['title'];
+			}
+		}
+
+		return $list;
+	}
+
+	/**
+	 * This function will generate the gravity form for a given id with default parameters. Use if you need to generate ajax fomr outside of blocks.
+	 *
+	 * @param int   $form_id
+	 * @param bool  $display_title
+	 * @param bool  $display_description
+	 * @param bool  $display_inactive
+	 * @param array $field_values
+	 * @param bool  $ajax
+	 * @param int   $tabindex
+	 * @param bool  $_echo
+	 *
+	 * @return mixed
+	 */
+	public static function get_form( $form_id, $display_title = false, $display_description = false, $display_inactive = false, $field_values = null, $ajax = true, $tabindex = 0, $_echo = false ) {
+		if ( function_exists( 'gravity_form' ) ) {
+			return gravity_form( $form_id, $display_title, $display_description, $display_inactive, $field_values, $ajax, $tabindex, $_echo );
+		}
+
+		return null;
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/inc/Helper/ImageHelpers.php

@@ -0,0 +1,102 @@
+<?php
+
+namespace Chisel\Helper;
+
+use Timber\Timber;
+
+/**
+ * Image Helper functions.
+ *
+ * @package Chisel
+ */
+class ImageHelpers {
+
+	/**
+	 * Responsive image data.
+	 *
+	 * @var array
+	 */
+	private static $responsive_image_data = array();
+
+	/**
+	 * Get image url of the theme images.
+	 *
+	 * @param string $image_name
+	 * @param bool   $is_icon
+	 *
+	 * @return string
+	 */
+	public static function get_image_url( $image_name, $is_icon = false ) {
+		$folder_name = $is_icon ? 'icons' : 'images';
+		$image_path  = '/assets/' . $folder_name . '/' . $image_name;
+		$file_path   = get_template_directory() . $image_path;
+
+		if ( ! file_exists( $file_path ) ) {
+			return '';
+		}
+
+		return get_template_directory_uri() . $image_path;
+	}
+
+	/**
+	 * Get responsive image html
+	 *
+	 * @param int    $image_id Image ID.
+	 * @param string $image_size Image size.
+	 * @param array  $attrs Image attributes.
+	 *
+	 * @return string|html
+	 */
+	public static function get_responsive_image( $image_id, $image_size = 'medium', $attrs = array() ) {
+		if ( ! $image_id ) {
+			return '';
+		}
+
+		$image = Timber::get_image( $image_id );
+
+		self::$responsive_image_data = array(
+			'image_id' => $image_id,
+			'attrs'    => $attrs,
+		);
+
+		// Adjust image width and height to prevent layout shifts.
+		if ( isset( $attrs['width'] ) && isset( $attrs['height'] ) ) {
+			add_filter(
+				'wp_get_attachment_image_src',
+				array( self::class, 'responsive_image_dimensions' ),
+				10,
+				4
+			);
+		}
+
+		$responsive_image = $image ? $image->responsive( $image_size, $attrs ) : '';
+
+		remove_filter(
+			'wp_get_attachment_image_src',
+			array( self::class, 'responsive_image_dimensions' ),
+			10
+		);
+
+		return $responsive_image;
+	}
+
+	/**
+	 * Adjust image width and height to prevent layout shifts
+	 *
+	 * @param array $src
+	 * @param int   $id
+	 *
+	 * @return array
+	 */
+	public static function responsive_image_dimensions( $src, $id ) {
+		$image_id = self::$responsive_image_data['image_id'] ?? 0;
+		$attrs    = self::$responsive_image_data['attrs'] ?? array();
+
+		if ( $id === $image_id && isset( $attrs['width'] ) && isset( $attrs['height'] ) ) {
+				$src[1] = $attrs['width'];
+				$src[2] = $attrs['height'];
+		}
+
+		return $src;
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/{classes/Helpers.php → inc/Helper/ThemeHelpers.php}

@@ -1,22 +1,21 @@
 <?php
 
-namespace Chisel;
+namespace Chisel\Helper;
 
-use Timber\Timber;
+use Chisel\Helper\ImageHelpers;
 
 /**
  * Helper functions.
  *
  * @package Chisel
  */
-class Helpers {
-
+class ThemeHelpers {
 	/**
 	 * Color palettes.
 	 *
 	 * @var array
 	 */
-	protected static $colors_palettes = array(
+	private static $colors_palettes = array(
 		'acf'     => array(),
 		'tinymce' => '',
 	);
@@ -31,107 +30,33 @@ class Helpers {
 	}
 
 	/**
-	 * Get theme version.
+	 * Check if current environment is development and runnning in fast refresh mode. Set define( 'WP_ENVIRONMENT_TYPE', 'development' ); in wp-config-local.
 	 *
 	 * @return bool
 	 */
-	public static function get_theme_version() {
-		$theme = wp_get_theme();
-		return $theme->get( 'Version' );
-	}
-
-	/**
-	 * Get colors palette for given type from theme.json file.
-	 *
-	 * @param string $type Type of palette to get.
-	 *
-	 * @return array
-	 */
-	public static function get_colors_palette( $type ) {
-		if ( ! isset( self::$colors_palettes[$type] ) || self::$colors_palettes[$type] ) {
-			return self::$colors_palettes[$type];
-		}
-
-		$theme_json      = get_template_directory() . '/theme.json';
-		$theme_json_data = wp_json_file_decode( $theme_json, array( 'associative' => true ) );
-		$colors_palette  = $theme_json_data['settings']['color']['palette'];
-
-		if ( $colors_palette ) {
-			foreach ( $colors_palette as $color_data ) {
-				$color = sanitize_hex_color( $color_data['color'] );
-
-				if ( $type === 'acf' ) {
-					self::$colors_palettes[$type][] = $color;
-				} elseif ( $type === 'tinymce' ) {
-					self::$colors_palettes[$type] .= sprintf(
-						'"%s", "%s",',
-						str_replace( '#', '', $color ),
-						esc_attr( $color_data['name'] )
-					);
-				}
-			}
-		}
-
-		return apply_filters( 'chisel_' . $type . '_colors_palette', self::$colors_palettes[$type] );
-	}
-
-	/**
-	 * Json decode data for storing in html attribute
-	 *
-	 * @param array $data
-	 *
-	 * @return string
-	 */
-	public static function json_encode_for_data_attribute( $data ) {
-		return htmlspecialchars( wp_json_encode( $data ) );
-	}
+	public static function is_fast_refresh() {
+		$runtime = get_template_directory() . '/build/runtime.js';
 
-	/**
-	 * Convert an object to an array.
-	 *
-	 * @param object $object_to_convert
-	 *
-	 * @return array
-	 */
-	public static function object_to_array( $object_to_convert ) {
-			return json_decode( wp_json_encode( $object_to_convert ), true );
+		return self::is_dev_env() && is_file( $runtime );
 	}
 
 	/**
-	 * Get image url of the theme images.
-	 *
-	 * @param string $image_name
-	 * @param bool   $is_icon
+	 * Get theme version.
 	 *
-	 * @return string
+	 * @return bool
 	 */
-	public static function get_image_url( $image_name, $is_icon = false ) {
-		$folder_name = $is_icon ? 'icons' : 'images';
-		$image_path  = '/assets/' . $folder_name . '/' . $image_name;
-		$file_path   = get_template_directory() . $image_path;
-
-		if ( ! file_exists( $file_path ) ) {
-			return '';
-		}
-
-		return get_template_directory_uri() . $image_path;
+	public static function get_theme_version() {
+		$theme = wp_get_theme();
+		return $theme->get( 'Version' );
 	}
 
 	/**
-	 * Get responsive image html
-	 *
-	 * @param int    $image_id Image ID.
-	 * @param string $image_size Image size.
-	 * @param array  $attrs Image attributes.
+	 * Get theme name / site title.
 	 *
-	 * @return string|html
+	 * @return bool
 	 */
-	public static function get_responsive_image( $image_id, $image_size = 'medium', $attrs = array() ) {
-		if ( ! $image_id ) {
-			return '';
-		}
-
-		return Timber::get_image( $image_id )->responsive( $image_size, $attrs );
+	public static function get_theme_name() {
+		return esc_attr( get_bloginfo( 'name' ) );
 	}
 
 	/**
@@ -182,6 +107,41 @@ class Helpers {
 		return implode( ' ', $classnames );
 	}
 
+	/**
+	 * Get colors palette for given type from theme.json file.
+	 *
+	 * @param string $type Type of palette to get.
+	 *
+	 * @return array
+	 */
+	public static function get_colors_palette( $type ) {
+		if ( ! isset( self::$colors_palettes[$type] ) || self::$colors_palettes[$type] ) {
+			return self::$colors_palettes[$type];
+		}
+
+		$theme_json      = get_template_directory() . '/theme.json';
+		$theme_json_data = wp_json_file_decode( $theme_json, array( 'associative' => true ) );
+		$colors_palette  = $theme_json_data['settings']['color']['palette'];
+
+		if ( $colors_palette ) {
+			foreach ( $colors_palette as $color_data ) {
+				$color = sanitize_hex_color( $color_data['color'] );
+
+				if ( $type === 'acf' ) {
+					self::$colors_palettes[$type][] = $color;
+				} elseif ( $type === 'tinymce' ) {
+					self::$colors_palettes[$type] .= sprintf(
+						'"%s", "%s",',
+						str_replace( '#', '', $color ),
+						esc_attr( $color_data['name'] )
+					);
+				}
+			}
+		}
+
+		return apply_filters( 'chisel_' . $type . '_colors_palette', self::$colors_palettes[$type] );
+	}
+
 	/**
 	 * Get logo data for the wp login page.
 	 *
@@ -195,7 +155,7 @@ class Helpers {
 			$logo_data = wp_get_attachment_image_src( $logo_id, 'medium' );
 		} else {
 			$logo_data = array(
-				self::get_image_url( 'chisel.png' ),
+				ImageHelpers::get_image_url( 'chisel.png' ),
 				84,
 				84,
 				0,

package/lib/commands/create/creators/app/chisel-starter-theme/inc/Helper/WoocommerceHelpers.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace Chisel\Helper;
+
+/**
+ * Helper functions.
+ *
+ * @package Chisel
+ */
+class WoocommerceHelpers {
+
+	/**
+	 * Check if WooCommerce is active.
+	 *
+	 * @return bool
+	 */
+	public static function is_woocommerce_active() {
+		return class_exists( '\Woocommerce' );
+	}
+
+	/**
+	 * Set the product object. For some reason, products in the loop don’t get the right context by default. Without this, some elements of the listed products would show the same information as the first product in the loop. This function fixes that.
+	 *
+	 * @param object $post The post object.
+	 */
+	public static function timber_set_product( $post ) {
+		global $product;
+
+		if ( is_woocommerce() ) {
+			$product = wc_get_product( $post->ID );
+		}
+	}
+
+	/**
+	 * Get products grid classnames
+	 *
+	 * @param bool $products
+	 * @param bool $has_sidebar
+	 *
+	 * @return string
+	 */
+	public static function get_products_grid_classnames( $products, $has_sidebar ) {
+		$loop_columns = wc_get_loop_prop( 'columns' );
+
+		// Set max columns to 4.
+		if ( $loop_columns > 4 ) {
+			$loop_columns = 4;
+		}
+
+		$columns_data = array(
+			'medium' => $loop_columns,
+			'small'  => $loop_columns > 2 ? $loop_columns - 1 : $loop_columns,
+		);
+
+		$grid_classnames = array(
+			'o-grid',
+			'o-grid--cols-1',
+		);
+
+		if ( $products ) {
+			$grid_classnames[] = 'o-grid--cols-' . $columns_data['small'] . '-small';
+
+			if ( $has_sidebar ) {
+				$grid_classnames[] = 'o-grid--cols-' . $columns_data['small'] . '-medium';
+			} else {
+				$grid_classnames[] = 'o-grid--cols-' . $columns_data['medium'] . '-medium';
+			}
+		}
+
+		return implode( ' ', $grid_classnames );
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/inc/Helper/YoastHelpers.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Chisel\Helper;
+
+/**
+ * Helper functions.
+ *
+ * @package Chisel
+ */
+class YoastHelpers {
+
+	/**
+	 * Check if Gravity Forms plugin is active.
+	 *
+	 * @return bool
+	 */
+	public static function is_yoast_active() {
+		return class_exists( '\WPSEO_Options' );
+	}
+
+	/**
+	 * Display breadcrumbs.
+	 *
+	 * @return html
+	 */
+	public static function breadcrumbs() {
+		if ( ! self::is_yoast_active() ) {
+			return '';
+		}
+
+		if ( is_front_page() ) {
+			return '';
+		}
+
+		return yoast_breadcrumb( '<div class="c-breadcrumbs">', '</div>', false );
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/{classes/interfaces/Instance.php → inc/Interfaces/HooksInterface.php}

@@ -1,18 +1,13 @@
 <?php
 
-namespace Chisel;
+namespace Chisel\Interfaces;
 
 /**
- * Instance Interface
+ * Hooks Interface
  *
  * @package Chisel
  */
-interface Instance {
-
-	/**
-	 * Get the instance of the class.
-	 */
-	public static function get_instance();
+interface HooksInterface {
 
 	/**
 	 * Set class properties.

package/lib/commands/create/creators/app/chisel-starter-theme/inc/Interfaces/InstanceInterface.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Chisel\Interfaces;
+
+/**
+ * Instance Interface
+ *
+ * @package Chisel
+ */
+interface InstanceInterface {
+
+	/**
+	 * Get the instance of the class.
+	 */
+	public static function get_instance();
+}

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

@@ -1,13 +1,19 @@
 <?php
 
-namespace Chisel;
+namespace Chisel\Module;
+
+use Chisel\Interfaces\InstanceInterface;
+use Chisel\Interfaces\HooksInterface;
+use Chisel\Traits\Singleton;
 
 /**
  * ACF related functionalities.
  *
  * @package Chisel
  */
-class AcfSync extends \ACF_Admin_Internal_Post_Type_List implements Instance {
+class AcfSync extends \ACF_Admin_Internal_Post_Type_List implements InstanceInterface, HooksInterface {
+
+	use Singleton;
 
 	/**
 	 * The acf groups post type.
@@ -28,21 +34,21 @@ class AcfSync extends \ACF_Admin_Internal_Post_Type_List implements Instance {
 	 *
 	 * @var null|int
 	 */
-	protected $post_id = null;
+	private $post_id = null;
 
 	/**
 	 * The key of acf field group to sync.
 	 *
 	 * @var null|string
 	 */
-	protected $single_post_key = null;
+	private $single_post_key = null;
 
 	/**
 	 * The acf groups sync page url.
 	 *
 	 * @var string
 	 */
-	protected $sync_page_url = '';
+	private $sync_page_url = '';
 
 	/**
 	 * ACF section current page
@@ -164,7 +170,7 @@ class AcfSync extends \ACF_Admin_Internal_Post_Type_List implements Instance {
 	 *
 	 * @return void
 	 */
-	protected function display_admin_notice() {
+	private function display_admin_notice() {
 		?>
 		<div class="error">
 			<p><?php esc_html_e( 'You have unsynced ACF fields.', 'chisel' ); ?> <a href="<?php echo esc_url( $this->sync_page_url ); ?>"><?php esc_html_e( ' View fields available for sync', 'chisel' ); ?></a></p>
@@ -177,7 +183,7 @@ class AcfSync extends \ACF_Admin_Internal_Post_Type_List implements Instance {
 	 *
 	 * @return void
 	 */
-	protected function display_modal_notice() {
+	private function display_modal_notice() {
 		$url = $this->get_admin_url( '&acfsync=' . $this->single_post_key . '&_wpnonce=' . wp_create_nonce( 'bulk-posts' ) );
 		?>
 		<div class="xfive-acf-sync-modal js-xfive-acf-sync-modal is-open" role="dialog">
@@ -214,17 +220,4 @@ class AcfSync extends \ACF_Admin_Internal_Post_Type_List implements Instance {
 	public static function load_scripts() {
 		return self::get_instance()->post_id && self::get_instance()->single_post_key;
 	}
-
-	/**
-	 * Get the instance of the class.
-	 */
-	public static function get_instance() {
-		static $instance = null;
-
-		if ( null === $instance ) {
-			$instance = new self();
-		}
-
-		return $instance;
-	}
 }