Base PHP-cs-fixer migration to version 2 plus style fix #1555

massimilianobraglia · 2018-12-12T22:20:22Z

Hey there!

As stated here #1540, I'm opening multiple CS fix PRs.

This is the base porting from version 1 to version 2 of the linter. Also, I have applied the CS rules in order to show you how this should look like.

@ruflin and @p365labs: what's your opinion about this?

ruflin · 2018-12-13T14:42:09Z

@massimilianobraglia This is great and it looks like it could still be reviewable as the changes overall are minimal.

ruflin · 2018-12-13T14:47:17Z

env/elastica/composer.json

-        "sebastian/phpcpd":"~2.0",
-        "squizlabs/php_codesniffer":"~2.5"
+        "phpdocumentor/phpdocumentor": "~2.8",
+        "friendsofphp/php-cs-fixer": "^2.0",


Could you have a look at CI? I assume some more updates are needed: https://travis-ci.org/ruflin/Elastica/jobs/467233662

Ok! I'll check it ASAP

ruflin

This change LGTM as soon as we get CI green. Let me know if I can help here.

Overall the changes are as minimal as I hoped for.

As soon as this PR is in, we should also create a follow up PR to runs the linting on Travis so we can block PR's which do not adhere.

ruflin · 2018-12-14T08:20:54Z

Makefile

@@ -140,7 +140,7 @@ gource:

 ## DOCKER IMAGES

-.PHONY: elastica-image
+	.PHONY: elastica-image


Is this change intentional?

No, I didn't notice that 🤔
Fixing..

still needs a fix ;-)

ruflin · 2018-12-14T08:22:38Z

lib/Elastica/Index/Settings.php

-                    } else {
-                        return;
-                    }
+        }


Nice that it catches such things with return. I'm positively surprised :-)

Yeps! It's such a nice tool (and there are many rules that I have to look deeper 😄)

ruflin · 2018-12-14T08:24:44Z

test/Elastica/Aggregation/BucketScriptTest.php

     */
    public function testToArrayInvalidBucketsPath()
    {
+        $this->expectException(\Elastica\Exception\InvalidException::class);


Are the also changes it has done automatically?

Yes, it should be done by using the 'php_unit_dedicate_assert' => ['target' => 'newest'], rule

ruflin · 2018-12-14T08:25:27Z

test/Elastica/Base.php

@@ -7,7 +8,7 @@
 use Elasticsearch\Endpoints\Ingest\Pipeline\Put;
 use Psr\Log\LoggerInterface;

-class Base extends \PHPUnit_Framework_TestCase
+class Base extends \PHPUnit\Framework\TestCase


Automated change?

Yes. Obviously it should be imported with the use statement

massimilianobraglia · 2018-12-14T11:55:04Z

Everything touched by this PR is automated by the CS-fixer. A part from the Makefile change :/ (probably is my mistake).

About the composer problem, it must be a version conflict for phpdocumentor/fileset (I think). Still I didn't have time to check it, what do you think about it @ruflin?

ruflin · 2018-12-14T14:14:36Z

yes, seems like it. I wonder if setting it to 2.9 helps?

massimilianobraglia · 2018-12-14T17:46:34Z

Unfortunately it does not help. I tried to remove it also and it does not work anyway.

Also, I noticed that the CS-Fixer does not support PHP 7.3 (see PHP-CS-Fixer/PHP-CS-Fixer#3697)...

ruflin · 2018-12-17T08:41:58Z

The good news at least the errors change now. I'm opening #1567 so we can experimenting with updating the other dependencies separately.

For php-cs-fixer: When do you expect it to be compatible with PHP 7.3? Is it only a problem with 7.3 if it runs the linter or always? I'm thinking that on travis we should run linting as a separate step and not on all 4 versions.

p365labs · 2018-12-17T09:17:35Z

@massimilianobraglia I think we need to update composer.json here

env\elastica\composer.json

it uses "phpunit/phpunit":"~5.6"

not sure bad I have a bad smell on that version ;)

massimilianobraglia · 2018-12-17T16:41:24Z

@ruflin the issue I linked is opened since April 2018. I do not know when the full compatibility will be merged. A comment states that the linter is compatible since we do not use one of the new features of PHP 7.3. I agree about not using the linter in every step but in another one.

I'm going to rebase and see if the build goes on 😄

massimilianobraglia · 2018-12-18T09:50:03Z

I made it! Let's see what the build on Travis says but the problem about composer's hangin' on was also with the phploc package (see 657da46#diff-bdfe059178421755f0677c4b7b332938L20)

I just removed it and it worked!

I have also updated PHPUnit version to ^6.0.

massimilianobraglia · 2018-12-18T10:12:47Z

lmc-eu/steward#230

What about using this workaround until PHP-CS-fixer solves the issue with PHP 7.3?

@ruflin and @p365labs what do think about this?

ruflin · 2018-12-20T08:37:43Z

I assume we don't need a workaround as we just run the linting job with 7.2?

Could you rebase this PR on top of master as @p365labs updated the dependency. I hope now the build will run.

massimilianobraglia · 2018-12-20T10:20:54Z

I made it running. The build failed beacuse of PHP-CS-Fixer on PHP 7.3.

Rebasing will be done in a moment 😄

massimilianobraglia · 2018-12-20T17:06:29Z

@ruflin and @p365labs
I removed php-cs-fixer from PHP 7.3 and added in .travis.yml the style check. Can you give it a look?

…ted .travis.yml (now checks style

p365labs · 2018-12-20T17:32:26Z

@massimilianobraglia well done ! good point amending .travis + Make 👍

env/elastica/Docker70

massimilianobraglia · 2018-12-20T17:39:26Z

That's the point in fact..!

ruflin · 2018-12-21T08:22:01Z

env/elastica/composer.json

@@ -13,8 +13,6 @@
    ],
    "require": {
        "php": "^7.0",
-        "phpdocumentor/phpdocumentor": "^2.9",


Can we please keep this in? I need this to generate the docs :-)

Ok :) Probably I forgot to readd that one.

ruflin · 2018-12-21T08:23:50Z

My thinking for Travis was more that we introduce one more target which could be called Lint. And this target would have it's own Docker container, so no need to modify the other containers. We can still do this in a follow up PR to not further hold back this PR.

Could you readd the removed line to the composer file or does this still cause issue even with the updates?

massimilianobraglia · 2018-12-21T10:19:22Z

It still causes the issue. No problem about adding a separate step with the linting :)
Let's see if I can manage it right now

massimilianobraglia · 2018-12-21T10:26:51Z

the new travis.yml file will look something like this:

sudo: required
dist: trusty

group: edge


services:
  - docker

branches:
  only:
    - master

env:
  global:
    - DOCKER_VERSION=17.09.0
    - DOCKER_COMPOSE_VERSION=1.17.1
  matrix:
    - TARGET="70"
    - TARGET="71"
    - TARGET="72"
    - TARGET="73"
    - TARGET="Lint"

before_install:
  # check running "docker engine" and "docker-compose" version on travis
  - docker --version
  - docker-compose --version

  # list docker-engine versions, usefull to update the docker engine on travis and trusty
#  - sudo apt-cache madison docker-engine

  # update docker engine to the desired version
  - sudo apt-get -o Dpkg::Options::="--force-confnew" install -y docker-ce=${DOCKER_VERSION}~ce-0~ubuntu --allow-downgrades

  - sudo rm /usr/local/bin/docker-compose
  - curl -L https://github.com/docker/compose/releases/download/${DOCKER_COMPOSE_VERSION}/docker-compose-`uname -s`-`uname -m` > docker-compose
  - chmod +x docker-compose
  - sudo mv docker-compose /usr/local/bin

before_script:
  - sudo sysctl -w vm.max_map_count=262144

script:
  - if [ "$TARGET" != "Lint" ] ; then make tests TARGET=$TARGET ; fi
  - if [ "$TARGET" == "Lint" ] ; then make check-style ; fi

after_script:
  - cat /var/log/elasticsearch/*.log
  - cat /var/log/nginx/*.log
  - sudo rm composer.lock && sudo composer require satooshi/php-coveralls dev-master --no-ansi --no-progress --no-interaction

after_success:
  - bash <(curl -s https://codecov.io/bash)
  - vendor/bin/coveralls -v

What do you think about it, @ruflin?

ruflin · 2018-12-21T12:42:08Z

@massimilianobraglia LGTM

ruflin

This looks good, we are almost there. Last thing missing I think is a CHANGELOG entry.

massimilianobraglia · 2018-12-21T15:10:13Z

What should I enter in the CHANGELOG?
Something like
Introduced new version of PHP-CS-Fixer and new Lint travis step?

ruflin · 2018-12-21T15:14:39Z

@massimilianobraglia Changelog SGTM.

massimilianobraglia · 2018-12-21T15:51:50Z

here you are 😄

ruflin · 2018-12-24T08:14:43Z

@massimilianobraglia Merged 🎄 Thank you so much for going through all these loops to get this in.

Moving forward we should make sure it's as easy as possible for contributors to apply the linting to not get stuck on this step in their PR's.

I'm happy to apply more linting rules to Elastica. The less we need to discuss about how things are formatted and the more we can focus on the code itself the better :-)

massimilianobraglia · 2018-12-24T10:24:20Z

Yes!!
If you don't mind, I have the original rules ready and I can open another PR with that 😄

ruflin · 2018-12-27T07:52:36Z

@massimilianobraglia Yes, please. Best do 1 PR per change so we keep it small.

ruflin reviewed Dec 13, 2018

View reviewed changes

ruflin reviewed Dec 14, 2018

View reviewed changes

massimilianobraglia force-pushed the migrate_cs_fixer_to_version_2 branch from 4fb4606 to b478559 Compare December 14, 2018 11:55

massimilianobraglia force-pushed the migrate_cs_fixer_to_version_2 branch from b478559 to 4541719 Compare December 14, 2018 16:39

massimilianobraglia force-pushed the migrate_cs_fixer_to_version_2 branch from 4541719 to 657da46 Compare December 18, 2018 09:47

Base PHP-cs-fixer migration to version 2 plus style fix

4f15fb2

massimilianobraglia force-pushed the migrate_cs_fixer_to_version_2 branch from 657da46 to 4f15fb2 Compare December 20, 2018 10:32

add php-cs-fixer only in 7.0, 7.1 and 7.2. Removed from PHP 7.3. Upda…

84612d5

…ted .travis.yml (now checks style

massimilianobraglia force-pushed the migrate_cs_fixer_to_version_2 branch from 7cb95ff to 84612d5 Compare December 20, 2018 17:13

p365labs reviewed Dec 20, 2018

View reviewed changes

env/elastica/Docker70 Outdated Show resolved Hide resolved

ruflin reviewed Dec 21, 2018

View reviewed changes

massimilianobraglia force-pushed the migrate_cs_fixer_to_version_2 branch from eb2036b to 993540d Compare December 21, 2018 10:57

Separate step for linting in travis matrix. Readded phpdocumentor

41f890e

massimilianobraglia force-pushed the migrate_cs_fixer_to_version_2 branch from 993540d to 41f890e Compare December 21, 2018 11:04

ruflin reviewed Dec 21, 2018

View reviewed changes

Updated CHANGELOG.md

19cf2da

Update CHANGELOG with PR number.

fb63135

ruflin merged commit 419a508 into ruflin:master Dec 24, 2018

keradus mentioned this pull request Jan 6, 2019

DX: Upgrade PHP CS Fixer and it's config #1587

Merged

Base PHP-cs-fixer migration to version 2 plus style fix #1555

Base PHP-cs-fixer migration to version 2 plus style fix #1555

Conversation

massimilianobraglia commented Dec 12, 2018

ruflin commented Dec 13, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ruflin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

massimilianobraglia Dec 14, 2018 • edited Loading

Choose a reason for hiding this comment

massimilianobraglia commented Dec 14, 2018

ruflin commented Dec 14, 2018

massimilianobraglia commented Dec 14, 2018

ruflin commented Dec 17, 2018

p365labs commented Dec 17, 2018

massimilianobraglia commented Dec 17, 2018 • edited Loading

massimilianobraglia commented Dec 18, 2018

massimilianobraglia commented Dec 18, 2018 • edited Loading

ruflin commented Dec 20, 2018

massimilianobraglia commented Dec 20, 2018

massimilianobraglia commented Dec 20, 2018

p365labs commented Dec 20, 2018

massimilianobraglia commented Dec 20, 2018 via email

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ruflin commented Dec 21, 2018

massimilianobraglia commented Dec 21, 2018

massimilianobraglia commented Dec 21, 2018

ruflin commented Dec 21, 2018

ruflin left a comment

Choose a reason for hiding this comment

massimilianobraglia commented Dec 21, 2018

ruflin commented Dec 21, 2018

massimilianobraglia commented Dec 21, 2018

ruflin commented Dec 24, 2018

massimilianobraglia commented Dec 24, 2018

ruflin commented Dec 27, 2018

massimilianobraglia Dec 14, 2018 •

edited

Loading

massimilianobraglia commented Dec 17, 2018 •

edited

Loading

massimilianobraglia commented Dec 18, 2018 •

edited

Loading