Merge pull request #1 from voodooism/update-php-version

Update php version

Author: voodooism

composer.json

@@ -1,12 +1,13 @@
 {
   "name": "voodooism/php-genetic-algorithm",
   "type": "library",
-  "description": "Simple php algorithm",
+  "description": "Simple php genetic algorithm",
   "require": {
-    "php": "^7.2"
+    "php": "^7.4"
   },
   "require-dev": {
-    "phpunit/phpunit": "^8.5"
+    "phpunit/phpunit": "^8.5",
+    "vimeo/psalm": "^4.7"
   },
   "autoload": {
     "psr-4": {

psalm.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="2"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>

src/DNA/ASCIIStringDNA.php

@@ -5,15 +5,10 @@
 namespace Voodooism\Genetic\DNA;
 
 use Exception;
+use InvalidArgumentException;
 use RuntimeException;
 use Voodooism\Genetic\DNA\Gene\ASCIIStringGene;
-use Webmozart\Assert\Assert;
 
-/**
- * Class ASCIIStringDNA
- *
- * @package Voodooism\Genetic\DNA
- */
 class ASCIIStringDNA extends AbstractDNA
 {
     /**
@@ -24,36 +19,37 @@ class ASCIIStringDNA extends AbstractDNA
 
     /**
      * Contains the goal of evolution.
-     *
-     * @var string
      */
-    private $target;
+    private string $target;
 
     /**
      * The length of the goal string.
-     *
-     * @var int
      */
-    private $length;
+    private int $length;
 
     /**
      * Every character in a phrase is a gene.
      *
-     * @var ASCIIStringGene[]
+     * @psalm-suppress NonInvariantDocblockPropertyType
+     * @var array<int, ASCIIStringGene>
      */
-    protected $genes;
+    protected array $genes;
 
     /**
-     * ASCIIStringDNA constructor.
-     *
-     * @param string $target
-     * @param array  $genes
+     * @psalm-suppress DocblockTypeContradiction
+     * @param array<int, ASCIIStringGene> $genes
      *
      * @throws Exception
      */
     public function __construct(string $target, array $genes = [])
     {
-        Assert::allIsInstanceOf($genes, ASCIIStringGene::class);
+        foreach ($genes as $gene) {
+            if (!$gene instanceof ASCIIStringGene) {
+                throw new InvalidArgumentException(
+                    sprintf('Gene should be instance of `%s`.', ASCIIStringGene::class)
+                );
+            }
+        }
 
         $this->target = $target;
         $this->length = strlen($target);
@@ -101,9 +97,6 @@ public function mutate(float $mutationRate): void
         }
     }
 
-    /**
-     * @inheritDoc
-     */
     public function evaluateFitness(): void
     {
         $score = 0;
@@ -124,18 +117,18 @@ public function evaluateFitness(): void
      */
     public function crossover(AbstractDNA $partner): AbstractDNA
     {
+        /** @var array<int, ASCIIStringGene> $genes */
         $genes = [];
 
         for ($i = 0; $i < $this->length; $i++) {
-            $genes[$i] = random_int(0, 1) ? $this->getGene($i) : $partner->getGene($i);
+            /** @var ASCIIStringGene $gene */
+            $gene = random_int(0, 1) ? $this->getGene($i) : $partner->getGene($i);
+            $genes[$i] = $gene;
         }
 
         return new self($this->target, $genes);
     }
 
-    /**
-     * @return string
-     */
     public function getValue(): string
     {
         $value = '';

src/DNA/AbstractDNA.php

@@ -7,19 +7,12 @@
 use RuntimeException;
 use Voodooism\Genetic\DNA\Gene\AbstractGene;
 
-/**
- * Class AbstractDNA
- *
- * @package Voodooism\Genetic\DNA
- */
 abstract class AbstractDNA
 {
     /**
      * The fitness of this DNA.
-     *
-     * @var float
      */
-    protected $fitness = 0;
+    protected float $fitness = 0;
 
     /**
      * The value of whole DNA.
@@ -32,22 +25,18 @@ abstract class AbstractDNA
     /**
      * Array of genes this DNA.
      *
-     * @var AbstractGene[]
+     * @var array<int, AbstractGene>
      */
-    protected $genes;
+    protected array $genes = [];
 
     /**
      * Replicates this DNA with a different set of genes.
-     *
-     * @return $this
      */
     abstract public function replicate(): self;
 
     /**
      * Mutate every gene of this DNA with some probability, depends on given "mutation rate".
      * It is an optional step. Mutation is unnecessary in some cases.
-     *
-     * @param float $mutationRate
      */
     abstract public function mutate(float $mutationRate): void;
 
@@ -61,16 +50,9 @@ abstract public function evaluateFitness(): void;
 
     /**
      * Creates a new DNA by crossing this DNA with the given one.
-     *
-     * @param AbstractDNA $partner
-     *
-     * @return $this
      */
     abstract public function crossover(self $partner): self;
 
-    /**
-     * @return float
-     */
     public function getFitness(): float
     {
         return $this->fitness;
@@ -84,11 +66,6 @@ public function getValue()
         return $this->value;
     }
 
-    /**
-     * @param int $number
-     *
-     * @return AbstractGene
-     */
     public function getGene(int $number): AbstractGene
     {
         if (!array_key_exists($number, $this->genes)) {

src/DNA/Gene/ASCIIStringGene.php

@@ -4,20 +4,13 @@
 
 namespace Voodooism\Genetic\DNA\Gene;
 
+use RuntimeException;
 use Exception;
 
-/**
- * Class ASCIIStringGene
- *
- * @package Voodooism\Genetic\DNA\Gene
- */
 class ASCIIStringGene extends AbstractGene
 {
     /**
-     * ASCIIStringGene constructor.
-     *
-     * @param int|null $ASCIINumber
-     *
+     * @throws RuntimeException
      * @throws Exception
      */
     public function __construct(?int $ASCIINumber = null)
@@ -27,7 +20,7 @@ public function __construct(?int $ASCIINumber = null)
         }
 
         if ($ASCIINumber > 126 || $ASCIINumber < 32) {
-            throw new \RuntimeException('Wrong ASCII number! Only numbers from 32 to 126 are allowed');
+            throw new RuntimeException('Wrong ASCII number! Only numbers from 32 to 126 are allowed');
         }
 
         $this->value = chr($ASCIINumber);

src/DNA/Gene/AbstractGene.php

@@ -4,15 +4,10 @@
 
 namespace Voodooism\Genetic\DNA\Gene;
 
-/**
- * Class AbstractGene
- *
- * @package Voodooism\Genetic\DNA\Gene
- */
 abstract class AbstractGene
 {
     /**
-     * The value this gene.
+     * The value of this gene.
      * Can contain any value you want.
      *
      * @var mixed

src/DNA/Gene/MathGene.php

@@ -6,11 +6,6 @@
 
 use Exception;
 
-/**
- * Class MathGene
- *
- * @package Voodooism\Genetic\DNA\Gene
- */
 class MathGene extends AbstractGene
 {
     /**
@@ -20,25 +15,15 @@ class MathGene extends AbstractGene
 
     /**
      * The lowest possible value (inclusive).
-     *
-     * @var float
      */
-    private $from;
+    private float $from;
 
     /**
-     * The lowest possible value (inclusive).
-     *
-     * @var float
+     * The highest possible value (inclusive).
      */
-    private $to;
+    private float $to;
 
     /**
-     * MathGene constructor.
-     *
-     * @param float      $from
-     * @param float      $to
-     * @param float|null $value
-     *
      * @throws Exception
      */
     public function __construct(float $from, float $to, ?float $value = null)
@@ -48,9 +33,12 @@ public function __construct(float $from, float $to, ?float $value = null)
         $this->value = $value ?? $this->generate();
     }
 
+    public function getValue(): float
+    {
+        return $this->value;
+    }
+
     /**
-     * @return $this
-     *
      * @throws Exception
      */
     public function mutate(): self
@@ -61,16 +49,14 @@ public function mutate(): self
     /**
      * Generates random float accordingly to "from" and "to" parameters
      *
-     * @return float
-     *
      * @throws Exception
      */
     private function generate(): float
     {
         $multiplier = 10 ** self::PRECISION;
 
-        $intFrom = (int)$this->from * $multiplier;
-        $intTo   = (int)$this->to * $multiplier;
+        $intFrom = (int)($this->from * $multiplier);
+        $intTo   = (int)($this->to * $multiplier);
 
         return random_int($intFrom, $intTo) / $multiplier;
     }

src/DNA/Gene/NullGene.php

@@ -6,8 +6,6 @@
 
 /**
  * Gene stub
- *
- * @package Voodooism\Genetic\DNA\Gene
  */
 class NullGene extends AbstractGene
 {

src/DNA/Math/Equation.php

@@ -6,11 +6,6 @@
 
 use Voodooism\Genetic\DNA\Gene\MathGene;
 
-/**
- * Class Equation
- *
- * @package Voodooism\Genetic\DNA\Math
- */
 class Equation
 {
     /**
@@ -21,20 +16,13 @@ class Equation
      */
     private $func;
 
-    /**
-     * Equation constructor.
-     *
-     * @param callable $f
-     */
     public function __construct(callable $f)
     {
         $this->func = $f;
     }
 
     /**
      * @param MathGene ...$genes Each of gene corresponds to a variable of equation.
-     *
-     * @return float
      */
     public function __invoke(MathGene ...$genes): float
     {