Merge branch 'master' into 4.0.x

.github/workflows/carnival_ci.yml

@@ -7,7 +7,7 @@ on:
 jobs:
   test_runner:
     name: Unit Tests
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v2

CONTRIBUTING.md

@@ -17,8 +17,4 @@ Feature requests can be made in the issue tracker using the [feature report form
 
 
 # Solving Issues
-To submit bug fixes, open a new GitHub pull request with the bug fix. The PR description should clearly describe the problem and solution and should include the relevant issue numbers if applicable. Before submitting, all the tests should pass.
-
-
-# Creating carnival extensions, demonstrations, or other external projects
-** coming soon **
+To submit bug fixes, open a new GitHub pull request with the bug fix. The PR description should clearly describe the problem and solution and should include the relevant issue numbers if applicable. Before submitting, the test suite should be run locally and all the tests should pass. Instructions for how to set up a local carnival development environment and run the tests can be found in the [developers documentation](https://carnival-data.github.io/carnival/developer-setup.html).

README.md

@@ -9,14 +9,10 @@
 
 ## External Resources
 
--   [Usage Website](https://carnival-data.github.io/carnival/)
--   [GroovyDoc API Documentation](https://carnival-data.github.io/carnival/groovydoc/index.html)
--   [Demonstration Project](https://github.com/carnival-data/carnival-micronaut)
+-   [Documentation](https://carnival-data.github.io/carnival/)
+-   [API Documentation](https://carnival-data.github.io/carnival/groovydoc/index.html)
+-   [Example Demonstration Project](https://github.com/carnival-data/carnival-micronaut)
 
-## Contents
-- [Overview](#overview)
-- [Packages](#packages)
-- [Contribution Guide](README.md#contribution-guide)
 
 ## <a name="overview"></a> Overview
 
@@ -29,20 +25,13 @@ Carnival has three principal components: a graph modeling architecture, a cachin
 
 Name | Description
 --- | ---
-[carnival-core](app/carnival-core/README.md) | Basic Carnival framework. Implements the basic Carnival framework classes (vines, reapers, reasonsers, etc). Defines the basic carnival graph schema (processes, databases). [Core model](https://github.com/carnival-data/carnival/blob/master/app/carnival-core/src/main/groovy/carnival/core/graph/Core.groovy)
-[carnival-vine](app/carnival-vine/README.md) | Mechanisms to faciliate the aggregation of data with data caching.  
+[carnival-core](app/carnival-core/README.md) | Basic Carnival framework. Implements the basic Carnival framework classes (vines, carnival modeling framework, carnival graph algorithm framework, etc). Defines the [core carnival graph model](https://github.com/carnival-data/carnival/blob/master/app/carnival-core/src/main/groovy/carnival/core/graph/Core.groovy). This model defines key carnival concepts such as processes, databases, and namespaces.
+[carnival-vine](app/carnival-vine/README.md) | Framework for data adaptors called vines which faciliate loading and aggregation of source data. Implements data caching facilities.
 [carnival-graph](app/carnival-graph/README.md) | Framework for defining carnival graph schemas (vertex and edge definitions). Contains the basic vertex, edge, and property classes.
 [carnival-util](app/carnival-util/README.md) | Standalone package that contains utility and helper classes such as data tables, reports, and SQL utilties, which are primarily used for dealing with relational data.
 [carnival-gradle](app/carnival-gradle/README.md) | Gradle plugin for building Carnival applications and libraries.
 
 ## <a name="contribution-guide"></a> Contribution Guide
-Carnival is an open source project and welcomes contributions! Here are some ways to help:
-
-* Writing and improving the documentation
-* Reporting or fixing bugs
-* Contributing features or enhancements
-* Creating carnival extensions for more domains
-* Creating demonstration projects or tutorials
-
+Carnival is an open source project and welcomes contributions! Please see the [Contribution Guide](CONTRIBUTING.md) for ways to contribute.
 
 

app/carnival-core/src/main/groovy/carnival/core/graph/DefaultGraphSchema.groovy

@@ -105,10 +105,12 @@ class DefaultGraphSchema implements GraphSchema {
 	/** edge constraints */
 	private Set<EdgeConstraint> edgeConstraints = new HashSet<EdgeConstraint>()
 
-	/* get edge constraints */
+	/** 
+	 * Get edge constraints 
+	 * @return Set of EdgeConstraint
+	 */
 	public Set<EdgeConstraint> getEdgeConstraints() {
 		return edgeConstraints
 	}
 
-
 }

app/carnival-gradle/src/main/groovy/carnival/gradle/CarnivalApplicationPlugin.groovy

@@ -14,6 +14,10 @@ import org.gradle.api.Project
  */
 class CarnivalApplicationPlugin implements Plugin<Project> {
 
+    /**
+     * Implementation of Plugin.apply(Project).
+     * @see <a href="https://docs.gradle.org/current/javadoc/org/gradle/api/Plugin.html">Plugin</a>
+     */
     void apply(Project project) {
         def pn = project.rootProject.name
         println "[CarnivalApplication] root project name: $pn"

app/carnival-graph/src/main/groovy/carnival/graph/VertexBuilder.groovy

@@ -61,7 +61,10 @@ class VertexBuilder extends PropertyValuesHolder<VertexBuilder> {
     // METHODS
     ///////////////////////////////////////////////////////////////////////////
 
-    /** */
+    /** 
+     * Render this object as a String.
+     * @return String representation of this object.
+     */
     public String toString() {
         def str = "${vertexDef}"
         if (propertyValues.size() > 0) str += " ${propertyValues}"

app/carnival-graph/src/main/groovy/carnival/graph/ext/TinkerpopAnonTraversalExtension.groovy

@@ -31,42 +31,42 @@ import carnival.graph.Base
  */
 class TinkerpopAnonTraversalExtension {
 
-    /** @see TinkerpopTraversalExtension */
+    /** @see TinkerpopTraversalExtension#out(DefaultTraversal, EdgeDefinition) */
     static GraphTraversal out(__ traversal, EdgeDefinition edef) {
         __.outE(edef.label).has(Base.PX.NAME_SPACE.label, edef.nameSpace).inV()
     }
 
-    /** @see TinkerpopTraversalExtension */
+    /** @see TinkerpopTraversalExtension#both(DefaultTraversal, EdgeDefinition) */
     static GraphTraversal both(__ traversal, EdgeDefinition edef) {
         __.bothE(edef.label).has(Base.PX.NAME_SPACE.label, edef.nameSpace).otherV()
     }
 
-    /** @see TinkerpopTraversalExtension */
+    /** @see TinkerpopTraversalExtension#in(DefaultTraversal, EdgeDefinition) */
     static GraphTraversal "in"(__ traversal, EdgeDefinition edef) {
         __.inE(edef.label).has(Base.PX.NAME_SPACE.label, edef.nameSpace).outV()
     }
 
-    /** @see TinkerpopTraversalExtension */
+    /** @see TinkerpopTraversalExtension#isa(DefaultTraversal, VertexDefinition) */
     static GraphTraversal isa(__ traversal, VertexDefinition vdef) {
         __.hasLabel(vdef.label).has(Base.PX.NAME_SPACE.label, vdef.nameSpace)
     }
 
-    /** @see TinkerpopTraversalExtension */
+    /** @see TinkerpopTraversalExtension#isa(DefaultTraversal, EdgeDefinition) */
     static GraphTraversal isa(__ traversal, EdgeDefinition edef) {
         __.hasLabel(edef.label).has(Base.PX.NAME_SPACE.label, edef.nameSpace)
     }
 
-    /** @see TinkerpopTraversalExtension */
+    /** @see TinkerpopTraversalExtension#has(DefaultTraversal, PropertyDefinition) */
     static GraphTraversal has(__ traversal, PropertyDefinition pdef) {
         traversal.has(pdef.label)
     }
 
-    /** @see TinkerpopTraversalExtension */
+    /** @see TinkerpopTraversalExtension#has(DefaultTraversal, PropertyDefinition, Enum) */
     static GraphTraversal has(__ traversal, PropertyDefinition pdef, Enum value) {
         traversal.has(pdef.label, value.name())
     }
 
-    /** @see TinkerpopTraversalExtension */
+    /** @see TinkerpopTraversalExtension#has(DefaultTraversal, PropertyDefinition, Object) */
     static GraphTraversal has(__ traversal, PropertyDefinition pdef, Object value) {
         traversal.has(pdef.label, value)
     }