organize RemoteGit to highlight interfaces (refs #24)

src/MBO/RemoteGit/ClientFactory.php

@@ -5,6 +5,10 @@
 use Psr\Log\LoggerInterface;
 use \GuzzleHttp\Client as GuzzleHttpClient;
 
+use MBO\RemoteGit\Github\GithubClient;
+use MBO\RemoteGit\Gitlab\GitlabClient;
+
+
 /**
  * Helper to create clients
  */

src/MBO/RemoteGit/Filter/FilterCollection.php

@@ -4,7 +4,9 @@
 
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
+
 use MBO\RemoteGit\ProjectInterface;
+use MBO\RemoteGit\ProjectFilterInterface;
 
 /**
  * Compose a list of filter to simplify command line integration

src/MBO/RemoteGit/Filter/GitlabNamespaceFilter.php

@@ -2,9 +2,11 @@
 
 namespace MBO\RemoteGit\Filter;
 
+use Psr\Log\LoggerInterface;
+
 use MBO\RemoteGit\ProjectInterface;
+use MBO\RemoteGit\ProjectFilterInterface;
 use MBO\RemoteGit\ClientInterface as GitClientInterface;
-use Psr\Log\LoggerInterface;
 
 /**
  * Filter projects based on GitLab project namespace name or id.

src/MBO/RemoteGit/Filter/IgnoreRegexpFilter.php

@@ -3,6 +3,7 @@
 namespace MBO\RemoteGit\Filter;
 
 use MBO\RemoteGit\ProjectInterface;
+use MBO\RemoteGit\ProjectFilterInterface;
 
 /**
  * Ignore project according to a regular expression

src/MBO/RemoteGit/Filter/IncludeIfHasFileFilter.php

@@ -2,14 +2,15 @@
 
 namespace MBO\RemoteGit\Filter;
 
+use Psr\Log\LoggerInterface;
+
 use MBO\RemoteGit\ProjectInterface;
+use MBO\RemoteGit\ProjectFilterInterface;
 use MBO\RemoteGit\ClientInterface as GitClientInterface;
-use Psr\Log\LoggerInterface;
+
 
 /**
  * Accept projects if git contains a given file
- * 
- * TODO remove (done at git listing level)
  */
 class IncludeIfHasFileFilter implements ProjectFilterInterface {
 

src/MBO/RemoteGit/Filter/ProjectTypeFilter.php

@@ -2,9 +2,12 @@
 
 namespace MBO\RemoteGit\Filter;
 
+use Psr\Log\LoggerInterface;
+
 use MBO\RemoteGit\ProjectInterface;
+use MBO\RemoteGit\ProjectFilterInterface;
 use MBO\RemoteGit\ClientInterface as GitClientInterface;
-use Psr\Log\LoggerInterface;
+
 
 /**
  * Ignore project according to their type

src/MBO/RemoteGit/FindOptions.php

@@ -32,14 +32,15 @@ class FindOptions {
     private $users = array();
 
     /**
-     * Filters not appliable throw API usage
+     * Additional filter that can't be implemented throw 
+     * project listing API parameters 
      *
-     * @var FilterCollection
+     * @var ProjectFilterInterface
      */
-    private $filterCollection ;
+    private $filter ;
 
     public function __construct(){
-        $this->filterCollection = new FilterCollection();
+        $this->filter = new FilterCollection();
     }
 
     /**
@@ -78,75 +79,75 @@ public function setSearch(string $search)
 
 
     /**
-     * Get filters not appliable throw API usage
+     * Get filter according to organizations
      *
-     * @return  FilterCollection
+     * @return  string[]
      */ 
-    public function getFilterCollection()
+    public function getOrganizations()
     {
-        return $this->filterCollection;
+        return $this->organizations;
     }
 
     /**
-     * Set filters not appliable throw API usage
+     * Set filter according to organizations
      *
-     * @param  FilterCollection  $filterCollection  Filters not appliable throw API usage
+     * @param  string[]  $organizations  Filter according to organizations
      *
      * @return  self
      */ 
-    public function setFilterCollection(FilterCollection $filterCollection)
+    public function setOrganizations(array $organizations)
     {
-        $this->filterCollection = $filterCollection;
+        $this->organizations = $organizations;
 
         return $this;
     }
 
 
     /**
-     * Get filter according to organizations
+     * Get filter according to user names
      *
      * @return  string[]
      */ 
-    public function getOrganizations()
+    public function getUsers()
     {
-        return $this->organizations;
+        return $this->users;
     }
 
     /**
-     * Set filter according to organizations
+     * Set filter according to user names
      *
-     * @param  string[]  $organizations  Filter according to organizations
+     * @param  string[]  $users  Filter according to user names
      *
      * @return  self
      */ 
-    public function setOrganizations(array $organizations)
+    public function setUsers(array $users)
     {
-        $this->organizations = $organizations;
+        $this->users = $users;
 
         return $this;
     }
 
 
     /**
-     * Get filter according to user names
+     * Get project listing API parameters
      *
-     * @return  string[]
+     * @return  ProjectFilterInterface
      */ 
-    public function getUsers()
+    public function getFilter()
     {
-        return $this->users;
+        return $this->filter;
     }
 
     /**
-     * Set filter according to user names
+     * Set project listing API parameters
      *
-     * @param  string[]  $users  Filter according to user names
+     * @param  ProjectFilterInterface  $filter  project listing API parameters
      *
      * @return  self
      */ 
-    public function setUsers(array $users)
+    public function setFilter(ProjectFilterInterface $filter)
     {
-        $this->users = $users;
+        $this->filter = $filter;
 
         return $this;
     }

src/MBO/RemoteGit/GithubClient.php → src/MBO/RemoteGit/Github/GithubClient.php

@@ -1,11 +1,15 @@
 <?php
 
-namespace MBO\RemoteGit;
+namespace MBO\RemoteGit\Github;
 
 use Psr\Log\LoggerInterface;
 use \GuzzleHttp\Client as GuzzleHttpClient;
 
-use MBO\RemoteGit\Filter\ProjectFilterInterface;
+use MBO\RemoteGit\ClientInterface;
+use MBO\RemoteGit\ProjectInterface;
+use MBO\RemoteGit\FindOptions;
+use MBO\RemoteGit\ProjectFilterInterface;
+
 
 /**
  * Client implementation for github
@@ -56,13 +60,13 @@ public function find(FindOptions $options){
         foreach ( $options->getUsers() as $user ){
             $result = array_merge($result,$this->findByUser(
                 $user,
-                $options->getFilterCollection()
+                $options->getFilter()
             ));
         }
         foreach ( $options->getOrganizations() as $org ){
             $result = array_merge($result,$this->findByOrg(
                 $org,
-                $options->getFilterCollection()
+                $options->getFilter()
             ));
         }
         return $result;

src/MBO/RemoteGit/GithubProject.php → src/MBO/RemoteGit/Github/GithubProject.php

@@ -1,6 +1,8 @@
 <?php
 
-namespace MBO\RemoteGit;
+namespace MBO\RemoteGit\Github;
+
+use MBO\RemoteGit\ProjectInterface;
 
 /**
  * Project implementation for github

src/MBO/RemoteGit/GitlabClient.php → src/MBO/RemoteGit/Gitlab/GitlabClient.php

@@ -1,11 +1,15 @@
 <?php
 
-namespace MBO\RemoteGit;
+namespace MBO\RemoteGit\Gitlab;
 
-use \GuzzleHttp\Client as GuzzleHttpClient;
 use Psr\Log\LoggerInterface;
+use \GuzzleHttp\Client as GuzzleHttpClient;
+
+use MBO\RemoteGit\ClientInterface;
+use MBO\RemoteGit\ProjectInterface;
+use MBO\RemoteGit\FindOptions;
+use MBO\RemoteGit\ProjectFilterInterface;
 
-use MBO\RemoteGit\Filter\ProjectFilterInterface;
 
 /**
  * Find gitlab projects
@@ -57,13 +61,13 @@ public function find(FindOptions $options){
         foreach ( $options->getUsers() as $user ){
             $result = array_merge($result,$this->findByUser(
                 $user,
-                $options->getFilterCollection()
+                $options->getFilter()
             ));
         }
         foreach ( $options->getOrganizations() as $org ){
             $result = array_merge($result,$this->findByGroup(
                 $org,
-                $options->getFilterCollection()
+                $options->getFilter()
             ));
         }
         return $result;
@@ -113,7 +117,7 @@ protected function findBySearch(FindOptions $options){
         return $this->fetchAllPages(
             $path,
             $params,
-            $options->getFilterCollection()
+            $options->getFilter()
         );
     }
 

src/MBO/RemoteGit/GitlabProject.php → src/MBO/RemoteGit/Gitlab/GitlabProject.php

@@ -1,6 +1,8 @@
 <?php
 
-namespace MBO\RemoteGit;
+namespace MBO\RemoteGit\Gitlab;
+
+use MBO\RemoteGit\ProjectInterface;
 
 /**
  * Common project properties between different git project host (gitlab, github, etc.)

src/MBO/RemoteGit/Filter/ProjectFilterInterface.php → src/MBO/RemoteGit/ProjectFilterInterface.php

@@ -1,9 +1,6 @@
 <?php
 
-namespace MBO\RemoteGit\Filter;
-
-use MBO\RemoteGit\ProjectInterface;
-
+namespace MBO\RemoteGit;
 
 /**
  * Test if a project should be included in satis config (regexp, )

src/MBO/SatisGitlab/Command/GitlabToConfigCommand.php

@@ -55,11 +55,10 @@ protected function configure() {
             ->addArgument('gitlab-token')
 
             /*
-             * Project listing options (git level)
+             * Project listing options (hosted git api level)
              */
             ->addOption('orgs', 'o', InputOption::VALUE_REQUIRED, 'Find projects according to given organization names')
             ->addOption('users', 'u', InputOption::VALUE_REQUIRED, 'Find projects according to given user names')
-
             ->addOption('projectFilter', 'p', InputOption::VALUE_OPTIONAL, 'filter for projects (deprecated : see organization and users)', null)
 
             /*
@@ -134,7 +133,7 @@ protected function execute(InputInterface $input, OutputInterface $output) {
          * Create project filters according to input arguments
          */
         $filterCollection = new FilterCollection($logger);
-        $findOptions->setFilterCollection($filterCollection);
+        $findOptions->setFilter($filterCollection);
 
         /* ignore if 'composer.json' is not available */
         $filterCollection->addFilter(new IncludeIfHasFileFilter(

tests/RemoteGit/Filter/FilterCollectionTest.php

@@ -6,9 +6,9 @@
 
 use Psr\Log\NullLogger;
 
-use MBO\RemoteGit\Filter\FilterCollection;
 use MBO\RemoteGit\ProjectInterface;
-use MBO\RemoteGit\Filter\ProjectFilterInterface;
+use MBO\RemoteGit\ProjectFilterInterface;
+use MBO\RemoteGit\Filter\FilterCollection;
 
 /**
  * Test FilterCollection

tests/RemoteGit/Filter/IgnoreRegexpFilterTest.php

@@ -6,8 +6,9 @@
 
 use Symfony\Component\Console\Tester\CommandTester;
 
-use MBO\RemoteGit\Filter\IgnoreRegexpFilter;
 use MBO\RemoteGit\ProjectInterface;
+use MBO\RemoteGit\Filter\IgnoreRegexpFilter;
+
 
 /**
  * Test IgnoreRegexpFilter

tests/RemoteGit/GithubClientTest.php

@@ -10,10 +10,12 @@
 use Psr\Log\NullLogger;
 use MBO\RemoteGit\ClientOptions;
 use MBO\RemoteGit\ClientFactory;
-use MBO\RemoteGit\GithubClient;
-use MBO\RemoteGit\GithubProject;
 use MBO\RemoteGit\FindOptions;
 
+use MBO\RemoteGit\Github\GithubClient;
+use MBO\RemoteGit\Github\GithubProject;
+
+
 class GithubClientTest extends TestCase {
 
     /**

tests/RemoteGit/GitlabClientTest.php

@@ -5,13 +5,14 @@
 use MBO\SatisGitlab\Tests\TestCase;
 
 use GuzzleHttp\Client as GuzzleHttpClient;
-use MBO\RemoteGit\GitlabClient;
 
 use Psr\Log\NullLogger;
 use MBO\RemoteGit\ClientOptions;
 use MBO\RemoteGit\ClientFactory;
 use MBO\RemoteGit\FindOptions;
 
+use MBO\RemoteGit\Gitlab\GitlabClient;
+use MBO\RemoteGit\Gitlab\GitlabProject;
 
 class GitlabClientTest extends TestCase {