Add DI + tests

veewee · veewee · commit 25c708b7256c · 2018-07-06T07:28:07.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,7 @@
 /vendor/
 composer.lock
 .php_cs.cache
+.php_cs
+grumphp.yml
+phpunit.xml
+var
diff --git a/.php_cs.dist b/.php_cs.dist
@@ -5,7 +5,7 @@ return PhpCsFixer\Config::create()
         \Symfony\Component\Finder\Finder::create()
             ->in([
                 __DIR__ . '/src',
-                __DIR__ . '/spec',
+                __DIR__ . '/test',
             ])
     )
     ->setRiskyAllowed(true)
diff --git a/CONTRIBUTING b/CONTRIBUTING
@@ -11,8 +11,8 @@ will be closed (this is selected by default).
 
 ## Coverage
 
-- All classes that interact solely with the core logic should be covered by Specs
+- All classes that interact solely with the core logic should be covered by Tests
 
 ## Code style / Formatting
 
-- All code in the `src` and `spec` folder must follow the PSR-2 standard and should comply with the php-cs-fixer config.
+- All code in the `src` and `test` folder must follow the PSR-2 standard and should comply with the php-cs-fixer config.
diff --git a/README.md b/README.md
@@ -25,11 +25,6 @@ return [
 ];
 ```
 
-## Configuration
-
-TODO
-
-
 ## Supported response formats
 
 - application/problem+json
@@ -68,7 +63,7 @@ Body:
     "status": 400,
     "type": "http:\/\/www.w3.org\/Protocols\/rfc2616\/rfc2616-sec10.html",
     "title": "Bad Request",
-    "detail": "It aint all bad ..."
+    "detail": "It ain't all bad ..."
 }
 ```
 
diff --git a/composer.json b/composer.json
@@ -4,8 +4,9 @@
     "type": "library",
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.12",
+        "matthiasnoback/symfony-dependency-injection-test": "^3.0",
         "phpro/grumphp": "^0.14.1",
-        "phpspec/phpspec": "^4.3"
+        "phpunit/phpunit": "^7.2"
     },
     "license": "MIT",
     "authors": [
@@ -16,6 +17,7 @@
     ],
     "require": {
         "php": "^7.2",
+        "phpro/api-problem": "dev-basic-api-problem-implementation@dev",
         "symfony/dependency-injection": "^4.1",
         "symfony/event-dispatcher": "^4.1",
         "symfony/http-kernel": "^4.1"
@@ -27,5 +29,16 @@
         "psr-4": {
             "Phpro\\ApiProblemBundle\\": "src/"
         }
-    }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "PhproTest\\ApiProblemBundle\\": "test/"
+        }
+    },
+    "repositories": [
+        {
+            "type": "git",
+            "url": "https://github.com/veewee/api-problem.git"
+        }
+    ]
 }
diff --git a/config/services.xml b/config/services.xml
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    <services>
+        <service
+            id="Phpro\ApiProblemBundle\EventListener\JsonApiProblemExceptionListener"
+            class="Phpro\ApiProblemBundle\EventListener\JsonApiProblemExceptionListener"
+        >
+            <argument key="$debug" >%kernel.debug%</argument>
+            <tag name="kernel.event_listener" event="kernel.exception" method="onKernelException" />
+        </service>
+    </services>
+</container>
diff --git a/grumphp.yml.dist b/grumphp.yml.dist
@@ -5,7 +5,19 @@ parameters:
       phpcsfixer2:
         config: ".php_cs.dist"
         config_contains_finder: true
-      phpspec:
-        format: dot
+        metadata:
+          priority: 10000
+      phpunit:
+        metadata:
+          priority: 9000
+      clover_coverage:
+        clover_file: var/coverage.xml
+        level: 100
+        metadata:
+          priority: 8000
       composer:
         no_check_lock: true
+      xmllint:
+        load_from_net: true
+        scheme_validation: true
+        triggered_by: ['xml']
diff --git a/phpspec.yml.dist b/phpspec.yml.dist
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit colors="true">
+    <testsuites>
+        <testsuite name="Unit">
+            <directory>./test</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">src</directory>
+        </whitelist>
+    </filter>
+    <logging>
+        <log type="coverage-clover" target="var/coverage.xml" />
+    </logging>
+</phpunit>
diff --git a/spec/ApiProblemBundleSpec.php b/spec/ApiProblemBundleSpec.php
diff --git a/spec/EventListener/JsonApiProblemExceptionListenerSpec.php b/spec/EventListener/JsonApiProblemExceptionListenerSpec.php
diff --git a/src/DependencyInjection/ApiProblemExtension.php b/src/DependencyInjection/ApiProblemExtension.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phpro\ApiProblemBundle\DependencyInjection;
+
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\Extension;
+use Symfony\Component\DependencyInjection\Loader;
+
+class ApiProblemExtension extends Extension
+{
+    public function load(array $configs, ContainerBuilder $container): void
+    {
+        $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__.'/../../config'));
+        $loader->load('services.xml');
+    }
+}
diff --git a/src/EventListener/JsonApiProblemExceptionListener.php b/src/EventListener/JsonApiProblemExceptionListener.php
@@ -28,7 +28,7 @@ public function onKernelException(GetResponseForExceptionEvent $event): void
     {
         $request = $event->getRequest();
         if (
-            'json' !== $request->getRequestFormat() &&
+            false === mb_strpos($request->getRequestFormat(), 'json') &&
             false === mb_strpos((string) $request->getContentType(), 'json')
         ) {
             return;
diff --git a/test/ApiProblemBundleTest.php b/test/ApiProblemBundleTest.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhproTest\ApiProblemBundle;
+
+use Phpro\ApiProblemBundle\ApiProblemBundle;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+/** @covers \Phpro\ApiProblemBundle\ApiProblemBundle */
+class ApiProblemBundleTest extends TestCase
+{
+    /** @test */
+    public function it_is_a_symfony_bundle(): void
+    {
+        $this->assertInstanceOf(Bundle::class, new ApiProblemBundle());
+    }
+}
diff --git a/test/DependencyInjection/ApiProblemExtensionTest.php b/test/DependencyInjection/ApiProblemExtensionTest.php
@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhproTest\ApiProblemBundle\DependencyInjection;
+
+use Matthias\SymfonyDependencyInjectionTest\PhpUnit\AbstractExtensionTestCase;
+use Phpro\ApiProblemBundle\DependencyInjection\ApiProblemExtension;
+use Phpro\ApiProblemBundle\EventListener\JsonApiProblemExceptionListener;
+
+/**
+ * @covers \Phpro\ApiProblemBundle\DependencyInjection\ApiProblemExtension
+ */
+class ApiProblemExtensionTest extends AbstractExtensionTestCase
+{
+    protected function getContainerExtensions(): array
+    {
+        return [new ApiProblemExtension()];
+    }
+
+    /** @test */
+    public function it_registers_json_exception_listener(): void
+    {
+        $this->load([]);
+
+        $this->assertContainerBuilderHasService(
+            JsonApiProblemExceptionListener::class,
+            JsonApiProblemExceptionListener::class
+        );
+        $this->assertContainerBuilderHasServiceDefinitionWithArgument(
+            JsonApiProblemExceptionListener::class,
+            '$debug',
+            '%kernel.debug%'
+        );
+        $this->assertContainerBuilderHasServiceDefinitionWithTag(
+            JsonApiProblemExceptionListener::class,
+            'kernel.event_listener',
+            [
+                'event' => 'kernel.exception',
+                'method' => 'onKernelException',
+            ]
+        );
+    }
+}
diff --git a/test/EventListener/JsonApiProblemExceptionListenerTest.php b/test/EventListener/JsonApiProblemExceptionListenerTest.php

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ return PhpCsFixer\Config::create()`
`5`	`5`	`\Symfony\Component\Finder\Finder::create()`
`6`	`6`	`->in([`
`7`	`7`	`__DIR__ . '/src',`
`8`		`- __DIR__ . '/spec',`
	`8`	`+ __DIR__ . '/test',`
`9`	`9`	`])`
`10`	`10`	`)`
`11`	`11`	`->setRiskyAllowed(true)`