Completed
Pull Request — develop (#552)
by
unknown
14:01 queued 09:14
created

VersionFieldConstraint   A

Complexity

Total Complexity 9

Size/Duplication

Total Lines 70
Duplicated Lines 7.14 %

Coupling/Cohesion

Components 1
Dependencies 7

Test Coverage

Coverage 0%

Importance

Changes 2
Bugs 0 Features 0
Metric Value
wmc 9
c 2
b 0
f 0
lcom 1
cbo 7
dl 5
loc 70
rs 10
ccs 0
cts 32
cp 0

3 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
B validate() 5 26 6
A setCurrentVersionHeader() 0 6 2

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
/**
3
 * Field constraint that validates if the posted version is the same as the one in DB.
4
 */
5
6
namespace Graviton\SchemaBundle\Constraint;
7
8
use Graviton\JsonSchemaBundle\Validator\Constraint\Event\ConstraintEventFormat;
9
use Symfony\Component\PropertyAccess\PropertyAccess;
10
use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
11
12
/**
13
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
14
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
15
 * @link     http://swisscom.ch
16
 */
17
class VersionFieldConstraint
18
{
19
    /** @var ConstraintUtils  */
20
    private $utils;
21
22
    /** @var Integer */
23
    private $version;
24
25
    /**
26
     * Constructor
27
     *
28
     * @param ConstraintUtils $utils Utils
29
     */
30
    public function __construct(ConstraintUtils $utils)
31
    {
32
        $this->utils = $utils;
33
    }
34
35
    /**
36
     * Check if the version is correct: versioning
37
     * -> Post, even if posted it should be version 1
38
     * -> Put, should be the same value. Reject if not.
39
     * -> Patch, no check, only increment
40
     *
41
     * Default, if object have version as integer , increment 1.
42
     *
43
     * @param ConstraintEventFormat $event event class
44
     *
45
     * @return void
46
     */
47
    public function validate(ConstraintEventFormat $event)
48
    {
49
        $schema = $event->getSchema();
50
51 View Code Duplication
        if (!isset($schema->{'x-constraints'}) ||
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
52
            (is_array($schema->{'x-constraints'}) && !in_array('versioning', $schema->{'x-constraints'}))
53
        ) {
54
            return;
55
        }
56
57
        // get the current recor
58
        if ($currentRecord = $this->utils->getCurrentEntity()) {
59
            $formVersion = $event->getElement();
60
            /** @var \JsonSchema\Entity\JsonPointer $pointer */
61
            $pointer = $event->getPath();
62
            $accessor = PropertyAccess::createPropertyAccessor();
63
            $path = $this->utils->getNormalizedPathFromPointer($pointer);
64
            $storedVersion = $accessor->getValue($currentRecord, $path);
65
            if ($storedVersion !== $formVersion) {
66
                $this->version = $storedVersion;
67
                $event->addError('The version does not match, please update your data.');
68
                return;
69
            }
70
        }
71
        return;
72
    }
73
74
    /**
75
     * Setting if needed the headers to let user know what was the new version.
76
     *
77
     * @param FilterResponseEvent $event SF response event
78
     * @return void
79
     */
80
    public function setCurrentVersionHeader(FilterResponseEvent $event)
81
    {
82
        if ($this->version) {
83
            $event->getResponse()->headers->set('X-Current-Version', $this->version);
84
        }
85
    }
86
}
87