Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 3 additions & 12 deletions docs/processors.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,11 +175,6 @@ DefaultProcessor::fromFiltersAndValidators(...$chain)
|-----------|---------------------|
| ...$chain | Filter or Validator |

## OpenAPI Processors

The following processors are intended for Open-API specific use cases.
Alternative uses are not recommended.

### AllOf

Designed specifically to deal with the 'allOf' keyword of OpenAPI:
Expand Down Expand Up @@ -213,14 +208,10 @@ Designed specifically to deal with the 'oneOf' keyword of OpenAPI:
The OneOf processor takes a chain of processors (one for each schema within the 'oneOf') and makes sure that one and
only one processor returns a valid result.

### Json

| Parameter | Type |
|-----------|-----------|
| $wrapped | Processor |
## OpenAPI Processors

Designed specifically to wrap a processor that is expecting a json object. The Json processor attempts to decode a
string into a json object before passing it into the wrapped processor.
The following processors are intended for Open-API specific use cases.
Alternative uses are not recommended.

### Request

Expand Down
6 changes: 3 additions & 3 deletions src/OpenAPI/Builder/APIBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@

use Membrane\Builder\Builder;
use Membrane\OpenAPI;
use Membrane\OpenAPI\Processor\AllOf;
use Membrane\OpenAPI\Processor\AnyOf;
use Membrane\OpenAPI\Processor\OneOf;
use Membrane\OpenAPIReader\ValueObject\Valid\{Enum\Type, V30, V31};
use Membrane\Processor;
use Membrane\Processor\AllOf;
use Membrane\Processor\AnyOf;
use Membrane\Processor\Field;
use Membrane\Processor\OneOf;
use Membrane\Validator\Type\IsNull;
use Membrane\Validator\Utility;

Expand Down
51 changes: 2 additions & 49 deletions src/OpenAPI/Processor/AllOf.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,54 +4,7 @@

namespace Membrane\OpenAPI\Processor;

use Membrane\Exception\InvalidProcessorArguments;
use Membrane\Processor;
use Membrane\Result\FieldName;
use Membrane\Result\Result;

class AllOf implements Processor
/** @deprecated Use \Membrane\Processor\AllOf instead */
final class AllOf extends \Membrane\Processor\AllOf
{
/** @var Processor[] */
public array $processors;

public function __construct(private readonly string $processes, Processor ...$processors)
{
if (count($processors) < 2) {
throw InvalidProcessorArguments::redundantProcessor(AllOf::class);
}
$this->processors = $processors;
}

public function __toString(): string
{
return "All of the following:\n\t" .
implode(".\n\t", array_map(fn($p) => preg_replace("#\n#m", "\n\t", (string)$p), $this->processors)) . '.';
}

public function __toPHP(): string
{
return sprintf(
'new %s("%s"%s)',
self::class,
$this->processes(),
implode('', array_map(fn($p) => ', ' . $p->__toPHP(), $this->processors))
);
}

public function processes(): string
{
return $this->processes;
}

public function process(FieldName $parentFieldName, mixed $value): Result
{
$result = Result::noResult($value);

foreach ($this->processors as $processor) {
$itemResult = $processor->process($parentFieldName, $value);
$result = $result->merge($itemResult);
}

return $result;
}
}
67 changes: 2 additions & 65 deletions src/OpenAPI/Processor/AnyOf.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,70 +4,7 @@

namespace Membrane\OpenAPI\Processor;

use Membrane\Exception\InvalidProcessorArguments;
use Membrane\Processor;
use Membrane\Result\FieldName;
use Membrane\Result\Result;

class AnyOf implements Processor
/** @deprecated Use \Membrane\Processor\AnyOf instead */
final class AnyOf extends \Membrane\Processor\AnyOf
{
/** @var Processor[] */
public array $processors;

public function __construct(private readonly string $processes, Processor ...$processors)
{
if (count($processors) < 2) {
throw InvalidProcessorArguments::redundantProcessor(AnyOf::class);
}
$this->processors = $processors;
}

public function __toPHP(): string
{
return sprintf(
'new %s("%s"%s)',
self::class,
$this->processes(),
implode('', array_map(fn($p) => ', ' . $p->__toPHP(), $this->processors))
);
}

public function __toString(): string
{
return "Any of the following:\n\t" .
implode(".\n\t", array_map(fn($p) => preg_replace("#\n#m", "\n\t", (string)$p), $this->processors)) . '.';
}

public function processes(): string
{
return $this->processes;
}

public function process(FieldName $parentFieldName, mixed $value): Result
{
$results = [];
$messageSets = [];

foreach ($this->processors as $fieldSet) {
$itemResult = $fieldSet->process($parentFieldName, $value);

if ($itemResult->result === Result::VALID) {
return $itemResult;
}

if ($itemResult->result === Result::INVALID) {
$messageSets [] = $itemResult->messageSets[0];
}

$results [] = $itemResult->result;
}

$result = in_array(Result::INVALID, $results) ? Result::INVALID : Result::NO_RESULT;

return new Result(
$value,
$result,
...($result === Result::INVALID ? $messageSets : [])
);
}
}
78 changes: 2 additions & 76 deletions src/OpenAPI/Processor/OneOf.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,81 +4,7 @@

namespace Membrane\OpenAPI\Processor;

use Membrane\Exception\InvalidProcessorArguments;
use Membrane\Processor;
use Membrane\Result\FieldName;
use Membrane\Result\Message;
use Membrane\Result\MessageSet;
use Membrane\Result\Result;

class OneOf implements Processor
/** @deprecated Use \Membrane\Processor\OneOf instead */
final class OneOf extends \Membrane\Processor\OneOf
{
/** @var Processor[] */
public array $processors;

public function __construct(private readonly string $processes, Processor ...$processors)
{
if (count($processors) < 2) {
throw InvalidProcessorArguments::redundantProcessor(OneOf::class);
}
$this->processors = $processors;
}

public function __toPHP(): string
{
return sprintf(
'new %s("%s"%s)',
self::class,
$this->processes(),
implode('', array_map(fn($p) => ', ' . $p->__toPHP(), $this->processors))
);
}

public function __toString(): string
{
return "One of the following:\n\t" .
implode(".\n\t", array_map(fn($p) => preg_replace("#\n#m", "\n\t", (string)$p), $this->processors)) . '.';
}

public function processes(): string
{
return $this->processes;
}

public function process(FieldName $parentFieldName, mixed $value): Result
{
$results = array_map(
fn($p) => $p->process($parentFieldName, $value),
$this->processors
);

if ($this->hasExactlyOneValidResult($results)) {
return Result::valid($value);
}

$messageSets = [
new MessageSet(
$parentFieldName,
new Message('one and only one schema must pass', [])
),
];

foreach ($results as $result) {
if (!$result->isValid()) {
foreach ($result->messageSets as $messageSet) {
if (!$messageSet->isEmpty()) {
$messageSets[] = $messageSet;
}
}
}
}

return Result::invalid($value, ...$messageSets);
}

/** @param Result[] $results */
private function hasExactlyOneValidResult(array $results): bool
{
return count(array_filter($results, fn($r) => $r->isValid())) === 1;
}
}
57 changes: 57 additions & 0 deletions src/Processor/AllOf.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<?php

declare(strict_types=1);

namespace Membrane\Processor;

use Membrane\Exception\InvalidProcessorArguments;
use Membrane\Processor;
use Membrane\Result\FieldName;
use Membrane\Result\Result;

class AllOf implements Processor
{
/** @var Processor[] */
public array $processors;

public function __construct(private readonly string $processes, Processor ...$processors)
{
if (count($processors) < 2) {
throw InvalidProcessorArguments::redundantProcessor(AllOf::class);
}
$this->processors = $processors;
}

public function __toString(): string
{
return "All of the following:\n\t" .
implode(".\n\t", array_map(fn($p) => preg_replace("#\n#m", "\n\t", (string)$p), $this->processors)) . '.';
}

public function __toPHP(): string
{
return sprintf(
'new %s("%s"%s)',
self::class,
$this->processes(),
implode('', array_map(fn($p) => ', ' . $p->__toPHP(), $this->processors))
);
}

public function processes(): string
{
return $this->processes;
}

public function process(FieldName $parentFieldName, mixed $value): Result
{
$result = Result::noResult($value);

foreach ($this->processors as $processor) {
$itemResult = $processor->process($parentFieldName, $value);
$result = $result->merge($itemResult);
}

return $result;
}
}
73 changes: 73 additions & 0 deletions src/Processor/AnyOf.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<?php

declare(strict_types=1);

namespace Membrane\Processor;

use Membrane\Exception\InvalidProcessorArguments;
use Membrane\Processor;
use Membrane\Result\FieldName;
use Membrane\Result\Result;

class AnyOf implements Processor
{
/** @var Processor[] */
public array $processors;

public function __construct(private readonly string $processes, Processor ...$processors)
{
if (count($processors) < 2) {
throw InvalidProcessorArguments::redundantProcessor(AnyOf::class);
}
$this->processors = $processors;
}

public function __toPHP(): string
{
return sprintf(
'new %s("%s"%s)',
self::class,
$this->processes(),
implode('', array_map(fn($p) => ', ' . $p->__toPHP(), $this->processors))
);
}

public function __toString(): string
{
return "Any of the following:\n\t" .
implode(".\n\t", array_map(fn($p) => preg_replace("#\n#m", "\n\t", (string)$p), $this->processors)) . '.';
}

public function processes(): string
{
return $this->processes;
}

public function process(FieldName $parentFieldName, mixed $value): Result
{
$results = [];
$messageSets = [];

foreach ($this->processors as $fieldSet) {
$itemResult = $fieldSet->process($parentFieldName, $value);

if ($itemResult->result === Result::VALID) {
return $itemResult;
}

if ($itemResult->result === Result::INVALID) {
$messageSets [] = $itemResult->messageSets[0];
}

$results [] = $itemResult->result;
}

$result = in_array(Result::INVALID, $results) ? Result::INVALID : Result::NO_RESULT;

return new Result(
$value,
$result,
...($result === Result::INVALID ? $messageSets : [])
);
}
}
Loading