[4.1] PHPStan Analysis (#399)

.gitattributes

@@ -5,6 +5,8 @@
 /.github export-ignore
 /.gitignore export-ignore
 /.travis.yml export-ignore
+/phpstan.neon.dist export-ignore
 /phpunit.xml.dist export-ignore
 /README.md export-ignore
 /UPGRADING.md export-ignore
+/vendor-bin export-ignore

.travis.yml

@@ -36,3 +36,9 @@ matrix:
       dist: bionic
       install: travis_retry docker run -it -w /data -v ${PWD}:/data:delegated --entrypoint composer registry.gitlab.com/grahamcampbell/php:7.4 install --no-suggest --prefer-dist -n -o
       script: docker run -it -w /data -v ${PWD}:/data:delegated --entrypoint vendor/bin/phpunit registry.gitlab.com/grahamcampbell/php:7.4
+    - name: PHPStan
+      dist: bionic
+      install: 
+        - travis_retry docker run -it -w /data -v ${PWD}:/data:delegated --entrypoint composer registry.gitlab.com/grahamcampbell/php:7.4 install --no-suggest --prefer-dist -n -o
+        - travis_retry docker run -it -w /data -v ${PWD}:/data:delegated --entrypoint composer registry.gitlab.com/grahamcampbell/php:7.4 bin phpstan install --no-suggest --prefer-dist -n -o
+      script: docker run -it -w /data -v ${PWD}:/data:delegated --entrypoint vendor/bin/phpstan registry.gitlab.com/grahamcampbell/php:7.4 analyse src

composer.json

@@ -21,7 +21,8 @@
         "symfony/polyfill-ctype": "^1.9"
     },
     "require-dev": {
-        "phpunit/phpunit": "^4.8.35 || ^5.0 || ^6.0 || ^7.0"
+        "phpunit/phpunit": "^4.8.35 || ^5.0 || ^6.0 || ^7.0",
+        "bamarni/composer-bin-plugin": "^1.3"
     },
     "autoload": {
         "psr-4": {

phpstan.neon.dist

@@ -0,0 +1,10 @@
+parameters:
+  level: max
+  ignoreErrors:
+    - '#Method Dotenv\\Loader\\Parser::processChar\(\) should return Dotenv\\Result\\Result<array<int, bool\|int\|string>, string> but return statement is missing.#'
+    - '#Method Dotenv\\Repository\\AdapterRepository::getInternal\(\) should return string\|null but return statement is missing.#'
+    - '#Variable \$defaults might not be defined.#'
+    - '/^Parameter \#1 \$readers of class Dotenv\\Repository\\[a-zA-Z]*Repository[a-zA-Z]* constructor expects/'
+    - '/^Parameter \#2 \$writers of class Dotenv\\Repository\\[a-zA-Z]*Repository[a-zA-Z]* constructor expects/'
+    - '#Method Dotenv\\Repository\\AbstractRepository::offset[a-zA-Z\(\)\$ ]* typehint specified.#'
+    - '#Method Dotenv\\Loader\\Lines::getCharPairs\(\) should return array\(array\(string, string\|null\)\) but returns array\<int, mixed\>.#'

src/Loader/Lines.php

@@ -37,7 +37,7 @@ public static function process(array $lines)
      * @param string   $line
      * @param string[] $buffer
      *
-     * @return array
+     * @return array{bool,string,string[]}
      */
     private static function multilineProcess($multiline, $line, array $buffer)
     {
@@ -105,7 +105,7 @@ private static function looksLikeMultilineStop($line, $started)
      *
      * @param string $line
      *
-     * @return bool[]
+     * @return array{array{string,string|null}}
      */
     private static function getCharPairs($line)
     {

src/Loader/Loader.php

@@ -22,7 +22,7 @@ public function load(RepositoryInterface $repository, $content)
     {
         return self::processEntries(
             $repository,
-            Lines::process(preg_split("/(\r\n|\n|\r)/", $content))
+            Lines::process(Regex::split("/(\r\n|\n|\r)/", $content)->getSuccess())
         );
     }
 

src/Loader/Parser.php

@@ -23,7 +23,7 @@ class Parser
      *
      * @throws \Dotenv\Exception\InvalidFileException
      *
-     * @return array<string|null>
+     * @return array{string,\Dotenv\Loader\Value|null}
      */
     public static function parse($entry)
     {
@@ -39,7 +39,7 @@ public static function parse($entry)
      *
      * @throws \Dotenv\Exception\InvalidFileException
      *
-     * @return array<string|null>
+     * @return array{string,string|null}
      */
     private static function splitStringIntoParts($line)
     {
@@ -105,7 +105,7 @@ private static function isValidName($name)
     private static function parseValue($value)
     {
         if ($value === null) {
-            return;
+            return null;
         }
 
         if (trim($value) === '') {
@@ -129,7 +129,7 @@ private static function parseValue($value)
      * @param int    $state
      * @param string $char
      *
-     * @return \Dotenv\Result\Result
+     * @return \Dotenv\Result\Result<array{string,bool,int},string>
      */
     private static function processChar($state, $char)
     {

src/Regex/Regex.php

@@ -15,7 +15,7 @@ class Regex
      * @param string $pattern
      * @param string $subject
      *
-     * @return \Dotenv\Result\Result
+     * @return \Dotenv\Result\Result<int,string>
      */
     public static function match($pattern, $subject)
     {
@@ -32,7 +32,7 @@ public static function match($pattern, $subject)
      * @param string   $subject
      * @param int|null $limit
      *
-     * @return \Dotenv\Result\Result
+     * @return \Dotenv\Result\Result<string,string>
      */
     public static function replace($pattern, $replacement, $subject, $limit = null)
     {
@@ -49,7 +49,7 @@ public static function replace($pattern, $replacement, $subject, $limit = null)
      * @param string   $subject
      * @param int|null $limit
      *
-     * @return \Dotenv\Result\Result
+     * @return \Dotenv\Result\Result<string,string>
      */
     public static function replaceCallback($pattern, callable $callback, $subject, $limit = null)
     {
@@ -58,13 +58,30 @@ public static function replaceCallback($pattern, callable $callback, $subject, $
         }, $subject);
     }
 
+    /**
+     * Perform a preg split, wrapping up the result.
+     *
+     * @param string $pattern
+     * @param string $subject
+     *
+     * @return \Dotenv\Result\Result<string[],string>
+     */
+    public static function split($pattern, $subject)
+    {
+        return self::pregAndWrap(function ($subject) use ($pattern) {
+            return (array) @preg_split($pattern, $subject);
+        }, $subject);
+    }
+
     /**
      * Perform a preg operation, wrapping up the result.
      *
-     * @param callable $operation
-     * @param string   $subject
+     * @template V
+     *
+     * @param callable(string): V $operation
+     * @param string              $subject
      *
-     * @return \Dotenv\Result\Result
+     * @return \Dotenv\Result\Result<V,string>
      */
     private static function pregAndWrap(callable $operation, $subject)
     {

src/Repository/Adapter/ApacheAdapter.php

@@ -26,7 +26,7 @@ public function isSupported()
      *
      * @param string $name
      *
-     * @return \PhpOption\Option
+     * @return \PhpOption\Option<string>
      */
     public function get($name)
     {

src/Repository/Adapter/ArrayAdapter.php

@@ -10,7 +10,7 @@ class ArrayAdapter implements AvailabilityInterface, ReaderInterface, WriterInte
     /**
      * The variables and their values.
      *
-     * @return array<string,string|null>
+     * @var array<string,string|null>
      */
     private $variables = [];
 
@@ -29,7 +29,7 @@ public function isSupported()
      *
      * @param string $name
      *
-     * @return \PhpOption\Option
+     * @return \PhpOption\Option<string>
      */
     public function get($name)
     {

src/Repository/Adapter/EnvConstAdapter.php

@@ -22,7 +22,7 @@ public function isSupported()
      *
      * @param string $name
      *
-     * @return \PhpOption\Option
+     * @return \PhpOption\Option<string>
      */
     public function get($name)
     {

src/Repository/Adapter/PutenvAdapter.php

@@ -21,7 +21,7 @@ public function isSupported()
      *
      * @param string $name
      *
-     * @return \PhpOption\Option
+     * @return \PhpOption\Option<string>
      */
     public function get($name)
     {

src/Repository/Adapter/ReaderInterface.php

@@ -9,7 +9,7 @@ interface ReaderInterface extends AvailabilityInterface
      *
      * @param string $name
      *
-     * @return \PhpOption\Option
+     * @return \PhpOption\Option<string>
      */
     public function get($name);
 }

src/Repository/Adapter/ServerConstAdapter.php

@@ -22,7 +22,7 @@ public function isSupported()
      *
      * @param string $name
      *
-     * @return \PhpOption\Option
+     * @return \PhpOption\Option<string>
      */
     public function get($name)
     {

src/Repository/RepositoryBuilder.php

@@ -34,9 +34,9 @@ class RepositoryBuilder
     /**
      * Create a new repository builder instance.
      *
-     * @param \Dotenv\Repository\Adapter\ReaderInterface[]|null
-     * @param \Dotenv\Repository\Adapter\WriterInterface[]|null
-     * @param bool $immutable
+     * @param \Dotenv\Repository\Adapter\ReaderInterface[]|null $readers
+     * @param \Dotenv\Repository\Adapter\WriterInterface[]|null $writers
+     * @param bool                                              $immutable
      *
      * @return void
      */
@@ -60,7 +60,7 @@ public static function create()
     /**
      * Creates a repository builder with the given readers.
      *
-     * @param \Dotenv\Repository\Adapter\ReaderInterface[]|null
+     * @param \Dotenv\Repository\Adapter\ReaderInterface[]|null $readers
      *
      * @return \Dotenv\Repository\RepositoryBuilder
      */
@@ -74,7 +74,7 @@ public function withReaders(array $readers = null)
     /**
      * Creates a repository builder with the given writers.
      *
-     * @param \Dotenv\Repository\Adapter\WriterInterface[]|null
+     * @param \Dotenv\Repository\Adapter\WriterInterface[]|null $writers
      *
      * @return \Dotenv\Repository\RepositoryBuilder
      */

src/Repository/RepositoryInterface.php

@@ -4,6 +4,9 @@
 
 use ArrayAccess;
 
+/**
+ * @extends \ArrayAccess<string,string|null>
+ */
 interface RepositoryInterface extends ArrayAccess
 {
     /**

src/Result/Error.php

@@ -5,17 +5,22 @@
 use PhpOption\None;
 use PhpOption\Some;
 
+/**
+ * @template T
+ * @template E
+ * @extends \Dotenv\Result\Result<T,E>
+ */
 class Error extends Result
 {
     /**
-     * @var mixed
+     * @var E
      */
     private $value;
 
     /**
      * Internal constructor for an error value.
      *
-     * @param mixed $value
+     * @param E $value
      *
      * @return void
      */
@@ -27,9 +32,9 @@ private function __construct($value)
     /**
      * Create a new error value.
      *
-     * @param mixed $value
+     * @param E $value
      *
-     * @return \Dotenv\Result\Result
+     * @return \Dotenv\Result\Result<T,E>
      */
     public static function create($value)
     {
@@ -39,7 +44,7 @@ public static function create($value)
     /**
      * Get the success option value.
      *
-     * @return \PhpOption\Option
+     * @return \PhpOption\Option<T>
      */
     public function success()
     {
@@ -51,7 +56,7 @@ public function success()
      *
      * @param callable $f
      *
-     * @return \Dotenv\Result\Result
+     * @return \Dotenv\Result\Result<T,E>
      */
     public function mapSuccess(callable $f)
     {
@@ -61,7 +66,7 @@ public function mapSuccess(callable $f)
     /**
      * Get the error option value.
      *
-     * @return \PhpOption\Option
+     * @return \PhpOption\Option<E>
      */
     public function error()
     {
@@ -73,7 +78,7 @@ public function error()
      *
      * @param callable $f
      *
-     * @return \Dotenv\Result\Result
+     * @return \Dotenv\Result\Result<T,E>
      */
     public function mapError(callable $f)
     {