Merge branch 'release/0.19.0'

Author: moaxcp

README.md

@@ -304,6 +304,18 @@ If there are any issues contact me moaxcp@gmail.com.
 
 # Releases
 
+## 0.19.0
+
+* [#91](https://github.com/moaxcp/graph-dsl/issues/91) Plugins should be called Type
+ 
+This change adds names for types of graphs and plugins. Instead of the developers needing to import and use classes
+they can simply use a name.
+
+```
+type 'directed-graph'
+plugin 'edge-map'
+```
+
 ## 0.18.0
 
 * [#93](https://github.com/moaxcp/graph-dsl/issues/89) NameSpec and ConfigSpec

src/main/groovy/graph/Graph.groovy

@@ -3,6 +3,7 @@ package graph
 import graph.plugin.Plugin
 import graph.type.EdgeSpec
 import graph.type.EdgeSpecFactory
+import graph.type.Type
 import graph.type.VertexSpec
 import graph.type.VertexSpecFactory
 import graph.type.DefaultVertexFactory
@@ -34,6 +35,7 @@ class Graph {
     private Set<? extends Edge> edges = [] as LinkedHashSet<? extends Edge>
     private final Set<Class> edgeTraitsSet = [] as LinkedHashSet<Class>
     private final Set<? extends Plugin> plugins = [] as LinkedHashSet<? extends Plugin>
+    private final Set<? extends Type> types = [] as LinkedHashSet<? extends Type>
     @PackageScope
     EdgeFactory edgeFactory = new UnDirectedEdgeFactory()
     @PackageScope
@@ -170,6 +172,10 @@ class Graph {
         Collections.unmodifiableSet(plugins)
     }
 
+    Set<? extends Type> getTypes() {
+        Collections.unmodifiableSet(types)
+    }
+
     /**
      * Creates and applies a {@link Plugin} to this graph.
      * @param pluginClass - the {@link Plugin} to create and apply to this graph.
@@ -186,6 +192,30 @@ class Graph {
         plugin.apply(this)
     }
 
+    void apply(String pluginName) {
+        Properties properties = new Properties()
+        properties.load(getClass().getResourceAsStream("/META-INF/graph-plugins/${pluginName}.properties"))
+        apply(Class.forName((String) properties.'implementation-class'))
+    }
+
+    void type(Class typeClass) {
+        if (types.contains(typeClass)) {
+            throw new IllegalArgumentException("$typeClass.name is already applied.")
+        }
+        if (!typeClass.interfaces.contains(Type)) {
+            throw new IllegalArgumentException("$typeClass.name does not implement Plugin")
+        }
+        types << typeClass
+        Type type = typeClass.newInstance()
+        type.apply(this)
+    }
+
+    void type(String typeName) {
+        Properties properties = new Properties()
+        properties.load(getClass().getResourceAsStream("/META-INF/graph-types/${typeName}.properties"))
+        type(Class.forName((String) properties.'implementation-class'))
+    }
+
     /**
      * Applies trait to all vertices and all future vertices.
      * @param traits to add to vertices and all future vertices

src/main/groovy/graph/type/Type.groovy

@@ -0,0 +1,7 @@
+package graph.type
+
+import graph.Graph
+
+interface Type {
+    void apply(Graph graph)
+}

…type/directed/DirectedGraphPlugin.groovy …h/type/directed/DirectedGraphType.groovysrc/main/groovy/graph/type/directed/DirectedGraphPlugin.groovy renamed to src/main/groovy/graph/type/directed/DirectedGraphType.groovy src/main/groovy/graph/type/directed/DirectedGraphPlugin.groovy renamed to src/main/groovy/graph/type/directed/DirectedGraphType.groovy

@@ -3,6 +3,7 @@ package graph.type.directed
 import graph.Edge
 import graph.Graph
 import graph.plugin.Plugin
+import graph.type.Type
 
 /**
  * This plugin changes the behavior of a {@link Graph} to that of a directed graph.
@@ -47,7 +48,7 @@ import graph.plugin.Plugin
  *     <dd>traverses the graph in reverse-post-order</dd>
  * </dl>
  */
-class DirectedGraphPlugin implements Plugin {
+class DirectedGraphType implements Type {
 
     /**
      * Applies the plugin to a {@link graph.Graph}.

src/main/resources/META-INF/graph-plugins/edge-map.properties

@@ -0,0 +1 @@
+implementation-class=graph.plugin.EdgeMapPlugin

src/main/resources/META-INF/graph-plugins/edge-weight.properties

@@ -0,0 +1 @@
+implementation-class=graph.plugin.EdgeWeightPlugin

src/main/resources/META-INF/graph-plugins/vertex-map.properties

@@ -0,0 +1 @@
+implementation-class=graph.plugin.VertexMapPlugin

src/main/resources/META-INF/graph-types/directed-graph.properties

@@ -0,0 +1 @@
+implementation-class=graph.type.directed.DirectedGraphType

src/test/groovy/dsl/ConnectsToConnectsFromSpec.groovy

@@ -1,7 +1,7 @@
 package dsl
 
 import graph.Graph
-import graph.type.directed.DirectedGraphPlugin
+import graph.type.directed.DirectedGraphType
 import spock.lang.Specification
 
 import static graph.Graph.graph
@@ -11,7 +11,7 @@ class ConnectsToConnectsFromSpec extends Specification {
     def 'use connectsFrom with a VertexNameSpec'() {
         given:
         Graph graph = graph {
-            apply DirectedGraphPlugin
+            type DirectedGraphType
             vertex A {
                 connectsFrom B
             }
@@ -27,7 +27,7 @@ class ConnectsToConnectsFromSpec extends Specification {
     def 'use connectsFrom with two VertexNameSpec'() {
         given:
         Graph graph = graph {
-            apply DirectedGraphPlugin
+            type DirectedGraphType
             vertex A {
                 connectsFrom B, C
             }
@@ -79,7 +79,7 @@ class ConnectsToConnectsFromSpec extends Specification {
     def 'use connectsFrom with a VertexSpec'() {
         given:
         Graph graph = graph {
-            apply DirectedGraphPlugin
+            type DirectedGraphType
             vertex A {
                 connectsFrom B {}
             }
@@ -95,7 +95,7 @@ class ConnectsToConnectsFromSpec extends Specification {
     def 'use nested connectsFrom with a VertexSpec'() {
         given:
         Graph graph = graph {
-            apply DirectedGraphPlugin
+            type DirectedGraphType
             vertex A {
                 connectsFrom B {
                     connectsFrom C

src/test/groovy/dsl/PluginMethods.groovy

@@ -0,0 +1,30 @@
+package dsl
+
+import graph.Graph
+import graph.plugin.EdgeMapPlugin
+import spock.lang.Specification
+
+import static graph.Graph.graph
+
+class PluginMethods extends Specification {
+
+    def 'can apply plugin with Class'() {
+        given:
+        Graph graph = graph {
+            apply EdgeMapPlugin
+        }
+
+        expect:
+        graph.plugins.contains(EdgeMapPlugin)
+    }
+
+    def 'can apply plugin with String'() {
+        given:
+        Graph graph = graph {
+            apply 'edge-map'
+        }
+
+        expect:
+        graph.plugins.contains(EdgeMapPlugin)
+    }
+}