Merge branch 'release/v0.5.0' into main

decodelabs · Aug 24, 2022 · a57ec54 · a57ec54
2 parents dc3df19 + 3be05c6
commit a57ec54
Show file tree

Hide file tree

Showing 7 changed files with 52 additions and 80 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+## v0.5.0 (2022-08-24)
+* Added concrete types to all members
+
 ## v0.4.0 (2022-08-23)
 * Removed PHP7 compatibility
 * Added try/catch around URL resolver

diff --git a/src/Metamorph.php b/src/Metamorph.php
@@ -56,27 +56,26 @@ public static function resolveUrl(string $url): string
      * Initiate conversion
      *
      * @param array{0: mixed, 1?: array<string, mixed>, 2?: callable(Handler):void|null} $args
-     * @return string|Stringable|null
      */
-    public static function __callStatic(string $method, array $args)
-    {
+    public static function __callStatic(
+        string $method,
+        array $args
+    ): string|Stringable|null {
         return static::convert($method, ...$args);
     }
 
     /**
      * Handle conversion
      *
-     * @param mixed $content
      * @param callable(object):void|null $setup
      * @param array<string, mixed>|null $options
-     * @return string|Stringable|null
      */
     public static function convert(
         string $name,
-        $content,
+        mixed $content,
         ?array $options = [],
         ?callable $setup = null
-    ) {
+    ): string|Stringable|null {
         if ($content === null) {
             return null;
         }
@@ -96,7 +95,7 @@ public static function convert(
      *
      * @param mixed $content
      */
-    protected static function prepareContent($content): ?string
+    protected static function prepareContent(mixed $content): ?string
     {
         if (
             is_string($content) ||

diff --git a/src/Metamorph/Handler.php b/src/Metamorph/Handler.php
@@ -15,7 +15,9 @@ interface Handler
 {
     /**
      * @param callable(object):void|null $setup
-     * @return string|Stringable|null
      */
-    public function convert(string $content, ?callable $setup = null);
+    public function convert(
+        string $content,
+        ?callable $setup = null
+    ): string|Stringable|null;
 }
diff --git a/src/Metamorph/Handler/HtmlToText.php b/src/Metamorph/Handler/HtmlToText.php
@@ -33,20 +33,9 @@ class HtmlToText implements MacroHandler
     ];
 
 
-    /**
-     * @var int|null
-     */
-    protected $maxLength = null;
-
-    /**
-     * @var string
-     */
-    protected $ellipsis = '…';
-
-    /**
-     * @var bool
-     */
-    protected $wrap = false;
+    protected ?int $maxLength = null;
+    protected string $ellipsis = '…';
+    protected bool $wrap = false;
 
     /**
      * Set options
@@ -66,7 +55,7 @@ public function __construct(array $options)
     public function convert(
         string $content,
         ?callable $setup = null
-    ) {
+    ): string|Stringable|null {
         $content = trim($content);
 
         if (!strlen($content)) {
@@ -127,11 +116,11 @@ protected function shorten(string $content): string
 
     /**
      * Wrap output content
-     *
-     * @return string|Stringable|null
      */
-    protected function wrap(string $content, bool $shorten)
-    {
+    protected function wrap(
+        string $content,
+        bool $shorten
+    ): string|Stringable|null {
         if ($this->wrap) {
             return $this->wrapHtml($content, $shorten);
         } else {
@@ -143,8 +132,10 @@ protected function wrap(string $content, bool $shorten)
     /**
      * Wrap text content
      */
-    protected function wrapText(string $content, bool $shorten): string
-    {
+    protected function wrapText(
+        string $content,
+        bool $shorten
+    ): string {
         if ($shorten) {
             $content = $this->shorten($content) . $this->ellipsis;
         }
@@ -154,11 +145,11 @@ protected function wrapText(string $content, bool $shorten): string
 
     /**
      * Wrap HTML content
-     *
-     * @return string|Stringable|null
      */
-    protected function wrapHtml(string $content, bool $shorten)
-    {
+    protected function wrapHtml(
+        string $content,
+        bool $shorten
+    ): string|Stringable|null {
         if ($shorten) {
             $content = [
                 Element::create('abbr', [

diff --git a/src/Metamorph/Handler/HtmlTrait.php b/src/Metamorph/Handler/HtmlTrait.php
@@ -13,10 +13,7 @@
 
 trait HtmlTrait
 {
-    /**
-     * @var bool
-     */
-    protected $resolveUrls = true;
+    protected bool $resolveUrls = true;
 
     /**
      * Resolve URLs in HTML

diff --git a/src/Metamorph/Handler/Markdown.php b/src/Metamorph/Handler/Markdown.php
@@ -38,15 +38,8 @@ class Markdown implements MacroHandler
         ],
     ];
 
-    /**
-     * @var bool
-     */
-    protected $inline = false;
-
-    /**
-     * @var bool
-     */
-    protected $safe = false;
+    protected bool $inline = false;
+    protected bool $safe = false;
 
     /**
      * Set options
@@ -68,7 +61,7 @@ public function __construct(array $options)
     public function convert(
         string $content,
         ?callable $setup = null
-    ) {
+    ): string|Stringable|null {
         if (class_exists(Parsedown::class)) {
             return $this->convertParsedown($content, $setup);
         }
@@ -87,13 +80,11 @@ class_exists(MarkdownLib::class)
 
     /**
      * Convert markdown using Parsedown
-     *
-     * @return string|Stringable
      */
     protected function convertParsedown(
         string $content,
         ?callable $setup = null
-    ) {
+    ): string|Stringable {
         $parser = new Parsedown();
         $parser->setSafeMode(!$this->safe);
 
@@ -113,13 +104,11 @@ protected function convertParsedown(
 
     /**
      * Convert markdown using Markdown lib
-     *
-     * @return string|Stringable
      */
     protected function convertMarkdownLib(
         string $content,
         ?callable $setup = null
-    ) {
+    ): string|Stringable {
         $parser = new MarkdownLib();
 
         if (!$this->safe) {

diff --git a/src/Metamorph/Handler/Text.php b/src/Metamorph/Handler/Text.php
@@ -35,20 +35,9 @@ class Text implements MacroHandler
     ];
 
 
-    /**
-     * @var int|null
-     */
-    protected $maxLength = null;
-
-    /**
-     * @var string
-     */
-    protected $ellipsis = '…';
-
-    /**
-     * @var bool
-     */
-    protected $wrap = true;
+    protected ?int $maxLength = null;
+    protected string $ellipsis = '…';
+    protected bool $wrap = true;
 
     /**
      * Set options
@@ -68,7 +57,7 @@ public function __construct(array $options)
     public function convert(
         string $content,
         ?callable $setup = null
-    ) {
+    ): string|Stringable|null {
         $content = trim($content);
 
         if (!strlen($content)) {
@@ -107,11 +96,11 @@ protected function shorten(string $content): string
 
     /**
      * Wrap output content
-     *
-     * @return string|Stringable|null
      */
-    protected function wrap(string $content, bool $shorten)
-    {
+    protected function wrap(
+        string $content,
+        bool $shorten
+    ): string|Stringable|null {
         if ($this->wrap) {
             return $this->wrapHtml($content, $shorten);
         } else {
@@ -123,8 +112,10 @@ protected function wrap(string $content, bool $shorten)
     /**
      * Wrap text content
      */
-    protected function wrapText(string $content, bool $shorten): string
-    {
+    protected function wrapText(
+        string $content,
+        bool $shorten
+    ): string {
         if ($shorten) {
             $content = $this->shorten($content) . $this->ellipsis;
         }
@@ -134,11 +125,11 @@ protected function wrapText(string $content, bool $shorten): string
 
     /**
      * Wrap HTML content
-     *
-     * @return string|Stringable|null
      */
-    protected function wrapHtml(string $content, bool $shorten)
-    {
+    protected function wrapHtml(
+        string $content,
+        bool $shorten
+    ): string|Stringable|null {
         if ($shorten) {
             $content = [
                 Element::create('abbr', [