[refactor] introduce debug classes under new structure

docs/advanced.rst

@@ -98,19 +98,19 @@ a proxy connection object that will collect the necessary statistics and
 "echo" them out.
 
 If you would like to do something else with these statistics, you can set
-a callback. For Dumper::
+a callback. For Stopwatch::
 
     $c->callback = function($expression, $time, $fail = false) {
         ...
     }
 
-and for Counter::
+and for Profiler::
 
     $c->callback = function($queries, $selects, $rows, $expressions, $fail = false) {
         ...
     }
 
-If you have used "dumper:counter:", then use this::
+If you have used "stopwatch:profile:", then use this::
 
     $c->callback = function($expression, $time, $fail = false) {
         ...

docs/extensions.rst

@@ -20,16 +20,16 @@ MSSQL       Untested  mssql:   native, PDO
 Other Interesting Drivers
 -------------------------
 
-===================== ========= ======== ============
-Class                 Support   PDO      Dependency
-===================== ========= ======== ============
-Connection_Dumper     Full      dumper:  native, Proxy
-Connection_Counter    Full      counter: native, Proxy
-===================== ========= ======== ============
+=========================== ========= ========== ============
+Class                       Support   PDO        Dependency
+=========================== ========= ========== ============
+Debug\Stopwatch\Driver      Full      stopwatch: native, Proxy
+Debug\Profiler\Driver       Full      profile:   native, Proxy
+=========================== ========= ========== ============
 
 
 3rd party vendor support
--------------------------
+------------------------
 
 ===================== ========= =========  ============================
 Class                 Support   PDO        Dependency

src/Connection.php

@@ -195,14 +195,16 @@ public static function connect($dsn, $user = null, $password = null, $args = [])
                 ], $args));
 
                 break;
-            case 'dumper':
-                $c = new Connection_Dumper(array_merge([
+            case 'dumper': // deprecated - will be removed in v2.3
+            case 'stopwatch':
+                $c = new Debug\Stopwatch\Driver(array_merge([
                     'connection' => static::connect($dsn['rest'], $dsn['user'], $dsn['pass']),
                 ], $args));
 
                 break;
-            case 'counter':
-                $c = new Connection_Counter(array_merge([
+            case 'counter': // deprecated - will be removed in v2.3
+            case 'profile':
+                $c = new Debug\Profiler\Driver(array_merge([
                     'connection' => static::connect($dsn['rest'], $dsn['user'], $dsn['pass']),
                 ], $args));
 

src/Connection_Counter.php

@@ -4,101 +4,9 @@
 
 namespace atk4\dsql;
 
-class Connection_Counter extends Connection_Proxy
+/**
+ * @deprecated will be removed in v2.3
+ */
+class Connection_Counter extends Debug\Profiler\Driver
 {
-    /**
-     * Callable to call for outputting.
-     *
-     * Will receive parameters:
-     *  - int     Count of executed queries
-     *  - int     Count of executed selects
-     *  - int     Count of rows iterated
-     *  - int     Count of executed expressions
-     *  - boolean True if we had exception while executing expression
-     *
-     * @var callable
-     */
-    public $callback;
-
-    /** @var int Count of executed selects */
-    protected $selects = 0;
-
-    /** @var int Count of executed queries */
-    protected $queries = 0;
-
-    /** @var int Count of executed expressions */
-    protected $expressions = 0;
-
-    /** @var int Count of rows iterated */
-    protected $rows = 0;
-
-    /**
-     * Iterate (yield) array.
-     *
-     * @param array $ret
-     *
-     * @return mixed
-     */
-    public function iterate($ret)
-    {
-        foreach ($ret as $key => $row) {
-            ++$this->rows;
-            yield $key => $row;
-        }
-    }
-
-    /**
-     * Execute expression.
-     *
-     * @return mixed
-     */
-    public function execute(Expression $expr)
-    {
-        if ($expr instanceof Query) {
-            ++$this->queries;
-            if ($expr->mode === 'select' || $expr->mode === null) {
-                ++$this->selects;
-            }
-        } else {
-            ++$this->expressions;
-        }
-
-        try {
-            $ret = parent::execute($expr);
-        } catch (\Exception $e) {
-            if ($this->callback && is_callable($this->callback)) {
-                call_user_func($this->callback, $this->queries, $this->selects, $this->rows, $this->expressions, true);
-            } else {
-                printf(
-                    "[ERROR] Queries: %3d, Selects: %3d, Rows fetched: %4d, Expressions %3d\n",
-                    $this->queries,
-                    $this->selects,
-                    $this->rows,
-                    $this->expressions
-                );
-            }
-
-            throw $e;
-        }
-
-        return $this->iterate($ret);
-    }
-
-    /**
-     * Log results when destructing.
-     */
-    public function __destruct()
-    {
-        if ($this->callback && is_callable($this->callback)) {
-            call_user_func($this->callback, $this->queries, $this->selects, $this->rows, $this->expressions, false);
-        } else {
-            printf(
-                "Queries: %3d, Selects: %3d, Rows fetched: %4d, Expressions %3d\n",
-                $this->queries,
-                $this->selects,
-                $this->rows,
-                $this->expressions
-            );
-        }
-    }
 }

src/Connection_Dumper.php

@@ -4,55 +4,9 @@
 
 namespace atk4\dsql;
 
-class Connection_Dumper extends Connection_Proxy
+/**
+ * @deprecated will be removed in v2.3
+ */
+class Connection_Dumper extends Debug\Stopwatch\Driver
 {
-    /**
-     * Callable to call for outputting.
-     *
-     * Will receive parameters:
-     *  - Expression Expression object
-     *  - float      How long it took to execute expression
-     *  - boolean    True if we had exception while executing expression
-     *
-     * @var callable
-     */
-    public $callback;
-
-    /**
-     * @var float
-     */
-    protected $start_time;
-
-    /**
-     * Execute expression.
-     *
-     * @return \PDOStatement
-     */
-    public function execute(Expression $expr)
-    {
-        $this->start_time = microtime(true);
-
-        try {
-            $ret = parent::execute($expr);
-            $took = microtime(true) - $this->start_time;
-
-            if ($this->callback && is_callable($this->callback)) {
-                call_user_func($this->callback, $expr, $took, false);
-            } else {
-                printf("[%02.6f] %s\n", $took, $expr->getDebugQuery());
-            }
-        } catch (\Exception $e) {
-            $took = microtime(true) - $this->start_time;
-
-            if ($this->callback && is_callable($this->callback)) {
-                call_user_func($this->callback, $expr, $took, true);
-            } else {
-                printf("[ERROR %02.6f] %s\n", $took, $expr->getDebugQuery());
-            }
-
-            throw $e;
-        }
-
-        return $ret;
-    }
 }

src/Debug/Profiler/Driver.php

@@ -0,0 +1,116 @@
+<?php
+
+declare(strict_types=1);
+
+namespace atk4\dsql\Debug\Profiler;
+
+use atk4\dsql\Connection_Proxy;
+use atk4\dsql\Expression;
+use atk4\dsql\Query;
+
+class Driver extends Connection_Proxy
+{
+    public $driverType = 'profile';
+
+    /**
+     * Callable to call for outputting.
+     *
+     * Will receive parameters:
+     *  - int     Count of executed queries
+     *  - int     Count of executed selects
+     *  - int     Count of rows iterated
+     *  - int     Count of executed expressions
+     *  - boolean True if we had exception while executing expression
+     *
+     * @var callable
+     */
+    public $callback;
+
+    /** @var int Count of executed selects */
+    protected $selects = 0;
+
+    /** @var int Count of executed queries */
+    protected $queries = 0;
+
+    /** @var int Count of executed expressions */
+    protected $expressions = 0;
+
+    /** @var int Count of rows iterated */
+    protected $rows = 0;
+
+    public static function createDriver(array $dsn)
+    {
+        return static::create($dsn['rest'], $dsn['user'], $dsn['pass']);
+    }
+
+    /**
+     * Iterate (yield) array.
+     *
+     * @param array $ret
+     *
+     * @return mixed
+     */
+    public function iterate($ret)
+    {
+        foreach ($ret as $key => $row) {
+            ++$this->rows;
+            yield $key => $row;
+        }
+    }
+
+    /**
+     * Execute expression.
+     *
+     * @return mixed
+     */
+    public function execute(Expression $expr)
+    {
+        if ($expr instanceof Query) {
+            ++$this->queries;
+            if ($expr->mode === 'select' || $expr->mode === null) {
+                ++$this->selects;
+            }
+        } else {
+            ++$this->expressions;
+        }
+
+        try {
+            $ret = parent::execute($expr);
+        } catch (\Exception $e) {
+            if ($this->callback && is_callable($this->callback)) {
+                call_user_func($this->callback, $this->queries, $this->selects, $this->rows, $this->expressions, true);
+            } else {
+                $this->dump(true);
+            }
+
+            throw $e;
+        }
+
+        return $this->iterate($ret);
+    }
+
+    /**
+     * Log results when destructing.
+     */
+    public function __destruct()
+    {
+        if ($this->callback && is_callable($this->callback)) {
+            call_user_func($this->callback, $this->queries, $this->selects, $this->rows, $this->expressions, false);
+        } else {
+            $this->dump();
+        }
+    }
+
+    protected function dump($error = false)
+    {
+        $error = $error ? 'ERROR ' : '';
+
+        printf(
+            "{$error}Queries: %3d, Selects: %3d, Rows fetched: %4d, Expressions %3d\n",
+            $this->queries,
+            $this->selects,
+            $this->rows,
+            $this->expressions
+        );
+    }
+}