Code quality improvements

.github/workflows/tests.yml

@@ -35,8 +35,8 @@ jobs:
           max_attempts: 5
           command: composer update --${{ matrix.stability }} --prefer-dist --no-interaction --no-progress
 
-      - name: Copy PHP Unit Settings
-        run: cp phpunit.xml.dist phpunit.xml
+      - name: Execute phpstan
+        run: vendor/bin/phpstan
 
       - name: Execute tests
         run: vendor/bin/phpunit --verbose

composer.json

@@ -14,7 +14,9 @@
 		"joomla/string": ">=2.0.1"
 	},
 	"require-dev":{
-		"phpunit/phpunit": "^9.0"
+		"phpunit/phpunit": "^9.0",
+		"phpstan/phpstan": "^2",
+		"phpstan/phpstan-deprecation-rules": "^2"
 	},
 	"autoload": {
 		"psr-4": {

phpstan.neon

@@ -0,0 +1,9 @@
+includes:
+	- vendor/phpstan/phpstan-deprecation-rules/rules.neon
+
+parameters:
+	level: 5
+	phpVersion: 70300
+	reportUnmatchedIgnoredErrors: false
+	paths:
+		- src

src/Stemmer/Danish.php

@@ -46,7 +46,7 @@ public function stem($word): string
      * Define a valid s-ending as one of
      * a   b   c   d   f   g   h   j   k   l   m   n   o   p   r   t   v   y   z   å
      *
-     * @param string $ending
+     * @param string $word
      * @return boolean
      */
     private function hasValidSEnding($word)

src/Stemmer/Dutch.php

@@ -61,7 +61,7 @@ public function stem($word)
 
     /**
      * Define a valid s-ending as a non-vowel other than j.
-     * @param string $ending
+     * @param string $word
      * @return boolean
      */
     private function hasValidSEnding($word)
@@ -72,7 +72,7 @@ private function hasValidSEnding($word)
 
     /**
      * Define a valid en-ending as a non-vowel, and not gem.
-     * @param string $ending
+     * @param string $word
      * @return boolean
      */
     private function hasValidEnEnding($word)

src/Stemmer/Finnish.php

@@ -91,6 +91,8 @@ private function step1()
 
             return true;
         }
+
+        return false;
     }
 
     /**
@@ -180,6 +182,8 @@ private function step2()
                 }
             }
         }
+
+        return false;
     }
 
     /**
@@ -294,6 +298,8 @@ private function step3()
             $this->_removedInStep3 = true;
             return true;
         }
+
+        return false;
     }
 
     /**
@@ -326,6 +332,8 @@ private function step4()
             $this->r2();
             return true;
         }
+
+        return false;
     }
 
     /**
@@ -372,6 +380,7 @@ private function step5()
             }
         }
 
+        return false;
     }
 
     /**

src/Stemmer/Norwegian.php

@@ -46,7 +46,7 @@ public function stem($word)
      * b   c   d   f   g   h   j   l   m   n   o   p   r   t   v   y   z,
      * or k not preceded by a vowel
      *
-     * @param string $ending
+     * @param string $word
      * @return boolean
      */
     private function hasValidSEnding($word)

src/Stemmer/Romanian.php

@@ -300,6 +300,8 @@ private function step3()
             }
             return true;
         }
+
+        return false;
     }
 
     /**

src/Stemmer/Spanish.php

@@ -98,7 +98,7 @@ private function step0()
             // c
             if ( ($position2 = $this->searchIfInRv(array('yendo' . $suffixe))) != false) {
                 $before = StringHelper::substr($this->word, ($position2-1), 1);
-                if ( (isset($before)) && ($before == 'u') ) {
+                if ($before == 'u') {
                     $this->word = StringHelper::substr($this->word, 0, $position);
                     return true;
                 }
@@ -259,7 +259,7 @@ private function step2a()
             'yamos', 'yendo', 'yeron', 'yan', 'yen', 'yais', 'yas', 'yes', 'yo', 'yó', 'ya', 'ye'))) != false) {
 
             $before = StringHelper::substr($this->word, ($position-1), 1);
-            if ( (isset($before)) && ($before == 'u') ) {
+            if ($before == 'u') {
                 $this->word = StringHelper::substr($this->word, 0, $position);
                 return true;
             }
@@ -301,6 +301,8 @@ private function step2b()
 
             return true;
         }
+
+        return false;
     }
 
     /**
@@ -323,7 +325,7 @@ private function step3()
 
             if ( ($position2 = $this->searchIfInRv(array('u'))) != false) {
                 $before = StringHelper::substr($this->word, ($position2-1), 1);
-                if ( (isset($before)) && ($before == 'g') ) {
+                if ($before == 'g') {
                     $this->word = StringHelper::substr($this->word, 0, $position2);
                     return true;
                 }

src/Stemmer/Stem.php

@@ -40,7 +40,7 @@ abstract class Stem implements Stemmer
 
     /**
      * R1 value
-     * @var integer
+     * @var string
      */
     protected $r1;
 

src/Stemmer/Swedish.php

@@ -45,7 +45,7 @@ public function stem($word)
      * Define a valid s-ending as one of
      * b   c   d   f   g   h   j   k   l   m   n   o   p   r   t   v   y
      *
-     * @param string $ending
+     * @param string $word
      * @return boolean
      */
     private function hasValidSEnding($word)

test/CatalanTest.php

@@ -4,22 +4,8 @@
 use PHPUnit\Framework\TestCase;
 use Wamania\Snowball\Stemmer\Catalan;
 
-class CatalanTest extends TestCase
+class CatalanTest extends StemmingTest
 {
-    /**
-     * @dataProvider load
-     */
-    public function testStem($word, $stem)
-    {
-        $o = new Catalan();
-
-        $snowballStem = $o->stem($word);
-
-        $this->assertEquals($stem, $snowballStem);
-    }
-
-    public function load()
-    {
-        return new CsvFileVerboseIterator('test/files/ca.txt');
-    }
+    protected $class = Catalan::class;
+    protected $file = 'ca';
 }

test/CsvFileIterator.php

@@ -19,6 +19,7 @@ public function __destruct()
         fclose($this->file);
     }
 
+    #[\ReturnTypeWillChange]
     public function rewind()
     {
         rewind($this->file);
@@ -32,21 +33,25 @@ public function rewind()
         $this->key = 0;
     }
 
+    #[\ReturnTypeWillChange]
     public function valid()
     {
         return !feof($this->file);
     }
 
+    #[\ReturnTypeWillChange]
     public function key()
     {
         return $this->key;
     }
 
+    #[\ReturnTypeWillChange]
     public function current()
     {
         return $this->current;
     }
 
+    #[\ReturnTypeWillChange]
     public function next()
     {
         $line = fgets($this->file);

test/CsvFileVerboseIterator.php

@@ -3,7 +3,7 @@
 
 class CsvFileVerboseIterator extends CsvFileIterator
 {
-    public function rewind()
+    public function rewind(): void
     {
         parent::rewind();
         $this->_updateKey($this->current());
@@ -20,9 +20,9 @@ public function next()
     protected function _updateKey($value)
     {
         if ($value && sizeof($value)) {
-            $this->key = $value[0];
+            $this->key = (int) $value[0];
         } elseif (sizeof($this->current)) {
-            $this->key = $this->current[0];
+            $this->key = (int) $this->current[0];
         }
     }
 }

test/DanishTest.php

@@ -4,22 +4,8 @@
 use PHPUnit\Framework\TestCase;
 use Wamania\Snowball\Stemmer\Danish;
 
-class DanishTest extends TestCase
+class DanishTest extends StemmingTest
 {
-    /**
-     * @dataProvider load
-     */
-    public function testStem($word, $stem)
-    {
-        $o = new Danish();
-
-        $snowballStem = $o->stem($word);
-
-        $this->assertEquals($stem, $snowballStem);
-    }
-
-    public function load()
-    {
-        return new CsvFileIterator('test/files/dk.txt');
-    }
+    protected $class = Danish::class;
+    protected $file = 'dk';
 }

test/DutchTest.php

@@ -4,22 +4,8 @@
 use PHPUnit\Framework\TestCase;
 use Wamania\Snowball\Stemmer\Dutch;
 
-class DutchTest extends TestCase
+class DutchTest extends StemmingTest
 {
-    /**
-     * @dataProvider load
-     */
-    public function testStem($word, $stem)
-    {
-        $o = new Dutch();
-
-        $snowballStem = $o->stem($word);
-
-        $this->assertEquals($stem, $snowballStem);
-    }
-
-    public function load()
-    {
-        return new CsvFileIterator('test/files/nl.txt');
-    }
+    protected $class = Dutch::class;
+    protected $file = 'nl';
 }

test/EnglishTest.php

@@ -4,22 +4,8 @@
 use PHPUnit\Framework\TestCase;
 use Wamania\Snowball\Stemmer\English;
 
-class EnglishTest extends TestCase
+class EnglishTest extends StemmingTest
 {
-    /**
-     * @dataProvider load
-     */
-    public function testStem($word, $stem)
-    {
-        $o = new English();
-
-        $snowballStem = $o->stem($word);
-
-        $this->assertEquals($stem, $snowballStem);
-    }
-
-    public function load()
-    {
-        return new CsvFileIterator('test/files/en.txt');
-    }
+    protected $class = English::class;
+    protected $file = 'en';
 }

test/FinnishTest.php

@@ -4,22 +4,8 @@
 use PHPUnit\Framework\TestCase;
 use Wamania\Snowball\Stemmer\Finnish;
 
-class FinnishTest extends TestCase
+class FinnishTest extends StemmingTest
 {
-    /**
-     * @dataProvider load
-     */
-    public function testStem($word, $stem)
-    {
-        $o = new Finnish();
-
-        $snowballStem = $o->stem($word);
-
-		$this->assertEquals($stem, $snowballStem);
-    }
-
-    public function load()
-    {
-        return new CsvFileIterator('test/files/fi.txt');
-    }
+    protected $class = Finnish::class;
+    protected $file = 'fi';
 }

test/FrenchTest.php

@@ -4,22 +4,8 @@
 use PHPUnit\Framework\TestCase;
 use Wamania\Snowball\Stemmer\French;
 
-class FrenchTest extends TestCase
+class FrenchTest extends StemmingTest
 {
-    /**
-     * @dataProvider load
-     */
-    public function testStem($word, $stem)
-    {
-        $o = new French();
-
-        $snowballStem = $o->stem($word);
-
-        $this->assertEquals($stem, $snowballStem);
-    }
-
-    public function load()
-    {
-        return new CsvFileIterator('test/files/fr.txt');
-    }
+    protected $class = French::class;
+    protected $file = 'fr';
 }