Better, still needs more cleanup

Author: jrfnl

src/Files/File.php

@@ -153,28 +153,62 @@ class File
     protected $warningCount = 0;
 
     /**
-     * The total number of errors that can be fixed.
+     * The original total number of errors that can be fixed (first run on a file).
+     *
+     * @readonly This should be regarded as an immutable property.
+     *
+     * @var integer
+     */
+    private $fixableErrorCountFirstRun;
+
+    /**
+     * The original total number of warnings that can be fixed (first run on a file).
+     *
+     * @readonly This should be regarded as an immutable property.
+     *
+     * @var integer
+     */
+    private $fixableWarningCountFirstRun;
+
+    /**
+     * The current total number of errors that can be fixed.
      *
      * @var integer
      */
     protected $fixableErrorCount = 0;
 
     /**
-     * The total number of warnings that can be fixed.
+     * The current total number of warnings that can be fixed.
      *
      * @var integer
      */
     protected $fixableWarningCount = 0;
 
     /**
-     * The total number of errors that were fixed.
+     * The actual number of errors and warnings that were fixed.
+     *
+     * I.e. how many fixes were applied. This may be higher than the originally found
+     * issues if the fixer from one sniff causes other sniffs to come into play in follow-up loops.
+     * Example: if a brace is moved to a new line, the `ScopeIndent` sniff may need to ensure
+     * the brace is indented correctly in the next loop.
+     *
+     * @var integer
+     */
+    protected $fixedCount = 0;
+
+    /**
+     * The effective number of errors that were fixed.
+     *
+     * I.e. how many of the originally found errors were fixed.
      *
      * @var integer
      */
     protected $fixedErrorCount = 0;
 
     /**
-     * The total number of warnings that were fixed.
+     * The effective number of warnings that were fixed.
+     *
+     * I.e. how many of the originally found warnings were fixed.
      *
      * @var integer
      */
@@ -521,9 +555,18 @@ public function process()
             StatusWriter::write('*** END SNIFF PROCESSING REPORT ***', 1);
         }
 
-        //$this->fixedCount        += $this->fixer->getFixCount();
-        $this->fixedErrorCount   += $this->fixer->getFixedErrorCount();
-        $this->fixedWarningCount += $this->fixer->getFixedWarningCount();
+        if (isset($this->fixableErrorCountFirstRun, $this->fixableWarningCountFirstRun) === false) {
+            $this->fixableErrorCountFirstRun   = $this->fixableErrorCount;
+            $this->fixableWarningCountFirstRun = $this->fixableWarningCount;
+        }
+
+// This is still needed for the progress reporting ?
+// Only if the error/warning counts don't work, as otherwise, it can be calculated in the getter method.
+// Then again, maybe we should still leave it in as-is and not have the calculation to have actual vs effective fixes in File too.
+        $this->fixedCount        += $this->fixer->getFixCount();
+// THIS IS WHAT I NEED TO LOOK AT/FIX
+        $this->fixedErrorCount   = ($this->fixableErrorCountFirstRun - $this->fixableErrorCount);
+        $this->fixedWarningCount = ($this->fixableWarningCountFirstRun - $this->fixableWarningCount);
 
     }//end process()
 
@@ -1166,37 +1209,52 @@ public function getFixableWarningCount()
 
 
     /**
-     * Returns the number of fixed errors/warnings.
+     * Returns the actual number of fixed errors/warnings.
      *
      * @return int
      */
     public function getFixedCount()
     {
-        return ($this->fixedErrorCount + $this->fixedWarningCount);
+        return $this->fixedCount;
+        //return ($this->fixedErrorCount + $this->fixedWarningCount);
 
     }//end getFixedCount()
 
 
     /**
-     * Returns the number of fixed errors.
+     * Returns the effective number of fixed errors.
      *
      * @return int
      */
     public function getFixedErrorCount()
     {
-        return $this->fixedErrorCount;
+/*
+        if ($this->fixedErrorCount === 0 && PHP_CODESNIFFER_CBF === true) {
+            return $this->fixer->getFixedErrorCount();
+        } else {
+*/
+            // Using value retrieved from cache/child process.
+            return $this->fixedErrorCount;
+//        }
 
     }//end getFixedErrorCount()
 
 
     /**
-     * Returns the number of fixed warnings.
+     * Returns the effective number of fixed warnings.
      *
      * @return int
      */
     public function getFixedWarningCount()
     {
-        return $this->fixedWarningCount;
+/*
+        if ($this->fixedWarningCount === 0 && PHP_CODESNIFFER_CBF === true) {
+            return $this->fixer->getFixedWarningCount();
+        } else {
+*/
+            // Using value retrieved from cache/child process.
+            return $this->fixedWarningCount;
+//        }
 
     }//end getFixedWarningCount()
 

src/Fixer.php

@@ -120,7 +120,7 @@ class Fixer
      *
      * @var integer
      */
-    private $errorFixes = 0;
+//    private $errorFixes = 0;
 
     /**
      * The effective number of warning fixes that have been performed.
@@ -129,7 +129,7 @@ class Fixer
      *
      * @var integer
      */
-    private $warningFixes = 0;
+//    private $warningFixes = 0;
 
 
     /**
@@ -143,8 +143,8 @@ public function startFile(File $phpcsFile)
     {
         $this->currentFile  = $phpcsFile;
         $this->numFixes     = 0;
-        $this->errorFixes   = 0;
-        $this->warningFixes = 0;
+//        $this->errorFixes   = 0;
+//        $this->warningFixes = 0;
         $this->fixedTokens  = [];
 
         $tokens       = $phpcsFile->getTokens();
@@ -179,8 +179,8 @@ public function fixFile()
         StatusWriter::pause();
 
         $this->loops    = 0;
-        $errorsBefore   = $this->currentFile->getFixableErrorCount();
-        $warningsBefore = $this->currentFile->getFixableWarningCount();
+//        $errorsBefore   = $this->currentFile->getFixableErrorCount();
+//        $warningsBefore = $this->currentFile->getFixableWarningCount();
 
         while ($this->loops < 50) {
             // Only needed once file content has changed.
@@ -233,8 +233,12 @@ public function fixFile()
 
         StatusWriter::resume();
 
-        $this->errorFixes   = ($errorsBefore - $this->currentFile->getFixableErrorCount());
-        $this->warningFixes = ($warningsBefore - $this->currentFile->getFixableWarningCount());
+// MAYBE THIS SHOULD SET THE PROPERTY VALUES ON THE FILE CLASS ?
+// BUT IT CAN'T, as those are protected.
+// BUT THIS IS THE REAL PROBLEM, these values MUST be calculated, but won't be available until File::process() has finished,
+// while File::process() sets these to the File class....
+//        $this->errorFixes   = ($errorsBefore - $this->currentFile->getFixableErrorCount());
+//        $this->warningFixes = ($warningsBefore - $this->currentFile->getFixableWarningCount());
 
         if ($this->numFixes > 0 || $this->inConflict === true) {
             if (PHP_CODESNIFFER_VERBOSITY > 1) {
@@ -367,7 +371,7 @@ public function generateDiff($filePath=null, $colors=true)
 
 
     /**
-     * Get a count of fixes that have been performed on the file.
+     * Get a count of the actual number of fixes that have been performed on the file.
      *
      * This value is reset every time a new file is started, or an existing
      * file is restarted.
@@ -382,7 +386,7 @@ public function getFixCount()
 
 
     /**
-     * Get a count of error fixes that have been performed on the file.
+     * Get a count of the effective number of error fixes that have been performed on the file.
      *
      * This value is reset every time a new file is started, or an existing
      * file is restarted.
@@ -397,7 +401,7 @@ public function getFixedErrorCount()
 
 
     /**
-     * Get a count of warning fixes that have been performed on the file.
+     * Get a count of the effective number of warning fixes that have been performed on the file.
      *
      * This value is reset every time a new file is started, or an existing
      * file is restarted.