Merge Part\Joins into Join, fix all phpstan and phpcs errors

Eliminate the Part\Joins internal class by merging its rendering
functionality (toSql, specs, caching) directly into the public Join
class, which now extends AbstractPart. This removes the lazy getModel()
bridge and the duplicated joinModel property on Table.

Also fix all phpstan errors: remove redundant is_string check in
PredicateSet, narrow Sql method types to AbstractPreparableSql/AbstractSql,
fix MockObject return types in test helpers, rename TokenizesExpression
trait to satisfy Trait suffix rule. Fix all phpcs warnings across the
codebase.

Author: simon-mundy

src/Adapter/Platform/AbstractPlatform.php

@@ -44,7 +44,7 @@ public function quoteIdentifier(string $identifier, ?string $identifier2 = null)
         }
 
         if ($identifier2 !== null) {
-            $key = $identifier . '.' . $identifier2;
+            $key                                  = $identifier . '.' . $identifier2;
             return $this->identifierCache[$key]
                 ??= $this->quoteIdentifier[0]
                     . str_replace($this->quoteIdentifier[0], $this->quoteIdentifierTo, $identifier)

src/Sql/Delete.php

@@ -8,9 +8,9 @@
 use PhpDb\Adapter\Driver\DriverInterface;
 use PhpDb\Adapter\ParameterContainer;
 use PhpDb\Adapter\Platform\PlatformInterface;
+use PhpDb\Sql\Part\From;
 use PhpDb\Sql\Part\SqlFragment;
 use PhpDb\Sql\Part\SqlProcessor;
-use PhpDb\Sql\Part\From;
 use PhpDb\Sql\Part\Where as WherePart;
 use PhpDb\Sql\Platform\AbstractPlatform as SqlPlatform;
 use PhpDb\Sql\Predicate\PredicateInterface;

src/Sql/Expression.php

@@ -17,7 +17,8 @@
 
 class Expression extends AbstractExpression
 {
-    use TokenizesExpression;
+    use TokenizesExpressionTrait;
+
     /**
      * @const
      */

src/Sql/Insert.php

@@ -8,8 +8,8 @@
 use PhpDb\Adapter\Driver\PdoDriverInterface;
 use PhpDb\Adapter\ParameterContainer;
 use PhpDb\Adapter\Platform\PlatformInterface;
-use PhpDb\Sql\Part\SqlProcessor;
 use PhpDb\Sql\Part\From;
+use PhpDb\Sql\Part\SqlProcessor;
 use PhpDb\Sql\Platform\AbstractPlatform as SqlPlatform;
 
 use function array_flip;

src/Sql/Join.php

@@ -7,13 +7,21 @@
 use Countable;
 use Iterator;
 use Override;
+use PhpDb\Sql\Part\AbstractPart;
+use PhpDb\Sql\Part\JoinSpec;
+use PhpDb\Sql\Part\JoinTableType;
+use PhpDb\Sql\Part\SqlProcessor;
 use ReturnTypeWillChange;
 
 use function array_shift;
 use function count;
+use function explode;
+use function implode;
 use function is_array;
 use function is_string;
 use function key;
+use function preg_replace_callback;
+use function spl_object_id;
 use function sprintf;
 
 /**
@@ -26,8 +34,10 @@
  * - type: the type of JOIN being performed; see the `JOIN_*` constants;
  *   defaults to `JOIN_INNER`
  */
-class Join implements Iterator, Countable
+class Join extends AbstractPart implements Iterator, Countable
 {
+    private const IDENTIFIER_PATTERN = '/\b(?!(?:AS|AND|OR|BETWEEN)\b)([a-zA-Z_]\w*+(?:\.[a-zA-Z_]\w*+)*)(?!\s*\()/i';
+
     final public const JOIN_INNER = 'INNER';
 
     final public const JOIN_OUTER = 'OUTER';
@@ -42,59 +52,45 @@ class Join implements Iterator, Countable
 
     final public const JOIN_LEFT_OUTER = 'LEFT OUTER';
 
-    /**
-     * Current iterator position.
-     */
     private int $position = 0;
 
-    /**
-     * JOIN specifications
-     */
+    /** @var array[] */
     protected array $joins = [];
 
-    /**
-     * Rewind iterator.
-     */
+    /** @var JoinSpec[] */
+    private array $specs = [];
+
+    private ?string $sqlCache        = null;
+    private ?int $sqlCachePlatformId = null;
+
     #[Override]
     #[ReturnTypeWillChange]
     public function rewind(): void
     {
         $this->position = 0;
     }
 
-    /**
-     * Return current join specification.
-     */
     #[Override]
     #[ReturnTypeWillChange]
     public function current(): array
     {
         return $this->joins[$this->position];
     }
 
-    /**
-     * Return the current iterator index.
-     */
     #[Override]
     #[ReturnTypeWillChange]
     public function key(): int
     {
         return $this->position;
     }
 
-    /**
-     * Advance to the next JOIN specification.
-     */
     #[Override]
     #[ReturnTypeWillChange]
     public function next(): void
     {
         ++$this->position;
     }
 
-    /**
-     * Is the iterator at a valid position?
-     */
     #[Override]
     #[ReturnTypeWillChange]
     public function valid(): bool
@@ -134,13 +130,17 @@ public function join(
             $columns = [$columns];
         }
 
-        $this->joins[] = [
+        $raw = [
             'name'    => $name,
             'on'      => $on,
             'columns' => $columns,
             'type'    => $type,
         ];
 
+        $this->joins[]  = $raw;
+        $this->specs[]  = new JoinSpec($raw);
+        $this->sqlCache = null;
+
         return $this;
     }
 
@@ -149,17 +149,92 @@ public function join(
      */
     public function reset(): static
     {
-        $this->joins = [];
+        $this->joins              = [];
+        $this->specs              = [];
+        $this->sqlCache           = null;
+        $this->sqlCachePlatformId = null;
         return $this;
     }
 
-    /**
-     * Get count of attached predicates
-     */
     #[Override]
     #[ReturnTypeWillChange]
     public function count(): int
     {
         return count($this->joins);
     }
+
+    #[Override]
+    public function toSql(SqlProcessor $processor): ?string
+    {
+        if ($this->specs === []) {
+            return null;
+        }
+
+        $canCache = $processor->parameterContainer === null;
+        if ($canCache) {
+            $platformId = spl_object_id($processor->platform);
+            if ($this->sqlCachePlatformId === $platformId) {
+                return $this->sqlCache;
+            }
+        }
+
+        $platform     = $processor->platform;
+        $joinSqlParts = [];
+
+        foreach ($this->specs as $j => $spec) {
+            $joinName = match ($spec->tableType) {
+                JoinTableType::Expression      => $spec->table->getExpression(), // @phpstan-ignore method.nonObject
+                JoinTableType::TableIdentifier => $processor->resolveTable($spec->table),
+                JoinTableType::Select          => '(' . $processor->processSubSelect($spec->table) . ')',
+                JoinTableType::Identifier      => $platform->quoteIdentifier($spec->table),
+            };
+            $quotedAlias = $spec->alias !== null
+                ? $platform->quoteIdentifier($spec->alias)
+                : null;
+
+            $renderedTable = $processor->renderTable($joinName, $quotedAlias);
+
+            if ($spec->isExpressionOn) {
+                $onClause = $processor->renderExpression(
+                    $spec->on,
+                    'join' . ($j + 1) . 'part'
+                );
+            } else {
+                $onClause = preg_replace_callback(
+                    self::IDENTIFIER_PATTERN,
+                    static fn($m) => $platform->quoteIdentifier(...explode('.', $m[1], 2)),
+                    $spec->on,
+                );
+            }
+
+            $joinSqlParts[] = "{$spec->type} JOIN {$renderedTable} ON {$onClause}";
+        }
+
+        $result = implode(' ', $joinSqlParts);
+
+        if ($canCache) {
+            $this->sqlCache           = $result;
+            $this->sqlCachePlatformId = $platformId;
+        }
+
+        return $result;
+    }
+
+    #[Override]
+    public function isEmpty(): bool
+    {
+        return $this->specs === [];
+    }
+
+    /** @return JoinSpec[] */
+    public function getSpecs(): array
+    {
+        return $this->specs;
+    }
+
+    public function __clone()
+    {
+        $this->sqlCache           = null;
+        $this->sqlCachePlatformId = null;
+    }
 }

src/Sql/Part/ColumnRef.php

@@ -24,7 +24,7 @@ public function __construct(
         string $star = Select::SQL_STAR,
     ) {
         $this->column = $column;
-        $this->isStar = ($column === $star);
+        $this->isStar = $column === $star;
 
         if ($this->isStar) {
             $this->alias         = null;

src/Sql/Part/Columns.php

@@ -19,10 +19,10 @@
 class Columns extends AbstractPart
 {
     /** @var ColumnRef[] */
-    private array $columnRefs = [];
-    private array $rawColumns = [Select::SQL_STAR];
+    private array $columnRefs            = [];
+    private array $rawColumns            = [Select::SQL_STAR];
     private bool $prefixColumnsWithTable = true;
-    private string $fromTablePrefix = '';
+    private string $fromTablePrefix      = '';
     /** @var JoinSpec[] */
     private array $joinSpecs = [];
 

src/Sql/Part/GroupBy.php

@@ -4,8 +4,6 @@
 
 namespace PhpDb\Sql\Part;
 
-use PhpDb\Sql\ExpressionInterface;
-
 use function explode;
 use function implode;
 use function is_array;