Rename "number of batches" to "total number of batches" (#131)

Author: theofidry

src/Configuration.php

@@ -32,7 +32,7 @@ final class Configuration
     /**
      * @var positive-int
      */
-    private int $numberOfBatches;
+    private int $totalNumberOfBatches;
 
     /**
      * @param positive-int   $numberOfProcesses
@@ -63,7 +63,7 @@ public function __construct(
             ? $numberOfItems
             : $segmentSize;
         $this->numberOfSegments = (int) (1 === $numberOfProcesses ? 1 : ceil($numberOfItems / $segmentSize));
-        $this->numberOfBatches = (int) (ceil($segmentSize / $batchSize) * $this->numberOfSegments);
+        $this->totalNumberOfBatches = (int) (ceil($segmentSize / $batchSize) * $this->numberOfSegments);
     }
 
     /**
@@ -85,8 +85,8 @@ public function getNumberOfSegments(): int
     /**
      * @return positive-int
      */
-    public function getNumberOfBatches(): int
+    public function getTotalNumberOfBatches(): int
     {
-        return $this->numberOfBatches;
+        return $this->totalNumberOfBatches;
     }
 }

src/Logger/Logger.php

@@ -22,7 +22,7 @@ public function logConfiguration(
         int $batchSize,
         int $numberOfItems,
         int $numberOfSegments,
-        int $numberOfBatches,
+        int $totalNumberOfBatches,
         int $numberOfProcesses,
         string $itemName
     ): void;

src/Logger/NullLogger.php

@@ -22,7 +22,7 @@ public function logConfiguration(
         int $batchSize,
         int $numberOfItems,
         int $numberOfSegments,
-        int $numberOfBatches,
+        int $totalNumberOfBatches,
         int $numberOfProcesses,
         string $itemName
     ): void {

src/Logger/StandardLogger.php

@@ -48,7 +48,7 @@ public function logConfiguration(
         int $batchSize,
         int $numberOfItems,
         int $numberOfSegments,
-        int $numberOfBatches,
+        int $totalNumberOfBatches,
         int $numberOfProcesses,
         string $itemName
     ): void {
@@ -60,8 +60,8 @@ public function logConfiguration(
             $batchSize,
             $numberOfSegments,
             1 === $numberOfSegments ? 'round' : 'rounds',
-            $numberOfBatches,
-            1 === $numberOfBatches ? 'batch' : 'batches',
+            $totalNumberOfBatches,
+            1 === $totalNumberOfBatches ? 'batch' : 'batches',
             $numberOfProcesses,
             1 === $numberOfProcesses ? 'process' : 'processes',
         ));

src/ParallelExecutor.php

@@ -228,15 +228,15 @@ private function executeMainProcess(
         );
 
         $numberOfSegments = $config->getNumberOfSegments();
-        $numberOfBatches = $config->getNumberOfBatches();
+        $totalNumberOfBatches = $config->getTotalNumberOfBatches();
         $itemName = ($this->getItemName)($numberOfItems);
 
         $logger->logConfiguration(
             $segmentSize,
             $batchSize,
             $numberOfItems,
             $numberOfSegments,
-            $numberOfBatches,
+            $totalNumberOfBatches,
             $numberOfProcesses,
             $itemName,
         );

tests/ConfigurationTest.php

@@ -47,7 +47,7 @@ public function test_it_can_be_instantiated(
 
         self::assertSame($expectedSegmentSize, $config->getSegmentSize());
         self::assertSame($expectedNumberOfSegments, $config->getNumberOfSegments());
-        self::assertSame($expectedNumberOfBatches, $config->getNumberOfBatches());
+        self::assertSame($expectedNumberOfBatches, $config->getTotalNumberOfBatches());
     }
 
     /**

tests/Logger/DummyLogger.php

@@ -25,7 +25,7 @@ public function logConfiguration(
         int $batchSize,
         int $numberOfItems,
         int $numberOfSegments,
-        int $numberOfBatches,
+        int $totalNumberOfBatches,
         int $numberOfProcesses,
         string $itemName
     ): void {

tests/Logger/FakeLogger.php

@@ -23,7 +23,7 @@ public function logConfiguration(
         int $batchSize,
         int $numberOfItems,
         int $numberOfSegments,
-        int $numberOfBatches,
+        int $totalNumberOfBatches,
         int $numberOfProcesses,
         string $itemName
     ): void {

tests/Logger/StandardLoggerTest.php

@@ -53,7 +53,7 @@ public function test_it_can_log_the_configuration(
         int $batchSize,
         int $numberOfItems,
         int $numberOfSegments,
-        int $numberOfBatches,
+        int $totalNumberOfBatches,
         int $numberOfProcesses,
         string $itemName,
         string $expected
@@ -63,7 +63,7 @@ public function test_it_can_log_the_configuration(
             $batchSize,
             $numberOfItems,
             $numberOfSegments,
-            $numberOfBatches,
+            $totalNumberOfBatches,
             $numberOfProcesses,
             $itemName,
         );

tests/ParallelExecutorTest.php

@@ -868,7 +868,7 @@ private static function mainProcessWithChildProcessLaunchedProvider(): iterable
         $numberOfProcesses = 5;
         $numberOfProcessesDefined = true;
         $numberOfSegments = 2;
-        $numberOfBatches = 2;
+        $totalNumberOfBatches = 2;
 
         $input = new StringInput('');
         $output = new BufferedOutput();
@@ -912,7 +912,7 @@ private static function mainProcessWithChildProcessLaunchedProvider(): iterable
                         $batchSize,
                         3,
                         $numberOfSegments,
-                        $numberOfBatches,
+                        $totalNumberOfBatches,
                         $numberOfProcesses,
                         'items',
                     ],
@@ -937,7 +937,7 @@ private static function mainProcessWithoutChildProcessLaunchedProvider(): iterab
         $segmentSize = 3;
         $numberOfProcesses = 1;
         $numberOfSegments = 1;
-        $numberOfBatches = 2;
+        $totalNumberOfBatches = 2;
 
         $input = new StringInput('');
         $output = new BufferedOutput();
@@ -1003,7 +1003,7 @@ private static function mainProcessWithoutChildProcessLaunchedProvider(): iterab
                         $batchSize,
                         3,
                         $numberOfSegments,
-                        $numberOfBatches,
+                        $totalNumberOfBatches,
                         $numberOfProcesses,
                         'items',
                     ],