Completed
Push — rest_role_limitation_href ( 885ab2...f3bd2f )
by
unknown
37:35 queued 08:28
created

SectionLimitationTest   A

Complexity

Total Complexity 4

Size/Duplication

Total Lines 75
Duplicated Lines 24 %

Coupling/Cohesion

Components 1
Dependencies 3

Importance

Changes 1
Bugs 1 Features 0
Metric Value
wmc 4
c 1
b 1
f 0
lcom 1
cbo 3
dl 18
loc 75
rs 10

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
/**
4
 * File containing a test class.
5
 *
6
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
7
 * @license For full copyright and license information view LICENSE file distributed with this source code.
8
 *
9
 * @version //autogentag//
10
 */
11
namespace eZ\Publish\Core\REST\Server\Tests\Input\Parser;
12
13
use eZ\Publish\API\Repository\Values\User\Limitation\SectionLimitation;
14
use eZ\Publish\Core\REST\Server\Input\Parser\Limitation\SectionLimitation as Parser;
15
16
class SectionInputTest extends BaseTest
0 ignored issues
show
Comprehensibility Best Practice introduced by
The type eZ\Publish\Core\REST\Ser...Parser\SectionInputTest has been defined more than once; this definition is ignored, only the first definition in eZ/Publish/Core/REST/Ser...er/SectionInputTest.php (L16-105) is considered.

This check looks for classes that have been defined more than once.

If you can, we would recommend to use standard object-oriented programming techniques. For example, to avoid multiple types, it might make sense to create a common interface, and then multiple, different implementations for that interface.

This also has the side-effect of providing you with better IDE auto-completion, static analysis and also better OPCode caching from PHP.

Loading history...
17
{
18
    /**
19
     * Tests the SectionInput parser.
20
     */
21
    public function testParse()
22
    {
23
        $inputArray = array(
24
            '_identifier' => 'Section',
25
            'values' => [
26
                'ref' => [
27
                    [
28
                        '_href' => '/content/section/2',
29
                        '_media-type' => "application/vnd.ez.api.Section+json",
30
                    ],
31
                ],
32
            ],
33
        );
34
35
        $this->getRequestParserMock()
36
            ->expects($this->once())
37
            ->method('parseHref')
38
            ->with('/content/section/2', 'sectionId')
39
            ->will($this->returnValue(2));
40
41
        $result = $this->getParser()->parse($inputArray, $this->getParsingDispatcherMock());
42
43
        $this->assertEquals(
44
            new SectionLimitation(['limitationValues' => [2]]),
45
            $result,
46
            'SectionLimitation not created correctly.'
47
        );
48
    }
49
50
    public function getParseHrefExpectationsMap()
51
    {
52
        return [
53
            ['/content/section/2', 'sectionId', 2]
54
        ];
55
    }
56
57
58
    /**
59
     * Returns the section input parser.
60
     *
61
     * @return \eZ\Publish\Core\REST\Server\Input\Parser\SectionInput
62
     */
63
    protected function internalGetParser()
64
    {
65
        return new Parser($this->getSectionServiceMock());
66
    }
67
68
    /**
69
     * Get the section service mock object.
70
     *
71
     * @return \eZ\Publish\API\Repository\SectionService
72
     */
73 View Code Duplication
    protected function getSectionServiceMock()
74
    {
75
        $sectionServiceMock = $this->getMock(
76
            'eZ\\Publish\\Core\\Repository\\SectionService',
77
            array(),
0 ignored issues
show
Bug Best Practice introduced by
The return type of return new \eZ\Publish\C...tSectionServiceMock()); (eZ\Publish\Core\REST\Ser...put\Parser\SectionInput) is incompatible with the return type declared by the abstract method eZ\Publish\Core\REST\Ser...Test::internalGetParser of type eZ\Publish\Core\REST\Server\Input\Parser\Base.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
78
            array(),
79
            '',
80
            false
81
        );
82
83
        $sectionServiceMock->expects($this->any())
84
            ->method('newSectionCreateStruct')
85
            ->will(
86
                $this->returnValue(new SectionCreateStruct())
87
            );
88
89
        return $sectionServiceMock;
90
    }
91
}
92