Skip to content

Commit

Permalink
Tokenizer - remove deprecations and legacy mode
Browse files Browse the repository at this point in the history
  • Loading branch information
@keradus
keradus committed Jan 4, 2018
1 parent 3a2402f commit 428b50a
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 310 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
View file
Expand Up @@ -69,7 +69,7 @@ jobs:
<<: *STANDARD_TEST_JOB
stage: Test
php: 7.1
env: SYMFONY_DEPRECATIONS_HELPER=weak PHP_CS_FIXER_TEST_USE_LEGACY_TOKENIZER=1 SYMFONY_VERSION="^4.0" MIN_STABILITY=dev
env: SYMFONY_DEPRECATIONS_HELPER=weak SYMFONY_VERSION="^4.0" MIN_STABILITY=dev

-
<<: *STANDARD_TEST_JOB
Expand Down
1 change: 0 additions & 1 deletion phpunit.xml.dist
View file
Expand Up @@ -49,6 +49,5 @@
<ini name="zend.enable_gc" value="0"/>
<ini name="memory_limit" value="1G"/>
<env name="SKIP_LINT_TEST_CASES" value="0"/>
<env name="PHP_CS_FIXER_TEST_USE_LEGACY_TOKENIZER" value="0"/>
</php>
</phpunit>
2 changes: 0 additions & 2 deletions src/Runner/Runner.php
View file
Expand Up @@ -164,8 +164,6 @@ private function fixFile(\SplFileInfo $file, LintingResultInterface $lintingResu
}

$old = file_get_contents($file->getRealPath());

Tokens::setLegacyMode(false);
$tokens = Tokens::fromCode($old);
$oldHash = $tokens->getCodeHash();

Expand Down
118 changes: 0 additions & 118 deletions src/Tokenizer/Token.php
View file
Expand Up @@ -114,36 +114,6 @@ public static function getClassyTokenKinds()
return $classTokens;
}

/**
* Clear token at given index.
*
* Clearing means override token by empty string.
*
* @deprecated since 2.4
*/
public function clear()
{
@trigger_error(__METHOD__.' is deprecated and will be removed in 3.0.', E_USER_DEPRECATED);
Tokens::setLegacyMode(true);

$this->content = '';
$this->id = null;
$this->isArray = false;
}

/**
* Clear internal flag if token was changed.
*
* @deprecated since 2.4
*/
public function clearChanged()
{
@trigger_error(__METHOD__.' is deprecated and will be removed in 3.0.', E_USER_DEPRECATED);
Tokens::setLegacyMode(true);

$this->changed = false;
}

/**
* Check if token is equals to given one.
*
Expand Down Expand Up @@ -371,20 +341,6 @@ public function isCast()
return $this->isGivenKind(self::getCastTokenKinds());
}

/**
* Check if token was changed.
*
* @return bool
*
* @deprecated since 2.4
*/
public function isChanged()
{
@trigger_error(__METHOD__.' is deprecated and will be removed in 3.0.', E_USER_DEPRECATED);

return $this->changed;
}

/**
* Check if token is one of classy tokens: T_CLASS, T_INTERFACE or T_TRAIT.
*
Expand All @@ -407,20 +363,6 @@ public function isComment()
return $this->isGivenKind($commentTokens);
}

/**
* Check if token is empty, e.g. because of clearing.
*
* @return bool
*
* @deprecated since 2.4
*/
public function isEmpty()
{
@trigger_error(__METHOD__.' is deprecated and will be removed in 3.0.', E_USER_DEPRECATED);

return null === $this->id && ('' === $this->content || null === $this->content);
}

/**
* Check if token is one of given kind.
*
Expand Down Expand Up @@ -491,66 +433,6 @@ public function isWhitespace($whitespaces = " \t\n\r\0\x0B")
return '' === trim($this->content, $whitespaces);
}

/**
* Override token.
*
* If called on Token inside Tokens collection please use `Tokens::overrideAt` instead.
*
* @param array|string|Token $other token prototype
*
* @deprecated since 2.4
*/
public function override($other)
{
@trigger_error(__METHOD__.' is deprecated and will be removed in 3.0.', E_USER_DEPRECATED);
Tokens::setLegacyMode(true);

$prototype = $other instanceof self ? $other->getPrototype() : $other;

if ($this->equals($prototype)) {
return;
}

$this->changed = true;

if (is_array($prototype)) {
$this->isArray = true;
$this->id = $prototype[0];
$this->content = $prototype[1];

return;
}

$this->isArray = false;
$this->id = null;
$this->content = $prototype;
}

/**
* @param string $content
*
* @deprecated since 2.4
*/
public function setContent($content)
{
@trigger_error(__METHOD__.' is deprecated and will be removed in 3.0.', E_USER_DEPRECATED);
Tokens::setLegacyMode(true);

if ($this->content === $content) {
return;
}

$this->changed = true;
$this->content = $content;

// setting empty content is clearing the token
if ('' === $content) {
@trigger_error(__METHOD__.' shall not be used to clear token, use Tokens::clearAt instead.', E_USER_DEPRECATED);
$this->id = null;
$this->isArray = false;
}
}

public function toArray()
{
return [
Expand Down
111 changes: 10 additions & 101 deletions src/Tokenizer/Tokens.php
View file
Expand Up @@ -80,13 +80,6 @@ class Tokens extends \SplFixedArray
*/
private $foundTokenKinds = [];

/**
* @var bool
*
* @todo remove at 3.0
*/
private static $isLegacyMode = false;

/**
* Clone tokens collection.
*/
Expand All @@ -97,34 +90,6 @@ public function __clone()
}
}

/**
* @return bool
*
* @internal
*
* @todo remove at 3.0
*/
public static function isLegacyMode()
{
return self::$isLegacyMode;
}

/**
* @param bool $isLegacy
*
* @internal
*
* @todo remove at 3.0
*/
public static function setLegacyMode($isLegacy)
{
if (getenv('PHP_CS_FIXER_FUTURE_MODE') && $isLegacy) {
throw new \RuntimeException('Cannot enable `legacy mode` when using `future mode`. This check was performed as `PHP_CS_FIXER_FUTURE_MODE` env var is set.');
}

self::$isLegacyMode = $isLegacy;
}

/**
* Clear cache - one position or all of them.
*
Expand Down Expand Up @@ -328,12 +293,6 @@ public function offsetSet($index, $newval)
public function clearChanged()
{
$this->changed = false;

if (self::isLegacyMode()) {
foreach ($this as $token) {
$token->clearChanged();
}
}
}

/**
Expand Down Expand Up @@ -446,7 +405,7 @@ public function findBlockEnd($type, $searchIndex, $findEnd = true)
throw new \InvalidArgumentException(sprintf('Invalid param type: %s.', $type));
}

if (!self::isLegacyMode() && isset($this->blockEndCache[$searchIndex])) {
if (isset($this->blockEndCache[$searchIndex])) {
return $this->blockEndCache[$searchIndex];
}

Expand Down Expand Up @@ -519,11 +478,9 @@ public function findGivenKind($possibleKind, $start = 0, $end = null)
$elements[$kind] = [];
}

if (!self::isLegacyMode()) {
$possibleKinds = array_filter($possibleKinds, function ($kind) {
return $this->isTokenKindFound($kind);
});
}
$possibleKinds = array_filter($possibleKinds, function ($kind) {
return $this->isTokenKindFound($kind);
});

if (count($possibleKinds)) {
for ($i = $start; $i < $end; ++$i) {
Expand Down Expand Up @@ -676,11 +633,9 @@ public function getPrevTokenOfKind($index, array $tokens = [], $caseSensitive =
*/
public function getTokenOfKindSibling($index, $direction, array $tokens = [], $caseSensitive = true)
{
if (!self::isLegacyMode()) {
$tokens = array_filter($tokens, function ($token) {
return $this->isTokenKindFound($this->extractTokenKind($token));
});
}
$tokens = array_filter($tokens, function ($token) {
return $this->isTokenKindFound($this->extractTokenKind($token));
});

if (!count($tokens)) {
return null;
Expand Down Expand Up @@ -838,11 +793,9 @@ public function findSequence(array $sequence, $start = 0, $end = null, $caseSens
}
}

if (!self::isLegacyMode()) {
foreach ($sequence as $token) {
if (!$this->isTokenKindFound($this->extractTokenKind($token))) {
return null;
}
foreach ($sequence as $token) {
if (!$this->isTokenKindFound($this->extractTokenKind($token))) {
return null;
}
}

Expand Down Expand Up @@ -938,14 +891,6 @@ public function isChanged()
return true;
}

if (self::isLegacyMode()) {
foreach ($this as $token) {
if ($token->isChanged()) {
return true;
}
}
}

return false;
}

Expand All @@ -966,23 +911,6 @@ public function clearAt($index)
$this[$index] = new Token('');
}

/**
* Override token at given index and register it.
*
* @param int $index
* @param array|string|Token $token token prototype
*
* @deprecated since 2.4, use offsetSet instead
*/
public function overrideAt($index, $token)
{
@trigger_error(__METHOD__.' is deprecated and will be removed in 3.0, use offsetSet instead.', E_USER_DEPRECATED);
self::$isLegacyMode = true;

$this[$index]->override($token);
$this->registerFoundToken($token);
}

/**
* Override tokens at given range.
*
Expand Down Expand Up @@ -1165,10 +1093,6 @@ public function isTokenKindFound($tokenKind)
*/
public function countTokenKind($tokenKind)
{
if (self::isLegacyMode()) {
throw new \RuntimeException(sprintf('%s is not available in legacy mode.', __METHOD__));
}

return isset($this->foundTokenKinds[$tokenKind]) ? $this->foundTokenKinds[$tokenKind] : 0;
}

Expand Down Expand Up @@ -1201,21 +1125,6 @@ public function isMonolithicPhp()
return false;
}

if (self::isLegacyMode()) {
// If code is not monolithic there is a great chance that first or last token is `T_INLINE_HTML`:
if ($this[0]->isGivenKind(T_INLINE_HTML) || $this[$size - 1]->isGivenKind(T_INLINE_HTML)) {
return false;
}

for ($index = 1; $index < $size; ++$index) {
if ($this[$index]->isGivenKind([T_INLINE_HTML, T_OPEN_TAG, T_OPEN_TAG_WITH_ECHO])) {
return false;
}
}

return true;
}

if ($this->isTokenKindFound(T_INLINE_HTML)) {
return false;
}
Expand Down
13 changes: 0 additions & 13 deletions tests/Test/AbstractFixerTestCase.php
View file
Expand Up @@ -55,19 +55,6 @@ protected function setUp()

$this->linter = $this->getLinter();
$this->fixer = $this->createFixer();

// @todo remove at 3.0 together with env var itself
if (getenv('PHP_CS_FIXER_TEST_USE_LEGACY_TOKENIZER')) {
Tokens::setLegacyMode(true);
}
}

protected function tearDown()
{
parent::tearDown();

// @todo remove at 3.0
Tokens::setLegacyMode(false);
}

/**
Expand Down
13 changes: 0 additions & 13 deletions tests/Test/AbstractIntegrationTestCase.php
View file
Expand Up @@ -105,19 +105,6 @@ protected function setUp()
parent::setUp();

$this->linter = $this->getLinter();

// @todo remove at 3.0 together with env var itself
if (getenv('PHP_CS_FIXER_TEST_USE_LEGACY_TOKENIZER')) {
Tokens::setLegacyMode(true);
}
}

protected function tearDown()
{
parent::tearDown();

// @todo remove at 3.0
Tokens::setLegacyMode(false);
}

/**
Expand Down

0 comments on commit 428b50a

Please sign in to comment.