Set status code for transformer response from tag if present

Author: shalvah

src/Strategies/Responses/ResponseCalls.php

@@ -43,7 +43,8 @@ public function __invoke(Route $route, \ReflectionClass $controller, \Reflection
         $request = $this->prepareRequest($route, $rulesToApply, $bodyParameters, $queryParameters);
 
         try {
-            $response = [200 => $this->makeApiCall($request)->getContent()];
+            $response = $this->makeApiCall($request);
+            $response = [$response->getStatusCode() => $response->getContent()];
         } catch (\Exception $e) {
             echo 'Exception thrown during response call for ['.implode(',', $route->methods)."] {$route->uri}.\n";
             if (Flags::$shouldBeVerbose) {

src/Strategies/Responses/UseTransformerTags.php

@@ -54,7 +54,7 @@ protected function getTransformerResponse(array $tags)
                 return null;
             }
 
-            $transformer = $this->getTransformerClass($transformerTag);
+            list($statusCode, $transformer) = $this->getStatusCodeAmdTransformerClass($transformerTag);
             $model = $this->getClassToBeTransformed($tags, (new ReflectionClass($transformer))->getMethod('transform'));
             $modelInstance = $this->instantiateTransformerModel($model);
 
@@ -68,7 +68,7 @@ protected function getTransformerResponse(array $tags)
                 ? new Collection([$modelInstance, $modelInstance], new $transformer)
                 : new Item($modelInstance, new $transformer);
 
-            return [200 => response($fractal->createData($resource)->toJson())->getContent()];
+            return [$statusCode => response($fractal->createData($resource)->toJson())->getContent()];
         } catch (\Exception $e) {
             return null;
         }
@@ -77,11 +77,16 @@ protected function getTransformerResponse(array $tags)
     /**
      * @param Tag $tag
      *
-     * @return string|null
+     * @return array
      */
-    private function getTransformerClass($tag)
+    private function getStatusCodeAmdTransformerClass($tag): array
     {
-        return $tag->getContent();
+        $content = $tag->getContent();
+        preg_match('/^(\d{3})?\s?([\s\S]*)$/', $content, $result);
+        $status = $result[1] ?: 200;
+        $transformerClass = $result[2];
+
+        return [$status, $transformerClass];
     }
 
     /**

tests/Fixtures/TestController.php

@@ -251,6 +251,14 @@ public function transformerTag()
         return '';
     }
 
+    /**
+     * @transformer 201 \Mpociot\ApiDoc\Tests\Fixtures\TestTransformer
+     */
+    public function transformerTagWithStatusCode()
+    {
+        return '';
+    }
+
     /**
      * @transformer \Mpociot\ApiDoc\Tests\Fixtures\TestTransformer
      * @transformermodel \Mpociot\ApiDoc\Tests\Fixtures\TestModel

tests/Unit/GeneratorTestCase.php

@@ -435,8 +435,26 @@ public function can_parse_transformer_tag_with_model()
         $this->assertTrue(is_array($response));
         $this->assertEquals(200, $response['status']);
         $this->assertSame(
-            $response['content'],
-            '{"data":{"id":1,"description":"Welcome on this test versions","name":"TestName"}}'
+            '{"data":{"id":1,"description":"Welcome on this test versions","name":"TestName"}}',
+            $response['content']
+        );
+    }
+
+    /** @test */
+    public function can_parse_transformer_tag_with_status_code()
+    {
+        $route = $this->createRoute('GET', '/transformerTagWithStatusCode', 'transformerTagWithStatusCode');
+        $parsed = $this->generator->processRoute($route);
+        $response = Arr::first($parsed['response']);
+
+        $this->assertTrue(is_array($parsed));
+        $this->assertArrayHasKey('showresponse', $parsed);
+        $this->assertTrue($parsed['showresponse']);
+        $this->assertTrue(is_array($response));
+        $this->assertEquals(201, $response['status']);
+        $this->assertSame(
+            '{"data":{"id":1,"description":"Welcome on this test versions","name":"TestName"}}',
+            $response['content']
         );
     }