More modernization

.gitignore

@@ -10,3 +10,4 @@
 /Vagrantfile
 /.vagrant
 /node_modules
+.phpunit.result.cache

.travis.yml

@@ -40,4 +40,3 @@ deploy:
     repo: CouscousPHP/Couscous
     tags: true
     php: '7.1'
-

bin/compile

@@ -39,7 +39,7 @@ $builder->buildFromIterator(
         ->files()
         ->name('*.php')
         ->name('*.pem*')
-        ->exclude(['Tests', 'tests', 'phpunit'])
+        ->exclude(['Tests', 'tests'])
         ->in($couscousDir . '/vendor')
         ->getIterator(),
     $couscousDir

composer.json

@@ -16,28 +16,23 @@
     ],
     "require": {
         "php": ">=7.1",
-        "symfony/console": "~3.0|~4.0|~5.0",
-        "symfony/filesystem": "~3.0|~4.0|~5.0",
-        "symfony/finder": "~3.0|~4.0|~5.0",
-        "symfony/process": "~3.0|~4.0|~5.0",
-        "symfony/yaml": "~3.0|~4.0|~5.0",
-        "twig/twig": "~1.10",
-        "erusev/parsedown": "~1.7.4",
-        "erusev/parsedown-extra": "~0.8",
-        "phine/phar": "~1.0",
-        "mnapoli/front-yaml": "~1.5",
-        "php-di/php-di": "^5.2.1",
-        "psr/log": "~1.0",
+        "symfony/console": "^3.0|^4.0|^5.0",
+        "symfony/filesystem": "^3.0|^4.0|^5.0",
+        "symfony/finder": "^3.0|^4.0|^5.0",
+        "symfony/process": "^3.0|^4.0|^5.0",
+        "symfony/yaml": "^3.0|^4.0|^5.0",
+        "twig/twig": "^1.10",
+        "erusev/parsedown": "^1.7",
+        "erusev/parsedown-extra": "^0.8",
+        "phine/phar": "^1.0",
+        "mnapoli/front-yaml": "^1.5",
+        "php-di/php-di": "^5.2",
+        "psr/log": "^1.0",
         "padraic/phar-updater": "^1.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "~7.5",
+        "phpunit/phpunit": "^7.5|^8.5|^9.3",
         "squizlabs/php_codesniffer": "^3.3",
         "vimeo/psalm": "^3.16"
-    },
-    "config": {
-        "platform": {
-            "php": "7.1.3"
-        }
     }
 }

phpunit.xml.dist

@@ -5,7 +5,6 @@
          convertWarningsToExceptions="true"
          beStrictAboutOutputDuringTests="true"
          beStrictAboutTestsThatDoNotTestAnything="true"
-         forceCoversAnnotation="true"
          bootstrap="./vendor/autoload.php">
 
     <testsuites>

src/Application/Cli/ClearCommand.php

@@ -29,13 +29,19 @@ public function __construct(Filesystem $filesystem)
         parent::__construct();
     }
 
+    /**
+     * {@inheritdoc}
+     */
     protected function configure(): void
     {
         $this
             ->setName('clear')
             ->setDescription('Clear all files generated by Couscous');
     }
 
+    /**
+     * {@inheritdoc}
+     */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $dir = getcwd().'/.couscous';

src/Application/Cli/DeployCommand.php

@@ -12,7 +12,6 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Filesystem\Filesystem;
 
 /**
  * Generate and deploy the website.
@@ -31,21 +30,15 @@ class DeployCommand extends Command
      */
     private $deployer;
 
-    /**
-     * @var Filesystem
-     */
-    private $filesystem;
-
     /**
      * @var Git
      */
     private $git;
 
-    public function __construct(Generator $generator, Deployer $deployer, Filesystem $filesystem, Git $git)
+    public function __construct(Generator $generator, Deployer $deployer, Git $git)
     {
         $this->generator = $generator;
         $this->deployer = $deployer;
-        $this->filesystem = $filesystem;
         $this->git = $git;
 
         parent::__construct();

src/Application/Cli/GenerateCommand.php

@@ -30,6 +30,9 @@ public function __construct(Generator $generator)
         parent::__construct();
     }
 
+    /**
+     * {@inheritdoc}
+     */
     protected function configure(): void
     {
         $this
@@ -57,6 +60,9 @@ protected function configure(): void
             );
     }
 
+    /**
+     * {@inheritdoc}
+     */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         /** @var string */

src/Application/Cli/InitTemplateCommand.php

@@ -15,6 +15,9 @@
  */
 class InitTemplateCommand extends Command
 {
+    /**
+     * {@inheritdoc}
+     */
     protected function configure(): void
     {
         $this
@@ -34,6 +37,9 @@ protected function configure(): void
         );
     }
 
+    /**
+     * {@inheritdoc}
+     */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $fileExtension = '.twig';

src/Application/Cli/PreviewCommand.php

@@ -220,7 +220,7 @@ private function startLivereload(
 
     private function isFound(string $executablePath): bool
     {
-        if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
+        if (stripos(PHP_OS, 'WIN') === 0) {
             $folders = explode(';', (string) getenv('PATH'));
         } else {
             $folders = explode(':', (string) getenv('PATH'));
@@ -237,7 +237,7 @@ private function isFound(string $executablePath): bool
 
     private function fileListToDisplay(array $files, string $sourceDirectory): string
     {
-        $files = array_map(function (string $file) use ($sourceDirectory): string {
+        $files = array_map(static function (string $file) use ($sourceDirectory): string {
             return substr($file, strlen($sourceDirectory) + 1);
         }, $files);
 

src/Application/Cli/TravisAutoDeployCommand.php

@@ -93,23 +93,23 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         if ($travisBranch !== 'master') {
             $output->writeln('<comment>[NOT DEPLOYED] Deploying Couscous only for master branch</comment>');
 
-            return 0;
+            return 1;
         }
 
-        $isPullRequest = (int) getenv('TRAVIS_PULL_REQUEST') > 0 ? true : false;
+        $isPullRequest = (int) getenv('TRAVIS_PULL_REQUEST') > 0;
 
         if ($isPullRequest) {
             $output->writeln('<comment>[NOT DEPLOYED] Not deploying Couscous for pull requests</comment>');
 
-            return 0;
+            return 1;
         }
 
         // getting current php version to only deploy once
         $currentPhpVersion = getenv('TRAVIS_PHP_VERSION');
-        if ($input->getOption('php-version') != $currentPhpVersion) {
+        if ($input->getOption('php-version') !== $currentPhpVersion) {
             $output->writeln('<comment>This version of the documentation is already deployed</comment>');
 
-            return 0;
+            return 1;
         }
 
         // set git user data

src/CommandRunner/Git.php

@@ -61,11 +61,13 @@ public function getRemoteUrl(string $remote = 'origin'): string
      * Check if the git repository in the provided directory has any uncommitted changes
      *
      * @param string $directory A directory containing a git repository
+     *
      * @return bool True if there are changes, false otherwise
      */
     public function hasUncommittedChanges(string $directory): bool
     {
         $changes = $this->run($directory, "git diff-index --name-only HEAD");
+
         return !(ctype_space($changes) || $changes = '');
     }
 

src/Model/ExcludeList.php

@@ -47,7 +47,7 @@ public function toArray(): array
         $excluded = $this->excluded;
         $excluded = array_filter($excluded, [$this, 'keepEntry']);
         $excluded = array_map([$this, 'sanitizeEntry'], $excluded);
-        $excluded = array_map(function (string $entry): string {
+        $excluded = array_map(static function (string $entry): string {
             return trim($entry, '/');
         }, $excluded);
 
@@ -69,8 +69,8 @@ private function keepEntry($entry): bool
         switch (true) {
             case !is_string($entry) && !is_numeric($entry):
             case $entry === '':
-            case is_string($entry) && (preg_match('/^[#!]/', $entry) > 0):
-            case is_string($entry) && (strpos($entry, '*') !== false):
+            case preg_match('/^[#!]/', (string) $entry) > 0:
+            case strpos((string) $entry, '*') !== false:
                 return false;
 
             default:

src/Model/Metadata.php

@@ -24,7 +24,7 @@ class Metadata implements \ArrayAccess
     /**
      * @var array
      */
-    private $values = [];
+    private $values;
 
     public function __construct(array $values = [])
     {

src/Model/Project.php

@@ -100,7 +100,7 @@ public function findFilesByType(string $class): array
             ));
         }
 
-        return array_filter($this->files, function (File $file) use ($class): bool {
+        return array_filter($this->files, static function (File $file) use ($class): bool {
             return $file instanceof $class;
         });
     }
@@ -111,7 +111,7 @@ public function findFilesByType(string $class): array
     public function sourceFiles(): Finder
     {
         /** @var list<string> */
-        $includedDirectories = $this->metadata['include'] ? $this->metadata['include'] : [];
+        $includedDirectories = $this->metadata['include'] ?: [];
 
         // To be sure that included directories are under the source one
         if (!empty($includedDirectories)) {
@@ -121,7 +121,7 @@ public function sourceFiles(): Finder
         }
 
         /** @var list<string> */
-        $exclude = $this->metadata['exclude'] ? $this->metadata['exclude'] : [];
+        $exclude = $this->metadata['exclude'] ?: [];
         $excludedDirectories = new ExcludeList($exclude);
 
         if (is_file($this->sourceDirectory.'/.gitignore')) {

src/Model/WatchList/FileWatch.php

@@ -25,6 +25,9 @@ public function __construct(string $filename)
         $this->time = time();
     }
 
+    /**
+     * @return string[]
+     */
     public function getChangedFiles(): array
     {
         if (!file_exists($this->filename)) {

src/Model/WatchList/WatchList.php

@@ -38,12 +38,12 @@ public function watchDirectory(string $directory): void
 
     public function getChangedFiles(): array
     {
-        $files = array_map(function (WatchInterface $watch): array {
+        $files = array_map(static function (WatchInterface $watch): array {
             return $watch->getChangedFiles();
         }, $this->watches);
 
         /** @var list<string> */
-        $files = call_user_func_array('array_merge', $files);
+        $files = array_merge(...$files);
 
         return array_unique($files);
     }

src/Module/Config/Step/LoadConfig.php

@@ -17,7 +17,7 @@
  */
 class LoadConfig implements Step
 {
-    const FILENAME = 'couscous.yml';
+    private const FILENAME = 'couscous.yml';
 
     /**
      * @var Filesystem

src/Module/Config/Step/OverrideBaseUrlForPreview.php

@@ -4,13 +4,14 @@
 namespace Couscous\Module\Config\Step;
 
 use Couscous\Model\Project;
+use Couscous\Step;
 
 /**
  * Override the baseUrl if we are in preview.
  *
  * @author Matthieu Napoli <matthieu@mnapoli.fr>
  */
-class OverrideBaseUrlForPreview implements \Couscous\Step
+class OverrideBaseUrlForPreview implements Step
 {
     public function __invoke(Project $project): void
     {

src/Module/Config/Step/OverrideConfigFromCLI.php

@@ -4,14 +4,15 @@
 namespace Couscous\Module\Config\Step;
 
 use Couscous\Model\Project;
+use Couscous\Step;
 use Psr\Log\LoggerInterface;
 
 /**
  * Override config variables when specified using --config option.
  *
  * @author D.J. Marcolesco <dj.marcolesco@gmail.com>
  */
-class OverrideConfigFromCLI implements \Couscous\Step
+class OverrideConfigFromCLI implements Step
 {
     /**
      * @var LoggerInterface

src/Module/Markdown/Step/CreateHeadingIds.php

@@ -50,7 +50,7 @@ private function render(string $content): string
      */
     private function addAttributeId(array $matches): string
     {
-        $id = $this->slugfy($matches[2]);
+        $id = $this->slugify($matches[2]);
         if (!isset($this->ids[$id])) {
             $this->ids[$id] = 0;
         }
@@ -67,7 +67,7 @@ private function addAttributeId(array $matches): string
         return $replacement;
     }
 
-    private function slugfy(string $text): string
+    private function slugify(string $text): string
     {
         $slug = trim($text);
         $slug = strtr($slug, ' ', '-');

src/Module/Markdown/Step/RewriteMarkdownLinks.php

@@ -19,7 +19,7 @@ class RewriteMarkdownLinks implements Step
      *
      * @link https://regex101.com/
      */
-    const MARKDOWN_LINK_REGEX = '/\[(?:[^\]]+)\]\(([^\)]+\/)?([A-Za-z0-9_\.\-]+\.md)([^.\)][^\)]*)?\)/';
+    private const MARKDOWN_LINK_REGEX = '/\[(?:[^\]]+)\]\(([^\)]+\/)?([A-Za-z0-9_\.\-]+\.md)([^.\)][^\)]*)?\)/';
 
     public function __invoke(Project $project): void
     {
@@ -41,7 +41,7 @@ private function replaceFilename(array $matches): string
     {
         $filename = strtolower($matches[2]);
         $filename = str_replace('.md', '.html', $filename);
-        if ($filename == 'readme.html') {
+        if ($filename === 'readme.html') {
             $filename = 'index.html';
         }
 

src/Module/Template/Step/AddLivereloadSnippet.php

@@ -14,7 +14,7 @@
  */
 class AddLivereloadSnippet implements Step
 {
-    const LIVERELOAD_SNIPPET = '
+    private const LIVERELOAD_SNIPPET = '
         <!-- Livereload -->
         <script>
             document.write(\'<script src="http://\' + (location.host || \'localhost\').split(\':\')[0] +