[META] Finalizing PHPCS 2.x support

[mbabker]

Extracted from #109 (comment)

• In the ruleset.xml there are some pear rules with adjusted messages that we either need to accept messages reporting spaces or will need to create custom copies to properly report the number of tabs.

• Fix ControlStructuresBrackets sniff issues with the unitTests.

• Testing against the CMS needs a custom ruleset as a custom standard to mute some errors. The readme has some explanations for adjustments. An example xml file should be included. I also can provide an xml example (code in previous comment way back) and another xml example for projects that have php5.4+ requirements like the Joomla-stats repo (xml code in previous comment just above)

• Review what our custom sniffs are based on for changes in PHPCS 2.7.x that need to be adopted into our custom sniffs.

• review for consistency with the old ruleset warnings/errors from phpcs 1.5.x (after the automatic fixers and manual fixes the 1.5.x ruleset should not throw any warnings/errors due to the code style phpcs 2.7.x version being applied. (I've been occasionally running against the CMS admin components for this check, I've only completed PR's for 3 or 4 components)

• Merge coding standards manual to phpcs-2 branch

[photodude]

• consider/implement [Proposal] Code standards change to implement psr-2 multiline class params for more readability [Proposal] Code standards change for more readability joomla-cms#13438

[photodude]

@mbabker where do you think the example xml files for selectively applying rules should live in the repo?

Added in ExampleRulesets via #152

[photodude]

• Add composer instructions
  • see [PHPCS2] change install information to composer #154

[photodude]

Just notice this new issue with InstantiateNewClasses fixer as shown in the InstantiateNewClassUnitTest
If we instantiate a New Class as $k = new self(); we end up with $k = new ;
See https://travis-ci.org/photodude/coding-standards/jobs/200657756

InstantiateNewClass issue has been fixed, Thanks @wilsonge

we also have a bunch of Missing @package tag in file comment (Joomla.Commenting.FileComment.MissingPackageTag) issues now being reported as of phpcs 2.7.1+
fixed in #150

[photodude]

As best I can tell the ControlStructuresBrackets sniff issues are related to the section that deals with bracket indenting. https://github.com/joomla/coding-standards/blob/phpcs-2/Joomla/Sniffs/ControlStructures/ControlStructuresBracketsSniff.php#L148-L192

~~Likely in the str_repeat() with tabs~~~

ControlStructuresBrackets sniff issues have been fixed, Thanks @wilsonge

[photodude]

@wilsonge Are you still up for helping to work on these issues so we can move forward with the Alpha release?

This is the Branch I'm working with to try and create a PR to solve these issues.
https://github.com/photodude/coding-standards/tree/patch-2

[photodude]

@rdeutz If your interested, this is the current list of Items to address with the PHPCS2 branch for a public alpha release of the updated standard with autofixers.

[photodude]

@nibra, @810, @vess if you are interested in continuing to follow the path to a public alpha release for the PHPCS2 branch, or contributing to fixing any of the issues in the PHPCS2 version of the standards prior to the alpha release this is issue to follow.

[wilsonge]

I very much am!

[wilsonge]

I've done fixes for the InstantiateNewClasses and the ControlStructuresBrackets for the patch-5 (i made them against patch-2 like you asked - but locally been testing against patch-5 given that was where your unit test was running against that you linked to) branch and then the package tag warning looks correct to me

[photodude]

• fix cs errors in code style custom sniffs
  fixed in [PHPCS2] apply code style fixes #150

[photodude]

added a number of fixes see

• [PHPCS2] add example XML files showing selectively applying the standard  #152 for Testing against the CMS needs a custom ruleset
• [PHPCS2] fix file vs class reporting of errors #151 fix for a newly found bug with how docblock tags are reported
• [PHPCS2] apply code style fixes #150 fix for code style issues