add tests and documentation for clone feature

Author: alexandresalome

doc/api/admin.rst

@@ -21,9 +21,27 @@ second argument:
 
 .. code-block:: php
 
-    $repository = Gitonomy\Git\Admin::init('/path/to/folder', false);
+    $repository = Gitonomy\Git\Admin::init('/tmp/git_sandbox', false);
+
+Cloning repositories
+::::::::::::::::::::
+
+You can clone a repository from an URL by doing:
+
+.. code-block:: php
+
+    $repository = Gitonomy\Git\Admin::cloneTo('/tmp/gitlib', 'https://github.com/gitonomy/gitlib.git');
+
+You can pass ``false`` and third argument to get a repository with a working copy.
+
+If you already have a Repository instance and want to clone it, you can use this shortcut:
+
+.. code-block:: php
+
+    $new = $repository->cloneTo('/tmp/clone');
 
 References
 ::::::::::
 
-- http://linux.die.net/man/1/git-init
+* http://linux.die.net/man/1/git-init
+* http://linux.die.net/man/1/git-clone

doc/development.rst

@@ -0,0 +1,13 @@
+Developing gitlib
+=================
+
+If you plan to contribute to gitlib, here are few things you should know:
+
+Documentation generation
+::::::::::::::::::::::::
+
+Documentation is generated using Sphinx (restructured text). Configuration file
+is located in https://github.com/gitonomy/website/blob/master/bin/conf.py
+
+You will need to fetch vendor modules for PHP blocks especially. If you really
+want to generate it, install the website project locally and hack into it.

doc/index.rst

@@ -33,7 +33,6 @@ Missing features
 Some major features are still missing from gitlib:
 
 * Remotes
-* Clone
 * Submodules
 
 If you want to run git commands on repository, call method ``Repository::run`` with method and arguments.

doc/installation.rst

@@ -0,0 +1,20 @@
+Installation of gitlib
+======================
+
+Autoloading
+:::::::::::
+
+gitlib relies on class autoloading. It does not require any additional setup.
+
+Using composer
+::::::::::::::
+
+Edit your ``composer.json`` file and add ``gitonomy/gitlib`` in section ``require``:
+
+.. code-block:: json
+
+    {
+        "require": {
+            "gitonomy/gitlib": "dev-master"
+        }
+    }

tests/Gitonomy/Git/Tests/AdminTest.php

@@ -55,6 +55,28 @@ public function testNotBare()
         $this->assertEquals($this->tmpDir, $repository->getWorkingDir(), "working dir present in bare repository");
     }
 
+    /**
+     * @dataProvider provideFoobar
+     */
+    public function testClone($repository)
+    {
+        $newDir = self::createTempDir();
+        $new = $repository->cloneTo($newDir, $repository->isBare());
+        self::registerDeletion($new);
+
+        $oldRefs = $repository->getReferences()->getAll();
+        $newRefs = $new->getReferences()->getAll();
+
+        $this->assertEquals(array_keys($oldRefs), array_keys($newRefs), "same references in both repositories");
+
+        if ($repository->isBare()) {
+            $this->assertEquals($newDir, $new->getGitDir());
+        } else {
+            $this->assertEquals($newDir.'/.git', $new->getGitDir());
+            $this->assertEquals($newDir, $new->getWorkingDir());
+        }
+    }
+
     /**
      * @expectedException RuntimeException
      */