Add ecs with an opinionated default

Author: GenieTim

composer.json

@@ -24,7 +24,9 @@
     "php": ">=5.6"
   },
   "require-dev": {
-    "phpunit/phpunit": "^5.7 | ^7.5 | ^8.0 | ^9.0"
+    "phpunit/phpunit": "^5.7 | ^7.5 | ^8.0 | ^9.0",
+    "rector/rector": "^0.13.6",
+    "symplify/easy-coding-standard": "^11.0"
   },
   "autoload": {
     "psr-4": {
@@ -33,5 +35,10 @@
     "files": [
       "lib/Common/customFunctions.php"
     ]
+  },
+  "scripts": {
+    "check-cs": "./vendor/bin/ecs check",
+    "fix-cs": "./vendor/bin/ecs check --fix",
+    "tests": "./vendor/bin/phpunit"
   }
 }

ecs.php

@@ -0,0 +1,29 @@
+<?php
+
+use Rector\Set\ValueObject\LevelSetList;
+use PhpCsFixer\Fixer\Operator\ConcatSpaceFixer;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+use Symplify\EasyCodingStandard\ValueObject\Option;
+
+use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer;
+use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ECSConfig $configurator): void {
+
+  // alternative to CLI arguments, easier to maintain and extend
+  $configurator->paths([__DIR__ . '/lib', __DIR__ . '/tests']);
+
+  // choose 
+  $configurator->sets([
+    SetList::CLEAN_CODE, SetList::PSR_12//, LevelSetList::UP_TO_PHP_81 //, SymfonySetList::SYMFONY_60
+  ]);
+
+  $configurator->ruleWithConfiguration(ConcatSpaceFixer::class, [
+    'spacing' => 'one'
+  ]);
+
+  // indent and tabs/spaces
+  // [default: spaces]. BUT: tabs are superiour due to accessibility reasons
+  $configurator->indentation('tab');
+};

lib/Binarizer.php

@@ -30,67 +30,67 @@
  */
 abstract class Binarizer
 {
-    private $source;
+	private $source;
 
-    protected function __construct($source)
-    {
-        $this->source = $source;
-    }
+	protected function __construct($source)
+	{
+		$this->source = $source;
+	}
 
-    /**
-     * @return LuminanceSource
-     */
-    public final function getLuminanceSource()
-    {
-        return $this->source;
-    }
+	/**
+	 * @return LuminanceSource
+	 */
+	final public function getLuminanceSource()
+	{
+		return $this->source;
+	}
 
-    /**
-     * Converts one row of luminance data to 1 bit data. May actually do the conversion, or return
-     * cached data. Callers should assume this method is expensive and call it as seldom as possible.
-     * This method is intended for decoding 1D barcodes and may choose to apply sharpening.
-     * For callers which only examine one row of pixels at a time, the same BitArray should be reused
-     * and passed in with each call for performance. However it is legal to keep more than one row
-     * at a time if needed.
-     *
-     * @param y   The row to fetch, which must be in [0, bitmap height)
-     * @param row An optional preallocated array. If null or too small, it will be ignored.
-     *            If used, the Binarizer will call BitArray.clear(). Always use the returned object.
-     *
-     * @return array The array of bits for this row (true means black).
-     * @throws NotFoundException if row can't be binarized
-     */
-    public abstract function getBlackRow($y, $row);
+	/**
+	 * Converts one row of luminance data to 1 bit data. May actually do the conversion, or return
+	 * cached data. Callers should assume this method is expensive and call it as seldom as possible.
+	 * This method is intended for decoding 1D barcodes and may choose to apply sharpening.
+	 * For callers which only examine one row of pixels at a time, the same BitArray should be reused
+	 * and passed in with each call for performance. However it is legal to keep more than one row
+	 * at a time if needed.
+	 *
+	 * @param $y   The row to fetch, which must be in [0, bitmap height)
+	 * @param An $row optional preallocated array. If null or too small, it will be ignored.
+	 *            If used, the Binarizer will call BitArray.clear(). Always use the returned object.
+	 *
+	 * @return array The array of bits for this row (true means black).
+	 * @throws NotFoundException if row can't be binarized
+	 */
+	abstract public function getBlackRow($y, $row);
 
-    /**
-     * Converts a 2D array of luminance data to 1 bit data. As above, assume this method is expensive
-     * and do not call it repeatedly. This method is intended for decoding 2D barcodes and may or
-     * may not apply sharpening. Therefore, a row from this matrix may not be identical to one
-     * fetched using getBlackRow(), so don't mix and match between them.
-     *
-     * @return BitMatrix The 2D array of bits for the image (true means black).
-     * @throws NotFoundException if image can't be binarized to make a matrix
-     */
-    public abstract function getBlackMatrix();
+	/**
+	 * Converts a 2D array of luminance data to 1 bit data. As above, assume this method is expensive
+	 * and do not call it repeatedly. This method is intended for decoding 2D barcodes and may or
+	 * may not apply sharpening. Therefore, a row from this matrix may not be identical to one
+	 * fetched using getBlackRow(), so don't mix and match between them.
+	 *
+	 * @return BitMatrix The 2D array of bits for the image (true means black).
+	 * @throws NotFoundException if image can't be binarized to make a matrix
+	 */
+	abstract public function getBlackMatrix();
 
-    /**
-     * Creates a new object with the same type as this Binarizer implementation, but with pristine
-     * state. This is needed because Binarizer implementations may be stateful, e.g. keeping a cache
-     * of 1 bit data. See Effective Java for why we can't use Java's clone() method.
-     *
-     * @param source The LuminanceSource this Binarizer will operate on.
-     *
-     * @return Binarizer A new concrete Binarizer implementation object.
-     */
-    public abstract function createBinarizer($source);
+	/**
+	 * Creates a new object with the same type as this Binarizer implementation, but with pristine
+	 * state. This is needed because Binarizer implementations may be stateful, e.g. keeping a cache
+	 * of 1 bit data. See Effective Java for why we can't use Java's clone() method.
+	 *
+	 * @param $source The LuminanceSource this Binarizer will operate on.
+	 *
+	 * @return Binarizer A new concrete Binarizer implementation object.
+	 */
+	abstract public function createBinarizer($source);
 
-    public final function getWidth()
-    {
-        return $this->source->getWidth();
-    }
+	final public function getWidth()
+	{
+		return $this->source->getWidth();
+	}
 
-    public final function getHeight()
-    {
-        return $this->source->getHeight();
-    }
+	final public function getHeight()
+	{
+		return $this->source->getHeight();
+	}
 }