Merge pull request #1 from skoro/phpstan

Phpstan integration

Author: skoro

composer.json

@@ -25,7 +25,8 @@
         }
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.5"
+        "phpunit/phpunit": "^9.5",
+        "phpstan/phpstan": "^1.3"
     },
     "autoload-dev": {
         "psr-4": {
@@ -35,6 +36,7 @@
     "scripts": {
         "test": "phpunit",
         "test-f": "phpunit --filter",
-        "make-color-names": "@php make-color-names.php colors.txt > ./src/ColorNames.php"
+        "make-color-names": "@php make-color-names.php colors.txt > ./src/ColorNames.php",
+        "check": "phpstan"
     }
 }

composer.lock

@@ -0,0 +1,9 @@
+parameters:
+  level: 4
+  paths:
+    - src
+    - tests
+
+  ignoreErrors:
+    - '#Call to an undefined method FFI::Tcl_#'
+    - '#Call to an undefined method FFI::Tk_#'

phpstan.neon.dist

@@ -13,14 +13,14 @@ class Color
     private int $green;
     private int $blue;
 
-    public function __construct(string $hex)
+    final public function __construct(string $hex)
     {
         $this->extractColors($hex);
     }
 
     protected function extractColors(string $hex)
     {
-        list ($red, $green, $blue) = sscanf($hex, '#%02x%02x%02x');
+        [$red, $green, $blue] = sscanf($hex, '#%02x%02x%02x');
         if ($red !== null && $green !== null && $blue !== null) {
             $this->red = $red;
             $this->green = $green;
@@ -35,7 +35,7 @@ protected static function assertUnsignedByte(int $value): int
         if ($value >= 0 && $value <= 255) {
             return $value;
         }
-        throw new InvalidArgumentException('Argument must be unsigned byte.');
+        throw new InvalidArgumentException(sprintf('Argument must be unsigned byte but got: %d', $value));
     }
 
     public static function fromRgb(int $red, int $green, int $blue): self

src/Color.php

@@ -17,10 +17,10 @@ abstract class Dialog implements ModalWindow
     private Options $options;
     private Window $parent;
 
-    /** @var callable */
-    private $callbackSuccess;
-    /** @var callable */
-    private $callbackCancel;
+    /** @var callable|null */
+    private $callbackSuccess = null;
+    /** @var callable|null */
+    private $callbackCancel = null;
 
     public function __construct(Window $parent, array $options = [])
     {
@@ -59,6 +59,7 @@ public function __set($name, $value)
                     throw new TkException('Parent must be a Window instance.');
                 }
                 $this->parent = $value;
+                /** @phpstan-ignore-next-line */
                 $this->options->parent = $value->path();
                 break;
 

src/Dialogs/Dialog.php

@@ -8,7 +8,7 @@
 /**
  * .env file environment loader.
  */
-class DotEnv implements Environment
+final class DotEnv implements Environment
 {
     private array $data;
     private string $path;
@@ -55,7 +55,7 @@ public function load(): void
     public function loadAndMergeWith(array $override): void
     {
         $this->load();
-        array_merge($this->data, $override);
+        $this->data = array_merge($this->data, $override);
     }
 
     /**

src/DotEnv.php

@@ -20,7 +20,7 @@ class Font implements SplSubject
     /** @var SplObserver[] */
     private array $observers;
 
-    /** @var bool[string] */
+    /** @var array<string, bool> */
     private array $styles;
 
     public function __construct(string $name, int $size, ...$styles)
@@ -35,7 +35,7 @@ public function __construct(string $name, int $size, ...$styles)
     }
 
     /**
-     * @return bool[string]
+     * @return array<string, bool>
      */
     protected function defaultStyles(): array
     {
@@ -87,7 +87,7 @@ public function setSize(int $size): self
     }
 
     /**
-     * @return bool[string]
+     * @return array<string, bool>
      */
     public function getStyles(): array
     {
@@ -186,11 +186,17 @@ public function attach(SplObserver $observer): void
         $this->observers[] = $observer;
     }
 
-    public function detach(SplObserver $observer)
+    public function detach(SplObserver $observer): void
     {
         $index = array_search($observer, $this->observers, true);
         if ($index !== false) {
             unset($this->observers[$index]);
         }
     }
+
+    // TODO: php8 Stringable interface
+    public function __toString(): string
+    {
+        return sprintf('%s %d', $this->name, $this->size);
+    }
 }

src/Font.php

@@ -13,9 +13,14 @@ class Options
 {
     private array $options = [];
 
-    public function __construct(array $options = [])
+    final public function __construct(array $options = [])
     {
-        $this->options = $options;
+        $this->mergeAsArray($this->defaults(), $options);
+    }
+
+    protected function defaults(): array
+    {
+        return [];
     }
 
     /**
@@ -124,9 +129,9 @@ public function merge(Options $options): self
     /**
      * Merge options from an array.
      */
-    public function mergeAsArray(array $options): self
+    public function mergeAsArray(array ...$options): self
     {
-        $this->options = array_merge($this->options, $options);
+        $this->options = array_merge($this->options, ...$options);
         return $this;
     }
 

src/Options.php

@@ -48,7 +48,6 @@ class TkApplication implements Application
     public function __construct(Tk $tk)
     {
         $this->tk = $tk;
-        $this->ttkEnabled = false;
         $this->interp = $tk->interp();
         $this->bindings = $this->createBindings();
         $this->themeManager = null;
@@ -64,7 +63,7 @@ protected function createBindings(): Bindings
         return new TkBindings($this->interp);
     }
 
-    protected function createFontManager(): FontManager
+    protected function createFontManager(): TkFontManager
     {
         return new TkFontManager($this->interp);
     }

src/TclTk/TkApplication.php

@@ -4,7 +4,7 @@
 
 use PhpGui\Font;
 
-class TkFont extends Font
+final class TkFont extends Font
 {
     public function __toString(): string
     {
@@ -31,4 +31,14 @@ protected function getStyleNames(): array
     {
         return array_keys(array_filter($this->getStyles()));
     }
+
+    public static function createFromFontOptions(TkFontOptions $fontOptions): self
+    {
+        $font = new static($fontOptions->family, (int) $fontOptions->size);
+        $font->setBold($fontOptions->weight === 'bold')
+             ->setItalic($fontOptions->slant === 'italic')
+             ->setUnderline((bool) $fontOptions->underline)
+             ->setOverstrike((bool) $fontOptions->overstrike);
+        return $font;
+    }
 }