Enhancement: Extract GitInfo value object (#120)

Author: localheinz

src/System/Git/GitCommand.php

@@ -7,10 +7,22 @@ class GitCommand extends SystemCommand
 {
     protected $commandPath = 'git';
 
+    /**
+     * @return GitInfoInterface
+     */
+    public function getGitInfo()
+    {
+        return new GitInfo(
+            $this->getHead(),
+            $this->getBranch(),
+            $this->getCommittedAt()
+        );
+    }
+
     /**
      * @return string
      */
-    public function getHead()
+    private function getHead()
     {
         $command = $this->createCommand("log -1 --pretty=format:'%H'");
 
@@ -20,7 +32,7 @@ public function getHead()
     /**
      * @return string|null
      */
-    public function getBranch()
+    private function getBranch()
     {
         $command  = $this->createCommand("branch");
         $branches = $this->executeCommand($command);
@@ -37,7 +49,7 @@ public function getBranch()
     /**
      * @return int
      */
-    public function getCommittedAt()
+    private function getCommittedAt()
     {
         $command = $this->createCommand("log -1 --pretty=format:'%ct'");
 

src/System/Git/GitInfo.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace CodeClimate\PhpTestReporter\System\Git;
+
+/**
+ * @internal
+ */
+final class GitInfo implements GitInfoInterface
+{
+    /**
+     * @var string
+     */
+    private $head;
+
+    /**
+     * @var string
+     */
+    private $branch;
+
+    /**
+     * @var int
+     */
+    private $committedAt;
+
+    /**
+     * @param string $head
+     * @param string|null $branch
+     * @param int $committedAt
+     */
+    public function __construct($head, $branch, $committedAt)
+    {
+        $this->head = $head;
+        $this->branch = $branch;
+        $this->committedAt = $committedAt;
+    }
+
+    public function head()
+    {
+        return $this->head;
+    }
+
+    public function branch()
+    {
+        return $this->branch;
+    }
+
+    public function committedAt()
+    {
+        return $this->committedAt;
+    }
+
+    public function toArray()
+    {
+        return array(
+            'head' => $this->head,
+            'branch' => $this->branch,
+            'committed_at' => $this->committedAt,
+        );
+    }
+}

src/System/Git/GitInfoInterface.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace CodeClimate\PhpTestReporter\System\Git;
+
+/**
+ * @internal
+ */
+interface GitInfoInterface
+{
+    /**
+     * @return string
+     */
+    public function head();
+
+    /**
+     * @return string
+     */
+    public function branch();
+
+    /**
+     * @return int
+     */
+    public function committedAt();
+
+    /**
+     * @return array
+     */
+    public function toArray();
+}

src/TestReporter/Entity/JsonFile.php

@@ -49,11 +49,7 @@ protected function collectGitInfo()
     {
         $command = new GitCommand();
 
-        return array(
-            "head"         => $command->getHead(),
-            "branch"       => $command->getBranch(),
-            "committed_at" => $command->getCommittedAt(),
-        );
+        return $command->getGitInfo()->toArray();
     }
 
     /**

tests/Unit/System/Git/GitInfoTest.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace CodeClimate\PhpTestReporter\Tests\Unit\System\Git;
+
+use CodeClimate\PhpTestReporter\System\Git\GitInfo;
+
+class GitInfoTest extends \PHPUnit_Framework_TestCase
+{
+    public function testIsFinal()
+    {
+        $reflection = new \ReflectionClass('CodeClimate\PhpTestReporter\System\Git\GitInfo');
+
+        $this->assertTrue($reflection->isFinal());
+    }
+
+    public function testImplementsGitInfoInterface()
+    {
+        $reflection = new \ReflectionClass('CodeClimate\PhpTestReporter\System\Git\GitInfo');
+
+        $this->assertTrue($reflection->implementsInterface('CodeClimate\PhpTestReporter\System\Git\GitInfoInterface'));
+    }
+
+    public function testConstructorSetsValues()
+    {
+        $head = 'foo';
+        $branch = 'feature/gitinfo';
+        $committedAt = time();
+
+        $info = new GitInfo(
+            $head,
+            $branch,
+            $committedAt
+        );
+
+        $this->assertSame($head, $info->head());
+        $this->assertSame($branch, $info->branch());
+        $this->assertSame($committedAt, $info->committedAt());
+    }
+
+    public function testToArrayReturnsArrayRepresentation()
+    {
+        $head = 'foo';
+        $branch = 'feature/gitinfo';
+        $committedAt = time();
+
+        $info = new GitInfo(
+            $head,
+            $branch,
+            $committedAt
+        );
+
+        $expected = array(
+            'head' => $head,
+            'branch' => $branch,
+            'committed_at' => $committedAt,
+        );
+
+        $this->assertEquals($expected, $info->toArray());
+    }
+}