Java: Make Panel extensible (#562)

* Make Panel extensible * Update tests * Skip test for other languages
grafana · Sep 30, 2024 · 8597003 · 8597003
1 parent cd35dd6
commit 8597003
Show file tree

Hide file tree

Showing 33 changed files with 313 additions and 28 deletions.
diff --git a/internal/jennies/golang/builder_test.go b/internal/jennies/golang/builder_test.go
@@ -14,6 +14,7 @@ func TestBuilder_Generate(t *testing.T) {
 		Name:         "GoBuilder",
 		Skip: map[string]string{
 			"builder_delegation_in_disjunction": "disjunctions are eliminated with compiler passes",
+			"dashboard_panel":                   "this test if for Java generics for dashboard.Panel",
 		},
 	}
 

diff --git a/internal/jennies/java/builders.go b/internal/jennies/java/builders.go
@@ -61,6 +61,7 @@ func (b Builders) genBuilders(pkg string, name string) ([]Builder, bool) {
 			Properties:           builder.Properties,
 			Defaults:             b.genDefaults(builder.Options),
 			ImportAlias:          b.config.PackagePath,
+			IsGeneric:            builder.For.SelfRef.ReferredPkg == "dashboard" && object.Name == "Panel",
 		}
 	}), true
 }

diff --git a/internal/jennies/java/templates/types/builder.tmpl b/internal/jennies/java/templates/types/builder.tmpl
@@ -1,6 +1,6 @@
 {{- define "builder" }}
-    public static class {{ .BuilderName }}Builder implements {{ if not (eq .Builder.ImportAlias "") }}{{ .Builder.ImportAlias }}.{{ end }}cog.Builder<{{ .Builder.BuilderSignatureType }}> {
-        private final {{ .Builder.ObjectName }} internal;
+    public static class {{ .BuilderName }}Builder{{ if .Builder.IsGeneric }}<T extends {{ .BuilderName }}Builder<T>>{{ end }} implements {{ if not (eq .Builder.ImportAlias "") }}{{ .Builder.ImportAlias }}.{{ end }}cog.Builder<{{ .Builder.BuilderSignatureType }}> {
+        protected final {{ .Builder.ObjectName }} internal;
 
         {{- range .Builder.Properties }}
         private {{ .Type | formatBuilderFieldType }} {{ .Name | escapeVar }};
@@ -25,11 +25,11 @@
         }
 
     {{- range $opt := .Builder.Options }}
-    public {{ $.BuilderName }}Builder {{ .Name | lowerCamelCase | escapeVar }}({{- template "args" .Args }}) {
+    public {{ if $.Builder.IsGeneric }}T {{ else }}{{ $.BuilderName }}Builder {{ end }}{{ .Name | lowerCamelCase | escapeVar }}({{- template "args" .Args }}) {
         {{- range .Assignments }}
             {{- template "assignment" (dict "Assignment" . "BuilderName" $.Builder.BuilderName "OptionName" $opt.Name) }}
         {{- end }}
-        return this;
+        return {{ if $.Builder.IsGeneric }}(T) {{ end }}this;
     }
     {{ end -}}
 

diff --git a/internal/jennies/java/tmpl.go b/internal/jennies/java/tmpl.go
@@ -129,6 +129,7 @@ type Builder struct {
 	Properties           []ast.StructField
 	Options              []ast.Option
 	Defaults             []OptionCall
+	IsGeneric            bool
 }
 
 type OptionCall struct {

diff --git a/internal/jennies/php/builder_test.go b/internal/jennies/php/builder_test.go
@@ -12,6 +12,9 @@ func TestBuilder_Generate(t *testing.T) {
 	test := testutils.GoldenFilesTestSuite[languages.Context]{
 		TestDataRoot: "../../../testdata/jennies/builders",
 		Name:         "PHPBuilder",
+		Skip: map[string]string{
+			"dashboard_panel": "this test if for Java generics for dashboard.Panel",
+		},
 	}
 
 	config := Config{

diff --git a/internal/jennies/python/builder_test.go b/internal/jennies/python/builder_test.go
@@ -14,6 +14,7 @@ func TestBuilder_Generate(t *testing.T) {
 		Name:         "PythonBuilder",
 		Skip: map[string]string{
 			"anonymous_struct": "Anonymous structs are not supported in Python",
+			"dashboard_panel":  "this test if for Java generics for dashboard.Panel",
 		},
 	}
 

diff --git a/internal/jennies/typescript/builder_test.go b/internal/jennies/typescript/builder_test.go
@@ -12,6 +12,9 @@ func TestBuilder_Generate(t *testing.T) {
 	test := testutils.GoldenFilesTestSuite[languages.Context]{
 		TestDataRoot: "../../../testdata/jennies/builders",
 		Name:         "TypescriptBuilder",
+		Skip: map[string]string{
+			"dashboard_panel": "this test if for Java generics for dashboard.Panel",
+		},
 	}
 
 	language := New(Config{})

diff --git a/testdata/jennies/builders/anonymous_struct/JavaBuilders/anonymous_struct/SomeStruct.java b/testdata/jennies/builders/anonymous_struct/JavaBuilders/anonymous_struct/SomeStruct.java
@@ -18,7 +18,7 @@ public String toJSON() throws JsonProcessingException {
 
 
     public static class Builder implements cog.Builder<SomeStruct> {
-        private final SomeStruct internal;
+        protected final SomeStruct internal;
 
         public Builder() {
             this.internal = new SomeStruct();

diff --git a/testdata/jennies/builders/array_append/JavaBuilders/sandbox/SomeStruct.java b/testdata/jennies/builders/array_append/JavaBuilders/sandbox/SomeStruct.java
@@ -21,7 +21,7 @@ public String toJSON() throws JsonProcessingException {
 
 
     public static class Builder implements cog.Builder<SomeStruct> {
-        private final SomeStruct internal;
+        protected final SomeStruct internal;
 
         public Builder() {
             this.internal = new SomeStruct();

diff --git a/testdata/jennies/builders/basic_struct/JavaBuilders/basic_struct/SomeStruct.java b/testdata/jennies/builders/basic_struct/JavaBuilders/basic_struct/SomeStruct.java
@@ -30,7 +30,7 @@ public String toJSON() throws JsonProcessingException {
 
 
     public static class Builder implements cog.Builder<SomeStruct> {
-        private final SomeStruct internal;
+        protected final SomeStruct internal;
 
         public Builder() {
             this.internal = new SomeStruct();

diff --git a/...jennies/builders/basic_struct_defaults/JavaBuilders/basic_struct_defaults/SomeStruct.java b/...jennies/builders/basic_struct_defaults/JavaBuilders/basic_struct_defaults/SomeStruct.java
@@ -26,7 +26,7 @@ public String toJSON() throws JsonProcessingException {
 
 
     public static class Builder implements cog.Builder<SomeStruct> {
-        private final SomeStruct internal;
+        protected final SomeStruct internal;
 
         public Builder() {
             this.internal = new SomeStruct();

diff --git a/testdata/jennies/builders/builder_delegation/JavaBuilders/builder_delegation/Dashboard.java b/testdata/jennies/builders/builder_delegation/JavaBuilders/builder_delegation/Dashboard.java
@@ -34,7 +34,7 @@ public String toJSON() throws JsonProcessingException {
 
 
     public static class Builder implements cog.Builder<Dashboard> {
-        private final Dashboard internal;
+        protected final Dashboard internal;
 
         public Builder() {
             this.internal = new Dashboard();

diff --git a/...ta/jennies/builders/builder_delegation/JavaBuilders/builder_delegation/DashboardLink.java b/...ta/jennies/builders/builder_delegation/JavaBuilders/builder_delegation/DashboardLink.java
@@ -18,7 +18,7 @@ public String toJSON() throws JsonProcessingException {
 
 
     public static class Builder implements cog.Builder<DashboardLink> {
-        private final DashboardLink internal;
+        protected final DashboardLink internal;
 
         public Builder() {
             this.internal = new DashboardLink();

diff --git a/...r_delegation_in_disjunction/JavaBuilders/builder_delegation_in_disjunction/Dashboard.java b/...r_delegation_in_disjunction/JavaBuilders/builder_delegation_in_disjunction/Dashboard.java
@@ -26,7 +26,7 @@ public String toJSON() throws JsonProcessingException {
 
 
     public static class Builder implements cog.Builder<Dashboard> {
-        private final Dashboard internal;
+        protected final Dashboard internal;
 
         public Builder() {
             this.internal = new Dashboard();

diff --git a/...legation_in_disjunction/JavaBuilders/builder_delegation_in_disjunction/DashboardLink.java b/...legation_in_disjunction/JavaBuilders/builder_delegation_in_disjunction/DashboardLink.java
@@ -18,7 +18,7 @@ public String toJSON() throws JsonProcessingException {
 
 
     public static class Builder implements cog.Builder<DashboardLink> {
-        private final DashboardLink internal;
+        protected final DashboardLink internal;
 
         public Builder() {
             this.internal = new DashboardLink();

diff --git a/...elegation_in_disjunction/JavaBuilders/builder_delegation_in_disjunction/ExternalLink.java b/...elegation_in_disjunction/JavaBuilders/builder_delegation_in_disjunction/ExternalLink.java
@@ -16,7 +16,7 @@ public String toJSON() throws JsonProcessingException {
 
 
     public static class Builder implements cog.Builder<ExternalLink> {
-        private final ExternalLink internal;
+        protected final ExternalLink internal;
 
         public Builder() {
             this.internal = new ExternalLink();

diff --git a/testdata/jennies/builders/composable_slot/JavaBuilders/composable_slot/Dashboard.java b/testdata/jennies/builders/composable_slot/JavaBuilders/composable_slot/Dashboard.java
@@ -25,7 +25,7 @@ public String toJSON() throws JsonProcessingException {
 
 
     public static class Builder implements cog.Builder<Dashboard> {
-        private final Dashboard internal;
+        protected final Dashboard internal;
 
         public Builder() {
             this.internal = new Dashboard();

diff --git a/testdata/jennies/builders/constant_assignment/JavaBuilders/sandbox/SomeStruct.java b/testdata/jennies/builders/constant_assignment/JavaBuilders/sandbox/SomeStruct.java
@@ -20,7 +20,7 @@ public String toJSON() throws JsonProcessingException {
 
 
     public static class Builder implements cog.Builder<SomeStruct> {
-        private final SomeStruct internal;
+        protected final SomeStruct internal;
 
         public Builder() {
             this.internal = new SomeStruct();

diff --git a/testdata/jennies/builders/constraints/JavaBuilders/constraints/SomeStruct.java b/testdata/jennies/builders/constraints/JavaBuilders/constraints/SomeStruct.java
@@ -18,7 +18,7 @@ public String toJSON() throws JsonProcessingException {
 
 
     public static class Builder implements cog.Builder<SomeStruct> {
-        private final SomeStruct internal;
+        protected final SomeStruct internal;
 
         public Builder() {
             this.internal = new SomeStruct();

diff --git a/testdata/jennies/builders/constructor_argument/JavaBuilders/sandbox/SomeStruct.java b/testdata/jennies/builders/constructor_argument/JavaBuilders/sandbox/SomeStruct.java
@@ -16,7 +16,7 @@ public String toJSON() throws JsonProcessingException {
 
 
     public static class Builder implements cog.Builder<SomeStruct> {
-        private final SomeStruct internal;
+        protected final SomeStruct internal;
 
         public Builder(String title) {
             this.internal = new SomeStruct();

diff --git a/...lders/constructor_initializations/JavaBuilders/constructor_initializations/SomePanel.java b/...lders/constructor_initializations/JavaBuilders/constructor_initializations/SomePanel.java
@@ -22,7 +22,7 @@ public String toJSON() throws JsonProcessingException {
 
 
     public static class Builder implements cog.Builder<SomePanel> {
-        private final SomePanel internal;
+        protected final SomePanel internal;
 
         public Builder() {
             this.internal = new SomePanel();

diff --git a/testdata/jennies/builders/dashboard_panel/JavaBuilders/dashboard/Panel.java b/testdata/jennies/builders/dashboard_panel/JavaBuilders/dashboard/Panel.java
@@ -0,0 +1,33 @@
+package dashboard;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.ObjectWriter;
+
+public class Panel {
+    @JsonProperty("onlyFromThisDashboard")
+    public Boolean onlyFromThisDashboard;
+
+    public String toJSON() throws JsonProcessingException {
+        ObjectWriter ow = new ObjectMapper().writer().withDefaultPrettyPrinter();
+        return ow.writeValueAsString(this);
+    }
+
+
+    public static class Builder<T extends Builder<T>> implements cog.Builder<Panel> {
+        protected final Panel internal;
+
+        public Builder() {
+            this.internal = new Panel();
+        this.onlyFromThisDashboard(false);
+        }
+    public T onlyFromThisDashboard(Boolean onlyFromThisDashboard) {
+    this.internal.onlyFromThisDashboard = onlyFromThisDashboard;
+        return (T) this;
+    }
+    public Panel build() {
+            return this.internal;
+        }
+    }
+}