From 6bf4ea2131dd57d9229f42956dd5e9c6d3d48c84 Mon Sep 17 00:00:00 2001
From: Julien Rosset <julien.rosset@solulog.fr>
Date: Tue, 8 Nov 2022 12:59:27 +0100
Subject: [PATCH] Add interfaces and traits for registries

---
 src/Singleton/IRegistry.php        | 47 ++++++++++++++++++++++
 src/Singleton/IRegistryDefault.php | 40 +++++++++++++++++++
 src/Singleton/ISingleton.php       |  4 +-
 src/Singleton/TRegistry.php        | 21 ++++++++++
 src/Singleton/TRegistryBase.php    | 62 ++++++++++++++++++++++++++++++
 src/Singleton/TRegistryDefault.php | 44 +++++++++++++++++++++
 src/Singleton/TSingleton.php       | 18 ++++-----
 tests/registry.php                 | 38 ++++++++++++++++++
 tests/registry_default.php         | 39 +++++++++++++++++++
 tests/{test.php => singleton.php}  | 14 ++++---
 10 files changed, 311 insertions(+), 16 deletions(-)
 create mode 100644 src/Singleton/IRegistry.php
 create mode 100644 src/Singleton/IRegistryDefault.php
 create mode 100644 src/Singleton/TRegistry.php
 create mode 100644 src/Singleton/TRegistryBase.php
 create mode 100644 src/Singleton/TRegistryDefault.php
 create mode 100644 tests/registry.php
 create mode 100644 tests/registry_default.php
 rename tests/{test.php => singleton.php} (55%)

diff --git a/src/Singleton/IRegistry.php b/src/Singleton/IRegistry.php
new file mode 100644
index 0000000..212fa0e
--- /dev/null
+++ b/src/Singleton/IRegistry.php
@@ -0,0 +1,47 @@
+<?php
+
+namespace jrosset\Singleton;
+
+use InvalidArgumentException;
+use Throwable;
+
+/**
+ * Interface for class implementing an instance register
+ *
+ * @see TRegistry for default implementation
+ */
+interface IRegistry {
+    /**
+     * Register a new entry
+     *
+     * @param string $name The entry name
+     * @param array  $args The instance constructor arguments
+     *
+     * @return void
+     *
+     * @throws InvalidArgumentException If the entry name already exists
+     */
+    public static function addEntry (string $name, ...$args): void;
+    /**
+     * Check if an entry name already exists
+     *
+     * @param string $name The entry name
+     *
+     * @return bool TRUE if the entry name already exists
+     */
+    public static function hasEntry (string $name): bool;
+
+    /**
+     * Get the instance
+     *
+     * If the instance is not already created then create it
+     *
+     * @param string The entry name
+     *
+     * @return static The instance
+     *
+     * @throws InvalidArgumentException If the entry name doesn't exist
+     * @throws Throwable If instantiating failed
+     */
+    public static function getInstance (string $name): self;
+}
\ No newline at end of file
diff --git a/src/Singleton/IRegistryDefault.php b/src/Singleton/IRegistryDefault.php
new file mode 100644
index 0000000..60b8e59
--- /dev/null
+++ b/src/Singleton/IRegistryDefault.php
@@ -0,0 +1,40 @@
+<?php
+
+namespace jrosset\Singleton;
+
+use InvalidArgumentException;
+use Throwable;
+
+/**
+ * Interface for class implementing an instance register with a default entry name
+ */
+interface IRegistryDefault extends IRegistry {
+    /**
+     * The default entry name
+     *
+     * @return string The default entry name
+     *
+     * @throws InvalidArgumentException If the entry name isn't set
+     */
+    public static function getDefaultEntryName (): string;
+    /**
+     * Set the default entry name
+     *
+     * <b>WARNING :</b> The entry name MUST already exists
+     *
+     * @param string $name The new default name
+     *
+     * @return void
+     *
+     * @throws InvalidArgumentException If the entry name doesn't exists
+     */
+    public static function setDefaultEntryName (string $name): void;
+
+    /**
+     * @inheritDoc
+     *
+     * @throws InvalidArgumentException If the entry name doesn't exist or no default entry name
+     * @throws Throwable If instantiating failed
+     */
+    public static function getInstance (?string $name = null): self;
+}
\ No newline at end of file
diff --git a/src/Singleton/ISingleton.php b/src/Singleton/ISingleton.php
index 4e35c85..06b57f9 100644
--- a/src/Singleton/ISingleton.php
+++ b/src/Singleton/ISingleton.php
@@ -3,7 +3,9 @@
 namespace jrosset\Singleton;
 
 /**
- * Interface for class that must implements a singleton
+ * Interface for class implementing a singleton
+ *
+ * @see TSingleton for common implementation
  */
 interface ISingleton {
     /**
diff --git a/src/Singleton/TRegistry.php b/src/Singleton/TRegistry.php
new file mode 100644
index 0000000..22c327d
--- /dev/null
+++ b/src/Singleton/TRegistry.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace jrosset\Singleton;
+
+/**
+ * Default implementation for registry
+ *
+ * Instance initialization through the constructor
+ *
+ * @see IRegistry for interface
+ */
+trait TRegistry {
+    use TRegistryBase;
+
+    /**
+     * @inheritDoc
+     */
+    public static function getInstance (string $name): self {
+        return static::TRegistryBase_getInstance($name);
+    }
+}
\ No newline at end of file
diff --git a/src/Singleton/TRegistryBase.php b/src/Singleton/TRegistryBase.php
new file mode 100644
index 0000000..40c4656
--- /dev/null
+++ b/src/Singleton/TRegistryBase.php
@@ -0,0 +1,62 @@
+<?php
+
+namespace jrosset\Singleton;
+
+use InvalidArgumentException;
+use Throwable;
+
+/**
+ * Default base implementation for registry
+ *
+ * Instance initialization through the constructor
+ *
+ * @see IRegistry for interface
+ */
+trait TRegistryBase {
+    /**
+     * @var array[] The registry entries
+     */
+    private static array $registerEntries = [];
+    /**
+     * @var static[] The current instances
+     */
+    private static array $registryInstances = [];
+
+    /**
+     * @inheritDoc
+     */
+    public static function addEntry (string $name, ...$args): void {
+        if (static::hasEntry($name)) {
+            throw new InvalidArgumentException('An entry with "' . $name . '" already exists');
+        }
+        static::$registerEntries[$name] = $args;
+    }
+    /**
+     * @inheritDoc
+     */
+    public static function hasEntry (string $name): bool {
+        return isset(static::$registerEntries[$name]);
+    }
+
+    /**
+     * Get the instance
+     *
+     * If the instance is not already created then create it
+     *
+     * @param string The entry name
+     *
+     * @return static The instance
+     *
+     * @throws InvalidArgumentException If the entry name doesn't exist
+     * @throws Throwable If instantiating failed
+     */
+    public static function TRegistryBase_getInstance (string $name): self {
+        if (!static::hasEntry($name)) {
+            throw new InvalidArgumentException('Unable to find entry "' . $name . '"');
+        }
+        if (!isset(static::$registryInstances[$name])) {
+            static::$registryInstances[$name] = new static(...static::$registerEntries[$name]);
+        }
+        return static::$registryInstances[$name];
+    }
+}
\ No newline at end of file
diff --git a/src/Singleton/TRegistryDefault.php b/src/Singleton/TRegistryDefault.php
new file mode 100644
index 0000000..d4f1cda
--- /dev/null
+++ b/src/Singleton/TRegistryDefault.php
@@ -0,0 +1,44 @@
+<?php
+
+namespace jrosset\Singleton;
+
+use InvalidArgumentException;
+
+/**
+ * Default implementation for registry with default entry name
+ *
+ * Instance initialization through the constructor
+ *
+ * @see IRegistryDefault for interface
+ */
+trait TRegistryDefault {
+    use TRegistryBase;
+
+    /**
+     * @var string|null The default entry name. NULL if not defined yet
+     */
+    private static ?string $registryDefaultEntryName = null;
+
+    /**
+     * @inheritDoc
+     */
+    public static function getDefaultEntryName (): string {
+        if (static::$registryDefaultEntryName === null) {
+            throw new InvalidArgumentException('No default entry name set');
+        }
+        return static::$registryDefaultEntryName;
+    }
+    /**
+     * @inheritDoc
+     */
+    public static function setDefaultEntryName (string $name): void {
+        static::$registryDefaultEntryName = $name;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public static function getInstance (?string $name = null): self {
+        return static::TRegistryBase_getInstance($name ?? static::getDefaultEntryName());
+    }
+}
\ No newline at end of file
diff --git a/src/Singleton/TSingleton.php b/src/Singleton/TSingleton.php
index 453543c..c03d34d 100644
--- a/src/Singleton/TSingleton.php
+++ b/src/Singleton/TSingleton.php
@@ -3,16 +3,18 @@
 namespace jrosset\Singleton;
 
 /**
- * Trait for simple singleton
+ * Default implementation for singleton
  *
  * Initialization through the constructor
+ *
+ * @see ISingleton for interface
  */
 trait TSingleton {
     /**
      * @var static|null The current instance. Null if not already created
      * @noinspection PhpDocFieldTypeMismatchInspection
      */
-    private static ?self $singleton_instance;
+    private static ?self $singletonInstance;
 
     /**
      * Initialize the instance
@@ -21,17 +23,13 @@ trait TSingleton {
     }
 
     /**
-     * Get the instance
-     *
-     * If the instance is not already created then create it
-     *
-     * @return static The instance
+     * @inheritDoc
      */
     public static final function getInstance (): self {
-        if (!isset(self::$singleton_instance)) {
-            self::$singleton_instance = new static();
+        if (!isset(self::$singletonInstance)) {
+            self::$singletonInstance = new static();
         }
 
-        return self::$singleton_instance;
+        return self::$singletonInstance;
     }
 }
\ No newline at end of file
diff --git a/tests/registry.php b/tests/registry.php
new file mode 100644
index 0000000..f1fe1e8
--- /dev/null
+++ b/tests/registry.php
@@ -0,0 +1,38 @@
+<?php
+/** @noinspection PhpUnhandledExceptionInspection */
+
+/** @noinspection PhpIllegalPsrClassPathInspection */
+
+use jrosset\Singleton\IRegistry;
+use jrosset\Singleton\TRegistry;
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+class RegistryTest implements IRegistry {
+    use TRegistry;
+
+    private int $cpt;
+
+    private function __construct (int $cpt) {
+        $this->cpt = $cpt;
+    }
+
+    public function getCpt (): int {
+        return $this->cpt;
+    }
+    public function increment (): void {
+        $this->cpt++;
+    }
+}
+
+RegistryTest::addEntry('cpt_1', 0);
+RegistryTest::addEntry('cpt_2', 5);
+
+var_dump(RegistryTest::getInstance('cpt_1')->getCpt());
+var_dump(RegistryTest::getInstance('cpt_2')->getCpt());
+
+RegistryTest::getInstance('cpt_1')->increment();
+RegistryTest::getInstance('cpt_2')->increment();
+
+var_dump(RegistryTest::getInstance('cpt_1')->getCpt());
+var_dump(RegistryTest::getInstance('cpt_2')->getCpt());
\ No newline at end of file
diff --git a/tests/registry_default.php b/tests/registry_default.php
new file mode 100644
index 0000000..c93eec1
--- /dev/null
+++ b/tests/registry_default.php
@@ -0,0 +1,39 @@
+<?php
+/** @noinspection PhpUnhandledExceptionInspection */
+
+/** @noinspection PhpIllegalPsrClassPathInspection */
+
+use jrosset\Singleton\IRegistryDefault;
+use jrosset\Singleton\TRegistryDefault;
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+class RegistryDefaultTest implements IRegistryDefault {
+    use TRegistryDefault;
+
+    private int $cpt;
+
+    private function __construct (int $cpt) {
+        $this->cpt = $cpt;
+    }
+
+    public function getCpt (): int {
+        return $this->cpt;
+    }
+    public function increment (): void {
+        $this->cpt++;
+    }
+}
+
+RegistryDefaultTest::addEntry('cpt_1', -5);
+RegistryDefaultTest::addEntry('cpt_2', 12);
+RegistryDefaultTest::setDefaultEntryName('cpt_1');
+
+var_dump(RegistryDefaultTest::getInstance()->getCpt());
+var_dump(RegistryDefaultTest::getInstance('cpt_2')->getCpt());
+
+RegistryDefaultTest::getInstance()->increment();
+RegistryDefaultTest::getInstance('cpt_2')->increment();
+
+var_dump(RegistryDefaultTest::getInstance()->getCpt());
+var_dump(RegistryDefaultTest::getInstance('cpt_2')->getCpt());
\ No newline at end of file
diff --git a/tests/test.php b/tests/singleton.php
similarity index 55%
rename from tests/test.php
rename to tests/singleton.php
index db564b8..cf1e872 100644
--- a/tests/test.php
+++ b/tests/singleton.php
@@ -6,10 +6,14 @@ require_once __DIR__ . '/../vendor/autoload.php';
 use jrosset\Singleton\ISingleton;
 use jrosset\Singleton\TSingleton;
 
-class Test implements ISingleton {
+class SingletonTest implements ISingleton {
     use TSingleton;
 
-    private int $cpt = 0;
+    private int $cpt;
+
+    private function __construct () {
+        $this->cpt = 0;
+    }
 
     public function getCpt (): int {
         return $this->cpt;
@@ -19,6 +23,6 @@ class Test implements ISingleton {
     }
 }
 
-var_dump(Test::getInstance()->getCpt());
-Test::getInstance()->increment();
-var_dump(Test::getInstance()->getCpt());
+var_dump(SingletonTest::getInstance()->getCpt());
+SingletonTest::getInstance()->increment();
+var_dump(SingletonTest::getInstance()->getCpt());