You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by lz...@apache.org on 2023/02/16 01:19:26 UTC
[flink-table-store] branch master updated: [FLINK-31088] flink free for flink-table-store-docs
This is an automated email from the ASF dual-hosted git repository.
lzljs3620320 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink-table-store.git
The following commit(s) were added to refs/heads/master by this push:
new 61ddbde6 [FLINK-31088] flink free for flink-table-store-docs
61ddbde6 is described below
commit 61ddbde6ec113cf82bc8d34843bb25c1e80fd165
Author: Shammon FY <zj...@gmail.com>
AuthorDate: Thu Feb 16 09:19:20 2023 +0800
[FLINK-31088] flink free for flink-table-store-docs
This closes #541
---
flink-table-store-docs/pom.xml | 14 ----------
.../configuration/ConfigOptionsDocGenerator.java | 31 +++++++++++-----------
.../ConfigOptionsDocGeneratorTest.java | 26 ++++++++++--------
.../ConfigOptionsDocsCompletenessITCase.java | 6 ++---
4 files changed, 33 insertions(+), 44 deletions(-)
diff --git a/flink-table-store-docs/pom.xml b/flink-table-store-docs/pom.xml
index 4bcf8ff3..92621957 100644
--- a/flink-table-store-docs/pom.xml
+++ b/flink-table-store-docs/pom.xml
@@ -51,20 +51,6 @@ under the License.
<scope>provided</scope>
</dependency>
- <dependency>
- <groupId>org.apache.flink</groupId>
- <artifactId>flink-core</artifactId>
- <version>${flink.version}</version>
- <scope>provided</scope>
- </dependency>
-
- <dependency>
- <groupId>org.apache.flink</groupId>
- <artifactId>flink-table-common</artifactId>
- <version>${flink.version}</version>
- <scope>provided</scope>
- </dependency>
-
<!-- Test -->
<dependency>
<!-- Used for parsing HTML -->
diff --git a/flink-table-store-docs/src/main/java/org/apache/flink/table/store/docs/configuration/ConfigOptionsDocGenerator.java b/flink-table-store-docs/src/main/java/org/apache/flink/table/store/docs/configuration/ConfigOptionsDocGenerator.java
index 21149289..5fc03d20 100644
--- a/flink-table-store-docs/src/main/java/org/apache/flink/table/store/docs/configuration/ConfigOptionsDocGenerator.java
+++ b/flink-table-store-docs/src/main/java/org/apache/flink/table/store/docs/configuration/ConfigOptionsDocGenerator.java
@@ -18,11 +18,10 @@
package org.apache.flink.table.store.docs.configuration;
-import org.apache.flink.annotation.VisibleForTesting;
-import org.apache.flink.api.java.tuple.Tuple2;
import org.apache.flink.table.store.annotation.ConfigGroup;
import org.apache.flink.table.store.annotation.ConfigGroups;
import org.apache.flink.table.store.annotation.Documentation;
+import org.apache.flink.table.store.annotation.VisibleForTesting;
import org.apache.flink.table.store.options.ConfigOption;
import org.apache.flink.table.store.options.description.DescribedEnum;
import org.apache.flink.table.store.options.description.Description;
@@ -30,6 +29,7 @@ import org.apache.flink.table.store.options.description.Formatter;
import org.apache.flink.table.store.options.description.HtmlFormatter;
import org.apache.flink.table.store.options.description.InlineElement;
import org.apache.flink.table.store.options.description.TextElement;
+import org.apache.flink.table.store.utils.Pair;
import org.apache.flink.table.store.utils.ThrowingConsumer;
import org.apache.flink.table.store.utils.TimeUtils;
@@ -154,13 +154,12 @@ public class ConfigOptionsDocGenerator {
}
return Arrays.stream(sections)
- .map(section -> Tuple2.of(section, option));
+ .map(section -> Pair.of(section, option));
})
.collect(
Collectors.groupingBy(
- option -> option.f0,
- Collectors.mapping(
- option -> option.f1, Collectors.toList())));
+ Pair::getLeft,
+ Collectors.mapping(Pair::getRight, Collectors.toList())));
optionsGroupedBySection.forEach(
(section, options) -> {
@@ -226,10 +225,10 @@ public class ConfigOptionsDocGenerator {
packageName,
ConfigOptionsDocGenerator.DEFAULT_PATH_PREFIX,
optionsClass -> {
- List<Tuple2<ConfigGroup, String>> tables = generateTablesForClass(optionsClass);
- for (Tuple2<ConfigGroup, String> group : tables) {
+ List<Pair<ConfigGroup, String>> tables = generateTablesForClass(optionsClass);
+ for (Pair<ConfigGroup, String> group : tables) {
String name;
- if (group.f0 == null) {
+ if (group.getLeft() == null) {
Matcher matcher =
CLASS_NAME_PATTERN.matcher(optionsClass.getSimpleName());
if (!matcher.matches()) {
@@ -240,12 +239,12 @@ public class ConfigOptionsDocGenerator {
}
name = matcher.group(CLASS_PREFIX_GROUP);
} else {
- name = group.f0.name();
+ name = group.getLeft().name();
}
String outputFile = toSnakeCase(name) + "_configuration.html";
Files.write(
Paths.get(outputDirectory, outputFile),
- group.f1.getBytes(StandardCharsets.UTF_8));
+ group.getRight().getBytes(StandardCharsets.UTF_8));
}
});
}
@@ -277,13 +276,13 @@ public class ConfigOptionsDocGenerator {
}
@VisibleForTesting
- static List<Tuple2<ConfigGroup, String>> generateTablesForClass(Class<?> optionsClass) {
+ static List<Pair<ConfigGroup, String>> generateTablesForClass(Class<?> optionsClass) {
ConfigGroups configGroups = optionsClass.getAnnotation(ConfigGroups.class);
List<OptionWithMetaInfo> allOptions = extractConfigOptions(optionsClass);
if (allOptions.isEmpty()) {
return Collections.emptyList();
}
- List<Tuple2<ConfigGroup, String>> tables;
+ List<Pair<ConfigGroup, String>> tables;
if (configGroups != null) {
tables = new ArrayList<>(configGroups.groups().length + 1);
Tree tree = new Tree(configGroups.groups(), allOptions);
@@ -291,17 +290,17 @@ public class ConfigOptionsDocGenerator {
List<OptionWithMetaInfo> configOptions = tree.findConfigOptions(group);
if (!configOptions.isEmpty()) {
sortOptions(configOptions);
- tables.add(Tuple2.of(group, toHtmlTable(configOptions)));
+ tables.add(Pair.of(group, toHtmlTable(configOptions)));
}
}
List<OptionWithMetaInfo> configOptions = tree.getDefaultOptions();
if (!configOptions.isEmpty()) {
sortOptions(configOptions);
- tables.add(Tuple2.of(null, toHtmlTable(configOptions)));
+ tables.add(Pair.of(null, toHtmlTable(configOptions)));
}
} else {
sortOptions(allOptions);
- tables = Collections.singletonList(Tuple2.of(null, toHtmlTable(allOptions)));
+ tables = Collections.singletonList(Pair.of(null, toHtmlTable(allOptions)));
}
return tables;
}
diff --git a/flink-table-store-docs/src/test/java/org/apache/flink/table/store/docs/configuration/ConfigOptionsDocGeneratorTest.java b/flink-table-store-docs/src/test/java/org/apache/flink/table/store/docs/configuration/ConfigOptionsDocGeneratorTest.java
index d3d9a6dc..8f36de42 100644
--- a/flink-table-store-docs/src/test/java/org/apache/flink/table/store/docs/configuration/ConfigOptionsDocGeneratorTest.java
+++ b/flink-table-store-docs/src/test/java/org/apache/flink/table/store/docs/configuration/ConfigOptionsDocGeneratorTest.java
@@ -18,7 +18,6 @@
package org.apache.flink.table.store.docs.configuration;
-import org.apache.flink.api.java.tuple.Tuple2;
import org.apache.flink.table.store.annotation.ConfigGroup;
import org.apache.flink.table.store.annotation.ConfigGroups;
import org.apache.flink.table.store.annotation.Documentation;
@@ -30,6 +29,7 @@ import org.apache.flink.table.store.options.description.DescribedEnum;
import org.apache.flink.table.store.options.description.Formatter;
import org.apache.flink.table.store.options.description.HtmlFormatter;
import org.apache.flink.table.store.options.description.InlineElement;
+import org.apache.flink.table.store.utils.Pair;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
@@ -194,7 +194,7 @@ class ConfigOptionsDocGeneratorTest {
final String htmlTable =
ConfigOptionsDocGenerator.generateTablesForClass(TypeTestConfigGroup.class)
.get(0)
- .f1;
+ .getRight();
assertThat(htmlTable).isEqualTo(expectedTable);
}
@@ -226,7 +226,9 @@ class ConfigOptionsDocGeneratorTest {
+ " </tbody>\n"
+ "</table>\n";
final String htmlTable =
- ConfigOptionsDocGenerator.generateTablesForClass(TestConfigGroup.class).get(0).f1;
+ ConfigOptionsDocGenerator.generateTablesForClass(TestConfigGroup.class)
+ .get(0)
+ .getRight();
assertThat(htmlTable).isEqualTo(expectedTable);
}
@@ -267,12 +269,13 @@ class ConfigOptionsDocGeneratorTest {
@Test
void testLongestPrefixMatching() {
- final List<Tuple2<ConfigGroup, String>> tables =
+ final List<Pair<ConfigGroup, String>> tables =
ConfigOptionsDocGenerator.generateTablesForClass(TestConfigPrefix.class);
assertThat(tables).hasSize(3);
final Map<String, String> tablesConverted = new HashMap<>(tables.size());
- for (final Tuple2<ConfigGroup, String> table : tables) {
- tablesConverted.put(table.f0 != null ? table.f0.name() : "default", table.f1);
+ for (final Pair<ConfigGroup, String> table : tables) {
+ tablesConverted.put(
+ table.getLeft() != null ? table.getLeft().name() : "default", table.getRight());
}
assertThat(tablesConverted.get("group1"))
.contains("a.b.option", "a.b.c.option", "a.b.c.e.option")
@@ -314,12 +317,13 @@ class ConfigOptionsDocGeneratorTest {
@Test
void testCreatingMultipleGroups() {
- final List<Tuple2<ConfigGroup, String>> tables =
+ final List<Pair<ConfigGroup, String>> tables =
ConfigOptionsDocGenerator.generateTablesForClass(TestConfigMultipleSubGroup.class);
assertThat(tables).hasSize(3);
final HashMap<String, String> tablesConverted = new HashMap<>();
- for (Tuple2<ConfigGroup, String> table : tables) {
- tablesConverted.put(table.f0 != null ? table.f0.name() : "default", table.f1);
+ for (Pair<ConfigGroup, String> table : tables) {
+ tablesConverted.put(
+ table.getLeft() != null ? table.getLeft().name() : "default", table.getRight());
}
assertThat(tablesConverted)
.containsEntry(
@@ -439,7 +443,7 @@ class ConfigOptionsDocGeneratorTest {
ConfigOptionsDocGenerator.generateTablesForClass(
TestConfigGroupWithOverriddenDefault.class)
.get(0)
- .f1;
+ .getRight();
assertThat(htmlTable).isEqualTo(expectedTable);
}
@@ -573,7 +577,7 @@ class ConfigOptionsDocGeneratorTest {
final String htmlTable =
ConfigOptionsDocGenerator.generateTablesForClass(TestConfigGroupWithExclusion.class)
.get(0)
- .f1;
+ .getRight();
assertThat(htmlTable).isEqualTo(expectedTable);
}
diff --git a/flink-table-store-docs/src/test/java/org/apache/flink/table/store/docs/configuration/ConfigOptionsDocsCompletenessITCase.java b/flink-table-store-docs/src/test/java/org/apache/flink/table/store/docs/configuration/ConfigOptionsDocsCompletenessITCase.java
index f76b2161..c9a7288c 100644
--- a/flink-table-store-docs/src/test/java/org/apache/flink/table/store/docs/configuration/ConfigOptionsDocsCompletenessITCase.java
+++ b/flink-table-store-docs/src/test/java/org/apache/flink/table/store/docs/configuration/ConfigOptionsDocsCompletenessITCase.java
@@ -18,9 +18,9 @@
package org.apache.flink.table.store.docs.configuration;
-import org.apache.flink.api.java.tuple.Tuple2;
import org.apache.flink.table.store.annotation.Documentation;
import org.apache.flink.table.store.options.ConfigOption;
+import org.apache.flink.table.store.utils.Pair;
import org.jsoup.Jsoup;
import org.jsoup.nodes.Document;
@@ -134,9 +134,9 @@ public class ConfigOptionsDocsCompletenessITCase {
})
.get());
}
- return new Tuple2<>(entry.getKey(), consolidated);
+ return Pair.of(entry.getKey(), consolidated);
})
- .collect(Collectors.toMap((t) -> t.f0, (t) -> t.f1));
+ .collect(Collectors.toMap(Pair::getLeft, Pair::getRight));
}
private static void compareDocumentedAndExistingOptions(