Segregate methods from DriverBase

Author: mrliptontea

src/TripodStatFactory.php

@@ -4,8 +4,6 @@
 
 namespace Tripod;
 
-use Tripod\Mongo\NoStat;
-
 class TripodStatFactory
 {
     /**

src/classes/NoStat.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tripod;
+
+final class NoStat implements ITripodStat
+{
+    /**
+     * @var self
+     */
+    public static $instance;
+
+    public function increment(string $operation, int $inc = 1): void
+    {
+        // do nothing
+    }
+
+    /**
+     * @param float|int $duration
+     */
+    public function timer(string $operation, $duration): void
+    {
+        // do nothing
+    }
+
+    public function getConfig(): array
+    {
+        return [];
+    }
+
+    public static function getInstance(): self
+    {
+        if (self::$instance == null) {
+            self::$instance = new NoStat();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * @return self
+     */
+    public static function createFromConfig(array $config = [])
+    {
+        return self::getInstance();
+    }
+}

src/mongo/base/DriverBase.php

@@ -10,8 +10,6 @@
 use Monolog\Logger;
 use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
-use Tripod\Exceptions\Exception;
-use Tripod\IEventHook;
 use Tripod\ITripodStat;
 use Tripod\Mongo\Composites\Views;
 use Tripod\StatsD;
@@ -20,15 +18,6 @@
 
 abstract class DriverBase
 {
-    /**
-     * constants for the supported hook functions that can be applied.
-     */
-    public const HOOK_FN_PRE = 'pre';
-
-    public const HOOK_FN_SUCCESS = 'success';
-
-    public const HOOK_FN_FAILURE = 'failure';
-
     public static ?LoggerInterface $logger = null;
 
     protected string $storeName;
@@ -157,11 +146,6 @@ protected function getStatFromStatFactory(): ITripodStat
         return TripodStatFactory::create($this->statsConfig);
     }
 
-    protected function getExpirySecFromNow(int $secs): int
-    {
-        return time() + $secs;
-    }
-
     protected function getContextAlias(?string $context = null): string
     {
         $contextAlias = $this->labeller->uri_to_alias((empty($context)) ? $this->defaultContext : $context);
@@ -337,33 +321,6 @@ protected function getCollection(): Collection
         return $this->collection;
     }
 
-    /**
-     * @param IEventHook[] $hooks
-     *
-     * @throws Exception If an invalid hook function is requested
-     */
-    protected function applyHooks(string $fn, array $hooks, array $args = []): void
-    {
-        switch ($fn) {
-            case $this::HOOK_FN_PRE:
-            case $this::HOOK_FN_SUCCESS:
-            case $this::HOOK_FN_FAILURE:
-                break;
-
-            default:
-                throw new Exception(sprintf('Invalid hook function %s requested', $fn));
-        }
-
-        foreach ($hooks as $hook) {
-            try {
-                call_user_func([$hook, $fn], $args);
-            } catch (\Exception $e) {
-                // don't let rabid hooks stop tripod
-                static::getLogger()->error('Hook ' . get_class($hook) . sprintf(' threw exception %s, continuing', $e->getMessage()));
-            }
-        }
-    }
-
     /**
      * @codeCoverageIgnore
      */
@@ -372,46 +329,3 @@ private function log(string $level, string $message, ?array $params): void
         self::getLogger()->log($level, $message, $params ?: []);
     }
 }
-
-final class NoStat implements ITripodStat
-{
-    /**
-     * @var self
-     */
-    public static $instance;
-
-    public function increment(string $operation, int $inc = 1): void
-    {
-        // do nothing
-    }
-
-    /**
-     * @param float|int $duration
-     */
-    public function timer(string $operation, $duration): void
-    {
-        // do nothing
-    }
-
-    public function getConfig(): array
-    {
-        return [];
-    }
-
-    public static function getInstance(): self
-    {
-        if (self::$instance == null) {
-            self::$instance = new NoStat();
-        }
-
-        return self::$instance;
-    }
-
-    /**
-     * @return self
-     */
-    public static function createFromConfig(array $config = [])
-    {
-        return self::getInstance();
-    }
-}

src/mongo/delegates/Updates.php

@@ -22,6 +22,13 @@
 
 class Updates extends DriverBase
 {
+    /**
+     * constants for the supported hook functions that can be applied.
+     */
+    public const HOOK_FN_PRE = 'pre';
+    public const HOOK_FN_SUCCESS = 'success';
+    public const HOOK_FN_FAILURE = 'failure';
+
     protected Driver $tripod;
 
     protected ?Database $locksDb = null;
@@ -352,6 +359,33 @@ public function registerSaveChangesEventHook(IEventHook $hook): void
         $this->saveChangesHooks[] = $hook;
     }
 
+    /**
+     * @param IEventHook[] $hooks
+     *
+     * @throws Exception If an invalid hook function is requested
+     */
+    protected function applyHooks(string $fn, array $hooks, array $args = []): void
+    {
+        switch ($fn) {
+            case $this::HOOK_FN_PRE:
+            case $this::HOOK_FN_SUCCESS:
+            case $this::HOOK_FN_FAILURE:
+                break;
+
+            default:
+                throw new Exception(sprintf('Invalid hook function %s requested', $fn));
+        }
+
+        foreach ($hooks as $hook) {
+            try {
+                call_user_func([$hook, $fn], $args);
+            } catch (\Exception $e) {
+                // don't let rabid hooks stop tripod
+                static::getLogger()->error('Hook ' . get_class($hook) . sprintf(' threw exception %s, continuing', $e->getMessage()));
+            }
+        }
+    }
+
     /**
      * Change the read preferences to RP_PRIMARY
      * Used for a write operation.
@@ -965,7 +999,7 @@ protected function unlockAllDocuments(string $transaction_id): bool
      *
      * @param string $s subject URI of resource to lock
      *
-     * @return array|null|false
+     * @return array|false|null
      */
     protected function lockSingleDocument(string $s, string $transaction_id, string $contextAlias)
     {

src/mongo/delegates/Views.php

@@ -503,6 +503,11 @@ public function count(string $viewSpec, array $filters = []): int
         return $this->getCollectionForViewSpec($viewSpec)->count($filters);
     }
 
+    protected function getExpirySecFromNow(int $secs): int
+    {
+        return time() + $secs;
+    }
+
     /**
      * Joins data to $dest from $source according to specification in $joins, or queries DB if data is not available in $source.
      */

test/unit/mongo/MongoTripodStatTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use Tripod\Mongo\NoStat;
+use Tripod\NoStat;
 use Tripod\StatsD;
 use Tripod\TripodStatFactory;