Makes the DSL script context mirror the DSL plugin context (added a r…

…eference to the parser).
structurizr · Feb 16, 2024 · 15b6eae · 15b6eae
1 parent 4ff7f42
commit 15b6eae
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 11 deletions.
diff --git a/structurizr-dsl/src/main/java/com/structurizr/dsl/ExternalScriptDslContext.java b/structurizr-dsl/src/main/java/com/structurizr/dsl/ExternalScriptDslContext.java
@@ -9,8 +9,8 @@ class ExternalScriptDslContext extends ScriptDslContext {
 
     private final String filename;
 
-    ExternalScriptDslContext(DslContext parentContext, File dslFile, String filename) {
-        super(parentContext, dslFile);
+    ExternalScriptDslContext(DslContext parentContext, File dslFile, StructurizrDslParser dslParser, String filename) {
+        super(parentContext, dslFile, dslParser);
 
         this.filename = filename;
     }

diff --git a/structurizr-dsl/src/main/java/com/structurizr/dsl/InlineScriptDslContext.java b/structurizr-dsl/src/main/java/com/structurizr/dsl/InlineScriptDslContext.java
@@ -20,8 +20,8 @@ class InlineScriptDslContext extends ScriptDslContext {
         SUPPORTED_LANGUAGES.put("ruby", "rb");
     }
 
-    InlineScriptDslContext(DslContext parentContext, File dslFile, String language) {
-        super(parentContext, dslFile);
+    InlineScriptDslContext(DslContext parentContext, File dslFile, StructurizrDslParser dslParser, String language) {
+        super(parentContext, dslFile, dslParser);
 
         this.language = language.toLowerCase();
     }

diff --git a/structurizr-dsl/src/main/java/com/structurizr/dsl/ScriptDslContext.java b/structurizr-dsl/src/main/java/com/structurizr/dsl/ScriptDslContext.java
@@ -22,12 +22,14 @@ abstract class ScriptDslContext extends DslContext {
     private final DslContext parentContext;
 
     protected final File dslFile;
+    private final StructurizrDslParser dslParser;
 
     private final Map<String,String> parameters = new HashMap<>();
 
-    ScriptDslContext(DslContext parentContext, File dslFile) {
+    ScriptDslContext(DslContext parentContext, File dslFile, StructurizrDslParser dslParser) {
         this.parentContext = parentContext;
         this.dslFile = dslFile;
+        this.dslParser = dslParser;
     }
 
     void addParameter(String name, String value) {
@@ -60,7 +62,7 @@ void run(DslContext context, String extension, List<String> lines) throws Except
             }
 
             // bind a context object
-            StructurizrDslScriptContext scriptContext = new StructurizrDslScriptContext(dslFile, getWorkspace(), parameters);
+            StructurizrDslScriptContext scriptContext = new StructurizrDslScriptContext(dslParser, dslFile, getWorkspace(), parameters);
             bindings.put(CONTEXT_VARIABLE_NAME, scriptContext);
 
             // and any custom parameters

diff --git a/structurizr-dsl/src/main/java/com/structurizr/dsl/StructurizrDslParser.java b/structurizr-dsl/src/main/java/com/structurizr/dsl/StructurizrDslParser.java
@@ -271,10 +271,10 @@ void parse(List<String> lines, File dslFile) throws StructurizrDslParserExceptio
                             ScriptParser scriptParser = new ScriptParser();
                             if (scriptParser.isInlineScript(tokens)) {
                                 String language = scriptParser.parseInline(tokens.withoutContextStartToken());
-                                startContext(new InlineScriptDslContext(getContext(), dslFile, language));
+                                startContext(new InlineScriptDslContext(getContext(), dslFile, this, language));
                             } else {
                                 String filename = scriptParser.parseExternal(tokens.withoutContextStartToken());
-                                startContext(new ExternalScriptDslContext(getContext(), dslFile, filename));
+                                startContext(new ExternalScriptDslContext(getContext(), dslFile, this, filename));
 
                                 if (shouldStartContext(tokens)) {
                                     // we'll wait for parameters before executing the script

diff --git a/structurizr-dsl/src/main/java/com/structurizr/dsl/StructurizrDslScriptContext.java b/structurizr-dsl/src/main/java/com/structurizr/dsl/StructurizrDslScriptContext.java
@@ -11,23 +11,35 @@
  */
 public class StructurizrDslScriptContext {
 
+    private final StructurizrDslParser dslParser;
     private final File dslFile;
     private final Workspace workspace;
     private final Map<String,String> parameters;
 
     /**
      * Creates a new instance.
      *
+     * @param dslParser     a reference to the DSL parser that loaded the script
      * @param dslFile       a reference to the DSL file that loaded the script
      * @param workspace     the workspace
      * @param parameters    a map of name/value pairs representing parameters
      */
-    public StructurizrDslScriptContext(File dslFile, Workspace workspace, Map<String,String> parameters) {
+    public StructurizrDslScriptContext(StructurizrDslParser dslParser, File dslFile, Workspace workspace, Map<String,String> parameters) {
+        this.dslParser = dslParser;
         this.dslFile = dslFile;
         this.workspace = workspace;
         this.parameters = parameters;
     }
 
+    /**
+     * Gets a reference to the DSL parser that initiated this script context.
+     *
+     * @return  a StructurizrDslParser instance
+     */
+    public StructurizrDslParser getDslParser() {
+        return dslParser;
+    }
+
     /**
      * Gets a reference to the DSL file that initiated this script context.
      *

diff --git a/structurizr-dsl/src/test/java/com/structurizr/dsl/ExternalScriptDslContextTests.java b/structurizr-dsl/src/test/java/com/structurizr/dsl/ExternalScriptDslContextTests.java
@@ -11,7 +11,7 @@ class ExternalScriptDslContextTests extends AbstractTests {
 
     @Test
     void test_parseExternal_RunsTheScript_WhenAValidScriptFilenameIsSpecified() {
-        ExternalScriptDslContext context = new ExternalScriptDslContext(new WorkspaceDslContext(), new File("src/test/resources/dsl/workspace.dsl"), "test.kts");
+        ExternalScriptDslContext context = new ExternalScriptDslContext(new WorkspaceDslContext(), new File("src/test/resources/dsl/workspace.dsl"), null, "test.kts");
         context.setWorkspace(workspace);
         context.end();
 

diff --git a/structurizr-dsl/src/test/java/com/structurizr/dsl/InlineScriptDslContextTests.java b/structurizr-dsl/src/test/java/com/structurizr/dsl/InlineScriptDslContextTests.java
@@ -12,7 +12,7 @@ class InlineScriptDslContextTests extends AbstractTests {
     @Test
     void test_end_ThrowsAnException_WhenAnUnsupportedLanguageIsSpecified() {
         try {
-            InlineScriptDslContext context = new InlineScriptDslContext(new WorkspaceDslContext(), new File("workspace.dsl"), "java");
+            InlineScriptDslContext context = new InlineScriptDslContext(new WorkspaceDslContext(), new File("workspace.dsl"), null, "java");
             context.end();
             fail();
         } catch (Exception e) {