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.

src/Spout/Reader/XLSX/Helper/CellValueFormatter.php

@@ -47,22 +47,21 @@ class CellValueFormatter
     /** @var bool Whether date/time values should be returned as PHP objects or be formatted as strings */
     protected $shouldFormatDates;
 
-    /** @var \Box\Spout\Common\Escaper\XLSX Used to unescape XML data */
+    /** @var \Box\Spout\Common\Helper\Escaper\XLSX Used to unescape XML data */
     protected $escaper;
 
     /**
      * @param SharedStringsHelper $sharedStringsHelper Helper to work with shared strings
      * @param StyleHelper $styleHelper Helper to work with styles
      * @param bool $shouldFormatDates Whether date/time values should be returned as PHP objects or be formatted as strings
+     * @param \Box\Spout\Common\Helper\Escaper\XLSX $escaper Used to unescape XML data
      */
-    public function __construct($sharedStringsHelper, $styleHelper, $shouldFormatDates)
+    public function __construct($sharedStringsHelper, $styleHelper, $shouldFormatDates, $escaper)
     {
         $this->sharedStringsHelper = $sharedStringsHelper;
         $this->styleHelper = $styleHelper;
         $this->shouldFormatDates = $shouldFormatDates;
-
-        /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
-        $this->escaper = \Box\Spout\Common\Escaper\XLSX::getInstance();
+        $this->escaper = $escaper;
     }
 
     /**

src/Spout/Reader/XLSX/Helper/SharedStringsCaching/CachingStrategyFactory.php

@@ -1,6 +1,7 @@
 <?php
 
 namespace Box\Spout\Reader\XLSX\Helper\SharedStringsCaching;
+use Box\Spout\Reader\XLSX\Creator\HelperFactory;
 
 /**
  * Class CachingStrategyFactory
@@ -50,44 +51,22 @@ class CachingStrategyFactory
      */
     const MAX_NUM_STRINGS_PER_TEMP_FILE = 10000;
 
-    /** @var CachingStrategyFactory|null Singleton instance */
-    protected static $instance = null;
-
-    /**
-     * Private constructor for singleton
-     */
-    private function __construct()
-    {
-    }
-
-    /**
-     * Returns the singleton instance of the factory
-     *
-     * @return CachingStrategyFactory
-     */
-    public static function getInstance()
-    {
-        if (self::$instance === null) {
-            self::$instance = new CachingStrategyFactory();
-        }
-
-        return self::$instance;
-    }
 
     /**
      * Returns the best caching strategy, given the number of unique shared strings
      * and the amount of memory available.
      *
      * @param int|null $sharedStringsUniqueCount Number of unique shared strings (NULL if unknown)
-     * @param string|void $tempFolder Temporary folder where the temporary files to store shared strings will be stored
+     * @param string $tempFolder Temporary folder where the temporary files to store shared strings will be stored
+     * @param HelperFactory $helperFactory Factory to create helpers
      * @return CachingStrategyInterface The best caching strategy
      */
-    public function getBestCachingStrategy($sharedStringsUniqueCount, $tempFolder = null)
+    public function createBestCachingStrategy($sharedStringsUniqueCount, $tempFolder, $helperFactory)
     {
         if ($this->isInMemoryStrategyUsageSafe($sharedStringsUniqueCount)) {
             return new InMemoryStrategy($sharedStringsUniqueCount);
         } else {
-            return new FileBasedStrategy($tempFolder, self::MAX_NUM_STRINGS_PER_TEMP_FILE);
+            return new FileBasedStrategy($tempFolder, self::MAX_NUM_STRINGS_PER_TEMP_FILE, $helperFactory);
         }
     }
 

src/Spout/Reader/XLSX/Helper/SharedStringsCaching/FileBasedStrategy.php

@@ -5,6 +5,7 @@ namespace Box\Spout\Reader\XLSX\Helper\SharedStringsCaching;
 use Box\Spout\Common\Helper\FileSystemHelper;
 use Box\Spout\Common\Helper\GlobalFunctionsHelper;
 use Box\Spout\Reader\Exception\SharedStringNotFoundException;
+use Box\Spout\Reader\XLSX\Creator\HelperFactory;
 
 /**
  * Class FileBasedStrategy
@@ -51,18 +52,18 @@ class FileBasedStrategy implements CachingStrategyInterface
     protected $inMemoryTempFileContents;
 
     /**
-     * @param string|null $tempFolder Temporary folder where the temporary files to store shared strings will be stored
+     * @param string $tempFolder Temporary folder where the temporary files to store shared strings will be stored
      * @param int $maxNumStringsPerTempFile Maximum number of strings that can be stored in one temp file
+     * @param HelperFactory $helperFactory Factory to create helpers
      */
-    public function __construct($tempFolder, $maxNumStringsPerTempFile)
+    public function __construct($tempFolder, $maxNumStringsPerTempFile, $helperFactory)
     {
-        $rootTempFolder = ($tempFolder) ?: sys_get_temp_dir();
-        $this->fileSystemHelper = new FileSystemHelper($rootTempFolder);
-        $this->tempFolder = $this->fileSystemHelper->createFolder($rootTempFolder, uniqid('sharedstrings'));
+        $this->fileSystemHelper = $helperFactory->createFileSystemHelper($tempFolder);
+        $this->tempFolder = $this->fileSystemHelper->createFolder($tempFolder, uniqid('sharedstrings'));
 
         $this->maxNumStringsPerTempFile = $maxNumStringsPerTempFile;
 
-        $this->globalFunctionsHelper = new GlobalFunctionsHelper();
+        $this->globalFunctionsHelper = $helperFactory->createGlobalFunctionsHelper();
         $this->tempFilePointer = null;
     }
 

src/Spout/Reader/XLSX/Helper/SharedStringsHelper.php

@@ -5,6 +5,8 @@ namespace Box\Spout\Reader\XLSX\Helper;
 use Box\Spout\Common\Exception\IOException;
 use Box\Spout\Reader\Exception\XMLProcessingException;
 use Box\Spout\Reader\Wrapper\XMLReader;
+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\CachingStrategyInterface;
 
@@ -40,17 +42,32 @@ class SharedStringsHelper
     /** @var string Temporary folder where the temporary files to store shared strings will be stored */
     protected $tempFolder;
 
+    /** @var EntityFactory Factory to create entities */
+    protected $entityFactory;
+
+    /** @var HelperFactory $helperFactory Factory to create helpers */
+    protected $helperFactory;
+
+    /** @var CachingStrategyFactory Factory to create shared strings caching strategies */
+    protected $cachingStrategyFactory;
+
     /** @var CachingStrategyInterface The best caching strategy for storing shared strings */
     protected $cachingStrategy;
 
     /**
      * @param string $filePath Path of the XLSX file being read
-     * @param string|null|void $tempFolder Temporary folder where the temporary files to store shared strings will be stored
+     * @param string $tempFolder Temporary folder where the temporary files to store shared strings will be stored
+     * @param EntityFactory $entityFactory Factory to create entities
+     * @param HelperFactory $helperFactory Factory to create helpers
+     * @param CachingStrategyFactory $cachingStrategyFactory Factory to create shared strings caching strategies
      */
-    public function __construct($filePath, $tempFolder = null)
+    public function __construct($filePath, $tempFolder, $entityFactory, $helperFactory, $cachingStrategyFactory)
     {
         $this->filePath = $filePath;
         $this->tempFolder = $tempFolder;
+        $this->entityFactory = $entityFactory;
+        $this->helperFactory = $helperFactory;
+        $this->cachingStrategyFactory = $cachingStrategyFactory;
     }
 
     /**
@@ -61,7 +78,7 @@ class SharedStringsHelper
     public function hasSharedStrings()
     {
         $hasSharedStrings = false;
-        $zip = new \ZipArchive();
+        $zip = $this->entityFactory->createZipArchive();
 
         if ($zip->open($this->filePath) === true) {
             $hasSharedStrings = ($zip->locateName(self::SHARED_STRINGS_XML_FILE_PATH) !== false);
@@ -86,7 +103,7 @@ class SharedStringsHelper
      */
     public function extractSharedStrings()
     {
-        $xmlReader = new XMLReader();
+        $xmlReader = $this->entityFactory->createXMLReader();
         $sharedStringIndex = 0;
 
         if ($xmlReader->openFileInZip($this->filePath, self::SHARED_STRINGS_XML_FILE_PATH) === false) {
@@ -151,8 +168,8 @@ class SharedStringsHelper
      */
     protected function getBestSharedStringsCachingStrategy($sharedStringsUniqueCount)
     {
-        return CachingStrategyFactory::getInstance()
-                ->getBestCachingStrategy($sharedStringsUniqueCount, $this->tempFolder);
+        return $this->cachingStrategyFactory
+                ->createBestCachingStrategy($sharedStringsUniqueCount, $this->tempFolder, $this->helperFactory);
     }
 
     /**

src/Spout/Reader/XLSX/Helper/SheetHelper.php

@@ -3,6 +3,7 @@
 namespace Box\Spout\Reader\XLSX\Helper;
 
 use Box\Spout\Reader\Wrapper\XMLReader;
+use Box\Spout\Reader\XLSX\Creator\EntityFactory;
 use Box\Spout\Reader\XLSX\Sheet;
 
 /**
@@ -33,8 +34,8 @@ class SheetHelper
     /** @var string Path of the XLSX file being read */
     protected $filePath;
 
-    /** @var \Box\Spout\Reader\XLSX\ReaderOptions Reader's current options */
-    protected $options;
+    /** @var \Box\Spout\Common\Manager\OptionsManagerInterface Reader's options manager */
+    protected $optionsManager;
 
     /** @var \Box\Spout\Reader\XLSX\Helper\SharedStringsHelper Helper to work with shared strings */
     protected $sharedStringsHelper;
@@ -42,18 +43,28 @@ class SheetHelper
     /** @var \Box\Spout\Common\Helper\GlobalFunctionsHelper Helper to work with global functions */
     protected $globalFunctionsHelper;
 
+    /** @var EntityFactory Factory to create entities */
+    protected $entityFactory;
+
+    /** @var \Box\Spout\Common\Helper\Escaper\XLSX Used to unescape XML data */
+    protected $escaper;
+
     /**
      * @param string $filePath Path of the XLSX file being read
-     * @param \Box\Spout\Reader\XLSX\ReaderOptions $options Reader's current options
+     * @param \Box\Spout\Common\Manager\OptionsManagerInterface $optionsManager Reader's options manager
      * @param \Box\Spout\Reader\XLSX\Helper\SharedStringsHelper Helper to work with shared strings
      * @param \Box\Spout\Common\Helper\GlobalFunctionsHelper $globalFunctionsHelper
+     * @param \Box\Spout\Common\Helper\Escaper\XLSX $escaper Used to unescape XML data
+     * @param EntityFactory $entityFactory Factory to create entities
      */
-    public function __construct($filePath, $options, $sharedStringsHelper, $globalFunctionsHelper)
+    public function __construct($filePath, $optionsManager, $sharedStringsHelper, $globalFunctionsHelper, $escaper, $entityFactory)
     {
         $this->filePath = $filePath;
-        $this->options = $options;
+        $this->optionsManager = $optionsManager;
         $this->sharedStringsHelper = $sharedStringsHelper;
         $this->globalFunctionsHelper = $globalFunctionsHelper;
+        $this->escaper = $escaper;
+        $this->entityFactory = $entityFactory;
     }
 
     /**
@@ -68,7 +79,8 @@ class SheetHelper
         $sheetIndex = 0;
         $activeSheetIndex = 0; // By default, the first sheet is active
 
-        $xmlReader = new XMLReader();
+        $xmlReader = $this->entityFactory->createXMLReader();
+
         if ($xmlReader->openFileInZip($this->filePath, self::WORKBOOK_XML_FILE_PATH)) {
             while ($xmlReader->read()) {
                 if ($xmlReader->isPositionedOnStartingNode(self::XML_NODE_WORKBOOK_VIEW)) {
@@ -105,17 +117,18 @@ class SheetHelper
     {
         $sheetId = $xmlReaderOnSheetNode->getAttribute(self::XML_ATTRIBUTE_R_ID);
         $escapedSheetName = $xmlReaderOnSheetNode->getAttribute(self::XML_ATTRIBUTE_NAME);
-
-        /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
-        $escaper = \Box\Spout\Common\Escaper\XLSX::getInstance();
-        $sheetName = $escaper->unescape($escapedSheetName);
+        $sheetName = $this->escaper->unescape($escapedSheetName);
 
         $sheetDataXMLFilePath = $this->getSheetDataXMLFilePathForSheetId($sheetId);
 
-        return new Sheet(
-            $this->filePath, $sheetDataXMLFilePath,
-            $sheetIndexZeroBased, $sheetName, $isSheetActive,
-            $this->options, $this->sharedStringsHelper
+        return $this->entityFactory->createSheet(
+            $this->filePath,
+            $sheetDataXMLFilePath,
+            $sheetIndexZeroBased,
+            $sheetName,
+            $isSheetActive,
+            $this->optionsManager,
+            $this->sharedStringsHelper
         );
     }
 
@@ -128,7 +141,7 @@ class SheetHelper
         $sheetDataXMLFilePath = '';
 
         // find the file path of the sheet, by looking at the "workbook.xml.res" file
-        $xmlReader = new XMLReader();
+        $xmlReader = $this->entityFactory->createXMLReader();
         if ($xmlReader->openFileInZip($this->filePath, self::WORKBOOK_XML_RELS_FILE_PATH)) {
             while ($xmlReader->read()) {
                 if ($xmlReader->isPositionedOnStartingNode(self::XML_NODE_RELATIONSHIP)) {

src/Spout/Reader/XLSX/Helper/StyleHelper.php

@@ -2,7 +2,7 @@
 
 namespace Box\Spout\Reader\XLSX\Helper;
 
-use Box\Spout\Reader\Wrapper\XMLReader;
+use Box\Spout\Reader\XLSX\Creator\EntityFactory;
 
 /**
  * Class StyleHelper
@@ -53,6 +53,9 @@ class StyleHelper
     /** @var string Path of the XLSX file being read */
     protected $filePath;
 
+    /** @var EntityFactory Factory to create entities */
+    protected $entityFactory;
+
     /** @var array Array containing the IDs of built-in number formats indicating a date */
     protected $builtinNumFmtIdIndicatingDates;
 
@@ -67,10 +70,12 @@ class StyleHelper
 
     /**
      * @param string $filePath Path of the XLSX file being read
+     * @param EntityFactory $entityFactory Factory to create entities
      */
-    public function __construct($filePath)
+    public function __construct($filePath, $entityFactory)
     {
         $this->filePath = $filePath;
+        $this->entityFactory = $entityFactory;
         $this->builtinNumFmtIdIndicatingDates = array_keys(self::$builtinNumFmtIdToNumFormatMapping);
     }
 
@@ -107,7 +112,7 @@ class StyleHelper
         $this->customNumberFormats = [];
         $this->stylesAttributes = [];
 
-        $xmlReader = new XMLReader();
+        $xmlReader = $this->entityFactory->createXMLReader();
 
         if ($xmlReader->openFileInZip($this->filePath, self::STYLES_XML_FILE_PATH)) {
             while ($xmlReader->read()) {