Create Pipeline (#7)

Setup pipeline with tests and cs-fixer

Author: davidhoelzel

.github/workflows/tests.yaml

@@ -0,0 +1,32 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  tests:
+    name: "PHP ${{ matrix.php-version }}"
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    strategy:
+      matrix:
+        php-version: ['8.2', '8.3']
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          tools: composer:v2
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Dependencies
+        run: composer update --no-interaction --prefer-dist --optimize-autoloader --prefer-stable
+      - name: PHP-CS-Fixer
+        run: vendor/bin/php-cs-fixer fix --diff --dry-run
+      - name: Run tests
+        run: vendor/bin/phpunit
+
+

.gitignore

@@ -2,3 +2,4 @@
 /vendor/
 .phpunit.cache
 composer.lock
+.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,16 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__)
+    ->exclude('var');
+
+$config = new PhpCsFixer\Config();
+return $config
+    ->setRiskyAllowed(true)
+    ->setRules([
+    '@Symfony' => true,
+    '@Symfony:risky' => true,
+    'array_syntax' => ['syntax' => 'short'],
+    'yoda_style' => false,
+])
+    ->setFinder($finder);

composer.json

@@ -23,6 +23,7 @@
   "require-dev": {
     "phpunit/phpunit": "^10.5",
     "symfony/browser-kit": "^6.4|^7.0",
-    "symfony/css-selector": "^6.4|^7.0"
+    "symfony/css-selector": "^6.4|^7.0",
+    "friendsofphp/php-cs-fixer": "^3.51"
   }
 }

config/documentation.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
@@ -10,7 +11,7 @@
 use Qossmic\TwigDocBundle\Twig\TwigDocExtension;
 
 return static function (ContainerConfigurator $container) {
-    $container->services()  ->set('twig_doc.controller.documentation', TwigDocController::class)
+    $container->services()->set('twig_doc.controller.documentation', TwigDocController::class)
         ->public()
         ->autoconfigure()
         ->autowire()
@@ -35,5 +36,5 @@
         ->autowire()
         ->tag('twig.extension')
         ->alias(TwigDocExtension::class, 'twig_doc.twig.extension')
-        ;
+    ;
 };

src/Component/ComponentCategory.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Qossmic\TwigDocBundle\Component;
@@ -15,14 +16,15 @@ class ComponentCategory
     #[Assert\Regex('/^\w+$/')]
     private string $name;
 
-    public function getParent(): ?ComponentCategory
+    public function getParent(): ?self
     {
         return $this->parent;
     }
 
-    public function setParent(?ComponentCategory $parent): ComponentCategory
+    public function setParent(?self $parent): self
     {
         $this->parent = $parent;
+
         return $this;
     }
 
@@ -31,9 +33,10 @@ public function getName(): string
         return $this->name;
     }
 
-    public function setName(string $name): ComponentCategory
+    public function setName(string $name): self
     {
         $this->name = $name;
+
         return $this;
     }
 }

src/Component/ComponentInvalid.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Qossmic\TwigDocBundle\Component;

src/Component/ComponentItem.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Qossmic\TwigDocBundle\Component;
@@ -30,9 +31,10 @@ public function getName(): string
         return $this->name;
     }
 
-    public function setName(string $name): ComponentItem
+    public function setName(string $name): self
     {
         $this->name = $name;
+
         return $this;
     }
 
@@ -41,9 +43,10 @@ public function getTitle(): string
         return $this->title;
     }
 
-    public function setTitle(string $title): ComponentItem
+    public function setTitle(string $title): self
     {
         $this->title = $title;
+
         return $this;
     }
 
@@ -52,9 +55,10 @@ public function getDescription(): string
         return $this->description;
     }
 
-    public function setDescription(string $description): ComponentItem
+    public function setDescription(string $description): self
     {
         $this->description = $description;
+
         return $this;
     }
 
@@ -63,9 +67,10 @@ public function getTags(): array
         return $this->tags;
     }
 
-    public function setTags(array $tags): ComponentItem
+    public function setTags(array $tags): self
     {
         $this->tags = $tags;
+
         return $this;
     }
 
@@ -74,27 +79,28 @@ public function getParameters(): array
         return $this->parameters;
     }
 
-    public function setParameters(array $parameters): ComponentItem
+    public function setParameters(array $parameters): self
     {
         $this->parameters = $parameters;
 
         return $this;
     }
 
-    public function setVariations(array $variations): ComponentItem
+    public function setVariations(array $variations): self
     {
         $this->variations = $variations;
 
         return $this;
     }
 
-    public function addParameter(string $name, mixed $value): ComponentItem
+    public function addParameter(string $name, mixed $value): self
     {
         $this->parameters[$name] = $value;
+
         return $this;
     }
 
-    public function removeParameter(string $name): ComponentItem
+    public function removeParameter(string $name): self
     {
         unset($this->parameters[$name]);
 
@@ -106,13 +112,14 @@ public function getVariations(): array
         return $this->variations;
     }
 
-    public function addVariation(string $name, array $variation): ComponentItem
+    public function addVariation(string $name, array $variation): self
     {
         $this->variations[$name] = $variation;
+
         return $this;
     }
 
-    public function removeVariation(string $name): ComponentItem
+    public function removeVariation(string $name): self
     {
         unset($this->variations[$name]);
 
@@ -124,9 +131,10 @@ public function getCategory(): ComponentCategory
         return $this->category;
     }
 
-    public function setCategory(ComponentCategory $category): ComponentItem
+    public function setCategory(ComponentCategory $category): self
     {
         $this->category = $category;
+
         return $this;
     }
 

src/Component/ComponentItemFactory.php

@@ -1,12 +1,13 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Qossmic\TwigDocBundle\Component;
 
-use Symfony\Component\Validator\ConstraintViolationList;
-use Symfony\Component\Validator\Validator\ValidatorInterface;
 use Qossmic\TwigDocBundle\Exception\InvalidComponentConfigurationException;
 use Qossmic\TwigDocBundle\Service\CategoryService;
+use Symfony\Component\Validator\ConstraintViolationList;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
 
 class ComponentItemFactory
 {
@@ -23,7 +24,7 @@ public function create(array $data): ComponentItem
         if ($category === null) {
             $violations = ConstraintViolationList::createFromMessage(
                 sprintf(
-                    "invalid %s \"%s\". Valid categories are: %s. Valid sub-categories are: %s",
+                    'invalid %s "%s". Valid categories are: %s. Valid sub-categories are: %s',
                     isset($data['sub_category']) ? 'sub_category' : 'category',
                     $data['sub_category'] ?? $data['category'],
                     implode(', ', array_keys($this->categoryService->getCategories())),
@@ -53,7 +54,7 @@ private function createItem(array $data): ComponentItem
             ->setTags($data['tags'] ?? [])
             ->setParameters($data['parameters'] ?? [])
             ->setVariations($data['variations'] ?? [
-                'default' => $this->createVariationParameters($data['parameters'] ?? [])
+                'default' => $this->createVariationParameters($data['parameters'] ?? []),
             ]);
 
         return $item;
@@ -63,7 +64,7 @@ public function createVariationParameters(array $parameters): array
     {
         $params = [];
         foreach ($parameters as $name => $type) {
-            if (is_array($type)) {
+            if (\is_array($type)) {
                 $paramValue = $this->createVariationParameters($type);
             } else {
                 $paramValue = $this->createParamValue($type);
@@ -86,7 +87,7 @@ private function createParamValue(string $type): bool|int|float|string|null
                 return random_int(0, 100000);
             case 'bool':
             case 'boolean':
-                return [true, false][rand(0,1)];
+                return [true, false][rand(0, 1)];
             case 'float':
             case 'double':
                 return (float) rand(1, 1000) / 100;

src/Controller/TwigDocController.php

@@ -1,24 +1,23 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Qossmic\TwigDocBundle\Controller;
 
+use Qossmic\TwigDocBundle\Service\ComponentService;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\HttpKernel\Profiler\Profiler;
 use Twig\Environment;
-use Qossmic\TwigDocBundle\Component\ComponentItem;
-use Qossmic\TwigDocBundle\Service\ComponentService;
 
 class TwigDocController
 {
     public function __construct(
         private readonly Environment $twig,
         private readonly ComponentService $componentService,
         private readonly ?Profiler $profiler = null
-    )
-    {
+    ) {
     }
 
     public function index(Request $request): Response
@@ -55,14 +54,15 @@ public function componentView(Request $request): Response
         }
         $breakpoint = $request->query->get('breakpoint');
         // disable profiler to get rid of toolbar in dev
-        if($this->profiler) {
-        $this->profiler->disable();
+        if ($this->profiler) {
+            $this->profiler->disable();
         }
+
         return new Response(
             $this->twig->render('@TwigDoc/component.html.twig', [
                 'component' => $component,
                 'componentData' => $request->query->all('data'),
-                'quantity' => $request->query->get('quantity')
+                'quantity' => $request->query->get('quantity'),
             ])
         );
     }