Skip to content

Add: generate servers.description & servers.variables #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 7, 2021
Merged

Add: generate servers.description & servers.variables #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1855fb2
add: generate server.description & server.variables
sun-yryr Apr 30, 2021
cb474fa
add: test for ServerBuilder
sun-yryr Apr 30, 2021
7ba9fd7
update: config for servers
sun-yryr Apr 30, 2021
a15a2de
fix: styleci
sun-yryr Apr 30, 2021
8332df0
refactor: rename variable & delete dev log
sun-yryr May 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions config/openapi.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
'servers' => [
[
'url' => env('APP_URL'),
'description' => null,
'variables' => [],
],
],

Expand Down
22 changes: 21 additions & 1 deletion src/Builders/ServersBuilder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
namespace Vyuldashev\LaravelOpenApi\Builders;

use GoldSpecDigital\ObjectOrientedOAS\Objects\Server;
use GoldSpecDigital\ObjectOrientedOAS\Objects\ServerVariable;
use Illuminate\Support\Arr;

class ServersBuilder
{
Expand All @@ -13,7 +15,25 @@ class ServersBuilder
public function build(array $config): array
{
return collect($config)
->map(static fn(array $server) => Server::create()->url($server['url']))
->map(static function (array $server) {
$variables = collect(Arr::get($server, 'variables'))
->map(function (array $variable, string $key) {
$serverVariable = ServerVariable::create($key)
->default(Arr::get($variable, 'default'))
->description(Arr::get($variable, 'description'));
if (is_array(Arr::get($variable, 'enum'))) {
return $serverVariable->enum(...Arr::get($variable, 'enum'));
}

return $serverVariable;
})
->toArray();

return Server::create()
->url(Arr::get($server, 'url'))
->description(Arr::get($server, 'description'))
->variables(...$variables);
})
->toArray();
}
}
148 changes: 148 additions & 0 deletions tests/Builders/ServersBuilderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
<?php

declare(strict_types=1);

namespace Vyuldashev\LaravelOpenApi\Tests\Builders;

use Vyuldashev\LaravelOpenApi\Builders\ServersBuilder;
use Vyuldashev\LaravelOpenApi\Tests\TestCase;

class ServersBuilderTest extends TestCase
{
/**
* @dataProvider providerBuild
* @param array $config
* @param array $expected
* @return void
*/
public function testBuild(array $config, array $expected): void
{
$SUT = new ServersBuilder();
$servers = $SUT->build($config);
$this->assertSameAssociativeArray($expected[0], $servers[0]->toArray());
}

public function providerBuild(): array
{
return [
'If the variables field does not exist, it is possible to output the correct json.' => [
[[
'url' => 'http://example.com',
'description' => 'sample_description',
'variables' => [],
]],
[[
'url' => 'http://example.com',
'description' => 'sample_description',
]],
],
'If the variables field is present, it can output the correct json.' => [
[[
'url' => 'http://example.com',
'description' => 'sample_description',
'variables' => [
'variable_name' => [
'default' => 'variable_defalut',
'description' => 'variable_description',
],
],
]],
[[
'url' => 'http://example.com',
'description' => 'sample_description',
'variables' => [
'variable_name' => [
'default' => 'variable_defalut',
'description' => 'variable_description',
],
],
]],
],
'If there is a variables field containing enum, it can output the correct json.' => [
[[
'url' => 'http://example.com',
'description' => 'sample_description',
'variables' => [
'variable_name' => [
'default' => 'variable_defalut',
'description' => 'variable_description',
'enum' => [
'A',
'B',
'C',
],
],
],
]],
[[
'url' => 'http://example.com',
'description' => 'sample_description',
'variables' => [
'variable_name' => [
'default' => 'variable_defalut',
'description' => 'variable_description',
'enum' => [
'A',
'B',
'C',
],
],
],
]],
],
'If there are variables fields in multiple formats, it is possible to output the correct json.' => [
[[
'url' => 'http://example.com',
'description' => 'sample_description',
'variables' => [
'variable_name' => [
'default' => 'variable_defalut',
'description' => 'variable_description',
'enum' => ['A', 'B'],
],
'variable_name_B' => [
'default' => 'sample',
'description' => 'sample',
],
],
]],
[[
'url' => 'http://example.com',
'description' => 'sample_description',
'variables' => [
'variable_name' => [
'default' => 'variable_defalut',
'description' => 'variable_description',
'enum' => ['A', 'B'],
],
'variable_name_B' => [
'default' => 'sample',
'description' => 'sample',
],
],
]],
],
];
}

/**
* Assert equality as an associative array.
*
* @param array $expected
* @param array $actual
* @return void
*/
protected function assertSameAssociativeArray(array $expected, array $actual): void
{
foreach ($expected as $key => $value) {
if (is_array($value)) {
$this->assertSameAssociativeArray($value, $actual[$key]);
unset($actual[$key]);
continue;
}
self::assertSame($value, $actual[$key]);
unset($actual[$key]);
}
self::assertCount(0, $actual, sprintf('[%s] does not matched keys.', join(', ', array_keys($actual))));
}
}