phpcpd 8.2.2 release. Improved progress bar.

Author: DKravtsov

.env

@@ -6,5 +6,5 @@ COMPOSE_PROJECT_NAME=phpcpd
 # XDEBUG_CONFIG possible values: main|osx. Use main value for Linux and Windows, osx value for MacOS.
 XDEBUG_CONFIG=main
 # Sometimes we need to use different xdebug versions, list of versions can be found here - https://pecl.php.net/package/xdebug
-XDEBUG_VERSION=3.4.2
+XDEBUG_VERSION=3.4.3
 ###< XDebug docker configuration ###

ChangeLog.md

@@ -2,6 +2,12 @@
 
 All notable changes in PHPCPD are documented in this file using the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
 
+## [8.2.2] - 2025-05-18
+
+### Updated
+
+* Improved progress bar.
+
 ## [8.2.1] - 2025-05-03
 
 ### Updated

Dockerfile

@@ -12,7 +12,7 @@ ARG INSIDE_DOCKER_CONTAINER=1
 ENV INSIDE_DOCKER_CONTAINER=$INSIDE_DOCKER_CONTAINER
 ARG XDEBUG_CONFIG=main
 ENV XDEBUG_CONFIG=$XDEBUG_CONFIG
-ARG XDEBUG_VERSION=3.4.2
+ARG XDEBUG_VERSION=3.4.3
 ENV XDEBUG_VERSION=$XDEBUG_VERSION
 ENV PHP_CS_FIXER_IGNORE_ENV=1
 

build.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project name="phpcpd" default="setup">
     <property name="basedir" value="." override="false"/>
-    <property name="version" value="8.2.1" override="false"/>
+    <property name="version" value="8.2.2" override="false"/>
     <target name="setup" depends="clean,install-dependencies"/>
 
     <target name="clean" description="Cleanup build artifacts">

composer.lock

@@ -29,8 +29,8 @@ Note: This tool is distributed as a [PHP Archive (PHAR)](https://php.net/phar).
 ## Usage example
 ```
 $ php ./vendor/bin/phpcpd --fuzzy --verbose src tests
-Copy/Paste Detector 8.2.1
-14/14 [==============================>] 100%
+Copy/Paste Detector 8.2.2
+14/14 [==============================>] 100% Loading & Processing
 Found 1 code clones with 17 duplicated lines in 1 files:
 
   - /var/www/html/tests/Application/ApiKey/Transport/Controller/Api/v1/ApiKeyControllerTest.php:128-145 (17 lines)

docs/images/report_example_01.png

@@ -28,7 +28,7 @@
 
 final class Application
 {
-    public const string VERSION = '8.2.1';
+    public const string VERSION = '8.2.2';
 
     /**
      * @param array<int, string> $argv

readme.md

@@ -6,12 +6,18 @@
 
 use Systemsdk\PhpCPD\CodeCloneMap;
 use Systemsdk\PhpCPD\Detector\Strategy\AbstractStrategy;
+use Systemsdk\PhpCPD\Detector\Strategy\SuffixTreeStrategy;
+use Systemsdk\PhpCPD\Detector\Traits\ProgressBarTrait;
 use Systemsdk\PhpCPD\Exceptions\ProcessingResultException;
 
-use function sprintf;
-
 final class Detector
 {
+    use ProgressBarTrait;
+
+    private const int PROGRESS_BAR_BOUNDARY = 20;
+    private const string PROGRESS_BAR_RABIN_KARP_TITLE = 'Loading & Processing';
+    private const string PROGRESS_BAR_SUFFIX_TREE_TITLE = 'Loading';
+
     public function __construct(
         private readonly AbstractStrategy $strategy,
         private readonly bool $useProgressBar = false
@@ -28,44 +34,27 @@ public function copyPasteDetection(array $files): CodeCloneMap
         $result = new CodeCloneMap();
         $totalItems = count($files);
         $processedFiles = 0;
+        $boundary = self::PROGRESS_BAR_BOUNDARY;
         foreach ($files as $file) {
             $processedFiles++;
 
-            if (empty($file)) {
-                $this->progressBar($processedFiles, $totalItems);
-
-                continue;
+            if (!empty($file)) {
+                $this->strategy->processFile($file, $result);
             }
 
-            $this->strategy->processFile($file, $result);
-            $this->progressBar($processedFiles, $totalItems);
+            if ($this->useProgressBar && $this->countProgressBarPercent($processedFiles, $totalItems) >= $boundary) {
+                $this->progressBar(
+                    $processedFiles,
+                    $totalItems,
+                    $this->strategy instanceof SuffixTreeStrategy
+                        ? self::PROGRESS_BAR_SUFFIX_TREE_TITLE
+                        : self::PROGRESS_BAR_RABIN_KARP_TITLE
+                );
+                $boundary += self::PROGRESS_BAR_BOUNDARY;
+            }
         }
-        $this->strategy->postProcess();
+        $this->strategy->postProcess($this->useProgressBar);
 
         return $result;
     }
-
-    private function progressBar(int $done, int $total, string $title = '', int $width = 30): void
-    {
-        if ($this->useProgressBar === false) {
-            return;
-        }
-
-        $perc = (int)floor(($done * 100) / $total);
-        $bar = (int)floor(($width * $perc) / 100);
-
-        print sprintf(
-            " %s/%s [%s>%s] %s%% %s\r",
-            $done,
-            $total,
-            str_repeat('=', $bar),
-            str_repeat(' ', $width - $bar),
-            $perc,
-            $title
-        );
-
-        if ($done >= $total) {
-            print PHP_EOL;
-        }
-    }
 }

releases/phpcpd-8.2.2.phar

@@ -49,7 +49,7 @@ public function setConfig(StrategyConfiguration $config): void
 
     abstract public function processFile(string $file, CodeCloneMap $result): void;
 
-    public function postProcess(): void
+    public function postProcess(bool $useProgressBar): void
     {
     }
 }

releases/phpcpd-latest.phar

@@ -11,6 +11,7 @@
 use Systemsdk\PhpCPD\Detector\Strategy\SuffixTree\ApproximateCloneDetectingSuffixTree;
 use Systemsdk\PhpCPD\Detector\Strategy\SuffixTree\Sentinel;
 use Systemsdk\PhpCPD\Detector\Strategy\SuffixTree\Token;
+use Systemsdk\PhpCPD\Detector\Traits\ProgressBarTrait;
 use Systemsdk\PhpCPD\Exceptions\MissingResultException;
 
 use function array_key_exists;
@@ -33,6 +34,12 @@
  */
 final class SuffixTreeStrategy extends AbstractStrategy
 {
+    use ProgressBarTrait;
+
+    private const string PROGRESS_BAR_SEARCH_CLONES_TITLE = 'Search for clones';
+    private const string PROGRESS_BAR_PROCESS_CLONES_TITLE = 'Clones processing';
+    private const string PROGRESS_BAR_POST_PROCESS_DONE_TITLE = 'Post process done';
+
     /**
      * @var array<int, AbstractToken>
      */
@@ -98,12 +105,18 @@ public function processFile(string $file, CodeCloneMap $result): void
     /**
      * @throws MissingResultException
      */
-    public function postProcess(): void
+    public function postProcess(bool $useProgressBar): void
     {
         if (empty($this->result)) {
             throw new MissingResultException('Missing result');
         }
 
+        $totalSteps = 2;
+
+        if ($useProgressBar) {
+            $this->progressBar(0, $totalSteps, self::PROGRESS_BAR_SEARCH_CLONES_TITLE);
+        }
+
         // Sentinel = End of word
         $this->word[] = new Sentinel();
 
@@ -113,6 +126,10 @@ public function postProcess(): void
             $this->config->headEquality()
         );
 
+        if ($useProgressBar) {
+            $this->progressBar(1, $totalSteps, self::PROGRESS_BAR_PROCESS_CLONES_TITLE);
+        }
+
         foreach ($cloneInfos as $cloneInfo) {
             /** @var int[] $others */
             $others = $cloneInfo->otherClones->extractFirstList();
@@ -126,6 +143,7 @@ public function postProcess(): void
                     $otherCloneLength = $this->processCloneLength($cloneLength, $otherToken->file);
                     $otherLastToken = $this->getLastToken($others[$j], $otherCloneLength);
 
+                    /** @phpstan-ignore method.nonObject */
                     $this->result->add(
                         new CodeClone(
                             new CodeCloneFile(
@@ -141,6 +159,10 @@ public function postProcess(): void
                 }
             }
         }
+
+        if ($useProgressBar) {
+            $this->progressBar(2, $totalSteps, self::PROGRESS_BAR_POST_PROCESS_DONE_TITLE);
+        }
     }
 
     private function processCloneLength(int $cloneLength, string $file): int

src/Cli/Application.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Systemsdk\PhpCPD\Detector\Traits;
+
+use function sprintf;
+
+trait ProgressBarTrait
+{
+    private function progressBar(int $done, int $total, string $title = '', int $width = 30): void
+    {
+        $perc = $this->countProgressBarPercent($done, $total);
+        $bar = (int)floor(($width * $perc) / 100);
+        print sprintf(
+            " %s/%s [%s>%s] %s%% %s\r",
+            $done,
+            $total,
+            str_repeat('=', $bar),
+            str_repeat(' ', $width - $bar),
+            $perc,
+            $title
+        );
+
+        if ($done >= $total) {
+            print PHP_EOL;
+        }
+    }
+
+    private function countProgressBarPercent(int $done, int $total): int
+    {
+        return (int)floor(($done * 100) / $total);
+    }
+}