Merge pull request #83 from truthencode/config/documentation

Config/documentation

.bsp/sbt.json

@@ -0,0 +1 @@
+{"name":"sbt","version":"1.6.2","bspVersion":"2.0.0-M5","languages":["scala"],"argv":["/home/adarro/.sdkman/candidates/java/22.0.0.2.r11-grl/bin/java","-Xms100m","-Xmx100m","-classpath","/home/adarro/.sdkman/candidates/sbt/1.6.2/bin/sbt-launch.jar","-Dsbt.script=/home/adarro/.sdkman/candidates/sbt/current/bin/sbt","xsbt.boot.Boot","-bsp"]}

.gitignore

@@ -35,6 +35,8 @@ buildNumber.properties
 # RStudio files
 .Rproj.user/
 
+**/.antlr/
+
 # produced vignettes
 vignettes/*.html
 vignettes/*.pdf
@@ -80,8 +82,12 @@ qa-tools/qa-tools.iml
 /.ensime_cache/
 ### Gradle template
 .gradle
+local.properties
 build/
 
+# temporary items
+testprojects
+
 # Ignore Gradle GUI config
 gradle-app.setting
 
@@ -195,4 +201,10 @@ rslt.txt
 # apache ignite folder
 **/ignite/*
 # auto generated files
-**/version.properties
+**/version.properties
+incubating/ddo-antlr/src/generated/java/*
+local.properties
+
+.quarkus/
+/subprojects/common/ddo-modeling/src/main/avro/
+/subprojects/common/ddo-core/src/generated/java/io/truthencode/ddo/core/GeneratedVersion.java

.readthedocs.yaml

@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/mkdocs.yaml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#    install:
+#    - requirements: docs/requirements.txt

.tool-versions

@@ -0,0 +1,4 @@
+gradle 7.6
+dotty 3.2.1
+scala 12.13.10
+kotlin 1.7.10

archived/README.md

@@ -0,0 +1,4 @@
+# Archived Projects
+
+These are subprojects that aren't currently incubated or slated for any active development.
+They may eventually be removed or revived. 

incubating/toad-api/build.gradle.kts → archived/toad-api/build.gradle.kts

@@ -24,6 +24,7 @@
 plugins {
     id("scala-library-profile")
     `maven-publish`
+    id("be.vbgn.ci-detect") version "0.5.0"
 }
 
 repositories {
@@ -55,7 +56,7 @@ val hazelcastVersion: String by project
 val junitScalaTestVersion: String by project
 val junitPlatformVersion: String by project
 val junitLauncherVersion: String by project
-val verticesVersion:String by project
+val verticesVersion: String by project
 val monixVersion: String by project
 
 dependencies {
@@ -87,7 +88,11 @@ dependencies {
     implementation("io.vertx:vertx-mongo-client:$vertxVersion")
     implementation("io.vertx:vertx-ignite:$vertxVersion")
 
-    implementation(group="io.github.davidgregory084", name="vertices-core_$scalaMajorVersion",version = verticesVersion)
+    implementation(
+        group = "io.github.davidgregory084",
+        name = "vertices-core_$scalaMajorVersion",
+        version = verticesVersion
+    )
 
     implementation("io.vertx:vertx-codegen:$vertxVersion")
     implementation("io.vertx:vertx-auth-shiro:$vertxVersion")
@@ -165,6 +170,13 @@ tasks {
     withType(Test::class.java) {
         useJUnitPlatform {
             includeEngines = setOf("scalatest", "junit-jupiter")
+            if (ci.isCi)
+                excludeTags = setOf(
+                    "Integration",
+                    "io.truthencode.tags.Integration",
+                    "FunctionOnly",
+                    "io.truthencode.tags.FunctionOnly"
+                )
             testLogging {
                 events("passed", "skipped", "failed")
             }

incubating/toad-api/src/main/java/io/truthencode/toad/Server.java → archived/toad-api/src/main/java/io/truthencode/toad/Server.java

@@ -49,7 +49,7 @@ private Server() {
      *
      * @return the server (type Server) of this Server object.
      */
-    private synchronized static Server getServer() {
+    private static synchronized  Server getServer() {
         if (server == null) {
             server = new Server();
         }
@@ -80,16 +80,7 @@ private void initVertxCluster() {
             }
         });
 
-// Unsure if we need to add shutdownhook for ZK as we did for Hazelcast
-//        Runtime.getRuntime().addShutdownHook(new Thread(() -> {
-//            log.info("Shutting down Hazelcast");
-//            Zookeeper instance = clusterManager.
-//            if (instance.getPartitionService().isClusterSafe()) {
-//                IExecutorService svc = instance.getExecutorService(Server.class.getName());
-//                svc.executeOnAllMembers(new ShutdownMember());
-//            }
-//        }));
-    }
+
 
     /**
      * Internally calls {@link #initVertxCluster()}

incubating/toad-api/src/main/java/io/truthencode/toad/verticle/MyFirstVerticle.java → archived/toad-api/src/main/java/io/truthencode/toad/verticle/MyFirstVerticle.java

@@ -43,6 +43,9 @@
 public class MyFirstVerticle extends AbstractVerticle {
     private static final Logger log = LoggerFactory.getLogger(MyFirstVerticle.class);
     private static final String COLLECTION = "whiskies";
+    public static final String CONTENT_TYPE = "content-type";
+    public static final String API_WHISKIES_ID = "/api/whiskies/:id";
+    public static final String APPLICATION_JSON_CHARSET_UTF_8 = "application/json; charset=utf-8";
     private MongoClient mongo;
 
     /**
@@ -112,7 +115,7 @@ private void startWebApp(Handler<AsyncResult<HttpServer>> next) {
                 routingContext -> {
                     HttpServerResponse response = routingContext
                         .response();
-                    response.putHeader("content-type", "text/html")
+                    response.putHeader(CONTENT_TYPE, "text/html")
                         .end("<h1>Hello from my first Vert.x 3 application</h1>");
                 });
 
@@ -121,12 +124,12 @@ private void startWebApp(Handler<AsyncResult<HttpServer>> next) {
         router.get("/api/whiskies").handler(this::getAll);
         router.route("/api/whiskies*").handler(BodyHandler.create());
         router.post("/api/whiskies").handler(this::addOne);
-        router.get("/api/whiskies/:id").handler(this::getOne);
-        router.put("/api/whiskies/:id").handler(this::updateOne);
-        router.delete("/api/whiskies/:id").handler(this::deleteOne);
+        router.get(API_WHISKIES_ID).handler(this::getOne);
+        router.put(API_WHISKIES_ID).handler(this::updateOne);
+        router.delete(API_WHISKIES_ID).handler(this::deleteOne);
         Config conf = ConfigFactory.load("defaults");
         int port = conf.getInt("server-info.port");
-        //  Integer port = config().getInteger("http.port", 8080);
+
         log.info(String.format("Creating http server on port (%d)", port));
         // Create the HTTP server and pass the "accept" method to the request
         // handler.
@@ -158,7 +161,7 @@ private void completeStartup(AsyncResult<HttpServer> http, Promise<Void> fut) {
     @Override
     public void stop() {
         mongo.close();
-        //	MongoService.Stop();
+
     }
 
     private void addOne(RoutingContext routingContext) {
@@ -171,8 +174,8 @@ private void addOne(RoutingContext routingContext) {
             r -> routingContext
                 .response()
                 .setStatusCode(201)
-                .putHeader("content-type",
-                    "application/json; charset=utf-8")
+                .putHeader(CONTENT_TYPE,
+                    APPLICATION_JSON_CHARSET_UTF_8)
                 .end(Json.encodePrettily(whisky.setId(r.result()))));
     }
 
@@ -196,8 +199,8 @@ private void getOne(RoutingContext routingContext) {
                         routingContext
                             .response()
                             .setStatusCode(200)
-                            .putHeader("content-type",
-                                "application/json; charset=utf-8")
+                            .putHeader(CONTENT_TYPE,
+                                APPLICATION_JSON_CHARSET_UTF_8)
                             .end(Json.encodePrettily(whisky));
                     } else {
                         routingContext.response().setStatusCode(404).end();
@@ -215,17 +218,17 @@ private void updateOne(RoutingContext routingContext) {
             mongo.updateCollection(
                 COLLECTION,
                 new JsonObject().put("_id", id), // Select a unique document
-                // The update syntax: {$set, the json object containing the
-                // fields to update}
+                /* The update syntax: {$set, the json object containing the
+                 fields to update} */
                 new JsonObject().put("$set", json),
                 v -> {
                     if (v.failed()) {
                         routingContext.response().setStatusCode(404).end();
                     } else {
                         routingContext
                             .response()
-                            .putHeader("content-type",
-                                "application/json; charset=utf-8")
+                            .putHeader(CONTENT_TYPE,
+                                APPLICATION_JSON_CHARSET_UTF_8)
                             .end(Json.encodePrettily(new Whisky(id,
                                 json.getString("name"), json
                                 .getString("origin"))));
@@ -254,8 +257,8 @@ private void getAll(RoutingContext routingContext) {
                     .collect(Collectors.toList());
                 routingContext
                     .response()
-                    .putHeader("content-type",
-                        "application/json; charset=utf-8")
+                    .putHeader(CONTENT_TYPE,
+                        APPLICATION_JSON_CHARSET_UTF_8)
                     .end(Json.encodePrettily(whiskies));
             });
     }

incubating/toad-api/src/main/resources/webroot/index.html → archived/toad-api/src/main/resources/webroot/index.html

@@ -17,7 +17,8 @@
     limitations under the License.
 
 -->
-<html>
+<!DOCTYPE>
+<html lang="en">
 <head><title>Welcome to the Sample</title></head>
 <body>
 

incubating/toad-api/src/main/webapp/index.html → archived/toad-api/src/main/webapp/index.html

@@ -23,7 +23,7 @@ <h1>My Whiskies</h1>
         </button>
         <div class="row">
             <div class="col-md-12">
-                <table class="table table-striped">
+                <table class="table table-striped" aria-labelledby="Whiskey bottles">
                     <thead>
                     <tr>
                         <th>#</th>

incubating/toad-api/src/test/java/io/truthencode/toad/db/EmbeddedMongoVerticleIT.java → archived/toad-api/src/test/java/io/truthencode/toad/db/EmbeddedMongoVerticleIT.java

@@ -49,7 +49,7 @@ public class EmbeddedMongoVerticleIT {
 
     // will be shared between test methods
     @Container
-    final static MongoDBContainer mongoDBContainer = new MongoDBContainer(DockerImageName.parse("mongo:4.1.2"));
+    static final MongoDBContainer mongoDBContainer = new MongoDBContainer(DockerImageName.parse("mongo:4.1.2"));
 
     public VertxOptions getOptions() {
         // It can take some time to download the first time!
@@ -62,23 +62,6 @@ void testContainer() {
         assertTrue(mongoDBContainer.isRunning());
     }
 
-    // static JMongoRunner runner = new JMongoRunner(27017);
-
-//    @BeforeAll
-//    static void setUpDb() {
-//
-//        try {
-//            runner.start();
-//        } catch (IOException e) {
-//            e.printStackTrace();
-//        }
-//    }
-
-//    @AfterAll
-//    static void closeDb() {
-//        runner.stop();
-//    }
-
     String mongoUrl(MongoDBContainer mongo) {
         if (!mongo.isRunning()) {
             mongo.start();
@@ -98,11 +81,6 @@ public void testDeployUsingClassName(Vertx vertx, VertxTestContext testContext)
             assertNotNull(id);
             vertx.undeploy(id, testContext.succeedingThenComplete());
         }));
-//            ar.onComplete(testContext.succeeding(rslt ->
-//                testContext.verify(() -> {
-//                    assertTrue(ar.succeeded());
-//                })));
-//        });
         assertTrue(testContext.awaitCompletion(5, TimeUnit.SECONDS));
         if (testContext.failed())
             throw testContext.causeOfFailure();
@@ -116,11 +94,11 @@ public void testEmbeddedMongo(Vertx vertx, VertxTestContext testContext) throws
         // Not really sure what to test here apart from start and stop vertx.
         vertx.deployVerticle("service:io.vertx.vertx-mongo-embedded-db", testContext.succeeding(deploymentID -> {
             assertNotNull(deploymentID);
-            vertx.undeploy(deploymentID, testContext.succeeding(v -> {
-                testContext.verify(() -> {
+            vertx.undeploy(deploymentID, testContext.succeeding(v ->
+                testContext.verify(() ->
                     assertNull(v);
-                });
-            }));
+                );
+            ));
         }));
         assertTrue(testContext.awaitCompletion(5, TimeUnit.SECONDS));
         if (testContext.failed())
@@ -147,8 +125,7 @@ public void testSimpleVerticle(Vertx vertx, VertxTestContext testContext) throws
 
 
     @Test
-    void start_http_server(Vertx vertx, VertxTestContext testContext) throws Throwable {
-        //  VertxTestContext testContext = new VertxTestContext();
+    void startHttpServer(Vertx vertx, VertxTestContext testContext) throws Throwable {
 
         vertx.createHttpServer()
             .requestHandler(req -> req.response().end())

incubating/toad-api/src/test/java/io/truthencode/toad/verticle/DemoVerticle.java → archived/toad-api/src/test/java/io/truthencode/toad/verticle/DemoVerticle.java

@@ -14,8 +14,7 @@ public void start() {
     public void stop() {
 
         // You can optionally override the stop method too, if you have some clean-up to do
-
-        System.out.println("In OtherVerticle.stop");
+        java.util.logging.Logger.getLogger(DemoVerticle.class.getName()).warning("In OtherVerticle.stop")
 
     }
 }

incubating/toad-api/src/test/java/io/truthencode/toad/verticle/MongoClientVerticle.java → archived/toad-api/src/test/java/io/truthencode/toad/verticle/MongoClientVerticle.java

@@ -9,6 +9,12 @@
 public class MongoClientVerticle extends AbstractVerticle {
 
 
+    static final String LABEL_ITEM_ID = "itemId";
+    static final String LABEL_NAME = "name";
+    static final String LABEL_PRICE = "price";
+    static final String SOME_NUMBER = "12345";
+    static final String LABEL_PRODUCTS = "products";
+    Logger logger = java.util.logging.Logger.getLogger(MongoClientVerticle.class);
 
     @Override
     public void start() throws Exception {
@@ -30,20 +36,20 @@ public void start() throws Exception {
 
         MongoClient mongoClient = MongoClient.createShared(vertx, mongoconfig);
 
-        JsonObject product1 = new JsonObject().put("itemId", "12345").put("name", "Cooler").put("price", "100.0");
+        JsonObject product1 = new JsonObject().put(LABEL_ITEM_ID, LABEL_SOME_NUMBER).put(LABEL_NAME, "Cooler").put(LABEL_PRICE, "100.0");
 
-        mongoClient.save("products", product1)
+        mongoClient.save(LABEL_PRODUCTS, product1)
             .compose(id -> {
-                System.out.println("Inserted id: " + id);
-                return mongoClient.find("products", new JsonObject().put("itemId", "12345"));
+                logger.debug("Inserted id: " + id);
+                return mongoClient.find(LABEL_PRODUCTS, new JsonObject().put(LABEL_ITEM_ID, LABEL_SOME_NUMBER));
             })
             .compose(res -> {
-                System.out.println("Name is " + res.get(0).getString("name"));
-                return mongoClient.removeDocument("products", new JsonObject().put("itemId", "12345"));
+                logger.debug("Name is " + res.get(0).getString(LABEL_NAME));
+                return mongoClient.removeDocument(LABEL_PRODUCTS, new JsonObject().put(LABEL_ITEM_ID, LABEL_SOME_NUMBER));
             })
             .onComplete(ar -> {
                 if (ar.succeeded()) {
-                    System.out.println("Product removed ");
+                    logger.debug("Product removed ");
                 } else {
                     ar.cause().printStackTrace();
                 }