docs: consolidate documentation into organized structure

- Move 12 markdown files from root to docs/ subdirectories
- Organize documentation by category:
  • docs/troubleshooting/ (1 file)  - Technical troubleshooting guides
  • docs/deployment/      (4 files) - Deployment and security documentation
  • docs/guides/          (3 files) - Feature-specific guides
  • docs/planning/        (4 files) - Planning and improvement proposals

Root directory cleanup:
- Reduced from 16 to 4 markdown files in root
- Only essential project files remain:
  • CLAUDE.md (AI instructions)
  • README.md (Main project readme)
  • CLEANUP_PLAN.md (Current cleanup plan)
  • SRC_STRUCTURE_IMPROVEMENTS.md (Structure improvements)

This improves:
 Documentation discoverability
 Logical organization by purpose
 Clean root directory
 Better maintainability
This commit is contained in:
2025-10-05 11:05:04 +02:00
parent 887847dde6
commit 5050c7d73a
36686 changed files with 196456 additions and 12398919 deletions

View File

@@ -0,0 +1,162 @@
<?php
declare(strict_types=1);
namespace Tests\Framework\Database\ValueObjects;
use App\Framework\Database\ValueObjects\QueryParameters;
use InvalidArgumentException;
describe('QueryParameters Value Object', function () {
it('can be created empty', function () {
$params = QueryParameters::empty();
expect($params->isEmpty())->toBeTrue();
expect($params->count())->toBe(0);
expect($params->toArray())->toBe([]);
});
it('can be created from array', function () {
$data = ['id' => 123, 'name' => 'John'];
$params = QueryParameters::fromArray($data);
expect($params->isEmpty())->toBeFalse();
expect($params->count())->toBe(2);
expect($params->get('id'))->toBe(123);
expect($params->get('name'))->toBe('John');
});
it('can add parameters immutably', function () {
$params = QueryParameters::empty();
$newParams = $params->with('id', 123);
expect($params->has('id'))->toBeFalse(); // Original unchanged
expect($newParams->has('id'))->toBeTrue();
expect($newParams->get('id'))->toBe(123);
});
it('can merge parameters', function () {
$params1 = QueryParameters::fromArray(['id' => 123]);
$params2 = $params1->merge(['name' => 'John', 'active' => true]);
expect($params1->count())->toBe(1); // Original unchanged
expect($params2->count())->toBe(3);
expect($params2->get('id'))->toBe(123);
expect($params2->get('name'))->toBe('John');
expect($params2->get('active'))->toBeTrue();
});
it('can remove parameters immutably', function () {
$params = QueryParameters::fromArray(['id' => 123, 'name' => 'John']);
$newParams = $params->without('name');
expect($params->has('name'))->toBeTrue(); // Original unchanged
expect($newParams->has('name'))->toBeFalse();
expect($newParams->has('id'))->toBeTrue();
});
it('gets parameters with defaults', function () {
$params = QueryParameters::fromArray(['id' => 123]);
expect($params->get('id'))->toBe(123);
expect($params->get('missing'))->toBeNull();
expect($params->get('missing', 'default'))->toBe('default');
});
it('normalizes parameter names', function () {
$params = QueryParameters::fromArray([':id' => 123, 'name' => 'John']);
expect($params->has('id'))->toBeTrue();
expect($params->has(':id'))->toBeTrue(); // Both work
expect($params->get('id'))->toBe(123);
expect($params->get(':id'))->toBe(123);
});
it('converts to PDO array with colon prefixes', function () {
$params = QueryParameters::fromArray(['id' => 123, ':name' => 'John']);
$pdoArray = $params->toPdoArray();
expect($pdoArray)->toBe([':id' => 123, ':name' => 'John']);
});
it('finds used parameters in SQL', function () {
$params = QueryParameters::fromArray(['id' => 123, 'name' => 'John', 'unused' => 'test']);
$sql = 'SELECT * FROM users WHERE id = :id AND name = :name';
$used = $params->getUsedParameters($sql);
expect($used)->toBe(['id', 'name']);
});
it('finds unused parameters', function () {
$params = QueryParameters::fromArray(['id' => 123, 'name' => 'John', 'unused' => 'test']);
$sql = 'SELECT * FROM users WHERE id = :id';
$unused = $params->getUnusedParameters($sql);
expect($unused)->toBe(['name', 'unused']);
});
it('validates SQL parameter requirements', function () {
$params = QueryParameters::fromArray(['id' => 123]);
$sql = 'SELECT * FROM users WHERE id = :id AND name = :name';
expect(fn () => $params->validateForSql($sql))->toThrow(InvalidArgumentException::class);
});
it('validates SQL parameter requirements successfully', function () {
$params = QueryParameters::fromArray(['id' => 123, 'name' => 'John']);
$sql = 'SELECT * FROM users WHERE id = :id AND name = :name';
expect(fn () => $params->validateForSql($sql))->not->toThrow(InvalidArgumentException::class);
});
it('determines PDO parameter types', function () {
$params = QueryParameters::fromArray([
'null_val' => null,
'bool_val' => true,
'int_val' => 123,
'string_val' => 'text',
]);
expect($params->getPdoType('null_val'))->toBe(\PDO::PARAM_NULL);
expect($params->getPdoType('bool_val'))->toBe(\PDO::PARAM_BOOL);
expect($params->getPdoType('int_val'))->toBe(\PDO::PARAM_INT);
expect($params->getPdoType('string_val'))->toBe(\PDO::PARAM_STR);
});
it('throws exception for non-string parameter names', function () {
expect(fn () => QueryParameters::fromArray([123 => 'value']))->toThrow(InvalidArgumentException::class);
});
it('throws exception for empty parameter names', function () {
expect(fn () => QueryParameters::fromArray(['' => 'value']))->toThrow(InvalidArgumentException::class);
expect(fn () => QueryParameters::fromArray([':' => 'value']))->toThrow(InvalidArgumentException::class);
});
it('throws exception for invalid parameter names', function () {
expect(fn () => QueryParameters::fromArray(['1invalid' => 'value']))->toThrow(InvalidArgumentException::class);
expect(fn () => QueryParameters::fromArray(['invalid-name' => 'value']))->toThrow(InvalidArgumentException::class);
expect(fn () => QueryParameters::fromArray(['invalid name' => 'value']))->toThrow(InvalidArgumentException::class);
});
it('allows valid parameter names', function () {
expect(fn () => QueryParameters::fromArray(['valid' => 'value']))->not->toThrow(InvalidArgumentException::class);
expect(fn () => QueryParameters::fromArray(['valid_name' => 'value']))->not->toThrow(InvalidArgumentException::class);
expect(fn () => QueryParameters::fromArray(['valid123' => 'value']))->not->toThrow(InvalidArgumentException::class);
expect(fn () => QueryParameters::fromArray(['_valid' => 'value']))->not->toThrow(InvalidArgumentException::class);
expect(fn () => QueryParameters::fromArray([':valid' => 'value']))->not->toThrow(InvalidArgumentException::class);
});
it('throws exception for non-scalar parameter values', function () {
expect(fn () => QueryParameters::fromArray(['array' => [1, 2, 3]]))->toThrow(InvalidArgumentException::class);
expect(fn () => QueryParameters::fromArray(['object' => new \stdClass()]))->toThrow(InvalidArgumentException::class);
});
it('allows scalar and null parameter values', function () {
expect(fn () => QueryParameters::fromArray([
'string' => 'text',
'int' => 123,
'float' => 12.34,
'bool' => true,
'null' => null,
]))->not->toThrow(InvalidArgumentException::class);
});
});

View File

@@ -0,0 +1,128 @@
<?php
declare(strict_types=1);
namespace Tests\Framework\Database\ValueObjects;
use App\Framework\Database\ValueObjects\QueryParameters;
use App\Framework\Database\ValueObjects\SqlQuery;
use InvalidArgumentException;
describe('SqlQuery Value Object', function () {
it('can be created with SQL and parameters', function () {
$params = QueryParameters::fromArray(['id' => 123]);
$query = new SqlQuery('SELECT * FROM users WHERE id = :id', $params);
expect($query->sql)->toBe('SELECT * FROM users WHERE id = :id');
expect($query->parameters->get('id'))->toBe(123);
});
it('can be created with create factory method', function () {
$query = SqlQuery::create('SELECT * FROM users', ['limit' => 10]);
expect($query->sql)->toBe('SELECT * FROM users');
expect($query->parameters->get('limit'))->toBe(10);
});
it('can create SELECT queries', function () {
$query = SqlQuery::select('users', ['id', 'name'], 'active = 1');
expect($query->sql)->toBe('SELECT id, name FROM users WHERE active = 1');
expect($query->isSelect())->toBeTrue();
});
it('can create INSERT queries', function () {
$query = SqlQuery::insert('users', ['name' => 'John', 'email' => 'john@test.com']);
expect($query->sql)->toBe('INSERT INTO users (name, email) VALUES (:name, :email)');
expect($query->parameters->get('name'))->toBe('John');
expect($query->parameters->get('email'))->toBe('john@test.com');
expect($query->isInsert())->toBeTrue();
});
it('can create UPDATE queries', function () {
$query = SqlQuery::update('users', ['name' => 'Jane'], 'id = :id');
expect($query->sql)->toBe('UPDATE users SET name = :name WHERE id = :id');
expect($query->parameters->get('name'))->toBe('Jane');
expect($query->isUpdate())->toBeTrue();
});
it('can create DELETE queries', function () {
$query = SqlQuery::delete('users', 'id = :id');
expect($query->sql)->toBe('DELETE FROM users WHERE id = :id');
expect($query->isDelete())->toBeTrue();
});
it('can add parameters immutably', function () {
$query = SqlQuery::create('SELECT * FROM users WHERE id = :id');
$newQuery = $query->withParameter('id', 123);
expect($query->parameters->has('id'))->toBeFalse(); // Original unchanged
expect($newQuery->parameters->get('id'))->toBe(123);
});
it('can add multiple parameters', function () {
$query = SqlQuery::create('SELECT * FROM users');
$newQuery = $query->withParameters(['limit' => 10, 'offset' => 20]);
expect($newQuery->parameters->get('limit'))->toBe(10);
expect($newQuery->parameters->get('offset'))->toBe(20);
});
it('detects query types correctly', function () {
expect(SqlQuery::create('SELECT * FROM users')->isSelect())->toBeTrue();
expect(SqlQuery::create('INSERT INTO users VALUES (1)')->isInsert())->toBeTrue();
expect(SqlQuery::create('UPDATE users SET name = "test"')->isUpdate())->toBeTrue();
expect(SqlQuery::create('DELETE FROM users')->isDelete())->toBeTrue();
expect(SqlQuery::create('CREATE TABLE test (id INT)')->isDDL())->toBeTrue();
expect(SqlQuery::create('ALTER TABLE test ADD column')->isDDL())->toBeTrue();
expect(SqlQuery::create('DROP TABLE test')->isDDL())->toBeTrue();
});
it('detects modifying queries', function () {
expect(SqlQuery::create('SELECT * FROM users')->isModifying())->toBeFalse();
expect(SqlQuery::create('INSERT INTO users VALUES (1)')->isModifying())->toBeTrue();
expect(SqlQuery::create('UPDATE users SET name = "test"')->isModifying())->toBeTrue();
expect(SqlQuery::create('DELETE FROM users')->isModifying())->toBeTrue();
expect(SqlQuery::create('CREATE TABLE test (id INT)')->isModifying())->toBeTrue();
});
it('generates debug string correctly', function () {
$query = SqlQuery::create('SELECT * FROM users WHERE id = :id AND name = :name', [
'id' => 123,
'name' => 'John',
]);
$debug = $query->toDebugString();
expect($debug)->toContain('123');
expect($debug)->toContain("'John'");
expect($debug)->not->toContain(':id');
expect($debug)->not->toContain(':name');
});
it('converts to string', function () {
$query = SqlQuery::create('SELECT * FROM users');
expect($query->toString())->toBe('SELECT * FROM users');
expect($query->__toString())->toBe('SELECT * FROM users');
});
it('throws exception for empty SQL', function () {
expect(fn () => new SqlQuery(''))->toThrow(InvalidArgumentException::class);
expect(fn () => new SqlQuery(' '))->toThrow(InvalidArgumentException::class);
});
it('throws exception for too large SQL', function () {
$largeSql = str_repeat('SELECT * FROM users; ', 100000); // > 1MB
expect(fn () => new SqlQuery($largeSql))->toThrow(InvalidArgumentException::class);
});
it('throws exception for empty insert data', function () {
expect(fn () => SqlQuery::insert('users', []))->toThrow(InvalidArgumentException::class);
});
it('throws exception for empty update data', function () {
expect(fn () => SqlQuery::update('users', [], 'id = 1'))->toThrow(InvalidArgumentException::class);
});
});