Tokenizer::createToken() - Code Metrics - Inspection of "Simplified clean and fix functions for elements." - kevintweber/Groundskeeper - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 817727...d8e3ee )

by Kevin

created 2016-05-14 00:46 UTC

Tokenizer::createToken() B

↳ Parent: Tokenizer

Complexity

Conditions	6
Paths	6

Size

Total Lines	36
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	29
CRAP Score	6

Importance

Changes	5
Bugs	2	Features	1

Metric	Value
c	5
b	2
f	1
dl	0
loc	36
ccs	29
cts	29
cp	1
rs	8.439
cc	6
eloc	23
nc	6
nop	1
crap	6

<?php

namespace Groundskeeper\Tokens;

use Groundskeeper\Configuration;
use Kevintweber\HtmlTokenizer\HtmlTokenizer;
use Kevintweber\HtmlTokenizer\Tokens\Element as BasicElement;
use Kevintweber\HtmlTokenizer\Tokens\Token as BasicToken;

class Tokenizer
{
    /** @var Configuration */
    private $configuration;

    /**
     * Constructor
     */
    public function __construct(Configuration $configuration)
    {
        $this->configuration = $configuration;
    }

    public function tokenize($html)
    {
        $tokenizer = new HtmlTokenizer(false);
        $basicTokenCollection = $tokenizer->parse((string) $html);

        $tokenContainer = new TokenContainer($this->configuration);
        foreach ($basicTokenCollection as $basicToken) {
            $tokenContainer->appendChild($this->createToken($basicToken));
        }

        return $tokenContainer;
    }

    private function createToken(BasicToken $basicToken)
    {
        switch ($basicToken->getType()) {
        case 'cdata':
            return new CData(
                $this->configuration,
                $basicToken->getValue()
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.
    }
}
            );

        case 'comment':
            return new Comment(
                $this->configuration,
                $basicToken->getValue()
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.
    }
}
            );

        case 'doctype':
            return new DocType(
                $this->configuration,
                $basicToken->getValue()
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.
    }
}
            );

        case 'php':
            return new Php(
                $this->configuration,
                $basicToken->getValue()
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.
    }
}
            );

        case 'text':
            return new Text(
                $this->configuration,
                $basicToken->getValue()
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.
    }
}
            );
        }

        return $this->createElement($basicToken);

    }

    private function createElement(BasicElement $basicElement)
    {
        // Primary class name.
        $elementClassName = 'Groundskeeper\\Tokens\\Elements\\' .
            ucfirst(strtolower($basicElement->getName()));
        if (!class_exists($elementClassName)) {
            // Secondary class name.
            // For elements whose names conflict with PHP keywords: var
            $elementClassName = 'Groundskeeper\\Tokens\\Elements\\' .
                ucfirst(strtolower($basicElement->getName())) . 'Element';
            if (!class_exists($elementClassName)) {
                $elementClassName = 'Groundskeeper\\Tokens\\Element';
            }
        }

        $cleanableElement = new $elementClassName(
            $this->configuration,
            $basicElement->getName(),
            $basicElement->getAttributes()
        );

        foreach ($basicElement->getChildren() as $basicChild) {
            $cleanableElement->appendChild(
                $this->createToken($basicChild)
            );
        }

        return $cleanableElement;
    }
}


1		<?php
2
3		namespace Groundskeeper\Tokens;
4
5		use Groundskeeper\Configuration;
6		use Kevintweber\HtmlTokenizer\HtmlTokenizer;
7		use Kevintweber\HtmlTokenizer\Tokens\Element as BasicElement;
8		use Kevintweber\HtmlTokenizer\Tokens\Token as BasicToken;
9
10		class Tokenizer
11		{
12		/** @var Configuration */
13		private $configuration;
14
15		/**
16		* Constructor
17		*/
18	92	public function __construct(Configuration $configuration)
19		{
20	92	$this->configuration = $configuration;
21	92	}
22
23	92	public function tokenize($html)
24		{
25	92	$tokenizer = new HtmlTokenizer(false);
26	92	$basicTokenCollection = $tokenizer->parse((string) $html);
27
28	92	$tokenContainer = new TokenContainer($this->configuration);
29	92	foreach ($basicTokenCollection as $basicToken) {
30	92	$tokenContainer->appendChild($this->createToken($basicToken));
31	92	}
32
33	92	return $tokenContainer;
34		}
35
36	92	private function createToken(BasicToken $basicToken)
37		{
38	92	switch ($basicToken->getType()) {
39	92	case 'cdata':
40	3	return new CData(
41	3	$this->configuration,
42	3	$basicToken->getValue()
		0 ignored issues – show Bug introduced 2016-05-07 19:28 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Kevintweber\HtmlTokenizer\Tokens\Token` as the method `getValue()` does only exist in the following implementations of said interface: `Kevintweber\HtmlTokenizer\Tokens\CData`, `Kevintweber\HtmlTokenizer\Tokens\Comment`, `Kevintweber\HtmlTokenizer\Tokens\DocType`, `Kevintweber\HtmlTokenizer\Tokens\Php`, `Kevintweber\HtmlTokenizer\Tokens\Text`. 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...
43	3	);
44
45	90	case 'comment':
46	17	return new Comment(
47	17	$this->configuration,
48	17	$basicToken->getValue()
		0 ignored issues – show Bug introduced 2016-05-07 19:28 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Kevintweber\HtmlTokenizer\Tokens\Token` as the method `getValue()` does only exist in the following implementations of said interface: `Kevintweber\HtmlTokenizer\Tokens\CData`, `Kevintweber\HtmlTokenizer\Tokens\Comment`, `Kevintweber\HtmlTokenizer\Tokens\DocType`, `Kevintweber\HtmlTokenizer\Tokens\Php`, `Kevintweber\HtmlTokenizer\Tokens\Text`. 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...
49	17	);
50
51	88	case 'doctype':
52	3	return new DocType(
53	3	$this->configuration,
54	3	$basicToken->getValue()
		0 ignored issues – show Bug introduced 2016-05-07 19:28 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Kevintweber\HtmlTokenizer\Tokens\Token` as the method `getValue()` does only exist in the following implementations of said interface: `Kevintweber\HtmlTokenizer\Tokens\CData`, `Kevintweber\HtmlTokenizer\Tokens\Comment`, `Kevintweber\HtmlTokenizer\Tokens\DocType`, `Kevintweber\HtmlTokenizer\Tokens\Php`, `Kevintweber\HtmlTokenizer\Tokens\Text`. 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...
55	3	);
56
57	86	case 'php':
58	1	return new Php(
59	1	$this->configuration,
60	1	$basicToken->getValue()
		0 ignored issues – show Bug introduced 2016-05-07 19:28 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Kevintweber\HtmlTokenizer\Tokens\Token` as the method `getValue()` does only exist in the following implementations of said interface: `Kevintweber\HtmlTokenizer\Tokens\CData`, `Kevintweber\HtmlTokenizer\Tokens\Comment`, `Kevintweber\HtmlTokenizer\Tokens\DocType`, `Kevintweber\HtmlTokenizer\Tokens\Php`, `Kevintweber\HtmlTokenizer\Tokens\Text`. 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...
61	1	);
62
63	86	case 'text':
64	76	return new Text(
65	76	$this->configuration,
66	76	$basicToken->getValue()
		0 ignored issues – show Bug introduced 2016-05-07 19:28 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Kevintweber\HtmlTokenizer\Tokens\Token` as the method `getValue()` does only exist in the following implementations of said interface: `Kevintweber\HtmlTokenizer\Tokens\CData`, `Kevintweber\HtmlTokenizer\Tokens\Comment`, `Kevintweber\HtmlTokenizer\Tokens\DocType`, `Kevintweber\HtmlTokenizer\Tokens\Php`, `Kevintweber\HtmlTokenizer\Tokens\Text`. 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...
67	76	);
68	84	}
69
70	84	return $this->createElement($basicToken);
		0 ignored issues – show Compatibility introduced 2016-04-23 02:08 UTC by Report Bug Copy Issue Report `$basicToken` of type `object<Kevintweber\HtmlTokenizer\Tokens\Token>` is not a sub-type of `object<Kevintweber\HtmlTokenizer\Tokens\Element>`. It seems like you assume a concrete implementation of the interface `Kevintweber\HtmlTokenizer\Tokens\Token` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
71		}
72
73	84	private function createElement(BasicElement $basicElement)
74		{
75		// Primary class name.
76		$elementClassName = 'Groundskeeper\\Tokens\\Elements\\' .
77	84	ucfirst(strtolower($basicElement->getName()));
78	84	if (!class_exists($elementClassName)) {
79		// Secondary class name.
80		// For elements whose names conflict with PHP keywords: var
81		$elementClassName = 'Groundskeeper\\Tokens\\Elements\\' .
82	7	ucfirst(strtolower($basicElement->getName())) . 'Element';
83	7	if (!class_exists($elementClassName)) {
84	7	$elementClassName = 'Groundskeeper\\Tokens\\Element';
85	7	}
86	7	}
87
88	84	$cleanableElement = new $elementClassName(
89	84	$this->configuration,
90	84	$basicElement->getName(),
91	84	$basicElement->getAttributes()
92	84	);
93
94	84	foreach ($basicElement->getChildren() as $basicChild) {
95	82	$cleanableElement->appendChild(
96	82	$this->createToken($basicChild)
97	82	);
98	84	}
99
100	84	return $cleanableElement;
101		}
102		}
103

kevintweber / Groundskeeper

Push — master ( 817727...d8e3ee )

Tokenizer::createToken() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like