Simplify the API and update readme/license

Author: plotbox-io

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2020 GSS (NI) LIMITED
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,2 +1,32 @@
 # php-git-ops
 PHP wrapper around git designed to help with devops needs
+
+Currently in early stage of development (Potentially subject to breaking changes)
+
+### Example
+
+```
+// Make a line filter
+$git = new Git('/home/richard/Development/PlotBox/plotbox-app');
+$lineFilterFactory = new LineFilterFactory($git);
+$lineFilter = $lineFilterFactory->makeLineFilter();
+
+// Pass in ci-issues to be filtered
+$issues = [
+    CodeIssue::make('devops/git/post-merge', 123, 'abc123'),
+    CodeIssue::make('static/maintenance.html', 456, 'abc456')
+];
+$filteredIssues = $lineFilter->filterIssues($issues);
+```
+
+## Contributing
+
+Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). 
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

src/CodeIssue.php

@@ -4,20 +4,60 @@
 
 class CodeIssue
 {
-    /** @var RelativeFile  */
+    /** @var RelativeFile */
     private $file;
     /** @var int */
     private $line;
+    /** @var string */
+    private $uniqueReference;
 
     /**
      * @param RelativeFile $file
      * @param int $line
      */
-    public function __construct(RelativeFile $file, $line) {
+    public function __construct(RelativeFile $file, $line)
+    {
         $this->file = $file;
         $this->line = $line;
     }
 
+    /**
+     * Create new instance from primitives
+     *
+     * @param string $file
+     * @param int $line
+     * @param null $uniqueRef
+     * @return static
+     */
+    public static function make($file, $line, $uniqueRef = null)
+    {
+        $instance = new static(
+            new RelativeFile($file),
+            $line
+        );
+        if ($uniqueRef) {
+            $instance->setUniqueReference($uniqueRef);
+        }
+
+        return $instance;
+    }
+
+    /**
+     * @return string
+     */
+    public function getUniqueReference()
+    {
+        return $this->uniqueReference;
+    }
+
+    /**
+     * @param string $uniqueReference
+     */
+    public function setUniqueReference($uniqueReference)
+    {
+        $this->uniqueReference = $uniqueReference;
+    }
+
     /**
      * @return string
      */

src/Git/Git.php

@@ -2,11 +2,6 @@
 
 namespace App\Git;
 
-use App\Git\Branch;
-use App\Git\Commit;
-use App\Git\LineNotExistException;
-use App\Git\LineUnstagedException;
-use App\Git\UnstagedChanges;
 use App\ProjectPathCli;
 use App\RelativeFile;
 use RuntimeException;
@@ -21,13 +16,12 @@ class Git
     private $blameCache;
 
     /**
-     * @param string $repoDirectory
-     * @param ProjectPathCli $cli
+     * @param string $projectPath
      */
-    public function __construct(ProjectPathCli $cli)
+    public function __construct($projectPath)
     {
-        $this->repoDirectory = $cli->projectDirectory();
-        $this->cli = $cli;
+        $this->cli = new ProjectPathCli($projectPath);
+        $this->repoDirectory = $projectPath;
         $this->blameCache = [];
     }
 

src/Git/LineFilter.php

@@ -31,13 +31,6 @@ public function filterIssues(array $issues)
         foreach ($issues as $issue) {
             $file = new RelativeFile($issue->getFile());
             $line = (int) $issue->getLine();
-
-            // Highlight internal exceptions if file was touched in any way at all
-            if (key_exists($file->getPath(), $this->modifiedFiles) && $issue->getSource() === 'Internal.Exception') {
-                $resultIssues[] = $issue;
-                continue;
-            }
-
             if ($this->lineWasTouched($file, $line)) {
                 $resultIssues[] = $issue;
             }

src/Git/LineFilterFactory.php

@@ -9,15 +9,21 @@ class LineFilterFactory
     /** @var BranchModificationsFactory */
     private $branchModificationsFactory;
 
-    public function __construct(Git $gitService, BranchModificationsFactory $branchModificationsFactory)
+    public function __construct(Git $gitService)
     {
         $this->gitService = $gitService;
-        $this->branchModificationsFactory = $branchModificationsFactory;
+        $this->branchModificationsFactory = new BranchModificationsFactory($this->gitService);
     }
 
-    public function makeLineFilter(Branch $ancestorBranch)
+    /**
+     * @return LineFilter
+     */
+    public function makeLineFilter()
     {
+        $branchComparer = new BranchComparer($this->gitService);
         $currentBranch = $this->gitService->getCurrentBranch();
+        $ancestorBranch = $branchComparer->getAncestorBranch($currentBranch);
+
         $branchModifications = $this->branchModificationsFactory->getBranchModifications(
             $this->gitService->getMergeBase($ancestorBranch, $currentBranch),
             $this->gitService->getLatestCommit($currentBranch)