ShortcodeTest::testProcessedShortcodeParents() - Code Metrics - Inspection of "Runtime events" - thunderer/Shortcode - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#32)

by Tomasz

created 2016-01-28 21:48 UTC

ShortcodeTest::testProcessedShortcodeParents() B

↳ Parent: ShortcodeTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	25
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	2

Metric	Value
c	2
b	0
f	2
dl	0
loc	25
rs	8.8571
cc	1
eloc	22
nc	1
nop	0

<?php
namespace Thunder\Shortcode\Tests;

use Thunder\Shortcode\HandlerContainer\HandlerContainer;
use Thunder\Shortcode\Parser\RegexParser;
use Thunder\Shortcode\Processor\Processor;
use Thunder\Shortcode\Processor\ProcessorContext;
use Thunder\Shortcode\Serializer\TextSerializer;
use Thunder\Shortcode\Shortcode\ParsedShortcode;
use Thunder\Shortcode\Shortcode\ProcessedShortcode;
use Thunder\Shortcode\Shortcode\Shortcode;

/**
 * @author Tomasz Kowalczyk <[email protected]>
 */
final class ShortcodeTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @dataProvider provideShortcodes
     */
    public function testShortcode($expected, $name, array $args, $content)
    {
        $s = new Shortcode($name, $args, $content);
        $textSerializer = new TextSerializer();

        $this->assertSame($name, $s->getName());
        $this->assertSame($args, $s->getParameters());
        $this->assertSame($content, $s->getContent());
        $this->assertSame($expected, $textSerializer->serialize($s));
        $this->assertSame('arg', $s->getParameterAt(0));
        $this->assertTrue($s->hasParameters());
    }

    public function provideShortcodes()
    {
        return array(
            array('[x arg=val /]', 'x', array('arg' => 'val'), null),
            array('[x arg=val][/x]', 'x', array('arg' => 'val'), ''),
            array('[x arg=val]inner[/x]', 'x', array('arg' => 'val'), 'inner'),
            array('[x arg="val val"]inner[/x]', 'x', array('arg' => 'val val'), 'inner'),
        );
    }

    public function testObject()
    {
        $shortcode = new Shortcode('random', array('arg' => 'value', 'none' => null), 'something');

        $this->assertTrue($shortcode->hasParameter('arg'));
        $this->assertFalse($shortcode->hasParameter('invalid'));
        $this->assertSame(null, $shortcode->getParameter('none'));
        $this->assertSame('value', $shortcode->getParameter('arg'));
        $this->assertSame('', $shortcode->getParameter('invalid', ''));
        $this->assertSame(42, $shortcode->getParameter('invalid', 42));

        $this->assertNotSame($shortcode, $shortcode->withContent('x'));
    }

    public function testProcessedShortcode()
    {
        $processor = new Processor(new RegexParser(), new HandlerContainer());

        $context = new ProcessorContext();
        $context->shortcode = new Shortcode('code', array('arg' => 'val'), 'content');
        $context->processor = $processor;
        $context->position = 20;
        $context->namePosition = array('code' => 10);
        $context->text = ' [code] ';
        $context->shortcodeText = '[code]';
        $context->offset = 1;
        $context->iterationNumber = 1;
        $context->recursionLevel = 0;
        $context->parent = null;

        $processed = ProcessedShortcode::createFromContext($context);

        $this->assertSame('code', $processed->getName());
        $this->assertSame(array('arg' => 'val'), $processed->getParameters());
        $this->assertSame('content', $processed->getContent());

        $this->assertSame(20, $processed->getPosition());
        $this->assertSame(10, $processed->getNamePosition());
        $this->assertSame(' [code] ', $processed->getText());
        $this->assertSame(1, $processed->getOffset());
        $this->assertSame('[code]', $processed->getShortcodeText());
        $this->assertSame(1, $processed->getIterationNumber());
        $this->assertSame(0, $processed->getRecursionLevel());
        $this->assertSame(null, $processed->getParent());
        $this->assertSame($processor, $processed->getProcessor());
    }

    public function testProcessedShortcodeParents()
    {
        $context = new ProcessorContext();
        $context->shortcode = new Shortcode('p1', array(), null);
        $context->parent = null;
        $context->namePosition = array('p1' => 0, 'p2' => 0, 'p3' => 0);
        $p1 = ProcessedShortcode::createFromContext($context);
        $context->shortcode = new Shortcode('p2', array(), null);
        $context->parent = $p1;
        $p2 = ProcessedShortcode::createFromContext($context);
        $context->shortcode = new Shortcode('p3', array(), null);
        $context->parent = $p2;
        $p3 = ProcessedShortcode::createFromContext($context);

        $this->assertSame('p3', $p3->getName());
        $this->assertSame('p2', $p3->getParent()->getName());
        $this->assertSame('p1', $p3->getParent()->getParent()->getName());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $this->assertFalse($p1->hasAncestor('p3'));
        $this->assertFalse($p1->hasAncestor('p1'));
        $this->assertTrue($p2->hasAncestor('p1'));
        $this->assertFalse($p2->hasAncestor('p3'));
        $this->assertTrue($p3->hasAncestor('p1'));
        $this->assertTrue($p3->hasAncestor('p2'));
        $this->assertFalse($p3->hasAncestor('p4'));
    }

    public function testParsedShortcode()
    {
        $shortcode = new ParsedShortcode(new Shortcode('name', array('arg' => 'val'), 'content'), 'text', 12);

        $this->assertSame('name', $shortcode->getName());
        $this->assertSame(array('arg' => 'val'), $shortcode->getParameters());
        $this->assertSame('content', $shortcode->getContent());
        $this->assertSame('text', $shortcode->getText());
        $this->assertSame(12, $shortcode->getOffset());
        $this->assertSame(true, $shortcode->hasContent());

        $this->assertSame(false, $shortcode->withContent(null)->hasContent());
        $this->assertSame('another', $shortcode->withContent('another')->getContent());
    }

    public function testShortcodeEmptyNameException()
    {
        $this->setExpectedException('InvalidArgumentException');
        new Shortcode('', array(), null);
    }
}


GitHub Access Token became invalid

Pull Request — master (#32)

ShortcodeTest::testProcessedShortcodeParents() B

Complexity

Size

Duplication

Importance

Available Fixes

1			<?php
2			namespace Thunder\Shortcode\Tests;
3
4			use Thunder\Shortcode\HandlerContainer\HandlerContainer;
5			use Thunder\Shortcode\Parser\RegexParser;
6			use Thunder\Shortcode\Processor\Processor;
7			use Thunder\Shortcode\Processor\ProcessorContext;
8			use Thunder\Shortcode\Serializer\TextSerializer;
9			use Thunder\Shortcode\Shortcode\ParsedShortcode;
10			use Thunder\Shortcode\Shortcode\ProcessedShortcode;
11			use Thunder\Shortcode\Shortcode\Shortcode;
12
13			/**
14			* @author Tomasz Kowalczyk <[email protected]>
15			*/
16			final class ShortcodeTest extends \PHPUnit_Framework_TestCase
17			{
18			/**
19			* @dataProvider provideShortcodes
20			*/
21			public function testShortcode($expected, $name, array $args, $content)
22			{
23			$s = new Shortcode($name, $args, $content);
24			$textSerializer = new TextSerializer();
25
26			$this->assertSame($name, $s->getName());
27			$this->assertSame($args, $s->getParameters());
28			$this->assertSame($content, $s->getContent());
29			$this->assertSame($expected, $textSerializer->serialize($s));
30			$this->assertSame('arg', $s->getParameterAt(0));
31			$this->assertTrue($s->hasParameters());
32			}
33
34			public function provideShortcodes()
35			{
36			return array(
37			array('[x arg=val /]', 'x', array('arg' => 'val'), null),
38			array('[x arg=val][/x]', 'x', array('arg' => 'val'), ''),
39			array('[x arg=val]inner[/x]', 'x', array('arg' => 'val'), 'inner'),
40			array('[x arg="val val"]inner[/x]', 'x', array('arg' => 'val val'), 'inner'),
41			);
42			}
43
44			public function testObject()
45			{
46			$shortcode = new Shortcode('random', array('arg' => 'value', 'none' => null), 'something');
47
48			$this->assertTrue($shortcode->hasParameter('arg'));
49			$this->assertFalse($shortcode->hasParameter('invalid'));
50			$this->assertSame(null, $shortcode->getParameter('none'));
51			$this->assertSame('value', $shortcode->getParameter('arg'));
52			$this->assertSame('', $shortcode->getParameter('invalid', ''));
53			$this->assertSame(42, $shortcode->getParameter('invalid', 42));
54
55			$this->assertNotSame($shortcode, $shortcode->withContent('x'));
56			}
57
58			public function testProcessedShortcode()
59			{
60			$processor = new Processor(new RegexParser(), new HandlerContainer());
61
62			$context = new ProcessorContext();
63			$context->shortcode = new Shortcode('code', array('arg' => 'val'), 'content');
64			$context->processor = $processor;
65			$context->position = 20;
66			$context->namePosition = array('code' => 10);
67			$context->text = ' [code] ';
68			$context->shortcodeText = '[code]';
69			$context->offset = 1;
70			$context->iterationNumber = 1;
71			$context->recursionLevel = 0;
72			$context->parent = null;
73
74			$processed = ProcessedShortcode::createFromContext($context);
75
76			$this->assertSame('code', $processed->getName());
77			$this->assertSame(array('arg' => 'val'), $processed->getParameters());
78			$this->assertSame('content', $processed->getContent());
79
80			$this->assertSame(20, $processed->getPosition());
81			$this->assertSame(10, $processed->getNamePosition());
82			$this->assertSame(' [code] ', $processed->getText());
83			$this->assertSame(1, $processed->getOffset());
84			$this->assertSame('[code]', $processed->getShortcodeText());
85			$this->assertSame(1, $processed->getIterationNumber());
86			$this->assertSame(0, $processed->getRecursionLevel());
87			$this->assertSame(null, $processed->getParent());
88			$this->assertSame($processor, $processed->getProcessor());
89			}
90
91			public function testProcessedShortcodeParents()
92			{
93			$context = new ProcessorContext();
94			$context->shortcode = new Shortcode('p1', array(), null);
95			$context->parent = null;
96			$context->namePosition = array('p1' => 0, 'p2' => 0, 'p3' => 0);
97			$p1 = ProcessedShortcode::createFromContext($context);
98			$context->shortcode = new Shortcode('p2', array(), null);
99			$context->parent = $p1;
100			$p2 = ProcessedShortcode::createFromContext($context);
101			$context->shortcode = new Shortcode('p3', array(), null);
102			$context->parent = $p2;
103			$p3 = ProcessedShortcode::createFromContext($context);
104
105			$this->assertSame('p3', $p3->getName());
106			$this->assertSame('p2', $p3->getParent()->getName());
107			$this->assertSame('p1', $p3->getParent()->getParent()->getName());
			0 ignored issues – show Bug introduced 2016-01-27 18:02 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Thunder\Shortcode\Shortcode\ShortcodeInterface` as the method `getParent()` does only exist in the following implementations of said interface: `Thunder\Shortcode\Shortcode\ProcessedShortcode`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
108			$this->assertFalse($p1->hasAncestor('p3'));
109			$this->assertFalse($p1->hasAncestor('p1'));
110			$this->assertTrue($p2->hasAncestor('p1'));
111			$this->assertFalse($p2->hasAncestor('p3'));
112			$this->assertTrue($p3->hasAncestor('p1'));
113			$this->assertTrue($p3->hasAncestor('p2'));
114			$this->assertFalse($p3->hasAncestor('p4'));
115			}
116
117			public function testParsedShortcode()
118			{
119			$shortcode = new ParsedShortcode(new Shortcode('name', array('arg' => 'val'), 'content'), 'text', 12);
120
121			$this->assertSame('name', $shortcode->getName());
122			$this->assertSame(array('arg' => 'val'), $shortcode->getParameters());
123			$this->assertSame('content', $shortcode->getContent());
124			$this->assertSame('text', $shortcode->getText());
125			$this->assertSame(12, $shortcode->getOffset());
126			$this->assertSame(true, $shortcode->hasContent());
127
128			$this->assertSame(false, $shortcode->withContent(null)->hasContent());
129			$this->assertSame('another', $shortcode->withContent('another')->getContent());
130			}
131
132			public function testShortcodeEmptyNameException()
133			{
134			$this->setExpectedException('InvalidArgumentException');
135			new Shortcode('', array(), null);
136			}
137			}
138

thunderer / Shortcode

GitHub Access Token became invalid

Pull Request — master (#32)

ShortcodeTest::testProcessedShortcodeParents() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like