Using the OptionsResolver instead of reimplementing it poorly

Author: dbu

composer.json

@@ -23,7 +23,8 @@
     "require": {
         "php": ">=5.3.3",
         "guzzle/http": "3.*",
-        "symfony/event-dispatcher": "~2.3"
+        "symfony/event-dispatcher": "~2.3",
+        "symfony/options-resolver": "~2.3"
     },
     "require-dev": {
         "guzzle/plugin-mock": "*",

doc/proxy-clients.rst

@@ -90,7 +90,7 @@ Nginx         ✓       ✓
 Symfony Cache ✓       ✓
 ============= ======= ======= =======
 
-.. _proxy-client purge::
+.. _proxy-client purge:
 
 Purge
 ~~~~~
@@ -119,7 +119,8 @@ send any headers that you vary on, such as ``Accept``.
 
 .. include:: includes/custom-headers.rst
 
-.. _proxy-client refresh::
+.. _proxy-client refresh:
+
 Refresh
 ~~~~~~~
 

doc/symfony-cache-configuration.rst

@@ -110,6 +110,7 @@ to overwrite the method to make it public.
   **default**: ``null``
 
 .. _symfony-cache user context:
+
 User Context
 ~~~~~~~~~~~~
 

src/SymfonyCache/PurgeSubscriber.php

@@ -16,6 +16,7 @@
 use Symfony\Component\HttpFoundation\RequestMatcher;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
  * Purge handler for the symfony built-in HttpCache.
@@ -48,20 +49,17 @@ class PurgeSubscriber extends AccessControlledSubscriber
      */
     public function __construct(array $options = array())
     {
-        $extra = array_diff(array_keys($options), array('purge_client_matcher', 'purge_client_ips', 'purge_method'));
-        if (count($extra)) {
-            throw new \InvalidArgumentException(sprintf(
-                'Unsupported purge configuration option(s) "%s"',
-                implode(', ', $extra)
-            ));
-        }
+        $resolver = new OptionsResolver();
+        $resolver->setDefined(array('purge_client_matcher', 'purge_client_ips', 'purge_method'));
+        $resolver->setDefaults(array(
+            'purge_client_matcher' => null,
+            'purge_client_ips' => null,
+            'purge_method' => 'PURGE',
+        ));
 
-        parent::__construct(
-            isset($options['purge_client_matcher']) ? $options['purge_client_matcher'] : null,
-            isset($options['purge_client_ips']) ? $options['purge_client_ips'] : null
-        );
+        $this->options = $resolver->resolve($options);
 
-        $this->options['purge_method'] = isset($options['purge_method']) ? $options['purge_method'] : 'PURGE';
+        parent::__construct($this->options['purge_client_matcher'], $this->options['purge_client_ips']);
     }
 
     /**

src/SymfonyCache/RefreshSubscriber.php

@@ -16,6 +16,7 @@
 use Symfony\Component\HttpFoundation\RequestMatcher;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
  * Refresh handler for the symfony built-in HttpCache.
@@ -43,18 +44,14 @@ class RefreshSubscriber extends AccessControlledSubscriber
      */
     public function __construct(array $options = array())
     {
-        $extra = array_diff(array_keys($options), array('refresh_client_matcher', 'refresh_client_ips'));
-        if (count($extra)) {
-            throw new \InvalidArgumentException(sprintf(
-                'Unsupported refresh configuration option(s) "%s"',
-                implode(', ', $extra)
-            ));
-        }
+        $resolver = new OptionsResolver();
+        $resolver->setDefaults(array(
+            'refresh_client_matcher' => null,
+            'refresh_client_ips' => null,
+        ));
+        $options = $resolver->resolve($options);
 
-        parent::__construct(
-            isset($options['refresh_client_matcher']) ? $options['refresh_client_matcher'] : null,
-            isset($options['refresh_client_ips']) ? $options['refresh_client_ips'] : null
-        );
+        parent::__construct($options['refresh_client_matcher'], $options['refresh_client_ips']);
     }
 
     /**

src/SymfonyCache/UserContextSubscriber.php

@@ -15,6 +15,7 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
  * User context handler for the symfony built-in HttpCache.
@@ -57,32 +58,17 @@ class UserContextSubscriber implements EventSubscriberInterface
      */
     public function __construct(array $options = array())
     {
-        $extra = array_diff(
-            array_keys($options),
-            array(
-                'anonymous_hash',
-                'user_hash_accept_header',
-                'user_hash_header',
-                'user_hash_uri',
-                'user_hash_method',
-                'session_name_prefix',
-            )
-        );
-        if (count($extra)) {
-            throw new \InvalidArgumentException(sprintf(
-                'Unsupported user context configuration option(s) "%s"',
-                implode(', ', $extra)
-            ));
-        }
-
-        $this->options = $options + array(
+        $resolver = new OptionsResolver();
+        $resolver->setDefaults(array(
             'anonymous_hash' => '38015b703d82206ebc01d17a39c727e5',
             'user_hash_accept_header' => 'application/vnd.fos.user-context-hash',
             'user_hash_header' => 'X-User-Context-Hash',
             'user_hash_uri' => '/_fos_user_context_hash',
             'user_hash_method' => 'GET',
             'session_name_prefix' => 'PHPSESSID',
-        );
+        ));
+
+        $this->options = $resolver->resolve($options);
     }
 
     /**

tests/Unit/SymfonyCache/PurgeSubscriberTest.php

@@ -144,7 +144,7 @@ public function testOtherMethod()
 
     /**
      * @expectedException \InvalidArgumentException
-     * @expectedExceptionMessage Unsupported
+     * @expectedExceptionMessage does not exist
      */
     public function testInvalidConfiguration()
     {

tests/Unit/SymfonyCache/RefreshSubscriberTest.php

@@ -120,7 +120,7 @@ public function testNoRefresh()
 
     /**
      * @expectedException \InvalidArgumentException
-     * @expectedExceptionMessage Unsupported
+     * @expectedExceptionMessage does not exist
      */
     public function testInvalidConfiguration()
     {

tests/Unit/SymfonyCache/UserContextSubscriberTest.php

@@ -180,7 +180,7 @@ public function testUserHashUserWithSession($arg, $options)
 
     /**
      * @expectedException \InvalidArgumentException
-     * @expectedExceptionMessage Unsupported
+     * @expectedExceptionMessage does not exist
      */
     public function testInvalidConfiguration()
     {