feat: initial commit of camelia/orm

Attribute-mapped Active Record ORM for MariaDB/MySQL over PDO.

- Attribute-driven metadata: TableName, PrimaryKey, AutoIncrement, Column,
  Guarded, Ignore, Required, Enum, Nullable, Length, Precision, Unique,
  UniqueGroup, Index, MaxLength.
- Relationship mapping: BelongsTo, HasOne, HasMany, BelongsToMany with
  batched eager loading and a 3-level depth limit.
- Orm entry point with fromArray, fromPdo, fromEnv and nested transactions.
- Immutable Query with Cond operators and GroupCond grouping.
- Repository read and write API, pagination, and typed exception hierarchy.
- Declares PHP >=8.3; Mago and PHPStan pin the parser to 8.3.
- MIT license.
This commit is contained in:
dgarcia committed 2026-11-15 10:14:22 -03:00
commit 66e93e3070
97 files changed
+12188

No files matched your search

+148
View File
@@ -0,0 +1,148 @@
<?php
declare(strict_types=1);
namespace Camelia\Orm\Tests\Unit\Query;
use Camelia\Orm\Exception\CriteriaException;
use Camelia\Orm\Metadata\MetadataFactory;
use Camelia\Orm\Query\Cond;
use Camelia\Orm\Query\CriteriaCompiler;
use Camelia\Orm\Query\MySqlDialect;
use Camelia\Orm\Tests\Fixture\Usuario;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\TestCase;
final class CriteriaCompilerTest extends TestCase
{
private CriteriaCompiler $compiler;
protected function setUp(): void
{
$this->compiler = new CriteriaCompiler(new MySqlDialect());
}
#[Test]
public function it_returns_an_empty_fragment_without_criteria(): void
{
[$sql, $params] = $this->compiler->compile($this->metadata(), []);
self::assertSame('', $sql);
self::assertSame([], $params);
}
#[Test]
public function it_compiles_scalar_equality(): void
{
[$sql, $params] = $this->compiler->compile($this->metadata(), ['activo' => true]);
self::assertSame('`activo` = ?', $sql);
self::assertSame([true], $params);
}
#[Test]
public function it_accepts_column_names_as_keys(): void
{
[$sql] = $this->compiler->compile($this->metadata(), ['password_hash' => 'x']);
self::assertSame('`password_hash` = ?', $sql);
}
#[Test]
public function it_compiles_arrays_as_in(): void
{
[$sql, $params] = $this->compiler->compile($this->metadata(), ['codigo' => [1, 2]]);
self::assertSame('`codigo` IN (?, ?)', $sql);
self::assertSame([1, 2], $params);
}
#[Test]
public function it_compiles_an_empty_array_as_always_false(): void
{
[$sql, $params] = $this->compiler->compile($this->metadata(), ['codigo' => []]);
self::assertSame('1 = 0', $sql);
self::assertSame([], $params);
}
#[Test]
public function it_compiles_null_as_is_null(): void
{
[$sql, $params] = $this->compiler->compile($this->metadata(), ['apodo' => null]);
self::assertSame('`apodo` IS NULL', $sql);
self::assertSame([], $params);
}
#[Test]
public function it_combines_criteria_with_and(): void
{
[$sql, $params] = $this->compiler->compile($this->metadata(), [
'activo' => true,
'nombre' => 'ana',
]);
self::assertSame('`activo` = ? AND `nombre` = ?', $sql);
self::assertSame([true, 'ana'], $params);
}
#[Test]
public function it_compiles_every_cond_operator(): void
{
$cases = [
['neq', Cond::neq(1), '`codigo` <> ?'],
['gt', Cond::gt(1), '`codigo` > ?'],
['gte', Cond::gte(1), '`codigo` >= ?'],
['lt', Cond::lt(1), '`codigo` < ?'],
['lte', Cond::lte(1), '`codigo` <= ?'],
['like', Cond::like('%a%'), '`codigo` LIKE ?'],
['notLike', Cond::notLike('%a%'), '`codigo` NOT LIKE ?'],
['between', Cond::between(1, 2), '`codigo` BETWEEN ? AND ?'],
['notBetween', Cond::notBetween(1, 2), '`codigo` NOT BETWEEN ? AND ?'],
['isNull', Cond::isNull(), '`codigo` IS NULL'],
['isNotNull', Cond::isNotNull(), '`codigo` IS NOT NULL'],
['in', Cond::in([1, 2]), '`codigo` IN (?, ?)'],
['notIn', Cond::notIn([1, 2]), '`codigo` NOT IN (?, ?)'],
];
foreach ($cases as [$label, $cond, $expected]) {
[$sql] = $this->compiler->compile($this->metadata(), ['codigo' => $cond]);
self::assertSame($expected, $sql, $label);
}
}
#[Test]
public function it_compiles_raw_conditions(): void
{
[$sql, $params] =
$this->compiler->compile($this->metadata(), ['codigo' => Cond::raw('codigo > ?', [
10,
])]);
self::assertSame('(codigo > ?)', $sql);
self::assertSame([10], $params);
}
#[Test]
public function it_rejects_an_unknown_column_naming_the_valid_ones(): void
{
$this->expectException(CriteriaException::class);
$this->expectExceptionMessage('Unknown column "inexistente"');
$this->compiler->compile($this->metadata(), ['inexistente' => 1]);
}
#[Test]
public function it_rejects_an_empty_in_cond(): void
{
$this->expectException(CriteriaException::class);
$this->compiler->compile($this->metadata(), ['codigo' => Cond::in([])]);
}
private function metadata(): \Camelia\Orm\Metadata\ClassMetadata
{
return (new MetadataFactory())->forClass(Usuario::class);
}
}
+161
View File
@@ -0,0 +1,161 @@
<?php
declare(strict_types=1);
namespace Camelia\Orm\Tests\Unit\Query;
use Camelia\Orm\Exception\CriteriaException;
use Camelia\Orm\Metadata\ClassMetadata;
use Camelia\Orm\Metadata\MetadataFactory;
use Camelia\Orm\Query\MySqlDialect;
use Camelia\Orm\Query\QueryBuilder;
use Camelia\Orm\Tests\Fixture\Factura;
use Camelia\Orm\Tests\Fixture\Usuario;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\TestCase;
final class QueryBuilderTest extends TestCase
{
private QueryBuilder $builder;
private ClassMetadata $usuarios;
protected function setUp(): void
{
$this->builder = new QueryBuilder(new MySqlDialect());
$this->usuarios = (new MetadataFactory())->forClass(Usuario::class);
}
#[Test]
public function it_selects_every_non_relation_column(): void
{
$compiled = $this->builder->select($this->usuarios, []);
self::assertSame(
'SELECT `codigo`, `nombre`, `correo`, `password_hash`, `activo`, `apodo`, `clave`'
. ' FROM `usuarios`',
$compiled['sql'],
);
self::assertSame([], $compiled['params']);
}
#[Test]
public function it_excludes_relations_from_the_select_list(): void
{
$metadata = (new MetadataFactory())->forClass(Factura::class);
$compiled = $this->builder->select($metadata, []);
self::assertStringNotContainsString('`usuario`', $compiled['sql']);
self::assertStringNotContainsString('`detalles`', $compiled['sql']);
}
#[Test]
public function it_adds_where_order_and_limit(): void
{
$compiled = $this->builder->select(
$this->usuarios,
['activo' => true],
[['nombre', 'ASC']],
10,
20,
);
self::assertSame(
'SELECT `codigo`, `nombre`, `correo`, `password_hash`, `activo`, `apodo`, `clave`'
. ' FROM `usuarios` WHERE `activo` = ?'
. ' ORDER BY `usuarios`.`nombre` ASC LIMIT 10 OFFSET 20',
$compiled['sql'],
);
self::assertSame([true], $compiled['params']);
}
#[Test]
public function it_rejects_an_invalid_order_direction(): void
{
$this->expectException(CriteriaException::class);
/** @phpstan-ignore-next-line intentionally invalid direction to prove runtime validation */
$this->builder->select($this->usuarios, [], [['nombre', 'SIDEWAYS']]);
}
#[Test]
public function it_restricts_selected_columns_when_asked(): void
{
$compiled = $this->builder->select(
$this->usuarios,
[],
[],
null,
null,
['codigo', 'nombre'],
);
self::assertStringContainsString('SELECT `codigo`, `nombre` FROM', $compiled['sql']);
}
#[Test]
public function it_compiles_count(): void
{
$compiled = $this->builder->count($this->usuarios, ['activo' => 1]);
self::assertSame(
'SELECT COUNT(*) AS aggregate FROM `usuarios` WHERE `activo` = ?',
$compiled['sql'],
);
self::assertSame([1], $compiled['params']);
}
#[Test]
public function it_compiles_aggregates(): void
{
$compiled = $this->builder->aggregate($this->usuarios, 'codigo', 'MAX', []);
self::assertSame('SELECT MAX(`codigo`) AS aggregate FROM `usuarios`', $compiled['sql']);
}
#[Test]
public function it_compiles_insert(): void
{
$compiled = $this->builder->insert($this->usuarios, ['nombre' => 'Ana', 'activo' => true]);
self::assertSame(
'INSERT INTO `usuarios` (`nombre`, `activo`) VALUES (?, ?)',
$compiled['sql'],
);
self::assertSame(['Ana', true], $compiled['params']);
}
#[Test]
public function it_compiles_update(): void
{
$compiled = $this->builder->update($this->usuarios, ['nombre' => 'Ana'], 7);
self::assertSame('UPDATE `usuarios` SET `nombre` = ? WHERE `codigo` = ?', $compiled['sql']);
self::assertSame(['Ana', 7], $compiled['params']);
}
#[Test]
public function it_compiles_delete(): void
{
$compiled = $this->builder->delete($this->usuarios, 7);
self::assertSame('DELETE FROM `usuarios` WHERE `codigo` = ?', $compiled['sql']);
self::assertSame([7], $compiled['params']);
}
#[Test]
public function it_refuses_an_empty_insert(): void
{
$this->expectException(CriteriaException::class);
$this->builder->insert($this->usuarios, []);
}
#[Test]
public function it_refuses_an_empty_update(): void
{
$this->expectException(CriteriaException::class);
$this->builder->update($this->usuarios, [], 1);
}
}