dsl-kotlin: update systems and when commands

Author: ivangsa

CONTRIBUTING.md

@@ -10,7 +10,7 @@
 
 ```bash
 # Build the project
-./gradlew build
+./gradlew clean build
 
 # Run tests
 ./gradlew jvmTest

README.md

@@ -38,6 +38,8 @@ ZdlParser parser = new ZdlParser();
 ZdlModel model = parser.parseModel(zdlContent);
 ```
 
+NOTE: jvm version includes a working ZdlParser compiled from Kotlin ANTL4 target and also just the Parser/Lexer from the Java target for use by intellij-antlr-adapter.
+
 * JavaScript/TypeScript:
 
 ```bash

nodejs-test-project/zfl-parser.test.js

@@ -54,29 +54,21 @@ describe('ZFL Parser - Subscriptions', () => {
         describe('Subscription system', () => {
             it('should have correct name and zdl', () => {
                 assert.equal(jsonPath(model, "$.flows.PaymentsFlow.systems.Subscription.name"), "Subscription");
-                assert.equal(jsonPath(model, "$.flows.PaymentsFlow.systems.Subscription.zdl"), "subscription/model.zdl");
+                assert.equal(jsonPath(model, "$.flows.PaymentsFlow.systems.Subscription.options.zdl"), "subscription/model.zdl");
             });
 
             it('should have 1 service', () => {
                 assert.equal(mapSize(jsonPath(model, "$.flows.PaymentsFlow.systems.Subscription.services")), 1);
             });
 
             it('should have SubscriptionService with correct commands', () => {
-                assert.equal(jsonPath(model, "$.flows.PaymentsFlow.systems.Subscription.services.DefaultService.name"), "DefaultService");
-                const commands = jsonPath(model, "$.flows.PaymentsFlow.systems.Subscription.services.DefaultService.commands");
+                assert.equal(jsonPath(model, "$.flows.PaymentsFlow.systems.Subscription.services.SubscriptionService.name"), "SubscriptionService");
+                const commands = jsonPath(model, "$.flows.PaymentsFlow.systems.Subscription.services.SubscriptionService.commands");
                 assert.equal(arraySize(commands), 3);
                 assert.equal(commands[0], "renewSubscription");
                 assert.equal(commands[1], "suspendSubscription");
                 assert.equal(commands[2], "cancelRenewal");
             });
-
-            it('should have correct events', () => {
-                const events = jsonPath(model, "$.flows.PaymentsFlow.systems.Subscription.events");
-                assert.equal(arraySize(events), 3);
-                assert.equal(events[0], "SubscriptionRenewed");
-                assert.equal(events[1], "SubscriptionSuspended");
-                assert.equal(events[2], "RenewalCancelled");
-            });
         });
 
         describe('Payments system', () => {
@@ -147,9 +139,9 @@ describe('ZFL Parser - Subscriptions', () => {
     });
 
     describe('when blocks', () => {
-        it('should have 5 when blocks', () => {
+        it('should have 6 when blocks', () => {
             const whens = jsonPath(model, "$.flows.PaymentsFlow.whens");
-            assert.equal(arraySize(whens), 5);
+            assert.equal(arraySize(whens), 6);
         });
 
         describe('first when block', () => {
@@ -159,10 +151,8 @@ describe('ZFL Parser - Subscriptions', () => {
                 assert.equal(triggers[0], "CustomerRequestsSubscriptionRenewal");
             });
 
-            it('should have correct commands', () => {
-                const commands = jsonPath(model, "$.flows.PaymentsFlow.whens[0].commands");
-                assert.equal(arraySize(commands), 1);
-                assert.equal(commands[0], "renewSubscription");
+            it('should have correct command', () => {
+                assert.equal(jsonPath(model, "$.flows.PaymentsFlow.whens[0].command"), "renewSubscription");
             });
 
             it('should have correct events', () => {
@@ -179,10 +169,8 @@ describe('ZFL Parser - Subscriptions', () => {
                 assert.equal(triggers[0], "SubscriptionRenewed");
             });
 
-            it('should have correct commands', () => {
-                const commands = jsonPath(model, "$.flows.PaymentsFlow.whens[1].commands");
-                assert.equal(arraySize(commands), 1);
-                assert.equal(commands[0], "chargePayment");
+            it('should have correct command', () => {
+                assert.equal(jsonPath(model, "$.flows.PaymentsFlow.whens[1].command"), "chargePayment");
             });
 
             it('should have correct events', () => {
@@ -193,94 +181,82 @@ describe('ZFL Parser - Subscriptions', () => {
             });
         });
 
-        describe('third when block with if/else', () => {
+        describe('third when block with if condition', () => {
             it('should have correct triggers', () => {
                 const triggers = jsonPath(model, "$.flows.PaymentsFlow.whens[2].triggers");
                 assert.equal(arraySize(triggers), 1);
                 assert.equal(triggers[0], "PaymentFailed");
             });
 
-            it('should have 1 if block', () => {
-                const ifs = jsonPath(model, "$.flows.PaymentsFlow.whens[2].ifs");
-                assert.equal(arraySize(ifs), 1);
-            });
-
             it('should have correct if condition', () => {
-                assert.equal(jsonPath(model, "$.flows.PaymentsFlow.whens[2].ifs[0].condition"), "less than 3 attempts");
+                assert.equal(jsonPath(model, "$.flows.PaymentsFlow.whens[2].options.if"), "less than 3 attempts");
             });
 
-            it('should have correct if commands', () => {
-                const commands = jsonPath(model, "$.flows.PaymentsFlow.whens[2].ifs[0].commands");
-                assert.equal(arraySize(commands), 1);
-                assert.equal(commands[0], "retryPayment");
+            it('should have correct command', () => {
+                assert.equal(jsonPath(model, "$.flows.PaymentsFlow.whens[2].command"), "retryPayment");
             });
 
-            it('should have correct if events', () => {
-                const events = jsonPath(model, "$.flows.PaymentsFlow.whens[2].ifs[0].events");
+            it('should have correct events', () => {
+                const events = jsonPath(model, "$.flows.PaymentsFlow.whens[2].events");
                 assert.equal(arraySize(events), 1);
                 assert.equal(events[0], "PaymentRetryScheduled");
             });
+        });
 
-            it('should have else block', () => {
-                const elseBlock = jsonPath(model, "$.flows.PaymentsFlow.whens[2].ifs[0].else");
-                assert.notEqual(elseBlock, null);
+        describe('fourth when block with if condition (else case)', () => {
+            it('should have correct triggers', () => {
+                const triggers = jsonPath(model, "$.flows.PaymentsFlow.whens[3].triggers");
+                assert.equal(arraySize(triggers), 1);
+                assert.equal(triggers[0], "PaymentFailed");
             });
 
-            it('should have correct else policies', () => {
-                const policies = jsonPath(model, "$.flows.PaymentsFlow.whens[2].ifs[0].else.policies");
-                assert.equal(arraySize(policies), 1);
-                assert.equal(policies[0], "Suspend after 3 failed attempts");
+            it('should have correct if condition', () => {
+                assert.equal(jsonPath(model, "$.flows.PaymentsFlow.whens[3].options.if"), "3 or more attempts");
             });
 
-            it('should have correct else commands', () => {
-                const commands = jsonPath(model, "$.flows.PaymentsFlow.whens[2].ifs[0].else.commands");
-                assert.equal(arraySize(commands), 1);
-                assert.equal(commands[0], "suspendSubscription");
+            it('should have correct command', () => {
+                assert.equal(jsonPath(model, "$.flows.PaymentsFlow.whens[3].command"), "suspendSubscription");
             });
 
-            it('should have correct else events', () => {
-                const events = jsonPath(model, "$.flows.PaymentsFlow.whens[2].ifs[0].else.events");
+            it('should have correct events', () => {
+                const events = jsonPath(model, "$.flows.PaymentsFlow.whens[3].events");
                 assert.equal(arraySize(events), 1);
                 assert.equal(events[0], "SubscriptionSuspended");
             });
         });
 
-        describe('fourth when block with AND trigger', () => {
+        describe('fifth when block with AND trigger', () => {
             it('should have 2 triggers (AND condition)', () => {
-                const triggers = jsonPath(model, "$.flows.PaymentsFlow.whens[3].triggers");
+                const triggers = jsonPath(model, "$.flows.PaymentsFlow.whens[4].triggers");
                 assert.equal(arraySize(triggers), 2);
                 assert.equal(triggers[0], "PaymentSucceeded");
                 assert.equal(triggers[1], "BillingCycleEnded");
             });
 
-            it('should have correct commands', () => {
-                const commands = jsonPath(model, "$.flows.PaymentsFlow.whens[3].commands");
-                assert.equal(arraySize(commands), 1);
-                assert.equal(commands[0], "recordPayment");
+            it('should have correct command', () => {
+                assert.equal(jsonPath(model, "$.flows.PaymentsFlow.whens[4].command"), "recordPayment");
             });
 
             it('should have correct events', () => {
-                const events = jsonPath(model, "$.flows.PaymentsFlow.whens[3].events");
+                const events = jsonPath(model, "$.flows.PaymentsFlow.whens[4].events");
                 assert.equal(arraySize(events), 1);
                 assert.equal(events[0], "PaymentRecorded");
             });
         });
 
-        describe('fifth when block', () => {
+        describe('sixth when block', () => {
             it('should have correct triggers', () => {
-                const triggers = jsonPath(model, "$.flows.PaymentsFlow.whens[4].triggers");
+                const triggers = jsonPath(model, "$.flows.PaymentsFlow.whens[5].triggers");
                 assert.equal(arraySize(triggers), 1);
                 assert.equal(triggers[0], "PaymentTimeout");
             });
 
-            it('should have correct commands', () => {
-                const commands = jsonPath(model, "$.flows.PaymentsFlow.whens[4].commands");
-                assert.equal(arraySize(commands), 1);
-                assert.equal(commands[0], "cancelRenewal");
+            it('should have correct command', () => {
+                assert.equal(jsonPath(model, "$.flows.PaymentsFlow.whens[5].command"), "cancelRenewal");
             });
 
             it('should have correct events', () => {
-                const events = jsonPath(model, "$.flows.PaymentsFlow.whens[4].events");
+                const events = jsonPath(model, "$.flows.PaymentsFlow.whens[5].events");
                 assert.equal(arraySize(events), 1);
                 assert.equal(events[0], "RenewalCancelled");
             });

src/commonMain/antlr/io.zenwave360.language.antlr/Zfl.g4

@@ -174,15 +174,11 @@ flow_start_name: ID;
 flow_when: javadoc? annotations WHEN flow_when_trigger LBRACE flow_when_body RBRACE;
 flow_when_trigger: flow_when_event_trigger (AND flow_when_event_trigger)*;
 flow_when_event_trigger: ID;
-flow_when_body: (flow_when_command | flow_when_event | flow_when_if | flow_when_policy)*;
+flow_when_body: flow_when_command (flow_when_event)*;
 flow_when_command: COMMAND flow_command_name;
 flow_command_name: ID;
 flow_when_event: EVENT flow_event_name;
 flow_event_name: ID;
-flow_when_if: IF string LBRACE flow_when_body RBRACE flow_when_else_if* flow_when_else?;
-flow_when_else_if: ELSE IF string LBRACE flow_when_body RBRACE;
-flow_when_else: ELSE LBRACE flow_when_body RBRACE;
-flow_when_policy: POLICY string;
 
 // end block
 flow_end: javadoc? annotations END LBRACE flow_end_outcomes RBRACE;

src/commonMain/kotlin/io/zenwave360/language/zfl/internal/ZflListenerImpl.kt

@@ -189,7 +189,6 @@ class ZflListenerImpl : ZflBaseListener() {
 
         val whenBlock = buildMap()
             .with("triggers", triggers)
-            .with("commands", mutableListOf<Any?>())
             .with("events", mutableListOf<Any?>())
             .with("ifs", mutableListOf<Any?>())
             .with("policies", mutableListOf<Any?>())
@@ -206,8 +205,7 @@ class ZflListenerImpl : ZflBaseListener() {
 
     override fun enterFlow_when_command(ctx: ZflParser.Flow_when_commandContext) {
         val commandName = getText(ctx.flow_command_name())
-        @Suppress("UNCHECKED_CAST")
-        (currentStack.last()["commands"] as MutableList<Any?>).add(commandName)
+        currentStack.last()["command"] = commandName
     }
 
     override fun enterFlow_when_event(ctx: ZflParser.Flow_when_eventContext) {
@@ -216,67 +214,6 @@ class ZflListenerImpl : ZflBaseListener() {
         (currentStack.last()["events"] as MutableList<Any?>).add(eventName)
     }
 
-    override fun enterFlow_when_policy(ctx: ZflParser.Flow_when_policyContext) {
-        val policyName = getValueText(ctx.string())
-        @Suppress("UNCHECKED_CAST")
-        (currentStack.last()["policies"] as MutableList<Any?>).add(policyName)
-    }
-
-    override fun enterFlow_when_if(ctx: ZflParser.Flow_when_ifContext) {
-        val condition = getValueText(ctx.string())
-
-        val ifBlock = buildMap()
-            .with("condition", condition)
-            .with("commands", mutableListOf<Any?>())
-            .with("events", mutableListOf<Any?>())
-            .with("policies", mutableListOf<Any?>())
-            .with("elseIfs", mutableListOf<Any?>())
-            .with("else", null)
-
-        currentStack.addLast(ifBlock)
-        val whenBlock = currentStack[currentStack.size - 2]
-        @Suppress("UNCHECKED_CAST")
-        (whenBlock["ifs"] as MutableList<Any?>).add(ifBlock)
-    }
-
-    override fun exitFlow_when_if(ctx: ZflParser.Flow_when_ifContext) {
-        currentStack.removeLast()
-    }
-
-    override fun enterFlow_when_else_if(ctx: ZflParser.Flow_when_else_ifContext) {
-        val condition = getValueText(ctx.string())
-
-        val elseIfBlock = buildMap()
-            .with("condition", condition)
-            .with("commands", mutableListOf<Any?>())
-            .with("events", mutableListOf<Any?>())
-            .with("policies", mutableListOf<Any?>())
-
-        val ifBlock = currentStack.last()
-        @Suppress("UNCHECKED_CAST")
-        (ifBlock["elseIfs"] as MutableList<Any?>).add(elseIfBlock)
-        currentStack.addLast(elseIfBlock)
-    }
-
-    override fun exitFlow_when_else_if(ctx: ZflParser.Flow_when_else_ifContext) {
-        currentStack.removeLast()
-    }
-
-    override fun enterFlow_when_else(ctx: ZflParser.Flow_when_elseContext) {
-        val elseBlock = buildMap()
-            .with("commands", mutableListOf<Any?>())
-            .with("events", mutableListOf<Any?>())
-            .with("policies", mutableListOf<Any?>())
-
-        val ifBlock = currentStack.last()
-        ifBlock["else"] = elseBlock
-        currentStack.addLast(elseBlock)
-    }
-
-    override fun exitFlow_when_else(ctx: ZflParser.Flow_when_elseContext) {
-        currentStack.removeLast()
-    }
-
     // End block
     override fun enterFlow_end(ctx: ZflParser.Flow_endContext) {
         val end = buildMap()