add getVisibility method

src/Github/GithubProject.php

@@ -3,6 +3,7 @@
 namespace MBO\RemoteGit\Github;
 
 use MBO\RemoteGit\ProjectInterface;
+use MBO\RemoteGit\ProjectVisibility;
 
 /**
  * Project implementation for github.
@@ -33,14 +34,19 @@ public function getDefaultBranch(): ?string
         return $this->rawMetadata['default_branch'];
     }
 
+    public function getHttpUrl(): string
+    {
+        return $this->rawMetadata['clone_url'];
+    }
+
     public function isArchived(): bool
     {
         return $this->rawMetadata['archived'];
     }
 
-    public function getHttpUrl(): string
+    public function getVisibility(): ?ProjectVisibility
     {
-        return $this->rawMetadata['clone_url'];
+        return $this->rawMetadata['private'] ? ProjectVisibility::PRIVATE : ProjectVisibility::PUBLIC;
     }
 
     public function getRawMetadata(): array

src/Gitlab/GitlabProject.php

@@ -3,6 +3,8 @@
 namespace MBO\RemoteGit\Gitlab;
 
 use MBO\RemoteGit\ProjectInterface;
+use MBO\RemoteGit\ProjectVisibility;
+use RuntimeException;
 
 /**
  * Common project properties between different git project host (gitlab, github, etc.).
@@ -47,6 +49,20 @@ public function isArchived(): bool
         return $this->rawMetadata['archived'];
     }
 
+    public function getVisibility(): ?ProjectVisibility
+    {
+        switch ($this->rawMetadata['visibility']) {
+            case 'public':
+                return ProjectVisibility::PUBLIC;
+            case 'private':
+                return ProjectVisibility::PRIVATE;
+            case 'internal':
+                return ProjectVisibility::INTERNAL;
+            default:
+                throw new RuntimeException("Unknown visibility: {$this->rawMetadata['visibility']}");
+        }
+    }
+
     public function getRawMetadata(): array
     {
         return $this->rawMetadata;

src/Gogs/GogsProject.php

@@ -3,6 +3,7 @@
 namespace MBO\RemoteGit\Gogs;
 
 use MBO\RemoteGit\ProjectInterface;
+use MBO\RemoteGit\ProjectVisibility;
 
 /**
  * Project implementation for github.
@@ -43,6 +44,17 @@ public function isArchived(): bool
         return $this->rawMetadata['archived'];
     }
 
+    public function getVisibility(): ?ProjectVisibility
+    {
+        if ($this->rawMetadata['private']) {
+            return ProjectVisibility::PRIVATE;
+        } elseif ($this->rawMetadata['internal']) {
+            return ProjectVisibility::INTERNAL;
+        } else {
+            return ProjectVisibility::PUBLIC;
+        }
+    }
+
     public function getRawMetadata(): array
     {
         return $this->rawMetadata;

src/Local/LocalProject.php

@@ -3,6 +3,7 @@
 namespace MBO\RemoteGit\Local;
 
 use MBO\RemoteGit\ProjectInterface;
+use MBO\RemoteGit\ProjectVisibility;
 
 /**
  * Project corresponding to a local git folder.
@@ -41,6 +42,11 @@ public function isArchived(): bool
         return false; // Always returns false for LocalClient
     }
 
+    public function getVisibility(): ?ProjectVisibility
+    {
+        return null; // Always returns null for LocalClient
+    }
+
     public function getRawMetadata(): array
     {
         return $this->rawMetadata;

src/ProjectInterface.php

@@ -36,6 +36,13 @@ public function getHttpUrl(): string;
      */
     public function isArchived(): bool;
 
+    /**
+     * Get project visibility.
+     *
+     * @warning This method will always return null for LocalClient.
+     */
+    public function getVisibility(): ?ProjectVisibility;
+
     /**
      * Get hosting service specific properties.
      *

src/ProjectVisibility.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace MBO\RemoteGit;
+
+/**
+ * Represents the visibility of a project.
+ *
+ * Note that internal is not supported by GitHub
+ */
+enum ProjectVisibility: string
+{
+    case PUBLIC = 'public';
+    case PRIVATE = 'private';
+    case INTERNAL = 'internal';
+}

tests/GithubClientTest.php

@@ -7,6 +7,7 @@
 use MBO\RemoteGit\FindOptions;
 use MBO\RemoteGit\Github\GithubClient;
 use MBO\RemoteGit\Github\GithubProject;
+use MBO\RemoteGit\ProjectVisibility;
 use Psr\Log\NullLogger;
 
 class GithubClientTest extends TestCase
@@ -95,6 +96,9 @@ public function testUserAndOrgsRepositories(): void
 
         /* test isArchived */
         $this->assertFalse($project->isArchived());
+
+        /* test getVisibility */
+        $this->assertEquals(ProjectVisibility::PUBLIC, $project->getVisibility());
     }
 
     /**

tests/GitlabClientTest.php

@@ -7,6 +7,7 @@
 use MBO\RemoteGit\FindOptions;
 use MBO\RemoteGit\Gitlab\GitlabClient;
 use MBO\RemoteGit\Gitlab\GitlabProject;
+use MBO\RemoteGit\ProjectVisibility;
 use Psr\Log\NullLogger;
 
 class GitlabClientTest extends TestCase
@@ -62,18 +63,24 @@ public function testGitlabDotComByUser(): void
         );
 
         $project = $projectsByName['mborne/sample-composer'];
+
         /* test getDefaultBranch */
         $defaultBranch = $project->getDefaultBranch();
         $this->assertNotNull($defaultBranch);
+
         /* test getRawFile */
         $composer = $client->getRawFile(
             $project,
             'composer.json',
             $defaultBranch
         );
         $this->assertStringContainsString('mborne@users.noreply.github.com', $composer);
+
         /* test isArchived */
         $this->assertFalse($project->isArchived());
+
+        /* test getVisibility */
+        $this->assertEquals(ProjectVisibility::PUBLIC, $project->getVisibility());
     }
 
     public function testGitlabDotComOrgs(): void
@@ -140,5 +147,8 @@ public function testGitlabDotComSearch(): void
 
         /* test isArchived */
         $this->assertFalse($project->isArchived());
+
+        /* test getVisibility */
+        $this->assertEquals(ProjectVisibility::PUBLIC, $project->getVisibility());
     }
 }

tests/GogsClientTest.php

@@ -7,6 +7,7 @@
 use MBO\RemoteGit\FindOptions;
 use MBO\RemoteGit\Gogs\GogsClient;
 use MBO\RemoteGit\Gogs\GogsProject;
+use MBO\RemoteGit\ProjectVisibility;
 
 /**
  * Test GogsClient with https://codes.quadtreeworld.net which is a gitea instance.
@@ -125,5 +126,8 @@ public function testFindByUserAndOrgs(): void
 
         /* test isArchived */
         $this->assertFalse($project->isArchived());
+
+        /* test getVisibility */
+        $this->assertEquals(ProjectVisibility::PUBLIC, $project->getVisibility());
     }
 }

tests/LocalClientTest.php

@@ -99,6 +99,17 @@ public function testIsArchived(): void
         }
     }
 
+    /**
+     * Ensure that isArchived returns public.
+     */
+    public function testGetVisibility(): void
+    {
+        $projects = $this->findAllProjects();
+        foreach ($projects as $project) {
+            $this->assertNull($project->getVisibility());
+        }
+    }
+
     /**
      * Check that raw file content can be retreived from non bare repository.
      */