análise de código estática e modernização de código

Author: fontebasso

.github/workflows/tests.yml

@@ -39,6 +39,9 @@ jobs:
       - name: Install dependencies
         run: composer install --no-interaction --prefer-dist --no-progress
 
+      - name: Run PHPStan
+        run: vendor/bin/phpstan analyse --configuration=phpstan.neon.dist
+
       - name: Run PHPCS (PSR-12)
         run: vendor/bin/phpcs --standard=PSR12 src
 

.qltyignore

@@ -0,0 +1 @@
+src/Resources/views/declaracao-conteudo-bootstrap.php

composer.json

@@ -24,6 +24,7 @@
   "license": "MIT",
   "require-dev": {
     "phpunit/phpunit": "^11.0",
-    "squizlabs/php_codesniffer": "3.*"
+    "squizlabs/php_codesniffer": "3.*",
+    "phpstan/phpstan": "^2.1"
   }
 }

phpstan.neon.dist

@@ -0,0 +1,7 @@
+parameters:
+  level: 9
+  paths:
+    - src
+  excludePaths:
+    analyse:
+      - src/Resources/views/declaracao-conteudo-bootstrap.php

src/Core/Controller.php

@@ -4,13 +4,21 @@
 
 class Controller
 {
-    public function view($name, $vars = [])
+    /**
+     * @param string $name
+     * @param array<string, mixed> $vars
+     * @return false|string
+     */
+    public function view(string $name, array $vars = []): false|string
     {
-
         extract($vars);
-        $ds = DIRECTORY_SEPARATOR;
         ob_start();
-        include __DIR__ . $ds . '..' . $ds . 'Resources' . $ds . 'views' . $ds . $name . '.php';
+        include __DIR__ . DIRECTORY_SEPARATOR .
+            '..' . DIRECTORY_SEPARATOR .
+            'Resources' . DIRECTORY_SEPARATOR .
+            'views' . DIRECTORY_SEPARATOR .
+            $name . '.php'
+        ;
         return ob_get_clean();
     }
 }

src/Core/Entity.php

@@ -2,22 +2,12 @@
 
 namespace Fontebasso\Correios\DeclaracaoConteudo\Core;
 
-/**
- * Class Entity
- *
- * @package  Fontebasso\Correios\DeclaracaoConteudo
- * @subpackage Core
- * @author   fontebasso <[email protected]>
- * @license  http://www.opensource.org/licenses/mit-license.html MIT License
- */
 class Entity
 {
     /**
-     * Entity constructor.
-     *
-     * @param array $params Lista de atributos da Entidade
+     * @param array<string, mixed> $params
      */
-    public function __construct($params = [])
+    public function __construct(array $params = [])
     {
         foreach ($params as $param => $value) {
             if (property_exists($this, $param)) {

src/Core/ItemBag.php

@@ -4,46 +4,43 @@
 
 use Fontebasso\Correios\DeclaracaoConteudo\Interfaces\ItemBagInterface;
 use Fontebasso\Correios\DeclaracaoConteudo\Interfaces\ItemInterface;
+use InvalidArgumentException;
 
-/**
- * Class ItemBag
- *
- * @package  Fontebasso\Correios\DeclaracaoConteudo
- * @subpackage Core
- * @author   fontebasso <[email protected]>
- * @license  http://www.opensource.org/licenses/mit-license.html MIT License
- */
 class ItemBag implements ItemBagInterface
 {
-    private $itens = [];
+    /**
+     * @var array<ItemInterface> $items
+     */
+    private array $items = [];
 
+    /**
+     * @param array<ItemInterface> $items
+     * @param string $classItem
+     */
     public function __construct(
-        array $itens = [],
-        $classItem = '\\Fontebasso\\Correios\\DeclaracaoConteudo\\Entities\\Item'
+        array $items = [],
+        string $classItem = '\\Fontebasso\\Correios\\DeclaracaoConteudo\\Entities\\Item'
     ) {
-        foreach ($itens as $item) {
-            if ($item instanceof $classItem) {
-                $this->itens[] = $item;
-            } else {
-                $this->itens[] = new $classItem($item);
+        foreach ($items as $item) {
+            if (!$item instanceof $classItem) {
+                if (!class_exists($classItem) && !is_subclass_of($classItem, ItemInterface::class)) {
+                    throw new InvalidArgumentException("Class $classItem does not exist or is not a subclass of ItemInterface");
+                }
+                /** @var ItemInterface $item */
+                $item = new $classItem($item);
             }
+            $this->items[] = $item;
         }
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function getItens(): array
+    public function getItems(): array
     {
-        return $this->itens;
+        return $this->items;
     }
 
-    /**
-     * @inheritDoc
-     */
     public function add(ItemInterface $item): ItemBagInterface
     {
-        $this->itens[] = $item;
+        $this->items[] = $item;
         return $this;
     }
 }

src/DeclaracaoConteudo.php

@@ -6,51 +6,31 @@
 use Fontebasso\Correios\DeclaracaoConteudo\Interfaces\ItemBagInterface;
 use Fontebasso\Correios\DeclaracaoConteudo\Interfaces\PessoaInterface;
 
-/**
- * Class DeclaracaoConteudo
- *
- * Declaração de Conteúdo para encomendas enviadas via Correios
- *
- * @package  Fontebasso\Correios\DeclaracaoConteudo
- * @author   fontebasso <[email protected]>
- * @license  http://www.opensource.org/licenses/mit-license.html MIT License
- */
 class DeclaracaoConteudo extends Controller
 {
-    private $remetente;
-    private $destinatario;
-    private $itens;
-    private $valorTotal;
+    private PessoaInterface $remetente;
+    private PessoaInterface $destinatario;
+    private ItemBagInterface $items;
+    private float $valorTotal;
 
-    /**
-     * DeclaracaoConteudo constructor.
-     *
-     * @param PessoaInterface  $remetente
-     * @param PessoaInterface  $destinatario
-     * @param ItemBagInterface $itens
-     * @param string|int       $valorTotal
-     */
     public function __construct(
         PessoaInterface $remetente,
         PessoaInterface $destinatario,
-        ItemBagInterface $itens,
-        $valorTotal = 0.00
+        ItemBagInterface $items,
+        float $valorTotal = 0.00
     ) {
         $this->remetente = $remetente;
         $this->destinatario = $destinatario;
-        $this->itens = $itens;
+        $this->items = $items;
         $this->valorTotal = $valorTotal;
     }
 
-    /**
-     * Imprimir Declaração de Conteúdo em HTML
-     */
-    public function imprimirHtml()
+    public function imprimirHtml(): bool|string
     {
         return $this->view('declaracao-conteudo-bootstrap', [
             'remetente' => $this->remetente,
             'destinatario' => $this->destinatario,
-            'itens' => $this->itens,
+            'items' => $this->items,
             'valorTotal' => $this->valorTotal
         ]);
     }

src/Entities/Item.php

@@ -5,86 +5,42 @@
 use Fontebasso\Correios\DeclaracaoConteudo\Core\Entity;
 use Fontebasso\Correios\DeclaracaoConteudo\Interfaces\ItemInterface;
 
-/**
- * Class Item
- *
- * @package  Fontebasso\Correios\DeclaracaoConteudo
- * @subpackage Entities
- * @author   fontebasso <[email protected]>
- * @license  http://www.opensource.org/licenses/mit-license.html MIT License
- */
 class Item extends Entity implements ItemInterface
 {
-    /**
-     * @var string $descricao Descrição do item
-     */
-    protected $descricao;
+    protected string $descricao;
 
-    /**
-     * @var int $quantidade Quantidade do item
-     */
-    protected $quantidade;
+    protected int $quantidade;
 
-    /**
-     * @var float $peso Peso Total do Item
-     */
-    protected $peso;
+    protected float $peso;
 
-    /**
-     * Define a Discriminação do Conteúdo
-     *
-     * @param  string $descricao Discriminação do Conteúdo
-     * @return Item
-     */
-    public function setDescricao($descricao): Item
+    public function setDescricao(string $descricao): Item
     {
         $this->descricao = $descricao;
         return $this;
     }
 
-    /**
-     * Define a quantidade de itens
-     *
-     * @param  int $quantidade Quantidade de Itens
-     * @return Item
-     */
-    public function setQuantidade($quantidade): Item
+    public function setQuantidade(int $quantidade): Item
     {
         $this->quantidade = $quantidade;
         return $this;
     }
 
-    /**
-     * Define o peso do item descrito
-     *
-     * @param  float $peso Peso do Item
-     * @return Item
-     */
-    public function setPeso($peso): Item
+    public function setPeso(float $peso): Item
     {
         $this->peso = $peso;
         return $this;
     }
 
-    /**
-     * @inheritDoc
-     */
     public function getDescricao(): string
     {
         return $this->descricao;
     }
 
-    /**
-     * @inheritDoc
-     */
     public function getQuantidade(): int
     {
         return $this->quantidade;
     }
 
-    /**
-     * @inheritDoc
-     */
     public function getPeso(): float
     {
         return $this->peso;