Add whitelist_patterns option to Phpcs task

[mgeoffray]

Q	A
Branch	master for features and deprecations
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes/no
Documented?	yes
Fixed tickets	#158

This PR add a new whitelist_patternsoption to Phpcs task. It will be used to filter files to be validated.

Example for a Symfony, validate PHP files only in src/ directory

phpcs:
    standard: "./vendor/leaphub/phpcs-symfony2-standard/leaphub/phpcs/Symfony2/"
    show_warnings: true
    whitelist_patterns: ["^src/(.*)"]
    triggered_by: [php]

[veewee]

Shouldn't both the whitelist as the extensions filter be applied?
This can be done in 2 methods instead of adding the extensions with the getWhitelistPathPattern method.

[veewee]

Thanks for the PR. Could you add some tests for this feature?

[mgeoffray]

Hi @veewee,
no problem I will take a look this weekend.

Is the option name whitelist_path_pattern is fine for you? I was not very inspired at the moment.

Thank you for your feedback.

[veewee]

It looks good. Alternatives are include_patterns, whitelist_pattern, ...
Maybe it should also work like the ignore patterns so that you can provide multiple paths that are whitelisted?

[mgeoffray]

I change parameter name to whitelist_patterns and make it usable as a regex array

[veewee]

It looks pretty good but I would still like to get rid of the escapePatternDirectorySeparator() method.
I also think its better to run the extensions() filter separate from the paths() filter. This way the extension filter won't break when someone enters a bad regex.
Can you also resolve the conflicts and fix the Continious Integration?

[mgeoffray]

Hi @veewee sorry for the late answer, I will take a look this week at your return.
Thanks

[veewee]

@mgeoffray Are you planning to finish this PR any time soon? Thanks!

[mgeoffray]

@veewee Yes sorry too much work beside, I prioritized it to correct your return quickly ;)

[veewee]

No problem! Thanks :)

[j3rrey]

Is anyone taking care of this ?

[veewee]

@jeremy-bruns, @mgeoffray is taking care of this. Currently he is busy so this new feature is on a hold. Feel free to contact him, maybe you can take care of this for him.

[mgeoffray]

@jeremy-bruns Hi, yes I plan to watch it from the beginning of next week on Monday or Tuesday maximum. I will keep you in touch!

[mgeoffray]

I worked on it this week I think I can deliver the fix this weekend ;)

[mgeoffray]

Hi @veewee,
someone is looking for your return today so I will keep you in touch quickly.
Again sorry for processing delay

[mgeoffray]

Hi @veewee,
we have just finished to process your return let me know if that is all good for you ! ;)

[veewee]

Thanks for your work. I've added some litlte remarks.

[veewee]

This code is almost the same as the regular path() method. Can you let the path() method use the paths() method instead of duplicating the code?

There should also be a spec test for this new feature.
Note that we are moving away from the old array() syntax and are using the new short array syntax instead. Can you replace that one?

[mgeoffray]

@veewee Yes you are right I refactor the path() function to call paths()
I forgot this one array, I have changed it.
What do you mean spec test, a new function testing it or just add the new line in \spec\GrumPHP\Task\PhpcsSpec::it_should_have_configurable_options ?

[veewee]

Indeed, the configurable options spec from the task should also contain the new option. The last commit is good.
I was talking about the GrumPHP/Collection/FilesCollectionSpec that should contain a new test for the new paths method. Can you add this one?

[mgeoffray]

Hi @veewee,
I have just added the function for paths() Spec test

[veewee]

It looks good, thanks!
I'll merge it in somewhere next week when the nightly build is fixed. This has nothing to do with this code, so you don't have to do any additional work on this PR.

[mgeoffray]

@veewee OK great ! Thanks :)