📦 More cleaning

Author: VincentLanglet

TwigCS/Command/TwigCSCommand.php

@@ -8,12 +8,11 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
-use Twig\Loader\ArrayLoader;
 use TwigCS\Config\Config;
 use TwigCS\Environment\StubbedEnvironment;
 use TwigCS\Linter;
 use TwigCS\Report\TextFormatter;
-use TwigCS\Ruleset\RulesetFactory;
+use TwigCS\Ruleset\Ruleset;
 use TwigCS\Token\Tokenizer;
 
 /**
@@ -33,16 +32,16 @@ protected function configure()
                 new InputOption(
                     'exclude',
                     'e',
-                    InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
+                    InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
                     'Excludes, based on regex, paths of files and folders from parsing',
-                    ['vendor/']
+                    []
                 ),
                 new InputOption(
                     'level',
                     'l',
                     InputOption::VALUE_OPTIONAL,
-                    'Allowed values are: warning, error',
-                    'warning'
+                    'Allowed values are notice, warning or error',
+                    'notice'
                 ),
                 new InputOption(
                     'working-dir',
@@ -81,26 +80,24 @@ protected function execute(InputInterface $input, OutputInterface $output)
             'workingDirectory' => $currentDir,
         ]);
 
-        $twig     = new StubbedEnvironment(new ArrayLoader());
-        $linter   = new Linter($twig, new Tokenizer($twig));
-        $factory  = new RulesetFactory();
-        $reporter = new TextFormatter($input, $output);
-        $exitCode = 0;
-
         // Get the rules to apply.
-        $ruleset = $factory->createStandardRuleset();
+        $ruleset = new Ruleset();
+        $ruleset->addStandard();
 
         // Execute the linter.
+        $twig = new StubbedEnvironment();
+        $linter = new Linter($twig, new Tokenizer($twig));
         $report = $linter->run($config->findFiles(), $ruleset);
 
         // Format the output.
+        $reporter = new TextFormatter($input, $output);
         $reporter->display($report, $level);
 
         // Return a meaningful error code.
         if ($report->getTotalErrors()) {
-            $exitCode = 1;
+            return 1;
         }
 
-        return $exitCode;
+        return 0;
     }
 }

TwigCS/Config/Config.php

@@ -16,10 +16,9 @@ class Config
      * @var array
      */
     public static $defaultConfig = [
-        'exclude'          => [],
+        'exclude'          => ['/vendor'],
         'pattern'          => '*.twig',
         'paths'            => [],
-        'stub'             => [],
         'workingDirectory' => '',
     ];
 

TwigCS/Environment/StubbedEnvironment.php

@@ -9,7 +9,7 @@
 use Symfony\Bridge\Twig\TokenParser\TransDefaultDomainTokenParser;
 use Symfony\Bridge\Twig\TokenParser\TransTokenParser;
 use Twig\Environment;
-use Twig\Loader\LoaderInterface;
+use Twig\Loader\ArrayLoader;
 use Twig\TwigFilter;
 use Twig\TwigFunction;
 use Twig\TwigTest;
@@ -34,13 +34,9 @@ class StubbedEnvironment extends Environment
      */
     private $stubTests;
 
-    /**
-     * @param LoaderInterface|null $loader
-     * @param array                $options
-     */
-    public function __construct(LoaderInterface $loader = null, $options = [])
+    public function __construct()
     {
-        parent::__construct($loader, $options);
+        parent::__construct(new ArrayLoader());
 
         $this->addTokenParser(new DumpTokenParser());
         $this->addTokenParser(new FormThemeTokenParser());

TwigCS/Sniff/Standard/BlankEOFSniff.php renamed to TwigCS/Ruleset/Generic/BlankEOFSniff.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace TwigCS\Sniff\Standard;
+namespace TwigCS\Ruleset\Generic;
 
 use \Exception;
 use TwigCS\Sniff\AbstractSniff;

TwigCS/Sniff/Standard/DelimiterSpacingSniff.php renamed to TwigCS/Ruleset/Generic/DelimiterSpacingSniff.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace TwigCS\Sniff\Standard;
+namespace TwigCS\Ruleset\Generic;
 
 use \Exception;
 use TwigCS\Sniff\AbstractSniff;

TwigCS/Sniff/Standard/DisallowCommentedCodeSniff.php renamed to TwigCS/Ruleset/Generic/DisallowCommentedCodeSniff.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace TwigCS\Sniff\Standard;
+namespace TwigCS\Ruleset\Generic;
 
 use \Exception;
 use TwigCS\Sniff\AbstractSniff;

TwigCS/Ruleset/Ruleset.php

@@ -2,6 +2,9 @@
 
 namespace TwigCS\Ruleset;
 
+use \Exception;
+use \SplFileInfo;
+use Symfony\Component\Finder\Finder;
 use TwigCS\Sniff\SniffInterface;
 
 /**
@@ -40,14 +43,29 @@ public function addSniff(SniffInterface $sniff)
     }
 
     /**
-     * @param string $sniffClass
+     * Create a new set of rule.
      *
-     * @return $this
+     * @param string $standardName
+     *
+     * @return Ruleset
+     *
+     * @throws Exception
      */
-    public function removeSniff($sniffClass)
+    public function addStandard($standardName = 'Generic')
     {
-        if (isset($this->sniffs[$sniffClass])) {
-            unset($this->sniffs[$sniffClass]);
+        try {
+            $finder = Finder::create()->in(__DIR__.'/'.$standardName)->files();
+        } catch (Exception $e) {
+            throw new Exception(sprintf('The standard "%s" is not found.', $standardName));
+        }
+
+        /** @var SplFileInfo $file */
+        foreach ($finder as $file) {
+            $class = __NAMESPACE__.'\\'.$standardName.'\\'.$file->getBasename('.php');
+
+            if (class_exists($class)) {
+                $this->addSniff(new $class());
+            }
         }
 
         return $this;

TwigCS/Ruleset/RulesetFactory.php

@@ -4,9 +4,7 @@
 
 use \Exception;
 use \ReflectionClass;
-use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
-use Twig\Loader\LoaderInterface;
 use TwigCS\Environment\StubbedEnvironment;
 use TwigCS\Linter;
 use TwigCS\Report\SniffViolation;
@@ -31,12 +29,15 @@ abstract class AbstractSniffTest extends TestCase
 
     public function setUp()
     {
-        /** @var LoaderInterface|MockObject $twigLoaderInterface */
-        $twigLoaderInterface = $this->getMockBuilder(LoaderInterface::class)->getMock();
-        $this->env = new StubbedEnvironment($twigLoaderInterface);
+        $this->env = new StubbedEnvironment();
         $this->lint = new Linter($this->env, new Tokenizer($this->env));
     }
 
+    /**
+     * Should call $this->checkGenericSniff(new Sniff(), [...]);
+     */
+    abstract public function testSniff();
+
     /**
      * @param SniffInterface $sniff
      * @param array          $expects

TwigCS/Tests/AbstractSniffTest.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace TwigCS\Tests\Sniff;
+namespace TwigCS\Tests\Ruleset\Generic;
 
-use TwigCS\Sniff\Standard\BlankEOFSniff;
+use TwigCS\Ruleset\Generic\BlankEOFSniff;
 use TwigCS\Tests\AbstractSniffTest;
 
 /**

TwigCS/Tests/Sniff/BlankEOFTest.php renamed to TwigCS/Tests/Ruleset/Generic/BlankEOFTest.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace TwigCS\Tests\Sniff;
+namespace TwigCS\Tests\Ruleset\Generic;
 
-use TwigCS\Sniff\Standard\DelimiterSpacingSniff;
+use TwigCS\Ruleset\Generic\DelimiterSpacingSniff;
 use TwigCS\Tests\AbstractSniffTest;
 
 /**

TwigCS/Tests/Sniff/DelimiterSpacingTest.php renamed to TwigCS/Tests/Ruleset/Generic/DelimiterSpacingTest.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace TwigCS\Tests\Sniff;
+namespace TwigCS\Tests\Ruleset\Generic;
 
-use TwigCS\Sniff\Standard\DisallowCommentedCodeSniff;
+use TwigCS\Ruleset\Generic\DisallowCommentedCodeSniff;
 use TwigCS\Tests\AbstractSniffTest;
 
 /**