add isArchived() method

src/Github/GithubProject.php

@@ -33,6 +33,11 @@ public function getDefaultBranch(): ?string
         return $this->rawMetadata['default_branch'];
     }
 
+    public function isArchived(): bool
+    {
+        return $this->rawMetadata['archived'];
+    }
+
     public function getHttpUrl(): string
     {
         return $this->rawMetadata['clone_url'];

src/Gitlab/GitlabProject.php

@@ -42,6 +42,11 @@ public function getHttpUrl(): string
         return $this->rawMetadata['http_url_to_repo'];
     }
 
+    public function isArchived(): bool
+    {
+        return $this->rawMetadata['archived'];
+    }
+
     public function getRawMetadata(): array
     {
         return $this->rawMetadata;

src/Gogs/GogsProject.php

@@ -38,6 +38,11 @@ public function getHttpUrl(): string
         return $this->rawMetadata['clone_url'];
     }
 
+    public function isArchived(): bool
+    {
+        return $this->rawMetadata['archived'];
+    }
+
     public function getRawMetadata(): array
     {
         return $this->rawMetadata;

src/Local/LocalProject.php

@@ -36,6 +36,11 @@ public function getHttpUrl(): string
         return $this->rawMetadata['full_path'];
     }
 
+    public function isArchived(): bool
+    {
+        return false; // Always returns false for LocalClient
+    }
+
     public function getRawMetadata(): array
     {
         return $this->rawMetadata;

src/ProjectInterface.php

@@ -29,6 +29,13 @@ public function getDefaultBranch(): ?string;
      */
     public function getHttpUrl(): string;
 
+    /**
+     * True if the project is archived.
+     *
+     * @warning This method will always return false for LocalClient.
+     */
+    public function isArchived(): bool;
+
     /**
      * Get hosting service specific properties.
      *

tests/GithubClientTest.php

@@ -70,7 +70,11 @@ public function testUserAndOrgsRepositories(): void
 
         $project = $projectsByName['mborne/satis-gitlab'];
         $defaultBranch = $project->getDefaultBranch();
+
+        /* test getDefaultBranch */
         $this->assertNotNull($defaultBranch);
+
+        /* test getRawFile */
         $composer = $client->getRawFile(
             $project,
             'composer.json',
@@ -88,6 +92,9 @@ public function testUserAndOrgsRepositories(): void
 
         /* test getRawFile not found */
         $this->ensureThatRawFileNotFoundThrowsException($client, $project);
+
+        /* test isArchived */
+        $this->assertFalse($project->isArchived());
     }
 
     /**

tests/GitlabClientTest.php

@@ -62,14 +62,18 @@ 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());
     }
 
     public function testGitlabDotComOrgs(): void
@@ -117,10 +121,13 @@ public function testGitlabDotComSearch(): void
             $projectsByName
         );
 
-        /* test getRawFile */
         $project = $projectsByName['mborne/sample-composer'];
+
+        /* test getDefaultBranch */
         $defaultBranch = $project->getDefaultBranch();
         $this->assertNotNull($defaultBranch);
+
+        /* test getRawFile */
         $composer = $client->getRawFile(
             $project,
             'composer.json',
@@ -130,5 +137,8 @@ public function testGitlabDotComSearch(): void
 
         /* test getRawFile not found */
         $this->ensureThatRawFileNotFoundThrowsException($client, $project);
+
+        /* test isArchived */
+        $this->assertFalse($project->isArchived());
     }
 }

tests/GogsClientTest.php

@@ -111,6 +111,8 @@ public function testFindByUserAndOrgs(): void
             'docker/docker-php-sury',
             $projectsByName
         );
+
+        /* test getRawFile */
         $project = $projectsByName['docker/docker-php-sury'];
         $this->assertStringContainsString(
             'FROM ',
@@ -120,5 +122,8 @@ public function testFindByUserAndOrgs(): void
             'ServerTokens Prod',
             $client->getRawFile($project, 'conf/apache-security.conf', 'master')
         );
+
+        /* test isArchived */
+        $this->assertFalse($project->isArchived());
     }
 }

tests/LocalClientTest.php

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