Cleanup tasks and javadoc

Author: stefan-ka

Diff for: .gitignore

@@ -7,6 +7,7 @@ build
 
 # IntelliJ
 .idea
+out/
 
 # Generated sources
 src-gen

Diff for: build.gradle

@@ -12,9 +12,11 @@ repositories {
 }
 
 dependencies {
-    compile group: 'guru.nidi', name: 'graphviz-java', version: '0.11.0'
-    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.5.2'
-    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.5.2'
+    implementation "guru.nidi:graphviz-java:${graphvizVersion}"
+    implementation "org.apache.commons:commons-lang3:${commonsLangVersion}"
+
+    testImplementation "org.junit.jupiter:junit-jupiter-api:${jUnitVersion}"
+    testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:${jUnitVersion}"
 }
 
 test {

Diff for: gradle.properties

@@ -0,0 +1,8 @@
+# Publication repos
+ossSnapshotRepository=https://oss.sonatype.org/content/repositories/snapshots/
+ossReleaseStagingRepository=https://oss.sonatype.org/service/local/staging/deploy/maven2/
+
+# dependency versions
+jUnitVersion=5.5.2
+commonsLangVersion=3.9
+graphvizVersion=0.11.0

Diff for: src/main/java/org/contextmapper/contextmap/generator/graphviz/ContextMapGenerator.java renamed to src/main/java/org/contextmapper/contextmap/generator/ContextMapGenerator.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.contextmapper.contextmap.generator.graphviz;
+package org.contextmapper.contextmap.generator;
 
 import guru.nidi.graphviz.attribute.Label;
 import guru.nidi.graphviz.attribute.Shape;
@@ -35,7 +35,7 @@
 import static guru.nidi.graphviz.model.Factory.*;
 
 /**
- * Generating Context Map with graphviz. Experimental state!
+ * Generating graphical Context Map with Graphviz.
  *
  * @author Stefan Kapferer
  */
@@ -49,18 +49,18 @@ public void generateContextMapGraphic(ContextMap contextMap, String fileName) th
 
         // create nodes
         contextMap.getBoundedContexts().forEach(bc -> {
-            MutableNode node = mutNode(bc.getId());
+            MutableNode node = mutNode(bc.getName());
             node.add(Label.lines(bc.getName()));
             node.add(Shape.EGG);
             node.add(attr("margin", "0.3"));
             node.add(attr("orientation", orientationDegree()));
-            bcNodesMap.put(bc.getId(), node);
+            bcNodesMap.put(bc.getName(), node);
         });
 
         // link nodes
         contextMap.getRelationships().forEach(rel -> {
-            MutableNode node1 = this.bcNodesMap.get(rel.getFirstParticipant().getId());
-            MutableNode node2 = this.bcNodesMap.get(rel.getSecondParticipant().getId());
+            MutableNode node1 = this.bcNodesMap.get(rel.getFirstParticipant().getName());
+            MutableNode node2 = this.bcNodesMap.get(rel.getSecondParticipant().getName());
 
             if (rel instanceof Partnership) {
                 node1.addLink(to(node2).with(Label.of("Partnership")));
@@ -87,19 +87,6 @@ public void generateContextMapGraphic(ContextMap contextMap, String fileName) th
         Graphviz.fromGraph(graph).width(2000).render(Format.DOT).toFile(new File(fileName + ".dot"));
     }
 
-    /*
-     * Select shape randomly
-     */
-    /*private Shape getShape() {
-        int selection = new Random().nextInt(2);
-        switch (selection) {
-            case 1:
-                return Shape.EGG;
-            default:
-                return Shape.ELLIPSE;
-        }
-    }*/
-
     /*
      * Generate random orientation degree
      */

Diff for: src/main/java/org/contextmapper/contextmap/generator/model/BoundedContext.java

@@ -15,22 +15,47 @@
  */
 package org.contextmapper.contextmap.generator.model;
 
+import org.apache.commons.lang3.builder.EqualsBuilder;
+import org.apache.commons.lang3.builder.HashCodeBuilder;
+
+/**
+ * Represents a Bounded Context for the graphical Context Map to be generated.
+ *
+ * @author Stefan Kapferer
+ */
 public class BoundedContext {
 
-    private String id;
     private String name;
 
     public BoundedContext(String name) {
         this.name = name;
-        this.id = name.replaceAll(" ", "");
     }
 
+    /**
+     * Gets the Bounded Context name.
+     *
+     * @return the name of the Bounded Context
+     */
     public String getName() {
         return name;
     }
 
-    public String getId() {
-        return id;
+    @Override
+    public boolean equals(Object object) {
+        if (!(object instanceof BoundedContext))
+            return false;
+
+        BoundedContext bc = (BoundedContext) object;
+
+        return new EqualsBuilder()
+                .append(name, bc.name)
+                .isEquals();
     }
 
+    @Override
+    public int hashCode() {
+        return new HashCodeBuilder()
+                .append(name)
+                .hashCode();
+    }
 }

Diff for: src/main/java/org/contextmapper/contextmap/generator/model/ContextMap.java

@@ -15,38 +15,70 @@
  */
 package org.contextmapper.contextmap.generator.model;
 
+import org.contextmapper.contextmap.generator.model.exception.BoundedContextAlreadyPartOfContextMapException;
+import org.contextmapper.contextmap.generator.model.exception.BoundedContextNotPartOfContextMapException;
+
 import java.util.*;
 
+/**
+ * Represents a Context Map for which a graphical representation shall be created.
+ *
+ * @author Stefan Kapferer
+ */
 public class ContextMap {
 
-    private List<BoundedContext> boundedContexts;
-    private List<Relationship> relationships;
+    private Set<BoundedContext> boundedContexts;
+    private Set<Relationship> relationships;
 
     public ContextMap() {
-        this.boundedContexts = new ArrayList<>();
-        this.relationships = new ArrayList<>();
+        this.boundedContexts = new HashSet<>();
+        this.relationships = new HashSet<>();
     }
 
-    public void addBoundedContext(BoundedContext boundedContext) {
+    /**
+     * Adds a new Bounded Context to the Context Map.
+     *
+     * @param boundedContext the Bounded Context to be added to the Context Map
+     */
+    public ContextMap addBoundedContext(BoundedContext boundedContext) {
+        if (this.boundedContexts.contains(boundedContext))
+            throw new BoundedContextAlreadyPartOfContextMapException(boundedContext.getName());
         this.boundedContexts.add(boundedContext);
+        return this;
     }
 
-    public void addRelationship(Relationship relationship) {
+    /**
+     * Adds a new relationship to the Context Map.
+     *
+     * @param relationship the relationship to be added to the Context Map
+     */
+    public ContextMap addRelationship(Relationship relationship) {
         if (!this.boundedContexts.contains(relationship.getFirstParticipant()))
             throw new BoundedContextNotPartOfContextMapException(relationship.getFirstParticipant());
         if (!this.boundedContexts.contains(relationship.getSecondParticipant()))
             throw new BoundedContextNotPartOfContextMapException(relationship.getSecondParticipant());
         this.relationships.add(relationship);
+        return this;
     }
 
-    public List<BoundedContext> getBoundedContexts() {
-        List<BoundedContext> set = new ArrayList<>();
+    /**
+     * Gets the set of Bounded Contexts on the Context Map.
+     *
+     * @return the set of Bounded Contexts on the Context Map
+     */
+    public Set<BoundedContext> getBoundedContexts() {
+        Set<BoundedContext> set = new HashSet<>();
         set.addAll(this.boundedContexts);
         return set;
     }
 
-    public List<Relationship> getRelationships() {
-        List<Relationship> set = new ArrayList<>();
+    /**
+     * Gets the set of relationships on the Context Map.
+     *
+     * @return the set of relationships on the Context Map
+     */
+    public Set<Relationship> getRelationships() {
+        Set<Relationship> set = new HashSet<>();
         set.addAll(this.relationships);
         return set;
     }

Diff for: src/main/java/org/contextmapper/contextmap/generator/model/DownstreamPatterns.java

@@ -1,5 +1,10 @@
 package org.contextmapper.contextmap.generator.model;
 
+/**
+ * The DDD relationship patterns allowed on the downstream side.
+ *
+ * @author Stefan Kapferer
+ */
 public enum DownstreamPatterns {
 
     ANTICORRUPTION_LAYER("ACL"), CONFORMIST("CF");

Diff for: src/main/java/org/contextmapper/contextmap/generator/model/Partnership.java

@@ -15,6 +15,11 @@
  */
 package org.contextmapper.contextmap.generator.model;
 
+/**
+ * Represents a DDD Partnership relationship on a Context Map.
+ *
+ * @author Stefan Kapferer
+ */
 public class Partnership implements Relationship {
 
     private BoundedContext bc1;
@@ -25,10 +30,20 @@ public Partnership(BoundedContext bc1, BoundedContext bc2) {
         this.bc2 = bc2;
     }
 
+    /**
+     * Gets the first participant of the Partnership.
+     *
+     * @return the first participant of the Partnership
+     */
     public BoundedContext getFirstParticipant() {
         return bc1;
     }
 
+    /**
+     * Gets the second participant of the Partnership.
+     *
+     * @return the second participant of the Partnership
+     */
     public BoundedContext getSecondParticipant() {
         return bc2;
     }

Diff for: src/main/java/org/contextmapper/contextmap/generator/model/Relationship.java

@@ -1,8 +1,14 @@
 package org.contextmapper.contextmap.generator.model;
 
+/**
+ * Represents a relationship on a Context Map.
+ *
+ * @author Stefan Kapferer
+ */
 public interface Relationship {
 
     BoundedContext getFirstParticipant();
+
     BoundedContext getSecondParticipant();
 
 }

Diff for: src/main/java/org/contextmapper/contextmap/generator/model/SharedKernel.java

@@ -15,6 +15,11 @@
  */
 package org.contextmapper.contextmap.generator.model;
 
+/**
+ * Represents a DDD Shared Kernel relationship on a Context Map.
+ *
+ * @author Stefan Kapferer
+ */
 public class SharedKernel implements Relationship {
 
     private BoundedContext bc1;
@@ -25,10 +30,20 @@ public SharedKernel(BoundedContext bc1, BoundedContext bc2) {
         this.bc2 = bc2;
     }
 
+    /**
+     * Gets the first participant of the Shared Kernel.
+     *
+     * @return the first participant of the Shared Kernel
+     */
     public BoundedContext getFirstParticipant() {
         return bc1;
     }
 
+    /**
+     * Gets the second participant of the Shared Kernel.
+     *
+     * @return the second participant of the Shared Kernel
+     */
     public BoundedContext getSecondParticipant() {
         return bc2;
     }