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,37 @@
<?php
use App\Framework\MagicLinks\Commands\ExecuteMagicLinkCommand;
use App\Framework\MagicLinks\MagicLinkToken;
use App\Framework\MagicLinks\ValueObjects\ExecutionContext;
describe('ExecuteMagicLinkCommand', function () {
it('creates command with token and context', function () {
$token = new MagicLinkToken('test-token-12345678');
$context = ExecutionContext::fromArray(['ip' => '127.0.0.1']);
$command = new ExecuteMagicLinkCommand($token, $context);
expect($command->token)->toBe($token);
expect($command->context)->toBe($context);
});
it('creates command with factory method', function () {
$token = new MagicLinkToken('test-token-12345678');
$command = ExecuteMagicLinkCommand::withToken($token);
expect($command->token)->toBe($token);
expect($command->context)->toBeInstanceOf(ExecutionContext::class);
expect($command->context->isEmpty())->toBeTrue();
});
it('context is ExecutionContext value object', function () {
$token = new MagicLinkToken('test-token-12345678');
$context = ExecutionContext::fromArray(['test' => 'value']);
$command = new ExecuteMagicLinkCommand($token, $context);
expect($command->context)->toBeInstanceOf(ExecutionContext::class);
expect($command->context->toArray())->toBe(['test' => 'value']);
});
});

View File

@@ -0,0 +1,58 @@
<?php
use App\Framework\MagicLinks\Commands\GenerateMagicLinkCommand;
use App\Framework\MagicLinks\TokenAction;
use App\Framework\MagicLinks\TokenConfig;
use App\Framework\MagicLinks\ValueObjects\MagicLinkPayload;
describe('GenerateMagicLinkCommand', function () {
it('creates command with required parameters', function () {
$action = new TokenAction('email_verification');
$payload = MagicLinkPayload::fromArray(['email' => 'test@example.com']);
$command = new GenerateMagicLinkCommand(
action: $action,
payload: $payload
);
expect($command->action)->toBe($action);
expect($command->payload)->toBe($payload);
expect($command->config)->toBeNull();
expect($command->baseUrl)->toBeNull();
});
it('creates command with all parameters', function () {
$action = new TokenAction('email_verification');
$payload = MagicLinkPayload::fromArray(['email' => 'test@example.com']);
$config = new TokenConfig(expiryHours: 24);
$command = new GenerateMagicLinkCommand(
action: $action,
payload: $payload,
config: $config,
baseUrl: 'https://example.com',
createdByIp: '127.0.0.1',
userAgent: 'Test Agent'
);
expect($command->action)->toBe($action);
expect($command->payload)->toBe($payload);
expect($command->config)->toBe($config);
expect($command->baseUrl)->toBe('https://example.com');
expect($command->createdByIp)->toBe('127.0.0.1');
expect($command->userAgent)->toBe('Test Agent');
});
it('payload is MagicLinkPayload value object', function () {
$action = new TokenAction('test');
$payload = MagicLinkPayload::fromArray(['test' => 'value']);
$command = new GenerateMagicLinkCommand(
action: $action,
payload: $payload
);
expect($command->payload)->toBeInstanceOf(MagicLinkPayload::class);
expect($command->payload->toArray())->toBe(['test' => 'value']);
});
});