blob: cea9f7a135a46f9d7d3546505118ffd4f52e94e0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
package com.vaadin.tests.server;
import static org.junit.Assert.assertTrue;
import java.io.File;
import java.lang.reflect.Modifier;
import java.net.URISyntaxException;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import org.jsoup.nodes.Document;
import org.jsoup.nodes.Element;
import org.junit.Test;
import com.vaadin.navigator.Navigator;
import com.vaadin.ui.Component;
import com.vaadin.ui.DragAndDropWrapper;
import com.vaadin.ui.components.colorpicker.ColorPickerGradient;
import com.vaadin.ui.components.colorpicker.ColorPickerGrid;
import com.vaadin.ui.components.colorpicker.ColorPickerHistory;
import com.vaadin.ui.components.colorpicker.ColorPickerPopup;
import com.vaadin.ui.components.colorpicker.ColorPickerPreview;
import com.vaadin.ui.components.colorpicker.ColorPickerSelect;
import com.vaadin.ui.declarative.Design;
import com.vaadin.ui.declarative.DesignContext;
/**
* Utility class for outputting the declarative syntax of Vaadin components.
*/
public class ComponentDesignWriterUtility {
private static final Set<String> WHITE_LIST_FQNS = new HashSet<>();
private static final Document document = new Document("");
private static final DesignContext designContext = new DesignContext(
document);
static {
WHITE_LIST_FQNS.add(DragAndDropWrapper.class.getName());
WHITE_LIST_FQNS.add(Navigator.EmptyView.class.getName());
WHITE_LIST_FQNS.add(ColorPickerGradient.class.getName());
WHITE_LIST_FQNS.add(ColorPickerPopup.class.getName());
WHITE_LIST_FQNS.add(ColorPickerPreview.class.getName());
WHITE_LIST_FQNS.add(ColorPickerGrid.class.getName());
WHITE_LIST_FQNS.add(ColorPickerSelect.class.getName());
WHITE_LIST_FQNS.add(ColorPickerHistory.class.getName());
WHITE_LIST_FQNS.add(
com.vaadin.v7.ui.components.colorpicker.ColorPickerGradient.class
.getName());
WHITE_LIST_FQNS.add(
com.vaadin.v7.ui.components.colorpicker.ColorPickerPopup.class
.getName());
WHITE_LIST_FQNS.add(
com.vaadin.v7.ui.components.colorpicker.ColorPickerPreview.class
.getName());
WHITE_LIST_FQNS.add(
com.vaadin.v7.ui.components.colorpicker.ColorPickerGrid.class
.getName());
WHITE_LIST_FQNS.add(
com.vaadin.v7.ui.components.colorpicker.ColorPickerSelect.class
.getName());
WHITE_LIST_FQNS.add(
com.vaadin.v7.ui.components.colorpicker.ColorPickerHistory.class
.getName());
// ==================================================================
// Classes that cannot be loaded
// ==================================================================
WHITE_LIST_FQNS.add(
"com.vaadin.server.communication.PushAtmosphereHandler$AtmosphereResourceListener");
WHITE_LIST_FQNS
.add("com.vaadin.server.communication.PushAtmosphereHandler");
WHITE_LIST_FQNS
.add("com.vaadin.server.communication.PushRequestHandler$1");
WHITE_LIST_FQNS
.add("com.vaadin.server.communication.PushRequestHandler$2");
WHITE_LIST_FQNS.add("com.vaadin.server.LegacyVaadinPortlet");
WHITE_LIST_FQNS.add("com.vaadin.server.RestrictedRenderResponse");
WHITE_LIST_FQNS
.add("com.vaadin.server.VaadinPortlet$VaadinGateInRequest");
WHITE_LIST_FQNS.add(
"com.vaadin.server.VaadinPortlet$VaadinHttpAndPortletRequest");
WHITE_LIST_FQNS
.add("com.vaadin.server.VaadinPortlet$VaadinLiferayRequest");
WHITE_LIST_FQNS.add(
"com.vaadin.server.VaadinPortlet$VaadinWebLogicPortalRequest");
WHITE_LIST_FQNS.add(
"com.vaadin.server.VaadinPortlet$VaadinWebSpherePortalRequest");
WHITE_LIST_FQNS.add("com.vaadin.server.VaadinPortlet");
WHITE_LIST_FQNS.add("com.vaadin.server.VaadinPortletRequest");
designContext.setShouldWriteDefaultValues(true);
}
@SafeVarargs
public static List<String> getDeclarativeSyntax(
Class<? extends Component>... components) {
return getDeclarativeSyntax(Arrays.asList(components));
}
public static List<String> getDeclarativeSyntax(
List<Class<? extends Component>> components) {
List<String> declarativeStrings = components.stream()
.map(ComponentDesignWriterUtility::getDeclarativeSyntax)
.collect(Collectors.toList());
return declarativeStrings;
}
@Test
public void vaadin8ComponentsElementStartsWithVaadinPrefix()
throws URISyntaxException {
assertTrue(getVaadin8Components().stream()
.map(ComponentDesignWriterUtility::getDeclarativeSyntax)
.allMatch(element -> element.startsWith("<vaadin-")));
}
@Test
public void vaadin7ComponentsElementStartsWithVaadinPrefix()
throws URISyntaxException {
assertTrue(getVaadin7Components().stream()
.map(ComponentDesignWriterUtility::getDeclarativeSyntax)
.allMatch(element -> element.startsWith("<vaadin7-")));
}
private static String getDeclarativeSyntax(
Class<? extends Component> componentClass) {
try {
Component component = componentClass.newInstance();
Element element = document.createElement(Design.getComponentMapper()
.componentToTag(component, designContext));
component.writeDesign(element, designContext);
return element.toString();
} catch (Exception e) {
throw new RuntimeException(
"Could not write the declarative syntax for component "
+ componentClass.getName(),
e);
}
}
public static void main(String[] args) throws URISyntaxException {
System.out.println("Vaadin 8 components:");
printFullDeclarativeSyntax(getVaadin8Components());
System.out.println("Vaadin 7 components:");
printFullDeclarativeSyntax(getVaadin7Components());
System.out.println("\nClases that are explicitely excluded from "
+ "the design support introspection:");
WHITE_LIST_FQNS.forEach(System.out::println);
}
private static void printFullDeclarativeSyntax(
List<Class<? extends Component>> components) {
components.stream().forEach(component -> System.out
.println(getDeclarativeSyntax(component)));
}
private static List<Class<? extends Component>> getVaadin8Components()
throws URISyntaxException {
List<Class<? extends Component>> vaadin8Components = getVaadinComponentsFromClasspath(
"/server/target/classes");
if (vaadin8Components.isEmpty()) {
throw new RuntimeException(
"No vaadin 8 components found on your classpath.");
}
return vaadin8Components;
}
private static List<Class<? extends Component>> getVaadin7Components()
throws URISyntaxException {
List<Class<? extends Component>> vaadin7Components = getVaadinComponentsFromClasspath(
"compatibility-server");
if (vaadin7Components.isEmpty()) {
throw new RuntimeException(
"No vaadin 7 components found on your classpath.");
}
return vaadin7Components;
}
@SuppressWarnings("unchecked")
private static List<Class<? extends Component>> getVaadinComponentsFromClasspath(
String classpathFilter) throws URISyntaxException {
File testRoot = new File(
ComponentDesignWriterUtility.class.getResource("/").toURI());
List<Class<? extends Component>> classes = new ClasspathHelper(
WHITE_LIST_FQNS::contains).getVaadinClassesFromClasspath(
entry -> entry.contains(classpathFilter)
&& !testRoot.equals(new File(entry)),
cls -> Component.class.isAssignableFrom(cls)
&& !cls.isInterface()
&& !Modifier.isAbstract(cls.getModifiers()))
.map(cls -> (Class<? extends Component>) cls)
.collect(Collectors.toList());
return classes;
}
}
|
