Refactor logic in multiRespond(), update getComposer() doc block, fix tests

Author: robbieaverill

spec/Packagist/Api/ClientSpec.php

@@ -98,26 +98,42 @@ public function it_gets_package_details(HttpClient $client, Factory $factory, Re
 
     public function it_gets_composer_package_details(HttpClient $client, Factory $factory, Response $response, Stream $body): void
     {
-        $data = file_get_contents('spec/Packagist/Api/Fixture/get_composer.json');
+        $data1 = file_get_contents('spec/Packagist/Api/Fixture/v2_get.json');
+        $data2 = file_get_contents('spec/Packagist/Api/Fixture/v2_get_dev.json');
         $response->getBody()->shouldBeCalled()->willReturn($body);
-        $body->getContents()->shouldBeCalled()->willReturn($data);
+        $body->getContents()->shouldBeCalledTimes(2)->willReturn($data1, $data2);
+
+        $client->request('GET', 'https://packagist.org/p2/sylius/sylius.json')
+            ->shouldBeCalled()
+            ->willReturn($response);
 
         $client->request('GET', 'https://packagist.org/p2/sylius/sylius~dev.json')
             ->shouldBeCalled()
             ->willReturn($response);
 
-        $packages = [
-            '1.0.0' => ['name' => 'sylius/sylius', 'version' => '1.0.0']
+        $data1 = json_decode($data1, true);
+        $data2 = json_decode($data2, true);
+        $factoryInput = $data1;
+        $factoryInput['packages']['sylius/sylius'] = [
+            ...$data1['packages']['sylius/sylius'],
+            ...$data2['packages']['sylius/sylius'],
         ];
 
-        $factory->create(json_decode($data, true))->shouldBeCalled()->willReturn($packages);
+        $factory->create($factoryInput)->shouldBeCalled()->willReturn([
+            'packages' => [
+                'sylius/sylius' => [
+                    ['name' => 'sylius/sylius', 'version' => '1.0.0'],
+                    ['name' => 'sylius/sylius', 'version' => 'dev-master'],
+                ],
+            ],
+        ]);
 
-        $this->getComposer('sylius/sylius')->shouldBe($packages);
+        $this->getComposer('sylius/sylius');
     }
 
     public function it_gets_composer_releases_package_details(HttpClient $client, Factory $factory, Response $response, Stream $body): void
     {
-        $data = file_get_contents('spec/Packagist/Api/Fixture/get_composer_releases.json');
+        $data = file_get_contents('spec/Packagist/Api/Fixture/v2_get.json');
         $response->getBody()->shouldBeCalled()->willReturn($body);
         $body->getContents()->shouldBeCalled()->willReturn($data);
 

spec/Packagist/Api/Fixture/get_composer_releases.json

@@ -40,32 +40,32 @@ public function it_creates_popular_results()
         }
     }
 
-    public function it_creates_packages()
+    public function it_creates_packages(): void
     {
         $data = json_decode(file_get_contents('spec/Packagist/Api/Fixture/get.json'), true);
 
         $this->create($data)->shouldHaveType(Package::class);
     }
 
-    public function it_creates_composer_packages()
+    public function it_creates_composer_packages(): void
     {
         $data = json_decode(file_get_contents('spec/Packagist/Api/Fixture/get_composer.json'), true);
 
         $results = $this->create($data);
         $results->shouldHaveCount(1);
         $results->shouldBeArray();
         foreach ($results as $result) {
-            $result->shouldBeAnInstanceOf('Packagist\Api\Result\Package');
+            $result->shouldBeAnInstanceOf(Package::class);
 
             foreach ($result->getVersions() as $version) {
-                $version->shouldBeAnInstanceOf('Packagist\Api\Result\Version');
+                $version->shouldBeAnInstanceOf(Package\Version::class);
             }
         }
     }
 
     public function it_creates_composer_releases_packages(): void
     {
-        $data = json_decode(file_get_contents('spec/Packagist/Api/Fixture/get_composer_releases.json'), true);
+        $data = json_decode(file_get_contents('spec/Packagist/Api/Fixture/v2_get.json'), true);
 
         $results = $this->create($data);
         $results->shouldHaveCount(1);

spec/Packagist/Api/Fixture/v2_get.json

@@ -99,10 +99,17 @@ public function get(string $package)
     }
 
     /**
-     * @see https://packagist.org/apidoc#get-package-data
-     * Contains tagged releases and dev branches
+     * Similar to {@link get()}, but uses Composer metadata which is Packagist's preferred
+     * way of retrieving details, since responses are cached efficiently as static files
+     * by the Packagist service. The response lacks some metadata that is provided
+     * by {@link get()}, see https://packagist.org/apidoc for details.
+     *
+     * Caution: Returns an array of packages, you need to select the correct one
+     * from the indexed array.
+     *
+     * @since 1.6
      * @param string $package Full qualified name ex : myname/mypackage
-     * @return Package[] An array of packages, including the requested one.
+     * @return array An array of packages, including the requested one, containing releases and dev branch versions
      */
     public function getComposer(string $package): array
     {
@@ -207,7 +214,8 @@ protected function respond(string $url)
     }
 
     /**
-     * Execute two urls request, parse and merge the responses
+     * Execute two URLs request, parse and merge the responses by adding the versions from the second URL
+     * into the versions from the first URL.
      *
      * @param string $url1
      * @param string $url2
@@ -216,19 +224,19 @@ protected function respond(string $url)
     protected function multiRespond(string $url1, string $url2)
     {
         $response1 = $this->request($url1);
-        $response1 = $this->parse((string)$response1);
+        $response1 = $this->parse((string) $response1);
 
         $response2 = $this->request($url2);
-        $response2 = $this->parse((string)$response2);
-
-        foreach ($response1['packages'] as $k1 => $package1) {
-            foreach ($response2['packages'] as $k2 => $package2) {
-                if ($k1 === $k2) {
-                    foreach ($package2 as $version) {
-                        $response1['packages'][$k1][] = $version;
-                    }
-                }
+        $response2 = $this->parse((string) $response2);
+
+        foreach ($response1['packages'] as $name => $package1) {
+            if (empty($response2['packages'][$name])) {
+                continue;
             }
+            $response1['packages'][$name] = [
+                ...$response1['packages'][$name],
+                ...$response2['packages'][$name],
+            ];
         }
 
         return $this->create($response1);