Add OptionsResolver::allowUnknownKeys

Author: steevanb

.circleci/config.yml

@@ -36,7 +36,7 @@ jobs:
 
     phpstan:
         docker:
-            - image: php:7.3.6-cli-alpine3.10
+            - image: php:7.2-cli-alpine3.10
         steps:
             - checkout
             - restore_cache:
@@ -48,7 +48,7 @@ jobs:
 
     phpunit:
         docker:
-            - image: php:7.3.6-cli-alpine3.10
+            - image: php:7.2-fpm-alpine3.10
         steps:
             - checkout
             - restore_cache:

README.md

@@ -1,7 +1,7 @@
-[![version](https://img.shields.io/badge/version-1.0.1-green.svg)](https://github.com/steevanb/symfony-options-resolver/tree/1.0.1)
+[![version](https://img.shields.io/badge/version-1.1.0-green.svg)](https://github.com/steevanb/symfony-options-resolver/tree/1.1.0)
 [![doctrine](https://img.shields.io/badge/symfony/options_resolver-^2.6||^3.0||^4.0-blue.svg)](https://github.com/symfony/options-resolver)
 [![php](https://img.shields.io/badge/php-^7.1-blue.svg)](http://www.php.net)
-![Lines](https://img.shields.io/badge/code%20lines-376-green.svg)
+![Lines](https://img.shields.io/badge/code%20lines-454-green.svg)
 ![Total Downloads](https://poser.pugx.org/steevanb/symfony-options-resolver/downloads)
 [![Scrutinizer](https://scrutinizer-ci.com/g/steevanb/symfony-options-resolver/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/steevanb/symfony-options-resolver/)
 
@@ -14,41 +14,51 @@ Add features to Symfony [OptionsResolver](https://github.com/symfony/options-res
 ### Installation
 
 ```bash
-composer require "steevanb/symfony-options-resolver": "^1.0.1"
+composer require "steevanb/symfony-options-resolver": "^1.1.0"
 ```
 
 ### Examples
 
 Define an optional option with a default value:
 ```php
-use steevanb\SymfonyOptionsResolver\OptionsResolver
+use steevanb\SymfonyOptionsResolver\OptionsResolver;
 
 $optionsResolver = new OptionsResolver();
 
 # Configure an optional option 
-$optionsResolver->configureOption('foo', ['string'], ['bar', 'baz'], 'bar');
+$optionsResolver->configureOption('foo', ['string'], 'default', ['default', 'value1', 'value2']);
 
 # Equivalent to call original OptionsResolver methods:
 $optionsResolver
     ->setDefined('foo')
     ->setAllowedTypes('foo', ['string'])
-    ->setAllowedValues('foo', ['bar', 'baz'])
-    ->setDefault('foo', 'bar');
+    ->setDefault('foo', 'default')
+    ->setAllowedValues('foo', ['default', 'value1', 'value2']);
 ```
 
 Define a required option:
 ```php
-use steevanb\SymfonyOptionsResolver\OptionsResolver
+use steevanb\SymfonyOptionsResolver\OptionsResolver;
 
 $optionsResolver = new OptionsResolver();
 
 # Configure a required option 
-$optionsResolver->configureRequiredOption('foo', ['string'], ['bar', 'baz']);
+$optionsResolver->configureRequiredOption('foo', ['string'], ['value1', 'value2']);
 
 # Equivalent to call original OptionsResolver methods:
 $optionsResolver
-    ->setDefined('foo')
+    ->setRequired('foo')
     ->setAllowedTypes('foo', ['string'])
-    ->setAllowedValues('foo', ['bar', 'baz'])
-    ->setRequired('foo');
+    ->setAllowedValues('foo', ['value1', 'value2']);
+```
+
+Allow unknown keys:
+```php
+use steevanb\SymfonyOptionsResolver\OptionsResolver;
+
+# This will not throw an exception because extraKey is not configured
+(new OptionsResolver())
+    ->configureRequiredOption('foo', ['string'], ['value1', 'value2'])
+    ->setAllowUnknownKeys(true)
+    ->resolve(['foo' => 'value1', 'extraKey' => 'extraValue']);
 ```

bin/phpstan

@@ -9,7 +9,7 @@ if [ $(which docker || false) ]; then
         --rm \
         -v ${PROJECT_DIRECTORY}:/var/phpstan:ro \
         -w /var/phpstan \
-        php:7.3.6-cli-alpine3.10 \
+        php:7.2-cli-alpine3.10 \
         /var/phpstan/bin/phpstan
 else
     ./vendor/bin/phpstan analyse --ansi -c phpstan.neon

changelog.md

@@ -1,4 +1,8 @@
-### [1.0.1](../../compare/1.0.0...1.0.1) - 2017-09-30
+### [1.1.0](../../compare/1.0.1...1.1.0) - 2019-12-06
+
+- Add `OptionsResolver::allowUnknownKeys()`
+
+### [1.0.1](../../compare/1.0.0...1.0.1) - 2019-09-30
 
 - `$allowedValues` parameter of `OptionsResolver::confogureOptions()` and `OptionsResolver::configureRequiredOptions()` is now optional.
 - [BC BREAK (should not impact a lot of people since library is not downloaded for now)] Inverse `OptionsResolver::configureOptions()` `$default` and `$allowedValues` parameters order.

src/OptionsResolver.php

@@ -8,6 +8,9 @@
 
 class OptionsResolver extends SymfonyOptionsResolver
 {
+    /** @var bool */
+    protected $allowUnknownKeys = false;
+
     public function configureOption(string $name, array $allowedTypes, $default, array $allowedValues = null): self
     {
         $this
@@ -26,6 +29,22 @@ public function configureRequiredOption(string $name, array $allowedTypes, array
         return $this;
     }
 
+    public function setAllowUnknownKeys(bool $allow): self
+    {
+        $this->allowUnknownKeys = $allow;
+
+        return $this;
+    }
+
+    public function resolve(array $options = [])
+    {
+        if ($this->allowUnknownKeys) {
+            $this->setDefined(array_keys($options));
+        }
+
+        return parent::resolve($options);
+    }
+
     protected function setAllowedTypesAndValues(string $name, array $allowedTypes, array $allowedValues = null): self
     {
         $this

tests/OptionsResolver/AllowUnknownKeysTest.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace steevanb\SymfonyOptionsResolver\Tests\OptionsResolver;
+
+use PHPUnit\Framework\TestCase;
+use steevanb\SymfonyOptionsResolver\OptionsResolver;
+use Symfony\Component\OptionsResolver\Exception\UndefinedOptionsException;
+
+final class AllowUnknownKeysTest extends TestCase
+{
+    public function testDefault(): void
+    {
+        static::expectException(UndefinedOptionsException::class);
+        $this
+            ->createOptionsResolver()
+            ->resolve(['foo' => 'bar', 'extraKey' => 'extraValue']);
+    }
+
+    public function testAllowed(): void
+    {
+        $this
+            ->createOptionsResolver()
+            ->setAllowUnknownKeys(true)
+            ->resolve(['foo' => 'bar', 'extraKey' => 'extraValue']);
+
+        static::addToAssertionCount(1);
+    }
+
+    public function testNotAllowed(): void
+    {
+        static::expectException(UndefinedOptionsException::class);
+        $this
+            ->createOptionsResolver()
+            ->setAllowUnknownKeys(false)
+            ->resolve(['foo' => 'bar', 'extraKey' => 'extraValue']);
+    }
+
+    private function createOptionsResolver(string $defaultValue = null): OptionsResolver
+    {
+        return (new OptionsResolver())
+            ->configureOption('foo', ['string'], $defaultValue, ['bar']);
+    }
+}

…s/OptionsResolverConfigureOptionTest.php …/OptionsResolver/ConfigureOptionTest.phptests/OptionsResolverConfigureOptionTest.php renamed to tests/OptionsResolver/ConfigureOptionTest.php tests/OptionsResolverConfigureOptionTest.php renamed to tests/OptionsResolver/ConfigureOptionTest.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace steevanb\SymfonyOptionsResolver\Tests;
+namespace steevanb\SymfonyOptionsResolver\Tests\OptionsResolver;
 
 use PHPUnit\Framework\TestCase;
 use steevanb\SymfonyOptionsResolver\OptionsResolver;
 use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
 
-final class OptionsResolverConfigureOptionTest extends TestCase
+final class ConfigureOptionTest extends TestCase
 {
     public function testValid(): void
     {

…sResolverConfigureRequiredOptionTest.php …Resolver/ConfigureRequiredOptionTest.phptests/OptionsResolverConfigureRequiredOptionTest.php renamed to tests/OptionsResolver/ConfigureRequiredOptionTest.php tests/OptionsResolverConfigureRequiredOptionTest.php renamed to tests/OptionsResolver/ConfigureRequiredOptionTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace steevanb\SymfonyOptionsResolver\Tests;
+namespace steevanb\SymfonyOptionsResolver\Tests\OptionsResolver;
 
 use PHPUnit\Framework\TestCase;
 use steevanb\SymfonyOptionsResolver\OptionsResolver;
@@ -11,7 +11,7 @@
     Exception\MissingOptionsException
 };
 
-final class OptionsResolverConfigureRequiredOptionTest extends TestCase
+final class ConfigureRequiredOptionTest extends TestCase
 {
     public function testValid(): void
     {