Some tweaks - remove commits property from branch modifications

Author: plotbox-io

README.md

@@ -10,25 +10,19 @@ when dealing with legacy code-bases where you want to tackle code smells bit by
 
 ### Example Usage
 
-#### Get all 'files touched' in current feature branch
-
-```
-$gitService = new GitInfoService();
-$touchedFiles = $gitService->filesTouched('/path/to/some/repo');
-```
-
 #### Filter issues by 'lines touched' in current branch 
 
 The logic will consider files added, and modified (unstaged, staged, comitted), 
 filtering out any issues deemed to not have been touched in the current branch
 
 ```
-// Make a line filter
-$git = new Git('/path/to/some/repo-directory');
-$lineFilterFactory = new LineFilterFactory($git);
-$lineFilter = $lineFilterFactory->makeLineFilter();
+// Get modifications for feature branch
+$git = new Git('/home/richard/Development/PlotBox/plotbox-app');
+$branchModificationsFactory = new BranchModificationsFactory($git);
+$branchModifications = $branchModificationsFactory->getBranchModifications();
+$lineFilter = new LineFilter($git, $branchModifications);
 
-// Pass in ci-issues to be filtered (third parameter 'attachment' can be anything you like)
+// Pass in ci-issues to be filtered
 $issues = [
     CodeIssue::make('devops/git/post-merge', 123, 'abc123'),
     CodeIssue::make('static/maintenance.html', 456, 'abc456')

src/Git/BranchComparer.php

@@ -56,20 +56,15 @@ public function getAncestorBranch(Branch $currentBranch)
     }
 
     /**
-     * TODO: We should always check against origin. Need to:
-     *  1. Know the origin name (default to origin)
-     *  2. Enforce "git fetch --all" before checking..
-     *  3. Prepend origin to all checks
-     *
      * @param Branch $currentBranch
      * @return Branch
      */
     private function getNearestStandardAncestor(Branch $currentBranch)
     {
         $branchDistances = [];
         foreach ($this->getStandardAncestors() as $ancestorBranch) {
-            // Note: If branch doesn't exist locally, we may be checking against an older ancestor
-            // (develop/master), but that shouldn't be too bad..
+            // Note: If branch doesn't exist locally (i.e., sprint or release), we may be checking against
+            // an older ancestor (develop/master), but that shouldn't be too bad..
             if ($this->git->branchExists($ancestorBranch)) {
                 $ancestorBaseCommit = $this->git->getMergeBase($currentBranch, $ancestorBranch);
                 $distance = $this->distance($currentBranch, $ancestorBaseCommit);

src/Git/BranchModifications.php

@@ -10,28 +10,21 @@ class BranchModifications
     private $modifiedFiles;
     /** @var RelativeFile[] */
     private $newFiles;
-    /** @var Commit[] */
-    private $commits;
     /** @var TouchedLines */
     private $unstagedChanges;
     /**
      * @param TouchedLines $modifiedFiles
      * @param RelativeFile[] $newFiles
-     * @param Commit[] $commits
      * @param TouchedLines $unstagedChanges
      */
-    public function __construct(TouchedLines $modifiedFiles, array $newFiles, array $commits, TouchedLines $unstagedChanges)
+    public function __construct(TouchedLines $modifiedFiles, array $newFiles, TouchedLines $unstagedChanges)
     {
         $this->modifiedFiles = $modifiedFiles;
         $this->newFiles = [];
         foreach ($newFiles as $newFile) {
             $this->newFiles[$newFile->getPath()] = $newFile;
         }
         $this->unstagedChanges = $unstagedChanges;
-        $this->commits = [];
-        foreach ($commits as $commit) {
-            $this->commits[$commit->getHash()] = $commit;
-        }
     }
 
     /**

src/Git/BranchModificationsFactory.php

@@ -26,7 +26,7 @@ public function getBranchModifications()
         $currentBranch = $this->git->getCurrentBranch();
         $ancestorBranch = $branchComparer->getAncestorBranch($currentBranch);
         return $this->getBranchModificationsSpecified(
-            $this->git->getMergeBase($ancestorBranch, $currentBranch),
+            $ancestorBranch,
             $this->git->getLatestCommit($currentBranch)
         );
     }
@@ -44,20 +44,19 @@ public function getBranchModificationsSpecified(Pointer $ancestorBranch, Pointer
             return $this->branchModificationsCached[$cacheKey];
         }
 
+        // New files appear to be being picked up here also now. May be possible to
+        // drop the separate newly added files method below..
         $modifiedFiles = $this->git->parseTouchedLines(
             new ComparisonDiffCommand(
                 $current,
                 $ancestorBranch
             )
         );
         $newFiles = $this->git->getNewlyAddedFiles($mergeBase, $current);
-        $commitList = $this->git->getCommitsBetween($mergeBase, $current);
         $unstagedChanges = $this->git->parseTouchedLines(new UnstagedDiffCommand());
-
         $this->branchModificationsCached[$cacheKey] = new BranchModifications(
             $modifiedFiles,
             $newFiles,
-            $commitList,
             $unstagedChanges
         );