Merge pull request #21 from php-enspired/analysis+tests

Tests + Analysis

Author: adrian-enspired

.phan/config.php

@@ -0,0 +1,6 @@
+<?php
+
+return [
+  'directory_list' => ['src', 'vendor'],
+  'exclude_analysis_directory_list' => ['vendor']
+];

composer.json

@@ -18,14 +18,16 @@
     "php": "^7.1"
   },
   "require-dev": {
-    "phpunit/phpunit": "^5.7"
+    "phan/phan": "^1",
+    "phpunit/phpunit": "^7"
   },
   "autoload": {
     "psr-4": {
       "at\\exceptable\\": "src/"
     }
   },
   "scripts": {
-    "test:unit" : "vendor/bin/phpunit --bootstrap vendor/autoload.php tests"
+    "test:phan": "vendor/bin/phan",
+    "test:unit" : "vendor/bin/phpunit tests"
   }
 }

phpunit.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+  bootstrap="./vendor/autoload.php"
+  colors="true">
+  <filter>
+    <whitelist processUncoveredFilesFromWhitelist="true">
+      <directory suffix=".php">./src</directory>
+    </whitelist>
+  </filter>
+</phpunit>

src/Exceptable.php

@@ -22,6 +22,8 @@
 
 use Throwable;
 
+use at\exceptable\ExceptableException;
+
 /**
  * augmented interface for exceptions.
  *
@@ -49,9 +51,9 @@ interface Exceptable extends Throwable {
   /**
    * gets information about a code known to the implementing class.
    *
-   * @param int $code    the exception code to look up
-   * @throws Exceptable  if the code is not known to the implementation
-   * @return array       a map of info about the error condition
+   * @param int $code             the exception code to look up
+   * @throws ExceptableException  if the code is not known to the implementation
+   * @return array                a map of info about the error condition
    */
   public static function getInfo(int $code) : array;
 
@@ -64,10 +66,10 @@ public static function getInfo(int $code) : array;
   public static function hasInfo(int $code) : bool;
 
   /**
-   * @param int       $code       exception code
-   * @param array     $context    additional exception context
-   * @param Throwable $previous   previous exception
-   * @throws ExceptableException  if code is invalid
+   * @param int            $code       exception code
+   * @param array          $context    additional exception context
+   * @param Throwable|null $previous   previous exception
+   * @throws ExceptableException       if code is invalid
    */
   public function __construct(int $code, array $context = [], Throwable $previous = null);
 

src/Exception.php

@@ -20,8 +20,7 @@
 
 namespace at\exceptable;
 
-use Exception as BaseException,
-  Throwable;
+use Exception as BaseException;
 
 use at\exceptable\ {
   Exceptable,

src/Handler.php

@@ -22,6 +22,7 @@
 
 use ErrorException,
     Throwable;
+
 use at\exceptable\Exceptable;
 
 class Handler {
@@ -44,9 +45,9 @@ class Handler {
   /**
    * registers this handler to invoke a callback, and then restores the previous handler(s).
    *
-   * @param callable $callback    the callback to execute
-   * @param mixed    …$arguments  arguments to pass to the callback
-   * @return mixed                the value returned from the callback
+   * @param callable $callback   the callback to execute
+   * @param mixed ...$arguments  arguments to pass to the callback
+   * @return mixed               the value returned from the callback
    */
   public function during(callable $callback, ...$arguments) {
     $registered = $this->_registered;
@@ -68,7 +69,7 @@ public function during(callable $callback, ...$arguments) {
    * @see <http://php.net/set_error_handler> $error_handler
    *
    * @param callable $handler  the error handler to add
-   * @param int      $types    the error type(s) to trigger this handler
+   * @param int|null $types    the error type(s) to trigger this handler
    *                           (bitmask of E_* constants, or omit for "any severity")
    * @return Handler           $this
    */
@@ -82,7 +83,7 @@ public function onError(callable $handler, int $types=null) : Handler {
    * @see <http://php.net/set_exception_handler> $exception_handler
    *
    * @param callable $handler   the exception handler to add
-   * @param int      $severity  the exception severity to trigger this handler
+   * @param int|null $severity  the exception severity to trigger this handler
    *                            (one of Exceptable::ERROR|WARNING|NOTICE, or omit for "any severity")
    * @return Handler            $this
    */
@@ -96,7 +97,7 @@ public function onException(callable $handler, int $severity=null) : Handler {
    * @see <http:/php.net/register_shutdown_handler> $callback
    *
    * @param callable $handler    the shutdown handler to add
-   * @param mixed    $arguments  optional agrs to pass to shutdown handler when invoked
+   * @param mixed ...$arguments  optional agrs to pass to shutdown handler when invoked
    * @return Handler             $this
    */
   public function onShutdown(callable $handler, ...$arguments) : Handler {
@@ -135,7 +136,7 @@ public function throw(int $types=E_ERROR|E_WARNING) : Handler {
    * tries invoking a callback, handling any exceptions using registered handlers.
    *
    * @param callable $callback    the callback to execute
-   * @param mixed    …$arguments  arguments to pass to the callback
+   * @param mixed ...$arguments   arguments to pass to the callback
    * @throws ExceptableException  if no registered handler handles the exception
    * @return mixed                the value returned from the callback
    */
@@ -191,7 +192,7 @@ protected function _error(int $s, string $m, string $f, int $l, array $c) : bool
    * @throws ExceptableException  if no registered handler handles the exception
    */
   protected function _exception(Throwable $e) {
-    $severity = method_exists($e, 'getSeverity') ? $e->getSeverity() : Exceptable::ERROR;
+    $severity = $e instanceof Exceptable ? $e->getSeverity() : Exceptable::ERROR;
     foreach ($this->_exceptionHandlers as $handler) {
       if ($handler->handles(_Handler::TYPE_EXCEPTION, $severity) && $handler->handle($e)) {
         return;
@@ -250,8 +251,8 @@ public function handle(...$arguments) : bool {
     } catch (Throwable $e) {
       throw new ExceptableException(
         ExceptableException::INVALID_HANDLER,
-        $e,
-        ['type' => $this->_type()]
+        ['type' => $this->_type()],
+        $e
       );
     }
   }

src/HasContext.php

@@ -22,13 +22,10 @@
 
 use Throwable;
 
-use at\exceptable\ {
-  Exceptable,
-  ExceptableException
-};
-
 /**
  * base implementation for Exceptable interface, including contexted message construction.
+ *
+ * this trait MUST be used by a class which implements Throwable.
  */
 trait HasContext {
 
@@ -42,6 +39,9 @@ trait HasContext {
   /** {@inheritDoc} */
   abstract public static function getInfo(int $code) : array;
 
+  /** @see https://php.net/Throwable.getPrevious */
+  abstract public function getPrevious();
+
   /** {@inheritDoc} */
   abstract public static function hasInfo(int $code) : bool;
 
@@ -53,17 +53,20 @@ public function __construct(int $code, array $context = [], Throwable $previous
     $context['__severity__'] = $this->_severity = $info['severity'];
     $this->_context = $context;
 
+    // @phan-suppress-next-line PhanTraitParentReference
     parent::__construct($this->_makeMessage($code) ?? $info['message'], $code, $previous);
   }
 
   /** @see https://php.net/__toString */
   public function __toString() {
     try {
+      // @phan-suppress-next-line PhanTraitParentReference
       return parent::__toString() . "\ncontext: " . json_encode(
         $this->getContext(),
         JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT
       );
     } catch (Throwable $e) {
+      // @phan-suppress-next-line PhanTraitParentReference
       return parent::__toString();
     }
   }

tests/ExceptableTest.php

@@ -49,8 +49,7 @@ public function testGetInfo() {
       $this->assertEquals($code, $actual['code']);
       $this->assertContains(
         $actual['severity'],
-        [Exceptable::ERROR, Exceptable::WARNING, Exceptable::NOTICE],
-        true
+        [Exceptable::ERROR, Exceptable::WARNING, Exceptable::NOTICE]
       );
       $this->assertInternalType('string', $actual['message']);
     }