"url prefix" -> "url prefix-src"

Author: simonbrowndotje

structurizr-component/src/main/java/com/structurizr/component/url/DefaultUrlStrategy.java

@@ -2,6 +2,9 @@
 
 import com.structurizr.component.Type;
 
+/**
+ * Generates a null URL.
+ */
 public class DefaultUrlStrategy implements UrlStrategy {
 
     @Override

…izr/component/url/PrefixUrlStrategy.java …mponent/url/PrefixSourceUrlStrategy.javastructurizr-component/src/main/java/com/structurizr/component/url/PrefixUrlStrategy.java renamed to structurizr-component/src/main/java/com/structurizr/component/url/PrefixSourceUrlStrategy.java structurizr-component/src/main/java/com/structurizr/component/url/PrefixUrlStrategy.java renamed to structurizr-component/src/main/java/com/structurizr/component/url/PrefixSourceUrlStrategy.java

@@ -3,11 +3,14 @@
 import com.structurizr.component.Type;
 import com.structurizr.util.StringUtils;
 
-public class PrefixUrlStrategy implements UrlStrategy {
+/**
+ * Adds a given prefix to the component source location.
+ */
+public class PrefixSourceUrlStrategy implements UrlStrategy {
 
     private final String prefix;
 
-    public PrefixUrlStrategy(String prefix) {
+    public PrefixSourceUrlStrategy(String prefix) {
         if (StringUtils.isNullOrEmpty(prefix)) {
             throw new IllegalArgumentException("A prefix must be supplied");
         }

structurizr-component/src/main/java/com/structurizr/component/url/UrlStrategy.java

@@ -2,6 +2,9 @@
 
 import com.structurizr.component.Type;
 
+/**
+ * Provides a way customise how component URLs are generated.
+ */
 public interface UrlStrategy {
 
     String urlOf(Type type);

structurizr-dsl/src/main/java/com/structurizr/dsl/ComponentFinderStrategyParser.java

@@ -9,7 +9,7 @@
 import com.structurizr.component.naming.TypeNamingStrategy;
 import com.structurizr.component.naming.FullyQualifiedNamingStrategy;
 import com.structurizr.component.supporting.*;
-import com.structurizr.component.url.PrefixUrlStrategy;
+import com.structurizr.component.url.PrefixSourceUrlStrategy;
 
 import java.io.File;
 import java.util.List;
@@ -52,9 +52,9 @@ final class ComponentFinderStrategyParser extends AbstractParser {
     private static final String DESCRIPTION_GRAMMAR = "description <" + String.join("|", List.of(DESCRIPTION_FIRST_SENTENCE, DESCRIPTION_TRUNCATED)) + ">";
     private static final String DESCRIPTION_TRUNCATED_GRAMMAR = "description truncated <maxLength>";
 
-    private static final String URL_PREFIX = "prefix";
-    private static final String URL_GRAMMAR = "url <" + String.join("|", List.of(URL_PREFIX)) + ">";
-    private static final String URL_PREFIX_GRAMMAR = "url prefix <prefix>";
+    private static final String URL_PREFIX_SRC = "prefix-src";
+    private static final String URL_GRAMMAR = "url <" + String.join("|", List.of(URL_PREFIX_SRC)) + ">";
+    private static final String URL_PREFIX_SRC_GRAMMAR = "url prefix-src <prefix>";
 
     void parseTechnology(ComponentFinderStrategyDslContext context, Tokens tokens) {
         if (tokens.size() != 2) {
@@ -248,13 +248,13 @@ void parseUrl(ComponentFinderStrategyDslContext context, Tokens tokens, File dsl
 
         String type = tokens.get(1).toLowerCase();
         switch (type) {
-            case URL_PREFIX:
+            case URL_PREFIX_SRC:
                 if (tokens.size() < 3) {
-                    throw new RuntimeException("Too few tokens, expected: " + URL_PREFIX_GRAMMAR);
+                    throw new RuntimeException("Too few tokens, expected: " + URL_PREFIX_SRC_GRAMMAR);
                 }
 
                 String prefix = tokens.get(2);
-                context.getComponentFinderStrategyBuilder().withUrl(new PrefixUrlStrategy(prefix));
+                context.getComponentFinderStrategyBuilder().withUrl(new PrefixSourceUrlStrategy(prefix));
                 break;
             default:
                 throw new IllegalArgumentException("Unknown URL strategy: " + type);

structurizr-dsl/src/test/java/com/structurizr/dsl/ComponentFinderStrategyParserTests.java

@@ -283,23 +283,23 @@ void test_parseUrl_ThrowsAnException_WhenNoTypeIsSpecified() {
             parser.parseUrl(context, tokens("url"), null);
             fail();
         } catch (Exception e) {
-            assertEquals("Too few tokens, expected: url <prefix>", e.getMessage());
+            assertEquals("Too few tokens, expected: url <prefix-src>", e.getMessage());
         }
     }
 
     @Test
     void test_parseUrl_Prefix_ThrowsAnException_WhenNoPrefixIsSpecified() {
         try {
-            parser.parseUrl(context, tokens("url", "prefix"), null);
+            parser.parseUrl(context, tokens("url", "prefix-src"), null);
             fail();
         } catch (Exception e) {
-            assertEquals("Too few tokens, expected: url prefix <prefix>", e.getMessage());
+            assertEquals("Too few tokens, expected: url prefix-src <prefix>", e.getMessage());
         }
     }
 
     @Test
     void test_parseUrl_Prefix() {
-        parser.parseUrl(context, tokens("url", "prefix", "https://example.com"), null);
+        parser.parseUrl(context, tokens("url", "prefix-src", "https://example.com"), null);
         assertEquals("ComponentFinderStrategyBuilder{technology=null, typeMatcher=null, typeFilter=null, supportingTypesStrategy=null, namingStrategy=null, descriptionStrategy=null, urlStrategy=PrefixUrlStrategy{prefix='https://example.com/'}, componentVisitor=null}", context.getComponentFinderStrategyBuilder().toString());
     }
 

structurizr-dsl/src/test/resources/dsl/spring-petclinic/workspace.dsl

@@ -26,7 +26,7 @@ workspace "Spring PetClinic" "A C4 model of the Spring PetClinic sample app (htt
                         technology "Spring MVC Controller"
                         matcher annotation "org.springframework.stereotype.Controller"
                         filter exclude fqn-regex ".*.CrashController"
-                        url prefix "https://github.com/spring-projects/spring-petclinic/blob/main/src/main/java"
+                        url prefix-src "https://github.com/spring-projects/spring-petclinic/blob/main/src/main/java"
                         forEach {
                             clinicEmployee -> this "Uses"
                             tag "Spring MVC Controller"
@@ -36,7 +36,7 @@ workspace "Spring PetClinic" "A C4 model of the Spring PetClinic sample app (htt
                         technology "Spring Data Repository"
                         matcher implements "org.springframework.data.repository.Repository"
                         description first-sentence
-                        url prefix "https://github.com/spring-projects/spring-petclinic/blob/main/src/main/java"
+                        url prefix-src "https://github.com/spring-projects/spring-petclinic/blob/main/src/main/java"
                         forEach {
                             -> relationalDatabaseSchema "Reads from and writes to"
                             tag "Spring Data Repository"