add psalm lints and php hints (#62)

Author: apache-hb

.circleci/config.yml

@@ -32,6 +32,9 @@ jobs:
       - run:
           name: install dependencies
           command: composer install --no-progress
+      - run:
+          name: psalm linting
+          command: ./vendor/bin/psalm --no-cache
       - run: mkdir -p ~/phpunit
       - run:
           name: run tests with highest compatible dependency versions

.gitignore

@@ -7,3 +7,4 @@ composer.phar
 integration-tests/vendor
 composer.lock
 docs/build
+.phpunit.result.cache

composer.json

@@ -23,7 +23,8 @@
         "guzzlehttp/guzzle": "^7",
         "kevinrob/guzzle-cache-middleware": "^3",
         "phpunit/phpunit": "^9",
-        "phpunit/php-code-coverage": "^9"
+        "phpunit/php-code-coverage": "^9",
+        "vimeo/psalm": "^4.7"
     },
     "suggest": {
         "guzzlehttp/guzzle": "(^7) Required when using GuzzleEventPublisher or the default FeatureRequester",

phpunit.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true" beStrictAboutChangesToGlobalState="true" beStrictAboutOutputDuringTests="true" beStrictAboutResourceUsageDuringSmallTests="true" beStrictAboutTestsThatDoNotTestAnything="true" beStrictAboutTodoAnnotatedTests="true" verbose="true">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true" beStrictAboutChangesToGlobalState="true" beStrictAboutOutputDuringTests="true" beStrictAboutResourceUsageDuringSmallTests="true" beStrictAboutTestsThatDoNotTestAnything="true" beStrictAboutTodoAnnotatedTests="true" verbose="true" defaultTimeLimit="10">
 
   <logging>
     <junit outputFile="~/phpunit/junit.xml"/>

psalm.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="4"
+    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>
+</psalm>

src/LaunchDarkly/Clause.php

@@ -12,39 +12,38 @@
  */
 class Clause
 {
-    /** @var string */
+    /** @var string|null */
     private $_attribute = null;
-    /** @var string */
+    /** @var string|null */
     private $_op = null;
     /** @var array  */
     private $_values = array();
     /** @var bool  */
     private $_negate = false;
 
-    private function __construct($attribute, $op, array $values, $negate)
+    private function __construct(?string $attribute, ?string $op, array $values, bool $negate)
     {
         $this->_attribute = $attribute;
         $this->_op = $op;
         $this->_values = $values;
         $this->_negate = $negate;
     }
 
-    public static function getDecoder()
+    /**
+     * @psalm-return \Closure(mixed):self
+     */
+    public static function getDecoder(): \Closure
     {
         return function ($v) {
             return new Clause($v['attribute'], $v['op'], $v['values'], $v['negate']);
         };
     }
 
-    /**
-     * @param $user LDUser
-     * @return bool
-     */
-    public function matchesUser($user, $featureRequester)
+    public function matchesUser(LDUser $user, ?FeatureRequester $featureRequester): bool
     {
         if ($this->_op === 'segmentMatch') {
             foreach ($this->_values as $value) {
-                $segment = $featureRequester->getSegment($value);
+                $segment = $featureRequester ? $featureRequester->getSegment($value) : null;
                 if ($segment) {
                     if ($segment->matchesUser($user)) {
                         return $this->_maybeNegate(true);
@@ -57,11 +56,7 @@ public function matchesUser($user, $featureRequester)
         }
     }
 
-    /**
-     * @param $user LDUser
-     * @return bool
-     */
-    public function matchesUserNoSegments($user)
+    public function matchesUserNoSegments(LDUser $user): bool
     {
         $userValue = $user->getValueForEvaluation($this->_attribute);
         if ($userValue === null) {
@@ -79,44 +74,32 @@ public function matchesUserNoSegments($user)
         }
     }
 
-
-    /**
-     * @return string
-     */
-    public function getAttribute()
+    public function getAttribute(): ?string
     {
         return $this->_attribute;
     }
 
-    /**
-     * @return string
-     */
-    public function getOp()
+    public function getOp(): ?string
     {
         return $this->_op;
     }
 
-    /**
-     * @return array
-     */
-    public function getValues()
+    public function getValues(): array
     {
         return $this->_values;
     }
 
-    /**
-     * @return boolean
-     */
-    public function isNegate()
+    public function isNegate(): bool
     {
         return $this->_negate;
     }
 
     /**
-     * @param $userValue
+     * @param mixed|null $userValue
+     *
      * @return bool
      */
-    private function matchAny($userValue)
+    private function matchAny($userValue): bool
     {
         foreach ($this->_values as $v) {
             $result = Operators::apply($this->_op, $userValue, $v);
@@ -127,7 +110,7 @@ private function matchAny($userValue)
         return false;
     }
 
-    private function _maybeNegate($b)
+    private function _maybeNegate(bool $b): bool
     {
         if ($this->_negate) {
             return !$b;

src/LaunchDarkly/EvalResult.php

@@ -11,33 +11,22 @@
 class EvalResult
 {
     /** @var EvaluationDetail */
-    private $_detail = null;
+    private $_detail;
     /** @var array */
     private $_prerequisiteEvents = [];
 
-    /**
-     * EvalResult constructor.
-     * @param EvaluationDetail $detail
-     * @param array $prerequisiteEvents
-     */
-    public function __construct($detail, array $prerequisiteEvents)
+    public function __construct(EvaluationDetail $detail, array $prerequisiteEvents)
     {
         $this->_detail = $detail;
         $this->_prerequisiteEvents = $prerequisiteEvents;
     }
 
-    /**
-     * @return EvaluationDetail
-     */
-    public function getDetail()
+    public function getDetail(): EvaluationDetail
     {
         return $this->_detail;
     }
 
-    /**
-     * @return array
-     */
-    public function getPrerequisiteEvents()
+    public function getPrerequisiteEvents(): array
     {
         return $this->_prerequisiteEvents;
     }

src/LaunchDarkly/EvaluationDetail.php

@@ -2,24 +2,31 @@
 
 namespace LaunchDarkly;
 
+use \LaunchDarkly\EvaluationReason;
+
 /**
  * An object that combines the result of a flag evaluation with an explanation of how it was calculated.
  *
  * This is returned by {@link \LaunchDarkly\LDClient::variationDetail()}.
  */
 class EvaluationDetail
 {
+    /** @var int|null */
     private $_variationIndex = null;
+
+    /** @var mixed|null */
     private $_value = null;
-    private $_reason = null;
+
+    /** @var EvaluationReason */
+    private $_reason;
 
     /**
      * EvaluationDetail constructor.
-     * @param mixed $value the value of the flag variation
+     * @param mixed|null $value the value of the flag variation
      * @param int|null $variationIndex the index of the flag variation, or null if it was the default value
      * @param EvaluationReason $reason evaluation reason properties
      */
-    public function __construct($value, $variationIndex, $reason = null)
+    public function __construct($value, ?int $variationIndex, EvaluationReason $reason)
     {
         $this->_value = $value;
         $this->_variationIndex = $variationIndex;
@@ -42,7 +49,7 @@ public function getValue()
      *
      * @return int | null
      */
-    public function getVariationIndex()
+    public function getVariationIndex(): ?int
     {
         return $this->_variationIndex;
     }
@@ -52,7 +59,7 @@ public function getVariationIndex()
      *
      * @return EvaluationReason
      */
-    public function getReason()
+    public function getReason(): EvaluationReason
     {
         return $this->_reason;
     }
@@ -62,7 +69,7 @@ public function getReason()
      *
      * @return bool
      */
-    public function isDefaultValue()
+    public function isDefaultValue(): bool
     {
         return ($this->_variationIndex === null);
     }