Merge pull request #80 from rokka-io/cs

apply cs fixes

.php-cs-fixer.dist.php

@@ -1,5 +1,7 @@
 <?php
 
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
+
 $finder = PhpCsFixer\Finder::create()
     ->notPath('src/AppBundle/Command/TestCommand.php')
     ->exclude('tests/*/Fixtures')
@@ -10,6 +12,7 @@
 $config = new PhpCsFixer\Config();
 
 return $config
+    ->setParallelConfig(ParallelConfigFactory::detect())
     ->setRiskyAllowed(true)
     ->setRules([
         '@Symfony' => true,

composer.json

@@ -33,8 +33,8 @@
     "require-dev": {
         "phpunit/phpunit": "^9.5.25",
         "symfony/var-dumper": "^3.4|^4.0|^5.0|^6.0",
-        "phpstan/phpstan": "^1.7",
-        "friendsofphp/php-cs-fixer": "^3.4"
+        "phpstan/phpstan": "^1.11",
+        "friendsofphp/php-cs-fixer": "^3.57"
     },
     "autoload": {
         "psr-4": {

phpstan.neon

@@ -2,5 +2,9 @@ parameters:
     level: 7
     paths:
         - src/
-    checkMissingIterableValueType: false
-    checkGenericClassInNonGenericObjectType: false
+    treatPhpDocTypesAsCertain: false
+    ignoreErrors:
+        -
+            identifier: missingType.generics
+        -
+            identifier: missingType.iterableValue

scripts/doctum-config.php

@@ -1,7 +1,7 @@
 <?php
 
-use Doctum\RemoteRepository\GitHubRemoteRepository;
 use Doctum\Doctum;
+use Doctum\RemoteRepository\GitHubRemoteRepository;
 use Doctum\Version\GitVersionCollection;
 use Symfony\Component\Finder\Finder;
 

src/Core/DynamicMetadata/DetectionFace.php

@@ -60,6 +60,9 @@ public static function getName()
         return 'detection_face';
     }
 
+    /**
+     * @return $this
+     */
     public function getForJson()
     {
         return $this;

src/Core/DynamicMetadata/DynamicMetadataInterface.php

@@ -24,7 +24,7 @@ public static function createFromDecodedJsonResponse($data);
     /**
      * Get the data, which should be json-fied later.
      *
-     * @return mixed
+     * @return mixed The data that will be encoded to JSON
      */
     public function getForJson();
 }

src/Core/DynamicMetadata/SubjectArea.php

@@ -88,6 +88,9 @@ public static function getName()
         return 'subject_area';
     }
 
+    /**
+     * @return $this
+     */
     public function getForJson()
     {
         return $this;

src/Core/DynamicMetadata/Version.php

@@ -31,11 +31,12 @@ public static function getName()
      */
     public static function createFromDecodedJsonResponse($data)
     {
-        $object = new self($data['text']);
-
-        return $object;
+        return new self($data['text']);
     }
 
+    /**
+     * @return self
+     */
     public function getForJson()
     {
         return $this;

src/Core/SourceImage.php

@@ -96,24 +96,20 @@ class SourceImage
     public $locked;
 
     /**
-     * Constructor.
-     *
-     * @param string    $organization    Organization
-     * @param string    $binaryHash      Binary hash
-     * @param string    $hash            Hash
-     * @param string    $name            Original name
-     * @param string    $format          Format
-     * @param int       $size            File size in bytes
-     * @param int       $width           Width in pixels
-     * @param int       $height          Height in pixels
-     * @param array     $userMetadata    User metadata
-     * @param array     $dynamicMetadata Dynamic metadata
-     * @param \DateTime $created         Created at date
-     * @param string    $link            Link to the image
-     * @param string    $shortHash       The short hash
-     * @param bool      $protected       Is image protected
-     * @param bool      $locked          Is image locked
-     * @param mixed     $mimetype
+     * @param string    $organization
+     * @param string    $binaryHash
+     * @param string    $hash
+     * @param string    $name         Original name
+     * @param string    $format
+     * @param string    $mimetype
+     * @param int       $size         File size in bytes
+     * @param int       $width        Width in pixels
+     * @param int       $height       Height in pixels
+     * @param \DateTime $created      Created at date
+     * @param string    $link         Link to the image
+     * @param string    $shortHash
+     * @param bool      $protected
+     * @param bool      $locked
      */
     public function __construct(
         $organization,
@@ -165,7 +161,7 @@ public static function createFromDecodedJsonResponse(array $data): self
             $data['user_metadata'] = [];
         } else {
             foreach ($data['user_metadata'] as $key => $value) {
-                if (0 === strpos($key, 'date:')) {
+                if (str_starts_with($key, 'date:')) {
                     $data['user_metadata'][$key] = new \DateTime($value);
                 }
             }

src/Core/Stack.php

@@ -35,7 +35,7 @@ class Stack extends AbstractStack
      * @param array       $stackOptions    Collection of stack options
      * @param \DateTime   $created         Created at
      */
-    public function __construct($organization = null, $name = null, array $stackOperations = [], array $stackOptions = [], \DateTime $created = null)
+    public function __construct($organization = null, $name = null, array $stackOperations = [], array $stackOptions = [], ?\DateTime $created = null)
     {
         parent::__construct($name, $stackOperations, $stackOptions);
         $this->organization = $organization;

src/Core/StackCollection.php

@@ -27,7 +27,7 @@ class StackCollection implements \Countable, \Iterator
      *
      * @param array $stacks Array of stacks
      */
-    public function __construct(array $stacks, string $cursor = null)
+    public function __construct(array $stacks, ?string $cursor = null)
     {
         foreach ($stacks as $stack) {
             if (!($stack instanceof Stack)) {

src/Core/StackUri.php

@@ -36,7 +36,7 @@ public function __construct($name = null, array $stackOperations = [], array $st
     {
         parent::__construct($name, $stackOperations, $stackOptions, $stackVariables);
 
-        if (null !== $name && false !== strpos($name, '/')) {
+        if (null !== $name && str_contains($name, '/')) {
             // Some part of a rokka URL can have // in it, but it means nothing, remove them here.
             $name = preg_replace('#/{2,}#', '/', $name);
             if (!\is_string($name)) {

src/Core/UriComponents.php

@@ -50,9 +50,9 @@ public function __construct($stack, $hash = null, $format = null, $filename = nu
     /**
      * Creates a UriComponent object from an array with 'stack', 'hash', 'format', 'filename' and 'stack' as keys.
      *
-     * @since 1.2.0
+     * @param array{stack: string, hash?: ?string, format?: ?string, filename?: ?string} $config
      *
-     * @param mixed $config
+     * @since 1.2.0
      */
     public static function createFromArray($config): self
     {

src/Core/UserApiKey.php

@@ -52,7 +52,7 @@ public function __construct($id, $created, $accessed, $comment, $apiKey)
      *
      * @param array $apiKeys
      *
-     * @return \Rokka\Client\Core\UserApiKey
+     * @return UserApiKey
      */
     public static function createFromArray($apiKeys)
     {

src/Core/UserApiToken.php

@@ -31,7 +31,7 @@ public function __construct($token, $payload)
      *
      * @param array $resonse
      *
-     * @return \Rokka\Client\Core\UserApiToken
+     * @return UserApiToken
      */
     public static function createFromArray($resonse)
     {

src/Factory.php

@@ -37,7 +37,7 @@ class Factory
      *
      * @throws \RuntimeException
      *
-     * @return Image
+     * @return ImageClient
      */
     public static function getImageClient($organization, $apiKey, $options = [])
     {
@@ -152,8 +152,8 @@ private static function retryDecider()
         return function (
             $retries,
             Request $request,
-            Response $response = null,
-            TransferException $exception = null
+            ?Response $response = null,
+            ?TransferException $exception = null
         ) {
             // Limit the number of retries to 10
             if ($retries >= 10) {

src/Image.php

@@ -39,7 +39,7 @@ class Image extends Base
     /**
      * @var string|null the render base url like foo-org.rokka.io
      */
-    private $renderBaseUrl = null;
+    private $renderBaseUrl;
 
     /**
      * Constructor.
@@ -470,13 +470,13 @@ public function createStack(
      *
      * Example:
      * ```language-php
-        $stack = new Stack(null, 'teststack');
-        $stack->addStackOperation(new StackOperation('resize', ['width' => 200, 'height' => 200]));
-        $stack->addStackOperation(new StackOperation('rotate', ['angle' => 45]));
-        $stack->setStackOptions(['jpg.quality' => 80]);
-        $requestConfig = ['overwrite' => true];
-        $stack = $client->saveStack($stack, $requestConfig);
-        echo 'Created stack ' . $stack->getName() . PHP_EOL;
+     * $stack = new Stack(null, 'teststack');
+     * $stack->addStackOperation(new StackOperation('resize', ['width' => 200, 'height' => 200]));
+     * $stack->addStackOperation(new StackOperation('rotate', ['angle' => 45]));
+     * $stack->setStackOptions(['jpg.quality' => 80]);
+     * $requestConfig = ['overwrite' => true];
+     * $stack = $client->saveStack($stack, $requestConfig);
+     * echo 'Created stack ' . $stack->getName() . PHP_EOL;
      * ```
      * The only requestConfig option currently can be
      * ['overwrite' => true|false] (false is the default)
@@ -691,12 +691,12 @@ public function setProtected($protected, $hash, $organization = '', $options = [
         $callOptions['json'] = $protected;
 
         $path = implode('/', [
-                self::SOURCEIMAGE_RESOURCE,
-                $this->getOrganizationName($organization),
-                $hash,
-                'options',
-                'protected',
-            ]);
+            self::SOURCEIMAGE_RESOURCE,
+            $this->getOrganizationName($organization),
+            $hash,
+            'options',
+            'protected',
+        ]);
 
         // delete the previous, if we're not on the first one anymore, or if we want to delete it.
         if (isset($options['deletePrevious']) && $options['deletePrevious']) {
@@ -766,10 +766,10 @@ public function addAutolabels($hash, $organization = null): SourceImage
     }
 
     /**
-     * @param string[]    $languages
-     * @param string      $hash
-     * @param string|null $organization
-     * @param array       $options, for example ['force' => true] to recreate
+     * @param string[]            $languages
+     * @param string              $hash
+     * @param string|null         $organization
+     * @param array{force?: bool} $options      if force is true, the description is generated again even if it already exists
      */
     public function addAutodescription($languages, $hash, $organization = null, array $options = []): SourceImage
     {

src/LocalImage/AbstractLocalImage.php

@@ -9,9 +9,9 @@
  *
  * See some implementation of the abstract class for examples.
  *
- * @see \Rokka\Client\LocalImage\FileInfo
- * @see \Rokka\Client\LocalImage\RokkaHash
- * @see \Rokka\Client\LocalImage\StringContent
+ * @see FileInfo
+ * @see RokkaHash
+ * @see StringContent
  * @since 1.3.0
  */
 abstract class AbstractLocalImage
@@ -21,14 +21,14 @@ abstract class AbstractLocalImage
      *
      * @var mixed|null
      */
-    protected $context = null;
+    protected $context;
 
     /**
      * The rokka hash from the rokka API.
      *
      * @var string|null
      */
-    protected $rokkaHash = null;
+    protected $rokkaHash;
 
     /**
      * A unique identifier for this image, can be any string.
@@ -37,7 +37,7 @@ abstract class AbstractLocalImage
      *
      * @var string|null
      */
-    protected $identifier = null;
+    protected $identifier;
 
     /**
      * @since 1.3.0

src/LocalImage/FileInfo.php

@@ -21,7 +21,7 @@
  * $image = new StringContent($content, $identifier, $context);
  * ```
  *
- * @see \Rokka\Client\LocalImage\StringContent
+ * @see StringContent
  * @since 1.3.0
  */
 class FileInfo extends AbstractLocalImage
@@ -34,12 +34,12 @@ class FileInfo extends AbstractLocalImage
     /**
      * @var string|null
      */
-    private $content = null;
+    private $content;
 
     /**
      * @var string|null
      */
-    private $filename = null;
+    private $filename;
 
     public function __construct(\SplFileInfo $image, $identifier = null, $context = null)
     {

src/LocalImage/RokkaHash.php

@@ -24,7 +24,7 @@ class RokkaHash extends AbstractLocalImage
     /**
      * @var string|null
      */
-    private $content = null;
+    private $content;
 
     /**
      * @var TemplateHelper|null

src/LocalImage/StringContent.php

@@ -13,15 +13,15 @@
  * $image = new StringContent($content, $identifier, $context);
  * ```
  *
- * @see \Rokka\Client\LocalImage\FileInfo
+ * @see FileInfo
  * @since 1.3.0
  */
 class StringContent extends AbstractLocalImage
 {
     /**
      * @var string|null
      */
-    private $content = null;
+    private $content;
 
     /**
      * @param string|null $image

src/SearchHelper.php

@@ -20,6 +20,7 @@ public static function validateFieldName($fieldName)
         if ('deletedDate' === $fieldName) {
             return true;
         }
+
         // Field names must be shorter than 54 chars, and match the given format.
         return 54 > \strlen($fieldName) && (1 === preg_match('/^(user:((str|array|date|latlon|int|double):)?)?[a-z0-9_]{1,54}$/', $fieldName)
             || 1 === preg_match('/^((dynamic|static):((str|array|date|latlon|int|double):))?[a-z0-9_]+:[a-z0-9_]{1,54}$/', $fieldName));