Updated doctrine/coding-standard to 5.0, #3303

morozov · 2018-09-27T06:46:50Z

Q	A
Type	improvement
BC Break	no

The coding standard violations have been fixed in tests/. Besides the automated fixes via phpcbf, the following was changed:

Fixed the issues which phpcbf couldn't fix.
Removed leading underscore from private/protected class memeber names where possible.
Renamed _conn to connection, _sm to schemaManager.
Replaced class names represented by strings with the ::class syntax
Removed some remaining license headers
Updated diff-sniffer to 0.2.0 on Travis since the older version is incompatible with PHP_CodeSniffer 3.3.

The remaining build failure is caused by squizlabs/PHP_CodeSniffer#2165:

$ phpcs tests/
............................................E............... 60 / 68 (88%)
........                                                     68 / 68 (100%)



FILE: tests/Doctrine/Tests/DBAL/SQLParserUtilsTest.php
---------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------
 72 | ERROR | [x] Expected 0 spaces before comma; 16 found
    |       |     (Squiz.Arrays.ArrayDeclaration.SpaceBeforeComma)
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------

Time: 6.25 secs; Memory: 30.76Mb

Majkl578 · 2018-09-27T13:58:11Z

.travis.yml

@@ -442,7 +442,7 @@ jobs:
            git fetch origin $TRAVIS_BRANCH;
          fi
        - git merge-base origin/$TRAVIS_BRANCH $TRAVIS_PULL_REQUEST_SHA || git fetch origin +refs/pull/$TRAVIS_PULL_REQUEST/merge --unshallow
-        - wget https://github.com/diff-sniffer/git/releases/download/0.1.0/git-phpcs.phar
+        - wget https://github.com/diff-sniffer/git/releases/download/0.2.0/git-phpcs.phar


Do we still need the diff checker? Since the code base should pass PHPCS, vendor/bin/phpcs should be enough?

The code style is only fixed in tests/, and even there, there's still one failure due to the bug in PHP_CodeSniffer. Once we fix everything, we can switch to phpcs.

Yup, noticed later it's only tests/. :)

Majkl578 · 2018-09-27T13:59:02Z

tests/Doctrine/Tests/DBAL/Driver/AbstractDriverTest.php

+    public const EXCEPTION_TABLE_NOT_FOUND                  = 'Doctrine\DBAL\Exception\TableNotFoundException';
+    public const EXCEPTION_UNIQUE_CONSTRAINT_VIOLATION      = 'Doctrine\DBAL\Exception\UniqueConstraintViolationException';
+    public const EXCEPTION_DEADLOCK                         = 'Doctrine\DBAL\Exception\DeadlockException';
+    public const EXCEPTION_LOCK_WAIT_TIMEOUT                = 'Doctrine\DBAL\Exception\LockWaitTimeoutException';


Could all be ::class.

True. Didn't get caught by my regex.

Majkl578 · 2018-09-27T14:02:04Z

tests/Doctrine/Tests/DBAL/Driver/PDOPgSql/DriverTest.php

     */
    private function skipWhenNotUsingPhp56AndPdoPgsql()
    {
        if (! defined('PDO::PGSQL_ATTR_DISABLE_PREPARES')) {
            $this->markTestSkipped('Test requires PHP 5.6+');
        }

-        if (! (isset($GLOBALS['db_type']) && $GLOBALS['db_type'] === 'pdo_pgsql')) {
-            $this->markTestSkipped('Test enabled only when using pdo_pgsql specific phpunit.xml');
+        if (isset($GLOBALS['db_type']) && $GLOBALS['db_type'] === 'pdo_pgsql') {


I wish I never saw this. 🙈

Phew… I thought it was a bug in the CS fixer which just removed the !. But it added an early return.

As for the $GLOBALS… yeah.

Majkl578 · 2018-09-27T14:04:58Z

tests/Doctrine/Tests/DBAL/Functional/Driver/SQLAnywhere/ConnectionTest.php

        }
+
+        $this->markTestSkipped('sqlanywhere only test.');


We don't seem to be consistent with using $this vs. self. But that can be fixed separately.

I don't have a problem fixing it but let's make it part of the standard first.

Majkl578 · 2018-09-27T14:07:21Z

Do you also want to update CS in lib/?

morozov · 2018-09-27T14:35:40Z

Do you also want to update CS in lib/?

Yes, but can we make it via a separate pull request? It'll require much more careful review.

Majkl578 · 2018-09-27T14:53:44Z

Sure. 👍

See squizlabs/PHP_CodeSniffer#2165

@morozov

Release v2.9.0 This is a minor release of Doctrine DBAL that aggregates over 40 fixes and improvements developed by 18 contributors over the last 5 months. This release includes all changes of the 2.8.x series, as well as feature additions and improvements that couldn't land in patch releases. ## Backwards Compatibility Breaks This doesn't contain any intentional Backwards Compatibility (BC) breaks. ## Deprecations * The usage of `NULL` to specify the absence of an offset in `LIMIT`ed queries is deprecated. Use `0` instead. * It's not recommended to rely on the default length specified by implementations of `Type`. These values are not used by the library and will be removed. * It's not recommended to rely on the string representation of `Type` objects. * Regular-expression based asset filters are deprecated in favor of callback-based as more extensible. * Calling `Statement::fetchColumn()` with an invalid column index is deprecated. * The `dbal:import` CLI command is deprecated. Please use other database client applications for import. Please see details in the [UPGRADE.md](UPGRADE.md) documentation. ## New Features * Added support for MariaDB 10.3. * Added support for Windows authentication for SQL Server. * Added support for column length in index definitions on MySQL. ## Improvements and Fixes * Implemented handling BLOB objects represented as streams in the MySQL (`mysqli`) driver. * Implemented handling BLOB objects represented as streams in the IDM DB2 driver. * DBAL is now continuously tested with the PDO driver for Oracle. * Implemented handling of URLs in master-slave and pooling-shard connection configuration. * The codebase is now fully compatible with the Doctrine Coding Standard v5.0. Total issues resolved: **45** **Deprecations:** - [3244: Deprecated dbal:import CLI command](doctrine#3244) thanks to @morozov - [3253: Deprecated usage of the NULL offset in LIMITed queries](doctrine#3253) thanks to @morozov - [3256: Deprecate Doctrine\DBAL\Types\Type::getDefaultLength()](doctrine#3256) thanks to @Majkl578 - [3258: Deprecate Doctrine\DBAL\Types\Type::&doctrine#95;&doctrine#95;toString()](doctrine#3258) thanks to @Majkl578 - [3316: Deprecated regex-based asset filters](doctrine#3316) thanks to @morozov - [3359: Removed DataAccessTest::testFetchColumnNonExistingIndex() since it covers a bug in PDO](doctrine#3359) thanks to @morozov **New Features:** - [2412: Add mysql specific indexes with lengths](doctrine#2412) thanks to @bburnichon - [3278: Add support for MariaDB 10.3](doctrine#3278) thanks to @javiereguiluz - [3283: MariaDB improvements, support 10.3](doctrine#3283) thanks to @sidz - [3333: Allow windows (userless/passwordless) authentication for SQL Server](doctrine#3333) thanks to @odinsey **Bug Fixes:** - [3355: Implemented comparison of default values as strings regardless of their PHP types](doctrine#3355) thanks to @morozov and @Majkl578 **Improvements:** - [3201: Fix support for URL to account for master-slave and pooling-shard connections](doctrine#3201) thanks to @stof - [3217: Fix that MysqliStatement cannot handle streams](doctrine#3217) thanks to @mpdude - [3235: Use PSR-4 autoloader](doctrine#3235) thanks to @Majkl578 - [3254: Throw ConversionException when unserialization fail for array and object types](doctrine#3254) thanks to @seferov - [3259: Update export ignores](doctrine#3259) thanks to @Majkl578 - [3309: Implemented handling BLOBs represented as stream resources for IBM DB2](doctrine#3309) thanks to @morozov and @mpdude - [3331: Fetch all should use the driver statement's fetchAll method](doctrine#3331) thanks to @michaelcullum **Documentation Improvements:** - [3223: GitHub template grammar/spelling fixes](doctrine#3223) thanks to @GawainLynch - [3232: Removed NOW() from QueryBuilder usage examples](doctrine#3232) thanks to @morozov - [3239: 2.8 in README & branch alias to 2.9](doctrine#3239) thanks to @Majkl578 - [3269: Fixed type hints in DockBlocks](doctrine#3269) thanks to @marforon - [3275: Add .doctrine-project.json to root of the project.](doctrine#3275) thanks to @jwage - [3276: Update homepage](doctrine#3276) thanks to @Majkl578 - [3280: Use behaviuor instead of behavior](doctrine#3280) thanks to @BackEndTea - [3285: Remove old comment from MysqliStatement](doctrine#3285) thanks to @mpdude - [3318: Removed link to www.doctrine-project.org from doc blocks](doctrine#3318) thanks to @morozov - [3319: remove ClassLoader](doctrine#3319) thanks to @garak - [3337: Fix of links in documentation](doctrine#3337) thanks to @SenseException - [3350: Remove pdo&doctrine#95;sqlsrv from known vendor issues list](doctrine#3350) thanks to @ostrolucky - [3357: Fix typo](doctrine#3357) thanks to @BenMorel - [3370: Removed 2.7 from README](doctrine#3370) thanks to @morozov **Code Quality Improvements:** - [3252: Replaced call&doctrine#95;user&doctrine#95;func&doctrine#95;array() of a fixed method with the usage of variadic arguments](doctrine#3252) thanks to @morozov - [3306: Fixed coding standard violations in the codebase](doctrine#3306) thanks to @morozov - [3303: Updated doctrine/coding-standard to 5.0, ](doctrine#3303) thanks to @morozov - [3317: Implemented proper escaping of string literals in platforms and schema managers](doctrine#3317) thanks to @morozov - [3363: Remove redundant implements](doctrine#3363) thanks to @BenMorel **Continuous Integration Improvements:** - [3307: Test against the latest stable sqlsrv extension](doctrine#3307) thanks to @morozov - [3320: Trying to fix failing DB builds](doctrine#3320) thanks to @morozov - [3325: Updated PHPUnit to 7.4](doctrine#3325) thanks to @morozov - [3339: ContinuousPHP configuration for PDO Oracle driver](doctrine#3339) thanks to @morozov - [3365: Reorganize Travis build matrix](doctrine#3365) thanks to @BenMorel # gpg: Signature made Tue Dec 4 05:44:06 2018 # gpg: using RSA key 374EADAF543AE995 # gpg: Can't check signature: public key not found # Conflicts: # README.md # lib/Doctrine/DBAL/Driver/AbstractOracleDriver.php # lib/Doctrine/DBAL/Version.php

morozov force-pushed the doctrine-coding-standard-5 branch 2 times, most recently from 2a26433 to 6adcdba Compare September 27, 2018 07:20

morozov requested review from Ocramius and Majkl578 September 27, 2018 07:35

Majkl578 reviewed Sep 27, 2018

View reviewed changes

morozov force-pushed the doctrine-coding-standard-5 branch from 6adcdba to 94ce793 Compare September 27, 2018 14:34

morozov added 2 commits September 27, 2018 19:23

Updated doctrine/coding-standard to ^5

f18ced5

PHPCBF

73bd82a

morozov force-pushed the doctrine-coding-standard-5 branch from 94ce793 to 616dc37 Compare September 28, 2018 02:29

Manual fixes

9efa3e4

morozov force-pushed the doctrine-coding-standard-5 branch from 616dc37 to 9efa3e4 Compare September 28, 2018 03:15

Temporarily excluded failing sniff

9d513ca

See squizlabs/PHP_CodeSniffer#2165

Majkl578 added Improvement CI Code Style labels Sep 28, 2018

Majkl578 added this to the 2.9.0 milestone Sep 28, 2018

Majkl578 approved these changes Sep 28, 2018

View reviewed changes

morozov merged commit 3790851 into doctrine:master Sep 28, 2018

morozov deleted the doctrine-coding-standard-5 branch September 28, 2018 19:13

morozov mentioned this pull request Oct 2, 2018

Rename protected and private class members starting with an underscore #3004

Closed

morozov self-assigned this Oct 13, 2018

github-actions bot locked as resolved and limited conversation to collaborators Aug 11, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated doctrine/coding-standard to 5.0, #3303

Updated doctrine/coding-standard to 5.0, #3303

morozov commented Sep 27, 2018 •

edited

Majkl578 Sep 27, 2018

morozov Sep 27, 2018

Majkl578 Sep 27, 2018

Majkl578 Sep 27, 2018

morozov Sep 27, 2018

Majkl578 Sep 27, 2018

morozov Sep 27, 2018

Majkl578 Sep 27, 2018

morozov Sep 27, 2018

Majkl578 commented Sep 27, 2018

morozov commented Sep 27, 2018 •

edited

Majkl578 commented Sep 27, 2018

Updated doctrine/coding-standard to 5.0, #3303

Updated doctrine/coding-standard to 5.0, #3303

Conversation

morozov commented Sep 27, 2018 • edited

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

Majkl578 commented Sep 27, 2018

morozov commented Sep 27, 2018 • edited

Majkl578 commented Sep 27, 2018

morozov commented Sep 27, 2018 •

edited

morozov commented Sep 27, 2018 •

edited