Files
piratepoet/mailpoet/tests/integration/WooCommerce/TransactionalEmails/RendererTest.php
2024-07-29 14:41:43 +02:00

305 lines
12 KiB
PHP

<?php declare(strict_types = 1);
namespace MailPoet\WooCommerce\TransactionalEmails;
use Codeception\Stub;
use MailPoet\Entities\NewsletterEntity;
use MailPoet\Features\FeaturesController;
use MailPoet\Logging\LoggerFactory;
use MailPoet\Newsletter\Editor\LayoutHelper as L;
use MailPoet\Newsletter\NewslettersRepository;
use MailPoet\Newsletter\Renderer\Preprocessor;
use MailPoet\Newsletter\Renderer\Renderer as NewsletterRenderer;
use MailPoet\Newsletter\Sending\SendingQueuesRepository;
use MailPoet\Newsletter\Shortcodes\Shortcodes as NewsletterShortcodes;
use MailPoet\Util\License\Features\CapabilitiesManager;
use MailPoet\WP\Functions as WPFunctions;
use MailPoetVendor\csstidy;
/**
* @group woo
*/
class RendererTest extends \MailPoetTest {
/** @var NewsletterEntity */
private $newsletter;
/** @var NewslettersRepository */
private $newslettersRepository;
public function _before() {
parent::_before();
$this->newsletter = new NewsletterEntity();
$this->newslettersRepository = $this->diContainer->get(NewslettersRepository::class);
$this->newsletter->setSubject('WooCommerce Transactional Email');
$this->newsletter->setType(NewsletterEntity::TYPE_WC_TRANSACTIONAL_EMAIL);
$this->newsletter->setPreheader('');
$this->newsletter->setBody([
'content' => L::col([
L::row([L::col([['type' => 'text', 'text' => 'Some text before heading']])]),
['type' => 'woocommerceHeading'],
L::row([L::col([['type' => 'text', 'text' => 'Some text between heading and content']])]),
['type' => 'woocommerceContent'],
L::row([L::col([['type' => 'text', 'text' => 'Some text after content']])]),
]),
]);
}
public function testGetHTMLBeforeContent() {
$renderer = $this->getRenderer();
$renderer->render($this->newsletter, 'Heading Text');
$html = $renderer->getHTMLBeforeContent();
verify($html)->stringContainsString('Some text before heading');
verify($html)->stringContainsString('Heading Text');
verify($html)->stringContainsString('Some text between heading and content');
verify($html)->stringNotContainsString('Some text after content');
}
public function testGetHTMLAfterContent() {
$renderer = $this->getRenderer();
$renderer->render($this->newsletter, 'Heading Text');
$html = $renderer->getHTMLAfterContent();
verify($html)->stringNotContainsString('Some text before heading');
verify($html)->stringNotContainsString('Heading Text');
verify($html)->stringNotContainsString('Some text between heading and content');
verify($html)->stringContainsString('Some text after content');
}
public function testRenderHeadingTextWhenHeadingBlockMovedToFooter() {
$this->newsletter->setBody([
'content' => L::col([
L::row([L::col([['type' => 'text', 'text' => 'Some text before heading']])]),
L::row([L::col([['type' => 'text', 'text' => 'Some text between heading and content']])]),
['type' => 'woocommerceContent'],
['type' => 'woocommerceHeading'],
L::row([L::col([['type' => 'text', 'text' => 'Some text after content']])]),
]),
]);
$this->newslettersRepository->persist($this->newsletter);
$renderer = $this->getRenderer();
$renderer->render($this->newsletter, 'Heading Text');
$html = $renderer->getHTMLAfterContent();
verify($html)->stringContainsString('Heading Text');
verify($html)->stringContainsString('Some text after content');
}
public function testPrefixCss() {
$renderer = $this->getRenderer(true);
$css = $renderer->enhanceCss('
#some_id {color: black}
.some-class {height: 50px; width: 30px}
h1 {
font-weight:bold;
}
', $this->newsletter);
verify($css)->stringContainsString("#mailpoet_woocommerce_container #some_id {\ncolor:black\n}");
verify($css)->stringContainsString("#mailpoet_woocommerce_container .some-class {\nheight:50px;\nwidth:30px\n}");
verify($css)->stringContainsString("#mailpoet_woocommerce_container h1 {\nfont-weight:700\n}");
}
public function testItReplaceShortcodes() {
$this->newsletter->setBody([
'content' => L::col([
L::row([L::col([['type' => 'text', 'text' => 'Some text before heading']])]),
L::row([L::col([['type' => 'text', 'text' => 'Some text between heading and content']])]),
['type' => 'woocommerceContent'],
['type' => 'woocommerceHeading'],
L::row([L::col([['type' => 'text', 'text' => 'Some text after content']])]),
L::row([L::col([
['type' => 'text', 'text' => '[site:title]'],
['type' => 'text', 'text' => '[site:homepage_url]'],
['type' => 'text', 'text' => '[date:mtext]'],
['type' => 'text', 'text' => '[date:y]'],
])]),
]),
]);
$this->newslettersRepository->persist($this->newsletter);
$renderer = $this->getRenderer();
$renderer->render($this->newsletter, 'Heading Text');
$html = $renderer->getHTMLAfterContent();
/** @var string $blogName - for PHPStan */
$blogName = get_option('blogname');
$siteName = strval($blogName);
verify($html)->stringContainsString($siteName); // [site:title]
/** @var string $home - for PHPStan */
$home = get_option('home');
$siteUrl = strval($home);
verify($html)->stringContainsString($siteUrl); // [site:homepage_url]
verify($html)->stringContainsString(date_i18n('F', WPFunctions::get()->currentTime('timestamp'))); // [date:mtext]
verify($html)->stringContainsString(date_i18n('Y', WPFunctions::get()->currentTime('timestamp'))); // [date:y]
}
public function testItDoesntChangeFontFamilyWhenNotSaveWithFlag() {
$this->newsletter->setBody([
'globalStyles' => [
'woocommerce' => [
'headingFontFamily' => 'Comic Sans MS',
],
],
]);
$css = $this->getWooEmailStyles();
$updatedCss = $this->getRenderer(true)->enhanceCss($css, $this->newsletter);
verify($updatedCss)->stringNotContainsString('Comic Sans MS');
}
public function testItChangesCssForHeadings() {
$this->newsletter->setBody([
'globalStyles' => [
'h1' => [
'fontSize' => '1px',
],
'h2' => [
'fontSize' => '2px',
],
'h3' => [
'fontSize' => '3px',
],
'woocommerce' => [
'headingFontFamily' => 'Comic Sans MS',
'contentHeadingFontColor' => '#aaaaaa',
'isSavedWithUpdatedStyles' => true,
],
],
]);
$css = $this->getWooEmailStyles();
$updatedCss = $this->getRenderer(true)->enhanceCss($css, $this->newsletter);
$h1Styles = $this->getCssDefinitionsForSelector('#mailpoet_woocommerce_container h1', $updatedCss);
verify($h1Styles)->stringContainsString('font-family:Comic Sans MS');
verify($h1Styles)->stringContainsString('font-size:1px');
verify($h1Styles)->stringContainsString('color:#aaaaaa');
$h2Styles = $this->getCssDefinitionsForSelector('#mailpoet_woocommerce_container h2', $updatedCss);
verify($h2Styles)->stringContainsString('font-family:Comic Sans MS');
verify($h2Styles)->stringContainsString('font-size:2px');
verify($h2Styles)->stringContainsString('color:#aaaaaa');
$h3Styles = $this->getCssDefinitionsForSelector('#mailpoet_woocommerce_container h3', $updatedCss);
verify($h3Styles)->stringContainsString('font-family:Comic Sans MS');
verify($h3Styles)->stringContainsString('font-size:3px');
verify($h3Styles)->stringContainsString('color:#aaaaaa');
}
public function testItChangesStylesForWooContent() {
$this->newsletter->setBody([
'globalStyles' => [
'text' => [
'fontFamily' => 'Comic Sans MS',
'fontSize' => '1px',
],
'woocommerce' => [
'isSavedWithUpdatedStyles' => true,
],
],
]);
$css = $this->getWooEmailStyles();
$updatedCss = $this->getRenderer(true)->enhanceCss($css, $this->newsletter);
$contentStyles = $this->getCssDefinitionsForSelector('#mailpoet_woocommerce_container #body_content_inner', $updatedCss);
verify($contentStyles)->stringContainsString('font-family:Comic Sans MS');
verify($contentStyles)->stringContainsString('font-size:1px');
}
public function testItAddCSSForWooHeading() {
$this->newsletter->setBody([
'globalStyles' => [
'woocommerce' => [
'isSavedWithUpdatedStyles' => true,
'headingFontColor' => '#ff0000',
],
],
]);
$css = $this->getWooEmailStyles();
$updatedCss = $this->getRenderer(true)->enhanceCss($css, $this->newsletter);
$headerStyles = $this->getCssDefinitionsForSelector('#mailpoet-woo-email-header', $updatedCss);
verify($headerStyles)->stringContainsString('color: #ff0000 !important');
}
public function testItSetsProperColorForHeadingInHeader() {
$this->newsletter->setBody([
'globalStyles' => [
'woocommerce' => [
'isSavedWithUpdatedStyles' => true,
'headingFontColor' => '#ff0000',
],
],
]);
$css = $this->getWooEmailStyles();
$updatedCss = $this->getRenderer(true)->enhanceCss($css, $this->newsletter);
$headerStyles = $this->getCssDefinitionsForSelector('#mailpoet-woo-email-header', $updatedCss);
verify($headerStyles)->stringContainsString('color: #ff0000 !important');
}
public function testItUpdatesFontFamilyInsideWooContentAndRemovesSeparators() {
$emailContent = '<h1 style="font-family:Arial;">Heading not in Woo</h1><!--WooContent--><p style="font-family:Arial;">Content</p><!--WooContent--><h2 style="font-family:Arial;">Footer not in Woo</h2>';
$this->newsletter->setBody([
'globalStyles' => [
'text' => [
'fontFamily' => 'Verdana',
],
'woocommerce' => [
'isSavedWithUpdatedStyles' => true,
],
],
]);
$renderer = $this->getRenderer(true);
$html = $renderer->updateRenderedContent($this->newsletter, $emailContent);
verify($html)->equals('<h1 style="font-family:Arial;">Heading not in Woo</h1><p style="font-family:Verdana;">Content</p><h2 style="font-family:Arial;">Footer not in Woo</h2>');
}
private function getNewsletterRenderer(): NewsletterRenderer {
$wooPreprocessor = new ContentPreprocessor(Stub::make(
\MailPoet\WooCommerce\TransactionalEmails::class,
[
'getWCEmailSettings' => [
'base_text_color' => '',
'base_color' => '',
],
]
));
return new NewsletterRenderer(
$this->diContainer->get(\MailPoet\Newsletter\Renderer\BodyRenderer::class),
$this->diContainer->get(\MailPoet\EmailEditor\Engine\Renderer\Renderer::class),
new Preprocessor(
$this->diContainer->get(\MailPoet\Newsletter\Renderer\Blocks\AbandonedCartContent::class),
$this->diContainer->get(\MailPoet\Newsletter\Renderer\Blocks\AutomatedLatestContentBlock::class),
$wooPreprocessor,
$this->diContainer->get(\MailPoet\WooCommerce\CouponPreProcessor::class)
),
$this->diContainer->get(\MailPoetVendor\CSS::class),
$this->diContainer->get(WPFunctions::class),
$this->diContainer->get(LoggerFactory::class),
$this->diContainer->get(NewslettersRepository::class),
$this->diContainer->get(SendingQueuesRepository::class),
$this->diContainer->get(FeaturesController::class),
$this->diContainer->get(CapabilitiesManager::class)
);
}
private function getRenderer($useNewsletterDI = false) {
$newsletterRenderer = $useNewsletterDI ? $this->diContainer->get(NewsletterRenderer::class) : $this->getNewsletterRenderer();
return new Renderer(
new csstidy,
$newsletterRenderer,
$this->diContainer->get(NewsletterShortcodes::class)
);
}
private function getWooEmailStyles() {
$wp = $this->diContainer->get(WPFunctions::class);
$wp->updateOption('woocommerce_email_background_color', '#ffffff');
$wp->updateOption('woocommerce_email_body_background_color', '#ffffff');
$wp->updateOption('woocommerce_email_base_color', '#663399');
$wp->updateOption('woocommerce_email_text_color', '#111111');
ob_start();
wc_get_template('emails/email-styles.php');
return ob_get_clean();
}
private function getCssDefinitionsForSelector(string $selector, string $css) {
$pattern = '/' . preg_quote($selector, '/') . '[^}]*\{([^}]*)}/';
if (preg_match($pattern, $css, $matches)) {
return trim($matches[1]);
} else {
return '';
}
}
}