feat: allow multiple source code tabs in TabbedDemo

Author: javier-godoy

src/main/java/com/flowingcode/vaadin/addons/demo/DemoSource.java

@@ -22,6 +22,7 @@
 import com.flowingcode.vaadin.addons.GithubBranch;
 import com.flowingcode.vaadin.addons.GithubLink;
 import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
@@ -37,12 +38,28 @@
  *
  * @author Javier Godoy / Flowing Code
  */
+@Repeatable(DemoSources.class)
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 public @interface DemoSource {
 
   static final String GITHUB_SOURCE = "__GITHUB__";
 
+  static final String DEFAULT_VALUE = "__DEFAULT__";
+
   /** A link to the source code, if different from the annotated class. */
   String value() default GITHUB_SOURCE;
+
+  /**
+   * The caption of the source tab (displayed if several sources are provided). Default to the file
+   * name.
+   */
+  String caption() default DEFAULT_VALUE;
+
+  /**
+   * The language used to format the sources. By default the language is inferred from the file
+   * extension.
+   */
+  String language() default DEFAULT_VALUE;
+
 }

src/main/java/com/flowingcode/vaadin/addons/demo/DemoSources.java

@@ -0,0 +1,14 @@
+package com.flowingcode.vaadin.addons.demo;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+public @interface DemoSources {
+
+  DemoSource[] value();
+
+}

src/main/java/com/flowingcode/vaadin/addons/demo/SourceCodeTab.java

@@ -2,16 +2,20 @@
 
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
+import lombok.Builder;
 import lombok.Getter;
+import lombok.NonNull;
 import lombok.RequiredArgsConstructor;
-import lombok.With;
 
 @Getter
-@With
+@Builder
 @RequiredArgsConstructor
 @AllArgsConstructor(access = AccessLevel.PRIVATE)
 public class SourceCodeTab {
+  
+  @NonNull
   private final String url;
   private String caption;
   private String language;
+  
 }

src/main/java/com/flowingcode/vaadin/addons/demo/SplitLayoutDemo.java

@@ -24,7 +24,7 @@
 import com.vaadin.flow.component.splitlayout.SplitLayout;
 import com.vaadin.flow.component.splitlayout.SplitLayout.Orientation;
 import com.vaadin.flow.server.Version;
-import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -35,14 +35,16 @@ class SplitLayoutDemo extends Composite<SplitLayout> {
   private MultiSourceCodeViewer code;
 
   public SplitLayoutDemo(Component demo, String sourceUrl) {
+    this(demo, Arrays.asList(new SourceCodeTab(sourceUrl)));
+  }
+
+  public SplitLayoutDemo(Component demo, List<SourceCodeTab> tabs) {
     getContent().setOrientation(Orientation.HORIZONTAL);
 
     Map<String, String> properties = new HashMap<>();
     properties.put("vaadin", VaadinVersion.getVaadinVersion());
     properties.put("flow", Version.getFullVersion());
 
-    List<SourceCodeTab> tabs = new ArrayList<>();
-    tabs.add(new SourceCodeTab(sourceUrl));
     code = new MultiSourceCodeViewer(tabs, properties);
     getContent().addToPrimary(demo);
     getContent().addToSecondary(code);

src/main/java/com/flowingcode/vaadin/addons/demo/TabbedDemo.java

@@ -40,6 +40,8 @@
 import com.vaadin.flow.router.Route;
 import com.vaadin.flow.router.RouterLayout;
 import com.vaadin.flow.router.RouterLink;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
 import org.slf4j.Logger;
@@ -179,29 +181,14 @@ public void showRouterLayoutContent(HasElement content) {
       helperButton = null;
     }
 
-    DemoSource demoSource = demo.getClass().getAnnotation(DemoSource.class);
-    String sourceCodeUrl = null;
-    if (demoSource != null) {
-      sourceCodeUrl = demoSource.value();
-
-      String demoFile;
-      if (sourceCodeUrl.equals(DemoSource.GITHUB_SOURCE)) {
-        String className = demo.getClass().getName().replace('.', '/');
-        demoFile = "src/test/java/" + className + ".java";
-      } else if (sourceCodeUrl.startsWith("/src/test/")) {
-        demoFile = sourceCodeUrl.substring(1);
-      } else {
-        demoFile = null;
-      }
-
-      if (demoFile != null) {
-        String branch = lookupGithubBranch(this.getClass());
-        sourceCodeUrl = Optional.ofNullable(this.getClass().getAnnotation(GithubLink.class))
-            .map(githubLink -> String.format("%s/blob/%s/%s", githubLink.value(),
-                branch, demoFile))
-            .orElse(null);
-      }
-      content = new SplitLayoutDemo(demo, sourceCodeUrl);
+    DemoSource demoSources[] = demo.getClass().getAnnotationsByType(DemoSource.class);
+    List<SourceCodeTab> tabs = new ArrayList<>(demoSources.length);
+    for (DemoSource demoSource : demoSources) {
+      createSourceCodeTab(demo.getClass(), demoSource).ifPresent(tabs::add);
+    }
+    
+    if (!tabs.isEmpty()) {
+      content = new SplitLayoutDemo(demo, tabs);
       currentLayout = (SplitLayoutDemo) content;
       if (splitOrientation != null) {
         setOrientation(splitOrientation);
@@ -216,10 +203,49 @@ public void showRouterLayoutContent(HasElement content) {
       demo.getElement().getStyle().set("height", "100%");
       setupDemoHelperButton(content.getClass());
     }
+    
     updateFooterButtonsVisibility();
     getElement().insertChild(1, content.getElement());
   }
 
+  private Optional<SourceCodeTab> createSourceCodeTab(Class<?> annotatedClass, DemoSource annotation) {
+    String demoFile;
+    String url = annotation.value();
+    if (url.equals(DemoSource.GITHUB_SOURCE)) {
+      String className = annotatedClass.getName().replace('.', '/');
+      demoFile = "src/test/java/" + className + ".java";
+    } else if (url.startsWith("/src/test/")) {
+      demoFile = url.substring(1);
+    } else {
+      demoFile = null;
+    }
+
+    if (demoFile != null) {
+      String branch = lookupGithubBranch(this.getClass());
+      url = Optional.ofNullable(this.getClass().getAnnotation(GithubLink.class))
+          .map(githubLink -> String.format("%s/blob/%s/%s", githubLink.value(),
+              branch, demoFile))
+          .orElse(null);
+    }
+    
+    if (url==null) {
+      return Optional.empty();
+    }
+
+    SourceCodeTab.SourceCodeTabBuilder builder = SourceCodeTab.builder();
+    builder.url(url);
+    
+    if (!annotation.caption().equals(DemoSource.DEFAULT_VALUE)) {
+      builder.caption(annotation.caption());
+    }
+    
+    if (!annotation.language().equals(DemoSource.DEFAULT_VALUE)) {
+      builder.language(annotation.caption());
+    }
+    
+    return Optional.of(builder.build());
+  }
+  
   public static String lookupGithubBranch(Class<? extends TabbedDemo> clazz) {
     GithubBranch branch = clazz.getAnnotation(GithubBranch.class);
     if (branch == null) {

src/test/java/com/flowingcode/vaadin/addons/demo/Demo.java

@@ -34,5 +34,6 @@ public Demo() {
     addDemo(SampleDemoDefault.class);
     addDemo(SampleDemoHighlight.class);
     addDemo(AdHocDemo.class);
+    addDemo(MultiSourceDemo.class);
   }
 }

src/test/java/com/flowingcode/vaadin/addons/demo/MultiSourceDemo.java

@@ -0,0 +1,39 @@
+/*-
+ * #%L
+ * %%
+ * Copyright (C) 2020 - 2023 Flowing Code
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.flowingcode.vaadin.addons.demo;
+
+import com.vaadin.flow.component.dependency.StyleSheet;
+import com.vaadin.flow.component.html.Div;
+import com.vaadin.flow.component.html.Span;
+import com.vaadin.flow.router.PageTitle;
+import com.vaadin.flow.router.Route;
+
+@Route(value = "demo/multisource", layout = Demo.class)
+@PageTitle("Demo with multiple sources")
+@DemoSource
+@DemoSource(value = "/src/test/resources/META-INF/resources/frontend/multi-source-demo.css")
+@StyleSheet("./multi-source-demo.css")
+public class MultiSourceDemo extends Div {
+  public MultiSourceDemo() {
+    Span span = new Span("This is the main source");
+    span.addClassName("custom-style");
+    add(span);
+  }
+
+}

src/test/resources/META-INF/resources/frontend/multi-source-demo.css

@@ -0,0 +1,3 @@
+.custom-style {
+  color: red;		
+}