Fix `fix` command to handle `--fixers` option when contains extra and excluding fixers #599

fivestar · 2014-09-25T12:18:16Z

Currently, when --fixers option contains extra and excluding mixed filters such as -eol_ending,concat_with_spaces, excluding filter will be enabled, however, extra filter will not be enabled.

This PR fixes this behavior, so enable both type filters when mixed filters given.

sample.php

<?php
echo 'foo'.'bar', PHP_EOL;

Current version: (concat_with_spaces is not enabled)

% php-cs-fixer fix -v --diff --fixers="-eol_ending,concat_with_spaces" --dry-run sample.php   
   1) /home/fivestar/sample.php (eof_ending)
      ---------- begin diff ----------
      --- Original
      +++ New
      @@ @@
       <?php
       echo 'foo'.'bar', PHP_EOL;

      -

      ---------- end diff ----------

Fixed version: (concat_with_spaces is enabled)

% php-cs-fixer fix -v --diff --fixers="-eol_ending,concat_with_spaces" --dry-run sample.php 
   1) /home/fivestar/sample.php (eof_ending, concat_with_spaces)
      ---------- begin diff ----------
      --- Original
      +++ New
      @@ @@
       <?php
      -echo 'foo'.'bar', PHP_EOL;
      -
      +echo 'foo' . 'bar', PHP_EOL;


      ---------- end diff ----------

keradus · 2014-09-25T13:59:24Z

Symfony/CS/Console/FixersResolver.php

+        $this->config = $config;
+    }
+
+    public function resolve($levelOption, $fixersOption)


Really, create extra class and do everything in one, the only one method?

Why create extra class is because to get testability and separate responsibilities.

Cool! but why only one magic method to do all things?

keradus · 2014-09-25T14:03:20Z

Symfony/CS/Console/FixersResolver.php

+ * with this source code in the file LICENSE.
+ */
+
+namespace Symfony\CS\Console;


You use it in console, but it does not do anything with console. It should not be in Console namespace

Certainly this class is not dependent on Console, but this class handles CLI options (especially $filterOption).
Considering the task for this class, so I think this class have to be under the Console namespace.

Where is better? Util\ or else? Tell me what you think!

I would agree if it manipulate only on console inputs. But it handle also Config and Fixer (or only Config, if you changed it) classes.
I would put it into Symfony\CS directry. But that's only my opinion.

keradus · 2014-09-25T14:04:09Z

Symfony/CS/Console/FixersResolver.php

+
+    public function resolve($levelOption, $fixersOption)
+    {
+        $allFixers = $this->fixer->getFixers();


IMO this should be passed into class - the defined Fixers, not Fixer itself.

keradus · 2014-09-25T14:05:35Z

Maybe this is good plase to separate Config::$fixers into two values?
One that handle LEVEL, and second that handle fixers array? Now this props handle both :(

keradus · 2014-09-25T14:06:41Z

Symfony/CS/Console/FixersResolver.php

+        $addNames = [];
+        $removeNames = [];
+        foreach ($names as $name) {
+            if (strpos($name, '-') === 0) {


please use Symfony standards here: 0 === $sth

keradus · 2014-09-25T14:08:46Z

Idea itself looks nice!
It would be great to add info about levels/fixers and mixing them (with excluding/including extra fixers) into readme.
I know that this is not intuitive now.

keradus · 2014-09-25T14:09:02Z

Fix fix command to handle --filter option

--filter? where?

keradus · 2014-09-25T14:10:24Z

Symfony/CS/Console/FixersResolver.php

+
+        // remove/add fixers based on the fixers option
+        $names = array_map('trim', explode(',', $fixersOption));
+        $addNames = [];


crash on php5.2

on PHP 5.3, not on 5.2 (the whole library crashes on 5.2 because it uses namespaces)

yes, @fivestar point it out 9 days ago and I already sorry for my typo ;)

fivestar · 2014-09-25T16:18:37Z

Thanks for your comments! I replied some line notes.

Sorry --filter is mistaken. --fixers is right. Do i have to amend commit message?
Will be fix php5.2 (5.3?) crash.
Maybe this is good plase to separate Config::$fixers into two values?
One that handle LEVEL, and second that handle fixers array? Now this props handle both :(
- Do you have any ideas? Maybe current code has any problems?
It would be great to add info about levels/fixers and mixing them (with excluding/including extra fixers) into readme.
- I'll see what I can do.

keradus · 2014-09-25T19:14:37Z

Do i have to amend commit message?

If you will keep this PR with only one commit then please, do it. If PR will has several then I will do it during merge.

Will be fix php5.2 (5.3?) crash.

Yeah, 5.3, sorry ;)

Maybe this is good plase to separate Config::$fixers into two values?

Do you have any ideas? Maybe current code has any problems?

No problems on that, just now we have one variable with dual responsibility. You are dealing with them now so it will be cool to fix it as well ;) Just create Config::$level for level value and change Config::$fixers to handle only fixers array

keradus · 2014-09-26T15:52:41Z

Please rebase on master ;)

keradus · 2014-09-30T20:12:28Z

any news @fivestar ? The work you have already done is cool!

fivestar · 2014-10-01T08:01:44Z

Sorry, I've been so busy lately... Please wait for a little while longer!

fivestar · 2014-10-06T03:16:10Z

@keradus Please check it!

keradus · 2014-10-06T11:29:42Z

Symfony/CS/Console/Command/FixCommand.php

-            }
-        }
+        $fixers = $fixersResolver->resolveByLevel($levelOption);
+        $fixers = $fixersResolver->resolveByNames($fixers, $fixersOption);


So we have here sth like:

$fixersResolver = new FixersResolver($this->fixer->getFixers()); $fixers = $fixersResolver->resolveByLevel($levelOption); $fixers = $fixersResolver->resolveByNames($fixers, $fixersOption);

So we passing $fixersOption, $levelOption, $fixers and $fixersOption, where$levelOptionis calculated here from$config->getFixers();or input itself. We also calculate sth fromFixersResolverand passing it toFixerResolver` again - just use a state.

It would be great if you have some setters to set $level and $fixers from input/config, then resolveBy* would be a private methods and at finish FixersResolver will have some public method like getFixers/resolve (which do all the magic like parsing inputs and calling private helpers)

already done.

keradus · 2014-10-06T11:31:03Z

Symfony/CS/Console/Command/FixCommand.php

+        if (null === $levelOption
+            && (empty($fixersOption) || preg_match('{(^|,)-}', $fixersOption))
+        ) {
+            $levelOption = $config->getFixers();


I would break a BC here - let the Config::getFixers returns fixers array and Config::getLevel returns level constant.
It will not be confusing then.

already done.

keradus · 2014-10-06T11:32:05Z

Symfony/CS/FixersResolver.php

+
+        if (is_string($levelOption)) {
+            switch ($levelOption) {
+                case 'psr0':


just do the mapping:
static array $foo = array('psr0' => FixerInterface::PSR0_LEVEL, ...);

already done.

keradus · 2014-10-06T11:33:10Z

Symfony/CS/FixersResolver.php

+        }
+
+        // select base fixers for the given level
+        if (is_array($level)) {


$level should not be an array of fixers, array of fixers should be in $fixers.
This will lead to breaking BC as mentioned before.

already done.

keradus · 2014-10-06T11:36:01Z

Symfony/CS/FixersResolver.php

+        $removeNames = array();
+        foreach ($names as $name) {
+            if (0 === strpos($name, '-')) {
+                $removeNames[] = ltrim($name, '-');


I would use ~map here instead of array (in $addNames the same):
$removeNames[$name] = true

then you will not need to chek in_array($name $removeNames, true) but just isset($removeNames[$name])

btw, with larges arrays it would be a little faster i think

already done.

keradus · 2014-10-06T11:38:13Z

Symfony/CS/FixersResolver.php

+        return $fixers;
+    }
+
+    public function resolveByNames(array $fixers, $names)


I think array $fixers is a state of this class, it should not be passed in and out.
calculate it inside class and make a getter for it.

already done.

keradus · 2014-10-06T11:41:16Z

Symfony/CS/Tests/FixersResolverTest.php

+
+        foreach ($fixers as $fixer) {
+            switch ($fixer->getName()) {
+                case 'encoding':        // psr1


And what if sb change this name of Fixer?
Please get it from fixer class itself.

oh, you have it in line 44 already.
ok, no big deal

keradus · 2014-10-06T13:05:37Z

Nice progress @fivestar ;)
But I think it needs just a little more (see code comments)

keradus · 2014-10-09T09:27:12Z

It would be great to see that on master! Waiting for progress ;)

keradus · 2014-10-28T19:38:29Z

I test this branch a lot, results are below.

             CONFIG      OPTION
LEVEL           X
FIXERS

Result: Take level from config.
OK

             CONFIG      OPTION
LEVEL           X
FIXERS          X

Result:
If fixers from config have only "positive" fixers: Take fixers from config and ignore level from config.
If fixers from config have "negative" fixers: Take level from config and apply fixers from config as patch.
ERROR: In both cases the fixers from config should be applied as patch.

             CONFIG      OPTION
LEVEL           X           X
FIXERS

Result: Take level from option.
OK

             CONFIG      OPTION
LEVEL           X           X
FIXERS          X           X

Result: Take level from option and apply fixers from options as patch.
OK

             CONFIG      OPTION
LEVEL           X
FIXERS          X           X

Result:
If fixers from options have only "positive" fixers: Take fixers from option and ignore level from config.
If fixers from options have "negative" fixers: Take level from config and apply fixers from option as patch.
OK

             CONFIG      OPTION
LEVEL           X           X
FIXERS          X

Result: Take level from option and ignore level from config. Then apply fixers from config as patch.
ERROR: Fixer from config should not be applied.

When sb run php-cs-fixer fix --level=symfony then one want to run only the level he set, without fixers from config as patch

keradus · 2014-10-28T19:55:26Z

@fabpot @fivestar @stof @sstok @GrahamCampbell
what do you think about above strategy of dealing with level/fixers config/options ?

BTW, tests and solution for that behavior are availeble here: fivestar#2

fivestar · 2014-10-28T23:50:47Z

Thanks!! I misread your specified commit number so I'll squash after merging your PR ;)

fivestar · 2014-10-29T03:42:30Z

I've seen test results and your PR, so I think your strategy is better because it's is useful for actual use case.
If you judge your PR can merge, please call me again.

keradus · 2014-10-29T09:35:47Z

I am not PR-ing with code I don't want to be merged ;)
(Sth I use WIP flag to show that PR is not done yet).

If you agreed with changes just accept that PR (fivestar#2). I don't change the whole strategy - just fix 2 cases.

The other thing is if this PR (#599) will be merged - and I will be glad to see more opinions here.
For me it should be ;)

fivestar · 2014-10-29T10:34:42Z

Ok I merged your PR. (What is WIP? I can't find the keyword)
What should I do sth else?

keradus · 2014-10-29T10:36:35Z

WIP stands for Work In Progress
6f0cb71 and 97a8abf should be squashed
I want to wait a little for some other opinions about this PR. I will be glad to see them.

fivestar · 2014-10-29T10:48:01Z

Uh oh I thought you are judged. I'll remove commits later. Please resend PR.

keradus · 2014-10-29T11:41:23Z

I'll remove commits later. Please resend PR.

Why to remove? The new commits are good - they improve this PR (#599).
Just please squash them.

Uh oh I thought you are judged.

Yes, I can perform a merge. But since this PR change tool interface and break BC it is worthly to give community a time to give a feedback with opinion :)

ghost · 2014-10-29T13:14:39Z

👍

sstok · 2014-10-29T13:24:00Z

Symfony/CS/Console/Command/FixCommand.php

+
+In combination with these config and command line options, you can choose various usage.
+
+For example, default level is ``symfony``, but if you also don't want to use ``psr0`` fixer, you can specify ``--fixers="-psr0"`` option.


but if you also don't want to use the psr0 fixer.

you can specify the --fixers="-psr0" option.

And try to wrap lines a bit ;) approx 80 chars max

sstok · 2014-10-29T13:24:42Z

Symfony/CS/Console/Command/FixCommand.php

@@ -197,6 +202,23 @@ protected function configure()

    ?>

+The ``symfony`` level is set by default, you can also change default level:


you can also change the default level

sstok · 2014-10-29T13:30:42Z

👍 for this feature.


        Fix README and some codes.


        FixersResolver - make class more state aware and enhance it's tests

fivestar · 2014-10-29T15:00:16Z

I've just got it! I squashed some commits.

@sstok Thanks for your help! I fixed some messages.

alterphp · 2014-10-31T10:00:06Z

👍 great job !

keradus · 2014-11-02T18:53:49Z

Thank you @fivestar.


        feature #599 Fix `fix` command to handle `--fixers` option when conta…

…ins extra and excluding fixers (fivestar, keradus) This PR was merged into the 1.0.x-dev branch. Discussion ---------- Fix `fix` command to handle `--fixers` option when contains extra and excluding fixers Currently, when `--fixers` option contains extra and excluding mixed filters such as `-eol_ending,concat_with_spaces`, excluding filter will be enabled, however, extra filter will not be enabled. This PR fixes this behavior, so enable both type filters when mixed filters given. ---- `sample.php` ```php <?php echo 'foo'.'bar', PHP_EOL; ``` Current version: (`concat_with_spaces` is not enabled) ``` % php-cs-fixer fix -v --diff --fixers="-eol_ending,concat_with_spaces" --dry-run sample.php 1) /home/fivestar/sample.php (eof_ending) ---------- begin diff ---------- --- Original +++ New @@ @@ <?php echo 'foo'.'bar', PHP_EOL; - ---------- end diff ---------- ``` Fixed version: (`concat_with_spaces` is enabled) ``` % php-cs-fixer fix -v --diff --fixers="-eol_ending,concat_with_spaces" --dry-run sample.php 1) /home/fivestar/sample.php (eof_ending, concat_with_spaces) ---------- begin diff ---------- --- Original +++ New @@ @@ <?php -echo 'foo'.'bar', PHP_EOL; - +echo 'foo' . 'bar', PHP_EOL; ---------- end diff ---------- ``` Commits ------- 23c07bb FixersResolver - make class more state aware and enhance it's tests e75c985 Fix README and some codes. 6876726 FixersResolver - simplify code f3c966f Fix `fix` command to handle `--fixers` option when contains include and excluding fixers

fivestar · 2014-11-04T01:13:31Z

Thank you too!!

keradus reviewed Sep 25, 2014
View changes

fivestar changed the title ~~Fix `fix` command to handle `--filter` option when contains extra and excluding filters~~ Fix `fix` command to handle `--fixers` option when contains extra and excluding filters Sep 25, 2014

keradus changed the title ~~Fix `fix` command to handle `--fixers` option when contains extra and excluding filters~~ Fix `fix` command to handle `--fixers` option when contains extra and excluding fixers Sep 25, 2014

keradus added the kind/bug label Sep 30, 2014

fivestar force-pushed the fivestar:resolve-mixed-fixtures branch 4 times, most recently from 343be2f to 45a1c1f Oct 6, 2014

keradus reviewed Oct 6, 2014
View changes

This was referenced Oct 28, 2014

FixersResolver - make class more state aware and enhance it's tests fivestar/PHP-CS-Fixer#2

Merged

Multiple levels #154

Closed

Can NOT exclude many filters via .php_cs #550

Closed

fivestar force-pushed the fivestar:resolve-mixed-fixtures branch from bc4c879 to 97a8abf Oct 29, 2014

sstok reviewed Oct 29, 2014
View changes

fivestar and others added 2 commits Oct 27, 2014

Fix README and some codes.

e75c985

FixersResolver - make class more state aware and enhance it's tests

Loading status checks…

23c07bb

fivestar force-pushed the fivestar:resolve-mixed-fixtures branch from 97a8abf to 23c07bb Oct 29, 2014

keradus added the kind/feature label Oct 29, 2014

keradus merged commit 23c07bb into FriendsOfPHP:master Nov 2, 2014
1 check passed

1 check passed

continuous-integration/travis-ci The Travis CI build passed
Details

keradus mentioned this pull request Nov 3, 2014

Adding level to Config #433

Closed

fivestar deleted the fivestar:resolve-mixed-fixtures branch Nov 4, 2014

keradus mentioned this pull request Nov 4, 2014

Blacklist for the Fixers not working when specified in config file #293

Closed


		In combination with these config and command line options, you can choose various usage.

		For example, default level is ``symfony``, but if you also don't want to use ``psr0`` fixer, you can specify ``--fixers="-psr0"`` option.

		@@ -197,6 +202,23 @@ protected function configure()

		?>

		The ``symfony`` level is set by default, you can also change default level:

FriendsOfPHP / PHP-CS-Fixer

Sponsor FriendsOfPHP/PHP-CS-Fixer

Join GitHub today

Fix `fix` command to handle `--fixers` option when contains extra and excluding fixers #599

Fix `fix` command to handle `--fixers` option when contains extra and excluding fixers #599

Conversation

fivestar commented Sep 25, 2014

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

keradus commented Sep 25, 2014

This comment has been minimized.

This comment has been minimized.

keradus commented Sep 25, 2014

keradus commented Sep 25, 2014

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

fivestar commented Sep 25, 2014

keradus commented Sep 25, 2014

keradus commented Sep 26, 2014

keradus commented Sep 30, 2014

fivestar commented Oct 1, 2014

fivestar commented Oct 6, 2014

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

keradus commented Oct 6, 2014

keradus commented Oct 9, 2014

keradus commented Oct 28, 2014

keradus commented Oct 28, 2014

fivestar commented Oct 28, 2014

fivestar commented Oct 29, 2014

keradus commented Oct 29, 2014

fivestar commented Oct 29, 2014

keradus commented Oct 29, 2014

fivestar commented Oct 29, 2014

keradus commented Oct 29, 2014

ghost commented Oct 29, 2014

This comment has been minimized.

This comment has been minimized.

sstok commented Oct 29, 2014

fivestar commented Oct 29, 2014

alterphp commented Oct 31, 2014

keradus commented Nov 2, 2014

fivestar commented Nov 4, 2014