Improves Diff class naming

src/Diff/Diff.php → src/Diff/DiffChangeset.php

@@ -4,7 +4,7 @@
 
 namespace DocbookCS\Diff;
 
-final readonly class Diff
+final readonly class DiffChangeset
 {
     /** @param list<FileChange> $fileChanges */
     public function __construct(public array $fileChanges)

src/Diff/DiffParser.php

@@ -8,7 +8,7 @@ final class DiffParser
 {
     private const string NO_FINAL_LINE_MARKER = '\ No newline at end of file';
 
-    public function parse(string $diff): Diff
+    public function parse(string $diff): DiffChangeset
     {
         /** @var array<string, list<int>> $changedLinesByFile */
         $changedLinesByFile = [];
@@ -108,6 +108,6 @@ public function parse(string $diff): Diff
             );
         }
 
-        return new Diff($fileChanges);
+        return new DiffChangeset($fileChanges);
     }
 }

src/Path/DiffPathLoader.php

@@ -4,22 +4,22 @@
 
 namespace DocbookCS\Path;
 
-use DocbookCS\Diff\Diff;
+use DocbookCS\Diff\DiffChangeset;
 use DocbookCS\Diff\FileChange;
 
 final readonly class DiffPathLoader
 {
     /** @param array<string, string> $projectRoots */
     public function __construct(
-        private Diff $diff,
+        private DiffChangeset $diff,
         private string $workingDirectory,
         private string $basePath,
         private array $projectRoots,
         private PathMatcher $matcher,
     ) {
     }
 
-    public function load(): Diff
+    public function load(): DiffChangeset
     {
         $changes = [];
 
@@ -42,7 +42,7 @@ public function load(): Diff
 
         ksort($changes);
 
-        return new Diff(array_values($changes));
+        return new DiffChangeset(array_values($changes));
     }
 
     /** @return list<string> */

src/Runner/RunPlanner.php

@@ -5,7 +5,7 @@
 namespace DocbookCS\Runner;
 
 use DocbookCS\Config\ConfigData;
-use DocbookCS\Diff\Diff;
+use DocbookCS\Diff\DiffChangeset;
 use DocbookCS\Diff\DiffParser;
 use DocbookCS\Diff\DiffProviderInterface;
 use DocbookCS\Diff\GitDiffProvider;
@@ -65,7 +65,7 @@ public function planPaths(array $paths): RunPlan
     }
 
     /** @throws \UnexpectedValueException if an entity directory cannot be read. */
-    public function planDiff(Diff $diff): RunPlan
+    public function planDiff(DiffChangeset $diff): RunPlan
     {
         return new RunPlan(
             mode: $this->mode,

src/Runner/RunScopeResolver.php

@@ -5,7 +5,7 @@
 namespace DocbookCS\Runner;
 
 use DocbookCS\Config\ConfigData;
-use DocbookCS\Diff\Diff;
+use DocbookCS\Diff\DiffChangeset;
 use DocbookCS\Diff\FileChange;
 use DocbookCS\Path\DiffPathLoader;
 use DocbookCS\Path\PathLoader;
@@ -46,7 +46,7 @@ public function resolvePaths(array $paths): array
     }
 
     /** @return array<string, FileChange|null> */
-    public function resolveDiff(Diff $diff): array
+    public function resolveDiff(DiffChangeset $diff): array
     {
         $resolvedDiff = new DiffPathLoader(
             $diff,

tests/Unit/ApplicationInputTest.php

@@ -8,8 +8,8 @@
 use DocbookCS\Config\ConfigData;
 use DocbookCS\Config\ConfigParser;
 use DocbookCS\Config\SniffEntry;
-use DocbookCS\Diff\Diff;
 use DocbookCS\Diff\DiffBaseResolver;
+use DocbookCS\Diff\DiffChangeset;
 use DocbookCS\Diff\DiffParser;
 use DocbookCS\Diff\GitDiffProvider;
 use DocbookCS\Diff\UpstreamResolver;
@@ -41,8 +41,8 @@
     UsesClass(ConfigData::class),
     UsesClass(ConfigParser::class),
     UsesClass(ConsoleReporter::class),
-    UsesClass(Diff::class),
     UsesClass(DiffBaseResolver::class),
+    UsesClass(DiffChangeset::class),
     UsesClass(DiffParser::class),
     UsesClass(DiffPathLoader::class),
     UsesClass(EntityPreprocessor::class),

tests/Unit/ApplicationTest.php

@@ -9,8 +9,8 @@
 use DocbookCS\Config\ConfigParser;
 use DocbookCS\Config\ConfigParserException;
 use DocbookCS\Config\SniffEntry;
-use DocbookCS\Diff\Diff;
 use DocbookCS\Diff\DiffBaseResolver;
+use DocbookCS\Diff\DiffChangeset;
 use DocbookCS\Diff\DiffParser;
 use DocbookCS\Diff\FileChange;
 use DocbookCS\Diff\GitDiffProvider;
@@ -69,8 +69,9 @@
     CoversClass(RunPlanner::class),
     CoversClass(SniffEntry::class),
     CoversClass(XmlFileProcessor::class),
-    UsesClass(Diff::class),
+    //
     UsesClass(DiffBaseResolver::class),
+    UsesClass(DiffChangeset::class),
     UsesClass(DiffPathLoader::class),
     UsesClass(File::class),
     UsesClass(FileChange::class),

tests/Unit/Diff/DiffParserTest.php

@@ -4,7 +4,7 @@
 
 namespace DocbookCS\Tests\Unit\Diff;
 
-use DocbookCS\Diff\Diff;
+use DocbookCS\Diff\DiffChangeset;
 use DocbookCS\Diff\DiffParser;
 use DocbookCS\Diff\FileChange;
 use PHPUnit\Framework\Attributes\CoversClass;
@@ -16,7 +16,7 @@
     CoversClass(DiffParser::class),
     CoversClass(FileChange::class),
     //
-    UsesClass(Diff::class),
+    UsesClass(DiffChangeset::class),
 ]
 final class DiffParserTest extends TestCase
 {
@@ -278,7 +278,7 @@ public function itHandlesHunkWithNoContext(): void
 
     // TODO: avoids test diff churn; remove when fixers merged
     /** @return array<string, list<int>> */
-    private function lineNumbersByFile(Diff $diff): array
+    private function lineNumbersByFile(DiffChangeset $diff): array
     {
         $lineNumbersByFile = [];
 

tests/Unit/Path/DiffPathLoaderTest.php

@@ -4,7 +4,7 @@
 
 namespace DocbookCS\Tests\Unit\Path;
 
-use DocbookCS\Diff\Diff;
+use DocbookCS\Diff\DiffChangeset;
 use DocbookCS\Diff\FileChange;
 use DocbookCS\Path\DiffPathLoader;
 use DocbookCS\Path\PathMatcher;
@@ -14,7 +14,7 @@
 use PHPUnit\Framework\TestCase;
 
 #[
-    CoversClass(Diff::class),
+    CoversClass(DiffChangeset::class),
     CoversClass(DiffPathLoader::class),
     CoversClass(PathMatcher::class),
     //
@@ -44,7 +44,7 @@ public function itLoadsChangedXmlFilesWithoutScanningConfiguredPaths(): void
         file_put_contents($file, '<chapter/>');
 
         $loader = new DiffPathLoader(
-            new Diff([new FileChange('docs/chapter.xml', [1])]),
+            new DiffChangeset([new FileChange('docs/chapter.xml', [1])]),
             workingDirectory: dirname($this->directory),
             basePath: $this->directory,
             projectRoots: [$this->directory => 'docs'],
@@ -64,7 +64,7 @@ public function itIgnoresMissingNonXmlAndExcludedFiles(): void
         file_put_contents($excluded, '<chapter/>');
 
         $loader = new DiffPathLoader(
-            new Diff([
+            new DiffChangeset([
                 new FileChange('excluded.xml', [1]),
                 new FileChange('notes.txt', [1]),
                 new FileChange('missing.xml', [1]),
@@ -85,7 +85,7 @@ public function itLoadsAbsolutePaths(): void
         file_put_contents($file, '<chapter/>');
 
         $loader = new DiffPathLoader(
-            new Diff([new FileChange($file, [1])]),
+            new DiffChangeset([new FileChange($file, [1])]),
             workingDirectory: $this->directory,
             basePath: $this->directory,
             projectRoots: [],
@@ -102,7 +102,7 @@ public function itNormalisesParentDirectorySegments(): void
         file_put_contents($file, '<chapter/>');
 
         $loader = new DiffPathLoader(
-            new Diff([new FileChange('nested/../chapter.xml', [1])]),
+            new DiffChangeset([new FileChange('nested/../chapter.xml', [1])]),
             workingDirectory: $this->directory,
             basePath: $this->directory,
             projectRoots: [],

tests/Unit/Runner/RunCoordinatorFileFailureTest.php

@@ -5,7 +5,7 @@
 namespace DocbookCS\Tests\Unit\Runner;
 
 use DocbookCS\Config\ConfigData;
-use DocbookCS\Diff\Diff;
+use DocbookCS\Diff\DiffChangeset;
 use DocbookCS\Diff\FileChange;
 use DocbookCS\Progress\ProgressInterface;
 use DocbookCS\Runner\RunCoordinator;
@@ -87,7 +87,7 @@ static function () use ($xmlFilePath): void {
             entityPaths: [],
             basePath: dirname($xmlFilePath),
         );
-        $diff = new Diff([new FileChange($xmlFilePath, [42])]);
+        $diff = new DiffChangeset([new FileChange($xmlFilePath, [42])]);
 
         $report = new RunCoordinator($progress)->run($this->planDiff($config, $diff));
 
@@ -100,7 +100,7 @@ private function planPaths(ConfigData $config): RunPlan
         return new RunPlanner($config)->planPaths($config->getIncludePaths());
     }
 
-    private function planDiff(ConfigData $config, Diff $diff): RunPlan
+    private function planDiff(ConfigData $config, DiffChangeset $diff): RunPlan
     {
         return new RunPlanner($config)->planDiff($diff);
     }

tests/Unit/Runner/RunPlannerTest.php

@@ -5,7 +5,7 @@
 namespace DocbookCS\Tests\Unit\Runner;
 
 use DocbookCS\Config\ConfigData;
-use DocbookCS\Diff\Diff;
+use DocbookCS\Diff\DiffChangeset;
 use DocbookCS\Diff\FileChange;
 use DocbookCS\Diff\DiffParser;
 use DocbookCS\Diff\DiffProviderInterface;
@@ -25,7 +25,7 @@
     CoversClass(RunPlanner::class),
     //
     UsesClass(ConfigData::class),
-    UsesClass(Diff::class),
+    UsesClass(DiffChangeset::class),
     UsesClass(DiffParser::class),
     UsesClass(DiffPathLoader::class),
     UsesClass(EntityResolver::class),

tests/Unit/Runner/RunScopeResolverTest.php

@@ -5,7 +5,7 @@
 namespace DocbookCS\Tests\Unit\Runner;
 
 use DocbookCS\Config\ConfigData;
-use DocbookCS\Diff\Diff;
+use DocbookCS\Diff\DiffChangeset;
 use DocbookCS\Diff\FileChange;
 use DocbookCS\Path\DiffPathLoader;
 use DocbookCS\Path\PathLoader;
@@ -21,7 +21,7 @@
     CoversClass(RunScopeResolver::class),
     //
     UsesClass(ConfigData::class),
-    UsesClass(Diff::class),
+    UsesClass(DiffChangeset::class),
     UsesClass(DiffPathLoader::class),
     UsesClass(FileChange::class),
     UsesClass(PathLoader::class),
@@ -61,7 +61,7 @@ public function narrowScopeKeepsOnlySelectedFilesAndDiffLines(): void
         $resolver = $this->resolver();
 
         $targets = $resolver->resolveDiff(
-            new Diff([new FileChange('source.xml', [2, 3])]),
+            new DiffChangeset([new FileChange('source.xml', [2, 3])]),
         );
 
         self::assertSame([2, 3], $targets[$this->sourceFile]?->addedLineNumbers);
@@ -74,7 +74,7 @@ public function wideScopeWidensSelectedFilesAndFollowsReferencedTargets(): void
         $resolver = $this->resolver(wide: true);
 
         $targets = $resolver->resolveDiff(
-            new Diff([new FileChange('source.xml', [2, 3])]),
+            new DiffChangeset([new FileChange('source.xml', [2, 3])]),
         );
 
         self::assertNull($targets[$this->sourceFile]);

tests/Unit/Runner/RunScopeTest.php

@@ -6,8 +6,8 @@
 
 use DocbookCS\Config\ConfigData;
 use DocbookCS\Config\SniffEntry;
-use DocbookCS\Diff\Diff;
 use DocbookCS\Diff\DiffBaseResolver;
+use DocbookCS\Diff\DiffChangeset;
 use DocbookCS\Diff\FileChange;
 use DocbookCS\Diff\GitDiffProvider;
 use DocbookCS\Diff\UpstreamResolver;
@@ -57,8 +57,8 @@
     //
     UsesClass(AbstractSniff::class),
     UsesClass(ConfigData::class),
-    UsesClass(Diff::class),
     UsesClass(DiffBaseResolver::class),
+    UsesClass(DiffChangeset::class),
     UsesClass(EntityExpansionMarker::class),
     UsesClass(EntityPreprocessor::class),
     UsesClass(File::class),
@@ -165,7 +165,7 @@ public function aDiffProvidesItsOwnFilesWithoutConfiguredIncludePaths(): void
 
         $report = $this->executeDiff(
             $config,
-            new Diff([
+            new DiffChangeset([
                 new FileChange($this->sourceFile, [1]),
             ]),
         );
@@ -187,7 +187,7 @@ public function aDiffPathUsingAProjectDirectoryKeepsItsSourceRanges(): void
 
         $report = $this->executeDiff(
             $config,
-            new Diff([
+            new DiffChangeset([
                 new FileChange('docs/source.xml', [1]),
             ]),
         );
@@ -222,7 +222,7 @@ private function executePaths(
 
     private function executeDiff(
         ConfigData $config,
-        Diff $diff,
+        DiffChangeset $diff,
         RunMode $mode = RunMode::Sniff,
         bool $wide = false,
     ): Report {