Refactory Writer Styles to match new code organization (#433)

Decomposed old StyleHelper into StyleManager, StyleRegistry and StyleMerger.

tests/Spout/Writer/Common/Manager/Style/StyleManagerTest.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Box\Spout\Writer\Common\Manager\Style;
+
+use Box\Spout\Writer\Common\Creator\Style\StyleBuilder;
+
+/**
+ * Class StyleManagerTest
+ *
+ * @package Box\Spout\Writer\Common\Manager\Style
+ */
+class StyleManagerTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @return StyleManager
+     */
+    private function getStyleManager()
+    {
+        $style = (new StyleBuilder())->build();
+        $styleRegistry = new StyleRegistry($style);
+
+        return new StyleManager($styleRegistry);
+    }
+
+    /**
+     * @return void
+     */
+    public function testApplyExtraStylesIfNeededShouldApplyWrapTextIfCellContainsNewLine()
+    {
+        $style = (new StyleBuilder())->build();
+        $this->assertFalse($style->shouldWrapText());
+
+        $styleManager = $this->getStyleManager();
+        $updatedStyle = $styleManager->applyExtraStylesIfNeeded($style, [12, 'single line', "multi\nlines", null]);
+
+        $this->assertTrue($updatedStyle->shouldWrapText());
+    }
+
+    /**
+     * @return void
+     */
+    public function testApplyExtraStylesIfNeededShouldDoNothingIfWrapTextAlreadyApplied()
+    {
+        $style = (new StyleBuilder())->setShouldWrapText()->build();
+        $this->assertTrue($style->shouldWrapText());
+
+        $styleManager = $this->getStyleManager();
+        $updatedStyle = $styleManager->applyExtraStylesIfNeeded($style, ["multi\nlines"]);
+
+        $this->assertTrue($updatedStyle->shouldWrapText());
+    }
+}

tests/Spout/Writer/Common/Manager/Style/StyleMergerTest.php

@@ -0,0 +1,159 @@
+<?php
+
+namespace Box\Spout\Writer\Common\Manager\Style;
+
+use Box\Spout\Writer\Common\Creator\Style\StyleBuilder;
+use Box\Spout\Writer\Common\Entity\Style\Color;
+use Box\Spout\Writer\Common\Entity\Style\Style;
+
+/**
+ * Class StyleMergerTest
+ *
+ * @package Box\Spout\Writer\Common\Manager\Style
+ */
+class StyleMergerTest extends \PHPUnit_Framework_TestCase
+{
+    /** @var StyleMerger */
+    private $styleMerger;
+
+    /**
+     * @return void
+     */
+    public function setUp()
+    {
+        $this->styleMerger = new StyleMerger();
+    }
+
+    /**
+     * @return void
+     */
+    public function testMergeWithShouldReturnACopy()
+    {
+        $baseStyle = (new StyleBuilder())->build();
+        $currentStyle = (new StyleBuilder())->build();
+        $mergedStyle = $this->styleMerger->merge($currentStyle, $baseStyle);
+
+        $this->assertNotSame($mergedStyle, $currentStyle);
+    }
+
+    /**
+     * @return void
+     */
+    public function testMergeWithShouldMergeSetProperties()
+    {
+        $baseStyle = (new StyleBuilder())
+                        ->setFontSize(99)
+                        ->setFontBold()
+                        ->setFontColor(Color::YELLOW)
+                        ->setBackgroundColor(Color::BLUE)
+                        ->build();
+        $currentStyle = (new StyleBuilder())->setFontName('Font')->setFontUnderline()->build();
+        $mergedStyle = $this->styleMerger->merge($currentStyle, $baseStyle);
+
+        $this->assertNotEquals(99, $currentStyle->getFontSize());
+        $this->assertFalse($currentStyle->isFontBold());
+        $this->assertEquals(Style::DEFAULT_FONT_COLOR, $currentStyle->getFontColor());
+        $this->assertEquals(null, $currentStyle->getBackgroundColor());
+
+        $this->assertEquals(99, $mergedStyle->getFontSize());
+        $this->assertTrue($mergedStyle->isFontBold());
+        $this->assertEquals('Font', $mergedStyle->getFontName());
+        $this->assertTrue($mergedStyle->isFontUnderline());
+        $this->assertEquals(Color::YELLOW, $mergedStyle->getFontColor());
+        $this->assertEquals(Color::BLUE, $mergedStyle->getBackgroundColor());
+    }
+
+    /**
+     * @return void
+     */
+    public function testMergeWithShouldPreferCurrentStylePropertyIfSetOnCurrentAndOnBase()
+    {
+        $baseStyle = (new StyleBuilder())->setFontSize(10)->build();
+        $currentStyle = (new StyleBuilder())->setFontSize(99)->build();
+        $mergedStyle = $this->styleMerger->merge($currentStyle, $baseStyle);
+
+        $this->assertEquals(99, $mergedStyle->getFontSize());
+    }
+
+    /**
+     * @return void
+     */
+    public function testMergeWithShouldPreferCurrentStylePropertyIfSetOnCurrentButNotOnBase()
+    {
+        $baseStyle = (new StyleBuilder())->build();
+        $currentStyle = (new StyleBuilder())
+                            ->setFontItalic()
+                            ->setFontStrikethrough()
+                            ->build();
+
+        $mergedStyle = $this->styleMerger->merge($currentStyle, $baseStyle);
+
+        $this->assertFalse($baseStyle->isFontItalic());
+        $this->assertFalse($baseStyle->isFontStrikethrough());
+
+        $this->assertTrue($mergedStyle->isFontItalic());
+        $this->assertTrue($mergedStyle->isFontStrikethrough());
+    }
+
+    /**
+     * @return void
+     */
+    public function testMergeWithShouldPreferBaseStylePropertyIfSetOnBaseButNotOnCurrent()
+    {
+        $baseStyle = (new StyleBuilder())
+            ->setFontItalic()
+            ->setFontUnderline()
+            ->setFontStrikethrough()
+            ->setShouldWrapText()
+            ->build();
+        $currentStyle = (new StyleBuilder())->build();
+        $mergedStyle = $this->styleMerger->merge($currentStyle, $baseStyle);
+
+        $this->assertFalse($currentStyle->isFontUnderline());
+        $this->assertTrue($mergedStyle->isFontUnderline());
+
+        $this->assertFalse($currentStyle->shouldWrapText());
+        $this->assertTrue($mergedStyle->shouldWrapText());
+    }
+
+    /**
+     * @return void
+     */
+    public function testMergeWithShouldDoNothingIfStylePropertyNotSetOnBaseNorCurrent()
+    {
+        $baseStyle = (new StyleBuilder())->build();
+        $currentStyle = (new StyleBuilder())->build();
+        $mergedStyle = $this->styleMerger->merge($currentStyle, $baseStyle);
+
+        $this->assertSameStyles($baseStyle, $currentStyle);
+        $this->assertSameStyles($currentStyle, $mergedStyle);
+    }
+
+    /**
+     * @return void
+     */
+    public function testMergeWithShouldDoNothingIfStylePropertyNotSetOnCurrentAndIsDefaultValueOnBase()
+    {
+        $baseStyle = (new StyleBuilder())
+            ->setFontName(Style::DEFAULT_FONT_NAME)
+            ->setFontSize(Style::DEFAULT_FONT_SIZE)
+            ->build();
+        $currentStyle = (new StyleBuilder())->build();
+        $mergedStyle = $this->styleMerger->merge($currentStyle, $baseStyle);
+
+        $this->assertSameStyles($currentStyle, $mergedStyle);
+    }
+
+    /**
+     * @param Style $style1
+     * @param Style $style2
+     * @return void
+     */
+    private function assertSameStyles(Style $style1, Style $style2)
+    {
+        $fakeStyle = (new StyleBuilder())->build();
+        $styleRegistry = new StyleRegistry($fakeStyle);
+
+        $this->assertTrue($styleRegistry->serialize($style1) === $styleRegistry->serialize($style2));
+    }
+}

tests/Spout/Writer/Common/Manager/Style/StyleRegistryTest.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace Box\Spout\Writer\Common\Manager\Style;
+
+use Box\Spout\Writer\Common\Creator\Style\BorderBuilder;
+use Box\Spout\Writer\Common\Creator\Style\StyleBuilder;
+use Box\Spout\Writer\Common\Entity\Style\Border;
+use Box\Spout\Writer\Common\Entity\Style\Color;
+use Box\Spout\Writer\Common\Entity\Style\Style;
+
+/**
+ * Class StyleRegistryTest
+ *
+ * @package Box\Spout\Writer\Common\Manager\Style
+ */
+class StyleRegistryTest extends \PHPUnit_Framework_TestCase
+{
+    /** @var Style */
+    private $defaultStyle;
+
+    /** @var StyleRegistry */
+    private $styleRegistry;
+
+    /**
+     * @return void
+     */
+    public function setUp()
+    {
+        $this->defaultStyle = (new StyleBuilder())->build();
+        $this->styleRegistry = new StyleRegistry($this->defaultStyle);
+    }
+
+    /**
+     * @return void
+     */
+    public function testSerializeShouldNotTakeIntoAccountId()
+    {
+        $style1 = (new StyleBuilder())->setFontBold()->build();
+        $style1->setId(1);
+
+        $style2 = (new StyleBuilder())->setFontBold()->build();
+        $style2->setId(2);
+
+        $this->assertEquals($this->styleRegistry->serialize($style1), $this->styleRegistry->serialize($style2));
+    }
+
+    /**
+     * @return void
+     */
+    public function testRegisterStyleShouldUpdateId()
+    {
+        $style1 = (new StyleBuilder())->setFontBold()->build();
+        $style2 = (new StyleBuilder())->setFontUnderline()->build();
+
+        $this->assertEquals(0, $this->defaultStyle->getId(), 'Default style ID should be 0');
+        $this->assertNull($style1->getId());
+        $this->assertNull($style2->getId());
+
+        $registeredStyle1 = $this->styleRegistry->registerStyle($style1);
+        $registeredStyle2 = $this->styleRegistry->registerStyle($style2);
+
+        $this->assertEquals(1, $registeredStyle1->getId());
+        $this->assertEquals(2, $registeredStyle2->getId());
+    }
+
+    /**
+     * @return void
+     */
+    public function testRegisterStyleShouldReuseAlreadyRegisteredStyles()
+    {
+        $style = (new StyleBuilder())->setFontBold()->build();
+
+        $registeredStyle1 = $this->styleRegistry->registerStyle($style);
+        $registeredStyle2 = $this->styleRegistry->registerStyle($style);
+
+        $this->assertEquals(1, $registeredStyle1->getId());
+        $this->assertEquals(1, $registeredStyle2->getId());
+    }
+}