Small code refactoring. Constructor property promotion.

kayukoff · Dec 1, 2023 · 39f54e1 · 39f54e1
1 parent 7a8dd80
commit 39f54e1
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 87 deletions.
diff --git a/composer.json b/composer.json
@@ -9,7 +9,7 @@
     }
   ],
   "require": {
-    "php": "^8.0",
+    "php": ">=8.1",
     "symfony/process": "^5.0|^6.0",
     "spatie/temporary-directory": "^2.0"
   },

diff --git a/src/Area.php b/src/Area.php
@@ -1,23 +1,15 @@
 <?php
 
-
 namespace RandomState\Camelot;
 
-
 class Area
 {
-    protected int $xTopLeft;
-    protected int $yTopLeft;
-    protected int $xBottomRight;
-    protected int $yBottomRight;
-
-    public function __construct(int $xTopLeft, int $yTopLeft, int $xBottomRight, int $yBottomRight)
-    {
-        $this->xTopLeft = $xTopLeft;
-        $this->yTopLeft = $yTopLeft;
-        $this->xBottomRight = $xBottomRight;
-        $this->yBottomRight = $yBottomRight;
-    }
+    public function __construct(
+        protected int $xTopLeft,
+        protected int $yTopLeft,
+        protected int $xBottomRight,
+        protected int $yBottomRight,
+    ) {}
 
     public function xTopLeft(): int
     {

diff --git a/src/Areas.php b/src/Areas.php
@@ -1,9 +1,7 @@
 <?php
 
-
 namespace RandomState\Camelot;
 
-
 class Areas
 {
     protected array $areas = [];

diff --git a/src/Camelot.php b/src/Camelot.php
@@ -1,9 +1,7 @@
 <?php
 
-
 namespace RandomState\Camelot;
 
-
 use RandomState\Camelot\Exceptions\BackgroundLinesNotSupportedException;
 use RandomState\Camelot\Exceptions\ColumnSeparatorsNotSupportedException;
 use RandomState\Camelot\Exceptions\PdfEncryptedException;
@@ -17,96 +15,44 @@ class Camelot
 
     /**
      * lattice | stream
-     *
-     * @var string
      */
     protected string $mode;
 
     /**
      * csv | json | excel | html | sqlite
-     *
-     * @var string
      */
     protected string $format = 'csv';
 
-    /**
-     * @var string
-     */
     protected string $path;
 
-    /**
-     * @var string
-     */
     protected string $pages = '';
 
-    /**
-     * @var string
-     */
     protected string $password = '';
 
-    /**
-     * @var string
-     */
     protected string $processBackgroundLines = '';
 
-    /**
-     * @var string
-     */
     protected string $plot = '';
 
-    /**
-     * @var Areas|null
-     */
     protected ?Areas $areas = null;
 
-    /**
-     * @var Areas|null
-     */
     protected ?Areas $regions = null;
 
-    /**
-     * @var array
-     */
     protected array $columnSeparators = [];
 
-    /**
-     * @var bool
-     */
     protected bool $splitAlongSeparators = false;
 
-    /**
-     * @var bool
-     */
     protected bool $flagSize = false;
 
-    /**
-     * @var string
-     */
     protected string $unwantedCharacters = '';
 
-    /**
-     * @var int|null
-     */
     protected ?int $edgeTolerance = null;
 
-    /**
-     * @var int|null
-     */
     protected ?int $rowTolerance = null;
 
-    /**
-     * @var int|null
-     */
     protected ?int  $lineScale = null;
 
-    /**
-     * @var array
-     */
     protected array $textShift = [];
 
-    /**
-     * @var array
-     */
     protected array $copyTextDirections = [];
 
     public function __construct(string $path, ?string $mode = null)
@@ -368,5 +314,4 @@ public function copyTextSpanningCells(...$directions): self
 
         return $this;
     }
-
 }
diff --git a/src/Exceptions/BackgroundLinesNotSupportedException.php b/src/Exceptions/BackgroundLinesNotSupportedException.php
@@ -1,9 +1,7 @@
 <?php
 
-
 namespace RandomState\Camelot\Exceptions;
 
-
 use RandomState\Camelot\Camelot;
 
 class BackgroundLinesNotSupportedException extends NotSupportedException
@@ -17,7 +15,7 @@ protected function validModes(): array
 
     protected function featureName(): string
     {
-        return "processing background lines";
+        return 'processing background lines';
     }
 
 }
diff --git a/src/Exceptions/ColumnSeparatorsNotSupportedException.php b/src/Exceptions/ColumnSeparatorsNotSupportedException.php
@@ -1,9 +1,7 @@
 <?php
 
-
 namespace RandomState\Camelot\Exceptions;
 
-
 use RandomState\Camelot\Camelot;
 
 class ColumnSeparatorsNotSupportedException extends NotSupportedException
@@ -17,7 +15,6 @@ protected function validModes(): array
 
     protected function featureName(): string
     {
-        return "column separators";
+        return 'column separators';
     }
-
 }
diff --git a/src/Exceptions/NotSupportedException.php b/src/Exceptions/NotSupportedException.php
@@ -1,14 +1,12 @@
 <?php
 
-
 namespace RandomState\Camelot\Exceptions;
 
-
 abstract class NotSupportedException extends \Exception
 {
     public function __construct(string $mode)
     {
-        parent::__construct("Processing mode '$mode' does not support ". $this->featureName() . ". It can be used with ". $this->validModesString().".");
+        parent::__construct(sprintf('Processing mode "%s" does not support "%s". It can be used with "%s"', $mode, $this->featureName(), $this->validModesString()));
     }
 
     private function validModesString(): string
@@ -18,6 +16,8 @@ private function validModesString(): string
 
         return count($validModes) > 1 ? $modes . ' modes' : $modes . ' mode';
     }
+
     abstract protected function validModes(): array;
+
     abstract protected function featureName(): string;
 }
diff --git a/src/Exceptions/PdfEncryptedException.php b/src/Exceptions/PdfEncryptedException.php
@@ -1,15 +1,11 @@
 <?php
 
-
 namespace RandomState\Camelot\Exceptions;
 
-
-use Throwable;
-
 class PdfEncryptedException extends \Exception
 {
     public function __construct(string $filePath)
     {
-        parent::__construct("The PDF $filePath is encrypted and cannot be read without a password. Supply a password with \$camelot->password('my_password').");
+        parent::__construct(sprintf('The PDF "%s" is encrypted and cannot be read without a password. Supply a password with $camelot->password(\'my_password\').', $filePath));
     }
 }