task: expose helper methods on SelectStatement

Author: norberttech

src/lib/postgresql/src/Flow/PostgreSql/AST/Nodes/Statement/SelectStatement.php

@@ -20,6 +20,31 @@ public function __construct(
     ) {
     }
 
+    public function hasCte() : bool
+    {
+        return $this->stmt->hasWithClause();
+    }
+
+    public function hasIntoClause() : bool
+    {
+        return $this->stmt->hasIntoClause();
+    }
+
+    public function hasLimit() : bool
+    {
+        return $this->stmt->hasLimitCount();
+    }
+
+    public function hasLockingClause() : bool
+    {
+        return \count($this->stmt->getLockingClause()) > 0;
+    }
+
+    public function hasOffset() : bool
+    {
+        return $this->stmt->hasLimitOffset();
+    }
+
     public function raw() : SelectStmt
     {
         return $this->stmt;

src/lib/postgresql/tests/Flow/PostgreSql/Tests/Unit/AST/Nodes/Statement/SelectStatementTest.php

@@ -0,0 +1,117 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flow\PostgreSql\Tests\Unit\AST\Nodes\Statement;
+
+use function Flow\PostgreSql\DSL\sql_parse;
+
+use Flow\PostgreSql\AST\Nodes\Statement\SelectStatement;
+use PHPUnit\Framework\TestCase;
+
+final class SelectStatementTest extends TestCase
+{
+    protected function setUp() : void
+    {
+        if (!\extension_loaded('pg_query')) {
+            self::markTestSkipped('pg_query extension is not loaded. For local development use `nix-shell --arg with-pg-query-ext true` to enable it in the shell.');
+        }
+    }
+
+    public function test_has_cte_returns_false_when_no_with_clause() : void
+    {
+        $statement = sql_parse('SELECT * FROM users')->statements()->first();
+        self::assertInstanceOf(SelectStatement::class, $statement);
+
+        self::assertFalse($statement->hasCte());
+    }
+
+    public function test_has_cte_returns_true_when_with_clause_exists() : void
+    {
+        $statement = sql_parse('WITH active_users AS (SELECT * FROM users WHERE active = true) SELECT * FROM active_users')->statements()->first();
+        self::assertInstanceOf(SelectStatement::class, $statement);
+
+        self::assertTrue($statement->hasCte());
+    }
+
+    public function test_has_into_clause_returns_false_when_no_into_clause() : void
+    {
+        $statement = sql_parse('SELECT * FROM users')->statements()->first();
+        self::assertInstanceOf(SelectStatement::class, $statement);
+
+        self::assertFalse($statement->hasIntoClause());
+    }
+
+    public function test_has_into_clause_returns_true_when_into_clause_exists() : void
+    {
+        $statement = sql_parse('SELECT * INTO new_users FROM users')->statements()->first();
+        self::assertInstanceOf(SelectStatement::class, $statement);
+
+        self::assertTrue($statement->hasIntoClause());
+    }
+
+    public function test_has_limit_returns_false_when_no_limit() : void
+    {
+        $statement = sql_parse('SELECT * FROM users')->statements()->first();
+        self::assertInstanceOf(SelectStatement::class, $statement);
+
+        self::assertFalse($statement->hasLimit());
+    }
+
+    public function test_has_limit_returns_true_when_limit_exists() : void
+    {
+        $statement = sql_parse('SELECT * FROM users LIMIT 10')->statements()->first();
+        self::assertInstanceOf(SelectStatement::class, $statement);
+
+        self::assertTrue($statement->hasLimit());
+    }
+
+    public function test_has_locking_clause_returns_false_when_no_locking() : void
+    {
+        $statement = sql_parse('SELECT * FROM users')->statements()->first();
+        self::assertInstanceOf(SelectStatement::class, $statement);
+
+        self::assertFalse($statement->hasLockingClause());
+    }
+
+    public function test_has_locking_clause_returns_true_when_for_share_exists() : void
+    {
+        $statement = sql_parse('SELECT * FROM users FOR SHARE')->statements()->first();
+        self::assertInstanceOf(SelectStatement::class, $statement);
+
+        self::assertTrue($statement->hasLockingClause());
+    }
+
+    public function test_has_locking_clause_returns_true_when_for_update_exists() : void
+    {
+        $statement = sql_parse('SELECT * FROM users FOR UPDATE')->statements()->first();
+        self::assertInstanceOf(SelectStatement::class, $statement);
+
+        self::assertTrue($statement->hasLockingClause());
+    }
+
+    public function test_has_offset_returns_false_when_no_offset() : void
+    {
+        $statement = sql_parse('SELECT * FROM users')->statements()->first();
+        self::assertInstanceOf(SelectStatement::class, $statement);
+
+        self::assertFalse($statement->hasOffset());
+    }
+
+    public function test_has_offset_returns_true_when_limit_and_offset_exist() : void
+    {
+        $statement = sql_parse('SELECT * FROM users LIMIT 10 OFFSET 5')->statements()->first();
+        self::assertInstanceOf(SelectStatement::class, $statement);
+
+        self::assertTrue($statement->hasLimit());
+        self::assertTrue($statement->hasOffset());
+    }
+
+    public function test_has_offset_returns_true_when_offset_exists() : void
+    {
+        $statement = sql_parse('SELECT * FROM users OFFSET 5')->statements()->first();
+        self::assertInstanceOf(SelectStatement::class, $statement);
+
+        self::assertTrue($statement->hasOffset());
+    }
+}