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

ruflin · Dec 18, 2018 · 657da46 · 657da46
1 parent 83d1a61
commit 657da46
Show file tree

Hide file tree

Showing 419 changed files with 996 additions and 551 deletions.
diff --git a/.php_cs b/.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;
diff --git a/Makefile b/Makefile
@@ -140,7 +140,7 @@ gource:
 
 ## DOCKER IMAGES
 
-.PHONY: elastica-image
+	.PHONY: elastica-image
 elastica-image:
 	docker build -t ruflin/elastica-dev-base -f env/elastica/Docker${TARGET} env/elastica/
 	docker build -t ruflin/elastica .

diff --git a/env/elastica/composer.json b/env/elastica/composer.json
@@ -13,13 +13,11 @@
     ],
     "require": {
         "php": "^7.0",
-        "phpdocumentor/phpdocumentor": "^2.9",
-        "fabpot/php-cs-fixer": "1.11.*",
+        "friendsofphp/php-cs-fixer": "^2.0",
         "mayflower/php-codebrowser": "~1.1",
         "pdepend/pdepend": "~2.2",
-        "phploc/phploc": "~2.1",
         "phpmd/phpmd": "~2.3",
-        "phpunit/phpunit": "~5.6",
+        "phpunit/phpunit": "^6.0",
         "sebastian/phpcpd": "~2.0",
         "squizlabs/php_codesniffer": "~2.5"
     }

diff --git a/lib/Elastica/AbstractUpdateAction.php b/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)
     {

diff --git a/lib/Elastica/Aggregation/AbstractAggregation.php b/lib/Elastica/Aggregation/AbstractAggregation.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 use Elastica\Exception\InvalidException;

diff --git a/lib/Elastica/Aggregation/AbstractSimpleAggregation.php b/lib/Elastica/Aggregation/AbstractSimpleAggregation.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 use Elastica\Exception\InvalidException;

diff --git a/lib/Elastica/Aggregation/AbstractTermsAggregation.php b/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
      */

diff --git a/lib/Elastica/Aggregation/Avg.php b/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
 {

diff --git a/lib/Elastica/Aggregation/AvgBucket.php b/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);
         }
     }

diff --git a/lib/Elastica/Aggregation/BucketScript.php b/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);
         }
     }

diff --git a/lib/Elastica/Aggregation/Cardinality.php b/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
 {

diff --git a/lib/Elastica/Aggregation/Children.php b/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
 {

diff --git a/lib/Elastica/Aggregation/DateHistogram.php b/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

diff --git a/lib/Elastica/Aggregation/DateRange.php b/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
 {

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

diff --git a/lib/Elastica/Aggregation/Filter.php b/lib/Elastica/Aggregation/Filter.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 use Elastica\Exception\InvalidException;
@@ -7,7 +8,7 @@
 /**
  * Class Filter.
  *
- * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html
  */
 class Filter extends AbstractAggregation
 {
@@ -19,7 +20,7 @@ public function __construct($name, AbstractQuery $filter = null)
     {
         parent::__construct($name);
 
-        if ($filter !== null) {
+        if (null !== $filter) {
             $this->setFilter($filter);
         }
     }

diff --git a/lib/Elastica/Aggregation/Filters.php b/lib/Elastica/Aggregation/Filters.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 use Elastica\Exception\InvalidException;
@@ -7,7 +8,7 @@
 /**
  * Class Filters.
  *
- * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html
  */
 class Filters extends AbstractAggregation
 {

diff --git a/lib/Elastica/Aggregation/GeoBounds.php b/lib/Elastica/Aggregation/GeoBounds.php
@@ -1,10 +1,11 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 /**
  * A metric aggregation that computes the bounding box containing all geo_point values for a field.
  *
- * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html
  */
 class GeoBounds extends AbstractAggregation
 {

diff --git a/lib/Elastica/Aggregation/GeoCentroid.php b/lib/Elastica/Aggregation/GeoCentroid.php
@@ -1,10 +1,11 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 /**
  * Class GeoCentroid.
  *
- * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geocentroid-aggregation.html
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geocentroid-aggregation.html
  */
 class GeoCentroid extends AbstractAggregation
 {

diff --git a/lib/Elastica/Aggregation/GeoDistance.php b/lib/Elastica/Aggregation/GeoDistance.php
@@ -1,12 +1,13 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 use Elastica\Exception\InvalidException;
 
 /**
  * Class GeoDistance.
  *
- * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geodistance-aggregation.html
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geodistance-aggregation.html
  */
 class GeoDistance extends AbstractAggregation
 {

diff --git a/lib/Elastica/Aggregation/GeohashGrid.php b/lib/Elastica/Aggregation/GeohashGrid.php
@@ -1,10 +1,11 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 /**
  * Class GeohashGrid.
  *
- * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geohashgrid-aggregation.html
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geohashgrid-aggregation.html
  */
 class GeohashGrid extends AbstractAggregation
 {

diff --git a/lib/Elastica/Aggregation/GlobalAggregation.php b/lib/Elastica/Aggregation/GlobalAggregation.php
@@ -1,10 +1,11 @@
 <?php
+
 namespace Elastica\Aggregation;
 
 /**
  * Class GlobalAggregation.
  *
- * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-global-aggregation.html
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-global-aggregation.html
  */
 class GlobalAggregation extends AbstractAggregation
 {