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/Common/Creator/HelperFactory.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Box\Spout\Common\Creator;
+
+use Box\Spout\Common\Helper\EncodingHelper;
+use Box\Spout\Common\Helper\FileSystemHelper;
+use Box\Spout\Common\Helper\GlobalFunctionsHelper;
+
+/**
+ * Class HelperFactory
+ * Factory to create helpers
+ *
+ * @package Box\Spout\Common\Creator
+ */
+class HelperFactory
+{
+    /**
+     * @return GlobalFunctionsHelper
+     */
+    public function createGlobalFunctionsHelper()
+    {
+        return new GlobalFunctionsHelper();
+    }
+
+    /**
+     * @param string $baseFolderPath The path of the base folder where all the I/O can occur
+     * @return FileSystemHelper
+     */
+    public function createFileSystemHelper($baseFolderPath)
+    {
+        return new FileSystemHelper($baseFolderPath);
+    }
+
+    /**
+     * @param GlobalFunctionsHelper $globalFunctionsHelper
+     * @return EncodingHelper
+     */
+    public function createEncodingHelper(GlobalFunctionsHelper $globalFunctionsHelper)
+    {
+        return new EncodingHelper($globalFunctionsHelper);
+    }
+}

src/Spout/Common/Helper/Escaper/CSV.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace Box\Spout\Common\Escaper;
+namespace Box\Spout\Common\Helper\Escaper;
 
 /**
  * Class CSV
  * Provides functions to escape and unescape data for CSV files
  *
- * @package Box\Spout\Common\Escaper
+ * @package Box\Spout\Common\Helper\Escaper
  */
 class CSV implements EscaperInterface
 {

src/Spout/Common/Helper/Escaper/EscaperInterface.php

@@ -1,11 +1,11 @@
 <?php
 
-namespace Box\Spout\Common\Escaper;
+namespace Box\Spout\Common\Helper\Escaper;
 
 /**
  * Interface EscaperInterface
  *
- * @package Box\Spout\Common\Escaper
+ * @package Box\Spout\Common\Helper\Escaper
  */
 interface EscaperInterface
 {

src/Spout/Common/Helper/Escaper/ODS.php

@@ -1,19 +1,15 @@
 <?php
 
-namespace Box\Spout\Common\Escaper;
-
-use Box\Spout\Common\Singleton;
+namespace Box\Spout\Common\Helper\Escaper;
 
 /**
  * Class ODS
  * Provides functions to escape and unescape data for ODS files
  *
- * @package Box\Spout\Common\Escaper
+ * @package Box\Spout\Common\Helper\Escaper
  */
 class ODS implements EscaperInterface
 {
-    use Singleton;
-
     /**
      * Escapes the given string to make it compatible with XLSX
      *

src/Spout/Common/Helper/Escaper/XLSX.php

@@ -1,36 +1,39 @@
 <?php
 
-namespace Box\Spout\Common\Escaper;
-
-use Box\Spout\Common\Singleton;
+namespace Box\Spout\Common\Helper\Escaper;
 
 /**
  * Class XLSX
  * Provides functions to escape and unescape data for XLSX files
  *
- * @package Box\Spout\Common\Escaper
+ * @package Box\Spout\Common\Helper\Escaper
  */
 class XLSX implements EscaperInterface
 {
-    use Singleton;
+    /** @var bool Whether the escaper has already been initialized */
+    private $isAlreadyInitialized = false;
 
     /** @var string Regex pattern to detect control characters that need to be escaped */
-    protected $escapableControlCharactersPattern;
+    private $escapableControlCharactersPattern;
 
     /** @var string[] Map containing control characters to be escaped (key) and their escaped value (value) */
-    protected $controlCharactersEscapingMap;
+    private $controlCharactersEscapingMap;
 
     /** @var string[] Map containing control characters to be escaped (value) and their escaped value (key) */
-    protected $controlCharactersEscapingReverseMap;
+    private $controlCharactersEscapingReverseMap;
 
     /**
-     * Initializes the singleton instance
+     * Initializes the control characters if not already done
      */
-    protected function init()
+    protected function initIfNeeded()
     {
-        $this->escapableControlCharactersPattern = $this->getEscapableControlCharactersPattern();
-        $this->controlCharactersEscapingMap = $this->getControlCharactersEscapingMap();
-        $this->controlCharactersEscapingReverseMap = array_flip($this->controlCharactersEscapingMap);
+        if (!$this->isAlreadyInitialized) {
+            $this->escapableControlCharactersPattern = $this->getEscapableControlCharactersPattern();
+            $this->controlCharactersEscapingMap = $this->getControlCharactersEscapingMap();
+            $this->controlCharactersEscapingReverseMap = array_flip($this->controlCharactersEscapingMap);
+
+            $this->isAlreadyInitialized = true;
+        }
     }
 
     /**
@@ -41,6 +44,8 @@ class XLSX implements EscaperInterface
      */
     public function escape($string)
     {
+        $this->initIfNeeded();
+
         $escapedString = $this->escapeControlCharacters($string);
         // @NOTE: Using ENT_NOQUOTES as only XML entities ('<', '>', '&') need to be encoded.
         //        Single and double quotes can be left as is.
@@ -57,6 +62,8 @@ class XLSX implements EscaperInterface
      */
     public function unescape($string)
     {
+        $this->initIfNeeded();
+
         // ==============
         // =   WARNING  =
         // ==============

src/Spout/Common/Manager/OptionsManagerAbstract.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace Box\Spout\Common\Manager;
+
+/**
+ * Class OptionsManager
+ *
+ * @package Box\Spout\Common\Manager
+ */
+abstract class OptionsManagerAbstract implements OptionsManagerInterface
+{
+    const PREFIX_OPTION = 'OPTION_';
+
+    /** @var string[] List of all supported option names */
+    private $supportedOptions = [];
+
+    /** @var array Associative array [OPTION_NAME => OPTION_VALUE] */
+    private $options = [];
+
+    /**
+     * OptionsManagerAbstract constructor.
+     */
+    public function __construct()
+    {
+        $this->supportedOptions = $this->getSupportedOptions();
+        $this->setDefaultOptions();
+    }
+
+    /**
+     * @return array List of supported options
+     */
+    abstract protected function getSupportedOptions();
+
+    /**
+     * Sets the default options.
+     * To be overriden by child classes
+     *
+     * @return void
+     */
+    abstract protected function setDefaultOptions();
+
+    /**
+     * Sets the given option, if this option is supported.
+     *
+     * @param string $optionName
+     * @param mixed $optionValue
+     * @return void
+     */
+    public function setOption($optionName, $optionValue)
+    {
+        if (in_array($optionName, $this->supportedOptions)) {
+            $this->options[$optionName] = $optionValue;
+        }
+    }
+
+    /**
+     * @param string $optionName
+     * @return mixed|null The set option or NULL if no option with given name found
+     */
+    public function getOption($optionName)
+    {
+        $optionValue = null;
+
+        if (isset($this->options[$optionName])) {
+            $optionValue = $this->options[$optionName];
+        }
+
+        return $optionValue;
+    }
+}

src/Spout/Common/Manager/OptionsManagerInterface.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Box\Spout\Common\Manager;
+
+/**
+ * Interface OptionsManagerInterface
+ *
+ * @package Box\Spout\Common\Manager
+ */
+interface OptionsManagerInterface
+{
+    /**
+     * @param string $optionName
+     * @param mixed $optionValue
+     * @return void
+     */
+    public function setOption($optionName, $optionValue);
+
+    /**
+     * @param string $optionName
+     * @return mixed|null The set option or NULL if no option with given name found
+     */
+    public function getOption($optionName);
+}

src/Spout/Common/Singleton.php

@@ -1,41 +0,0 @@
-<?php
-
-namespace Box\Spout\Common;
-
-/**
- * Class Singleton
- * Defines a class as a singleton.
- *
- * @package Box\Spout\Common
- */
-trait Singleton
-{
-    protected static $instance;
-
-    /**
-     * @return static
-     */
-    final public static function getInstance()
-    {
-        return isset(static::$instance)
-            ? static::$instance
-            : static::$instance = new static;
-    }
-
-    /**
-     * Singleton constructor.
-     */
-    final private function __construct()
-    {
-        $this->init();
-    }
-
-    /**
-     * Initializes the singleton
-     * @return void
-     */
-    protected function init() {}
-
-    final private function __wakeup() {}
-    final private function __clone() {}
-}