clean install

This commit is contained in:
2024-12-10 15:08:16 +01:00
commit e14eb2d8fd
31193 changed files with 3555714 additions and 0 deletions

4
vendor/e0ipso/shaper/.gitignore vendored Normal file
View File

@@ -0,0 +1,4 @@
/vendor/
/composer.lock
/build
.phpunit.result.cache

15
vendor/e0ipso/shaper/.travis.yml vendored Normal file
View File

@@ -0,0 +1,15 @@
language: php
php:
- 7.4
- 8.0
before_script:
- mkdir -p build/logs
- composer install --no-interaction
- echo "xdebug.mode = coverage" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
script:
- php vendor/bin/phpunit
after_success:
- travis_retry php vendor/bin/php-coveralls -v

339
vendor/e0ipso/shaper/LICENSE vendored Normal file
View File

@@ -0,0 +1,339 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.

124
vendor/e0ipso/shaper/README.md vendored Normal file
View File

@@ -0,0 +1,124 @@
[![Coverage Status](https://coveralls.io/repos/e0ipso/shaper/badge.svg?branch=master&service=github)](https://coveralls.io/github/e0ipso/shaper?branch=master) [![Build Status](https://travis-ci.org/e0ipso/shaper.svg?branch=master)](https://travis-ci.org/e0ipso/shaper)
# Shaper
Shaper is a simple library that enables type safe data transformations. You can either have simple
transformations or queued transformations.
## One-way Transformations
One way transformations are useful when data only flows in one direction. An example of this is a
read-only HTTP API that based on the contents of one property in the output will make a request to
an external service to include extra data in the original response.
### Simple Transformations
Performs a single operation to transform the data in a type safe manner.
```php
use JsonSchema\Validator;
use Shaper\Transformation\TransformationBase;
use Shaper\Util\Context;
use Shaper\Validator\JsonSchemaValidator;
class NumberToArray extends TransformationBase {
public function getInputValidator() {
return new JsonSchemaValidator(['type' => 'number'], new Validator());
}
public function getOutputValidator() {
$schema = ['type' => 'array', 'items' => ['type' => 'number']];
return new JsonSchemaValidator($schema, new Validator());
}
protected function doTransform($data, Context $context) {
return [$context['keyName'] => $data];
}
}
$t = new NumberToArray();
$t->transform(42, new Context(['keyName' => 'data'])); // ['data' => 42]
$t->transform(['foo']); // TypeError exception.
```
### Queued Transformations
Performs a set of operations, one after the other in a type safe manner.
```php
use JsonSchema\Validator;
use Shaper\Transformation\TransformationBase;
use Shaper\Util\Context;
use Shaper\Validator\InstanceofValidator;
use Shaper\Validator\JsonSchemaValidator;
use Shaper\Transformation\TransformationsQueue;
class ObjectToNumber extends TransformationBase {
public function getInputValidator() {
return new InstanceofValidator(\stdClass::class);
}
public function getOutputValidator() {
$schema = ['type' => 'number'];
return new JsonSchemaValidator($schema, new Validator());
}
protected function doTransform($data, Context $context) {
return isset($data->value) ? $data->value : 0;
}
}
$t = new TransformationsQueue();
$t->add(new ObjectToNumber());
$t->add(new NumberToArray());
$input = new \stdClass();
$input->value = 42;
$t->transform($input, new Context(['keyName' => 'data'])); // ['data' => 42]
```
## Two-way Transformations (aka Data Adaptor)
Data adaptors, or reversible transformations, are useful when the data can flow in both directions.
An example of this is an HTTP API that exposes an internal storage. However the internal storage
format is not the format that the API wants to expose. For that data coming in needs to be
transformed into the internal storage format, and data coming out needs to be transformed into the
shape we want to expose to the outside world via our API.
```php
use JsonSchema\Validator;
use Shaper\DataAdaptor\DataAdaptorBase;
use Shaper\Util\Context;
use Shaper\Validator\InstanceofValidator;
use Shaper\Validator\JsonSchemaValidator;
class MyDataAdaptor extends DataAdaptorBase {
protected function doTransform($data, Context $context) {
return $data->{$context['keyName']};
}
protected function doUndoTransform($data, Context $context) {
return (object) [$context['keyName'] => $data, 'bar' => 'default'];
}
public function getInputValidator() {
// In a real world scenario we would describe this as a JSON Schema.
return new InstanceofValidator(\stdClass::class);
}
public function getInternalValidator() {
// In a real world this would be your internal data object. Something like cheking that this is
// an object of class FieldItemInstance.
return new JsonSchemaValidator(['type' => 'string'], new Validator());
}
public function getOutputValidator() {
// In a real world scenario we would describe this as a JSON Schema. In most cases the output
// validator is the same as the input validator, so you can return the input validator here.
return new InstanceofValidator(\stdClass::class);
}
}
$da = new MyDataAdaptor();
$data = new \stdClass();
$data->lorem = 'caramba!';
$da->transform($data, new Context(['keyName' => 'lorem'])); // 'caramba!'
$da->transform(new NodeObject()); // TypeError exception.
$da->undoTransform('caramba!', new Context(['keyName' => 'lorem'])); // (object) ['lorem' => 'caramba!', 'bar' => 'default']
$da->undoTransform([]); // TypeError exception.
```
## Class Diagram
![Class Diagram](./shaper.png)

27
vendor/e0ipso/shaper/composer.json vendored Normal file
View File

@@ -0,0 +1,27 @@
{
"name": "e0ipso/shaper",
"description": "Lightweight library to handle in and out transformations in PHP.",
"type": "library",
"license": "GPL-2.0",
"authors": [
{
"name": "Mateu Aguiló Bosch",
"email": "mateu.aguilo.bosch@gmail.com"
}
],
"minimum-stability": "dev",
"autoload": {
"psr-4": {
"Shaper\\": "src",
"Shaper\\Tests\\": "tests/src"
}
},
"require": {
"justinrainbow/json-schema": "^5.2"
},
"require-dev": {
"phpunit/phpunit": "^9.5",
"phpunit/phpcov": "^8.2",
"php-coveralls/php-coveralls": "^2.4"
}
}

20
vendor/e0ipso/shaper/phpunit.xml vendored Normal file
View File

@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.2/phpunit.xsd"
bootstrap="vendor/autoload.php"
backupGlobals="false"
verbose="true">
<testsuite name="Shaper">
<directory suffix="Test.php">tests</directory>
</testsuite>
<filter>
<whitelist processUncoveredFilesFromWhitelist="true">
<directory suffix=".php">src</directory>
</whitelist>
</filter>
<logging>
<log type="coverage-clover" target="build/logs/clover.xml"/>
</logging>
</phpunit>

BIN
vendor/e0ipso/shaper/shaper.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 175 KiB

View File

@@ -0,0 +1,20 @@
<?php
namespace Shaper\DataAdaptor;
use Shaper\Transformation\TransformationInterface;
/**
* Transformation pair that can act as an adaptor between systems.
*
* Makes sure that data leaving A transforms into format B, and data arriving
* from B complies with the format requirements of A.
*
* @package Shaper
*/
abstract class DataAdaptorBase implements TransformationInterface, ReversibleTransformationInterface, ReversibleTransformationValidationInterface {
use DataAdaptorValidatorTrait;
use DataAdaptorTransformerTrait;
}

View File

@@ -0,0 +1,107 @@
<?php
namespace Shaper\DataAdaptor;
use Shaper\Util\Context;
trait DataAdaptorTransformerTrait {
/**
* {@inheritdoc}
*/
public function transform($data, ?Context $context = NULL) {
if (!isset($context)) {
$context = new Context();
}
if (!$this->conformsToExpectedInputShape($data, $context)) {
/** @var \Shaper\Validator\ValidateableInterface $validator */
$validator = $this->getInputValidator();
$message = sprintf(
'Adaptor %s received invalid input data: %s',
__CLASS__,
json_encode($validator->getErrors(), JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT)
);
throw new \TypeError($message);
}
$output = $this->doTransform($data, $context);
if (!$this->conformsToInternalShape($output, $context)) {
/** @var \Shaper\Validator\ValidateableInterface $validator */
$validator = $this->getInternalValidator();
$message = sprintf(
'Adaptor %s returned invalid output data: %s',
__CLASS__,
json_encode($validator->getErrors(), JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT)
);
throw new \TypeError($message);
}
return $output;
}
/**
* {@inheritdoc}
*/
public function undoTransform($data, ?Context $context = NULL) {
if (!isset($context)) {
$context = new Context();
}
if (!$this->conformsToInternalShape($data, $context)) {
/** @var \Shaper\Validator\ValidateableInterface $validator */
$validator = $this->getInternalValidator();
$message = sprintf(
'Adaptor %s received invalid input data: %s',
__CLASS__,
json_encode($validator->getErrors(), JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT)
);
throw new \TypeError($message);
}
$output = $this->doUndoTransform($data, $context);
if (!$this->conformsToOutputShape($output, $context)) {
/** @var \Shaper\Validator\ValidateableInterface $validator */
$validator = $this->getOutputValidator();
$message = sprintf(
'Adaptor %s returned invalid output data: %s',
__CLASS__,
json_encode($validator->getErrors(), JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT)
);
throw new \TypeError($message);
}
return $output;
}
/**
* Transforms incoming data into another shape.
*
* This method will validate data coming in and going out using validators.
*
* @param mixed $data
* The data to transform.
* @param \Shaper\Util\Context $context
* Additional information that will affect how the data is transformed.
*
* @return mixed
* The data in the new shape.
*
* @throws \TypeError
* When the transformation cannot be applied.
*/
abstract protected function doTransform($data, Context $context);
/**
* Transforms outgoing data into another shape.
*
* This method will validate data coming in and going out using validators.
*
* @param mixed $data
* The data to transform.
* @param \Shaper\Util\Context $context
* Additional information that will affect how the data is transformed.
*
* @return mixed
* The data in the new shape.
*
* @throws \TypeError
* When the transformation cannot be applied.
*/
abstract protected function doUndoTransform($data, Context $context);
}

View File

@@ -0,0 +1,19 @@
<?php
namespace Shaper\DataAdaptor;
use Shaper\Transformation\TransformationValidationTrait;
use Shaper\Util\Context;
trait DataAdaptorValidatorTrait {
use TransformationValidationTrait;
/**
* {@inheritdoc}
*/
public function conformsToInternalShape($data, ?Context $context = NULL) {
return $this->getInternalValidator()->isValid($data);
}
}

View File

@@ -0,0 +1,28 @@
<?php
namespace Shaper\DataAdaptor;
use Shaper\Util\Context;
interface ReversibleTransformationInterface {
/**
* Basic transformation revert from a shape into another shape.
*
* This method will validate data coming in and going out using validators.
*
* @param mixed $data
* The data to transform.
*
* @param \Shaper\Util\Context $context
* Additional information that will affect how the data is transformed.
*
* @return mixed
* The data in the new shape.
*
* @throws \TypeError
* When the transformation cannot be applied.
*/
public function undoTransform($data, ?Context $context = NULL);
}

View File

@@ -0,0 +1,30 @@
<?php
namespace Shaper\DataAdaptor;
use Shaper\Transformation\TransformationValidationInterface;
use Shaper\Util\Context;
interface ReversibleTransformationValidationInterface extends TransformationValidationInterface {
/**
* Checks if the shape of the transformed data is valid for internal use.
*
* @param mixed $data
* The data in the internal format.
* @param \Shaper\Util\Context $context
* Additional information that will affect how the data is transformed.
*
* @return bool
* TRUE if the format is valid.
*/
public function conformsToInternalShape($data, ?Context $context = NULL);
/**
* The validator for the internal data.
*
* @return \Shaper\Validator\ValidateableInterface
*/
public function getInternalValidator();
}

View File

@@ -0,0 +1,15 @@
<?php
namespace Shaper\Transformation;
/**
* Base implementation for transformation classes.
*
* @package Shaper
*/
abstract class TransformationBase implements TransformationInterface, TransformationValidationInterface {
use TransformationValidationTrait;
use TransformationTransformerTrait;
}

View File

@@ -0,0 +1,33 @@
<?php
namespace Shaper\Transformation;
use Shaper\Util\Context;
/**
* Interface for transformation classes.
*
* @package Shaper
*/
interface TransformationInterface {
/**
* Basic transformation from a shape into another shape.
*
* This method will validate data coming in and going out using validators.
*
* @param mixed $data
* The data to transform.
*
* @param \Shaper\Util\Context $context
* Additional information that will affect how the data is transformed.
*
* @return mixed
* The data in the new shape.
*
* @throws \TypeError
* When the transformation cannot be applied.
*/
public function transform($data, ?Context $context = NULL);
}

View File

@@ -0,0 +1,60 @@
<?php
namespace Shaper\Transformation;
use Shaper\Util\Context;
trait TransformationTransformerTrait {
/**
* {@inheritdoc}
*/
public function transform($data, ?Context $context = NULL) {
if (!isset($context)) {
$context = new Context();
}
// Error utility.
$throw = function($message, $arguments = []) {
/** @var \Shaper\Validator\ValidateableInterface $validator */
$validator = $this->getInputValidator();
$options = JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT;
throw new \TypeError(strtr($message, $arguments + [
'{class}' => static::class,
'{data}' => json_encode($validator->getErrors(), $options)
]));
};
if (!$this->conformsToExpectedInputShape($data, $context)) {
$throw('Adaptor {class} received invalid input data: {data}.');
}
$output = $this->doTransform($data, $context);
if (!$this->conformsToOutputShape($output, $context)) {
$throw('Adaptor {class} returned invalid output data: {data}');
}
return $output;
}
/**
* Basic transformation from a shape into another shape.
*
* This method does not include validations since they are handled in the
* calling method.
*
* @param mixed $data
* The data to transform.
* @param \Shaper\Util\Context $context
* Additional information that will affect how the data is transformed.
*
* @return mixed
* The data in the new shape.
*
* @throws \TypeError
* When the transformation cannot be applied.
*/
abstract protected function doTransform($data, Context $context);
}

View File

@@ -0,0 +1,49 @@
<?php
namespace Shaper\Transformation;
use Shaper\Util\Context;
interface TransformationValidationInterface {
/**
* Checks if the data provided can be transformed by the validator.
*
* @param mixed $data
* The data to check.
* @param \Shaper\Util\Context $context
* Additional information that will affect applicability.
*
* @return bool
* TRUE if the transformation can be used with the supplied data.
*/
public function conformsToExpectedInputShape($data, ?Context $context = NULL);
/**
* Checks if the transformed data conforms to the expected shape.
*
* @param mixed $data
* The data to check.
* @param \Shaper\Util\Context $context
* Additional information that will affect applicability.
*
* @return bool
* TRUE if the transformed data conforms to the expected shape.
*/
public function conformsToOutputShape($data, ?Context $context = NULL);
/**
* The validator for the input data.
*
* @return \Shaper\Validator\ValidateableInterface
*/
public function getInputValidator();
/**
* The validator for the output data.
*
* @return \Shaper\Validator\ValidateableInterface
*/
public function getOutputValidator();
}

View File

@@ -0,0 +1,23 @@
<?php
namespace Shaper\Transformation;
use Shaper\Util\Context;
trait TransformationValidationTrait {
/**
* {@inheritdoc}
*/
public function conformsToExpectedInputShape($data, ?Context $context = NULL) {
return $this->getInputValidator()->isValid($data);
}
/**
* {@inheritdoc}
*/
public function conformsToOutputShape($data, ?Context $context = NULL) {
return $this->getOutputValidator()->isValid($data);
}
}

View File

@@ -0,0 +1,43 @@
<?php
namespace Shaper\Transformation;
use Shaper\Util\Context;
class TransformationsQueue extends \SplQueue implements TransformationInterface, TransformationValidationInterface {
use TransformationValidationTrait;
/**
* {@inheritdoc}
*/
public function transform($data, ?Context $context = NULL) {
if (!isset($context)) {
$context = new Context();
}
$output = $data;
foreach ($this as $transformation) {
$output = $transformation->transform($output, $context);
}
return $output;
}
/**
* {@inheritdoc}
*/
public function getInputValidator() {
/** @var \Shaper\Transformation\TransformationValidationInterface $first_transformation */
$first_transformation = $this->bottom();
return $first_transformation->getInputValidator();
}
/**
* {@inheritdoc}
*/
public function getOutputValidator() {
/** @var \Shaper\Transformation\TransformationValidationInterface $last_transformation */
$last_transformation = $this->top();
return $last_transformation->getOutputValidator();
}
}

View File

@@ -0,0 +1,5 @@
<?php
namespace Shaper\Util;
class Context extends \ArrayObject {}

View File

@@ -0,0 +1,25 @@
<?php
/**
* Created by PhpStorm.
* User: e0ipso
* Date: 27/02/2018
* Time: 13:37
*/
namespace Shaper\Validator;
/**
* Validator that accepts everything.
*
* @package Shaper
*/
class AcceptValidator extends ValidateableBase {
/**
* {@inheritdoc}
*/
public function isValid($data) {
return TRUE;
}
}

View File

@@ -0,0 +1,47 @@
<?php
namespace Shaper\Validator;
class CollectionOfValidators extends ValidateableBase {
/**
* The name of the class or interface the data must comply.
*
* @var string
*/
protected $itemValidator;
/**
* InstanceofValidator constructor.
*
* @param ValidateableInterface $item_validator
* The validator to apply to each item.
*
* @throws \TypeError
* If the class or interface does not exist.
*/
public function __construct(ValidateableInterface $item_validator) {
$this->itemValidator = $item_validator;
}
/**
* {@inheritdoc}
*/
public function isValid($data) {
$this->resetErrors();
if (!is_array($data)) {
array_push($this->errors, 'Collection of validators only applies on data arrays.');
return FALSE;
}
// The collection is valid if all the items are valid.
return array_reduce($data, function ($is_valid, $item) {
$valid_item = TRUE;
$is_valid = $is_valid && ($valid_item = $this->itemValidator->isValid($item));
if (!$valid_item) {
$this->errors = array_merge($this->errors, $this->itemValidator->getErrors());
}
return $is_valid;
}, TRUE);
}
}

View File

@@ -0,0 +1,51 @@
<?php
namespace Shaper\Validator;
class InstanceofValidator extends ValidateableBase {
/**
* The name of the class or interface the data must comply.
*
* @var string
*/
protected $supportedClassOrInterface;
/**
* InstanceofValidator constructor.
*
* @param string $supported_class_or_interface
* The class or interface. It must exist.
*
* @throws \TypeError
* If the class or interface does not exist.
*/
public function __construct($supported_class_or_interface) {
if (
!class_exists($supported_class_or_interface) &&
!interface_exists($supported_class_or_interface)
) {
$message = sprintf('Class or interface %s does not exist.', $supported_class_or_interface);
throw new \TypeError($message);
}
$this->supportedClassOrInterface = $supported_class_or_interface;
}
/**
* {@inheritdoc}
*/
public function isValid($data) {
$this->resetErrors();
$is_valid = is_a($data, $this->supportedClassOrInterface);
if (!$is_valid) {
$message = sprintf(
'"%s" does not extend or implement "%s".',
is_object($data) ? get_class($data) : $data,
$this->supportedClassOrInterface
);
array_push($this->errors, $message);
}
return $is_valid;
}
}

View File

@@ -0,0 +1,113 @@
<?php
namespace Shaper\Validator;
use JsonSchema\Validator;
class JsonSchemaValidator extends ValidateableBase {
/**
* The JSON object with the schema.
*
* @var array
*/
protected $schema;
/**
* The schema validator.
*
* @var \JsonSchema\Validator
*/
protected $validator;
/**
* The check mode flag for the JSON Schema validator.
*
* @var int
*/
protected $checkMode;
/**
* JsonSchema constructor.
*
* @param array $schema
* The schema.
* @param \JsonSchema\Validator $validator
* The validator.
*/
public function __construct(?array $schema = NULL, ?Validator $validator = NULL, $mode = NULL) {
$this->schema = $schema;
$this->validator = $validator;
$this->checkMode = $mode;
}
/**
* Sets the validator.
*
* @param \JsonSchema\Validator $validator
* The object that checks the JSON Schema.
*/
public function setValidator(Validator $validator) {
$this->validator = $validator;
}
/**
* Transforms the schema into a JSON object.
*
* @return string
* The JSON object representation.
*/
public function toJSON() {
return json_encode($this->schema);
}
/**
* {@inheritdoc}
*/
public function isValid($data) {
$this->resetErrors();
if (!$this->validator) {
throw new \InvalidArgumentException('JSON Schema validator needs to be set using setValidator().');
}
$num_errors = $this->validator->validate($data, $this->schema, $this->checkMode);
if ($num_errors) {
$this->errors = array_merge($this->errors, $this->validator->getErrors());
}
return !$num_errors;
}
/**
* Avoid serializing the validator.
*
* @return array
* The names of the properties to serialize.
*/
public function __sleep() {
return ['schema', 'errors'];
}
/**
* Re-attach a validator on de-serialization.
*/
public function __wakeup() {
$this->setValidator(new Validator());
}
public function getErrors() {
if ($this->validator) {
return $this->validator->getErrors();
}
return parent::getErrors();
}
/**
* {@inheritdoc}
*/
public function resetErrors() {
if ($this->validator) {
$this->validator->reset();
}
$this->errors = [];
}
}

View File

@@ -0,0 +1,52 @@
<?php
namespace Shaper\Validator;
use JsonSchema\Validator;
class RegexpValidator extends ValidateableBase {
/**
* The name of the class or interface the data must comply.
*
* @var \Shaper\Validator\JsonSchemaValidator
*/
protected $stringValidator;
/**
* The regular expression.
*
* @var string
*/
protected $regexp;
/**
* InstanceofValidator constructor.
*
* @param string $regexp
* The regular expression (without delimiters) to check.
*/
public function __construct($regexp) {
$this->regexp = $regexp;
$this->stringValidator = new JsonSchemaValidator(['type' => 'string'], new Validator());
}
/**
* {@inheritdoc}
*/
public function isValid($data) {
$this->resetErrors();
$matches_regexp = $this->stringValidator->isValid($data) &&
preg_match('@' . $this->regexp . '@', $data);
if (!$matches_regexp) {
$message = sprintf(
'String "%s" does not match regular expression /%s/ as expected.',
$data,
$this->regexp
);
array_push($this->errors, $message);
}
return $matches_regexp;
}
}

View File

@@ -0,0 +1,23 @@
<?php
namespace Shaper\Validator;
abstract class ValidateableBase implements ValidateableInterface {
protected $errors = [];
/**
* {@inheritdoc}
*/
public function getErrors() {
return $this->errors;
}
/**
* {@inheritdoc}
*/
public function resetErrors() {
$this->errors = [];
}
}

View File

@@ -0,0 +1,33 @@
<?php
namespace Shaper\Validator;
interface ValidateableInterface {
/**
* Checks that the provided data is valid.
*
* @param mixed $data
* The data to validate.
*
* @return bool
* TRUE if the data is valid. FALSE otherwise.
*/
public function isValid($data);
/**
* Get the eventual errors in case validation failed.
*
* @return array
* The list of errors that happened.
*/
public function getErrors();
/**
* Clears any reported errors.
*
* Should be used between validation checks.
*/
public function resetErrors();
}

View File

@@ -0,0 +1,99 @@
<?php
namespace Shaper\Tests\DataAdaptor;
use PHPUnit\Framework\TestCase;
use Shaper\Util\Context;
/**
* @package Shaper
*
* @coversDefaultClass \Shaper\DataAdaptor\DataAdaptorBase
*/
class DataAdaptorBaseTest extends TestCase {
/**
* @var \Shaper\Util\Context
*/
protected $context;
protected function setUp(): void {
parent::setUp();
$this->context = new Context();
$this->context['key'] = 'lorem';
}
/**
* @covers ::transform
* @covers ::conformsToExpectedInputShape
* @covers ::conformsToInternalShape
*/
public function testtransform() {
$sut = new DataAdaptorFake();
$data = new \stdClass();
$data->lorem = 'caramba!';
$actual = $sut->transform($data, $this->context);
$this->assertSame('caramba!', $actual);
}
/**
* @covers ::transform
*/
public function testtransformErrorInput() {
$sut = new DataAdaptorFake2();
$data = new \stdClass();
$data->lorem = 'caramba!';
$this->expectException(\TypeError::class);
$sut->transform($data, $this->context);
}
/**
* @covers ::transform
*/
public function testtransformErrorOutput() {
$sut = new DataAdaptorFake3();
$data = new \stdClass();
$data->lorem = 'caramba!';
$this->expectException(\TypeError::class);
$sut->transform($data);
}
/**
* @covers ::undoTransform
* @covers ::conformsToInternalShape
* @covers ::conformsToOutputShape
*/
public function testundoTransform() {
$sut = new DataAdaptorFake();
$actual = $sut->undoTransform('caramba!', $this->context);
$expected = new \stdClass();
$expected->lorem = 'caramba!';
$expected->bar = 'default';
$this->assertEquals($expected, $actual);
}
/**
* @covers ::undoTransform
*/
public function testundoTransformErrorInput() {
$sut = new DataAdaptorFake3();
$expected = new \stdClass();
$expected->lorem = 'caramba!';
$expected->bar = 'default';
$this->expectException(\TypeError::class);
$sut->undoTransform('caramba!', $this->context);
}
/**
* @covers ::undoTransform
*/
public function testundoTransformErrorOutput() {
$sut = new DataAdaptorFake4();
$expected = new \stdClass();
$expected->lorem = 'caramba!';
$expected->bar = 'default';
$this->expectException(\TypeError::class);
$sut->undoTransform('caramba!');
}
}

View File

@@ -0,0 +1,29 @@
<?php
namespace Shaper\Tests\DataAdaptor;
use Shaper\DataAdaptor\DataAdaptorBase;
use Shaper\Util\Context;
use Shaper\Validator\AcceptValidator;
class DataAdaptorFake extends DataAdaptorBase {
protected function doTransform($data, Context $context) {
$key = $context->offsetExists('key') ? $context['key'] : 'lorem';
return $data->{$key};
}
protected function doUndoTransform($data, Context $context) {
$key = $context->offsetExists('key') ? $context['key'] : 'lorem';
return (object) [$key => $data, 'bar' => 'default'];
}
public function getInputValidator() {
return new AcceptValidator();
}
public function getInternalValidator() {
return new AcceptValidator();
}
public function getOutputValidator() {
return new AcceptValidator();
}
}

View File

@@ -0,0 +1,13 @@
<?php
namespace Shaper\Tests\DataAdaptor;
use Shaper\DataAdaptor\DataAdaptorBase;
use Shaper\Util\Context;
use Shaper\Validator\AcceptValidator;
class DataAdaptorFake2 extends DataAdaptorFake {
public function conformsToExpectedInputShape($data, ?Context $context = NULL) {
return FALSE;
}
}

View File

@@ -0,0 +1,13 @@
<?php
namespace Shaper\Tests\DataAdaptor;
use Shaper\DataAdaptor\DataAdaptorBase;
use Shaper\Util\Context;
use Shaper\Validator\AcceptValidator;
class DataAdaptorFake3 extends DataAdaptorFake {
public function conformsToInternalShape($data, ?Context $context = NULL) {
return FALSE;
}
}

View File

@@ -0,0 +1,13 @@
<?php
namespace Shaper\Tests\DataAdaptor;
use Shaper\DataAdaptor\DataAdaptorBase;
use Shaper\Util\Context;
use Shaper\Validator\AcceptValidator;
class DataAdaptorFake4 extends DataAdaptorFake {
public function conformsToOutputShape($data, ?Context $context = NULL) {
return FALSE;
}
}

View File

@@ -0,0 +1,52 @@
<?php
namespace Shaper\Tests\Transformation;
use JsonSchema\Validator;
use PHPUnit\Framework\TestCase;
use Shaper\Transformation\TransformationBase;
use Shaper\Util\Context;
use Shaper\Validator\AcceptValidator;
use Shaper\Validator\JsonSchemaValidator;
/**
* @package Shaper
*
* @coversDefaultClass \Shaper\Transformation\TransformationBase
*/
class TransformationBaseTest extends TestCase {
/**
* @covers ::transform
* @covers ::getInputValidator
* @covers ::getOutputValidator
* @covers ::conformsToExpectedInputShape
* @covers ::conformsToOutputShape
*/
public function testTransform() {
$sut = new TransformationFake();
$actual = $sut->transform('foo');
$this->assertSame(42, $actual);
$this->expectException(\TypeError::class);
$sut->transform([], new Context());
}
/**
* @covers ::transform
*/
public function testTransformBeforeError() {
$sut = new TransformationFake();
$this->expectException(\TypeError::class);
$sut->transform([], new Context());
}
/**
* @covers ::transform
*/
public function testTransformAfterError() {
$sut = new TransformationFail();
$this->expectException(\TypeError::class);
$sut->transform('foo', new Context());
}
}

View File

@@ -0,0 +1,11 @@
<?php
namespace Shaper\Tests\Transformation;
use Shaper\Util\Context;
class TransformationFail extends TransformationFake {
protected function doTransform($data, Context $context) {
return 'bar';
}
}

View File

@@ -0,0 +1,21 @@
<?php
namespace Shaper\Tests\Transformation;
use JsonSchema\Validator;
use Shaper\Transformation\TransformationBase;
use Shaper\Util\Context;
use Shaper\Validator\JsonSchemaValidator;
class TransformationFake extends TransformationBase {
public function getInputValidator() {
return new JsonSchemaValidator(['type' => 'string'], new Validator());
}
public function getOutputValidator() {
return new JsonSchemaValidator(['type' => 'number'], new Validator());
}
protected function doTransform($data, Context $context) {
return 42;
}
}

View File

@@ -0,0 +1,76 @@
<?php
namespace Shaper\Tests\Transformation;
use JsonSchema\Validator;
use PHPUnit\Framework\TestCase;
use Shaper\Transformation\TransformationBase;
use Shaper\Transformation\TransformationsQueue;
use Shaper\Util\Context;
use Shaper\Validator\AcceptValidator;
use Shaper\Validator\JsonSchemaValidator;
class TransformationFake2 extends TransformationBase {
public function getInputValidator() {
return new JsonSchemaValidator(['type' => 'number'], new Validator());
}
public function getOutputValidator() {
$schema = ['type' => 'array', 'items' => ['type' => 'number']];
return new JsonSchemaValidator($schema, new Validator());
}
protected function doTransform($data, Context $context) {
return [$data];
}
}
/**
* @package Shaper
*
* @coversDefaultClass \Shaper\Transformation\TransformationsQueue
*/
class TransformationsQueueTest extends TestCase {
/**
* @var \Shaper\Transformation\TransformationsQueue
*/
protected $sut;
/**
* @var \Shaper\Util\Context
*/
protected $context;
protected function setUp(): void {
parent::setUp();
$this->sut = new TransformationsQueue();
$this->sut->push(new TransformationFake());
$this->sut->push(new TransformationFake2());
$this->context = new Context();
}
/**
* @covers ::transform
*/
public function testTransform() {
$actual = $this->sut->transform('foo', $this->context);
$this->assertEquals([42], $actual);
$actual = $this->sut->transform('foo');
$this->assertEquals([42], $actual);
}
/**
* @covers ::getInputValidator
*/
public function testGetInputValidator() {
$this->assertFalse($this->sut->conformsToExpectedInputShape([], $this->context));
}
/**
* @covers ::getOutputValidator
*/
public function testGetOutputValidator() {
$this->assertFalse($this->sut->conformsToOutputShape(new \stdClass(), $this->context));
}
}

View File

@@ -0,0 +1,24 @@
<?php
namespace Shaper\Tests\Validator;
use Shaper\Validator\AcceptValidator;
use PHPUnit\Framework\TestCase;
/**
* @package Shaper
*
* @coversDefaultClass \Shaper\Validator\AcceptValidator
*/
class AcceptValidatorTest extends TestCase {
/**
* @covers ::isValid
*/
public function testIsValid() {
$sut = new AcceptValidator();
$this->assertTrue($sut->isValid(NULL));
$this->assertTrue($sut->isValid(TRUE));
$this->assertTrue($sut->isValid(42));
}
}

View File

@@ -0,0 +1,44 @@
<?php
namespace Shaper\Tests\Validator;
use PHPUnit\Framework\TestCase;
use Shaper\Validator\CollectionOfValidators;
use Shaper\Validator\InstanceofValidator;
/**
* @package Shaper
*
* @coversDefaultClass \Shaper\Validator\CollectionOfValidators
*/
class CollectionOfValidatorsTest extends TestCase {
/**
* @covers ::__construct
*/
public function test__construct() {
$sut = new CollectionOfValidators(new InstanceofValidator(TestCase::class));
$this->assertInstanceOf(CollectionOfValidators::class, $sut);
}
/**
* @covers ::__construct
*/
public function test__constructError() {
$this->expectException(\TypeError::class);
new CollectionOfValidators('IAmAFail');
}
/**
* @covers ::isValid
*/
public function testIsValid() {
$sut = new CollectionOfValidators(new InstanceofValidator(\stdClass::class));
$this->assertTrue($sut->isValid([new \stdClass(), new \stdClass()]));
$this->assertFalse($sut->isValid([new \stdClass(), 'fail']));
$this->assertSame('"fail" does not extend or implement "stdClass".', $sut->getErrors()[0]);
$this->assertFalse($sut->isValid(new \stdClass()));
$this->assertSame('Collection of validators only applies on data arrays.', $sut->getErrors()[0]);
}
}

View File

@@ -0,0 +1,43 @@
<?php
namespace Shaper\Tests\Validator;
use PHPUnit\Framework\TestCase;
use Shaper\Validator\InstanceofValidator;
/**
* @package Shaper
*
* @coversDefaultClass \Shaper\Validator\InstanceofValidator
*/
class InstanceofValidatorTest extends TestCase {
/**
* @covers ::__construct
*/
public function test__construct() {
$sut = new InstanceofValidator(TestCase::class);
$this->assertInstanceOf(InstanceofValidator::class, $sut);
}
/**
* @covers ::__construct
*/
public function test__constructError() {
$this->expectException(\TypeError::class);
new InstanceofValidator('IAmAFail');
}
/**
* @covers ::isValid
*/
public function testIsValid() {
$sut = new InstanceofValidator(\stdClass::class);
$this->assertTrue($sut->isValid(new \stdClass()));
$this->assertFalse($sut->isValid(new \Exception()));
$this->assertSame('"Exception" does not extend or implement "stdClass".', $sut->getErrors()[0]);
$this->assertFalse($sut->isValid('42'));
$this->assertSame('"42" does not extend or implement "stdClass".', $sut->getErrors()[0]);
}
}

View File

@@ -0,0 +1,95 @@
<?php
namespace Shaper\Tests\Validator;
use JsonSchema\Validator;
use PHPUnit\Framework\TestCase;
use Shaper\Validator\JsonSchemaValidator;
/**
* @package Shaper
*
* @coversDefaultClass \Shaper\Validator\JsonSchemaValidator
*/
class JsonSchemaValidatorTest extends TestCase {
/**
* @covers ::__construct
* @covers ::setValidator
*/
public function test__construct() {
$sut = new JsonSchemaValidator(NULL, new Validator());
$this->assertInstanceOf(JsonSchemaValidator::class, $sut);
}
/**
* @covers ::toJSON
*/
public function testToJSON() {
$sut = new JsonSchemaValidator(['type' => 'string'], new Validator());
$this->assertEquals('{"type":"string"}', $sut->toJSON());
}
/**
* @covers ::isValid
* @covers ::setValidator
*/
public function testIsValid() {
$sut = new JsonSchemaValidator(['type' => 'number']);
$sut->setValidator(new Validator());
$this->assertTrue($sut->isValid(42));
$this->assertFalse($sut->isValid('not true'));
$this->assertSame('String value found, but a number is required', $sut->getErrors()[0]['message']);
}
/**
* @covers ::isValid
*/
public function testIsValidError() {
$sut = new JsonSchemaValidator(['type' => 'number']);
$this->expectException(\InvalidArgumentException::class);
$this->assertTrue($sut->isValid(NULL));
}
/**
* @covers ::__sleep
* @covers ::__wakeup
*/
public function testSerialize() {
$sut = new JsonSchemaValidator(['type' => 'number'], new Validator());
$serialized = serialize($sut);
$sut = unserialize($serialized);
$this->assertInstanceOf(JsonSchemaValidator::class, $sut);
}
/**
* @covers ::getErrors
*/
public function testGetErrors() {
$sut = new JsonSchemaValidator(['type' => 'number']);
$sut->setValidator(new Validator());
$sut->isValid(NULL);
$this->assertEquals([[
'property' => '',
'pointer' => '',
'message' => 'NULL value found, but a number is required',
'constraint' => 'type',
'context' => 1,
]], $sut->getErrors());
$sut = new JsonSchemaValidator(['type' => 'number']);
$this->assertEquals([], $sut->getErrors());
}
/**
* @covers ::resetErrors
*/
public function testResetErrors() {
$sut = new JsonSchemaValidator(['type' => 'number']);
$sut->setValidator(new Validator());
$sut->isValid(NULL);
$this->assertNotEmpty($sut->getErrors()[0]);
$sut->resetErrors();
$this->assertEmpty($sut->getErrors());
}
}

View File

@@ -0,0 +1,45 @@
<?php
namespace Shaper\Tests\Validator;
use Shaper\Validator\RegexpValidator;
use PHPUnit\Framework\TestCase;
/**
* @package Shaper
*
* @coversDefaultClass \Shaper\Validator\RegexpValidator
*/
class RegexpValidatorTest extends TestCase {
/**
* @covers ::isValid
* @covers ::__construct
* @dataProvider providerIdValid
*/
public function testIsValid($data, $expected) {
$sut = new RegexpValidator('^d.*e$');
$this->assertSame($expected, $sut->isValid($data));
if (!$expected) {
$message = sprintf(
'String "%s" does not match regular expression /^d.*e$/ as expected.',
$data
);
$this->assertSame($message, $sut->getErrors()[0]);
}
}
/**
* Data provider for testIsValid.
*
* @return array
*/
public function providerIdValid() {
return [
['de', TRUE],
['d123/\/@e', TRUE],
['42', FALSE],
['d123@', FALSE],
];
}
}

View File

@@ -0,0 +1,46 @@
<?php
namespace Shaper\Tests\Validator;
use PHPUnit\Framework\TestCase;
use Shaper\Validator\ValidateableBase;
class FakeValidateable extends ValidateableBase {
public function isValid($data) {
return FALSE;
}
public function setErrors($value) {
$this->errors = $value;
}
}
/**
* @package Shaper
*
* @coversDefaultClass \Shaper\Validator\ValidateableBase
*/
class ValidateableBaseTest extends TestCase {
/**
* @covers ::getErrors
*/
public function testGetErrors() {
$sut = new FakeValidateable();
$sut->setErrors('foo');
$this->assertSame('foo', $sut->getErrors());
}
/**
* @covers ::resetErrors
*/
public function testResetErrors() {
$sut = new FakeValidateable();
$sut->setErrors('foo');
$sut->resetErrors();
$this->assertEquals([], $sut->getErrors());
}
}