Merge pull request #4 from MekDrop/improvement/added-supports-method-…

…for-factories

Added supports* functions for factory constructors

src/Exceptions/UnsupportedExtensionException.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Imponeer\Contracts\ExtensionInfo\Exceptions;
+
+use Exception;
+use Throwable;
+
+/**
+ * Exception that is thrown when factory doesn't supports such exception but asked to create one
+ *
+ * @package Imponeer\Contracts\ExtensionInfo\Exceptions
+ */
+class UnsupportedExtensionException extends Exception
+{
+
+    /**
+     * UnsupportedExtensionException constructor.
+     *
+     * @param string $name Extension name
+     * @param int $code Error code
+     * @param Throwable|null $previous Previous exception
+     */
+    public function __construct($name, $code = 0, ?Throwable $previous = null)
+    {
+        parent::__construct($name . ' extension for this factory is not supported', $code, $previous);
+    }
+
+}

src/Factory/FromComposerPackageFactoryInterface.php

@@ -4,6 +4,7 @@
 namespace Imponeer\Contracts\ExtensionInfo\Factory;
 
 use Composer\Package\Package;
+use Imponeer\Contracts\ExtensionInfo\Exceptions\UnsupportedExtensionException;
 use Imponeer\Contracts\ExtensionInfo\ExtensionInfoInterface;
 
 /**
@@ -20,7 +21,17 @@ interface FromComposerPackageFactoryInterface
      * @param Package $package Composer package instance
      *
      * @return ExtensionInfoInterface
+     *
+     * @throws UnsupportedExtensionException
      */
     public function createFromComposerPackage(Package $package): ExtensionInfoInterface;
 
+    /**
+     * Checks if info factory supports such package
+     *
+     * @param Package $package Composer package to be checked if is supported
+     *
+     * @return bool
+     */
+    public function supportsPackage(Package $package): bool;
 }

src/Factory/FromPathFactoryInterface.php

@@ -2,6 +2,7 @@
 
 namespace Imponeer\Contracts\ExtensionInfo\Factory;
 
+use Imponeer\Contracts\ExtensionInfo\Exceptions\UnsupportedExtensionException;
 use Imponeer\Contracts\ExtensionInfo\ExtensionInfoInterface;
 
 /**
@@ -18,7 +19,17 @@ interface FromPathFactoryInterface
      * @param string $path
      *
      * @return ExtensionInfoInterface
+     *
+     * @throws UnsupportedExtensionException
      */
     public function createFromPath(string $path): ExtensionInfoInterface;
 
+    /**
+     * Checks if info factory supports such path
+     *
+     * @param string $path Path to check if this info reader supports such path
+     *
+     * @return bool
+     */
+    public function supportsPath(string $path): bool;
 }