Added vimeo/psalm to dev dependencies and fixed several static analys…

…is issues
PHLAK · Dec 4, 2019 · 277e33e · 277e33e
1 parent 2cb7bd3
commit 277e33e
Show file tree

Hide file tree

Showing 8 changed files with 71 additions and 13 deletions.
diff --git a/composer.json b/composer.json
@@ -18,7 +18,8 @@
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.3",
         "phpunit/phpunit": "^6.0 || ^7.0",
-        "psy/psysh": "^0.9.6"
+        "psy/psysh": "^0.9.6",
+        "vimeo/psalm": "^3.6"
     },
     "autoload": {
         "psr-4": {

diff --git a/psalm.xml b/psalm.xml
@@ -0,0 +1,55 @@
+<?xml version="1.0"?>
+<psalm
+    totallyTyped="false"
+    resolveFromConfigFile="true"
+    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>
+
+    <issueHandlers>
+        <LessSpecificReturnType errorLevel="info" />
+
+        <!-- level 3 issues - slightly lazy code writing, but provably low false-negatives -->
+
+        <DeprecatedMethod errorLevel="info" />
+        <DeprecatedProperty errorLevel="info" />
+        <DeprecatedClass errorLevel="info" />
+        <DeprecatedConstant errorLevel="info" />
+        <DeprecatedFunction errorLevel="info" />
+        <DeprecatedInterface errorLevel="info" />
+        <DeprecatedTrait errorLevel="info" />
+
+        <InternalMethod errorLevel="info" />
+        <InternalProperty errorLevel="info" />
+        <InternalClass errorLevel="info" />
+
+        <MissingClosureReturnType errorLevel="info" />
+        <MissingReturnType errorLevel="info" />
+        <MissingPropertyType errorLevel="info" />
+        <InvalidDocblock errorLevel="info" />
+        <MisplacedRequiredParam errorLevel="info" />
+
+        <PropertyNotSetInConstructor errorLevel="info" />
+        <MissingConstructor errorLevel="info" />
+        <MissingClosureParamType errorLevel="info" />
+        <MissingParamType errorLevel="info" />
+
+        <RedundantCondition errorLevel="info" />
+
+        <DocblockTypeContradiction errorLevel="info" />
+        <RedundantConditionGivenDocblockType errorLevel="info" />
+
+        <UnresolvableInclude errorLevel="info" />
+
+        <RawObjectIteration errorLevel="info" />
+
+        <InvalidStringClass errorLevel="info" />
+    </issueHandlers>
+</psalm>
diff --git a/src/Support/helpers.php b/src/Support/helpers.php
@@ -4,6 +4,8 @@
     /**
      * Create a Twine string object.
      *
+     * @param mixed $string A string
+     *
      * @return \PHLAK\Twine\Str
      */
     function str($string)

diff --git a/src/Traits/Caseable.php b/src/Traits/Caseable.php
@@ -40,7 +40,7 @@ public function uppercase(string $mode = Config\Uppercase::ALL) : self
                 );
 
             case Config\Uppercase::WORDS:
-                $string = preg_replace_callback('/(\p{Ll})[\S]*/u', function ($matched) {
+                $string = preg_replace_callback('/(\p{Ll})[\S]*/u', function (array $matched) {
                     return mb_strtoupper($matched[1], $this->encoding) . mb_substr($matched[0], 1, null, $this->encoding);
                 }, $this->string);
 
@@ -81,7 +81,7 @@ public function lowercase(string $mode = Config\Lowercase::ALL) : self
                 );
 
             case Config\Lowercase::WORDS:
-                $string = preg_replace_callback('/(\p{Lu})[\S]*/u', function ($matched) {
+                $string = preg_replace_callback('/(\p{Lu})[\S]*/u', function (array $matched) {
                     return mb_strtolower($matched[1], $this->encoding) . mb_substr($matched[0], 1, null, $this->encoding);
                 }, $this->string);
 

diff --git a/src/Traits/Convenience.php b/src/Traits/Convenience.php
@@ -62,7 +62,7 @@ public function words() : array
     {
         preg_match_all('/\p{Lu}?[\p{Ll}0-9]+/u', $this->string, $matches);
 
-        return array_map(function ($words) {
+        return array_map(function (string $words) {
             return new static($words, $this->encoding);
         }, $matches[0]);
     }
@@ -72,7 +72,7 @@ public function words() : array
      *
      * @return \PHLAK\Twine\Str[]
      */
-    public function characters($mode = Config\Characters::ALL) : array
+    public function characters(string $mode = Config\Characters::ALL) : array
     {
         Config\Characters::validateOption($mode);
 

diff --git a/src/Traits/Encodable.php b/src/Traits/Encodable.php
@@ -66,13 +66,13 @@ public function hex(string $mode = Config\Hex::ENCODE) : self
 
         switch ($mode) {
             case Config\Hex::ENCODE:
-                $string = array_reduce(Support\Str::characters($this->string), function ($str, $char) {
+                $string = array_reduce(Support\Str::characters($this->string), function (string $str, string $char) {
                     return $str . '\x' . dechex(mb_ord($char, $this->encoding));
                 }, '');
                 break;
 
             case Config\Hex::DECODE:
-                $string = preg_replace_callback('/\\\\x([0-9A-Fa-f]+)/', function ($matched) {
+                $string = preg_replace_callback('/\\\\x([0-9A-Fa-f]+)/', function (array $matched) {
                     return mb_chr(hexdec($matched[1]), $this->encoding);
                 }, $this->string);
                 break;

diff --git a/src/Traits/Searchable.php b/src/Traits/Searchable.php
@@ -29,7 +29,7 @@ public function matchAll(string $pattern) : array
     {
         preg_match_all($pattern, $this->string, $matches);
 
-        return array_map(function ($match) {
+        return array_map(function (string $match) {
             return new static($match, $this->encoding);
         }, $matches[0]);
     }

diff --git a/src/Traits/Segmentable.php b/src/Traits/Segmentable.php
@@ -52,7 +52,7 @@ public function after(string $string) : self
      */
     public function from(string $string) : self
     {
-        return new static(mb_strstr($this->string, $string, null, $this->encoding), $this->encoding);
+        return new static(mb_strstr($this->string, $string, false, $this->encoding), $this->encoding);
     }
 
     /**
@@ -96,7 +96,7 @@ public function chunk(int $length) : array
     {
         preg_match_all("/(?:.|\p{L}|\w){1,{$length}}/u", $this->string, $chunks);
 
-        return array_map(function ($chunk) {
+        return array_map(function (string $chunk) {
             return new static($chunk, $this->encoding);
         }, $chunks[0]);
     }
@@ -111,10 +111,10 @@ public function chunk(int $length) : array
     public function split(int $chunks) : array
     {
         $length = ceil($this->length() / $chunks);
-        preg_match_all("/(?:.|\p{L}|\w){1,{$length}}/u", $this->string, $chunks);
+        preg_match_all("/(?:.|\p{L}|\w){1,{$length}}/u", $this->string, $strings);
 
-        return array_map(function ($chunk) {
+        return array_map(function (string $chunk) {
             return new static($chunk, $this->encoding);
-        }, $chunks[0]);
+        }, $strings[0]);
     }
 }