diff --git a/caracteristique.md b/caracteristique.md index f1dc4ca15..c9f615083 100644 --- a/caracteristique.md +++ b/caracteristique.md @@ -55,6 +55,15 @@ Dans le cadre du développement d'une application : - l'application utilise les variables avec leurs valeurs +|------------------------------------------| +| Acteur | +|------------------------------------------| +| défini les variables | +| adapte les valeurs | +| utilise les variables avec leurs valeurs | +|------------------------------------------| + + ## Cycle de vie des variables Le but de Rougail est de gérer les variables et plus largement la configuration. @@ -71,8 +80,11 @@ Dans le cycle de vie d'une variable, on inclut les étapes générique d'une var Mais d'autres notions sont inclusent dans le cycle de vie : -- extension de la déclaration en ajoutant la "description" de la variable -- présentation, l'acteur qui adapte les valeurs doit avoir toutes les informations nécessaires pour renseigner les valeurs, c'est ainsi qu'il est possible de généré automatiquement la documentation, le journal des modifications, ... +- extension de la déclaration + + - la "description" de la variable + - présentation, l'acteur qui adapte les valeurs doit avoir toutes les informations nécessaires pour renseigner les valeurs, c'est ainsi qu'il est possible de généré automatiquement la documentation, le journal des modifications, ... + - autorisations, des propriétés décrivent les contraintes d'accès - spécialisation, qui décrit l'usage possible d'une variable @@ -80,18 +92,27 @@ Rôle des différents composants Rougail : Le format permet de décrire : -- la déclaration (nom, type et description) +- la déclaration (nom, type, description, la présentation) - les autorisations - la spécialisation Rougail et ces composants : -- la définition (via Tiramisu) +- la déclaration (via Tiramisu) - la présentation - l'affectation (via Tiramisu) - la lecture - la fin de vie +|------------------------------------------|----------------------------| +| Acteur | Cycle de vies | +|------------------------------------------|----------------------------| +| défini les variables | déclaration + présentation | +| adapte les valeurs | affectration | +| utilise les variables avec leurs valeurs | lecture | +| | destruction | +|------------------------------------------|----------------------------| + ## Architecture Structurals-UserDatas-Outputs @@ -169,6 +190,15 @@ Variables: ┗━━ 📓 my_variable: a value ◀ loaded from the YAML file "userdata.yml" ``` +|-------------|------------------------------------------|----------------------------|----------|----------| +| Étape | Acteur | Cycle de vies | Variable | Valeur | +|-------------|------------------------------------------|----------------------------|----------|----------| +| Structurals | défini les variables | déclaration + présentation | mutable | | +| UserDatas | adapte les valeurs | affectration | immuable | mutable | +| Outputs | utilise les variables avec leurs valeurs | lecture | immuable | immuable | +| | | destruction | | | +|-------------|------------------------------------------|----------------------------|----------|----------| + ### Valeur par défaut @@ -197,6 +227,15 @@ Variables: ┗━━ 📓 my_variable: a default value ``` +|-------------|------------------------------------------|----------------------------|----------|----------| +| Étape | Acteur | Cycle de vies | Variable | Valeur | +|-------------|------------------------------------------|----------------------------|----------|----------| +| Structurals | défini les variables | déclaration + présentation | mutable | défaut | +| UserDatas | adapte les valeurs | affectration | immuable | mutable | +| Outputs | utilise les variables avec leurs valeurs | lecture | immuable | immuable | +| | | destruction | | | +|-------------|------------------------------------------|----------------------------|----------|----------| + ## Le format : un langage @@ -534,6 +573,15 @@ rougail -m structure_leadership.yml -u yaml -yf userdata_leadership.yml -o json } ``` +|-------------|------------------------------------------|----------------------------|----------|----------|------------| +| Étape | Acteur | Cycle de vies | Variable | Valeur | Propriétés | +|-------------|------------------------------------------|----------------------------|----------|----------|------------| +| Structurals | défini les variables | déclaration + présentation | mutable | défaut | | +| UserDatas | adapte les valeurs | affectration | immuable | mutable | | +| Outputs | utilise les variables avec leurs valeurs | lecture | immuable | immuable | mandatory | +| | | destruction | | | | +|-------------|------------------------------------------|----------------------------|----------|----------|------------| + ## Intégrité des données @@ -879,15 +927,11 @@ Variables: ┗━━ 📓 proxy_address: https://proxy.foo.net:4128/ ◀ loaded from the YAML file "userdata_properties.yml" ``` - -layers - -prééminance -Spécialisation des variables -Modèle de configuration -Réutilisable/partageable -dynamique -reutilisable -jit -traduit -linter +|-------------|------------------------------------------|----------------------------|----------|----------|--------------------|----------------------| +| Étape | Acteur | Cycle de vies | Variable | Valeur | Lecture | Écriture | Propriétés | +|-------------|------------------------------------------|----------------------------|----------|----------|--------------------|----------------------| +| Structurals | défini les variables | déclaration + présentation | mutable | défaut | | | +| UserDatas | adapte les valeurs | affectration | immuable | mutable | lecture + écriture | hidden + disabled | +| Outputs | utilise les variables avec leurs valeurs | lecture | immuable | immuable | lecture | disabled + mandatory | +| | | destruction | | | | | +|-------------|------------------------------------------|----------------------------|----------|----------|--------------------|----------------------|