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

.php_cs

@@ -1,32 +1,26 @@
 <?php
 
-$finder = Symfony\CS\Finder\DefaultFinder::create()
-    ->in(['lib', 'test']);
+$finder = PhpCsFixer\Finder::create()
+    ->exclude(['vendor', 'var'])
+    ->in([__DIR__])
+;
 
-$config = Symfony\CS\Config\Config::create()
-    ->setUsingCache(true)
-    ->level(Symfony\CS\FixerInterface::SYMFONY_LEVEL)
-    ->fixers([
-        // [contrib] Multi-line whitespace before closing semicolon are prohibited.
-        'multiline_spaces_before_semicolon',
-        // [contrib] There should be no blank lines before a namespace declaration.
-        'no_blank_lines_before_namespace',
-        // [contrib] Ordering use statements.
-        'ordered_use',
-        // [contrib] Annotations should be ordered so that param annotations come first, then throws annotations, then return annotations.
-        'phpdoc_order',
-        // [contrib] Arrays should use the short syntax.
-        'short_array_syntax',
-        // [contrib] Ensure there is no code on the same line as the PHP open tag.
-        'newline_after_open_tag',
-        // [contrib] Use null coalescing operator ?? where possible
-        'ternary_to_null_coalescing',
-        // [contrib] There should not be useless else cases.
-        'no_useless_else',
-        // [contrib] Use dedicated PHPUnit assertions for better error messages.
+$config = PhpCsFixer\Config::create()
+    ->setFinder($finder)
+    ->setRules([
+        '@PSR2' => true,
+        '@Symfony' => true,
+        'psr0' => false,
+        'single_blank_line_before_namespace' => false,
+        'ordered_imports' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'phpdoc_order' => true,
+        'blank_line_after_namespace' => true,
+        'ternary_to_null_coalescing' => true,
+        'no_useless_else' => true,
         '@PHPUnit60Migration:risky' => true,
-        //'php_unit_dedicate_assert' => ['target' => 'newest'],
+        'php_unit_dedicate_assert' => ['target' => 'newest'],
     ])
-    ->finder($finder);
+;
 
 return $config;

.travis.yml

@@ -20,6 +20,7 @@ env:
     - TARGET="71"
     - TARGET="72"
     - TARGET="73"
+    - TARGET="Lint"
 
 before_install:
   # check running "docker engine" and "docker-compose" version on travis
@@ -41,7 +42,8 @@ before_script:
   - sudo sysctl -w vm.max_map_count=262144
 
 script:
-  - make tests TARGET=$TARGET
+  - if [ "$TARGET" != "Lint" ] ; then make tests TARGET=$TARGET ; fi
+  - if [ "$TARGET" == "Lint" ] ; then make check-style ; fi
 
 after_script:
   - cat /var/log/elasticsearch/*.log

CHANGELOG.md

@@ -12,6 +12,7 @@ All notable changes to this project will be documented in this file based on the
 * Added `BucketSelector` aggregation [#1554](https://github.com/ruflin/Elastica/pull/1554)
 * Added `DerivativeAggregation` [#1553](https://github.com/ruflin/Elastica/pull/1553)
 * The preferred type name is [_doc](https://www.elastic.co/guide/en/elasticsearch/reference/6.5/removal-of-types.html), so that index APIs have the same path as they will have in 7.0
+* Introduced new version of PHP-CS-Fixer and new Lint travis step. [#1555](https://github.com/ruflin/Elastica/pull/1555)
 
 ### Improvements
 

Makefile

@@ -61,7 +61,7 @@ tests:
 	make start
 	mkdir -p build
 
-	docker run -e "ES_HOST=elasticsearch" --network=elastica_esnet elastica_elastica  make phpunit
+	docker run -e "ES_HOST=elasticsearch" --network=elastica_esnet elastica_elastica make phpunit
 	docker cp elastica:/elastica/build/coverage/ $(shell pwd)/build/coverage
 
 # Makes it easy to run a single test file. Example to run IndexTest.php: make test TEST="IndexTest.php"
@@ -79,7 +79,16 @@ doc:
 # Uses the preconfigured standards in .php_cs
 .PHONY: lint
 lint:
-	${RUN_ENV} php-cs-fixer fix
+	${RUN_ENV} php-cs-fixer fix --allow-risky=yes
+
+.PHONY: check-style
+check-style:
+	docker build -t ruflin/elastica-dev-base -f env/elastica/${TARGET} env/elastica/
+	docker build -t ruflin/elastica .
+	make start
+	mkdir -p build
+
+	${RUN_ENV} php-cs-fixer fix --allow-risky=yes --dry-run
 
 .PHONY: loc
 loc:

env/elastica/Lint

@@ -0,0 +1,39 @@
+# This image is the base image for the Elastica development and includes all parts which rarely change
+# PHP 7 Docker file with Composer installed
+FROM php:7.2
+MAINTAINER Nicolas Ruflin <spam@ruflin.com>
+
+RUN apt-get update && apt-get install -y \
+	cloc \
+	git \
+	graphviz \
+	libxslt-dev \
+	nano \
+	zip unzip \
+	wget
+	# XSL and Graphviz for PhpDocumentor
+
+RUN docker-php-ext-install sockets xsl
+
+RUN rm -r /var/lib/apt/lists/*
+
+# Xdebug for coverage report
+RUN pecl install xdebug-2.6.1
+
+RUN echo "memory_limit=1024M" >> /usr/local/etc/php/conf.d/memory-limit.ini
+RUN echo "date.timezone=UTC" >> /usr/local/etc/php/conf.d/timezone.ini
+
+# Install and setup composer
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+ENV COMPOSER_HOME /root/composer
+
+# Add composer bin to the environment
+ENV PATH=/root/composer/vendor/bin:$PATH
+
+COPY composer.json /root/composer/
+
+RUN composer global remove --no-update phpdocumentor/phpdocumentor -vvv
+RUN composer global require --no-update friendsofphp/php-cs-fixer:^2.0
+
+# Install development tools, prefer source removed as automatic fallback now
+RUN composer global install -vvv

env/elastica/composer.json

@@ -14,7 +14,6 @@
     "require": {
         "php": "^7.0",
         "phpdocumentor/phpdocumentor": "^2.9",
-        "fabpot/php-cs-fixer": "1.11.*",
         "mayflower/php-codebrowser": "~1.1",
         "pdepend/pdepend": "^2.5",
         "phploc/phploc": "^4.0",
@@ -23,4 +22,4 @@
         "sebastian/phpcpd": "~3.0",
         "squizlabs/php_codesniffer": "~3.3"
     }
-}
+}

lib/Elastica/AbstractUpdateAction.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Elastica;
 
 /**
@@ -108,7 +109,7 @@ public function getIndex()
      *
      * @return $this
      *
-     * @link https://www.elastic.co/blog/versioning
+     * @see https://www.elastic.co/blog/versioning
      */
     public function setVersion($version)
     {
@@ -171,7 +172,7 @@ public function hasVersionType()
      *
      * @return $this
      *
-     * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-parent-field.html
+     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-parent-field.html
      */
     public function setParent($parent)
     {

lib/Elastica/Aggregation/AbstractAggregation.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 use Elastica\Exception\InvalidException;

lib/Elastica/Aggregation/AbstractSimpleAggregation.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 use Elastica\Exception\InvalidException;

lib/Elastica/Aggregation/AbstractTermsAggregation.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 /**
@@ -61,7 +62,7 @@ public function setExclude($pattern, $flags = null)
     /**
      * Sets the amount of terms to be returned.
      *
-     * @param int $size The amount of terms to be returned.
+     * @param int $size the amount of terms to be returned
      *
      * @return $this
      */
@@ -73,7 +74,7 @@ public function setSize($size)
     /**
      * Sets how many terms the coordinating node will request from each shard.
      *
-     * @param int $shard_size The amount of terms to be returned.
+     * @param int $shard_size the amount of terms to be returned
      *
      * @return $this
      */

lib/Elastica/Aggregation/Avg.php

@@ -1,10 +1,11 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 /**
  * Class Avg.
  *
- * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-avg-aggregation.html
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-avg-aggregation.html
  */
 class Avg extends AbstractSimpleAggregation
 {

lib/Elastica/Aggregation/AvgBucket.php

@@ -1,12 +1,13 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 use Elastica\Exception\InvalidException;
 
 /**
  * Class AvgBucket.
  *
- * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-avg-bucket-aggregation.html
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-avg-bucket-aggregation.html
  */
 class AvgBucket extends AbstractAggregation
 {
@@ -18,7 +19,7 @@ public function __construct($name, $bucketsPath = null)
     {
         parent::__construct($name);
 
-        if ($bucketsPath !== null) {
+        if (null !== $bucketsPath) {
             $this->setBucketsPath($bucketsPath);
         }
     }

lib/Elastica/Aggregation/BucketScript.php

@@ -1,12 +1,13 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 use Elastica\Exception\InvalidException;
 
 /**
  * Class BucketScript.
  *
- * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-script-aggregation.html
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-script-aggregation.html
  */
 class BucketScript extends AbstractAggregation
 {
@@ -19,11 +20,11 @@ public function __construct($name, $bucketsPath = null, $script = null)
     {
         parent::__construct($name);
 
-        if ($bucketsPath !== null) {
+        if (null !== $bucketsPath) {
             $this->setBucketsPath($bucketsPath);
         }
 
-        if ($script !== null) {
+        if (null !== $script) {
             $this->setScript($script);
         }
     }

lib/Elastica/Aggregation/BucketSelector.php

@@ -1,9 +1,11 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 /**
  * Class BucketSelector.
- * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-selector-aggregation.html
+ *
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-selector-aggregation.html
  */
 class BucketSelector extends AbstractSimpleAggregation
 {
@@ -16,11 +18,11 @@ public function __construct(string $name, array $bucketsPath = null, string $scr
     {
         parent::__construct($name);
 
-        if ($bucketsPath !== null) {
+        if (null !== $bucketsPath) {
             $this->setBucketsPath($bucketsPath);
         }
 
-        if ($script !== null) {
+        if (null !== $script) {
             $this->setScript($script);
         }
     }
@@ -49,4 +51,3 @@ public function setGapPolicy(string $gapPolicy = 'skip')
         return $this->setParam('gap_policy', $gapPolicy);
     }
 }
-

lib/Elastica/Aggregation/Cardinality.php

@@ -1,10 +1,11 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 /**
  * Class Cardinality.
  *
- * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-cardinality-aggregation.html
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-cardinality-aggregation.html
  */
 class Cardinality extends AbstractSimpleAggregation
 {

lib/Elastica/Aggregation/Children.php

@@ -1,10 +1,11 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 /**
  * Class Children.
  *
- * @link https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-aggregations-bucket-children-aggregation.html
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-aggregations-bucket-children-aggregation.html
  */
 class Children extends AbstractAggregation
 {

lib/Elastica/Aggregation/DateHistogram.php

@@ -1,10 +1,11 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 /**
  * Class DateHistogram.
  *
- * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html
  */
 class DateHistogram extends Histogram
 {
@@ -47,7 +48,7 @@ public function setOffset($offset)
     /**
      * Set the format for returned bucket key_as_string values.
      *
-     * @link https://www.elastic.co/guide/en/elasticsearch/reference/master/search-aggregations-bucket-daterange-aggregation.html#date-format-pattern
+     * @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-aggregations-bucket-daterange-aggregation.html#date-format-pattern
      *
      * @param string $format see link for formatting options
      *
@@ -61,7 +62,7 @@ public function setFormat($format)
     /**
      * Set extended bounds option.
      *
-     * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html#search-aggregations-bucket-histogram-aggregation-extended-bounds
+     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html#search-aggregations-bucket-histogram-aggregation-extended-bounds
      *
      * @param string $min see link for formatting options
      * @param string $max see link for formatting options

lib/Elastica/Aggregation/DateRange.php

@@ -1,10 +1,11 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 /**
  * Class DateRange.
  *
- * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html
  */
 class DateRange extends Range
 {