README

Context

This project is an application designed to explore concepts such as Clean Architecture, Test-Driven Development (TDD), Domain-Driven Design (DDD), and Hexagonal Architecture. These approaches aim to produce maintainable, scalable, and testable code.

Technologies

PHP : Programming language used for business logic.
Composer : Dependency manager for PHP.
PHPUnit : Tool for unit testing.
Docker : Containerization platform to simplify application execution and isolation.

Key Concepts

1. Clean Architecture

Clean Architecture is a set of principles designed to organize code in a way that it is independent of frameworks, databases, and user interfaces. It enables:

Separation of concerns.
Easier testing.
More comprehensible and maintainable code.

2. Test-Driven Development (TDD)

TDD is a development methodology based on writing tests before coding the functionality. The process follows three steps:

Write a test that fails.
Write the minimum code necessary to make the test pass.
Refactor the code while ensuring the tests still pass.

TDD improves code quality and reduces the number of bugs.

3. Domain-Driven Design (DDD)

DDD is a software design approach focusing on the business domain. It encourages collaboration between developers and domain experts to:

Model the domain effectively.
Use a common language.
Structure code around business concepts.

4. Hexagonal Architecture

Hexagonal Architecture, or Ports and Adapters Architecture, separates the core application logic from external interactions (UI, databases, APIs, etc.). It allows:

Easier testing of the application core.
Replacement of external components without impacting business logic.
Simplified application evolution.

Installation and Usage

This project composer

Clone the repository:

git clone git@github.com:thetis20/messenger-domain.git
cd messenger-domain

Install composer dependencies:
```
composer install
```
Run tests
```
composer run-script tests
```

Class Diagram

---
title: Messenger Domain
---
classDiagram
   Discussion "1" *-- "*" DiscussionMember
   Member "1" *-- "*" DiscussionMember
   Discussion "1" *-- "*" Message
   Member "1" <-- "*" Message
   class Discussion {
      -Uuid id
      -string name
      +getId(): string
      +getName(): string
      +getDiscussionMembers(): DiscussionMember[]
      +isMember(string email): bool
      +findDiscussionMemberByEmail(string email): ?DiscussionMember
      +addMember(Member member, bool seen): void
      +markAsUnseen(?array emails = null): void
      +markAsSeen(?array emails = null): void
      +markAs(bool seen, ?array emails = null): void
      +jsonSerialize(): array
   }
   class DiscussionMember {
      -bool seen
      +isSeen(): bool
      +markAsUnseen(): void
      +markAsSeen(): void
      +getMember(): Member
      +getDiscussion(): Discussion
   }
   class Member {
      -string email
      -?string userIdentifier
      -?string username
      +getEmail(): string
      +getUserIdentifier(): ?string
      +getUsername(): ?string
   }
   class Message {
      -Uuid id
      -Uuid discussionId
      -Member author
      -?string Message
      -DateTime createdAt
      -DateTime updatedAt
      -bool deleted
      +getId(): Uuid
      +getAuthor(): Member
      +getMessage(): ?string
      +getCreatedAt(): DateTime
      +getUpdatedAt(): DateTime
      +isDeleted(): bool
      +getDiscusionId(): Uuid
      +jsonSerialize(): array
      +delete(): Message
   }

Use Cases

Creating Discussion Groups

A user can create a group and add other participants to it.

flowchart TD
    A[User] --> B[Enter group name]
    B --> G{Member already exists}
    G --> |yes| C[Add members to the discussion]
    G --> |no| H[Create member]
    H --> C
    C --> D[Create group]
    D --> E[Notify users]

Sending Messages

A user can send a message in a discussion group.

flowchart TD
    A[User] --> B[Enter message]
    B --> C[Choose recipient]
    C --> D[Send the message]
    D --> E[Display send confirmation]

Receiving Messages

A user receives messages sent by other participants.

flowchart TD
    A[Server] --> B[Receive a message]
    B --> C[Notify the recipient]
    C --> D[Display message in the application]

Viewing Message History

A user can view the history of their conversations.

Deleting Messages

A user can delete a message they have sent or received.

flowchart TD
    A[User] --> B[Select a message]
    B --> C[Confirm deletion]
    C -->|Confirmed| D[Delete the message]
    C -->|Not confirmed| E[Cancel deletion]

License

This project is licensed under the MIT License. Please refer to the LICENSE file for more information.

thetis20 / messenger-domain

Maintainers

Details