Refactor readers for better di (#457)

* Refactor readers to get a proper DI

Similar to what was done with writers, readers also needed to be updated to match the new way of doing things.
This commits promotes a better DI (factories, injection through constructors).

* Escapers should not be singletons

Instead, they should be proper object that can be injected where needed.

tests/Spout/Reader/XLSX/Helper/CellValueFormatterTest.php

@@ -2,6 +2,8 @@
 
 namespace Box\Spout\Reader\XLSX\Helper;
 
+use Box\Spout\Common\Helper\Escaper;
+
 /**
  * Class CellValueFormatterTest
  *
@@ -71,7 +73,7 @@ class CellValueFormatterTest extends \PHPUnit_Framework_TestCase
             ->with(123)
             ->will($this->returnValue(true));
 
-        $formatter = new CellValueFormatter(null, $styleHelperMock, false);
+        $formatter = new CellValueFormatter(null, $styleHelperMock, false, new Escaper\XLSX());
         $result = $formatter->extractAndFormatNodeValue($nodeMock);
 
         if ($expectedDateAsString === null) {
@@ -124,7 +126,7 @@ class CellValueFormatterTest extends \PHPUnit_Framework_TestCase
             ->method('shouldFormatNumericValueAsDate')
             ->will($this->returnValue(false));
 
-        $formatter = new CellValueFormatter(null, $styleHelperMock, false);
+        $formatter = new CellValueFormatter(null, $styleHelperMock, false, new Escaper\XLSX());
         $formattedValue = \ReflectionHelper::callMethodOnObject($formatter, 'formatNumericCellValue', $value, 0);
 
         $this->assertEquals($expectedFormattedValue, $formattedValue);
@@ -167,7 +169,7 @@ class CellValueFormatterTest extends \PHPUnit_Framework_TestCase
             ->with(CellValueFormatter::XML_NODE_INLINE_STRING_VALUE)
             ->will($this->returnValue($nodeListMock));
 
-        $formatter = new CellValueFormatter(null, null, false);
+        $formatter = new CellValueFormatter(null, null, false, new Escaper\XLSX());
         $formattedValue = \ReflectionHelper::callMethodOnObject($formatter, 'formatInlineStringCellValue', $nodeMock);
 
         $this->assertEquals($expectedFormattedValue, $formattedValue);

tests/Spout/Reader/XLSX/Helper/SharedStringsCaching/CachingStrategyFactoryTest.php

@@ -1,6 +1,7 @@
 <?php
 
 namespace Box\Spout\Reader\XLSX\Helper\SharedStringsCaching;
+use Box\Spout\Reader\XLSX\Creator\HelperFactory;
 
 /**
  * Class CachingStrategyFactoryTest
@@ -12,7 +13,7 @@ class CachingStrategyFactoryTest extends \PHPUnit_Framework_TestCase
     /**
      * @return array
      */
-    public function dataProviderForTestGetBestCachingStrategy()
+    public function dataProviderForTestCreateBestCachingStrategy()
     {
         return [
             [null, -1, 'FileBasedStrategy'],
@@ -26,14 +27,14 @@ class CachingStrategyFactoryTest extends \PHPUnit_Framework_TestCase
     }
 
     /**
-     * @dataProvider dataProviderForTestGetBestCachingStrategy
+     * @dataProvider dataProviderForTestCreateBestCachingStrategy
      *
      * @param int|null $sharedStringsUniqueCount
      * @param int $memoryLimitInKB
      * @param string $expectedStrategyClassName
      * @return void
      */
-    public function testGetBestCachingStrategy($sharedStringsUniqueCount, $memoryLimitInKB, $expectedStrategyClassName)
+    public function testCreateBestCachingStrategy($sharedStringsUniqueCount, $memoryLimitInKB, $expectedStrategyClassName)
     {
         /** @var CachingStrategyFactory|\PHPUnit_Framework_MockObject_MockObject $factoryStub */
         $factoryStub = $this
@@ -44,15 +45,14 @@ class CachingStrategyFactoryTest extends \PHPUnit_Framework_TestCase
 
         $factoryStub->method('getMemoryLimitInKB')->willReturn($memoryLimitInKB);
 
-        \ReflectionHelper::setStaticValue('\Box\Spout\Reader\XLSX\Helper\SharedStringsCaching\CachingStrategyFactory', 'instance', $factoryStub);
-
-        $strategy = $factoryStub->getBestCachingStrategy($sharedStringsUniqueCount, null);
+        $tempFolder = sys_get_temp_dir();
+        $helperFactory = new HelperFactory($factoryStub);
+        $strategy = $factoryStub->createBestCachingStrategy($sharedStringsUniqueCount, $tempFolder, $helperFactory);
 
         $fullExpectedStrategyClassName = 'Box\Spout\Reader\XLSX\Helper\SharedStringsCaching\\' . $expectedStrategyClassName;
         $this->assertEquals($fullExpectedStrategyClassName, get_class($strategy));
 
         $strategy->clearCache();
-        \ReflectionHelper::reset();
     }
 
     /**

tests/Spout/Reader/XLSX/Helper/SharedStringsHelperTest.php

@@ -2,6 +2,8 @@
 
 namespace Box\Spout\Reader\XLSX\Helper;
 
+use Box\Spout\Reader\XLSX\Creator\EntityFactory;
+use Box\Spout\Reader\XLSX\Creator\HelperFactory;
 use Box\Spout\Reader\XLSX\Helper\SharedStringsCaching\CachingStrategyFactory;
 use Box\Spout\Reader\XLSX\Helper\SharedStringsCaching\FileBasedStrategy;
 use Box\Spout\Reader\XLSX\Helper\SharedStringsCaching\InMemoryStrategy;
@@ -24,8 +26,7 @@ class SharedStringsHelperTest extends \PHPUnit_Framework_TestCase
      */
     public function setUp()
     {
-        $resourcePath = $this->getResourcePath('one_sheet_with_shared_strings.xlsx');
-        $this->sharedStringsHelper = new SharedStringsHelper($resourcePath);
+        $this->sharedStringsHelper = null;
     }
 
     /**
@@ -33,7 +34,26 @@ class SharedStringsHelperTest extends \PHPUnit_Framework_TestCase
      */
     public function tearDown()
     {
-        $this->sharedStringsHelper->cleanup();
+        if ($this->sharedStringsHelper !== null) {
+            $this->sharedStringsHelper->cleanup();
+        }
+    }
+
+    /**
+     * @param string $resourceName
+     * @return SharedStringsHelper
+     */
+    private function createSharedStringsHelper($resourceName = 'one_sheet_with_shared_strings.xlsx')
+    {
+        $resourcePath = $this->getResourcePath($resourceName);
+        $tempFolder = sys_get_temp_dir();
+        $cachingStrategyFactory = new CachingStrategyFactory();
+        $helperFactory = new HelperFactory($cachingStrategyFactory);
+        $entityFactory = new EntityFactory($helperFactory);
+
+        $this->sharedStringsHelper = new SharedStringsHelper($resourcePath, $tempFolder, $entityFactory, $helperFactory, $cachingStrategyFactory);
+
+        return $this->sharedStringsHelper;
     }
 
     /**
@@ -42,8 +62,9 @@ class SharedStringsHelperTest extends \PHPUnit_Framework_TestCase
      */
     public function testGetStringAtIndexShouldThrowExceptionIfStringNotFound()
     {
-        $this->sharedStringsHelper->extractSharedStrings();
-        $this->sharedStringsHelper->getStringAtIndex(PHP_INT_MAX);
+        $sharedStringsHelper = $this->createSharedStringsHelper();
+        $sharedStringsHelper->extractSharedStrings();
+        $sharedStringsHelper->getStringAtIndex(PHP_INT_MAX);
     }
 
     /**
@@ -51,15 +72,16 @@ class SharedStringsHelperTest extends \PHPUnit_Framework_TestCase
      */
     public function testGetStringAtIndexShouldReturnTheCorrectStringIfFound()
     {
-        $this->sharedStringsHelper->extractSharedStrings();
+        $sharedStringsHelper = $this->createSharedStringsHelper();
+        $sharedStringsHelper->extractSharedStrings();
 
-        $sharedString = $this->sharedStringsHelper->getStringAtIndex(0);
+        $sharedString = $sharedStringsHelper->getStringAtIndex(0);
         $this->assertEquals('s1--A1', $sharedString);
 
-        $sharedString = $this->sharedStringsHelper->getStringAtIndex(24);
+        $sharedString = $sharedStringsHelper->getStringAtIndex(24);
         $this->assertEquals('s1--E5', $sharedString);
 
-        $usedCachingStrategy = \ReflectionHelper::getValueOnObject($this->sharedStringsHelper, 'cachingStrategy');
+        $usedCachingStrategy = \ReflectionHelper::getValueOnObject($sharedStringsHelper, 'cachingStrategy');
         $this->assertTrue($usedCachingStrategy instanceof InMemoryStrategy);
     }
 
@@ -68,8 +90,7 @@ class SharedStringsHelperTest extends \PHPUnit_Framework_TestCase
      */
     public function testGetStringAtIndexShouldWorkWithMultilineStrings()
     {
-        $resourcePath = $this->getResourcePath('one_sheet_with_shared_multiline_strings.xlsx');
-        $sharedStringsHelper = new SharedStringsHelper($resourcePath);
+        $sharedStringsHelper = $this->createSharedStringsHelper('one_sheet_with_shared_multiline_strings.xlsx');
 
         $sharedStringsHelper->extractSharedStrings();
 
@@ -78,8 +99,6 @@ class SharedStringsHelperTest extends \PHPUnit_Framework_TestCase
 
         $sharedString = $sharedStringsHelper->getStringAtIndex(24);
         $this->assertEquals("s1\nE5", $sharedString);
-
-        $sharedStringsHelper->cleanup();
     }
 
     /**
@@ -87,15 +106,12 @@ class SharedStringsHelperTest extends \PHPUnit_Framework_TestCase
      */
     public function testGetStringAtIndexShouldWorkWithStringsContainingTextAndHyperlinkInSameCell()
     {
-        $resourcePath = $this->getResourcePath('one_sheet_with_shared_strings_containing_text_and_hyperlink_in_same_cell.xlsx');
-        $sharedStringsHelper = new SharedStringsHelper($resourcePath);
+        $sharedStringsHelper = $this->createSharedStringsHelper('one_sheet_with_shared_strings_containing_text_and_hyperlink_in_same_cell.xlsx');
 
         $sharedStringsHelper->extractSharedStrings();
 
         $sharedString = $sharedStringsHelper->getStringAtIndex(0);
         $this->assertEquals('go to https://github.com please', $sharedString);
-
-        $sharedStringsHelper->cleanup();
     }
 
     /**
@@ -103,15 +119,12 @@ class SharedStringsHelperTest extends \PHPUnit_Framework_TestCase
      */
     public function testGetStringAtIndexShouldNotDoubleDecodeHTMLEntities()
     {
-        $resourcePath = $this->getResourcePath('one_sheet_with_pre_encoded_html_entities.xlsx');
-        $sharedStringsHelper = new SharedStringsHelper($resourcePath);
+        $sharedStringsHelper = $this->createSharedStringsHelper('one_sheet_with_pre_encoded_html_entities.xlsx');
 
         $sharedStringsHelper->extractSharedStrings();
 
         $sharedString = $sharedStringsHelper->getStringAtIndex(0);
         $this->assertEquals('quote: " - ampersand: &', $sharedString);
-
-        $sharedStringsHelper->cleanup();
     }
 
     /**
@@ -123,8 +136,7 @@ class SharedStringsHelperTest extends \PHPUnit_Framework_TestCase
         $originalMemoryLimit = ini_get('memory_limit');
         ini_set('memory_limit', '-1');
 
-        $resourcePath = $this->getResourcePath('sheet_with_lots_of_shared_strings.xlsx');
-        $sharedStringsHelper = new SharedStringsHelper($resourcePath);
+        $sharedStringsHelper = $this->createSharedStringsHelper('sheet_with_lots_of_shared_strings.xlsx');
 
         $sharedStringsHelper->extractSharedStrings();
 
@@ -137,8 +149,6 @@ class SharedStringsHelperTest extends \PHPUnit_Framework_TestCase
         $usedCachingStrategy = \ReflectionHelper::getValueOnObject($sharedStringsHelper, 'cachingStrategy');
         $this->assertTrue($usedCachingStrategy instanceof FileBasedStrategy);
 
-        $sharedStringsHelper->cleanup();
-
         ini_set('memory_limit', $originalMemoryLimit);
     }
 }

tests/Spout/Reader/XLSX/Helper/StyleHelperTest.php

@@ -1,6 +1,9 @@
 <?php
 
 namespace Box\Spout\Reader\XLSX\Helper;
+use Box\Spout\Reader\XLSX\Creator\EntityFactory;
+use Box\Spout\Reader\XLSX\Creator\HelperFactory;
+use Box\Spout\Reader\XLSX\Helper\SharedStringsCaching\CachingStrategyFactory;
 
 /**
  * Class StyleManagerTest
@@ -17,9 +20,11 @@ class StyleHelperTest extends \PHPUnit_Framework_TestCase
      */
     private function getStyleHelperMock($styleAttributes = [], $customNumberFormats = [])
     {
+        $entityFactory = new EntityFactory(new HelperFactory(new CachingStrategyFactory()));
+
         /** @var StyleHelper $styleHelper */
         $styleHelper = $this->getMockBuilder('\Box\Spout\Reader\XLSX\Helper\StyleHelper')
-                            ->setConstructorArgs(['/path/to/file.xlsx'])
+                            ->setConstructorArgs(['/path/to/file.xlsx', $entityFactory])
                             ->setMethods(['getCustomNumberFormats', 'getStylesAttributes'])
                             ->getMock();