Enhancement: Rename (A|a)nalyser to (A|a)nalyzer

.github/workflows/build.yaml

@@ -41,22 +41,22 @@ jobs:
                 run: ./box compile
 
             -   name: "Run phar without cache"
-                run: bin/doctor-rst.phar analyse dummy/ --no-cache
+                run: bin/doctor-rst.phar analyze dummy/ --no-cache
 
             -   name: "Cache file should not exist"
                 run: "[ ! -f '.doctor-rst.cache' ]"
 
             -   name: "Run phar with cache enabled"
-                run: bin/doctor-rst.phar analyse dummy/
+                run: bin/doctor-rst.phar analyze dummy/
 
             -   name: "Cache file should exist"
                 run: "[ -f '.doctor-rst.cache' ]"
 
             -   name: "Run phar again with cache enabled to be sure the cache file could be reused"
-                run: bin/doctor-rst.phar analyse dummy/
+                run: bin/doctor-rst.phar analyze dummy/
 
             -   name: "Run phar with custom cache file output"
-                run: bin/doctor-rst.phar analyse dummy/ --cache-file=.doctor-rst.cache2
+                run: bin/doctor-rst.phar analyze dummy/ --cache-file=.doctor-rst.cache2
 
             -   name: "Custom cache file should exist"
                 run: "[ -f '.doctor-rst.cache2' ]"

config/cache.yaml

@@ -3,6 +3,6 @@ services:
         autowire: true
         autoconfigure: true
 
-    App\Analyser\Cache: '@App\Analyser\FileCache'
-    App\Analyser\FileCache:
+    App\Analyzer\Cache: '@App\Analyzer\FileCache'
+    App\Analyzer\FileCache:
         $cacheFile: '%cache.file%'

config/services.yaml

@@ -17,12 +17,12 @@ services:
         resource: '../src/*'
         exclude: '../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}'
 
-    App\Analyser\Cache: '@App\Analyser\InMemoryCache'
+    App\Analyzer\Cache: '@App\Analyzer\InMemoryCache'
 
-    App\Analyser\MemoizingAnalyser:
-        $analyser: '@App\Analyser\RstAnalyser'
+    App\Analyzer\MemoizingAnalyzer:
+        $analyzer: '@App\Analyzer\RstAnalyzer'
 
-    App\Command\AnalyseCommand:
+    App\Command\AnalyzeCommand:
         public: true
     App\Command\RulesCommand:
         public: true

entrypoint.sh

@@ -1,3 +1,3 @@
 #!/bin/sh -l
 
-sh -c "php /usr/bin/doctor-rst analyse $DOCS_DIR $*"
+sh -c "php /usr/bin/doctor-rst analyze $DOCS_DIR $*"

src/Analyser/Analyser.php → src/Analyzer/Analyzer.php

@@ -11,18 +11,18 @@
  * file that was distributed with this source code.
  */
 
-namespace App\Analyser;
+namespace App\Analyzer;
 
 use App\Rule\Rule;
 use App\Value\Violation;
 use SplFileInfo;
 
-interface Analyser
+interface Analyzer
 {
     /**
      * @param Rule[] $rules
      *
      * @return Violation[]
      */
-    public function analyse(SplFileInfo $file, array $rules): array;
+    public function analyze(SplFileInfo $file, array $rules): array;
 }

src/Analyser/Cache.php → src/Analyzer/Cache.php

@@ -11,7 +11,7 @@
  * file that was distributed with this source code.
  */
 
-namespace App\Analyser;
+namespace App\Analyzer;
 
 use SplFileInfo;
 

src/Analyser/FileCache.php → src/Analyzer/FileCache.php

@@ -11,7 +11,7 @@
  * file that was distributed with this source code.
  */
 
-namespace App\Analyser;
+namespace App\Analyzer;
 
 use App\Application;
 use App\Value\Violation;

src/Analyser/InMemoryCache.php → src/Analyzer/InMemoryCache.php

@@ -11,7 +11,7 @@
  * file that was distributed with this source code.
  */
 
-namespace App\Analyser;
+namespace App\Analyzer;
 
 use SplFileInfo;
 

src/Analyser/MemoizingAnalyser.php → src/Analyzer/MemoizingAnalyzer.php

@@ -11,31 +11,31 @@
  * file that was distributed with this source code.
  */
 
-namespace App\Analyser;
+namespace App\Analyzer;
 
 use SplFileInfo;
 
-final class MemoizingAnalyser implements Analyser
+final class MemoizingAnalyzer implements Analyzer
 {
-    private Analyser $analyser;
+    private Analyzer $analyzer;
     private Cache $cache;
 
-    public function __construct(Analyser $analyser, Cache $cache)
+    public function __construct(Analyzer $analyzer, Cache $cache)
     {
-        $this->analyser = $analyser;
+        $this->analyzer = $analyzer;
         $this->cache = $cache;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function analyse(SplFileInfo $file, array $rules): array
+    public function analyze(SplFileInfo $file, array $rules): array
     {
         if ($this->cache->has($file, $rules)) {
             return $this->cache->get($file, $rules);
         }
 
-        $violations = $this->analyser->analyse($file, $rules);
+        $violations = $this->analyzer->analyze($file, $rules);
         $this->cache->set($file, $rules, $violations);
 
         return $violations;

src/Analyser/RstAnalyser.php → src/Analyzer/RstAnalyzer.php

@@ -11,22 +11,22 @@
  * file that was distributed with this source code.
  */
 
-namespace App\Analyser;
+namespace App\Analyzer;
 
 use App\Rule\Rule;
 use App\Value\Lines;
 use App\Value\Violation;
 use SplFileInfo;
 use Symfony\Contracts\Service\ResetInterface;
 
-final class RstAnalyser implements Analyser
+final class RstAnalyzer implements Analyzer
 {
     /**
      * @param Rule[] $rules
      *
      * @return Violation[]
      */
-    public function analyse(SplFileInfo $file, array $rules): array
+    public function analyze(SplFileInfo $file, array $rules): array
     {
         $realpath = $file->getRealPath();
         if (false === $realpath) {

src/Application.php

@@ -13,7 +13,7 @@
 
 namespace App;
 
-use App\Command\AnalyseCommand;
+use App\Command\AnalyzeCommand;
 use App\Command\RulesCommand;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\Console\Application as BaseApplication;
@@ -41,8 +41,8 @@ public function doRun(InputInterface $input, OutputInterface $output): int
     {
         $container = $this->buildContainer($input);
 
-        /** @var AnalyseCommand $analyseCommand */
-        $analyseCommand = $container->get(AnalyseCommand::class);
+        /** @var AnalyzeCommand $analyseCommand */
+        $analyseCommand = $container->get(AnalyzeCommand::class);
 
         /** @var RulesCommand $rulesCommand */
         $rulesCommand = $container->get(RulesCommand::class);

src/Command/AnalyseCommand.php → src/Command/AnalyzeCommand.php

@@ -13,12 +13,12 @@
 
 namespace App\Command;
 
-use App\Analyser\MemoizingAnalyser;
+use App\Analyzer\MemoizingAnalyzer;
 use App\Formatter\Registry as FormatterRegistry;
 use App\Handler\Registry;
 use App\Rule\Configurable;
 use App\Rule\Rule;
-use App\Value\AnalyserResult;
+use App\Value\AnalyzerResult;
 use App\Value\ExcludedViolationList;
 use App\Value\FileResult;
 use App\Value\RuleGroup;
@@ -32,22 +32,22 @@
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Yaml\Yaml;
 
-class AnalyseCommand extends Command
+class AnalyzeCommand extends Command
 {
-    protected static $defaultName = 'analyse';
+    protected static $defaultName = 'analyze';
 
     private Registry $registry;
 
     /** @var Rule[] */
     private array $rules = [];
 
-    private MemoizingAnalyser $analyser;
+    private MemoizingAnalyzer $analyzer;
     private FormatterRegistry $formatterRegistry;
 
-    public function __construct(Registry $registry, MemoizingAnalyser $analyser, FormatterRegistry $formatterRegistry)
+    public function __construct(Registry $registry, MemoizingAnalyzer $analyzer, FormatterRegistry $formatterRegistry)
     {
         $this->registry = $registry;
-        $this->analyser = $analyser;
+        $this->analyzer = $analyzer;
         $this->formatterRegistry = $formatterRegistry;
 
         parent::__construct();
@@ -57,6 +57,7 @@ protected function configure(): void
     {
         $this
             ->setDescription('Analyse *.rst files')
+            ->setAliases(['analyse'])
             ->addArgument('dir', InputArgument::OPTIONAL, 'Directory', '.')
             ->addOption('rule', 'r', InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Which rule should be applied?')
             ->addOption('group', 'g', InputOption::VALUE_REQUIRED, 'Which groups should be used?')
@@ -143,18 +144,18 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $file,
                 new ExcludedViolationList(
                     $config['whitelist'] ?? [],
-                    $this->analyser->analyse($file, $this->rules)
+                    $this->analyzer->analyze($file, $this->rules)
                 )
             );
         }
-        $analyserResult = new AnalyserResult($fileResults);
+        $analyzerResult = new AnalyzerResult($fileResults);
 
-        $this->analyser->write();
+        $this->analyzer->write();
 
         $this->formatterRegistry
             ->get($errorFormat)
-            ->format($io, $analyserResult, $analyseDir, $showValidFiles);
+            ->format($io, $analyzerResult, $analyseDir, $showValidFiles);
 
-        return $analyserResult->hasViolations() ? 1 : 0;
+        return $analyzerResult->hasViolations() ? 1 : 0;
     }
 }

src/Formatter/ConsoleFormatter.php

@@ -13,7 +13,7 @@
 
 namespace App\Formatter;
 
-use App\Value\AnalyserResult;
+use App\Value\AnalyzerResult;
 use App\Value\FileResult;
 use App\Value\Violation;
 use Symfony\Component\Console\Style\OutputStyle;
@@ -22,12 +22,12 @@ class ConsoleFormatter implements Formatter
 {
     public function format(
         OutputStyle $style,
-        AnalyserResult $analyserResult,
+        AnalyzerResult $analyzerResult,
         string $analyseDir,
         bool $showValidFiles
     ): void {
         $violatedFiles = 0;
-        foreach ($analyserResult->all() as $fileResult) {
+        foreach ($analyzerResult->all() as $fileResult) {
             if ($fileResult->violationList()->hasViolations()) {
                 ++$violatedFiles;
                 $this->formatViolationList($style, $analyseDir, $fileResult);

src/Formatter/Formatter.php

@@ -13,12 +13,12 @@
 
 namespace App\Formatter;
 
-use App\Value\AnalyserResult;
+use App\Value\AnalyzerResult;
 use Symfony\Component\Console\Style\OutputStyle;
 
 interface Formatter
 {
-    public function format(OutputStyle $style, AnalyserResult $analyserResult, string $analyseDir, bool $showValidFiles): void;
+    public function format(OutputStyle $style, AnalyzerResult $analyzerResult, string $analyseDir, bool $showValidFiles): void;
 
     public function name(): string;
 }

src/Formatter/GithubFormatter.php

@@ -13,14 +13,14 @@
 
 namespace App\Formatter;
 
-use App\Value\AnalyserResult;
+use App\Value\AnalyzerResult;
 use Symfony\Component\Console\Style\OutputStyle;
 
 class GithubFormatter implements Formatter
 {
-    public function format(OutputStyle $style, AnalyserResult $analyserResult, string $analyseDir, bool $showValidFiles): void
+    public function format(OutputStyle $style, AnalyzerResult $analyzerResult, string $analyseDir, bool $showValidFiles): void
     {
-        foreach ($analyserResult->all() as $fileResult) {
+        foreach ($analyzerResult->all() as $fileResult) {
             foreach ($fileResult->violationList()->violations() as $violation) {
                 $style->writeln(sprintf(
                     '::error file=%s,line=%s::%s',

src/Value/AnalyserResult.php → src/Value/AnalyzerResult.php

@@ -13,7 +13,7 @@
 
 namespace App\Value;
 
-final class AnalyserResult
+final class AnalyzerResult
 {
     /** @var FileResult[] */
     private array $results;

tests/Analyser/FileCacheTest.php → tests/Analyzer/FileCacheTest.php

@@ -11,9 +11,9 @@
  * file that was distributed with this source code.
  */
 
-namespace App\Tests\Analyser;
+namespace App\Tests\Analyzer;
 
-use App\Analyser\FileCache;
+use App\Analyzer\FileCache;
 use App\Application;
 use org\bovigo\vfs\vfsStream;
 use org\bovigo\vfs\vfsStreamDirectory;