Switch to sirbrillig/phpcs-variable-analysis

[GaryJones]

Introduces a new dependency of sirbrillig/phpcs-variable-analysis which is a more maintained version of the existing VariableAnalysis sniff in VIPCS.

The new sniff is added to the WordPressVIPMinimum ruleset. WordPress-VIP-Go ruleset inherits this, and maintains its dropping of the severity for UnusedVariable and UndefinedVariable violations.

The ruleset tests have set the previously undefined variables (or changed some variable names), so that violations on each line are still specific to the thing being tested, and doesn't include extra violations due to the use of throwaway variables.

One of the reasons for changing was the previously false positive with respect to the use of $this inside closures inside class methods. A ruleset test has been added to cover this, and it correctly does not get flagged in the ruleset test.

The old VariableAnalysis has been marked as deprecated, until it can be removed in the next major release of VIPCS. This will stop any breakage of setups which reference WordPressVIPMinimum.Variables.VariableAnalysis in a custom ruleset. If called, it throws a warning, and then passes control to the new VariableAnalysis sniff. The deprecation notice is excluded if the sniff is not explicitly included, and the duplicate violation messages are also silenced.

The previously used VariableAnalaysisHelper.php has been removed completely, as no-one should have been referencing that directly.

Fixes #449.

[david-binda]

I added the custom fork of the upstream repository to VIPCS due to backward compatibility, as we have been on old version of PHPCS and WPCS for a long time.

That said, if we can switch to the upstream repository now, let's do it!

I haven't really tested this change, but can see that the tests have been adjusted. So as long as those are all still passing,

One question, tho. WordPressVIPMinimum.Variables.VariableAnalysis.UndefinedVariable becomes VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable. Is there a way to create an "alias", so this won't break the // phpcs:ignore WordPressVIPMinimum.Variables.VariableAnalysis.UndefinedVariable comments?

N/A

[GaryJones]

Is there a way to create an "alias", so this won't break the // phpcs:ignore WordPressVIPMinimum.Variables.VariableAnalysis.UndefinedVariable comments?

Not as far as I know. The deprecation handles references in custom rulesets, but not ignore / disable references.

[GaryJones]

Noting that VA 2.6.3+ requires PHP 5.6, so a composer install may need to ignore platform requirements to be able to test PHP 5.4 and PHP 5.5.

[GaryJones]

Refactored and fixed up tests and updated to use VA ^2.8.2. Currently failing on PHP 5.4 and PHP 5.5 Travis jobs.

I tested ignoring platform requirements so that VA could be installed on PHP 5.4 and 5.5, but a) it fails due to the PHP 5.6+ code in VA, and b) ignoring platform requirements make no sense when this is a non-dev dependency.

I suspect my comment isn't going to result in VA moving back to PHP 5.4 due to the code in it, so we'll have to bump the minimum PHP for VIPCS back up (having only just dropped it) to PHP 5.6.

[GaryJones]

Before merging, we should check the changes here against the proposals made in #449, or at least open a follow-up PR which the extra changes, within the same release.

[sirbrillig]

I suspect my comment isn't going to result in VA moving back to PHP 5.4 due to the code in it, so we'll have to bump the minimum PHP for VIPCS back up (having only just dropped it) to PHP 5.6.

Surprise! 😁 sirbrillig/phpcs-variable-analysis#191

I'll still need to backport it to the 2.x branch though. Coming soon...

[sirbrillig]

https://github.com/sirbrillig/phpcs-variable-analysis/releases/tag/v2.8.3 👍

[GaryJones]

@sirbrillig You are a wonderful human - thank you!