Merge remote-tracking branch 'origin/hotfix/inconsistency-default-options'

Author: sandrokeil

CHANGELOG.md

@@ -2,6 +2,27 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
+## 2.0.1 (2016-12-09)
+This release contains **no** BC break.
+
+### Added
+
+* More test cases for iterable return type and `\Iterator` objects
+
+### Deprecated
+
+* Nothing
+
+### Removed
+
+* Nothing
+
+### Fixed
+
+* [#34](https://github.com/sandrokeil/interop-config/issue/34): Inconsistent return type in `defaultOptions()`
+  * `defaultOptions()` method return type is `iterable` but `array` is still valid
+
+
 ## 2.0.0 (2016-12-06)
 To upgrade from version 1.x to version 2.x you have to add the PHP scalar types of the interfaces to your implemented 
 factory methods.

README.md

@@ -38,7 +38,7 @@ You should have coding conventions and you should have config conventions. If no
 
 ## Installation
 
-Installation of this module uses composer. For composer documentation, please refer to
+The suggested installation method is via composer. For composer documentation, please refer to
 [getcomposer.org](http://getcomposer.org/).
 
 Run `composer require sandrokeil/interop-config` to install interop-config. Version `1.x` is for PHP < 7.1 and Version `2.x` is for PHP >= 7.1.

doc/book/intro.md

@@ -36,7 +36,7 @@ You should have coding conventions and you should have config conventions. If no
 `interop-config` is universally applicable! See further documentation for more details.
 
 ## Installation
-Installation of this library uses Composer. For Composer documentation, please refer to
+The suggested installation method is via composer. For composer documentation, please refer to
 [getcomposer.org](http://getcomposer.org/).
 
 Run `composer require sandrokeil/interop-config` to install interop-config.

doc/book/quick-start.md

@@ -39,14 +39,14 @@ class MyAwesomeFactory implements RequiresConfigId
     public function dimensions() : iterable
     {
         return ['vendor-package'];
-    }
-    
-    public function canRetrieveOptions($config, $configId = null) : bool
+    } 
+
+    public function canRetrieveOptions($config, string $configId = null) : bool
     {
         // custom implementation depending on specifications
     }
 
-    public function options($config, $configId = null)
+    public function options($config, string $configId = null)
     {
         // custom implementation depending on specifications
     }

doc/bookdown.json

@@ -1,5 +1,5 @@
 {
-  "title": "interop-config",
+  "title": "interop-config - configurable factories",
   "content": [
     {"getting-started": "book/getting-started/bookdown.json"},
     {"reference": "book/reference/bookdown.json"},
@@ -8,5 +8,5 @@
   "target": "./html",
   "tocDepth": 2,
   "template": "../vendor/tobiju/bookdown-bootswatch-templates/templates/main.php",
-  "copyright": "Copyright (c) 2015-2016 <a href=\"https://sandro-keil.de/\" title=\"I write about topics, advices and trends of web development\">Sandro Keil</a> <br/> Powered by <a href=\"https://github.com/tobiju/bookdown-bootswatch-templates\" title=\"Visit project to generate your own docs\">Bookdown Bootswatch Templates</a>"
+  "copyright": "Visit interop-config on <a href=\"https://github.com/sandrokeil/interop-config\" title=\"interop-config on GitHub\">GitHub</a><br/>Copyright (c) 2015-2016 <a href=\"https://sandro-keil.de/\" title=\"I write about topics, advices and trends of web development\">Sandro Keil</a> <br/> Powered by <a href=\"https://github.com/tobiju/bookdown-bootswatch-templates\" title=\"Visit project to generate your own docs\">Bookdown Bootswatch Templates</a>"
 }

src/ConfigurationTrait.php

@@ -13,6 +13,7 @@
 
 use ArrayAccess;
 use Interop\Config\Exception;
+use Iterator;
 
 /**
  * ConfigurationTrait which retrieves options from configuration, see interface \Interop\Config\RequiresConfig
@@ -42,6 +43,7 @@ abstract public function dimensions(): iterable;
     public function canRetrieveOptions($config, string $configId = null): bool
     {
         $dimensions = $this->dimensions();
+        $dimensions = $dimensions instanceof Iterator ? iterator_to_array($dimensions) : $dimensions;
 
         if ($this instanceof RequiresConfigId) {
             $dimensions[] = $configId;
@@ -82,6 +84,7 @@ public function canRetrieveOptions($config, string $configId = null): bool
     public function options($config, string $configId = null)
     {
         $dimensions = $this->dimensions();
+        $dimensions = $dimensions instanceof Iterator ? iterator_to_array($dimensions) : $dimensions;
 
         if ($this instanceof RequiresConfigId) {
             $dimensions[] = $configId;
@@ -115,7 +118,12 @@ public function options($config, string $configId = null)
         }
 
         if ($this instanceof ProvidesDefaultOptions) {
-            $config = array_replace_recursive($this->defaultOptions(), $config);
+            $options = $this->defaultOptions();
+
+            $config = array_replace_recursive(
+                $options instanceof Iterator ? iterator_to_array($options) : (array)$options,
+                (array)$config
+            );
         }
         return $config;
     }

src/ProvidesDefaultOptions.php

@@ -22,7 +22,7 @@ interface ProvidesDefaultOptions
     /**
      * Returns a list of default options, which are merged in \Interop\Config\RequiresConfig::options()
      *
-     * @return mixed[] List with default options and values, can be nested
+     * @return iterable List with default options and values, can be nested
      */
-    public function defaultOptions(): array;
+    public function defaultOptions(): iterable;
 }