FieldTest::internalGetParser() - Code Metrics - Inspection of "EZP-28942: Added Field sort clause to REST API (#2..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 6.7 ( 341122...65da37 )

unknown

created 2018-06-29 07:37 UTC

FieldTest::internalGetParser() A

↳ Parent: FieldTest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

/**
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace eZ\Publish\Core\REST\Server\Tests\Input\Parser\SortClause;

use eZ\Publish\API\Repository\Values\Content\Query;
use eZ\Publish\API\Repository\Values\Content\Query\SortClause\Field;
use eZ\Publish\Core\REST\Server\Input\Parser\SortClause\Field as FieldParser;
use eZ\Publish\Core\REST\Server\Tests\Input\Parser\BaseTest;

class FieldTest extends BaseTest
{
    /**
     * Tests the Field parser.
     */
    public function testParse()
    {
        $inputArray = [
            'Field' => [
                'identifier' => 'content/field',
                'direction' => Query::SORT_ASC,
            ],
        ];

        $fieldParser = $this->getParser();
        $result = $fieldParser->parse($inputArray, $this->getParsingDispatcherMock());

        $this->assertEquals(
            new Field('content', 'field', Query::SORT_ASC),
            $result,
            'Field parser not created correctly.'
        );
    }

    /**
     * Test Field parser throwing exception on missing sort clause.
     *
     * @expectedException \eZ\Publish\Core\REST\Common\Exceptions\Parser
     * @expectedExceptionMessage The <Field> sort clause doesn't exist in the input structure
     */
    public function testParseExceptionOnMissingSortClause()
    {
        $inputArray = [
            'name' => 'Keep on mocking in the free world',
        ];

        $fieldParser = $this->getParser();
        $fieldParser->parse($inputArray, $this->getParsingDispatcherMock());
    }

    /**
     * Test Field parser throwing exception on invalid direction format.
     *
     * @expectedException \eZ\Publish\Core\REST\Common\Exceptions\Parser
     * @expectedExceptionMessage Invalid direction format in <Field> sort clause
     */
    public function testParseExceptionOnInvalidDirectionFormat()
    {
        $inputArray = [
            'Field' => [
                'identifier' => 'content/field',
                'direction' => 'mock',
            ],
        ];

        $fieldParser = $this->getParser();
        $fieldParser->parse($inputArray, $this->getParsingDispatcherMock());
    }

    /**
     * Returns the Field parser.
     *
     * @return \eZ\Publish\Core\REST\Server\Input\Parser\SortClause\Field
     */
    protected function internalGetParser()
    {
        return new FieldParser();
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());
}
    }
}


1		<?php
2
3		/**
4		* @copyright Copyright (C) eZ Systems AS. All rights reserved.
5		* @license For full copyright and license information view LICENSE file distributed with this source code.
6		*/
7		namespace eZ\Publish\Core\REST\Server\Tests\Input\Parser\SortClause;
8
9		use eZ\Publish\API\Repository\Values\Content\Query;
10		use eZ\Publish\API\Repository\Values\Content\Query\SortClause\Field;
11		use eZ\Publish\Core\REST\Server\Input\Parser\SortClause\Field as FieldParser;
12		use eZ\Publish\Core\REST\Server\Tests\Input\Parser\BaseTest;
13
14		class FieldTest extends BaseTest
15		{
16		/**
17		* Tests the Field parser.
18		*/
19		public function testParse()
20		{
21		$inputArray = [
22		'Field' => [
23		'identifier' => 'content/field',
24		'direction' => Query::SORT_ASC,
25		],
26		];
27
28		$fieldParser = $this->getParser();
29		$result = $fieldParser->parse($inputArray, $this->getParsingDispatcherMock());
30
31		$this->assertEquals(
32		new Field('content', 'field', Query::SORT_ASC),
33		$result,
34		'Field parser not created correctly.'
35		);
36		}
37
38		/**
39		* Test Field parser throwing exception on missing sort clause.
40		*
41		* @expectedException \eZ\Publish\Core\REST\Common\Exceptions\Parser
42		* @expectedExceptionMessage The <Field> sort clause doesn't exist in the input structure
43		*/
44		public function testParseExceptionOnMissingSortClause()
45		{
46		$inputArray = [
47		'name' => 'Keep on mocking in the free world',
48		];
49
50		$fieldParser = $this->getParser();
51		$fieldParser->parse($inputArray, $this->getParsingDispatcherMock());
52		}
53
54		/**
55		* Test Field parser throwing exception on invalid direction format.
56		*
57		* @expectedException \eZ\Publish\Core\REST\Common\Exceptions\Parser
58		* @expectedExceptionMessage Invalid direction format in <Field> sort clause
59		*/
60	View Code Duplication	public function testParseExceptionOnInvalidDirectionFormat()
61		{
62		$inputArray = [
63		'Field' => [
64		'identifier' => 'content/field',
65		'direction' => 'mock',
66		],
67		];
68
69		$fieldParser = $this->getParser();
70		$fieldParser->parse($inputArray, $this->getParsingDispatcherMock());
71		}
72
73		/**
74		* Returns the Field parser.
75		*
76		* @return \eZ\Publish\Core\REST\Server\Input\Parser\SortClause\Field
77		*/
78		protected function internalGetParser()
79		{
80		return new FieldParser();
		0 ignored issues – show Bug Best Practice introduced 2018-06-29 07:56 UTC by Report Bug Copy Issue Report The return type of `return new \eZ\Publish\C...ser\SortClause\Field();` (`eZ\Publish\Core\REST\Ser...Parser\SortClause\Field`) 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...
81		}
82		}
83

ezsystems / ezpublish-kernel

Push — 6.7 ( 341122...65da37 )

FieldTest::internalGetParser() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like