Token::isEnd() - Code Metrics - Inspection of "Tests" - kadet1090/KeyLighter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — 0.8-dev (5d9532)

by Kacper

created 2016-04-06 19:23 UTC

Token::isEnd() A

↳ Parent: Token

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
c	3
b	0
f	0
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php
/**
 * Highlighter
 *
 * Copyright (C) 2016, Some right reserved.
 *
 * @author Kacper "Kadet" Donat <[email protected]>
 *
 * Contact with author:
 * Xmpp: [email protected]
 * E-mail: [email protected]
 *
 * From Kadet with love.
 */

namespace Kadet\Highlighter\Parser\Token;

use Kadet\Highlighter\Language\Language;
use Kadet\Highlighter\Parser\Context;
use Kadet\Highlighter\Parser\Result;
use Kadet\Highlighter\Parser\Rule;
use Kadet\Highlighter\Parser\TokenIterator;
use Kadet\Highlighter\Parser\Validator\Validator;
use Kadet\Highlighter\Utils\Helper;

class Token
{
    const NAME  = null;
    const START = 0x1;
    const END   = 0x2;

    protected static $_id = 0;

    public $pos;
    public $name;
    public $index = 1;
    public $id;
    public $rule;

    # region >>> cache
    /**
     * @var static|null|false
     */
    protected $_end;

    /**
     * @var static|null|false
     */
    protected $_start;

    protected $_valid;
    protected $_length;
    # endregion

    /**
     * Token constructor.
     *
     * @param null  $name
     * @param array $options
     */
    public function __construct($name = null, array $options = [])
    {
        $this->name     = $name;

        if (isset($options['pos'])) {
            $this->pos = $options['pos'];
        }

        if (isset($options['index'])) {
            $this->index = $options['index'];
        }

        $this->rule = isset($options['rule']) ? $options['rule'] : new Rule();

        $this->id = ++self::$_id;
    }

    public function isStart()
    {
        return $this->_start === null;
    }

    public function isEnd()
    {
        return $this->_end === null;
    }

     public function isValid(Context $context)
    {
        if ($this->_valid === null) {
            $this->validate($context);
        }

        return $this->_valid;
    }

    protected function validate(Context $context)
    {
        $this->setValid(
            $context->language === $this->rule->language &&
            $this->rule->validator->validate($context, $this->isEnd() ? [$this->name => Validator::CONTEXT_IN] : [])
        );
    }

    public function setValid($valid = true)
    {
        $this->_valid = $valid;

        if ($this->_end) {
            $this->_end->_valid = $this->_valid;
        } elseif ($this->_start) {
            $this->_start->_valid = $this->_valid;
        }
    }

    /**
     * @return Token|null|false
     */
    public function getStart()
    {
        return $this->_start;
    }

    /**
     * @param Token|null|false $start
     */
    public function setStart($start = null)
    {
        $this->_end   = null;
        $this->_start = $start;

        if ($start instanceof Token) {
            $this->_start->_length = null;
            $start->_end = $this;
        }
    }

    /**
     * @return Token|null|false
     */
    public function getEnd()
    {
        return $this->_end;
    }

    /**
     * @param Token|null|false $end
     */
    public function setEnd($end = null)
    {
        $this->_start  = null;
        $this->_end    = $end;
        $this->_length = null;

        if ($end instanceof Token) {
            $end->_start = $this;
        }
    }

    public function getLength()
    {
        if ($this->_length === null) {
            $this->_length = !$this->_end ? 0 : $this->_end->pos - $this->pos;
        }

        return $this->_length;
    }

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

    /**
     * @param Context       $context
     * @param Language      $language
     * @param Result        $result
     * @param TokenIterator $tokens
     *
     * todo: Documentation
     *
     * @return bool Return true to continue processing, false to return already processed tokens.
     */
    public function process(Context $context, Language $language, Result $result, TokenIterator $tokens) {
        if(!$this->isValid($context)) {
            return true;
        }

        return $this->isStart() ?
            $this->processStart($context, $language, $result, $tokens) :
            $this->processEnd($context, $language, $result, $tokens);
    }

    protected function processStart(Context $context, Language $language, Result $result, TokenIterator $tokens) {

        $result->append($this);
        $context->push($this);

        return true;
    }

    protected function processEnd(Context $context, Language $language, Result $result, TokenIterator $tokens) {

        if($this->_start) {
            $context->pop($this->_start);
        } else {
            if (($start = $context->find($this->name)) !== false) {
                $this->setStart($tokens[$start]);

                unset($context->stack[$start]);
            }
        }

        if (!$this->_start instanceof MetaToken) {
            $result->append($this);
        }

        return true;
    }

    public static function compare(Token $a, Token $b)
    {
        $multiplier = $a->isEnd() ? -1 : 1;

        if (($a->isStart() && $b->isEnd()) || ($a->isEnd() && $b->isStart())) {
            if ($a->getStart() == $b) {
                return 1;
            } elseif ($a->getEnd() == $b) {
                return -1;
            } else {
                return $multiplier;
            }
        } elseif (($rule = Helper::cmp($b->rule->priority, $a->rule->priority)) !== 0) {
            return $multiplier*$rule;
        } elseif (($rule = Helper::cmp($b->index, $a->index)) !== 0) {
            return $multiplier*$rule;
        } else {
            return $multiplier*($a->id < $b->id ? -1 : 1);
        }
    }
}


1			<?php
2			/**
3			* Highlighter
4			*
5			* Copyright (C) 2016, Some right reserved.
6			*
7			* @author Kacper "Kadet" Donat <[email protected]>
8			*
9			* Contact with author:
10			* Xmpp: [email protected]
11			* E-mail: [email protected]
12			*
13			* From Kadet with love.
14			*/
15
16			namespace Kadet\Highlighter\Parser\Token;
17
18			use Kadet\Highlighter\Language\Language;
19			use Kadet\Highlighter\Parser\Context;
20			use Kadet\Highlighter\Parser\Result;
21			use Kadet\Highlighter\Parser\Rule;
22			use Kadet\Highlighter\Parser\TokenIterator;
23			use Kadet\Highlighter\Parser\Validator\Validator;
24			use Kadet\Highlighter\Utils\Helper;
25
26			class Token
27			{
28			const NAME = null;
29			const START = 0x1;
30			const END = 0x2;
31
32			protected static $_id = 0;
33
34			public $pos;
35			public $name;
36			public $index = 1;
37			public $id;
38			public $rule;
39
40			# region >>> cache
41			/**
42			* @var static\|null\|false
43			*/
44			protected $_end;
45
46			/**
47			* @var static\|null\|false
48			*/
49			protected $_start;
50
51			protected $_valid;
52			protected $_length;
53			# endregion
54
55			/**
56			* Token constructor.
57			*
58			* @param null $name
59			* @param array $options
60			*/
61	48		public function __construct($name = null, array $options = [])
62			{
63	48		$this->name = $name;
64
65	48		if (isset($options['pos'])) {
66	45		$this->pos = $options['pos'];
67	45		}
68
69	48		if (isset($options['index'])) {
70	33		$this->index = $options['index'];
71	6		}
72
73	48		$this->rule = isset($options['rule']) ? $options['rule'] : new Rule();
74
75	48		$this->id = ++self::$_id;
76	48		}
77
78	33		public function isStart()
79			{
80	33		return $this->_start === null;
81			}
82
83	31		public function isEnd()
84			{
85	31		return $this->_end === null;
86			}
87
88	14		public function isValid(Context $context)
89			{
90	14		if ($this->_valid === null) {
91	13		$this->validate($context);
92	13		}
93
94	14		return $this->_valid;
95			}
96
97	11		protected function validate(Context $context)
98			{
99	11		$this->setValid(
100	11		$context->language === $this->rule->language &&
101	11		$this->rule->validator->validate($context, $this->isEnd() ? [$this->name => Validator::CONTEXT_IN] : [])
102	11		);
103	11		}
104
105	14		public function setValid($valid = true)
106			{
107	14		$this->_valid = $valid;
108
109	14		if ($this->_end) {
110	11		$this->_end->_valid = $this->_valid;
111	14		} elseif ($this->_start) {
112	12		$this->_start->_valid = $this->_valid;
113	12		}
114	14		}
115
116			/**
117			* @return Token\|null\|false
118			*/
119	29		public function getStart()
120			{
121	29		return $this->_start;
122			}
123
124			/**
125			* @param Token\|null\|false $start
126			*/
127	11	View Code Duplication	public function setStart($start = null)
128			{
129	11		$this->_end = null;
130	11		$this->_start = $start;
131
132	11		if ($start instanceof Token) {
133	11		$this->_start->_length = null;
134	11		$start->_end = $this;
135	11		}
136	11		}
137
138			/**
139			* @return Token\|null\|false
140			*/
141	38		public function getEnd()
142			{
143	38		return $this->_end;
144			}
145
146			/**
147			* @param Token\|null\|false $end
148			*/
149	46	View Code Duplication	public function setEnd($end = null)
150			{
151	46		$this->_start = null;
152	46		$this->_end = $end;
153	46		$this->_length = null;
154
155	46		if ($end instanceof Token) {
156	46		$end->_start = $this;
157	46		}
158	46		}
159
160	2		public function getLength()
161			{
162	2		if ($this->_length === null) {
163	2		$this->_length = !$this->_end ? 0 : $this->_end->pos - $this->pos;
164	2		}
165
166	2		return $this->_length;
167			}
168
169	11		public function __get($name)
170			{
171	11		return $this->rule->$name;
172			}
173
174			/**
175			* @param Context $context
176			* @param Language $language
177			* @param Result $result
178			* @param TokenIterator $tokens
179			*
180			* todo: Documentation
181			*
182			* @return bool Return true to continue processing, false to return already processed tokens.
183			*/
184	11		public function process(Context $context, Language $language, Result $result, TokenIterator $tokens) {
185	11		if(!$this->isValid($context)) {
186	3		return true;
187			}
188
189	11		return $this->isStart() ?
190	11		$this->processStart($context, $language, $result, $tokens) :
191	11		$this->processEnd($context, $language, $result, $tokens);
192			}
193
194	10		protected function processStart(Context $context, Language $language, Result $result, TokenIterator $tokens) {
			1 ignored issue – show Unused Code introduced 2016-03-29 13:15 UTC by Report Bug Copy Issue Report The parameter `$language` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
195	10		$result->append($this);
196	10		$context->push($this);
197
198	10		return true;
199			}
200
201	9		protected function processEnd(Context $context, Language $language, Result $result, TokenIterator $tokens) {
			1 ignored issue – show Unused Code introduced 2016-03-29 13:15 UTC by Report Bug Copy Issue Report The parameter `$language` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
202	9		if($this->_start) {
203	8		$context->pop($this->_start);
204	8		} else {
205	1		if (($start = $context->find($this->name)) !== false) {
206	1		$this->setStart($tokens[$start]);
207
208	1		unset($context->stack[$start]);
209	1		}
210			}
211
212	9		if (!$this->_start instanceof MetaToken) {
213	9		$result->append($this);
214	9		}
215
216	9		return true;
217			}
218
219	13		public static function compare(Token $a, Token $b)
220			{
221	13		$multiplier = $a->isEnd() ? -1 : 1;
222
223	13		if (($a->isStart() && $b->isEnd()) \|\| ($a->isEnd() && $b->isStart())) {
224	1		if ($a->getStart() == $b) {
225	1		return 1;
226	1		} elseif ($a->getEnd() == $b) {
227			return -1;
228			} else {
229	1		return $multiplier;
230			}
231	12		} elseif (($rule = Helper::cmp($b->rule->priority, $a->rule->priority)) !== 0) {
232	10		return $multiplier*$rule;
233	4		} elseif (($rule = Helper::cmp($b->index, $a->index)) !== 0) {
234	1		return $multiplier*$rule;
235			} else {
236	3		return $multiplier*($a->id < $b->id ? -1 : 1);
237			}
238			}
239			}
240

kadet1090 / KeyLighter

Branch — 0.8-dev (5d9532)

Token::isEnd() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like