honeymoose/playwright-java
1
0
Fork 0
mirror of synced 2026-09-11 00:49:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: extract some option classes to top level (#273)

Browse Source
This commit is contained in:
Yury Semikhatsky
2021-02-09 17:15:09 -08:00
committed by GitHub
parent 7642097291
commit 429f2969aa
20 changed files with 495 additions and 693 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tools/api-generator/src/main/java/com/microsoft/playwright/tools/ApiGenerator.java
+45 -55
View File
@@ -62,6 +62,10 @@ abstract class Element {
return parent.enums();
}
Map<String, NestedClass> topLevelClasses() {
return parent.topLevelClasses();
}
static String toTitle(String name) {
return Character.toUpperCase(name.charAt(0)) + name.substring(1);
}
@@ -211,8 +215,6 @@ class TypeRef extends Element {
if (parent instanceof Field) {
customType = toTitle(parent.jsonName);
} else {
// String typeExpression = typeExpression(jsonElement.getAsJsonObject());
// System.out.println("add(\"" + parentPath + "\", \"" + typeExpression + "\", \"" + typeExpression + "\");" );
customType = toTitle(parent.parent.jsonName) + toTitle(parent.jsonName);
}
} else {
@@ -227,8 +229,12 @@ class TypeRef extends Element {
}
}
if (generatedType == GeneratedType.CLASS) {
typeScope().createNestedClass(customType, this, jsonElement.getAsJsonObject());
isNestedClass = true;
if (parent instanceof Field ) {
typeScope().createTopLevelClass(customType, this, jsonElement.getAsJsonObject());
} else {
typeScope().createNestedClass(customType, this, jsonElement.getAsJsonObject());
isNestedClass = true;
}
}
}
@@ -427,6 +433,15 @@ abstract class TypeDefinition extends Element {
}
}
void createTopLevelClass(String name, Element parent, JsonObject jsonObject) {
Map<String, NestedClass> map = topLevelClasses();
if (map.containsKey(name)) {
// TODO: check equal
return;
}
map.put(name, new NestedClass(parent, name, jsonObject));
}
void createNestedClass(String name, Element parent, JsonObject jsonObject) {
for (NestedClass c : classes) {
if (c.name.equals(name)) {
@@ -818,7 +833,7 @@ class Field extends Element {
output.add(offset + " this.position = position;");
output.add(offset + " return this;");
output.add(offset + "}");
output.add(offset + "public " + parentClass + " withPosition(int x, int y) {");
output.add(offset + "public " + parentClass + " withPosition(double x, double y) {");
output.add(offset + " return withPosition(new Position(x, y));");
output.add(offset + "}");
return;
@@ -868,6 +883,7 @@ class Interface extends TypeDefinition {
private final List<Method> methods = new ArrayList<>();
private final List<Event> events = new ArrayList<>();
private final Map<String, Enum> enums;
private final Map<String, NestedClass> topLevelClasses;
static final String header = "/*\n" +
" * Copyright (c) Microsoft Corporation.\n" +
" *\n" +
@@ -889,9 +905,10 @@ class Interface extends TypeDefinition {
private static Set<String> allowedBaseInterfaces = new HashSet<>(asList("Browser", "JSHandle", "BrowserContext"));
private static Set<String> autoCloseableInterfaces = new HashSet<>(asList("Playwright", "Browser", "BrowserContext", "Page"));
Interface(JsonObject jsonElement, Map<String, Enum> enums) {
Interface(JsonObject jsonElement, Map<String, Enum> enums, Map<String, NestedClass> topLevelClasses) {
super(null, jsonElement);
this.enums = enums;
this.topLevelClasses = topLevelClasses;
for (JsonElement item : jsonElement.getAsJsonArray("members")) {
JsonObject memberJson = item.getAsJsonObject();
switch (memberJson.get("kind").getAsString()) {
@@ -916,6 +933,10 @@ class Interface extends TypeDefinition {
return enums;
}
Map<String, NestedClass> topLevelClasses() {
return topLevelClasses;
}
void writeTo(List<String> output, String offset) {
output.add(header);
if ("Playwright".equals(jsonName)) {
@@ -1032,48 +1053,6 @@ class Interface extends TypeDefinition {
output.add("");
break;
}
case "BrowserContext": {
output.add(offset + "class HTTPCredentials {");
output.add(offset + " private final String username;");
output.add(offset + " private final String password;");
output.add("");
output.add(offset + " public HTTPCredentials(String username, String password) {");
output.add(offset + " this.username = username;");
output.add(offset + " this.password = password;");
output.add(offset + " }");
output.add("");
output.add(offset + " public String username() {");
output.add(offset + " return username;");
output.add(offset + " }");
output.add("");
output.add(offset + " public String password() {");
output.add(offset + " return password;");
output.add(offset + " }");
output.add(offset + "}");
output.add("");
break;
}
case "Browser": {
output.add(offset + "class VideoSize {");
output.add(offset + " private final int width;");
output.add(offset + " private final int height;");
output.add("");
output.add(offset + " public VideoSize(int width, int height) {");
output.add(offset + " this.width = width;");
output.add(offset + " this.height = height;");
output.add(offset + " }");
output.add("");
output.add(offset + " public int width() {");
output.add(offset + " return width;");
output.add(offset + " }");
output.add("");
output.add(offset + " public int height() {");
output.add(offset + " return height;");
output.add(offset + " }");
output.add(offset + "}");
output.add("");
break;
}
case "ElementHandle": {
output.add(offset + "class BoundingBox {");
output.add(offset + " public double x;");
@@ -1158,6 +1137,9 @@ class NestedClass extends TypeDefinition {
}
void writeTo(List<String> output, String offset) {
if (asList("RecordHar", "RecordVideo").contains(name)) {
output.add("import java.nio.file.Path;");
}
String access = parent.typeScope() instanceof NestedClass ? "public " : "";
output.add(offset + access + "class " + name + " {");
String bodyOffset = offset + " ";
@@ -1174,6 +1156,9 @@ class NestedClass extends TypeDefinition {
f.writeGetter(output, bodyOffset);
}
} else {
if (parent.parent instanceof Field) {
writeConstructor(output, bodyOffset);
}
writeBuilderMethods(output, bodyOffset);
if (asList("Browser.newContext.options",
"Browser.newPage.options",
@@ -1186,13 +1171,8 @@ class NestedClass extends TypeDefinition {
private void writeBuilderMethods(List<String> output, String bodyOffset) {
if (parent.typeScope() instanceof NestedClass) {
NestedClass outer = (NestedClass) parent.typeScope();
output.add(bodyOffset + name + "() {");
output.add(bodyOffset + "public " + name + "() {");
output.add(bodyOffset + "}");
output.add(bodyOffset + "public " + outer.name + " done() {");
output.add(bodyOffset + " return " + outer.name + ".this;");
output.add(bodyOffset + "}");
output.add("");
}
for (Field f : fields) {
f.writeBuilderMethod(output, bodyOffset, name);
@@ -1255,10 +1235,11 @@ public class ApiGenerator {
System.out.println("Writing files to: " + dir.getCanonicalPath());
filterOtherLangs(api);
Map<String, Enum> enums = new HashMap<>();
Map<String, NestedClass> topLevelClasses = new HashMap<>();
for (JsonElement entry: api) {
String name = entry.getAsJsonObject().get("name").getAsString();
List<String> lines = new ArrayList<>();
new Interface(entry.getAsJsonObject(), enums).writeTo(lines, "");
new Interface(entry.getAsJsonObject(), enums, topLevelClasses).writeTo(lines, "");
String text = String.join("\n", lines);
try (FileWriter writer = new FileWriter(new File(dir, name + ".java"))) {
writer.write(text);
@@ -1274,6 +1255,15 @@ public class ApiGenerator {
writer.write(text);
}
}
for (NestedClass e : topLevelClasses.values()) {
List<String> lines = new ArrayList<>();
lines.add(Interface.header.replace("package com.microsoft.playwright;", "package com.microsoft.playwright.options;"));
e.writeTo(lines, "");
String text = String.join("\n", lines);
try (FileWriter writer = new FileWriter(new File(dir, e.name + ".java"))) {
writer.write(text);
}
}
}
private static void filterOtherLangs(JsonElement json) {
tools/api-generator/src/main/java/com/microsoft/playwright/tools/Types.java
-21
View File
@@ -52,16 +52,6 @@ class Types {
add("Page.viewportSize", "Object|null", "Viewport", new Empty());
add("BrowserType.launchPersistentContext.options.viewport", "Object|null", "Page.Viewport", new Empty());
// RecordVideo size.
add("Browser.newContext.options.recordVideo.size", "Object", "VideoSize", new Empty());
add("Browser.newPage.options.recordVideo.size", "Object", "VideoSize", new Empty());
add("BrowserType.launchPersistentContext.recordVideo.size", "Object", "Browser.VideoSize", new Empty());
// HTTP credentials.
add("Browser.newContext.options.httpCredentials", "Object", "BrowserContext.HTTPCredentials", new Empty());
add("Browser.newPage.options.httpCredentials", "Object", "BrowserContext.HTTPCredentials", new Empty());
add("BrowserType.launchPersistentContext.options.httpCredentials", "Object", "BrowserContext.HTTPCredentials", new Empty());
add("BrowserContext.exposeBinding.callback", "function", "Page.Binding");
add("BrowserContext.exposeFunction.callback", "function", "Page.Function");
add("Page.exposeBinding.callback", "function", "Binding");
@@ -75,17 +65,6 @@ class Types {
add("ConsoleMessage.location", "Object", "Location");
add("ElementHandle.boundingBox", "Object|null", "BoundingBox", new Empty());
// Custom options
add("Page.click.options.position", "Object", "Position", new Empty());
add("Page.dblclick.options.position", "Object", "Position", new Empty());
add("Page.hover.options.position", "Object", "Position", new Empty());
add("Frame.click.options.position", "Object", "Position", new Empty());
add("Frame.dblclick.options.position", "Object", "Position", new Empty());
add("Frame.hover.options.position", "Object", "Position", new Empty());
add("ElementHandle.click.options.position", "Object", "Position", new Empty());
add("ElementHandle.dblclick.options.position", "Object", "Position", new Empty());
add("ElementHandle.hover.options.position", "Object", "Position", new Empty());
// The method has custom signatures
add("BrowserContext.cookies", "Array<Object>", "Cookie");
add("BrowserContext.cookies.sameSite", "\"Lax\"|\"None\"|\"Strict\"", "SameSite", new Empty());