Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
100.00% |
1 / 1 |
|
100.00% |
4 / 4 |
CRAP | |
100.00% |
33 / 33 |
| EntitySchema\DataAccess\SchemaUpdateGuard | |
100.00% |
1 / 1 |
|
100.00% |
4 / 4 |
7 | |
100.00% |
33 / 33 |
| __construct | |
100.00% |
1 / 1 |
1 | |
100.00% |
4 / 4 |
|||
| guardSchemaUpdate | |
100.00% |
1 / 1 |
4 | |
100.00% |
17 / 17 |
|||
| cleanupData | |
100.00% |
1 / 1 |
1 | |
100.00% |
6 / 6 |
|||
| array2persistence | |
100.00% |
1 / 1 |
1 | |
100.00% |
6 / 6 |
|||
| <?php | |
| namespace EntitySchema\DataAccess; | |
| use Diff\Patcher\PatcherException; | |
| use MediaWiki\Revision\RevisionRecord; | |
| use MediaWiki\Revision\SlotRecord; | |
| use EntitySchema\Services\Diff\SchemaDiffer; | |
| use EntitySchema\Services\Diff\SchemaPatcher; | |
| use EntitySchema\Services\SchemaConverter\FullArraySchemaData; | |
| use EntitySchema\Services\SchemaConverter\PersistenceSchemaData; | |
| use EntitySchema\Services\SchemaConverter\SchemaConverter; | |
| /** | |
| * @license GPL-2.0-or-later | |
| */ | |
| class SchemaUpdateGuard { | |
| /** @var SchemaConverter */ | |
| private $schemaConverter; | |
| /** @var SchemaDiffer */ | |
| private $schemaDiffer; | |
| /** @var SchemaPatcher */ | |
| private $schemaPatcher; | |
| public function __construct() { | |
| $this->schemaConverter = new SchemaConverter(); | |
| $this->schemaDiffer = new SchemaDiffer(); | |
| $this->schemaPatcher = new SchemaPatcher(); | |
| } | |
| /** | |
| * @param RevisionRecord $baseRevision The revision that the user’s data is based on. | |
| * @param RevisionRecord $parentRevision The parent revision returned by the PageUpdater. | |
| * @param callable $schemaUpdate Function accepting a FullArraySchemaData object, | |
| * updating it with the user’s data. | |
| * @return PersistenceSchemaData|null The data that should be stored, | |
| * or null if there is nothing to do. | |
| * @throws EditConflict | |
| */ | |
| public function guardSchemaUpdate( | |
| RevisionRecord $baseRevision, | |
| RevisionRecord $parentRevision, | |
| callable $schemaUpdate | |
| ) { | |
| $baseData = $this->schemaConverter->getFullArraySchemaData( | |
| // @phan-suppress-next-line PhanUndeclaredMethod | |
| $baseRevision->getContent( SlotRecord::MAIN )->getText() | |
| ); | |
| $updateData = clone $baseData; | |
| $schemaUpdate( $updateData ); | |
| $this->cleanupData( $baseData ); | |
| $this->cleanupData( $updateData ); | |
| $diff = $this->schemaDiffer->diffSchemas( $baseData, $updateData ); | |
| if ( $diff->isEmpty() ) { | |
| return null; | |
| } | |
| if ( $baseRevision->getId() === $parentRevision->getId() ) { | |
| return $this->array2persistence( $updateData ); | |
| } | |
| $parentData = $this->schemaConverter->getFullArraySchemaData( | |
| // @phan-suppress-next-line PhanUndeclaredMethod | |
| $parentRevision->getContent( SlotRecord::MAIN )->getText() | |
| ); | |
| try { | |
| $patchedData = $this->schemaPatcher->patchSchema( $parentData, $diff ); | |
| } catch ( PatcherException $e ) { | |
| throw new EditConflict( $e->getMessage(), $e->getCode(), $e ); | |
| } | |
| return $this->array2persistence( $patchedData ); | |
| } | |
| private function cleanupData( FullArraySchemaData $data ) { | |
| SchemaCleaner::cleanupParameters( | |
| $data->data['labels'], | |
| $data->data['descriptions'], | |
| $data->data['aliases'], | |
| $data->data['schemaText'] | |
| ); | |
| } | |
| // TODO this is very silly | |
| private function array2persistence( FullArraySchemaData $arrayData ): PersistenceSchemaData { | |
| $persistenceData = new PersistenceSchemaData(); | |
| $persistenceData->labels = $arrayData->data['labels']; | |
| $persistenceData->descriptions = $arrayData->data['descriptions']; | |
| $persistenceData->aliases = $arrayData->data['aliases']; | |
| $persistenceData->schemaText = $arrayData->data['schemaText']; | |
| return $persistenceData; | |
| } | |
| } |