adopted Broadway coding standard

qandidate-labs · Apr 3, 2020 · 8ceb61b · 8ceb61b
1 parent 8f7c987
commit 8ceb61b
Show file tree

Hide file tree

Showing 25 changed files with 163 additions and 112 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@ composer.lock
 /Tests/Functional/logs
 .phpunit.result.cache
 var/
+.php_cs.cache
diff --git a/.php_cs b/.php_cs
@@ -0,0 +1,13 @@
+<?php
+
+$config = require 'vendor/broadway/coding-standard/.php_cs.dist';
+
+$config->setFinder(
+    \PhpCsFixer\Finder::create()
+        ->in(__DIR__)
+        ->exclude([
+            __DIR__ . '/vendor/'
+        ])
+);
+
+return $config;
diff --git a/Annotations/Toggle.php b/Annotations/Toggle.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Qandidate\Bundle\ToggleBundle\Annotations;
 
 /**

diff --git a/Context/UserContextFactory.php b/Context/UserContextFactory.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the qandidate-labs/qandidate-toggle-bundle package.
  *
@@ -23,7 +25,7 @@ public function __construct(TokenStorageInterface $tokenStorage)
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function createContext()
     {

diff --git a/DataCollector/ToggleCollector.php b/DataCollector/ToggleCollector.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the qandidate-labs/qandidate-toggle-bundle package.
  *
@@ -35,8 +37,6 @@ class ToggleCollector extends DataCollector
 
     /**
      * ToggleCollector constructor.
-     * @param ToggleManager $toggleManager
-     * @param ContextFactory $contextFactory
      */
     public function __construct(ToggleManager $toggleManager, ContextFactory $contextFactory)
     {
@@ -47,8 +47,8 @@ public function __construct(ToggleManager $toggleManager, ContextFactory $contex
     /**
      * Collects data for the given Request and Response.
      *
-     * @param Request $request A Request instance
-     * @param Response $response A Response instance
+     * @param Request    $request   A Request instance
+     * @param Response   $response  A Response instance
      * @param \Exception $exception An Exception instance
      */
     public function collect(Request $request, Response $response, \Exception $exception = null)
@@ -91,6 +91,6 @@ public function getName()
 
     public function reset()
     {
-        $this->data = array();
+        $this->data = [];
     }
 }
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the qandidate-labs/qandidate-toggle-bundle package.
  *
@@ -17,7 +19,7 @@
 class Configuration implements ConfigurationInterface
 {
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function getConfigTreeBuilder()
     {
@@ -28,7 +30,7 @@ public function getConfigTreeBuilder()
         $rootNode
             ->children()
                 ->enumNode('persistence')
-                    ->values(array('in_memory', 'redis', 'factory', 'config'))
+                    ->values(['in_memory', 'redis', 'factory', 'config'])
                     ->defaultValue('in_memory')
                 ->end()
                 ->arrayNode('collection_factory')
@@ -75,8 +77,8 @@ public function getConfigTreeBuilder()
             ->end()
             ->validate()
                 ->ifTrue(function ($v) {
-                    if (isset($v['persistence']) && $v['persistence'] === 'factory') {
-                        return ! isset($v['collection_factory']['service_id'], $v['collection_factory']['method']);
+                    if (isset($v['persistence']) && 'factory' === $v['persistence']) {
+                        return !isset($v['collection_factory']['service_id'], $v['collection_factory']['method']);
                     }
 
                     return false;

diff --git a/DependencyInjection/QandidateToggleExtension.php b/DependencyInjection/QandidateToggleExtension.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the qandidate-labs/qandidate-toggle-bundle package.
  *
@@ -23,7 +25,7 @@
 class QandidateToggleExtension extends Extension
 {
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function load(array $configs, ContainerBuilder $container)
     {
@@ -45,28 +47,28 @@ public function load(array $configs, ContainerBuilder $container)
             case 'factory' === $config['persistence']:
                 $collection = 'factory';
                 $definition = new Definition(InMemoryCollection::class);
-                $definition->setFactory(array(
+                $definition->setFactory([
                     new Reference($config['collection_factory']['service_id']),
-                    $config['collection_factory']['method']
-                ));
+                    $config['collection_factory']['method'],
+                ]);
 
                 $container->setDefinition('qandidate.toggle.collection.factory', $definition);
 
                 break;
             case 'config' === $config['persistence']:
                 $collection = 'factory';
                 $definition = $container->getDefinition('qandidate.toggle.collection.in_memory');
-                $definition->setFactory(array(
+                $definition->setFactory([
                     new Reference('qandidate.toggle.collection.serializer.in_memory'),
-                    'deserialize'
-                ));
+                    'deserialize',
+                ]);
                 $definition->addArgument($config['toggles']);
 
                 $container->setDefinition('qandidate.toggle.collection.factory', $definition);
                 break;
         }
 
-        $container->setAlias('qandidate.toggle.collection', new Alias('qandidate.toggle.collection.' . $collection, true));
+        $container->setAlias('qandidate.toggle.collection', new Alias('qandidate.toggle.collection.'.$collection, true));
 
         $contextFactoryService = 'qandidate.toggle.user_context_factory';
         if (null !== $config['context_factory']) {

diff --git a/EventListener/ToggleListener.php b/EventListener/ToggleListener.php
@@ -1,14 +1,16 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Qandidate\Bundle\ToggleBundle\EventListener;
 
 use Doctrine\Common\Annotations\Reader;
 use Doctrine\Common\Util\ClassUtils;
+use Qandidate\Bundle\ToggleBundle\Annotations\Toggle;
+use Qandidate\Toggle\Context;
+use Qandidate\Toggle\ToggleManager;
 use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
-use Qandidate\Toggle\ToggleManager;
-use Qandidate\Toggle\Context;
-use Qandidate\Bundle\ToggleBundle\Annotations\Toggle;
 
 class ToggleListener
 {
@@ -18,35 +20,35 @@ class ToggleListener
 
     public function __construct(Reader $reader, ToggleManager $toggleManager, Context $context)
     {
-        $this->reader           = $reader;
-        $this->toggleManager    = $toggleManager;
-        $this->context          = $context;
+        $this->reader = $reader;
+        $this->toggleManager = $toggleManager;
+        $this->context = $context;
     }
 
     public function onKernelController(FilterControllerEvent $event)
     {
         $controller = $event->getController();
 
         if (is_array($controller)) {
-            $class      = ClassUtils::getClass($controller[0]);
-            $object     = new \ReflectionClass($class);
-            $method     = $object->getMethod($controller[1]);
+            $class = ClassUtils::getClass($controller[0]);
+            $object = new \ReflectionClass($class);
+            $method = $object->getMethod($controller[1]);
         } else {
-            $object     = new \ReflectionClass($controller);
-            $method     = $object->getMethod('__invoke');
+            $object = new \ReflectionClass($controller);
+            $method = $object->getMethod('__invoke');
         }
 
         foreach ($this->reader->getClassAnnotations($object) as $annotation) {
             if ($annotation instanceof Toggle) {
-                if (! $this->toggleManager->active($annotation->name, $this->context)) {
+                if (!$this->toggleManager->active($annotation->name, $this->context)) {
                     throw new NotFoundHttpException();
                 }
             }
         }
 
         foreach ($this->reader->getMethodAnnotations($method) as $annotation) {
             if ($annotation instanceof Toggle) {
-                if (! $this->toggleManager->active($annotation->name, $this->context)) {
+                if (!$this->toggleManager->active($annotation->name, $this->context)) {
                     throw new NotFoundHttpException();
                 }
             }

diff --git a/QandidateToggleBundle.php b/QandidateToggleBundle.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the qandidate-labs/qandidate-toggle-bundle package.
  *
@@ -15,5 +17,4 @@
 
 class QandidateToggleBundle extends Bundle
 {
-
 }
diff --git a/Resources/doc/example/index.php b/Resources/doc/example/index.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -8,7 +10,7 @@
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\Routing\RouteCollectionBuilder;
 
-require __DIR__ . '/vendor/autoload.php';
+require __DIR__.'/vendor/autoload.php';
 
 class AppKernel extends Kernel
 {
@@ -34,7 +36,6 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
             'providers' => [
                 'my_custom_provider' => [
                     'memory' => [],
-
                 ],
             ],
             'firewalls' => [
@@ -48,28 +49,28 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
             'persistence' => 'config',
             'toggles' => [
                 'always-active-feature' => [
-                    'name'   => 'always-active-feature',
+                    'name' => 'always-active-feature',
                     'status' => 'always-active',
                 ],
                 'inactive-feature' => [
                     'name' => 'inactive-feature',
                     'status' => 'inactive',
                 ],
                 'conditionally-active' => [
-                    'name'   => 'conditionally-active',
+                    'name' => 'conditionally-active',
                     'status' => 'conditionally-active',
                     'conditions' => [
                         [
                             'name' => 'operator-condition',
-                            'key'  => 'user_id',
+                            'key' => 'user_id',
                             'operator' => [
-                                'name'  => 'greater-than',
+                                'name' => 'greater-than',
                                 'value' => 42,
-                            ]
-                        ]
+                            ],
+                        ],
                     ],
-                ]
-            ]
+                ],
+            ],
         ]);
     }
 
@@ -81,12 +82,12 @@ protected function configureRoutes(RouteCollectionBuilder $routes)
     public function indexAction()
     {
         $toggleManager = $this->getContainer()->get('qandidate.toggle.manager');
-        $context       = new \Qandidate\Toggle\Context();
+        $context = new \Qandidate\Toggle\Context();
         $context->set('user_id', 43);
 
-        $output = array_map(function(\Qandidate\Toggle\Toggle $toggle) use ($toggleManager, $context) {
+        $output = array_map(function (\Qandidate\Toggle\Toggle $toggle) use ($toggleManager, $context) {
             return [
-                'name'   => $toggle->getName(),
+                'name' => $toggle->getName(),
                 'active' => $toggleManager->active($toggle->getName(), $context),
             ];
         }, $toggleManager->all());

diff --git a/Tests/Context/UserContextFactoryTest.php b/Tests/Context/UserContextFactoryTest.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the qandidate-labs/qandidate-toggle-bundle package.
  *
@@ -21,7 +23,7 @@ class UserContextFactoryTest extends TestCase
     public function setUp(): void
     {
         $this->tokenStorage = new TokenStorage();
-        $this->contextFactory  = new UserContextFactory($this->tokenStorage);
+        $this->contextFactory = new UserContextFactory($this->tokenStorage);
     }
 
     /**