update doc and tests

Author: alexandresalome

doc/api/admin.rst

@@ -1,26 +1,29 @@
-Create git repositories
-=======================
+Administration of git repositories
+==================================
 
-Initialize a repository
------------------------
+Initializing repositories
+:::::::::::::::::::::::::
 
-Bare repository
-:::::::::::::::
+Create a bare repository
+------------------------
 
 You can create a bare repository using ``Admin::init``:
 
 .. code-block:: php
 
-    use Gitonomy\Git\Admin;
+    $repository = Gitonomy\Git\Admin::init('/path/to/repository');
 
-    $repository = Admin::init('/path/to/repository');
-
-Non-bare repository
-:::::::::::::::::::
+Create a repository with a working copy
+---------------------------------------
 
 If you want to create a repository with a working directory, pass ``false`` as
 second argument:
 
 .. code-block:: php
 
     $repository = Gitonomy\Git\Admin::init('/path/to/folder', false);
+
+References
+::::::::::
+
+- http://linux.die.net/man/1/git-init

doc/api/blame.rst

@@ -28,7 +28,7 @@ If you want to access directly a line:
 Group reading by commit
 -----------------------
 
-If you plan to display it, you'll probably need a version where lines from same commit are merged.
+If you plan to display it, you'll probably need a version where lines from same commit are grouped.
 
 To do so, use the *getGroupedLines* method that will return an array like this:
 

doc/index.rst

@@ -1,47 +1,39 @@
-gitlib - PHP-library to access git
+gitlib - library to manipulate git
 ==================================
 
-View on Github: https://github.com/gitonomy/gitlib
+gitlib requires PHP 5.3 and class autoloading (PSR-0) to work properly. Internally, it relies on ``git`` method calls
+to fetch informations from repository.
 
-This library is a PHP-library for browsing git repositories.
-
-This library relies on ``git`` command.
+.. code-block:: php
 
-Example
--------
+    use Gitonomy\Git\Repository;
 
-.. code-block:: php
+    $repository = new Repository('/path/to/repository');
 
-    $repository = new Gitonomy\Git\Repository('/path/to/repository');
-    $master     = $repository->getReferences()->getBranch('master');
+    foreach ($repository->getReferences()->getBranches() as $branch) {
+        echo "- ".$branch->getName();
+    }
 
-    $author = $master->getCommit()->getAuthorName();
+    $repository->run('fetch', array('--all'));
 
-    echo "Last modification on master made by ".$author;
 
 Documentation
 -------------
 
 .. toctree::
    :maxdepth: 2
 
+   installation
    api
-
-Features
---------
-
-* Create repositories
-* Manage hooks in repositories
+   development
 
 Missing features
 ----------------
 
-* Remote management
-* Clone
-
-Requirements
-------------
+Some major features are still missing from gitlib:
 
-**Minimum PHP version**: PHP 5.3.3
+* Remotes
+* Clone
+* Submodules
 
-To use this library, you must have *git* installed and available in shell.
+If you want to run git commands on repository, call method ``Repository::run`` with method and arguments.

tests/Gitonomy/Git/Tests/AdminTest.php

@@ -13,6 +13,7 @@
 namespace Gitonomy\Git\Tests;
 
 use Gitonomy\Git\Admin;
+use Gitonomy\Git\Repository;
 
 class AdminTest extends AbstractTest
 {
@@ -25,45 +26,39 @@ public function setUp()
 
     public function tearDown()
     {
-        $this->deleteDir($this->tmpDir);
+        $this->deleteDir($this->createTempDir());
     }
 
-    public function testBare_WithInitialDirectory_Works()
+    public function testBare()
     {
-        Admin::init($this->tmpDir);
+        $repository = Admin::init($this->tmpDir);
 
         $objectDir = $this->tmpDir.'/objects';
-        $this->assertTrue(is_dir($objectDir),     "objects/ folder is present");
-    }
 
-    public function testBare_WithoutInitialDirectory_StillWorks()
-    {
-        Admin::init($this->tmpDir.'/test');
-
-        $objectDir = $this->tmpDir.'/test/objects';
+        $this->assertTrue($repository->isBare(), "Repository is bare");
         $this->assertTrue(is_dir($objectDir),     "objects/ folder is present");
+        $this->assertTrue($repository instanceof Repository, "Admin::init returns a repository");
+        $this->assertEquals($this->tmpDir, $repository->getGitDir(), "The folder passed as argument is git dir");
+        $this->assertNull($repository->getWorkingDir(), "No working dir in bare repository");
     }
 
-    public function testNotBare_WithInitialDirectory_Works()
+    public function testNotBare()
     {
-        Admin::init($this->tmpDir, false);
+        $repository = Admin::init($this->tmpDir, false);
 
         $objectDir = $this->tmpDir.'/.git/objects';
-        $this->assertTrue(is_dir($objectDir),     "objects/ folder is present");
-    }
-
-    public function testNotBare_WithoutInitialDirectory_StillWorks()
-    {
-        Admin::init($this->tmpDir.'/test', false);
 
-        $objectDir = $this->tmpDir.'/test/.git/objects';
-        $this->assertTrue(is_dir($objectDir),     "objects/ folder is present");
+        $this->assertFalse($repository->isBare(), "Repository is not bare");
+        $this->assertTrue(is_dir($objectDir), "objects/ folder is present");
+        $this->assertTrue($repository instanceof Repository, "Admin::init returns a repository");
+        $this->assertEquals($this->tmpDir.'/.git', $repository->getGitDir(), "git dir as subfolder of argument");
+        $this->assertEquals($this->tmpDir, $repository->getWorkingDir(), "working dir present in bare repository");
     }
 
     /**
      * @expectedException RuntimeException
      */
-    public function testFail()
+    public function testExistingFile()
     {
         $file = $this->tmpDir.'/test';
         touch($file);

tests/Gitonomy/Git/Tests/RepositoryTest.php

@@ -98,6 +98,10 @@ public function testEventDispatcher_Error()
 
     public function testLoggerOk()
     {
+        if (!class_exists('Psr\Log\LoggerInterface')) {
+            $this->markTestSkipped();
+        }
+
         $logger = $this->getMock('Psr\Log\LoggerInterface');
         $logger
             ->expects($this->once())
@@ -119,6 +123,10 @@ public function testLoggerOk()
      */
     public function testLoggerNOk()
     {
+        if (!class_exists('Psr\Log\LoggerInterface')) {
+            $this->markTestSkipped();
+        }
+
         $logger = $this->getMock('Psr\Log\LoggerInterface');
         $logger
             ->expects($this->once())