Merge pull request #27 from MacPaw/feat/rewriteAsBundle

feat: rewrite as bundle

.github/workflows/ci.yaml

@@ -68,6 +68,8 @@ jobs:
               run: |
                   composer require symfony/messenger:${{ matrix.symfony-versions }} --no-update --no-scripts
                   composer require symfony/serializer:${{ matrix.symfony-versions }} --no-update --no-scripts
+                  composer require symfony/dependency-injection:${{ matrix.symfony-versions }} --no-update --no-scripts
+                  composer require symfony/http-kernel:${{ matrix.symfony-versions }} --no-update --no-scripts
 
             - name: Install dependencies
               run: composer install

.gitignore

@@ -2,6 +2,6 @@
 /composer.lock
 /build/
 /.phpunit.result.cache
-
 /node_modules/
-package-lock.json
+/.idea/
+/package-lock.json

README.md

@@ -1,4 +1,4 @@
-Behat Messenger Context
+Behat Messenger Context Bundle
 =================================
 
 | Version | Build Status | Code Coverage |
@@ -9,26 +9,15 @@ Behat Messenger Context
 Installation
 ============
 
-Step 1: Install Context
+Step 1: Install Bundle
 ----------------------------------
 Open a command console, enter your project directory and execute:
 
 ```console
 $ composer require --dev macpaw/behat-messenger-context
 ```
 
-Step 2: Update Container config to load Messenger Context
-----------------------------------
-In the `config/services_test.yaml` file of your project:
-
-```
-    BehatMessengerContext\:
-        resource: '../vendor/macpaw/behat-messenger-context/src/*'
-        arguments:
-            - '@test.service_container'
-```
-
-Step 3: Configure Messenger 
+Step 2: Configure Messenger
 =============
 Copying `config/packages/dev/messenger.yaml` and pasting that into `config/packages/test/`. This gives us messenger configuration that will only be used in the test environment. Uncomment the code, and replace sync with in-memory. Do that for both of the transports.
 
@@ -43,7 +32,7 @@ framework:
 ```
 
 
-Step 4: Configure Behat
+Step 3: Configure Behat
 =============
 Go to `behat.yml`
 
@@ -61,4 +50,4 @@ Go to `behat.yml`
 [master Code Coverage]: https://codecov.io/gh/macpaw/BehatMessengerContext/branch/master
 [master Code Coverage Image]: https://img.shields.io/codecov/c/github/macpaw/BehatMessengerContext/master?logo=codecov
 [develop Code Coverage]: https://codecov.io/gh/macpaw/BehatMessengerContext/branch/develop
-[develop Code Coverage Image]: https://img.shields.io/codecov/c/github/macpaw/BehatMessengerContext/develop?logo=codecov
+[develop Code Coverage Image]: https://img.shields.io/codecov/c/github/macpaw/BehatMessengerContext/develop?logo=codecov

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "macpaw/behat-messenger-context",
-    "type": "library",
+    "type": "symfony-bundle",
     "description": "Behat Context for testing Symfony Messenger component",
     "keywords": [
         "MacPaw",
@@ -29,7 +29,10 @@
         "php": "^7.4 || ^8.0",
         "behat/behat": "^3.0",
         "symfony/messenger": "^4.4 || ^5.0 || ^6.0",
-        "symfony/serializer": "^4.4 || ^5.0 || ^6.0"
+        "symfony/serializer": "^4.4 || ^5.0 || ^6.0",
+        "symfony/dependency-injection": "^4.4 || ^5.4 || ^6.0",
+        "symfony/http-kernel": "^4.4 || ^5.4 || ^6.0",
+        "macpaw/similar-arrays": "^1.0"
     },
     "require-dev": {
         "phpstan/phpstan": "^0.12",

phpcs.xml.dist

@@ -40,4 +40,5 @@
     <rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
 
     <file>src/</file>
+    <file>tests/</file>
 </ruleset>

phpunit.xml.dist

@@ -14,11 +14,6 @@
             <directory>tests</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
-            <directory suffix=".php">src/</directory>
-        </whitelist>
-    </filter>
     <coverage>
         <include>
             <directory>./src</directory>

src/BehatMessengerContextBundle.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BehatMessengerContext;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+class BehatMessengerContextBundle extends Bundle
+{
+}

src/Context/MessengerContext.php

@@ -4,18 +4,16 @@
 
 namespace BehatMessengerContext\Context;
 
-use BehatMessengerContext\Context\Traits\ArraySimilarTrait;
 use Behat\Behat\Context\Context;
 use Behat\Gherkin\Node\PyStringNode;
 use Exception;
+use SimilarArrays\SimilarArray;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\Messenger\Transport\InMemoryTransport;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
-class MessengerContext implements Context
+class MessengerContext extends SimilarArray implements Context
 {
-    use ArraySimilarTrait;
-
     private ContainerInterface $container;
     private NormalizerInterface $normalizer;
 

src/DependencyInjection/BehatMessengerContextExtension.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BehatMessengerContext\DependencyInjection;
+
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\Extension;
+use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
+
+class BehatMessengerContextExtension extends Extension
+{
+    /**
+     * @param array<array> $configs
+     *
+     * {@inheritdoc}
+     */
+    public function load(array $configs, ContainerBuilder $container): void
+    {
+        $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
+        $loader->load('messenger_context.xml');
+    }
+}

src/DependencyInjection/Configuration.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BehatMessengerContext\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+class Configuration implements ConfigurationInterface
+{
+    public function getConfigTreeBuilder(): TreeBuilder
+    {
+        return new TreeBuilder('behat_messenger_context');
+    }
+}

src/Resources/config/messenger_context.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema-instance"
+    xsd:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+        <service public="true" autowire="true" id="BehatMessengerContext\Context\MessengerContext" class="BehatMessengerContext\Context\MessengerContext">
+            <argument key="$container" type="service" id="test.service_container"/>
+        </service>
+    </services>
+</container>

tests/DependencyInjection/BehatMessengerContextExtensionTest.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DependencyInjection;
+
+use BehatMessengerContext\Context\MessengerContext;
+use BehatMessengerContext\DependencyInjection\BehatMessengerContextExtension;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\Extension;
+
+class BehatMessengerContextExtensionTest extends TestCase
+{
+    public function testHasServices(): void
+    {
+        $extension = new BehatMessengerContextExtension();
+        $container = new ContainerBuilder();
+
+        $this->assertInstanceOf(Extension::class, $extension);
+
+        $extension->load([], $container);
+
+        $this->assertTrue($container->has(MessengerContext::class));
+    }
+}

tests/DependencyInjection/ConfigurationTest.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DependencyInjection;
+
+use BehatMessengerContext\DependencyInjection\Configuration;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+use Symfony\Component\Config\Definition\Processor;
+
+class ConfigurationTest extends TestCase
+{
+    public function testConfiguration(): void
+    {
+        $processor = new Processor();
+        $configuration = new Configuration();
+
+        $this->assertInstanceOf(ConfigurationInterface::class, $configuration);
+
+        $configs = $processor->processConfiguration($configuration, []);
+
+        $this->assertSame([], $configs);
+    }
+}