feat: add PostObjectInterface::getIcon() which returns an IconInterfa…

…ce (#1233)

library/Helper/Post.php

@@ -9,8 +9,10 @@
 use ComponentLibrary\Integrations\Image\Image as ImageComponentContract;
 use Municipio\PostObject\TermIcon\TryGetTermIcon;
 use Municipio\PostObject\Decorators\BackwardsCompatiblePostObject;
+use Municipio\PostObject\Decorators\IconResolvingPostObject;
 use Municipio\PostObject\Decorators\PostObjectFromWpPost;
 use Municipio\PostObject\Decorators\PostObjectWithTermIcons;
+use Municipio\PostObject\Icon\Resolvers\NullIconResolver;
 use Municipio\PostObject\PostObject;
 use Municipio\PostObject\PostObjectInterface;
 
@@ -151,6 +153,7 @@ private static function convertWpPostToPostObject(WP_Post $post, string $cacheGr
 
         $postObject = new PostObjectFromWpPost(new PostObject(), $post, $wpService);
         $postObject = new PostObjectWithTermIcons($postObject, $wpService, new TryGetTermIcon());
+        $postObject = new IconResolvingPostObject($postObject, new NullIconResolver());
         $postObject = new BackwardsCompatiblePostObject($postObject, $camelCasedPost);
 
         self::$runtimeCache[$cacheGroup][$cacheKey] = $postObject;

library/PostObject/Decorators/AbstractPostObjectDecorator.php

@@ -2,6 +2,7 @@
 
 namespace Municipio\PostObject\Decorators;
 
+use Municipio\PostObject\Icon\IconInterface;
 use Municipio\PostObject\PostObjectInterface;
 use Municipio\PostObject\TermIcon\TermIconInterface;
 
@@ -67,4 +68,12 @@ public function getTermIcon(?string $taxonomy = null): ?TermIconInterface
     {
         return $this->postObject->getTermIcon($taxonomy);
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function getIcon(): ?IconInterface
+    {
+        return $this->postObject->getIcon();
+    }
 }

library/PostObject/Decorators/IconResolvingPostObject.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Municipio\PostObject\Decorators;
+
+use Municipio\PostObject\Icon\IconInterface;
+use Municipio\PostObject\Icon\Resolvers\IconResolverInterface;
+use Municipio\PostObject\PostObjectInterface;
+
+/**
+ * IconResolvingPostObject
+ */
+class IconResolvingPostObject extends AbstractPostObjectDecorator implements PostObjectInterface
+{
+    /**
+     * Constructor.
+     */
+    public function __construct(PostObjectInterface $inner, private IconResolverInterface $iconResolver)
+    {
+        $this->postObject = $inner;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getIcon(): ?IconInterface
+    {
+        return $this->iconResolver->resolve();
+    }
+}

library/PostObject/Decorators/IconResolvingPostObject.test.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Municipio\PostObject\Decorators;
+
+use Municipio\PostObject\Icon\IconInterface;
+use Municipio\PostObject\Icon\Resolvers\IconResolverInterface;
+use Municipio\PostObject\Icon\Resolvers\NullIconResolver;
+use Municipio\PostObject\PostObject;
+use Municipio\PostObject\PostObjectInterface;
+use PHPUnit\Framework\TestCase;
+
+class IconResolvingPostObjectTest extends TestCase
+{
+    /**
+     * @testdox class can be instantiated
+     */
+    public function testClassCanBeInstantiated()
+    {
+        $decorator = new IconResolvingPostObject(new PostObject(), new NullIconResolver());
+        $this->assertInstanceOf(IconResolvingPostObject::class, $decorator);
+    }
+
+    /**
+     * @testdox getIcon() calls provided icon resolver
+     */
+    public function testGetIconCallsProvidedIconResolver()
+    {
+        $icon         = $this->createMock(IconInterface::class);
+        $iconResolver = $this->createMock(IconResolverInterface::class);
+
+        $icon->method('getIcon')->willReturn('test-icon');
+        $iconResolver->method('resolve')->willReturn($icon);
+
+        $postObject = new IconResolvingPostObject(new PostObject(), $iconResolver);
+
+        $this->assertEquals('test-icon', $postObject->getIcon()->getIcon());
+    }
+}

library/PostObject/Icon/IconInterface.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Municipio\PostObject\Icon;
+
+/**
+ * Interface that adhere to the Icon component atttibutes.
+ * @see https://styleguide.getmunicipio.com/components/atoms/icon
+ */
+interface IconInterface
+{
+    /**
+     * Sizes: xs, sm, md, lg, xl, xxl
+     */
+    public function getSize(): string;
+
+    /**
+     * A label on the icon
+     */
+    public function getLabel(): string;
+
+    /**
+     * Get the term icon.
+     */
+    public function getIcon(): string;
+
+    /**
+     * Get the term color.
+     */
+    public function getColor(): string;
+
+    /**
+     * A custom HEX color
+     */
+    public function getCustomColor(): string;
+
+    /**
+     *  Icon HTML tag
+     */
+    public function getComponentElement(): string;
+
+    /**
+     * If the icons should be filled or not
+     */
+    public function getFilled(): bool;
+
+    /**
+     * If the icon is decorative only or serves a purpose.
+     */
+    public function getDecorative(): bool;
+
+    /**
+     * Get the term ID.
+     */
+    public function toArray(): array;
+}

library/PostObject/Icon/Resolvers/IconResolverInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Municipio\PostObject\Icon\Resolvers;
+
+use Municipio\PostObject\Icon\IconInterface;
+
+interface IconResolverInterface
+{
+    /**
+     * Resolve icon.
+     *
+     * @return IconInterface|null
+     */
+    public function resolve(): ?IconInterface;
+}

library/PostObject/Icon/Resolvers/NullIconResolver.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Municipio\PostObject\Icon\Resolvers;
+
+use Municipio\PostObject\Icon\IconInterface;
+
+/**
+ * Null icon resolver.
+ */
+class NullIconResolver implements IconResolverInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function resolve(): ?IconInterface
+    {
+        return null;
+    }
+}

library/PostObject/Icon/Resolvers/NullIconResolver.test.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Municipio\PostObject\Icon\Resolvers;
+
+use PHPUnit\Framework\TestCase;
+
+class NullIconResolverTest extends TestCase
+{
+    /**
+     * @testdox class can be instantiated
+     */
+    public function testClassCanBeInstantiated()
+    {
+        $this->assertInstanceOf(NullIconResolver::class, new NullIconResolver());
+    }
+
+    /**
+     * @testdox resolve() returns null
+     */
+    public function testResolveReturnsNull()
+    {
+        $resolver = new NullIconResolver();
+        $this->assertNull($resolver->resolve());
+    }
+}

library/PostObject/PostObject.php

@@ -2,6 +2,7 @@
 
 namespace Municipio\PostObject;
 
+use Municipio\PostObject\Icon\IconInterface;
 use Municipio\PostObject\PostObjectInterface;
 use Municipio\PostObject\TermIcon\TermIconInterface;
 
@@ -65,4 +66,12 @@ public function getTermIcon(?string $taxonomy = null): ?TermIconInterface
     {
         return null;
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function getIcon(): ?IconInterface
+    {
+        return null;
+    }
 }

library/PostObject/PostObject.test.php

@@ -71,4 +71,12 @@ public function testGetTermIconReturnsNull()
     {
         $this->assertNull($this->instance->getTermIcon());
     }
+
+    /**
+     * @testdox getIcon() returns null
+     */
+    public function testGetIconReturnsNull()
+    {
+        $this->assertNull($this->instance->getIcon());
+    }
 }

library/PostObject/PostObjectInterface.php

@@ -2,6 +2,7 @@
 
 namespace Municipio\PostObject;
 
+use Municipio\PostObject\Icon\IconInterface;
 use Municipio\PostObject\TermIcon\TermIconInterface;
 
 interface PostObjectInterface
@@ -54,4 +55,11 @@ public function getTermIcon(?string $taxonomy = null): ?TermIconInterface;
      * Get the post type.
      */
     public function getPostType(): string;
+
+    /**
+     * Get the post object icon.
+     *
+     * @return IconInterface|null The post object icon or null if none is found.
+     */
+    public function getIcon(): ?IconInterface;
 }