full Psalm type coverage

Author: thunderer

.gitignore

@@ -1,3 +1,4 @@
+.phpunit.result.cache
 vendor
 composer.lock
 coverage

.travis.yml

@@ -10,7 +10,7 @@ php:
   - 7.1
   - 7.2
   - 7.3
-  - 7.4snapshot
+  - 7.4
   - hhvm
   - nightly
 
@@ -21,6 +21,10 @@ before_script:
 
 script:
  - vendor/bin/phpunit --coverage-text
+ - |
+  if php -r 'exit((int)(version_compare(PHP_VERSION, "7.1", ">=") === false));';
+  then composer require --dev vimeo/psalm && vendor/bin/psalm --threads=8 --no-cache --shepherd --find-unused-psalm-suppress;
+  fi;
 
 after_script:
   - wget https://scrutinizer-ci.com/ocular.phar
@@ -31,4 +35,3 @@ matrix:
     - php: 5.3
     - php: hhvm
     - php: nightly
-    - php: hhvm

README.md

@@ -1,11 +1,11 @@
 # Shortcode
 
-[![Build Status](https://travis-ci.org/thunderer/Shortcode.png?branch=master)](https://travis-ci.org/thunderer/Shortcode)
+[![Build Status](https://travis-ci.com/thunderer/Shortcode.svg?branch=master)](https://travis-ci.com/thunderer/Shortcode)
 [![SensioLabsInsight](https://insight.sensiolabs.com/projects/5235d5e3-d112-48df-bc07-d4555aef293d/mini.png)](https://insight.sensiolabs.com/projects/5235d5e3-d112-48df-bc07-d4555aef293d)
 [![License](https://poser.pugx.org/thunderer/shortcode/license.svg)](https://packagist.org/packages/thunderer/shortcode)
 [![Latest Stable Version](https://poser.pugx.org/thunderer/shortcode/v/stable.svg)](https://packagist.org/packages/thunderer/shortcode)
 [![Total Downloads](https://poser.pugx.org/thunderer/shortcode/downloads)](https://packagist.org/packages/thunderer/shortcode)
-[![Dependency Status](https://www.versioneye.com/user/projects/551d5385971f7847ca000002/badge.svg)](https://www.versioneye.com/user/projects/551d5385971f7847ca000002)
+[![Psalm coverage](https://shepherd.dev/github/thunderer/Shortcode/coverage.svg?)](https://shepherd.dev/github/thunderer/Shortcode)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/thunderer/Shortcode/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/thunderer/Shortcode/?branch=master)
 [![Code Coverage](https://scrutinizer-ci.com/g/thunderer/Shortcode/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/thunderer/Shortcode/?branch=master)
 [![Code Climate](https://codeclimate.com/github/thunderer/Shortcode/badges/gpa.svg)](https://codeclimate.com/github/thunderer/Shortcode)
@@ -33,18 +33,18 @@ Each part is described in the dedicated section in this document.
 
 ## Installation
 
-There are no required dependencies and all PHP versions from 5.3 up to latest 7.0 [are tested](https://travis-ci.org/thunderer/Shortcode) and supported. This library is available on Composer/Packagist as `thunderer/shortcode`, to install it execute:
+There are no required dependencies and all PHP versions from 5.3 up to latest 7.4 [are tested](https://travis-ci.org/thunderer/Shortcode) and supported. This library is available on Composer/Packagist as `thunderer/shortcode`, to install it execute:
 
 ```
-composer require thunderer/shortcode=^0.7.3
+composer require thunderer/shortcode=^0.7
 ```
 
 or manually update your `composer.json` with:
 
 ```
 (...)
 "require": {
-    "thunderer/shortcode": "^0.7.3"
+    "thunderer/shortcode": "^0.7"
 }
 (...)
 ```

psalm.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<psalm
+    totallyTyped="true"
+    findUnusedCode="false"
+    findUnusedVariablesAndParams="true"
+    findUnusedPsalmSuppress="true"
+    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/Event/FilterShortcodesEvent.php

@@ -13,28 +13,35 @@
  */
 class FilterShortcodesEvent
 {
+    /** @var ProcessedShortcode|null */
     private $parent;
-    private $shortcodes;
+    /** @var ParsedShortcodeInterface[] */
+    private $shortcodes = array();
 
+    /** @param ParsedShortcodeInterface[] $shortcodes */
     public function __construct(array $shortcodes, ProcessedShortcode $parent = null)
     {
         $this->parent = $parent;
         $this->setShortcodes($shortcodes);
     }
 
-    /**
-     * @return ParsedShortcodeInterface[]
-     */
+    /** @return ParsedShortcodeInterface[] */
     public function getShortcodes()
     {
         return $this->shortcodes;
     }
 
+    /** @return ProcessedShortcode|null */
     public function getParent()
     {
         return $this->parent;
     }
 
+    /**
+     * @param ParsedShortcodeInterface[] $shortcodes
+     *
+     * @return void
+     */
     public function setShortcodes(array $shortcodes)
     {
         $this->shortcodes = array();
@@ -43,6 +50,11 @@ public function setShortcodes(array $shortcodes)
         }
     }
 
+    /**
+     * @param ParsedShortcodeInterface $shortcode
+     *
+     * @return void
+     */
     private function addShortcode(ParsedShortcodeInterface $shortcode)
     {
         $this->shortcodes[] = $shortcode;

src/Event/ReplaceShortcodesEvent.php

@@ -13,12 +13,19 @@
  */
 class ReplaceShortcodesEvent
 {
+    /** @var ShortcodeInterface|null */
     private $shortcode;
+    /** @var string */
     private $text;
     /** @var ReplacedShortcode[] */
-    private $replacements;
+    private $replacements = array();
+    /** @var string|null */
     private $result;
 
+    /**
+     * @param string $text
+     * @param ReplacedShortcode[] $replacements
+     */
     public function __construct($text, array $replacements, ShortcodeInterface $shortcode = null)
     {
         $this->shortcode = $shortcode;
@@ -27,43 +34,59 @@ public function __construct($text, array $replacements, ShortcodeInterface $shor
         $this->setReplacements($replacements);
     }
 
+    /**
+     * @param ReplacedShortcode[] $replacements
+     *
+     * @return void
+     */
     private function setReplacements(array $replacements)
     {
         foreach($replacements as $replacement) {
             $this->addReplacement($replacement);
         }
     }
 
+    /** @return void */
     private function addReplacement(ReplacedShortcode $replacement)
     {
         $this->replacements[] = $replacement;
     }
 
+    /** @return string */
     public function getText()
     {
         return $this->text;
     }
 
+    /** @return ReplacedShortcode[] */
     public function getReplacements()
     {
         return $this->replacements;
     }
 
+    /** @return ShortcodeInterface|null */
     public function getShortcode()
     {
         return $this->shortcode;
     }
 
+    /**
+     * @param string $result
+     *
+     * @return void
+     */
     public function setResult($result)
     {
         $this->result = $result;
     }
 
+    /** @return string|null */
     public function getResult()
     {
         return $this->result;
     }
 
+    /** @return bool */
     public function hasResult()
     {
         return null !== $this->result;

src/EventContainer/EventContainer.php

@@ -8,12 +8,19 @@
  */
 final class EventContainer implements EventContainerInterface
 {
+    /** @psalm-var array<string,list<callable>> */
     private $listeners = array();
 
     public function __construct()
     {
     }
 
+    /**
+     * @param string $event
+     * @param callable $handler
+     *
+     * @return void
+     */
     public function addListener($event, $handler)
     {
         if(!\in_array($event, Events::getEvents(), true)) {
@@ -27,11 +34,21 @@ public function addListener($event, $handler)
         $this->listeners[$event][] = $handler;
     }
 
+    /**
+     * @param string $event
+     *
+     * @psalm-return list<callable>
+     */
     public function getListeners($event)
     {
         return $this->hasEvent($event) ? $this->listeners[$event] : array();
     }
 
+    /**
+     * @param string $name
+     *
+     * @return bool
+     */
     private function hasEvent($name)
     {
         return array_key_exists($name, $this->listeners);

src/EventHandler/ReplaceJoinEventHandler.php

@@ -24,7 +24,8 @@ public function __construct(array $names)
 
     public function __invoke(ReplaceShortcodesEvent $event)
     {
-        if($event->getShortcode() && in_array($event->getShortcode()->getName(), $this->names)) {
+        $shortcode = $event->getShortcode();
+        if($shortcode && in_array($shortcode->getName(), $this->names)) {
             $replaces = array();
             foreach($event->getReplacements() as $r) {
                 $replaces[] = $r->getReplacement();

src/Events.php

@@ -9,6 +9,7 @@ final class Events
     const FILTER_SHORTCODES = 'event.filter-shortcodes';
     const REPLACE_SHORTCODES = 'event.replace-shortcodes';
 
+    /** @return string[] */
     public static function getEvents()
     {
         return array(static::FILTER_SHORTCODES, static::REPLACE_SHORTCODES);

src/Handler/DeclareHandler.php

@@ -11,8 +11,10 @@ final class DeclareHandler
 {
     /** @var HandlerContainer */
     private $handlers;
+    /** @var string */
     private $delimiter;
 
+    /** @param string $delimiter */
     public function __construct(HandlerContainer $container, $delimiter = '%')
     {
         $this->handlers = $container;
@@ -33,12 +35,13 @@ public function __invoke(ShortcodeInterface $shortcode)
         }
         $keys = array_keys($args);
         $name = array_shift($keys);
-        $content = $shortcode->getContent();
+        $content = (string)$shortcode->getContent();
         $delimiter = $this->delimiter;
 
         $this->handlers->add($name, function(ShortcodeInterface $shortcode) use($content, $delimiter) {
             $args = $shortcode->getParameters();
             $keys = array_map(function($key) use($delimiter) { return $delimiter.$key.$delimiter; }, array_keys($args));
+            /** @var string[] $values */
             $values = array_values($args);
 
             return str_replace($keys, $values, $content);