Merge pull request #58 from pitpit/feature-cloneBranchTo

Add ability to clone a repository and point head to a specific branch in one call

Author: Alexandre Salomé

doc/api/admin.rst

@@ -35,6 +35,16 @@ You can clone a repository from an URL by doing:
 
 Default behavior is to clone in a bare repository.
 
+You can also clone a repository and point it to a specific branch. In a non-bare repository, this branch will be checked out:
+
+.. code-block:: php
+
+    // Clone to a bare repository
+    $repository = Gitonomy\Git\Admin::cloneBranchTo('/tmp/gitlib', 'https://github.com/gitonomy/gitlib.git', 'a-branch');
+
+    // Clone to a non-bare repository
+    $repository = Gitonomy\Git\Admin::cloneBranchTo('/tmp/gitlib', 'https://github.com/gitonomy/gitlib.git', 'a-branch' false);
+
 Clone a Repository object
 -------------------------
 

src/Gitonomy/Git/Admin.php

@@ -84,6 +84,27 @@ public static function cloneTo($path, $url, $bare = true, array $options = array
         return static::cloneRepository($path, $url, $args, $options);
     }
 
+    /**
+     * Clone a repository branch to a local path.
+     *
+     * @param string  $path    indicates where to clone repository
+     * @param string  $url     url of repository to clone
+     * @param string  $branch  branch to clone
+     * @param boolean $bare    indicates if repository should be bare or have a working copy
+     * @param array   $options options for Repository creation
+     *
+     * @return Repository
+     */
+    public static function cloneBranchTo($path, $url, $branch, $bare = true, $options = array())
+    {
+        $args = array('--branch', $branch);
+        if ($bare) {
+            $args[] = '--bare';
+        }
+
+        return static::cloneRepository($path, $url, $args, $options);
+    }
+
     /**
      * Mirrors a repository (fetch all revisions, not only branches).
      *

tests/Gitonomy/Git/Tests/AdminTest.php

@@ -14,6 +14,7 @@
 
 use Gitonomy\Git\Admin;
 use Gitonomy\Git\Repository;
+use Gitonomy\Git\Reference\Branch;
 
 class AdminTest extends AbstractTest
 {
@@ -78,6 +79,36 @@ public function testClone($repository)
         }
     }
 
+    public function testCloneBranchBare()
+    {
+        //we can't use AbstractText::createFoobarRepository()
+        //because it does not clone other branches than "master"
+        //so we test it directly against the remote repository
+
+        $newDir = self::createTempDir();
+        $new = Admin::cloneBranchTo($newDir, self::REPOSITORY_URL, 'new-feature');
+        self::registerDeletion($new);
+
+        $head = $new->getHead();
+        $this->assertTrue($head instanceof Branch, "HEAD is a branch");
+        $this->assertEquals("new-feature", $head->getName(), "HEAD is branch new-feature");
+    }
+
+    public function testCloneBranchNotBare()
+    {
+        //we can't use AbstractText::createFoobarRepository()
+        //because it does not clone other branches than "master"
+        //so we test it directly against remote repository
+
+        $newDir = self::createTempDir();
+        $new = Admin::cloneBranchTo($newDir, self::REPOSITORY_URL, 'new-feature', false);
+        self::registerDeletion($new);
+
+        $head = $new->getHead();
+        $this->assertTrue($head instanceof Branch, "HEAD is a branch");
+        $this->assertEquals("new-feature", $head->getName(), "HEAD is branch new-feature");
+    }
+
     /**
      * @dataProvider provideFoobar
      */