[uml] Scripts for rendering images files from _plantuml_ files

diagrams/classes/clase_localize.plantuml

@@ -0,0 +1,11 @@
+@startuml
+
+class Localize {
+    # esContent : String
+    # usContent : String
+
+    + Localize(String esContent, String usContent)
+    + String greet(String lang) : String
+}
+
+@enduml

diagrams/classes/clase_mensaje.plantuml

@@ -0,0 +1,8 @@
+@startuml
+
+class Mensaje {
+    + Mensaje(String esContent, String usContent)
+    + String greet() : String
+}
+
+@enduml

diagrams/classes/herencia.plantuml

@@ -0,0 +1,26 @@
+@startuml
+
+!include ../variables.txt
+!include clase_localize.plantuml
+!include clase_mensaje.plantuml
+
+title $MiVar\n
+
+Localize <|-- Mensaje
+
+note left of Mensaje
+        Plantuml soporta inclusión de archivos y
+        utilización de variables!!
+
+        Esto les permite definir sus clases y
+        las relaciones en archivos separados.
+
+        Por ejemplo "MiClaseNombre" no se encuentra
+        definida en este archivo.
+
+        NOTA:
+        Les recomendamos implementar esta herramienta
+        para mitigar los errores de inconsistencia en los
+        diagramas uml.
+end note
+@enduml

diagrams/variables.txt

@@ -0,0 +1 @@
+!$MiVar = "<valor variable 'MiVar'>"

docs/Desarrollo.md

@@ -9,6 +9,10 @@ Existen distintas maneras de configurar el ambiente de desarrollo:
 - [Nativo](./Nativo.md)
 - [Docker](./Docker.md)
 
+### Diagramas
+
+[Plantuml](https://plantuml.com/) soporta un mecanísmo que les facilitará la generación y posterior mantenimiento de los diagramas de clase, secuencia, estado y paquetes. Para mayor información referir [guía de PlantUML](./docs/PLANTUML.md)
+
 ## Empaquetado
 
 Cuando se genera un **tag** que comienza con `v` (ejemplo `v0.0.1`) automáticamente se produce un [release](https://github.com/fiuba/algo3_proyecto_base_tp2/releases) con la aplicación empaquetada. Para el nombre de la versión se recomienda utilizar [versionado semántico](https://semver.org/lang/es/), por ejemplo:

docs/PlantUML.md

@@ -0,0 +1,73 @@
+# Diagramas UML
+
+
+**Recomendamos la utilización de PlantUML por las siguientes razones**:
+
+- Se pueden versionar los distintos diagramas
+- Existen herramientas que lo interpretan y no requiere la instalación de un software. Ver [aquí](#editor-online)
+- La utilización de `include` y *variables* facilita la actualización de los diagramas
+
+## Herramientas
+
+### Plantuml
+
+Para trabajar localmente con [Plantuml](https://plantuml.com/) necesitará instalar la aplicación java. Las instrucciones las encontrarán [aquí](https://plantuml.com/starting).
+
+### Script de traducción
+
+Utilizando el script `render_diagrams.sh` se pueden generar los archivos `*.png` asociados a cada uno de los diagramas cuyo archivo es `*.plantuml`.
+
+Este script inspecciona la carpeta `diagrams/`.
+
+Forma de ejecución:
+
+```bash
+scripts/render_diagrams.sh 
+```
+
+**Nota 1:** 
+
+El script requiere que la herramienta [plantuml](#plantuml) esté instalada.
+
+**Nota 2:**
+
+No contamos con un script para sistemas operativos Windows. Cualquier colaboración es aceptada. Para más información revisar [guía de desarrollo](../docs/Desarrollo.md).
+
+### Editor online
+
+**Nota:**
+Es útil para pequeños ensayos de notación. 
+
+- [Plantuml Editor](https://plantuml-editor.kkeisuke.com/)
+- [Plant Text](https://www.planttext.com/)
+
+### IDE como editor
+
+Existen múltiples plugins para interpretar estos archivos
+
+
+| Herramienta               | Version | Plugin                                   | Version        |
+|---------------------------|:-------:|------------------------------------------|:--------------:|
+| [VSCode][external_vscode] | v1.58.0 | [Plantuml extension][external_pplantuml] | v2.15.1        |
+| [Idea][external_idea]     | 2020.3  | [Plantuml plugin][external_iplantuml]    | v2.15.2/v5.5.1 |
+| [Emacs][external_emacs]   | ?       | [Plugin][external_emacs_plugin]          | ?              |
+
+## Ventajas
+
+[Plantuml](https://plantuml.com/) nos permite utilizar inclusión de archivos y utilización de variables!
+
+Esto les permitiría definir sus clases (una única vez) y utilizarlas en la definición de sus relaciones. 
+
+Aquí pueden econtrar un ejemplo [ejemplo](../diagrams/)
+
+**Sugerencia:**
+
+Les recomendamos implementar esta herramienta para mitigar los errores de inconsistencia en los diagramas uml.
+
+[external_vscode]: https://code.visualstudio.com/Download
+[external_idea]: https://www.jetbrains.com/idea/
+[external_emacs]: https://www.gnu.org/software/emacs/
+[external_iplantuml]: https://plugins.jetbrains.com/plugin/7017-plantuml-integration
+[external_pplantuml]: https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml
+[external_emacs_plugin]: https://plantuml.com/emacs
+

scripts/render_diagrams.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+diagramsPath="diagrams"
+
+echo 'AVERTENCIA!!!'
+echo
+echo "Todos los archivos '*.png' dentro de \"$diagramsPath\" serán borrados."
+echo "Se regeneraran a partir de los archivos '*.plantuml'."
+echo
+
+read -t 3 -n 1 -p "Desea continuar (y/N)? " answer
+[ -z "$answer" ] && answer="n"
+
+if [ "$answer" == "y" ]
+then
+    find $diagramsPath -name '*.plantuml' -exec plantuml -v {} \;
+fi

src/main/java/edu/fiuba/algo3/modelo/Localize.java

@@ -0,0 +1,20 @@
+package edu.fiuba.algo3.modelo;
+
+public class Localize {
+    protected final String esContent;
+    protected final String usContent;
+
+    public Localize(String esContent, String usContent) {
+        this.esContent = esContent;
+        this.usContent = usContent;
+    }
+
+    public String greet(String lang) {
+        if (lang.equals("us")) {
+            return usContent;
+        }
+
+        return esContent;
+    }
+
+}

src/main/java/edu/fiuba/algo3/modelo/Message.java

@@ -1,13 +1,12 @@
 package edu.fiuba.algo3.modelo;
 
-public class Message {
-    private final String content;
+public class Message extends Localize {
 
-    public Message(String content) {
-        this.content = content;
+    public Message(String esContent, String usContent) {
+        super(esContent, usContent);
     }
 
     public String greet() {
-        return content;
+        return super.greet("es");
     }
 }

src/main/test/edu/fiuba/algo3/modelo/MessageTest.java

@@ -6,8 +6,15 @@
 public class MessageTest {
     @Test
     public void messageGreeting() {
-        Message message = new Message("Hello world!");
+        Message message = new Message("Hola Mundo!", "Hello world!");
 
-        assertEquals("Hello world!", message.greet());
+        assertEquals("Hello world!", message.greet("us"));
+    }
+
+    @Test
+    public void messageGreetingDefaultLanguage() {
+        Message message = new Message("Hola Mundo!", "Hello world!");
+
+        assertEquals("Hola Mundo!", message.greet());
     }
 }