Commit and Reference inherit from Revision

Author: Alexandre Salomé

doc/api/revision.rst

@@ -25,4 +25,4 @@ To resolve a revision to a commit:
 
 .. code-block:: php
 
-    $commit = $revision->getResolved();
+    $commit = $revision->getCommit();

src/Gitonomy/Git/Commit.php

@@ -12,26 +12,19 @@
 
 namespace Gitonomy\Git;
 
-use Gitonomy\Git\Util\StringHelper;
 use Gitonomy\Git\Diff\Diff;
-use Gitonomy\Git\Exception\ReferenceNotFoundException;
 use Gitonomy\Git\Exception\InvalidArgumentException;
+use Gitonomy\Git\Exception\ReferenceNotFoundException;
 use Gitonomy\Git\Exception\ProcessException;
+use Gitonomy\Git\Util\StringHelper;
 
 /**
  * Representation of a Git commit.
  *
  * @author Alexandre Salomé <[email protected]>
  */
-class Commit
+class Commit extends Revision
 {
-    /**
-     * The repository associated to the commit.
-     *
-     * @var Gitonomy\Git\Repository
-     */
-    private $repository;
-
     /**
      * Hash of the commit.
      *
@@ -126,8 +119,12 @@ class Commit
      */
     public function __construct(Repository $repository, $hash)
     {
-        $this->repository = $repository;
+        if (!preg_match('/^[a-f0-9]{40}$/', $hash)) {
+            throw new ReferenceNotFoundException($hash);
+        }
+
         $this->hash = $hash;
+        parent::__construct($repository, $hash, $hash);
     }
 
     /**
@@ -477,12 +474,4 @@ public function getBodyMessage()
 
         return implode("\n", $lines);
     }
-
-    /**
-     * @return Repository
-     */
-    public function getRepository()
-    {
-        return $this->repository;
-    }
 }

src/Gitonomy/Git/Reference.php

@@ -18,105 +18,15 @@
  * @author Alexandre Salomé <[email protected]>
  * @author Julien DIDIER <[email protected]>
  */
-abstract class Reference
+abstract class Reference extends Revision
 {
-    /**
-     * Current repository.
-     *
-     * @var Gitonomy\Git\Repository
-     */
-    protected $repository;
-
-    /**
-     * Fullname reference.
-     *
-     * @var string
-     */
-    protected $fullname;
-
-    /**
-     * Hash of the commit.
-     *
-     * @var string
-     */
-    protected $commitHash;
-
-    /**
-     * Constructor.
-     *
-     * @param Gitonomy\Git\Repository $repository A repository object
-     *
-     * @param string $fullname Fullname of the reference
-     *
-     * @param string $commitHash The commit hash
-     */
-    public function __construct(Repository $repository, $fullname, $commitHash)
-    {
-        $this->repository = $repository;
-        $this->fullname   = $fullname;
-        $this->commitHash = $commitHash;
-    }
-
-    /**
-     * Returns the usual name of the reference.
-     *
-     * @return string
-     */
-    abstract public function getName();
-
-    /**
-     * Returns the fullname of the reference.
-     *
-     * @return string
-     */
     public function getFullname()
     {
-        return $this->fullname;
-    }
-
-    /**
-     * Returns the commit associated to the reference.
-     *
-     * @return Gitonomy\Git\Commit
-     */
-    public function getCommit()
-    {
-        return $this->repository->getCommit($this->commitHash);
-    }
-
-    public function getCommitHash()
-    {
-        return $this->commitHash;
-    }
-
-    /**
-     * Returns the last modification date of the reference.
-     *
-     * @return DateTime
-     */
-    public function getLastModification()
-    {
-        return $this->getCommit()->getAuthorDate();
+        return $this->revision;
     }
 
     public function delete()
     {
         $this->repository->getReferences()->delete($this->getFullname());
     }
-
-    /**
-     * @return Repository
-     */
-    public function getRepository()
-    {
-        return $this->repository;
-    }
-
-    /**
-     * @return Log
-     */
-    public function getLog()
-    {
-        return new Log($this->repository, $this->getFullname());
-    }
 }

src/Gitonomy/Git/Reference/Branch.php

@@ -24,20 +24,19 @@ class Branch extends Reference
 {
     private $local = null;
 
-    /**
-     * {@inheritdoc}
-     */
     public function getName()
     {
-        if (preg_match('#^refs/heads/(?<name>.*)$#', $this->fullname, $vars)) {
+        $fullname = $this->getFullname();
+
+        if (preg_match('#^refs/heads/(?<name>.*)$#', $fullname, $vars)) {
             return $vars['name'];
         }
 
-        if (preg_match('#^refs/remotes/(?<remote>[^/]*)/(?<name>.*)$#', $this->fullname, $vars)) {
+        if (preg_match('#^refs/remotes/(?<remote>[^/]*)/(?<name>.*)$#', $fullname, $vars)) {
             return $vars['remote'].'/'.$vars['name'];
         }
 
-        throw new RuntimeException(sprintf('Cannot extract branch name from "%s"', $this->fullname));
+        throw new RuntimeException(sprintf('Cannot extract branch name from "%s"', $fullname));
     }
 
     public function isRemote()
@@ -57,7 +56,7 @@ public function isLocal()
     private function detectBranchType()
     {
         if (null === $this->local) {
-            $this->local = !preg_match('#^refs/remotes/(?<remote>[^/]*)/(?<name>.*)$#', $this->fullname);
+            $this->local = !preg_match('#^refs/remotes/(?<remote>[^/]*)/(?<name>.*)$#', $this->getFullname());
         }
     }
 }

src/Gitonomy/Git/Reference/Stash.php

@@ -19,11 +19,4 @@
  */
 class Stash extends Reference
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return 'stash';
-    }
 }

src/Gitonomy/Git/Reference/Tag.php

@@ -22,9 +22,6 @@
  */
 class Tag extends Reference
 {
-    /**
-     * {@inheritdoc}
-     */
     public function getName()
     {
         if (!preg_match('#^refs/tags/(.*)$#', $this->fullname, $vars)) {

src/Gitonomy/Git/Repository.php

@@ -563,6 +563,16 @@ public function setLogger(LoggerInterface $logger)
         return $this;
     }
 
+    /**
+     * Returns repository logger.
+     *
+     * @return LoggerInterface the logger or null
+     */
+    public function getLogger()
+    {
+        return $this->logger;
+    }
+
     /**
      * Clones the current repository to a new directory and return instance of new repository.
      *

src/Gitonomy/Git/Revision.php

@@ -13,6 +13,7 @@
 namespace Gitonomy\Git;
 
 use Gitonomy\Git\Exception\ReferenceNotFoundException;
+use Gitonomy\Git\Exception\InvalidArgumentException;
 use Gitonomy\Git\Exception\ProcessException;
 
 /**
@@ -28,44 +29,76 @@ class Revision
     /**
      * @var string
      */
-    protected $name;
+    protected $revision;
 
     /**
      * @var Commit
      */
-    protected $resolved;
+    protected $commitHash;
 
-    public function __construct(Repository $repository, $name)
+    public function __construct(Repository $repository, $revision, $commitHash = null)
     {
         $this->repository = $repository;
-        $this->name       = $name;
+        $this->revision   = $revision;
+        $this->commitHash = $commitHash;
     }
 
     /**
      * @return Log
      */
     public function getLog($paths = null, $offset = null, $limit = null)
     {
-        return $this->repository->getLog($this->name, $paths, $offset, $limit);
+        return $this->repository->getLog($this->revision, $paths, $offset, $limit);
     }
 
     /**
-     * Resolves the revision to a commit hash.
+     * Returns the commit associated to the reference.
      *
-     * @return Commit
+     * @return Gitonomy\Git\Commit
      */
-    public function getResolved()
+    public function getCommit()
     {
-        if (null !== $this->resolved) {
-            return $this->resolved;
+        return $this->repository->getCommit($this->getCommitHash());
+    }
+
+    public function getCommitHash()
+    {
+        if (null !== $this->commitHash) {
+            return $this->commitHash;
         }
 
         try {
-            $result = $this->repository->run('rev-parse', array('--verify', $this->name));
+            $result = $this->repository->run('rev-parse', array('--verify', $this->revision));
         } catch (ProcessException $e) {
-            throw new ReferenceNotFoundException(sprintf('Can not find reference "%s"', $this->name));
+            throw new ReferenceNotFoundException(sprintf('Can not find revision "%s"', $this->revision));
         }
 
-        return $this->resolved = $this->repository->getCommit(trim($result));
+        return $this->commitHash = trim($result);
+    }
+
+    /**
+     * Returns the last modification date of the reference.
+     *
+     * @return DateTime
+     */
+    public function getLastModification()
+    {
+        return $this->getCommit()->getAuthorDate();
+    }
+
+    /**
+     * @return string
+     */
+    public function getRevision()
+    {
+        return $this->revision;
+    }
+
+    /**
+     * @return Repository
+     */
+    public function getRepository()
+    {
+        return $this->repository;
     }
 }

tests/Gitonomy/Git/Tests/CommitTest.php

@@ -43,13 +43,11 @@ public function testGetHash($repository)
      * @dataProvider provideFoobar
      *
      * @expectedException Gitonomy\Git\Exception\ReferenceNotFoundException
-     * @expectedExceptionMessage Can not find reference "that-hash-doest-not-exists"
+     * @expectedExceptionMessage Reference not found: "that-hash-doest-not-exists"
      */
     public function testInvalideHashThrowException($repository)
     {
         $commit = new Commit($repository, 'that-hash-doest-not-exists');
-
-        $commit->getTreeHash();
     }
 
     /**

tests/Gitonomy/Git/Tests/RevisionTest.php

@@ -27,21 +27,21 @@ public function testGetCommit($repository)
 
         $this->assertTrue($revision instanceof Revision, "Revision object type");
 
-        $commit = $revision->getResolved();
+        $commit = $revision->getCommit();
 
-        $this->assertTrue($commit instanceof Commit, "getResolved returns a Commit");
+        $this->assertTrue($commit instanceof Commit, "getCommit returns a Commit");
 
         $this->assertEquals(self::BEFORE_LONGFILE_COMMIT, $commit->getHash(), "Resolution is correct");
     }
 
     /**
      * @dataProvider provideFoobar
      * @expectedException Gitonomy\Git\Exception\ReferenceNotFoundException
-     * @expectedExceptionMessage Can not find reference "non-existent-commit"
+     * @expectedExceptionMessage Can not find revision "non-existent-commit"
      */
     public function testGetFailingReference($repository)
     {
-        $revision = $repository->getRevision('non-existent-commit')->getResolved();
+        $revision = $repository->getRevision('non-existent-commit')->getCommit();
     }
 
     /**