Merge pull request #18 from sandrokeil/develop

Improved interfaces and naming

Author: sandrokeil

CHANGELOG.md

@@ -2,22 +2,31 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
-## 0.3.0 TBD
+## 0.3.0 (2015-10-18)
 
 ### Added
 
-* [#8](https://github.com/sandrokeil/interop-config/issues/8): Introducing HasOptionalOptions Interface
-* [#9](https://github.com/sandrokeil/interop-config/issues/9): Introducing HasDefaultOptions Interface
+* [#9](https://github.com/sandrokeil/interop-config/issues/9): Introducing ProvidesDefaultOptions interface
 * [#13](https://github.com/sandrokeil/interop-config/issues/13): Support for recursive mandatory options check
+* `canRetrieveOptions()` to `ConfigurationTrait` to perform the options check without throwing an exception 
+* `optionsWithFallback()` to `ConfigurationTrait` which uses default options if config can not be retrieved
+* OptionNotFoundException and MandatoryOptionNotFoundException extends OutOfBoundsException instead of RuntimeException
+* Check if retrieved options are an array or an instance of ArrayAccess
 * Benchmark suite
+* Updated documentation
 
 ### Deprecated
 
 * Nothing
 
 ### Removed
 
-* Nothing
+* `HasConfig` interface, was renamed to `RequiresConfig`
+* `HasContainer` interface, was renamed to `RequiresContainerId`
+* `HasMandatoryOptions` interface, was renamed to `RequiresMandatoryOptions`
+* `HasDefaultOptions` interface, was renamed to `ProvidesDefaultOptions`
+* `ObtainsOptions` interface, was merged in `RequiresConfig`
+* `OptionalOptions` interface, can be achieved via `ProvidesDefaultOptions`
 
 ### Fixed
 

README.md

@@ -2,7 +2,9 @@
 
 > You want to configure your factories?
 
-> You want to check automatically for mandatory params?
+> You want to reduce your factory boilerplate code?
+
+> You want to check automatically for mandatory options?
 
 > You want to have an uniform config structure?
 
@@ -24,7 +26,7 @@ and to create configuration files.
 
 > Please join the discussion about the [PSR config proposal](https://github.com/php-fig/fig-standards/pull/620).
 
- * **Well tested.** Besides unit test and continuous integration/inspection this solution is also ~~ready for production use~~.
+ * **Well tested.** Besides unit test and continuous integration/inspection this solution is also ready for production use.
  * **Framework agnostic** This PHP library does not depends on any framework but you can use it with your favourite framework.
  * **Every change is tracked**. Want to know whats new? Take a look at [CHANGELOG.md](https://github.com/sandrokeil/interop-config/blob/master/CHANGELOG.md)
  * **Listen to your ideas.** Have a great idea? Bring your tested pull request or open a new issue. See [CONTRIBUTING.md](CONTRIBUTING.md)
@@ -65,11 +67,11 @@ the logic to retrieve the options from a configuration. See documentation for mo
 
 ```php
 use Interop\Config\ConfigurationTrait;
-use Interop\Config\HasMandatoryOptions;
-use Interop\Config\HasContainerId;
+use Interop\Config\RequiresContainerId;
+use Interop\Config\RequiresMandatoryOptions;
 use Interop\Container\ContainerInterface;
 
-class MyDBALConnectionFactory implements HasMandatoryOptions, HasContainerId
+class MyDBALConnectionFactory implements RequiresContainerId, RequiresMandatoryOptions
 {
     use ConfigurationTrait;
 
@@ -78,7 +80,7 @@ class MyDBALConnectionFactory implements HasMandatoryOptions, HasContainerId
         // get options for doctrine.connection.orm_default
         $options = $this->options($container->get('config'));
 
-        // mandatory options check is automatically done by MandatoryOptionsInterface
+        // mandatory options check is automatically done by RequiresMandatoryOptions
 
         $driverClass = $options['driverClass'];
         $params = $options['params'];
@@ -125,7 +127,7 @@ class MyDBALConnectionFactory implements HasMandatoryOptions, HasContainerId
      */
     public function mandatoryOptions()
     {
-        return ['driverClass', 'params'];
+        return ['params' => ['user', 'password', 'dbname']];
     }
 }
 ```
@@ -139,22 +141,38 @@ Put the following into your composer.json
 
     {
         "require": {
-            "sandrokeil/interop-config": "1.0.x-dev"
+            "sandrokeil/interop-config": "^0.3"
         }
     }
 
 ## Documentation
+For the latest online documentation you can visit [http://sandrokeil.github.io/interop-config/](http://sandrokeil.github.io/interop-config/ "Latest interop-config documentation").
 
 Documentation is [in the doc tree](doc/), and can be compiled using [bookdown](http://bookdown.io) and [Docker](https://www.docker.com/)
 
 ```console
-$ docker run -i -t=false --rm -v $(pwd):/app sandrokeil/bookdown doc/bookdown.json
-$ docker run -i -t=false --rm -p 8080:8080 -v $(pwd):/app php:5.6-cli php -S 0.0.0.0:8080 -t /app/doc/html
+$ docker run -it --rm -v $(pwd):/app sandrokeil/bookdown doc/bookdown.json
+$ docker run -it --rm -p 8080:8080 -v $(pwd):/app php:5.6-cli php -S 0.0.0.0:8080 -t /app/doc/html
 ```
 
 or make sure bookdown is installed globally via composer and `$HOME/.composer/vendor/bin` is on your `$PATH`.
 
 ```console
 $ bookdown doc/bookdown.json
-$ php -S 0.0.0.0:8080 -t doc/html/ # then browse to http://localhost:8080/
+$ php -S 0.0.0.0:8080 -t doc/html/
+```
+
+Then browse to [http://localhost:8080/](http://localhost:8080/)
+
+## Benchmarks
+The benchmarks uses [PHPBench](https://github.com/phpbench/phpbench) and can be started by the following command:
+ 
+```console
+$ ./vendor/bin/phpbench run --report=aggregate
+```
+ 
+ or with Docker
+ 
+```console
+$ docker run --rm -it --volume $(pwd):/app sandrokeil/php:5.6-cli php ./vendor/bin/phpbench run --report=aggregate
 ```

benchmark/HasDefaultOptionsBench.php benchmark/ProvidesDefaultOptionsBench.phpbenchmark/HasDefaultOptionsBench.php renamed to benchmark/ProvidesDefaultOptionsBench.php

@@ -12,9 +12,9 @@
 use InteropTest\Config\TestAsset\ConnectionDefaultOptionsConfiguration;
 
 /**
- * @beforeMethod classSetUp
+ * @BeforeMethods({"classSetUp"})
  */
-class HasDefaultOptions
+class ProvidesDefaultOptions
 {
     private $config;
 
@@ -32,8 +32,8 @@ public function classSetUp()
     /**
      * Retrieve options
      *
-     * @revs 1000
-     * @iterations 10
+     * @Revs(10000)
+     * @Iterations(10)
      */
     public function benchOptions()
     {

benchmark/HasConfigBench.php benchmark/RequiresConfigBench.phpbenchmark/HasConfigBench.php renamed to benchmark/RequiresConfigBench.php

@@ -12,9 +12,9 @@
 use InteropTest\Config\TestAsset\ConnectionConfiguration;
 
 /**
- * @beforeMethod classSetUp
+ * @BeforeMethods({"classSetUp"})
  */
-class HasConfigBench
+class RequiresConfigBench
 {
     private $config;
 
@@ -32,8 +32,8 @@ public function classSetUp()
     /**
      * Retrieve options
      *
-     * @revs 1000
-     * @iterations 10
+     * @Revs(10000)
+     * @Iterations(10)
      */
     public function benchOptions()
     {

benchmark/HasContainerIdBench.php benchmark/RequiresContainerIdBench.phpbenchmark/HasContainerIdBench.php renamed to benchmark/RequiresContainerIdBench.php

@@ -12,9 +12,9 @@
 use InteropTest\Config\TestAsset\ConnectionContainerIdConfiguration;
 
 /**
- * @beforeMethod classSetUp
+ * @BeforeMethods({"classSetUp"})
  */
-class HasContainerId
+class RequiresContainerId
 {
     private $config;
 
@@ -32,8 +32,8 @@ public function classSetUp()
     /**
      * Retrieve options
      *
-     * @revs 1000
-     * @iterations 10
+     * @Revs(10000)
+     * @Iterations(10)
      */
     public function benchOptions()
     {

benchmark/HasMandatoryOptionsBench.php …chmark/RequiresMandatoryOptionsBench.phpbenchmark/HasMandatoryOptionsBench.php renamed to benchmark/RequiresMandatoryOptionsBench.php benchmark/HasMandatoryOptionsBench.php renamed to benchmark/RequiresMandatoryOptionsBench.php

@@ -12,9 +12,9 @@
 use InteropTest\Config\TestAsset\ConnectionMandatoryConfiguration;
 
 /**
- * @beforeMethod classSetUp
+ * @BeforeMethods({"classSetUp"})
  */
-class HasMandatoryOptions
+class RequiresMandatoryOptions
 {
     private $config;
 
@@ -32,8 +32,8 @@ public function classSetUp()
     /**
      * Retrieve options
      *
-     * @revs 1000
-     * @iterations 10
+     * @Revs(10000)
+     * @Iterations(10)
      */
     public function benchOptions()
     {

…/HasMandatoryOptionsContainerIdBench.php …iresMandatoryOptionsContainerIdBench.phpbenchmark/HasMandatoryOptionsContainerIdBench.php renamed to benchmark/RequiresMandatoryOptionsContainerIdBench.php benchmark/HasMandatoryOptionsContainerIdBench.php renamed to benchmark/RequiresMandatoryOptionsContainerIdBench.php

@@ -12,9 +12,9 @@
 use InteropTest\Config\TestAsset\ConnectionMandatoryContainerIdConfiguration;
 
 /**
- * @beforeMethod classSetUp
+ * @BeforeMethods({"classSetUp"})
  */
-class HasMandatoryOptionsContainerId
+class RequiresMandatoryOptionsContainerId
 {
     private $config;
 
@@ -32,8 +32,8 @@ public function classSetUp()
     /**
      * Retrieve options
      *
-     * @revs 1000
-     * @iterations 10
+     * @Revs(10000)
+     * @Iterations(10)
      */
     public function benchOptions()
     {

…toryOptionsRecursiveContainerIdBench.php …toryOptionsRecursiveContainerIdBench.phpbenchmark/HasMandatoryOptionsRecursiveContainerIdBench.php renamed to benchmark/RequiresMandatoryOptionsRecursiveContainerIdBench.php benchmark/HasMandatoryOptionsRecursiveContainerIdBench.php renamed to benchmark/RequiresMandatoryOptionsRecursiveContainerIdBench.php

@@ -12,9 +12,9 @@
 use InteropTest\Config\TestAsset\ConnectionMandatoryRecursiveContainerIdConfiguration;
 
 /**
- * @beforeMethod classSetUp
+ * @BeforeMethods({"classSetUp"})
  */
-class HasMandatoryOptionsRecursiveContainerId
+class RequiresMandatoryOptionsRecursiveContainerId
 {
     private $config;
 
@@ -32,8 +32,8 @@ public function classSetUp()
     /**
      * Retrieve options
      *
-     * @revs 1000
-     * @iterations 10
+     * @Revs(10000)
+     * @Iterations(10)
      */
     public function options()
     {

composer.json

@@ -45,7 +45,8 @@
     "phpunit/phpunit": "~4.8",
     "phpunit/php-invoker": "~1.1",
     "squizlabs/php_codesniffer": "~2.3",
-    "phpbench/phpbench": "dev-master"
+    "phpbench/phpbench": "^0.5",
+    "tobiju/bookdown-bootswatch-templates": "1.0.x-dev"
   },
   "minimum-stability": "dev",
   "prefer-stable": true,
@@ -57,12 +58,14 @@
   },
   "archive": {
     "exclude": [
+      ".coveralls.yml",
+      ".scrutinizer.yml",
+      ".travis.yml",
       "benchmark",
-      "test",
+      "build",
+      "phpbench.json.dist",
       "phpunit.xml*",
-      ".travis.yml",
-      ".scrutinizer.yml",
-      ".coveralls.yml"
+      "test"
     ]
   }
 }