Skip to content

Commit ea68460

Browse files
ybelenkoybelenko
committed
Rename methods to follow latest interface
1 parent dfd0cfc commit ea68460

File tree

4 files changed

+30
-30
lines changed

4 files changed

+30
-30
lines changed

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,9 @@ properties:
104104
type: string
105105
format: date-time
106106
```
107-
> Notice! While schema object presented in YAML format this library doesn't support YAML or JSON parsing right now. It means that `mockFromSchema` method expects already decoded JSON value as argument.
107+
> Notice! While schema object presented in YAML format this library doesn't support YAML or JSON parsing right now. It means that `mockSchemaObject` method expects already decoded JSON value as argument.
108108

109-
When we mock mentioned schema with `mockFromSchema` method:
109+
When we mock mentioned schema with `mockSchemaObject` method:
110110
```php
111111
require __DIR__ . '/vendor/autoload.php';
112112
@@ -118,7 +118,7 @@ $mocker->setModelsNamespace('JohnDoesPackage\\Model\\');
118118
// class InvoiceTest contains schema mentioned previously
119119
// it returns that schema with getOpenApiSchema() method declared in OpenAPIServer\Mock\BaseModel parent class
120120
$schema = \OpenAPIServer\Mock\Model\InvoiceTest::getOpenApiSchema();
121-
$data = $mocker->mockFromSchema($schema);
121+
$data = $mocker->mockSchemaObject($schema);
122122
echo json_encode($data, \JSON_PRETTY_PRINT);
123123
```
124124

‎examples/extended_example.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,5 @@
3636

3737
echo PHP_EOL . PHP_EOL . 'Real world schema' . PHP_EOL ;
3838
$schema = \OpenAPIServer\Mock\Model\InvoiceTest::getOpenApiSchema();
39-
$data = $mocker->mockFromSchema($schema);
39+
$data = $mocker->mockSchemaObject($schema);
4040
echo json_encode($data, \JSON_PRETTY_PRINT);

‎src/Mock/OpenApiDataMocker.php‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class OpenApiDataMocker implements IMocker
4444
*
4545
* @return mixed
4646
*/
47-
public function mock(string $dataType, ?string $dataFormat = null, ?array $options = [])
47+
public function mockData(string $dataType, ?string $dataFormat = null, ?array $options = [])
4848
{
4949
switch ($dataType) {
5050
case IMocker::DATA_TYPE_INTEGER:
@@ -362,7 +362,7 @@ public function mockArray(
362362
$arrSize = ($maxSize < 1) ? $maxSize : max($minSize, 1);
363363
while (count($arr) < $arrSize) {
364364
$data = $this->mockFromRef($ref);
365-
$arr[] = ($data) ? $data : $this->mock($dataType, $dataFormat, $options);
365+
$arr[] = ($data) ? $data : $this->mockData($dataType, $dataFormat, $options);
366366
}
367367
return $arr;
368368
}
@@ -437,30 +437,30 @@ public function mockObject(
437437
$dataFormat = $options['format'] ?? null;
438438
$ref = $options['$ref'] ?? null;
439439
$data = $this->mockFromRef($ref);
440-
$obj->$propName = ($data) ? $data : $this->mock($dataType, $dataFormat, $options);
440+
$obj->$propName = ($data) ? $data : $this->mockData($dataType, $dataFormat, $options);
441441
}
442442

443443
return $obj;
444444
}
445445

446446
/**
447-
* Mocks OpenApi Data from schema.
447+
* Mocks OpenApi Schema Object.
448448
*
449449
* @param array $schema OpenAPI schema.
450450
*
451451
* @throws \InvalidArgumentException When invalid arguments passed.
452452
*
453453
* @return mixed
454454
*/
455-
public function mockFromSchema(array $schema)
455+
public function mockSchemaObject(array $schema)
456456
{
457457
$props = $this->extractSchemaProperties($schema);
458458
if (array_key_exists('$ref', $props) && !empty($props['$ref'])) {
459459
return $this->mockFromRef($props['$ref']);
460460
} elseif ($props['type'] === null) {
461461
throw new InvalidArgumentException('"schema" must be assoc array with "type" property');
462462
}
463-
return $this->mock($props['type'], $props['format'], $props);
463+
return $this->mockData($props['type'], $props['format'], $props);
464464
}
465465

466466
/**
@@ -478,7 +478,7 @@ public function mockFromRef(?string $ref)
478478
if (!method_exists($modelClass, 'getOpenApiSchema')) {
479479
throw new InvalidArgumentException(sprintf('Method %s doesn\'t exist', $modelClass . '::getOpenApiSchema'));
480480
}
481-
return $this->mockFromSchema($modelClass::getOpenApiSchema());
481+
return $this->mockSchemaObject($modelClass::getOpenApiSchema());
482482
}
483483

484484
return null;
@@ -499,7 +499,7 @@ public function mockModelFromRef(?string $ref): ?OpenApiModelInterface
499499
if (in_array(OpenApiModelInterface::class, class_implements($modelClass)) === false) {
500500
throw new InvalidArgumentException(sprintf('Class %s doesn\'t implement ' . OpenApiModelInterface::class, $modelClass));
501501
}
502-
$data = $this->mockFromSchema($modelClass::getOpenApiSchema());
502+
$data = $this->mockSchemaObject($modelClass::getOpenApiSchema());
503503
return $modelClass::createFromData($data);
504504
}
505505

‎test/Mock/OpenApiDataMockerTest.php‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@
2929
class OpenApiDataMockerTest extends TestCase
3030
{
3131
/**
32-
* @covers ::mock
32+
* @covers ::mockData
3333
* @dataProvider provideMockCorrectArguments
3434
*/
3535
public function testMockCorrectArguments($dataType, $dataFormat, $options, $assertMethod)
3636
{
3737
$mocker = new OpenApiDataMocker();
38-
$data = $mocker->mock($dataType, $dataFormat, $options);
38+
$data = $mocker->mockData($dataType, $dataFormat, $options);
3939
$this->$assertMethod($data);
4040
}
4141

@@ -62,15 +62,15 @@ public function provideMockCorrectArguments()
6262
}
6363

6464
/**
65-
* @covers ::mock
65+
* @covers ::mockData
6666
* @dataProvider provideMockInvalidArguments
6767
*/
6868
public function testMockInvalidArguments($dataType, $dataFormat, $options)
6969
{
7070
$this->expectException(InvalidArgumentException::class);
7171
$this->expectExceptionMessage('"dataType" must be one of integer, number, string, boolean, array, object');
7272
$mocker = new OpenApiDataMocker();
73-
$data = $mocker->mock($dataType, $dataFormat, $options);
73+
$data = $mocker->mockData($dataType, $dataFormat, $options);
7474
}
7575

7676
public function provideMockInvalidArguments()
@@ -82,12 +82,12 @@ public function provideMockInvalidArguments()
8282
}
8383

8484
/**
85-
* @covers ::mock
85+
* @covers ::mockData
8686
*/
8787
public function testMockWithStringEnumOptions()
8888
{
8989
$mocker = new OpenApiDataMocker();
90-
$string = $mocker->mock(IMocker::DATA_TYPE_STRING, null, [
90+
$string = $mocker->mockData(IMocker::DATA_TYPE_STRING, null, [
9191
'enum' => ['foobar', 'foobaz', 'helloworld'],
9292
]);
9393
$this->assertContains($string, ['foobar', 'foobaz', 'helloworld']);
@@ -369,7 +369,7 @@ public function provideMockStringInvalidArguments()
369369
}
370370

371371
/**
372-
* @covers ::mock
372+
* @covers ::mockData
373373
* @covers ::mockString
374374
* @dataProvider provideMockStringByteFormatArguments
375375
*/
@@ -380,7 +380,7 @@ public function testMockStringWithByteFormat(
380380
) {
381381
$mocker = new OpenApiDataMocker();
382382
$str = $mocker->mockString($dataFormat, $minLength, $maxLength);
383-
$str2 = $mocker->mock(IMocker::DATA_TYPE_STRING, $dataFormat, ['minLength' => $minLength, 'maxLength' => $maxLength]);
383+
$str2 = $mocker->mockData(IMocker::DATA_TYPE_STRING, $dataFormat, ['minLength' => $minLength, 'maxLength' => $maxLength]);
384384
$base64pattern = '/^[\w\+\/\=]*$/';
385385
if (method_exists($this, 'assertMatchesRegularExpression')) {
386386
$this->assertMatchesRegularExpression($base64pattern, $str);
@@ -413,7 +413,7 @@ public function provideMockStringByteFormatArguments()
413413
}
414414

415415
/**
416-
* @covers ::mock
416+
* @covers ::mockData
417417
* @covers ::mockString
418418
* @dataProvider provideMockStringDateFormatArguments
419419
*/
@@ -425,7 +425,7 @@ public function testMockStringWithDateAndDateTimeFormat(
425425
) {
426426
$mocker = new OpenApiDataMocker();
427427
$str = $mocker->mockString($dataFormat, $minLength, $maxLength);
428-
$str2 = $mocker->mock(IMocker::DATA_TYPE_STRING, $dataFormat, ['minLength' => $minLength, 'maxLength' => $maxLength]);
428+
$str2 = $mocker->mockData(IMocker::DATA_TYPE_STRING, $dataFormat, ['minLength' => $minLength, 'maxLength' => $maxLength]);
429429

430430
if ($dtFormat !== null) {
431431
$date = DateTime::createFromFormat($dtFormat, $str);
@@ -460,7 +460,7 @@ public function provideMockStringDateFormatArguments()
460460
}
461461

462462
/**
463-
* @covers ::mock
463+
* @covers ::mockData
464464
* @covers ::mockString
465465
* @dataProvider provideMockStringBinaryFormatArguments
466466
*/
@@ -471,7 +471,7 @@ public function testMockStringWithBinaryFormat(
471471
) {
472472
$mocker = new OpenApiDataMocker();
473473
$str = $mocker->mockString($dataFormat, $minLength, $maxLength);
474-
$str2 = $mocker->mock(IMocker::DATA_TYPE_STRING, $dataFormat, ['minLength' => $minLength, 'maxLength' => $maxLength]);
474+
$str2 = $mocker->mockData(IMocker::DATA_TYPE_STRING, $dataFormat, ['minLength' => $minLength, 'maxLength' => $maxLength]);
475475
if ($minLength !== null) {
476476
$this->assertGreaterThanOrEqual($minLength, strlen($str));
477477
$this->assertGreaterThanOrEqual($minLength, strlen($str2));
@@ -495,7 +495,7 @@ public function provideMockStringBinaryFormatArguments()
495495
}
496496

497497
/**
498-
* @covers ::mock
498+
* @covers ::mockData
499499
* @covers ::mockString
500500
* @dataProvider provideMockStringUuidFormatArguments
501501
*/
@@ -510,7 +510,7 @@ public function testMockStringWithUuidFormat(
510510

511511
while (count($arr) < 100 && count($arr2) < 100) {
512512
$str = $mocker->mockString(IMocker::DATA_FORMAT_UUID, $minLength, $maxLength);
513-
$str2 = $mocker->mock(IMocker::DATA_TYPE_STRING, IMocker::DATA_FORMAT_UUID, ['minLength' => $minLength, 'maxLength' => $maxLength]);
513+
$str2 = $mocker->mockData(IMocker::DATA_TYPE_STRING, IMocker::DATA_FORMAT_UUID, ['minLength' => $minLength, 'maxLength' => $maxLength]);
514514
$arr[] = $str;
515515
$arr2[] = $str2;
516516

@@ -969,13 +969,13 @@ public function testMockObjectWithReferencedProps()
969969

970970
/**
971971
* @dataProvider provideMockFromSchemaCorrectArguments
972-
* @covers ::mockFromSchema
972+
* @covers ::mockSchemaObject
973973
*/
974974
public function testMockFromSchemaWithCorrectArguments($schema, $assertMethod)
975975
{
976976
$mocker = new OpenApiDataMocker();
977977
$mocker->setModelsNamespace('OpenAPIServer\\Mock\\Model\\');
978-
$data = $mocker->mockFromSchema($schema);
978+
$data = $mocker->mockSchemaObject($schema);
979979
$this->$assertMethod($data);
980980
}
981981

@@ -1025,13 +1025,13 @@ public function provideMockFromSchemaCorrectArguments()
10251025

10261026
/**
10271027
* @dataProvider provideMockFromSchemaInvalidArguments
1028-
* @covers ::mockFromSchema
1028+
* @covers ::mockSchemaObject
10291029
*/
10301030
public function testMockFromSchemaWithInvalidArguments($schema)
10311031
{
10321032
$this->expectException(InvalidArgumentException::class);
10331033
$mocker = new OpenApiDataMocker();
1034-
$data = $mocker->mockFromSchema($schema);
1034+
$data = $mocker->mockSchemaObject($schema);
10351035
}
10361036

10371037

0 commit comments

Comments
 (0)