diff --git a/inc/ThirdParty/Plugins/PageBuilder/Elementor.php b/inc/ThirdParty/Plugins/PageBuilder/Elementor.php index a22454e18e..cf1a836c29 100644 --- a/inc/ThirdParty/Plugins/PageBuilder/Elementor.php +++ b/inc/ThirdParty/Plugins/PageBuilder/Elementor.php @@ -12,404 +12,398 @@ /** * Compatibility file for Elementor plugin */ -class Elementor implements Subscriber_Interface -{ - /** - * WP Rocket options. - * - * @var Options_Data - */ - private $options; - - /** - * WP_Filesystem_Direct instance. - * - * @var \WP_Filesystem_Direct - */ - private $filesystem; - - /** - * Delay JS HTML class. - * - * @var HTML - */ - private $delayjs_html; - - /** - * UsedCSS instance - * - * @var UsedCSS - */ - private $used_css; - - /** - * Handle basic Ajax operations. - * - * @var AjaxHandler - */ - protected $ajax_handler; - - /** - * Constructor - * - * @param Options_Data $options WP Rocket options. - * @param \WP_Filesystem_Direct $filesystem The Filesystem object. - * @param HTML $delayjs_html DelayJS HTML class. - * @param UsedCSS $used_css UsedCSS class. - * @param AjaxHandler $ajax_handler Handle basic Ajax operations. - */ - public function __construct(Options_Data $options, $filesystem, HTML $delayjs_html, UsedCSS $used_css, AjaxHandler $ajax_handler) - { - $this->options = $options; - $this->filesystem = $filesystem; - $this->delayjs_html = $delayjs_html; - $this->used_css = $used_css; - $this->ajax_handler = $ajax_handler; - } - - /** - * Return an array of events that this subscriber wants to listen to. - * - * @return array - */ - public static function get_subscribed_events() - { - if (! defined('ELEMENTOR_VERSION')) { - return []; - } - - return [ - 'wp_rocket_loaded' => 'remove_widget_callback', - 'rocket_exclude_css' => 'exclude_post_css', - 'elementor/core/files/clear_cache' => 'clear_cache', - 'elementor/maintenance_mode/mode_changed' => 'clear_cache', - 'update_option__elementor_global_css' => 'clear_cache', - 'delete_option__elementor_global_css' => 'clear_cache', - 'rocket_buffer' => [ 'add_fix_animation_script', 28 ], - 'rocket_exclude_js' => 'exclude_js', - 'rocket_skip_post_row_actions' => 'remove_rocket_option', - 'rocket_metabox_options_post_types' => 'remove_rocket_option', - 'rocket_skip_admin_bar_cache_purge_option' => [ 'skip_admin_bar_option', 1, 2 ], - 'rocket_submitbox_options_post_types' => 'remove_rocket_option', - 'rocket_skip_admin_bar_clear_used_css_option' => [ 'skip_admin_bar_option', 1, 2 ], - 'rocket_pre_clean_post' => [ 'exclude_post_type_cache_clearing', 10, 2 ], - 'elementor/editor/after_save' => 'clear_related_post_cache', - 'admin_notices' => 'maybe_clear_cache_change_notice', - 'update_post_metadata' => [ 'setup_transient', 10, 5 ], - 'rocket_notice_args' => 'add_clear_action', - 'admin_post_rocket_elementor_clear_usedcss' => 'clear_action', - ]; - } - - /** - * Remove the callback to clear the cache on widget update - * - * @return void - */ - public function remove_widget_callback() - { - remove_filter('widget_update_callback', 'rocket_widget_update_callback'); - } - - /** - * Clear WP Rocket caches when Elementor changes the CSS - * - * @return void - */ - public function clear_cache() - { - if (! $this->elementor_use_external_file()) { - return; - } - - rocket_clean_domain(); - rocket_clean_minify('css'); - } - - /** - * Checks whether elementor is set use external CSS file or not. - * - * @return bool - */ - private function elementor_use_external_file() - { - return 'internal' !== get_option('elementor_css_print_method'); - } - - /** - * Add Fix Elementor Pro animations script. - * - * @since 3.9.2 - * - * @param string $html HTML content. - * - * @return string HTML with Fix Elementor Pro animations script. - */ - public function add_fix_animation_script($html) - { - if (! $this->delayjs_html->is_allowed()) { - return $html; - } - $pattern = '/<\/body*>/i'; - - $fix_elementor_animation_script = $this->filesystem->get_contents(rocket_get_constant('WP_ROCKET_PATH') . 'assets/js/elementor-animation.js'); - - if (false !== $fix_elementor_animation_script) { - $html = preg_replace($pattern, "$0", $html, 1); - } - - return $html; - } - - /** - * Excludes Elementor CSS from minify/combine - * - * @since 3.10.9 - * - * @param array $excluded Array of excluded patterns. - * - * @return array - */ - public function exclude_post_css($excluded): array - { - if (! $this->elementor_use_external_file()) { - return $excluded; - } - - $upload = wp_get_upload_dir(); - $basepath = wp_parse_url($upload['baseurl'], PHP_URL_PATH); - - if (empty($basepath)) { - return $excluded; - } - - $excluded[] = $basepath . '/elementor/css/(.*).css'; - - return $excluded; - } - - /** - * Excludes JS files from minify/combine JS - * - * @since 3.10.9 - * - * @param array $excluded_files Array of excluded patterns. - * - * @return array - */ - public function exclude_js($excluded_files): array - { - if (! $this->options->get('minify_concatenate_js', false)) { - return $excluded_files; - } - - $excluded_files[] = '/wp-includes/js/dist/hooks(.min)?.js'; - - return $excluded_files; - } - - /** - * Remove rocket metabox option from post. - * - * @param array $cpts Custom post type. - * @return array - */ - public function remove_rocket_option(array $cpts): array - { - if (isset($cpts['elementor_library'])) { - unset($cpts['elementor_library']); - } - - return $cpts; - } - - /** - * Remove cache or purge option from elementor template post. - * - * @param boolean $should_skip Should skip rocket option to admin bar. - * @param mixed $post Post object. - * @return boolean - */ - public function skip_admin_bar_option(bool $should_skip, $post): bool - { - if (null === $post) { - return $should_skip; - } - - if ('elementor_library' === $post->post_type) { - return true; - } - - return $should_skip; - } - - /** - * Exclude elementor library post type from cache clearing. - * - * @param mixed $clear_post A preemptive return value. Default null. - * @param Post $post Post Object. - * @return boolean - */ - public function exclude_post_type_cache_clearing($clear_post, $post) - { - if ('elementor_library' === $post->post_type) { - return true; - } - - return $clear_post; - } - - /** - * Clear cache of related posts. - * - * @param integer $post_id Post ID. - * @return void - */ - public function clear_related_post_cache(int $post_id) - { - global $wpdb; - - $template_id = '%' . $wpdb->esc_like($post_id) . '%'; +class Elementor implements Subscriber_Interface { + + /** + * WP Rocket options. + * + * @var Options_Data + */ + private $options; + + /** + * WP_Filesystem_Direct instance. + * + * @var \WP_Filesystem_Direct + */ + private $filesystem; + + /** + * Delay JS HTML class. + * + * @var HTML + */ + private $delayjs_html; + + /** + * UsedCSS instance + * + * @var UsedCSS + */ + private $used_css; + + /** + * Handle basic Ajax operations. + * + * @var AjaxHandler + */ + protected $ajax_handler; + + /** + * Constructor + * + * @param Options_Data $options WP Rocket options. + * @param \WP_Filesystem_Direct $filesystem The Filesystem object. + * @param HTML $delayjs_html DelayJS HTML class. + * @param UsedCSS $used_css UsedCSS class. + * @param AjaxHandler $ajax_handler Handle basic Ajax operations. + */ + public function __construct( Options_Data $options, $filesystem, HTML $delayjs_html, UsedCSS $used_css, AjaxHandler $ajax_handler ) { + $this->options = $options; + $this->filesystem = $filesystem; + $this->delayjs_html = $delayjs_html; + $this->used_css = $used_css; + $this->ajax_handler = $ajax_handler; + } + + /** + * Return an array of events that this subscriber wants to listen to. + * + * @return array + */ + public static function get_subscribed_events() { + if ( ! defined( 'ELEMENTOR_VERSION' ) ) { + return []; + } + + return [ + 'wp_rocket_loaded' => 'remove_widget_callback', + 'rocket_exclude_css' => 'exclude_post_css', + 'elementor/core/files/clear_cache' => 'clear_cache', + 'elementor/maintenance_mode/mode_changed' => 'clear_cache', + 'update_option__elementor_global_css' => 'clear_cache', + 'delete_option__elementor_global_css' => 'clear_cache', + 'rocket_buffer' => [ 'add_fix_animation_script', 28 ], + 'rocket_exclude_js' => 'exclude_js', + 'rocket_skip_post_row_actions' => 'remove_rocket_option', + 'rocket_metabox_options_post_types' => 'remove_rocket_option', + 'rocket_skip_admin_bar_cache_purge_option' => [ 'skip_admin_bar_option', 1, 2 ], + 'rocket_submitbox_options_post_types' => 'remove_rocket_option', + 'rocket_skip_admin_bar_clear_used_css_option' => [ 'skip_admin_bar_option', 1, 2 ], + 'rocket_pre_clean_post' => [ 'exclude_post_type_cache_clearing', 10, 2 ], + 'elementor/editor/after_save' => 'clear_related_post_cache', + 'admin_notices' => 'maybe_clear_cache_change_notice', + 'update_post_metadata' => [ 'setup_transient', 10, 5 ], + 'rocket_notice_args' => 'add_clear_action', + 'admin_post_rocket_elementor_clear_usedcss' => 'clear_action', + ]; + } + + /** + * Remove the callback to clear the cache on widget update + * + * @return void + */ + public function remove_widget_callback() { + remove_filter( 'widget_update_callback', 'rocket_widget_update_callback' ); + } + + /** + * Clear WP Rocket caches when Elementor changes the CSS + * + * @return void + */ + public function clear_cache() { + if ( ! $this->elementor_use_external_file() ) { + return; + } + + rocket_clean_domain(); + rocket_clean_minify( 'css' ); + } + + /** + * Checks whether elementor is set use external CSS file or not. + * + * @return bool + */ + private function elementor_use_external_file() { + return 'internal' !== get_option( 'elementor_css_print_method' ); + } + + /** + * Add Fix Elementor Pro animations script. + * + * @since 3.9.2 + * + * @param string $html HTML content. + * + * @return string HTML with Fix Elementor Pro animations script. + */ + public function add_fix_animation_script( $html ) { + if ( ! $this->delayjs_html->is_allowed() ) { + return $html; + } + $pattern = '/<\/body*>/i'; + + $fix_elementor_animation_script = $this->filesystem->get_contents( rocket_get_constant( 'WP_ROCKET_PATH' ) . 'assets/js/elementor-animation.js' ); + + if ( false !== $fix_elementor_animation_script ) { + $html = preg_replace( $pattern, "$0", $html, 1 ); + } + + return $html; + } + + /** + * Excludes Elementor CSS from minify/combine + * + * @since 3.10.9 + * + * @param array $excluded Array of excluded patterns. + * + * @return array + */ + public function exclude_post_css( $excluded ): array { + if ( ! $this->elementor_use_external_file() ) { + return $excluded; + } + + $upload = wp_get_upload_dir(); + $basepath = wp_parse_url( $upload['baseurl'], PHP_URL_PATH ); + + if ( empty( $basepath ) ) { + return $excluded; + } + + $excluded[] = $basepath . '/elementor/css/(.*).css'; + + return $excluded; + } + + /** + * Excludes JS files from minify/combine JS + * + * @since 3.10.9 + * + * @param array $excluded_files Array of excluded patterns. + * + * @return array + */ + public function exclude_js( $excluded_files ): array { + if ( ! $this->options->get( 'minify_concatenate_js', false ) ) { + return $excluded_files; + } + + $excluded_files[] = '/wp-includes/js/dist/hooks(.min)?.js'; + + return $excluded_files; + } + + /** + * Remove rocket metabox option from post. + * + * @param array $cpts Custom post type. + * @return array + */ + public function remove_rocket_option( array $cpts ): array { + if ( isset( $cpts['elementor_library'] ) ) { + unset( $cpts['elementor_library'] ); + } + + return $cpts; + } + + /** + * Remove cache or purge option from elementor template post. + * + * @param boolean $should_skip Should skip rocket option to admin bar. + * @param mixed $post Post object. + * @return boolean + */ + public function skip_admin_bar_option( bool $should_skip, $post ): bool { + if ( null === $post ) { + return $should_skip; + } + + if ( 'elementor_library' === $post->post_type ) { + return true; + } + + return $should_skip; + } + + /** + * Exclude elementor library post type from cache clearing. + * + * @param mixed $clear_post A preemptive return value. Default null. + * @param Post $post Post Object. + * @return boolean + */ + public function exclude_post_type_cache_clearing( $clear_post, $post ) { + if ( 'elementor_library' === $post->post_type ) { + return true; + } + + return $clear_post; + } + + /** + * Clear cache of related posts. + * + * @param integer $post_id Post ID. + * @return void + */ + public function clear_related_post_cache( int $post_id ) { + global $wpdb; + + $template_id = '%' . $wpdb->esc_like( $post_id ) . '%'; // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching - $results = $wpdb->get_results( - $wpdb->prepare( - "SELECT post_id FROM `$wpdb->postmeta` WHERE `meta_key` = %s AND `meta_value` LIKE %s", - [ '_elementor_data', $template_id ] - ) - ); - - if (! $results) { - return; - } - - foreach ($results as $result) { - if ('publish' !== get_post_status($result->post_id)) { - continue; - } - - rocket_clean_post($result->post_id); - - if (! $this->options->get('remove_unused_css', 0)) { - continue; - } - - $url = get_permalink($result->post_id); - $this->used_css->delete_used_css($url); - } - } - - /** - * Display a notice when clear is needed. - * - * @return void - */ - public function maybe_clear_cache_change_notice() - { - - $boxes = get_user_meta(get_current_user_id(), 'rocket_boxes', true); - - if (in_array(__FUNCTION__, (array) $boxes, true)) { - return; - } - - if (! current_user_can('rocket_manage_options')) { - return; - } - - $notice = get_transient('wpr_elementor_need_purge'); - if (! $notice) { - return; - } - - $args = [ - 'status' => 'warning', - 'dismissible' => '', - 'dismiss_button' => __FUNCTION__, - 'message' => sprintf( - // translators: %1$s = , %2$s = , %3$s = , %4$s = . - __('%1$sWP Rocket:%2$s Your Elementor template was updated. Clear the Used CSS if the layout, design or CSS styles were changed.', 'rocket'), - '', - '', - '' - ), - 'action' => 'elementor_clear_usedcss', - ]; - - rocket_notice_html($args); - } - - /** - * Set up the transient when needed. - * - * @param bool $check Check the filed. - * @param int $object_id Id from the object. - * @param string $meta_key Key from the meta. - * @param string $meta_value Current value from the meta. - * @param string $prev_value Previous value from the meta. - * @return void - */ - public function setup_transient($check, $object_id, $meta_key, $meta_value, $prev_value) - { - if ('_elementor_conditions' !== $meta_key || $meta_value === $prev_value || ! $this->options->get('remove_unused_css', false)) { - return; - } - set_transient('wpr_elementor_need_purge', true); - } - - /** - * Add an action to clear the RUCSS. - * - * @param array $args Arguments to pass to the view. - * @return array - */ - public function add_clear_action($args) - { - - if (! key_exists('action', $args) || 'elementor_clear_usedcss' !== $args['action']) { - return $args; - } - - $params = [ - 'action' => 'rocket_elementor_clear_usedcss', - ]; - - if (! empty($_SERVER['REQUEST_URI'])) { - $referer_url = filter_var(wp_unslash($_SERVER['REQUEST_URI']), FILTER_SANITIZE_URL); - $params['_wp_http_referer'] = rawurlencode($referer_url); - } - $args['action'] = '' . __('Clear Used CSS', 'rocket') . ''; - - return $args; - } - - /** - * Clear the cache and RUCSS. - * - * @return void - */ - public function clear_action() - { - - if (! $this->ajax_handler->validate_referer('rocket_elementor_clear_usedcss', 'rocket_remove_unused_css')) { - wp_nonce_ays(''); - } - - $url = wp_get_referer(); - - if (0 !== strpos($url, 'http')) { - $parse_url = get_rocket_parse_url(untrailingslashit(home_url())); - $url = $parse_url['scheme'] . '://' . $parse_url['host'] . $url; - } - - $this->used_css->clear_url_usedcss($url); - - rocket_clean_domain(); - - $boxes = get_user_meta(get_current_user_id(), 'rocket_boxes', true); - $boxes[] = 'maybe_clear_cache_change_notice'; - update_user_meta(get_current_user_id(), 'rocket_boxes', $boxes); - - $this->ajax_handler->redirect(); - } + $results = $wpdb->get_results( + $wpdb->prepare( + "SELECT post_id FROM `$wpdb->postmeta` WHERE `meta_key` = %s AND `meta_value` LIKE %s", + [ '_elementor_data', $template_id ] + ) + ); + + if ( ! $results ) { + return; + } + + foreach ( $results as $result ) { + if ( 'publish' !== get_post_status( $result->post_id ) ) { + continue; + } + + rocket_clean_post( $result->post_id ); + + if ( ! $this->options->get( 'remove_unused_css', 0 ) ) { + continue; + } + + $url = get_permalink( $result->post_id ); + $this->used_css->delete_used_css( $url ); + } + } + + /** + * Display a notice when clear is needed. + * + * @return void + */ + public function maybe_clear_cache_change_notice() { + + $boxes = get_user_meta( get_current_user_id(), 'rocket_boxes', true ); + + if ( in_array( __FUNCTION__, (array) $boxes, true ) ) { + return; + } + + if ( ! current_user_can( 'rocket_manage_options' ) ) { + return; + } + + $notice = get_transient( 'wpr_elementor_need_purge' ); + if ( ! $notice ) { + return; + } + + $args = [ + 'status' => 'warning', + 'dismissible' => '', + 'dismiss_button' => __FUNCTION__, + 'message' => sprintf( + // translators: %1$s = , %2$s = , %3$s = , %4$s = . + __( '%1$sWP Rocket:%2$s Your Elementor template was updated. Clear the Used CSS if the layout, design or CSS styles were changed.', 'rocket' ), + '', + '', + '' + ), + 'action' => 'elementor_clear_usedcss', + ]; + + rocket_notice_html( $args ); + } + + /** + * Set up the transient when needed. + * + * @param bool $check Check the filed. + * @param int $object_id Id from the object. + * @param string $meta_key Key from the meta. + * @param string $meta_value Current value from the meta. + * @param string $prev_value Previous value from the meta. + * @return void + */ + public function setup_transient( $check, $object_id, $meta_key, $meta_value, $prev_value ) { + if ( '_elementor_conditions' !== $meta_key || $meta_value === $prev_value || ! $this->options->get( 'remove_unused_css', false ) ) { + return; + } + set_transient( 'wpr_elementor_need_purge', true ); + + $boxes = get_user_meta( get_current_user_id(), 'rocket_boxes', true ); + $boxes = array_filter( + $boxes, + function ( $box ) { + return 'maybe_clear_cache_change_notice' !== $box; + } + ); + update_user_meta( get_current_user_id(), 'rocket_boxes', $boxes ); + } + + /** + * Add an action to clear the RUCSS. + * + * @param array $args Arguments to pass to the view. + * @return array + */ + public function add_clear_action( $args ) { + + if ( ! key_exists( 'action', $args ) || 'elementor_clear_usedcss' !== $args['action'] ) { + return $args; + } + + $params = [ + 'action' => 'rocket_elementor_clear_usedcss', + ]; + + if ( ! empty( $_SERVER['REQUEST_URI'] ) ) { + $referer_url = filter_var( wp_unslash( $_SERVER['REQUEST_URI'] ), FILTER_SANITIZE_URL ); + $params['_wp_http_referer'] = rawurlencode( $referer_url ); + } + $args['action'] = '' . __( 'Clear Used CSS', 'rocket' ) . ''; + + return $args; + } + + /** + * Clear the cache and RUCSS. + * + * @return void + */ + public function clear_action() { + + if ( ! $this->ajax_handler->validate_referer( 'rocket_elementor_clear_usedcss', 'rocket_remove_unused_css' ) ) { + wp_nonce_ays( '' ); + return; + } + + $url = wp_get_referer(); + + if ( 0 !== strpos( $url, 'http' ) ) { + $parse_url = get_rocket_parse_url( untrailingslashit( home_url() ) ); + $url = $parse_url['scheme'] . '://' . $parse_url['host'] . $url; + } + + $this->used_css->clear_url_usedcss( $url ); + + rocket_clean_domain(); + + $boxes = get_user_meta( get_current_user_id(), 'rocket_boxes', true ); + $boxes[] = 'maybe_clear_cache_change_notice'; + update_user_meta( get_current_user_id(), 'rocket_boxes', $boxes ); + + $this->ajax_handler->redirect(); + } } diff --git a/tests/Fixtures/inc/ThirdParty/Plugins/PageBuilder/Elementor/addFixAnimationsScript.php b/tests/Fixtures/inc/ThirdParty/Plugins/PageBuilder/Elementor/addFixAnimationsScript.php deleted file mode 100644 index 9d87601823..0000000000 --- a/tests/Fixtures/inc/ThirdParty/Plugins/PageBuilder/Elementor/addFixAnimationsScript.php +++ /dev/null @@ -1,39 +0,0 @@ -{const e=t.getBoundingClientRect();if(e.bottom>=0&&e.top<=window.innerHeight)try{this._animateElement(t)}catch(t){}})}_animateElement(t){const e=JSON.parse(t.dataset.settings),i=e._animation_delay||e.animation_delay||0,n=e[this.animationSettingKeys.find(t=>e[t])];if(\"none\"===n)return void t.classList.remove(\"elementor-invisible\");t.classList.remove(n),this.currentAnimation&&t.classList.remove(this.currentAnimation),this.currentAnimation=n;let s=setTimeout(()=>{t.classList.remove(\"elementor-invisible\"),t.classList.add(\"animated\",n),this._removeAnimationSettings(t,e)},i);window.addEventListener(\"rocket-startLoading\",function(){clearTimeout(s)})}_listAnimationSettingsKeys(t=\"mobile\"){const e=[\"\"];switch(t){case\"mobile\":e.unshift(\"_mobile\");case\"tablet\":e.unshift(\"_tablet\");case\"desktop\":e.unshift(\"_desktop\")}const i=[];return[\"animation\",\"_animation\"].forEach(t=>{e.forEach(e=>{i.push(t+e)})}),i}_removeAnimationSettings(t,e){this._listAnimationSettingsKeys().forEach(t=>delete e[t]),t.dataset.settings=JSON.stringify(e)}static run(){const t=new RocketElementorAnimation;requestAnimationFrame(t._detectAnimations.bind(t))}}document.addEventListener(\"DOMContentLoaded\",RocketElementorAnimation.run);"; - -return [ - 'vfs_dir' => 'wp-content/', - 'structure' => [ - 'wp-content' => [ - 'plugins' => [ - 'wp-rocket' => [ - 'assets'=>[ - 'js'=>[ - 'elementor-animation.js'=>$fix_script - ] - ] - ] - ], - ], - ], - 'test_data' => [ - 'testElementorShouldAddFixAnimationScript' => [ - 'config' => [ - 'delay_js' => 1, - ], - 'html' => 'Sample Page' . - '', - 'expected' => 'Sample Page' . - '', - ], - 'testElementorShouldNotAddFixAnimationScript' => [ - 'config' => [ - 'delay_js' => 0, - ], - 'html' => 'Sample Page' . - '', - 'expected' => 'Sample Page' . - '', - ] - ] -]; diff --git a/tests/Fixtures/inc/ThirdParty/Plugins/PageBuilder/Elementor/maybeClearCacheChangeNotice.php b/tests/Fixtures/inc/ThirdParty/Plugins/PageBuilder/Elementor/maybeClearCacheChangeNotice.php index ff49c99f7c..5849c97878 100644 --- a/tests/Fixtures/inc/ThirdParty/Plugins/PageBuilder/Elementor/maybeClearCacheChangeNotice.php +++ b/tests/Fixtures/inc/ThirdParty/Plugins/PageBuilder/Elementor/maybeClearCacheChangeNotice.php @@ -1,22 +1,32 @@ [ - 'config' => [ - 'boxes' => [], - 'user_id' => 10, - 'can' => true, - 'transient' => true, - 'notice' => true, - ], - 'expected' => [ - 'notice' => [ - 'status' => 'warning', - 'dismissible' => '', - 'dismiss_button' => 'maybe_clear_cache_change_notice', - 'message' => 'WP Rocket: Your Elementor template was updated. Clear the Used CSS if the layout, design or CSS styles were changed.', - 'action' => 'clear_cache', - ] - ] - ], + 'AddScript' => [ + 'config' => [ + 'html' => $input, + 'script' => 'script', + 'is_allowed' => true, + ], + 'expected' => $output_added + ], + 'NotAllowedShouldReturnSame' => [ + 'config' => [ + 'html' => $input, + 'script' => 'script', + 'is_allowed' => false, + ], + 'expected' => $output + ], + 'NoScriptShould' => [ + 'config' => [ + 'html' => $input, + 'script' => false, + 'is_allowed' => true, + ], + 'expected' => $output + ], ]; diff --git a/tests/Fixtures/inc/ThirdParty/Plugins/PageBuilder/Elementor/setupTransient.php b/tests/Fixtures/inc/ThirdParty/Plugins/PageBuilder/Elementor/setupTransient.php index 4338cd31df..286fe922a2 100644 --- a/tests/Fixtures/inc/ThirdParty/Plugins/PageBuilder/Elementor/setupTransient.php +++ b/tests/Fixtures/inc/ThirdParty/Plugins/PageBuilder/Elementor/setupTransient.php @@ -10,7 +10,7 @@ 'remove_unused_css' => true, 'user_id' => 10, 'boxes' => [ - 'maybe_clear_cache_change_notice' => true + 'maybe_clear_cache_change_notice' ], 'change' => true, ], @@ -31,7 +31,7 @@ 'remove_unused_css' => true, 'user_id' => 10, 'boxes' => [ - 'maybe_clear_cache_change_notice' => true + 'maybe_clear_cache_change_notice' ], 'change' => false, ], @@ -39,7 +39,7 @@ 'user_id' => 10, 'transient' => false, 'boxes' => [ - 'maybe_clear_cache_change_notice' => true + 'maybe_clear_cache_change_notice' ] ] ], @@ -53,7 +53,7 @@ 'remove_unused_css' => false, 'user_id' => 10, 'boxes' => [ - 'maybe_clear_cache_change_notice' => true + 'maybe_clear_cache_change_notice' ], 'change' => false, ], @@ -61,7 +61,7 @@ 'user_id' => 10, 'transient' => false, 'boxes' => [ - 'maybe_clear_cache_change_notice' => true + 'maybe_clear_cache_change_notice' ] ] ], @@ -75,7 +75,7 @@ 'remove_unused_css' => true, 'user_id' => 10, 'boxes' => [ - 'maybe_clear_cache_change_notice' => true + 'maybe_clear_cache_change_notice' ], 'change' => false, ], @@ -83,7 +83,7 @@ 'user_id' => 10, 'transient' => false, 'boxes' => [ - 'maybe_clear_cache_change_notice' => true + 'maybe_clear_cache_change_notice' ] ] ], diff --git a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/ElementorTestTrait.php b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/ElementorTestTrait.php new file mode 100644 index 0000000000..db80f1c1dd --- /dev/null +++ b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/ElementorTestTrait.php @@ -0,0 +1,51 @@ +options = Mockery::mock(Options_Data::class); + $this->filesystem = Mockery::mock(WP_Filesystem_Direct::class); + $this->delayjs_html = Mockery::mock(HTML::class); + $this->used_css = Mockery::mock(UsedCSS::class); + $this->ajax_handler = Mockery::mock(AjaxHandler::class); + + $this->elementor = new Elementor($this->options, $this->filesystem, $this->delayjs_html, $this->used_css, $this->ajax_handler); + } +} diff --git a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/addFixAnimationScript.php b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/addFixAnimationScript.php index 472597eb81..f4a5402bb2 100644 --- a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/addFixAnimationScript.php +++ b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/addFixAnimationScript.php @@ -3,6 +3,7 @@ namespace WP_Rocket\Tests\Unit\inc\ThirdParty\Plugins\PageBuilder\Elementor; use Mockery; +use ThirdParty\Plugins\PageBuilder\Elementor\ElementorTestTrait; use WP_Filesystem_Direct; use WP_Rocket\ThirdParty\Plugins\PageBuilder\Elementor; use WP_Rocket\Admin\Options_Data; @@ -18,37 +19,7 @@ */ class Test_addFixAnimationScript extends TestCase { - /** - * @var Options_Data - */ - protected $options; - - protected $filesystem; - - /** - * @var HTML - */ - protected $delayjs_html; - - /** - * @var UsedCSS - */ - protected $used_css; - - /** - * @var Elementor - */ - protected $elementor; - - public function set_up() { - parent::set_up(); - $this->options = Mockery::mock(Options_Data::class); - $this->filesystem = Mockery::mock(WP_Filesystem_Direct::class); - $this->delayjs_html = Mockery::mock(HTML::class); - $this->used_css = Mockery::mock(UsedCSS::class); - - $this->elementor = new Elementor($this->options, $this->filesystem, $this->delayjs_html, $this->used_css); - } + use ElementorTestTrait; /** * @dataProvider configTestData diff --git a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/addFixAnimationsScript.php b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/addFixAnimationsScript.php deleted file mode 100644 index 8c4344a07d..0000000000 --- a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/addFixAnimationsScript.php +++ /dev/null @@ -1,44 +0,0 @@ -delay_js_html = Mockery::mock( HTML::class ); - $this->subscriber = new Elementor( Mockery::mock( Options_Data::class ), $this->filesystem , $this->delay_js_html, Mockery::mock( UsedCSS::class ) ); - } - - public function tearDown() : void { - parent::tearDown(); - } - - /** - * @dataProvider providerTestData - */ - public function testShouldAddFixScript( $config , $html, $expected ) { - $this->delay_js_html->shouldReceive( 'is_allowed' ) - ->once() - ->andReturn( $config[ 'delay_js' ] ); - $this->assertSame( - $expected, - $this->subscriber->add_fix_animation_script( $html ) - ); - } -} diff --git a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/clearCache.php b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/clearCache.php index 342d68bf89..22fc51e064 100644 --- a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/clearCache.php +++ b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/clearCache.php @@ -3,6 +3,7 @@ use Mockery; use Brain\Monkey\Functions; +use ThirdParty\Plugins\PageBuilder\Elementor\ElementorTestTrait; use WP_Rocket\Admin\Options_Data; use WP_Rocket\Engine\Optimization\DelayJS\HTML; use WP_Rocket\Tests\Unit\TestCase; @@ -15,13 +16,7 @@ * @group ThirdParty */ class Test_ClearCache extends TestCase { - private $elementor; - - public function setUp() : void { - parent::setUp(); - - $this->elementor = new Elementor( Mockery::mock( Options_Data::class ), null, Mockery::mock( HTML::class ), Mockery::mock( UsedCSS::class ) ); - } + use ElementorTestTrait; public function testShouldDoNothingWhenNotExternal() { Functions\when( 'get_option' )->justReturn( 'internal' ); diff --git a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/clearRelatedPostCache.php b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/clearRelatedPostCache.php index 6345680970..c3d7d89a1b 100644 --- a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/clearRelatedPostCache.php +++ b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/clearRelatedPostCache.php @@ -3,6 +3,7 @@ use Mockery; use Brain\Monkey\Functions; +use ThirdParty\Plugins\PageBuilder\Elementor\ElementorTestTrait; use WP_Rocket\Tests\Unit\TestCase; use WP_Rocket\Admin\Options_Data; use WP_Rocket\Engine\Optimization\DelayJS\HTML; @@ -15,10 +16,7 @@ * @group HealthCheck */ class Test_ClearRelatedPostCache extends TestCase { - private $elementor; - private $wpdb; - private $options; - private $used_css; + use ElementorTestTrait; public static function setUpBeforeClass(): void { parent::setUpBeforeClass(); @@ -36,9 +34,6 @@ protected function setUp(): void { require_once WP_ROCKET_PLUGIN_ROOT . 'inc/common/purge.php'; } - $this->options = Mockery::mock( Options_Data::class ); - $this->used_css = Mockery::mock( UsedCSS::class ); - $this->elementor = new Elementor( $this->options, null, Mockery::mock( HTML::class ), $this->used_css ); $GLOBALS['wpdb'] = $this->wpdb = new wpdb(); } @@ -64,7 +59,7 @@ public function testShouldDoAsExpected( $config ) { Functions\expect( 'get_post_status' ) ->twice() ->andReturn( $config['post_status'] ); - + foreach ( $config['results'] as $result ) { if ( 'publish' === $config['post_status'] ) { $this->options->shouldReceive( 'get' ) diff --git a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/excludeJs.php b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/excludeJs.php index 1aa9b1434d..10bd714493 100644 --- a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/excludeJs.php +++ b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/excludeJs.php @@ -3,6 +3,7 @@ use Mockery; use Brain\Monkey\Functions; +use ThirdParty\Plugins\PageBuilder\Elementor\ElementorTestTrait; use WP_Rocket\Tests\Unit\TestCase; use WP_Rocket\Admin\Options_Data; use WP_Rocket\Engine\Optimization\DelayJS\HTML; @@ -16,15 +17,7 @@ * @group ThirdParty */ class Test_ExcludeJs extends TestCase { - private $options; - private $elementor; - - public function setUp(): void { - parent::setUp(); - - $this->options = Mockery::mock( Options_Data::class ); - $this->elementor = new Elementor( $this->options, null, Mockery::mock( HTML::class ), Mockery::mock( UsedCSS::class ) ); - } + use ElementorTestTrait; /** * @dataProvider configTestData diff --git a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/excludePostCss.php b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/excludePostCss.php index a747e0eda2..75a9688a67 100644 --- a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/excludePostCss.php +++ b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/excludePostCss.php @@ -3,6 +3,7 @@ use Mockery; use Brain\Monkey\Functions; +use ThirdParty\Plugins\PageBuilder\Elementor\ElementorTestTrait; use WP_Rocket\Admin\Options_Data; use WP_Rocket\Engine\Optimization\DelayJS\HTML; use WP_Rocket\ThirdParty\Plugins\PageBuilder\Elementor; @@ -15,13 +16,11 @@ * @group ThirdParty */ class Test_ExcludePostCss extends TestCase { - private $elementor; + use ElementorTestTrait; + public function setUp(): void { parent::setUp(); - - $this->elementor = new Elementor( Mockery::mock( Options_Data::class ), null, Mockery::mock( HTML::class ), Mockery::mock( UsedCSS::class ) ); - $this->stubWpParseUrl(); } diff --git a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/excludePostTypeCacheClearing.php b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/excludePostTypeCacheClearing.php index 539d974614..f775fdcbbc 100644 --- a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/excludePostTypeCacheClearing.php +++ b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/excludePostTypeCacheClearing.php @@ -3,6 +3,7 @@ use Mockery; use Brain\Monkey\Functions; +use ThirdParty\Plugins\PageBuilder\Elementor\ElementorTestTrait; use WP_Rocket\Admin\Options_Data; use WP_Rocket\Engine\Optimization\DelayJS\HTML; use WP_Rocket\ThirdParty\Plugins\PageBuilder\Elementor; @@ -15,13 +16,7 @@ * @group ThirdParty */ class Test_ExcludePostTypeCacheClearing extends TestCase { - private $elementor; - - public function setUp(): void { - parent::setUp(); - - $this->elementor = new Elementor( Mockery::mock( Options_Data::class ), null, Mockery::mock( HTML::class ), Mockery::mock( UsedCSS::class ) ); - } + use ElementorTestTrait; /** * @dataProvider configTestData diff --git a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/maybeClearCacheChangeNotice.php b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/maybeClearCacheChangeNotice.php index 7ba0d8497f..8197d4b552 100644 --- a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/maybeClearCacheChangeNotice.php +++ b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/maybeClearCacheChangeNotice.php @@ -3,6 +3,7 @@ namespace WP_Rocket\Tests\Unit\inc\ThirdParty\Plugins\PageBuilder\Elementor; use Mockery; +use ThirdParty\Plugins\PageBuilder\Elementor\ElementorTestTrait; use WP_Rocket\ThirdParty\Plugins\PageBuilder\Elementor; use WP_Rocket\Admin\Options_Data; use WP_Rocket\Engine\Optimization\DelayJS\HTML; @@ -17,37 +18,7 @@ */ class Test_maybeClearCacheChangeNotice extends TestCase { - /** - * @var Options_Data - */ - protected $options; - - protected $filesystem; - - /** - * @var HTML - */ - protected $delayjs_html; - - /** - * @var UsedCSS - */ - protected $used_css; - - /** - * @var Elementor - */ - protected $elementor; - - public function set_up() { - parent::set_up(); - $this->options = Mockery::mock(Options_Data::class); - $this->filesystem = null; - $this->delayjs_html = Mockery::mock(HTML::class); - $this->used_css = Mockery::mock(UsedCSS::class); - - $this->elementor = new Elementor($this->options, $this->filesystem, $this->delayjs_html, $this->used_css); - } + use ElementorTestTrait; /** * @dataProvider configTestData diff --git a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/removeRocketOption.php b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/removeRocketOption.php index 64bc4f50b5..b5c5defcf9 100644 --- a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/removeRocketOption.php +++ b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/removeRocketOption.php @@ -3,6 +3,7 @@ namespace WP_Rocket\Tests\Unit\inc\ThirdParty\Plugins\PageBuilder\Elementor; use Mockery; +use ThirdParty\Plugins\PageBuilder\Elementor\ElementorTestTrait; use WP_Rocket\ThirdParty\Plugins\PageBuilder\Elementor; use WP_Rocket\Admin\Options_Data; use WP_Rocket\Engine\Optimization\DelayJS\HTML; @@ -15,40 +16,10 @@ * @covers \WP_Rocket\ThirdParty\Plugins\PageBuilder\Elementor::remove_rocket_option */ class Test_removeRocketOption extends TestCase { + use ElementorTestTrait; - /** - * @var Options_Data - */ - protected $options; - - protected $filesystem; - - /** - * @var HTML - */ - protected $delayjs_html; - - /** - * @var UsedCSS - */ - protected $used_css; - - /** - * @var Elementor - */ - protected $elementor; - - public function set_up() { - parent::set_up(); - $this->options = Mockery::mock(Options_Data::class); - $this->filesystem = null; - $this->delayjs_html = Mockery::mock(HTML::class); - $this->used_css = Mockery::mock(UsedCSS::class); - - $this->elementor = new Elementor($this->options, $this->filesystem, $this->delayjs_html, $this->used_css); - } - /** + /** * @dataProvider configTestData */ public function testShouldReturnAsExpected( $config, $expected ) diff --git a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/removeWidgetCallback.php b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/removeWidgetCallback.php index b2b522686c..3058245925 100644 --- a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/removeWidgetCallback.php +++ b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/removeWidgetCallback.php @@ -3,6 +3,7 @@ namespace WP_Rocket\Tests\Unit\inc\ThirdParty\Plugins\PageBuilder\Elementor; use Mockery; +use ThirdParty\Plugins\PageBuilder\Elementor\ElementorTestTrait; use WP_Rocket\ThirdParty\Plugins\PageBuilder\Elementor; use WP_Rocket\Admin\Options_Data; use WP_Rocket\Engine\Optimization\DelayJS\HTML; @@ -16,37 +17,7 @@ */ class Test_removeWidgetCallback extends TestCase { - /** - * @var Options_Data - */ - protected $options; - - protected $filesystem; - - /** - * @var HTML - */ - protected $delayjs_html; - - /** - * @var UsedCSS - */ - protected $used_css; - - /** - * @var Elementor - */ - protected $elementor; - - public function set_up() { - parent::set_up(); - $this->options = Mockery::mock(Options_Data::class); - $this->filesystem = null; - $this->delayjs_html = Mockery::mock(HTML::class); - $this->used_css = Mockery::mock(UsedCSS::class); - - $this->elementor = new Elementor($this->options, $this->filesystem, $this->delayjs_html, $this->used_css); - } + use ElementorTestTrait; /** * @dataProvider configTestData diff --git a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/setupTransient.php b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/setupTransient.php index 0f2979d88e..f31077c80d 100644 --- a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/setupTransient.php +++ b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/setupTransient.php @@ -3,6 +3,7 @@ namespace WP_Rocket\Tests\Unit\inc\ThirdParty\Plugins\PageBuilder\Elementor; use Mockery; +use ThirdParty\Plugins\PageBuilder\Elementor\ElementorTestTrait; use WP_Rocket\ThirdParty\Plugins\PageBuilder\Elementor; use WP_Rocket\Admin\Options_Data; use WP_Rocket\Engine\Optimization\DelayJS\HTML; @@ -16,37 +17,8 @@ */ class Test_setupTransient extends TestCase { - /** - * @var Options_Data - */ - protected $options; - - protected $filesystem; - - /** - * @var HTML - */ - protected $delayjs_html; - - /** - * @var UsedCSS - */ - protected $used_css; - - /** - * @var Elementor - */ - protected $elementor; - - public function set_up() { - parent::set_up(); - $this->options = Mockery::mock(Options_Data::class); - $this->filesystem = null; - $this->delayjs_html = Mockery::mock(HTML::class); - $this->used_css = Mockery::mock(UsedCSS::class); + use ElementorTestTrait; - $this->elementor = new Elementor($this->options, $this->filesystem, $this->delayjs_html, $this->used_css); - } /** * @dataProvider configTestData diff --git a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/skipAdminBarOption.php b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/skipAdminBarOption.php index ccb9a79b2c..3cccc331f9 100644 --- a/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/skipAdminBarOption.php +++ b/tests/Unit/inc/ThirdParty/Plugins/PageBuilder/Elementor/skipAdminBarOption.php @@ -3,6 +3,7 @@ namespace WP_Rocket\Tests\Unit\inc\ThirdParty\Plugins\PageBuilder\Elementor; use Mockery; +use ThirdParty\Plugins\PageBuilder\Elementor\ElementorTestTrait; use WP_Rocket\ThirdParty\Plugins\PageBuilder\Elementor; use WP_Rocket\Admin\Options_Data; use WP_Rocket\Engine\Optimization\DelayJS\HTML; @@ -16,37 +17,7 @@ */ class Test_skipAdminBarOption extends TestCase { - /** - * @var Options_Data - */ - protected $options; - - protected $filesystem; - - /** - * @var HTML - */ - protected $delayjs_html; - - /** - * @var UsedCSS - */ - protected $used_css; - - /** - * @var Elementor - */ - protected $elementor; - - public function set_up() { - parent::set_up(); - $this->options = Mockery::mock(Options_Data::class); - $this->filesystem = null; - $this->delayjs_html = Mockery::mock(HTML::class); - $this->used_css = Mockery::mock(UsedCSS::class); - - $this->elementor = new Elementor($this->options, $this->filesystem, $this->delayjs_html, $this->used_css); - } + use ElementorTestTrait; /** * @dataProvider configTestData