Primera versión de ARAT.

Obtiene el valor de las anotaciones por reflexión
Genera el reporte con itext5

Author: sahydo

nbproject/project.properties

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>com.unicauca</groupId>
+    <artifactId>arat</artifactId>
+    <version>1</version>
+    <packaging>jar</packaging>
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <maven.compiler.source>1.8</maven.compiler.source>
+        <maven.compiler.target>1.8</maven.compiler.target>
+    </properties>
+    <dependencies>
+        <dependency>
+            <groupId>com.itextpdf</groupId>
+            <artifactId>itextpdf</artifactId>
+            <version>5.5.13</version>
+        </dependency>
+        <!-- https://mvnrepository.com/artifact/net.sf.jasperreports/jasperreports -->
+        <dependency>
+            <groupId>net.sf.jasperreports</groupId>
+            <artifactId>jasperreports</artifactId>
+            <version>6.6.0</version>
+        </dependency>
+        <!-- https://mvnrepository.com/artifact/org.reflections/reflections -->
+        <dependency>
+            <groupId>org.reflections</groupId>
+            <artifactId>reflections</artifactId>
+            <version>0.9.9-RC1</version>
+        </dependency>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>4.12</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.hamcrest</groupId>
+            <artifactId>hamcrest-core</artifactId>
+            <version>1.3</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+    <name>Architectural Rationale Annotations Tool</name>
+    <description>Tool to document Architectutal Rationale in the source code with source code annotations.</description>
+</project>

pom.xml

@@ -0,0 +1,51 @@
+/*
+ * To change this license header, choose License Headers in Project Properties.
+ * To change this template file, choose Tools | Templates
+ * and open the template in the editor.
+ */
+package com.unicauca.arat.business.model;
+
+/**
+ *
+ * @author sahydo
+ */
+public class Information {
+    private String path;
+    private String name;
+    private String type;
+
+    public Information(String path, String name, String type) {
+        this.path = path;
+        this.name = name;
+        this.type = type;
+    }
+
+    public Information() {
+    }
+
+    public String getPath() {
+        return path;
+    }
+
+    public void setPath(String path) {
+        this.path = path;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public String getType() {
+        return type;
+    }
+
+    public void setType(String type) {
+        this.type = type;
+    }
+    
+    
+}

reports/ArchitecturalRationaleReport.pdf

@@ -0,0 +1,38 @@
+/*
+ * To change this license header, choose License Headers in Project Properties.
+ * To change this template file, choose Tools | Templates
+ * and open the template in the editor.
+ */
+package com.unicauca.arat.business.model;
+
+import java.lang.annotation.Documented;
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.ElementType.PACKAGE;
+import static java.lang.annotation.ElementType.TYPE;
+import java.lang.annotation.Retention;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+import java.lang.annotation.Target;
+
+/**
+ *
+ * @author sahydo
+ */
+//Para que aparezcan los componentes marcados con esta anotación en el documento generado por javadoc
+@Documented
+//Retención del archivo de clases en tiempo de ejecución para acceder por Reflección
+@Retention(RUNTIME)
+//Objetivo de anotación: métodos, clases y clases pagacke-info que representan los paquetes
+@Target({METHOD,PACKAGE,TYPE})
+public @interface Rationale {
+    enum AtributoDeCalidad {ADECUACION_FUNCIONAL, EFICIENCIA_DESEMPENIO, COMPATIBILIDAD, USABILIDAD,
+                    FIABILIDAD, SEGURIDAD, MANTENIBILIDAD, PORTABILIDAD}
+    String id() default "";
+    boolean hiden() default false;
+    AtributoDeCalidad[] atributos_de_calidad(); //1
+    String[] causas();//2
+    String[] tacticas() default {};//3
+    String[] patrones() default {};//4
+    String[] alternativas() default {}; //5
+    String[] registro_de_decisiones();//6
+    String[] razones();//7
+}

resources/image1.jpg

@@ -0,0 +1,42 @@
+package com.unicauca.arat.business.tools.reporter;
+
+//import java.lang.annotation.Annotation;
+import com.unicauca.arat.business.model.Rationale;
+import java.lang.reflect.Method;
+//import java.util.ArrayList;
+import java.util.Set;
+
+import org.reflections.Reflections;
+import org.reflections.scanners.MethodAnnotationsScanner;
+import org.reflections.scanners.TypeAnnotationsScanner;
+import org.reflections.util.ClasspathHelper;
+import org.reflections.util.ConfigurationBuilder;
+import org.reflections.util.FilterBuilder;
+//import org.unicauca.annotations.model.Component;
+
+
+public class AnnotationsReflection {
+    private Reflections reflections;
+    
+    public AnnotationsReflection(String modelPackage){
+        //Se debe especificar el tipo de scanners que se quieren ejecutar (Type y Method)
+        //Se debe especificar la url del paquete que se quiere inspeccionar
+        //se debe agregar un filtro para realizar las busquedas en el paquete
+        reflections = new Reflections(
+                new ConfigurationBuilder()
+                        .setUrls(ClasspathHelper.forPackage(modelPackage))
+                        .setScanners(
+                                new TypeAnnotationsScanner(),
+                                new MethodAnnotationsScanner()
+                        )
+                        .filterInputsBy(new FilterBuilder().includePackage(modelPackage))
+        );
+    }
+    public Set<Method> getMethodsAnnotatedWithRationale(){
+        return reflections.getMethodsAnnotatedWith(Rationale.class);
+    }
+    public Set<Class<?>> getClasesAnnotatedWhitRationale(){
+        return reflections.getTypesAnnotatedWith(Rationale.class);
+    }
+    
+}

resources/image2.jpg

@@ -0,0 +1,13 @@
+package com.unicauca.arat.business.tools.reporter;
+
+import com.itextpdf.text.Document;
+import com.unicauca.arat.business.model.Information;
+import com.unicauca.arat.business.model.Rationale;
+import java.util.HashMap;
+
+public interface ReportStrategy {
+    //
+    public abstract void createTemplate(HashMap<Information,Rationale> rationaleInformation, Document document);
+    public abstract void createRationaleInfo(Document document, Rationale rationale);
+    public abstract boolean generateReport(HashMap<Information,Rationale> rationaleInformation,String dest);
+}

resources/unicauca.png

@@ -0,0 +1,66 @@
+package com.unicauca.arat.business.tools.reporter;
+
+import com.unicauca.arat.business.model.Information;
+import com.unicauca.arat.business.model.Rationale;
+import java.io.File;
+import java.lang.reflect.Method;
+import java.util.HashMap;
+import java.util.Set;
+
+public class Reporter {
+    private ReportStrategy reportStrategy;
+    private AnnotationsReflection reflection;
+    
+    public Reporter(ReportStrategy reportStrategy, String packageName) {
+        this.reportStrategy = reportStrategy;
+        this.reflection = new AnnotationsReflection(packageName);
+    }
+        
+    public HashMap<Information,Rationale> getRationaleInformation(){
+        Set<Class<?>> annotatedClasses = reflection.getClasesAnnotatedWhitRationale();
+        Set<Method> annotatedMethods = reflection.getMethodsAnnotatedWithRationale();
+        HashMap<Information,Rationale> data = new HashMap<>();
+        annotatedMethods.forEach((annotatedMethod) -> {
+            String aux[] = annotatedMethod.toString().split(" "); 
+            String path = aux[aux.length-1];
+            String name = annotatedMethod.getName();
+            String type = annotatedMethod.getClass().getSimpleName();
+            Information info = new Information(path, name, type);
+            for (Rationale rationale : annotatedMethod.getAnnotationsByType(Rationale.class)) {
+                data.put(info, rationale);
+            }
+        });
+        annotatedClasses.forEach((annotatedClass) -> {
+            String path = annotatedClass.getCanonicalName();
+            String name = annotatedClass.getSimpleName();
+            String type = annotatedClass.getClass().getSimpleName();
+            Information info;
+            if (name.equals("package-info")) {
+                info = new Information(path, name, "Package");
+            }else{
+                info = new Information(path, name, type);           
+            }
+            for (Rationale rationale : annotatedClass.getAnnotationsByType(Rationale.class)) {
+                data.put(info, rationale);
+            }
+        });
+        return data;
+    }
+    
+    public boolean createRationaleReport(String nameFile) {
+        return reportStrategy.generateReport(getRationaleInformation(),setNameFile(nameFile));
+    }
+    
+    public void setStrategy(ReportStrategy strategy) {
+        this.reportStrategy = strategy;
+    }
+    
+    
+    private String setNameFile(String nameFile) {
+        nameFile = "reports/"+nameFile+".pdf";
+        File file = new File(nameFile);
+        file.getParentFile().mkdirs();
+        return nameFile;
+    }
+    
+}