🔧 add support for rector (#189)

Author: sebastianMindee

.github/workflows/_static-analysis.yml

@@ -38,3 +38,7 @@ jobs:
     - name: Run PHPStan
       run: |
         composer phpstan
+
+    - name: Run Rector
+      run: |
+        composer rector:check

bin/MindeeCLICommand.php

@@ -8,7 +8,7 @@
 use Mindee\Input\InputSource;
 use Mindee\Input\PageOptions;
 use Mindee\Input\PathInput;
-use Mindee\Input\URLInputSource;
+use Mindee\Input\UrlInputSource;
 use Mindee\V1\Client;
 use Mindee\V1\ClientOptions\PredictMethodOptions;
 use Mindee\V1\ClientOptions\PredictOptions;
@@ -359,7 +359,7 @@ private function areMutuallyExclusivePagesOptions(InputInterface $input, OutputI
      * @param string $filePathOrUrl Path of the file, or URL if it's remote.
      * @param Client $client Mindee Client.
      * @param OutputInterface $output Output interface of the CLI.
-     * @return PathInput|URLInputSource|null A valid InputSource.
+     * @return PathInput|UrlInputSource|null A valid InputSource.
      */
     private function getFileSource(string $filePathOrUrl, Client $client, OutputInterface $output)
     {

composer.json

@@ -17,7 +17,9 @@
     "friendsofphp/php-cs-fixer": "^3.38",
     "phpunit/phpunit": "^9.6",
     "madewithlove/license-checker": "^v1.0",
-    "phpstan/phpstan": "^2.1"
+    "phpstan/phpstan": "^2.1",
+    "phpstan/phpstan-deprecation-rules": "^2.0",
+    "rector/rector": "^2.4"
   },
   "suggest": {
     "ext-imagick": "Required for PDF rasterization and image processing features",
@@ -35,6 +37,8 @@
   "scripts": {
     "lint": "php-cs-fixer fix --dry-run --diff",
     "phpstan": "phpstan analyse src --level 6",
-    "format": "php-cs-fixer fix"
+    "format": "php-cs-fixer fix",
+    "rector": "rector process src tests",
+    "rector:check": "rector process src tests --dry-run"
   }
 }

docs/code_samples/v2_extraction_webhook.txt

@@ -16,7 +16,7 @@ $mindeeClient = new Client($apiKey);
 $inferenceParams = new ExtractionParameters(
     // ID of the model, required.
     $modelId,
-    webhooksIds: ["MY_WEBHOOK_ID"],
+    webhookIds: ["MY_WEBHOOK_ID"],
 
     // Options: set to `true` or `false` to override defaults
 

docs/code_samples/v2_ocr.txt

@@ -1,8 +1,8 @@
 <?php
 
 use Mindee\V2\Client;
-use Mindee\V2\Product\OCR\Params\OCRParameters;
-use Mindee\V2\Product\OCR\OCRResponse;
+use Mindee\V2\Product\Ocr\Params\OcrParameters;
+use Mindee\V2\Product\Ocr\OcrResponse;
 use Mindee\Input\PathInput;
 
 $apiKey = "MY_API_KEY";
@@ -14,7 +14,7 @@ $mindeeClient = new Client($apiKey);
 
 // Set ocr parameters
 // Note: modelId is mandatory.
-$ocrParams = new OCRParameters(
+$ocrParams = new OcrParameters(
     // ID of the model, required.
     $modelId,
 );

rector.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+     ->withPhpSets()
+    ->withTypeCoverageLevel(0)
+    ->withDeadCodeLevel(0)
+    ->withCodeQualityLevel(0);

src/Dependency/DependencyChecker.php

@@ -48,7 +48,7 @@ public static function isGhostscriptAvailable(): void
             } else {
                 $commandWasExecuted = (bool) shell_exec('which gs');
             }
-        } catch (Exception $e) {
+        } catch (Exception) {
             throw new MindeeUnhandledException(
                 "To enable full support of PDF features, you need "
                 . "to enable Ghostscript on your PHP installation.",
@@ -96,7 +96,7 @@ public static function isImageMagickPolicyAllowed(): void
                 /** @phpstan-ignore-next-line */
                 TestingUtilities::getV1DataDir() . "/products/expense_receipts/default_sample.jpg"
             );
-        } catch (Exception $e) {
+        } catch (Exception) {
             throw new MindeeUnhandledException(
                 "To enable full support of PDF features, you need "
                 . "to enable ImageMagick on your PHP installation. Also, you "

src/Error/MindeeHttpException.php

@@ -20,10 +20,6 @@
  */
 class MindeeHttpException extends MindeeException
 {
-    /**
-     * @var integer Status code as sent by the server.
-     */
-    public int $statusCode;
     /**
      * @var string|null API code as sent by the server.
      */
@@ -40,11 +36,10 @@ class MindeeHttpException extends MindeeException
     /**
      * @param array<string, int|float|string|bool|null|array<array-key, mixed>> $httpError Array containing the error data.
      * @param string $url Remote URL the error was found on.
-     * @param integer $code Error code.
+     * @param integer $statusCode Error code.
      */
-    public function __construct(array $httpError, string $url, int $code)
+    public function __construct(array $httpError, string $url, public int $statusCode)
     {
-        $this->statusCode = $code;
         if (array_key_exists('code', $httpError)) {
             $this->apiCode = $httpError['code'];
         } else {

src/Error/MindeePDFException.php src/Error/MindeePdfException.phpsrc/Error/MindeePDFException.php renamed to src/Error/MindeePdfException.php

@@ -12,4 +12,4 @@
 /**
  *  Exceptions relating to the handling of PDF documents.
  */
-class MindeePDFException extends MindeeException {}
+class MindeePdfException extends MindeeException {}

src/Extraction/ExtractedImage.php

@@ -19,51 +19,21 @@
  */
 class ExtractedImage
 {
-    /**
-     * @var Imagick Wrapper for the image.
-     */
-    public Imagick $image;
-
-    /**
-     * @var string Name of the file.
-     */
-    public string $filename;
-
-    /**
-     * @var integer Page ID of the image.
-     */
-    public int $pageId;
-
-    /**
-     * @var integer Element ID of the image.
-     */
-    public int $elementId;
-
-    /**
-     * @var string String representation of the save format.
-     */
-    protected string $saveFormat;
-
     /**
      * Initializes a new instance of the ExtractedImage class.
      *
      * @param Imagick $image The extracted image.
      * @param string $filename The filename for the image.
      * @param string $saveFormat The format to save the image.
-     * @param integer $pageIndex The page index of the image.
-     * @param integer $index The element index of the image.
+     * @param integer $pageId The page index of the image.
+     * @param integer $elementId The element index of the image.
      *
      * @throws MindeeUnhandledException Throws if PDF operations aren't supported.
      */
-    public function __construct(Imagick $image, string $filename, string $saveFormat, int $pageIndex, int $index)
+    public function __construct(public Imagick $image, public string $filename, protected string $saveFormat, public int $pageId, public int $elementId)
     {
         DependencyChecker::isImageMagickAvailable();
         DependencyChecker::isGhostscriptAvailable();
-        $this->image = $image;
-        $this->filename = $filename;
-        $this->saveFormat = $saveFormat;
-        $this->pageId = $pageIndex;
-        $this->elementId = $index;
     }
 
     /**