maatify/data-repository

Unified Repository Abstraction Layer over MySQL, MongoDB, and Redis using maatify/data-adapters.

dev-main 2025-11-16 07:42 UTC

Requires

• php: >=8.4
• maatify/data-adapters: ^1.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.89
• phpstan/phpstan: ^1.11
• phpunit/phpunit: ^11.0

MIT

README

Unified Repository Abstraction Layer for the Maatify Ecosystem

🧩 Overview

maatify/data-repository provides a clean, unified repository abstraction layer above maatify/data-adapters.

It standardizes how all MySQL, MongoDB, and Redis operations are performed throughout the Maatify ecosystem by enforcing:

• Repository-first data interaction
• DTO-friendly hydration workflow
• Consistent error handling
• Standard abstraction for all business-domain libraries
• Zero direct PDO/Mongo/Redis driver access

This ensures clean architecture, high testability, and complete adapter isolation.

🚀 Features

✅ Unified repository interfaces

• MySQL, MongoDB, Redis
• Shared core contract (RepositoryInterface)

✅ DTO Hydration Layer (Phase 4)

• Lightweight hydration
• Decoupled mapping logic

✅ Flexible Profiles

Use any database profile from maatify/data-adapters:

mysql.main
mysql.reporting
mongo.logs
redis.cache

✅ Future Enhancements

• Repository Caching Layer (Phase 5)
• Repository Observers (Phase 6)
• Unit Of Work (Phase 8)
• Query Builder Integration (Phase 9)

📥 Installation

composer require maatify/data-repository

Autoloads into:

Maatify\DataRepository\

🏗️ Architecture

src/
  Contracts/
    RepositoryInterface.php
    MySQLRepositoryInterface.php
    MongoRepositoryInterface.php
    RedisRepositoryInterface.php

  Exceptions/
    RepositoryException.php
    NotFoundException.php
    InvalidRepositoryArgumentException.php
    UnsupportedDriverException.php

  Repository/
    (Added in Phase 2+)

✔ Clean separation ✔ PSR-12 compliant ✔ No circular dependencies ✔ No business logic inside repositories

🧠 Usage Examples (available after Phase 2)

MySQL Example

$users = $this->userRepository->find(['active' => 1]);

Redis Example

$this->cacheRepository->set('session:123', ['id' => 123], ttl: 3600);

Mongo Example

$logs = $this->auditRepository->find(['level' => 'warning']);

🔧 Composer Scripts

composer test      # PHPUnit
composer analyse   # PHPStan (level 6)
composer format    # php-cs-fixer

🧪 Testing

PHPUnit is configured with:

• phpunit.xml
• SmokeTest (Phase 1)
• Autoload via composer
• GitHub Actions pipeline

Run tests:

composer test

📝 Changelog

See CHANGELOG.md Semantic Versioning (SemVer).

🗺️ Roadmap

v1.0.0

✔ Phase 1 — Bootstrapping

• Namespace & structure
• Contracts
• Exceptions
• PHPUnit
• CI pipeline
• php-cs-fixer
• Initial docs

⏳ Phase 2 — Base Repository Layer

• Base MySQL/Mongo/Redis repositories
• DatabaseResolver integration
• Profile support

⏳ Phase 3 — Generic Repositories

⏳ Phase 4 — DTO Hydration Layer

⏳ Release v1.0.0

v1.1.0

• Repository Caching Layer

v1.2.0

• Repository Observers

v2.0.0

• Unit Of Work
• Entity Tracking
• Transaction Scopes

🤝 Contributing

See CONTRIBUTING.md

Highlights:

• PSR-12
• Strict typing
• No unused imports
• Mandatory PHPUnit coverage
• No direct database driver access

🔐 Security

See SECURITY.md

Report vulnerabilities privately: 📧 [e-mail]

📜 Code of Conduct

See CODE_OF_CONDUCT.md

🔗 Full documentation & release notes: see /docs/README.full.md

🪪 License

MIT license © Maatify.dev
You’re free to use, modify, and distribute this library with attribution.

👤 Author

Mohamed Abdulalim — Backend Lead & Technical Architect
🔗 https://www.maatify.dev | ✉️ [e-mail]

🤝 Contributors

Special thanks to the Maatify.dev engineering team and open-source contributors.

_{Built with ❤️ by Maatify.dev — Unified Ecosystem for Modern PHP Libraries}