WIP adjust to 2.0 and new setup with PSR7

Author: dbu

.travis.yml

@@ -1,7 +1,6 @@
 language: php
 
 php:
-  - 5.3
   - 5.4
   - 5.5
   - 7.0
@@ -36,11 +35,17 @@ matrix:
       env:
         - SYMFONY_VERSION='2.7.*@dev'
         - FRAMEWORK_EXTRA_VERSION='~3.0'
+    - php: 5.4
+      env:
+        - SYMFONY_VERSION=2.3.*
+        - COMPOSER_FLAGS="--prefer-lowest"
 
 before_script:
   - sh -c 'if [ "$SYMFONY_VERSION" != "" ]; then composer require --dev --no-update symfony/symfony=$SYMFONY_VERSION; fi;'
   - sh -c 'if [ "$FRAMEWORK_EXTRA_VERSION" != "" ]; then composer require --dev --no-update sensio/framework-extra-bundle=$FRAMEWORK_EXTRA_VERSION; fi;'
-  - composer install
+  - if [[ "$TRAVIS_PHP_VERSION" == "5.4" || "$TRAVIS_PHP_VERSION" == "hhvm" ]]; then composer remove "php-http/guzzle6-adapter" --dev --no-update; fi
+  - if [[ "$TRAVIS_PHP_VERSION" == "5.4" || "$TRAVIS_PHP_VERSION" == "hhvm" ]]; then composer require "php-http/guzzle5-adapter" --dev --no-update; fi
+  - composer update $COMPOSER_FLAGS --no-interaction
   - sudo apt-get install python-sphinx enchant
   - sudo pip install -r Resources/doc/requirements.txt
 

CHANGELOG.md

@@ -1,6 +1,16 @@
 Changelog
 =========
 
+2.0.0 (unreleased)
+------------------
+
+* Updated the version of FOSHttpCache to 2.*. See [FOSHttpCache changelog]
+  (https://github.com/FriendsOfSymfony/FOSHttpCache/blob/master/CHANGELOG.md).  
+  Most important, there is no more hard coupling on Guzzle HTTP client. We now
+  use the HTTP adapter. You now need to explicitly specify the adapter you 
+  want, see [installation instructions]
+  (http://foshttpcachebundle.readthedocs.org/en/stable/installation.html)
+
 1.3.2
 -----
 

DependencyInjection/Compiler/LoggerPass.php

@@ -11,11 +11,12 @@
 
 namespace FOS\HttpCacheBundle\DependencyInjection\Compiler;
 
+use FOS\HttpCache\Events;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
- * Attach Symfony2 logger to cache manager
+ * Announce the log listener to the symfony event system
  */
 class LoggerPass implements CompilerPassInterface
 {
@@ -28,10 +29,9 @@ public function process(ContainerBuilder $container)
             return;
         }
 
-        $subscriber = $container->getDefinition('fos_http_cache.event_listener.log')
-            ->setAbstract(false);
-
-        $container->getDefinition('fos_http_cache.cache_manager')
-            ->addMethodCall('addSubscriber', array($subscriber));
+        $container->getDefinition('fos_http_cache.event_listener.log')
+            ->setAbstract(false)
+            ->addTag('kernel.event_subscriber');
+        ;
     }
 }

DependencyInjection/FOSHttpCacheExtension.php

@@ -315,11 +315,6 @@ private function loadCacheTagging(ContainerBuilder $container, XmlFileLoader $lo
         if (!empty($config['rules'])) {
             $this->loadTagRules($container, $config['rules']);
         }
-
-        $tagsHeader = $config['header'];
-        $container->getDefinition($this->getAlias().'.cache_manager')
-            ->addMethodCall('setTagsHeader', array($tagsHeader))
-        ;
     }
 
     private function loadTest(ContainerBuilder $container, XmlFileLoader $loader, array $config)

Resources/config/matcher.xml

@@ -13,11 +13,13 @@
         <service id="fos_http_cache.request_matcher"
                  class="%fos_http_cache.request_matcher.class%"
                  public="false"
+                 abstract="true"
         />
-        
+
         <service id="fos_http_cache.rule_matcher"
                  class="%fos_http_cache.rule_matcher.class%"
                  public="false"
+                 abstract="true"
         >
             <argument/>
             <argument/>

Resources/config/nginx.xml

@@ -16,12 +16,13 @@
             <argument>%fos_http_cache.proxy_client.nginx.purge_location%</argument>
             <argument type="service" id="fos_http_cache.proxy_client.nginx.guzzle_client" on-invalid="ignore"/>
         </service>
-
+<!--
         <service id="fos_http_cache.test.client.nginx"
                  parent="fos_http_cache.test.client.abstract"
                  abstract="true">
             <argument index="0">%fos_http_cache.proxy_client.nginx.base_url%</argument>
         </service>
+-->
     </services>
 
 </container>

Resources/config/test_client.xml

@@ -9,15 +9,18 @@
         <parameter key="fos_http_cache.test.client.curlopt_forbid_reuse" type="constant">CURLOPT_FORBID_REUSE</parameter>
     </parameters>
 
-    <services>
-        <service id="fos_http_cache.test.client.abstract"
-                 class="%fos_http_cache.test.client.class%"
-                 abstract="true">
-            <argument /><!-- base_url -->
+    <!--
+    TODO: how to handle guzzle in future?
+<services>
+    <service id="fos_http_cache.test.client.abstract"
+             class="%fos_http_cache.test.client.class%"
+             abstract="true">
+        <argument />--><!-- base_url --><!--
             <argument type="collection">
                 <argument key="%fos_http_cache.test.client.curlopt_forbid_reuse%">true</argument>
             </argument>
         </service>
     </services>
+    -->
 
 </container>

Resources/config/varnish.xml

@@ -15,13 +15,13 @@
             <argument>%fos_http_cache.proxy_client.varnish.base_url%</argument>
             <argument type="service" id="fos_http_cache.proxy_client.varnish.guzzle_client" on-invalid="ignore"/>
         </service>
-
+<!--
         <service id="fos_http_cache.test.client.varnish"
                  parent="fos_http_cache.test.client.abstract"
                  abstract="true">
             <argument index="0">%fos_http_cache.proxy_client.varnish.base_url%</argument>
         </service>
-
+-->
     </services>
 
 </container>

Resources/doc/index.rst

@@ -1,6 +1,11 @@
 FOSHttpCacheBundle
 ==================
 
+.. note::
+
+    This documentation is for the (upcoming) 2.0 of the library. For the stable
+    1.* version, please refer to the `stable documentation`_.
+
 This is the documentation for the `FOSHttpCacheBundle <https://github.com/FriendsOfSymfony/FOSHttpCacheBundle>`_.
 Use the FOSHttpCacheBundle to:
 
@@ -23,3 +28,5 @@ Contents
 
     testing
     contributing
+
+.. _stable documentation: http://foshttpcachebundle.readthedocs.org/en/stable/

Resources/doc/overview.rst

@@ -8,7 +8,19 @@ This bundle is available on Packagist_. You can install it using Composer:
 
 .. code-block:: bash
 
-    $ composer require friendsofsymfony/http-cache-bundle:~1.0
+    $ composer require friendsofsymfony/http-cache-bundle
+
+Note that the FOSHttpCache_ library needs a ``psr/http-message-implementation``
+and ``php-http/adapter-implementation``. If your project does not contain one,
+composer will complain that it did not find ``psr/http-message-implementation``.
+
+When on PHP 5.5+, use the following line instead:
+
+.. code-block:: bash
+
+    $ composer require friendsofsymfony/http-cache-bundle:~2.0 guzzlehttp/psr7:^1.0 php-http/guzzle6-adapter:^0.1.0
+
+On PHP 5.4, the ``php-http/guzzle5-adapter:^0.1.0`` works fine.
 
 Then add the bundle to your application:
 

Test/ProxyTestCase.php

@@ -7,6 +7,8 @@
 use FOS\HttpCache\Test\Proxy\ProxyInterface;
 use Guzzle\Http\ClientInterface;
 use Guzzle\Http\Message\Response;
+use Http\Adapter\HttpAdapter;
+use Http\Discovery\MessageFactoryDiscovery;
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
@@ -62,7 +64,7 @@ public static function isCacheMiss()
      * Get HTTP test client for making requests to your application through a
      * live caching proxy
      *
-     * @return ClientInterface
+     * @return HttpAdapter
      */
     protected function getHttpClient()
     {
@@ -72,15 +74,22 @@ protected function getHttpClient()
     /**
      * Get a response from your application through a live caching proxy
      *
-     * @param string $url     Request URL (absolute or relative)
+     * @param string $uri     Request URL (absolute or relative)
      * @param array  $headers Request HTTP headers
      * @param array  $options Request options
      *
      * @return Response
      */
-    protected function getResponse($url, array $headers = array(), $options = array())
+    protected function getResponse($uri, array $headers = array())
     {
-        return $this->getHttpClient()->get($url, $headers, $options)->send();
+        $request = MessageFactoryDiscovery::find()->createRequest(
+            'GET',
+            $uri,
+            '1.1',
+            $headers
+        );
+
+        return $this->getHttpClient()->sendRequest($request);
     }
 
     /**

Tests/Unit/CacheManagerTest.php

@@ -82,6 +82,7 @@ public function testRefreshRoute()
 
     public function testTagResponse()
     {
+        $this->markTestSkipped('TODO refactor to use tag handler');
         $ban = \Mockery::mock('\FOS\HttpCache\ProxyClient\Invalidation\BanInterface');
         $router = \Mockery::mock('\Symfony\Component\Routing\Generator\UrlGeneratorInterface');