feature/sniffs_system - twigcs

.travis.yml

@@ -1,9 +1,10 @@
 language: php
 
+dist: trusty
+
 sudo: false
 
 php:
-  - 5.3
   - 5.4
   - 5.5
   - 5.6
@@ -13,3 +14,8 @@ php:
 before_script: composer install
 
 script: phpunit
+
+matrix:
+  include: # https://github.com/travis-ci/travis-ci/issues/7712#issuecomment-300553336
+    - php: "5.3"
+      dist: precise

composer.json

@@ -14,7 +14,13 @@
     "require": {
         "symfony/console": "^2.1 || ^3.0",
         "symfony/finder": "^2.1 || ^3.0",
-        "twig/twig": "^1.16.2"
+        "twig/twig": "^1.16.2",
+        "symfony/config": "^2.8 || ^3.0",
+        "symfony/stopwatch": "^2.8 || ^3.0",
+        "aura/autoload": "^2.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^4.8.36 || ^5.5 || ^6.2"
     },
     "autoload": {
         "psr-0": { "Asm89\\Twig\\Lint\\": "src/" }

src/Asm89/Twig/Lint/Command/LintCommand.php

@@ -50,6 +50,20 @@ protected function configure()
                     InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
                     'Excludes, based on regex, paths of files and folders from parsing'
                 ),
+                new InputOption(
+                    'stub-tag',
+                    '',
+                    InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
+                    'List of tags that the lint command has to provide stub for',
+                    array()
+                ),
+                new InputOption(
+                    'stub-test',
+                    '',
+                    InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
+                    'List of tests that the lint command has to provide stub for',
+                    array()
+                ),
                 new InputOption('only-print-errors', '', InputOption::VALUE_NONE),
                 new InputOption('summary', '', InputOption::VALUE_NONE)
             ))
@@ -81,12 +95,20 @@ protected function configure()
 
     protected function execute(InputInterface $input, CliOutputInterface $output)
     {
-        $twig     = new StubbedEnvironment(new \Twig_Loader_String());
-        $template = null;
-        $filename = $input->getArgument('filename');
-        $exclude  = $input->getOption('exclude');
-        $summary  = $input->getOption('summary');
-        $output   = $this->getOutput($output, $input->getOption('format'));
+        $template      = null;
+        $filename      = $input->getArgument('filename');
+        $exclude       = $input->getOption('exclude');
+        $stubTagList   = $input->getOption('stub-tag');
+        $stubTestsList = $input->getOption('stub-test');
+        $summary       = $input->getOption('summary');
+        $output        = $this->getOutput($output, $input->getOption('format'));
+        $twig          = new StubbedEnvironment(
+            new \Twig_Loader_Array(),
+            array(
+                'stub_tags'  => $stubTagList,
+                'stub_tests' => $stubTestsList,
+            )
+        );
 
         if (!$filename) {
             if (0 !== ftell(STDIN)) {
@@ -151,7 +173,7 @@ protected function validateTemplate(
     )
     {
         try {
-            $twig->parse($twig->tokenize($template, $file ? (string) $file : null));
+            $twig->parse($twig->tokenize(new \Twig_Source($template, $file ? (string) $file : null)));
             if (false === $onlyPrintErrors) {
                 $output->ok($template, $file);
             }

src/Asm89/Twig/Lint/Command/TwigCSCommand.php

@@ -0,0 +1,169 @@
+<?php
+
+/*
+ * This file is part of twig-lint.
+ *
+ * (c) Alexander <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Asm89\Twig\Lint\Command;
+
+use Asm89\Twig\Lint\Config;
+use Asm89\Twig\Lint\Linter;
+use Asm89\Twig\Lint\RulesetFactory;
+use Asm89\Twig\Lint\StubbedEnvironment;
+use Asm89\Twig\Lint\Config\Loader;
+use Asm89\Twig\Lint\Report\TextFormatter;
+use Asm89\Twig\Lint\Tokenizer\Tokenizer;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\Finder\Finder;
+
+/**
+ * TwigCS stands for "Twig Code Sniffer" and will check twig template againt all
+ * rules which have been defined in the twigcs.yml of your project.
+ *
+ * This is heavily inspired by the symfony lint command and PHP_CodeSniffer tool
+ * (https://github.com/squizlabs/PHP_CodeSniffer).
+ *
+ * @author Hussard <[email protected]>
+ */
+class TwigCSCommand extends Command
+{
+    protected function configure()
+    {
+        $this
+            ->setName('twigcs')
+            ->setDescription('Lints a template and outputs encountered errors')
+            ->setDefinition(array(
+                new InputOption(
+                    'exclude',
+                    '',
+                    InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
+                    'Excludes, based on regex, paths of files and folders from parsing',
+                    array()
+                ),
+                new InputOption(
+                    'format',
+                    '',
+                    InputOption::VALUE_OPTIONAL,
+                    'Implemented formats are: full',
+                    'full'
+                ),
+                new InputOption(
+                    'level',
+                    '',
+                    InputOption::VALUE_OPTIONAL,
+                    'Allowed values are: warning, error',
+                    'warning'
+                ),
+                new InputOption(
+                    'severity',
+                    '',
+                    InputOption::VALUE_OPTIONAL,
+                    'Allowed values are: 0 - 10',
+                    ''
+                ),
+                new InputOption(
+                    'working-dir',
+                    '',
+                    InputOption::VALUE_OPTIONAL,
+                    'Run as if this was started in <working-dir> instead of the current working directory',
+                    getcwd()
+                ),
+            ))
+            ->addArgument('filename', InputArgument::OPTIONAL)
+            ->setHelp(<<<EOF
+The <info>%command.name%</info> will check twig templates against a set of rules defined in
+a "twigcs.yml".
+
+<info>php %command.full_name% filename</info>
+
+The command gets the contents of <comment>filename</comment> and outputs violations of the rules to stdout.
+
+<info>php %command.full_name% dirname</info>
+
+The command finds all twig templates in <comment>dirname</comment> and validates the syntax
+of each Twig templates.
+
+EOF
+            )
+        ;
+    }
+
+    /**
+     * @{inheritDoc}
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $filename   = $input->getArgument('filename');
+        $exclude    = $input->getOption('exclude');
+        $format     = $input->getOption('format');
+        $level      = $input->getOption('level');
+        $severity   = $input->getOption('severity');
+        $currentDir = $input->getOption('working-dir');
+
+        // Load config files.
+        $globalLoader = new Loader(new FileLocator(getenv('HOME') . '/.twigcs'));
+        $loader       = new Loader(new FileLocator($currentDir));
+
+        $globalConfig = array();
+        try {
+            $globalConfig = $globalLoader->load('twigcs_global.yml');
+        } catch (\Exception $e) {
+            // The global config file may not exist but it's ok.
+        }
+
+        // Compute the final config object.
+        $config = new Config(
+            $globalConfig,
+            $loader->load('twigcs.yml'),
+            array('workingDirectory' => $currentDir)
+        );
+
+        $twig          = new StubbedEnvironment(new \Twig_Loader_Array(), array('stub_tags' => $config->get('stub')));
+        $linter        = new Linter($twig, new Tokenizer($twig));
+        $factory       = new RulesetFactory();
+        $reporter      = $this->getReportFormatter($input, $output, $format);
+        $exitCode      = 0;
+
+        // Get the rules to apply.
+        $ruleset = $factory->createRulesetFromConfig($config);
+
+        // Execute the linter.
+        $report = $linter->run($config->findFiles(), $ruleset);
+
+        // Format the output.
+        $reporter->display($report, array(
+            'level'     => $level,
+            'severity'  => $severity,
+        ));
+
+        // Return a meaningful error code.
+        if ($report->getTotalErrors()) {
+            $exitCode = 1;
+        }
+
+        return $exitCode;
+    }
+
+    protected function getReportFormatter($input, $output, $format)
+    {
+        switch ($format) {
+            case 'full':
+                return new TextFormatter($input, $output, array('explain' => true));
+            case 'text':
+                return new TextFormatter($input, $output);
+            default:
+                throw new \Exception(sprintf('Unknown format "%s"', $format));
+        }
+    }
+}

src/Asm89/Twig/Lint/Config.php

@@ -0,0 +1,134 @@
+<?php
+
+/*
+ * This file is part of twig-lint.
+ *
+ * (c) Alexander <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Asm89\Twig\Lint;
+
+use Aura\Autoload\Loader as Autoloader;
+use Symfony\Component\Finder\Finder;
+
+/**
+ * TwigCS configuration data.
+ *
+ * @author Hussard <[email protected]>
+ */
+class Config
+{
+    /**
+     * Default configuration.
+     *
+     * @var array
+     */
+    public static $defaultConfig = array(
+        'exclude'          => array(),
+        'pattern'          => '*.twig',
+        'paths'            => array(),
+        'standardPaths'    => array(),
+        'stub'             => array(),
+        'workingDirectory' => '',
+    );
+
+    /**
+     * Current configuration.
+     *
+     * @var array
+     */
+    protected $config;
+
+    /**
+     * Autoloader for sniffs.
+     *
+     * @var Autoloader\Loader
+     */
+    protected $autoloader;
+
+    /**
+     * Constructor.
+     */
+    public function __construct()
+    {
+        $args = func_get_args();
+
+        $this->config = $this::$defaultConfig;
+        foreach ($args as $arg) {
+            $this->config = array_merge($this->config, $arg);
+        }
+
+        $this->autoloader = new Autoloader();
+        $this->autoloader->register();
+
+        $standardPaths = $this->get('standardPaths');
+        if ($standardPaths) {
+            $this->autoloader->setPrefixes($standardPaths);
+        }
+    }
+
+    /**
+     * Find all files to process, based on a file or directory and exclude patterns.
+     *
+     * @param  string $fileOrDirectory a file or a directory.
+     * @param  array  $exclude         array of exclude patterns.
+     *
+     * @return array
+     */
+    public function findFiles($fileOrDirectory = null, $exclude = null)
+    {
+        $files = array();
+
+        if (is_file($fileOrDirectory)) {
+            // Early return with the given file. Should we exclude things to here?
+            return array($fileOrDirectory);
+        }
+
+        if (is_dir($fileOrDirectory)) {
+            $fileOrDirectory = array($fileOrDirectory);
+        }
+
+        if (!$fileOrDirectory) {
+            $fileOrDirectory = $this->get('paths');
+            $exclude = $this->get('exclude');
+        }
+
+        // Build the finder.
+        $files = Finder::create()
+            ->in($this->get('workingDirectory'))
+            ->name($this->config['pattern'])
+            ->files()
+        ;
+
+        // Include all matching paths.
+        foreach ($fileOrDirectory as $path) {
+            $files->path($path);
+        }
+
+        // Exclude all matching paths.
+        if ($exclude) {
+            $files->exclude($exclude);
+        }
+
+        return $files;
+    }
+
+    /**
+     * Get a configuration value for the given $key.
+     *
+     * @param  string $key
+     *
+     * @return any
+     */
+    public function get($key)
+    {
+        if (!isset($this->config[$key])) {
+            throw new \Exception(sprintf('Configuration key "%s" does not exist', $key));
+        }
+
+        return $this->config[$key];
+    }
+}