📦 Refacto Folder

Author: VincentLanglet

SymfonyCustom/Sniffs/FixerHelper.php renamed to SymfonyCustom/Helpers/FixerHelper.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SymfonyCustom\Sniffs;
+namespace SymfonyCustom\Helpers;
 
 use PHP_CodeSniffer\Files\File;
 

SymfonyCustom/Sniffs/SniffHelper.php renamed to SymfonyCustom/Helpers/SniffHelper.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SymfonyCustom\Sniffs;
+namespace SymfonyCustom\Helpers;
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Util\Tokens;

SymfonyCustom/Sniffs/Arrays/ArrayDeclarationSniff.php

@@ -7,7 +7,7 @@
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Util\Tokens;
-use SymfonyCustom\Sniffs\FixerHelper;
+use SymfonyCustom\Helpers\FixerHelper;
 
 /**
  * A test to ensure that arrays conform to the array coding standard.

SymfonyCustom/Sniffs/Commenting/DocCommentGroupSameTypeSniff.php

@@ -6,8 +6,8 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
-use SymfonyCustom\Sniffs\FixerHelper;
-use SymfonyCustom\Sniffs\SniffHelper;
+use SymfonyCustom\Helpers\FixerHelper;
+use SymfonyCustom\Helpers\SniffHelper;
 
 /**
  * Throws errors if comments are not grouped by type with one blank line between them.

SymfonyCustom/Sniffs/Commenting/DocCommentSniff.php

@@ -6,7 +6,7 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
-use SymfonyCustom\Sniffs\FixerHelper;
+use SymfonyCustom\Helpers\FixerHelper;
 
 /**
  * Ensures doc blocks follow basic formatting.

SymfonyCustom/Sniffs/Namespaces/AlphabeticallySortedUseSniff.php

@@ -7,7 +7,7 @@
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Util\Tokens;
-use SymfonyCustom\Sniffs\SniffHelper;
+use SymfonyCustom\Helpers\SniffHelper;
 
 /**
  * Class AlphabeticallySortedUseSniff

SymfonyCustom/Sniffs/Namespaces/UnusedUseSniff.php

@@ -7,7 +7,7 @@
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Util\Tokens;
-use SymfonyCustom\Sniffs\SniffHelper;
+use SymfonyCustom\Helpers\SniffHelper;
 
 /**
  * Checks for "use" statements that are not needed in a file.

SymfonyCustom/Sniffs/WhiteSpace/DocCommentTagSpacingSniff.php

@@ -6,7 +6,7 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
-use SymfonyCustom\Sniffs\SniffHelper;
+use SymfonyCustom\Helpers\SniffHelper;
 
 /**
  * Checks that there are not 2 empty lines following each other.

TwigCS/Command/TwigCSCommand.php renamed to TwigCS/src/Command/TwigCSCommand.php

@@ -0,0 +1,82 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TwigCS\Tests;
+
+use Exception;
+use PHPUnit\Framework\TestCase;
+use ReflectionClass;
+use TwigCS\Environment\StubbedEnvironment;
+use TwigCS\Report\Report;
+use TwigCS\Ruleset\Ruleset;
+use TwigCS\Runner\Fixer;
+use TwigCS\Runner\Linter;
+use TwigCS\Sniff\SniffInterface;
+use TwigCS\Token\Tokenizer;
+
+/**
+ * Class AbstractSniffTest
+ */
+abstract class AbstractSniffTest extends TestCase
+{
+    /**
+     * Should call $this->checkGenericSniff(new Sniff(), [...]);
+     */
+    abstract public function testSniff(): void;
+
+    /**
+     * @param SniffInterface $sniff
+     * @param array          $expects
+     */
+    protected function checkGenericSniff(SniffInterface $sniff, array $expects): void
+    {
+        $env = new StubbedEnvironment();
+        $tokenizer = new Tokenizer($env);
+        $linter = new Linter($env, $tokenizer);
+        $ruleset = new Ruleset();
+
+        try {
+            $class = new ReflectionClass(get_called_class());
+            $className = $class->getShortName();
+            $file = __DIR__.'/Fixtures/'.$className.'.twig';
+
+            $ruleset->addSniff($sniff);
+            $report = $linter->run([$file], $ruleset);
+        } catch (Exception $e) {
+            $this->fail($e->getMessage());
+
+            return;
+        }
+
+        $messages = $report->getMessages();
+        $messagePositions = [];
+
+        foreach ($messages as $message) {
+            if (Report::MESSAGE_TYPE_FATAL === $message->getLevel()) {
+                $errorMessage = $message->getMessage();
+                $line = $message->getLine();
+
+                if (null !== $line) {
+                    $errorMessage = sprintf('Line %s: %s', $line, $errorMessage);
+                }
+                $this->fail($errorMessage);
+            }
+
+            $messagePositions[] = [$message->getLine() => $message->getLinePosition()];
+        }
+        $this->assertEquals($expects, $messagePositions);
+
+        $fixedFile = __DIR__.'/Fixtures/'.$className.'.fixed.twig';
+        if (file_exists($fixedFile)) {
+            $fixer = new Fixer($ruleset, $tokenizer);
+            $sniff->enableFixer($fixer);
+            $fixer->fixFile($file);
+
+            $diff = $fixer->generateDiff($fixedFile);
+            if ('' !== $diff) {
+                $this->fail($diff);
+            }
+        }
+    }
+}

TwigCS/Config/Config.php renamed to TwigCS/src/Config/Config.php

@@ -0,0 +1,2 @@
+<div class="error">
+</div>

TwigCS/Environment/StubbedEnvironment.php renamed to TwigCS/src/Environment/StubbedEnvironment.php

@@ -0,0 +1,3 @@
+<div class="error">
+</div>
+

TwigCS/Report/Report.php renamed to TwigCS/src/Report/Report.php

@@ -0,0 +1,20 @@
+{{ foo }}
+{# comment #}
+{% if foo %}{% endif %}
+
+{{- foo -}}
+{#- comment -#}
+{%- if foo -%}{%- endif -%}
+
+{{
+    shouldNotCareAboutNewLine
+}}
+{%- if foo -%}{%- endif -%}
+
+{{ foo({'bar': {'baz': 'shouldNotCareAboutDoubleHashes'}}) }}
+
+<div>
+    {{
+        shouldNotCareAboutNewLine
+    }}
+</div>

TwigCS/Report/SniffViolation.php renamed to TwigCS/src/Report/SniffViolation.php

@@ -0,0 +1,20 @@
+{{ foo }}
+{# comment #}
+{% if foo %}{% endif %}
+
+{{- foo -}}
+{#- comment -#}
+{%- if foo -%}{%- endif -%}
+
+{{
+    shouldNotCareAboutNewLine
+}}
+{%-if foo  -%}{%-  endif-%}
+
+{{ foo({'bar': {'baz': 'shouldNotCareAboutDoubleHashes'}}) }}
+
+<div>
+    {{
+        shouldNotCareAboutNewLine
+    }}
+</div>

TwigCS/Report/TextFormatter.php renamed to TwigCS/src/Report/TextFormatter.php

@@ -0,0 +1,7 @@
+<div class="error">
+    {# {% set var = 'This is a comment' %} #}
+</div>
+
+<div class="success">
+    {# 'This is a comment' #}
+</div>

TwigCS/Ruleset/Generic/BlankEOFSniff.php renamed to TwigCS/src/Ruleset/Generic/BlankEOFSniff.php

@@ -0,0 +1,3 @@
+<div class="error">
+
+</div>

TwigCS/Ruleset/Generic/DelimiterSpacingSniff.php renamed to TwigCS/src/Ruleset/Generic/DelimiterSpacingSniff.php

@@ -0,0 +1,4 @@
+<div class="error">
+
+
+</div>

TwigCS/Ruleset/Generic/DisallowCommentedCodeSniff.php renamed to TwigCS/src/Ruleset/Generic/DisallowCommentedCodeSniff.php

@@ -0,0 +1,20 @@
+{{ 1 + 2 }}
+{{ 1 - 2 }}
+{{ 1 / 2 }}
+{{ 1 * 2 }}
+{{ 1 % 2 }}
+{{ 1 // 2 }}
+{{ 1 ** 2 }}
+{{ foo ~ bar }}
+{{ true ? true : false }}
+{{ 1 == 2 }}
+{{ not true }}
+{{ false and true }}
+{{ false or true }}
+{{ a in array }}
+{{ a is array }}
+
+Untouch +-/*%==:
+
+{{ [1, 2, 3] }}
+{{ {'foo': 'bar'} }}

TwigCS/Ruleset/Generic/EmptyLinesSniff.php renamed to TwigCS/src/Ruleset/Generic/EmptyLinesSniff.php

@@ -0,0 +1,20 @@
+{{ 1+2 }}
+{{ 1-2 }}
+{{ 1/2 }}
+{{ 1*2 }}
+{{ 1%2 }}
+{{ 1//2 }}
+{{ 1**2 }}
+{{ foo~bar }}
+{{ true  ?  true  :  false }}
+{{ 1==2 }}
+{{   not   true }}
+{{ false  and   true }}
+{{ false  or   true }}
+{{ a  in   array }}
+{{ a  is   array }}
+
+Untouch +-/*%==:
+
+{{ [1, 2, 3] }}
+{{ {'foo': 'bar'} }}

TwigCS/Ruleset/Generic/OperatorSpacingSniff.php renamed to TwigCS/src/Ruleset/Generic/OperatorSpacingSniff.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TwigCS\Tests\Ruleset\Generic;
+
+use TwigCS\Ruleset\Generic\BlankEOFSniff;
+use TwigCS\Tests\AbstractSniffTest;
+
+/**
+ * Class BlankEOFTest
+ */
+class BlankEOFTest extends AbstractSniffTest
+{
+    public function testSniff(): void
+    {
+        $this->checkGenericSniff(new BlankEOFSniff(), [
+            [4 => 1],
+        ]);
+    }
+}

TwigCS/Ruleset/Ruleset.php renamed to TwigCS/src/Ruleset/Ruleset.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TwigCS\Tests\Ruleset\Generic;
+
+use TwigCS\Ruleset\Generic\DelimiterSpacingSniff;
+use TwigCS\Tests\AbstractSniffTest;
+
+/**
+ * Class DelimiterSpacingTest
+ */
+class DelimiterSpacingTest extends AbstractSniffTest
+{
+    public function testSniff(): void
+    {
+        $this->checkGenericSniff(new DelimiterSpacingSniff(), [
+            [12 => 1],
+            [12 => 12],
+            [12 => 15],
+            [12 => 25],
+        ]);
+    }
+}

TwigCS/Runner/Fixer.php renamed to TwigCS/src/Runner/Fixer.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TwigCS\Tests\Ruleset\Generic;
+
+use TwigCS\Ruleset\Generic\DisallowCommentedCodeSniff;
+use TwigCS\Tests\AbstractSniffTest;
+
+/**
+ * Class DisallowCommentedCodeTest
+ */
+class DisallowCommentedCodeTest extends AbstractSniffTest
+{
+    public function testSniff(): void
+    {
+        $this->checkGenericSniff(new DisallowCommentedCodeSniff(), [
+            [2 => 5],
+        ]);
+    }
+}

TwigCS/Runner/Linter.php renamed to TwigCS/src/Runner/Linter.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TwigCS\Tests\Ruleset\Generic;
+
+use TwigCS\Ruleset\Generic\EmptyLinesSniff;
+use TwigCS\Tests\AbstractSniffTest;
+
+/**
+ * Class EmptyLinesTest
+ */
+class EmptyLinesTest extends AbstractSniffTest
+{
+    public function testSniff(): void
+    {
+        $this->checkGenericSniff(new EmptyLinesSniff(), [
+            [3 => 1],
+        ]);
+    }
+}