Remove test bootstrapper and add version to README

Author: jeskew

Makefile

@@ -1,6 +1,9 @@
-test:
+test: clean-tests
 	vendor/bin/phpunit
 
+clean-tests:
+	rm -rf tests/fixtures/cache/*
+
 phpfmt:
 	vendor/bin/phpcbf --standard=PSR2 src/ tests/ build/ \
 	--ignore=tests/fixtures/cache/

README.md

@@ -52,7 +52,10 @@ Sample configuration can be found in the `tests/fixtures` folder for [YAML](http
 
 ## Usage
 
-This bundle exposes an instance of the `Aws\Sdk` object as well as instances of each AWS client object as services to your symfony application
+This bundle exposes an instance of the `Aws\Sdk` object as well as instances of 
+each AWS client object as services to your symfony application. The services
+made available depends on which version of the SDK is installed. In version
+<!-- SDK VERSION -->3.2.0<!-- /SDK VERSION -->, the following services are made available:
 
 <!-- BEGIN SERVICE TABLE -->
 Service | Instance Of

build/ReadMeUpdater.php

@@ -2,6 +2,7 @@
 
 namespace Aws\Symfony;
 
+use Aws\Sdk;
 use Composer\Script\Event;
 use Symfony\Component\DependencyInjection\Container;
 
@@ -14,30 +15,38 @@ class ReadMeUpdater
 
     protected $projectRoot;
 
-    public static function updateReadMe(Event $e)
+    public static function updateReadMeFromComposer(Event $e)
     {
-        (new static(dirname($e->getComposer()->getConfig()->get('vendor-dir'))))
-            ->doUpdateReadMe();
+        $root = dirname($e->getComposer()->getConfig()->get('vendor-dir'));
+
+        require implode(DIRECTORY_SEPARATOR, [$root, 'vendor', 'autoload.php']);
+
+        (new static($root))
+            ->updateReadMe();
     }
 
     public function __construct($projectRoot = '..')
     {
         $this->projectRoot = $projectRoot;
     }
 
-
-    protected function doUpdateReadMe()
+    public function updateReadMe()
     {
         $readMeParts = $this->getReadMeWithoutServicesTable();
         $servicesTable = self::SERVICES_TABLE_START . "\n"
             . $this->getServicesTable()
             . self::SERVICES_TABLE_END;
 
-        $updatedReadMe = implode($servicesTable, $readMeParts);
-        file_put_contents($this->getReadMePath(), $updatedReadMe);
+        file_put_contents(
+            $this->getReadMePath(),
+            $this->replaceSdkVersionNumber(
+                implode($servicesTable, $readMeParts)
+            )
+        );
     }
 
-    protected function getReadMeWithoutServicesTable()
+
+    private function getReadMeWithoutServicesTable()
     {
         $readMe = file_get_contents($this->getReadMePath());
         $tablePattern = '/' . preg_quote(self::SERVICES_TABLE_START)
@@ -46,12 +55,12 @@ protected function getReadMeWithoutServicesTable()
         return preg_split($tablePattern, $readMe, 2);
     }
 
-    protected function getReadMePath()
+    private function getReadMePath()
     {
         return $this->projectRoot . '/README.md';
     }
 
-    protected function getServicesTable()
+    private function getServicesTable()
     {
         $table = "Service | Instance Of\n--- | ---\n";
 
@@ -70,22 +79,32 @@ protected function getServicesTable()
         return $table;
     }
 
-    protected function getAWSServices(Container $container)
+    private function getAWSServices(Container $container)
     {
         return array_filter($container->getServiceIds(), function ($service) {
             return strpos($service, 'aws') === 0;
         });
     }
 
+    private function replaceSdkVersionNumber($readMeText)
+    {
+        $start = '<!-- SDK VERSION -->';
+        $version = Sdk::VERSION;
+        $end = '<!-- /SDK VERSION -->';
+        $pattern = '/' . preg_quote($start, '/') . '[^<]*'
+            . preg_quote($end, '/') . '/';
+
+        return preg_replace($pattern, "$start{$version}$end", $readMeText);
+    }
+
     /**
      * @return Container
      */
-    protected function getContainer()
+    private function getContainer()
     {
         static $container = null;
 
         if (empty($container)) {
-            require_once $this->projectRoot . '/tests/bootstrap.php';
             $kernel = new \AppKernel('test', true);
             $kernel->boot();
             $container = $kernel->getContainer();

composer.json

@@ -31,11 +31,12 @@
   "autoload-dev": {
     "psr-4": {
       "Aws\\Symfony\\": ["build/", "tests/"]
-    }
+    },
+    "classmap": ["tests/fixtures"]
   },
   "scripts": {
     "post-autoload-dump": [
-      "Aws\\Symfony\\ReadMeUpdater::updateReadMe"
+      "Aws\\Symfony\\ReadMeUpdater::updateReadMeFromComposer"
     ]
   }
 }

phpunit.xml phpunit.xml.distphpunit.xml renamed to phpunit.xml.dist

@@ -3,7 +3,7 @@
 <phpunit
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.5/phpunit.xsd"
-        bootstrap="./tests/bootstrap.php">
+        bootstrap="./vendor/autoload.php">
     <testsuites>
         <testsuite name="AwsBundle Test Suite">
             <directory suffix="Test.php">./tests</directory>