Component Model Creator Skill

:PROPERTIES:
:ID: GUID
:END:
#+title: ORE Studio COMPONENT_TITLE Component
#+author: Marco Craveiro
#+options: <:nil c:nil todo:nil ^:nil d:nil date:nil author:nil toc:nil html-postamble:nil
#+startup: inlineimages

Brief description paragraph for ORE Studio.

* Component Architecture

Diagram:

#+attr_html: :width 100% :alt Description
#+caption: ORE Studio COMPONENT_TITLE Component Diagram
file:COMPONENT.png

This module provides [DESCRIPTION]. Key features include:

- Feature 1: description
- Feature 2: description
- Message-based API: asynchronous request/response handlers (subsystem range
  =0xNNNN-0xNNNN=)
- Temporal database support: version tracking with =valid_from= and =valid_to=
  fields
- Synthetic data generation: test data generation for development

The module is organized into namespaces: domain (core entities), repository
(ORM and persistence), service (business logic), messaging (API handlers), and
generators (test data).

* Domain Types

| Type       | Description                    |
|------------+--------------------------------|
| =type1=    | Description of type1           |
| =type2=    | Description of type2           |

* Database Tables

| Table      | Type     | Description                    |
|------------+----------+--------------------------------|
| =table1=   | Temporal | Description of table1          |
| =table2=   | Junction | Description of table2          |

All temporal tables use bitemporal fields (=valid_from=, =valid_to=) for
historical tracking.

| Top: Documentation | Previous: System Model |

' -*- mode: plantuml; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
'
' Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
'
' This program is free software; you can redistribute it and/or modify it under
' the terms of the GNU General Public License as published by the Free Software
' Foundation; either version 3 of the License, or (at your option) any later
' version.
'
' This program is distributed in the hope that it will be useful, but WITHOUT
'  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
' FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
'
' You should have received a copy of the GNU General Public License along with
' GNU Emacs; see the file COPYING. If not, write to the Free Software
' Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
@startuml
!pragma layout smetana

title ores.COMPONENT - COMPONENT_TITLE Component

set namespaceSeparator ::

namespace ores #F2F2F2 {
    note "Brief description of component." as COMPONENT_note
    SHORTNAME --- COMPONENT_note
    namespace SHORTNAME #F2F2F2 {
        namespace domain #F2F2F2 {
            ' Domain classes here
            class entity_name #F7E5FF {
                +{field} version : int
                +{field} entity_id : std::string
                +{field} name : std::string
            }

            note top of entity_name
            Description of the entity.

            Fields:

            - version: Version number for optimistic locking.
            - entity_id: Unique identifier (UUID).
            - name: Human-readable name.
            end note
        }

        namespace repository #F2F2F2 {
            ' ORM classes use <<orm>> stereotype and #99CB99 color
            class entity_entity <<orm>> #99CB99 {
                +{field} entity_id : sqlgen::PrimaryKey<std::string>
                +{field} version : int
                +{field} name : std::string
                +{field} modified_by : std::string
                +{field} valid_from : sqlgen::Timestamp
                +{field} valid_to : sqlgen::Timestamp
            }

            class entity_mapper <<orm>> #99CB99 {
                +{static} map(const entity_entity& v) : domain::entity
                +{static} map(const domain::entity& v) : entity_entity
            }

            class entity_repository <<orm>> #99CB99 {
                +sql() : std::string
                +write(context ctx, const domain::entity& e) : void
                +read_latest(context ctx) : std::vector<domain::entity>
            }

            entity_mapper ..> ores::SHORTNAME::domain::entity : uses
            entity_repository ..> ores::SHORTNAME::domain::entity : uses
        }

        namespace generators #F2F2F2 {
            ' Generator classes use #FFFACD color
            class "<functions>" as entity_generator #FFFACD {
                +{static} generate_synthetic_entity() : domain::entity
                +{static} generate_synthetic_entities(std::size_t n) : std::vector<domain::entity>
            }

            entity_generator ..> ores::SHORTNAME::domain::entity : generates
        }

        namespace tests #F2F2F2 {
            ' Test classes use <<test suite>> stereotype and #C5E1A5 color
            class repository_entity_repository_tests <<test suite>> #C5E1A5 {
                +write_single_entity() void
                +read_latest_entities() void
            }

            repository_entity_repository_tests ..> ores::SHORTNAME::repository::entity_repository : tests
        }
    }
}

' Local Variables:
' compile-command: "java -Djava.awt.headless=true -DPLANTUML_SECURITY_PROFILE=UNSECURE -DPLANTUML_LIMIT_SIZE=65535 -jar /usr/share/plantuml/plantuml.jar COMPONENT.puml"
' End:
@enduml

cmake --build --preset linux-clang-debug --target generate_SHORTNAME_diagram

add_plantuml_diagram(
    NAME ${project_name}_diagram
    INPUT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/modeling/${project_name}.puml"
    OUTPUT_DIR "${CMAKE_CURRENT_SOURCE_DIR}/modeling"
)

cmake --build --preset linux-clang-debug --target generate_ores_diagram

cmake --build --preset linux-clang-debug --target deploy_site