You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by ah...@apache.org on 2020/12/11 07:27:21 UTC
[isis] branch master updated: ISIS-2473: align class names with the
module's name (j2adoc)
This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/master by this push:
new b0a10b7 ISIS-2473: align class names with the module's name (j2adoc)
b0a10b7 is described below
commit b0a10b7829d12e0481f9b5ee4b28dcd785dee8ea
Author: Andi Huber <ah...@apache.org>
AuthorDate: Fri Dec 11 08:27:08 2020 +0100
ISIS-2473: align class names with the module's name (j2adoc)
---
.../isis/tooling/cli/projdoc/ProjectDocModel.java | 10 +++++-----
.../isis/tooling/cli/projdoc/ProjectDocWriter.java | 4 ++--
.../j2adoc/{J2AContext.java => J2AdocContext.java} | 22 +++++++++++-----------
.../j2adoc/{J2AUnit.java => J2AdocUnit.java} | 16 ++++++++--------
.../j2adoc/{J2AUnits.java => J2AdocUnits.java} | 2 +-
.../apache/isis/tooling/j2adoc/JavaToAsciiDoc.java | 4 ++--
.../j2adoc/test/{J2aTest.java => J2AdocTest.java} | 6 +++---
7 files changed, 32 insertions(+), 32 deletions(-)
diff --git a/tooling/cli/src/main/java/org/apache/isis/tooling/cli/projdoc/ProjectDocModel.java b/tooling/cli/src/main/java/org/apache/isis/tooling/cli/projdoc/ProjectDocModel.java
index 4d7d967..c9b1ad7 100644
--- a/tooling/cli/src/main/java/org/apache/isis/tooling/cli/projdoc/ProjectDocModel.java
+++ b/tooling/cli/src/main/java/org/apache/isis/tooling/cli/projdoc/ProjectDocModel.java
@@ -42,7 +42,7 @@ import org.apache.isis.commons.internal.exceptions._Exceptions;
import org.apache.isis.commons.internal.graph._Graph;
import org.apache.isis.tooling.c4.C4;
import org.apache.isis.tooling.cli.CliConfig;
-import org.apache.isis.tooling.j2adoc.J2AContext;
+import org.apache.isis.tooling.j2adoc.J2AdocContext;
import org.apache.isis.tooling.javamodel.AnalyzerConfigFactory;
import org.apache.isis.tooling.javamodel.ast.CodeClasses;
import org.apache.isis.tooling.model4adoc.AsciiDocFactory;
@@ -87,7 +87,7 @@ public class ProjectDocModel {
modules = new TreeSet<ProjectNode>();
projTree.depthFirst(modules::add);
- val j2aContext = J2AContext.compactFormat()
+ val j2aContext = J2AdocContext.compactFormat()
.xrefPageIdFormat(cliConfig.getDocumentGlobalIndexXrefPageIdFormat())
.build();
@@ -179,7 +179,7 @@ public class ProjectDocModel {
final @NonNull Document doc,
final @NonNull String sectionName,
final @Nullable String groupIdPattern,
- final @NonNull J2AContext j2aContext) {
+ final @NonNull J2AdocContext j2aContext) {
val titleBlock = block(doc);
@@ -275,7 +275,7 @@ public class ProjectDocModel {
sb.append(String.format("%s: %s\n", key, value));
}
- private String details(ProjectNode module, J2AContext j2aContext) {
+ private String details(ProjectNode module, J2AdocContext j2aContext) {
val description = module.getDescription().trim();
val dependencyList = module.getDependencies()
.stream()
@@ -325,7 +325,7 @@ public class ProjectDocModel {
return String.format("* %s\n", element);
}
- private SortedSet<String> gatherGlobalDocIndexXrefs(File projDir, J2AContext j2aContext) {
+ private SortedSet<String> gatherGlobalDocIndexXrefs(File projDir, J2AdocContext j2aContext) {
val analyzerConfig = AnalyzerConfigFactory.maven(projDir, Language.JAVA).main();
diff --git a/tooling/cli/src/main/java/org/apache/isis/tooling/cli/projdoc/ProjectDocWriter.java b/tooling/cli/src/main/java/org/apache/isis/tooling/cli/projdoc/ProjectDocWriter.java
index 2819314..b4cd55c 100644
--- a/tooling/cli/src/main/java/org/apache/isis/tooling/cli/projdoc/ProjectDocWriter.java
+++ b/tooling/cli/src/main/java/org/apache/isis/tooling/cli/projdoc/ProjectDocWriter.java
@@ -23,7 +23,7 @@ import java.io.File;
import org.asciidoctor.ast.Document;
import org.apache.isis.tooling.cli.CliConfig;
-import org.apache.isis.tooling.j2adoc.J2AContext;
+import org.apache.isis.tooling.j2adoc.J2AdocContext;
import org.apache.isis.tooling.model4adoc.AsciiDocWriter;
import lombok.NonNull;
@@ -36,7 +36,7 @@ final class ProjectDocWriter {
static void write(
final @NonNull CliConfig cliConfig,
final @NonNull Document adoc,
- final @NonNull J2AContext j2aContext) {
+ final @NonNull J2AdocContext j2aContext) {
try {
diff --git a/tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AContext.java b/tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AdocContext.java
similarity index 86%
rename from tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AContext.java
rename to tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AdocContext.java
index fd04d1d..bd3d4af 100644
--- a/tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AContext.java
+++ b/tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AdocContext.java
@@ -34,7 +34,7 @@ import lombok.Value;
import lombok.val;
@Value @Builder
-public class J2AContext {
+public class J2AdocContext {
private final @NonNull String xrefPageIdFormat;
@@ -83,9 +83,9 @@ public class J2AContext {
@Builder.Default
private final boolean includeJavaSource = true;
- private final Map<String, J2AUnit> unitIndex = _Maps.newTreeMap();
+ private final Map<String, J2AdocUnit> unitIndex = _Maps.newTreeMap();
- public J2AContext add(final @NonNull J2AUnit unit) {
+ public J2AdocContext add(final @NonNull J2AdocUnit unit) {
val previousKey = unitIndex.put(unit.getName(), unit);
if(previousKey!=null) {
throw _Exceptions.unrecoverableFormatted(
@@ -95,8 +95,8 @@ public class J2AContext {
return this;
}
- public Stream<J2AUnit> add(final @NonNull File sourceFile) {
- return J2AUnit.parse(sourceFile)
+ public Stream<J2AdocUnit> add(final @NonNull File sourceFile) {
+ return J2AdocUnit.parse(sourceFile)
.peek(this::add)
// ensure the stream is consumed here,
// current implementation does not expect more than 1 result per source file
@@ -104,22 +104,22 @@ public class J2AContext {
.stream();
}
- public Stream<J2AUnit> streamUnits() {
+ public Stream<J2AdocUnit> streamUnits() {
return unitIndex.values().stream();
}
- public Optional<J2AUnit> getUnit(String key) {
+ public Optional<J2AdocUnit> getUnit(String key) {
return Optional.ofNullable(unitIndex.get(key));
}
// -- PREDEFINED FORMATS
- public static J2AContextBuilder javaSourceWithFootNotesFormat() {
- return J2AContext.builder();
+ public static J2AdocContextBuilder javaSourceWithFootNotesFormat() {
+ return J2AdocContext.builder();
}
- public static J2AContextBuilder compactFormat() {
- return J2AContext.builder()
+ public static J2AdocContextBuilder compactFormat() {
+ return J2AdocContext.builder()
.constructorFormat("`%1$s(%2$s)`") // name | param-list)
.genericConstructorFormat("`%2$s%1$s(%3$s)`") // method-generic-type | name | param-list)
.methodFormat("`%2$s(%3$s)` : `%1$s`") // return-type | name | param-list)
diff --git a/tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AUnit.java b/tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AdocUnit.java
similarity index 92%
rename from tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AUnit.java
rename to tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AdocUnit.java
index c616024..48cab30 100644
--- a/tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AUnit.java
+++ b/tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AdocUnit.java
@@ -40,11 +40,11 @@ import lombok.extern.log4j.Log4j2;
@Value
@Log4j2
-public class J2AUnit {
+public class J2AdocUnit {
private final ClassOrInterfaceDeclaration td;
- public static Stream<J2AUnit> parse(final @NonNull File sourceFile) {
+ public static Stream<J2AdocUnit> parse(final @NonNull File sourceFile) {
if("package-info.java".equals(sourceFile.getName())) {
// ignore package files
@@ -61,8 +61,8 @@ public class J2AUnit {
return Stream.of(cu)
.flatMap(CompilationUnits::streamPublicTypeDeclarations)
- .filter(J2AUnits::hasIndexDirective)
- .map(J2AUnit::new);
+ .filter(J2AdocUnits::hasIndexDirective)
+ .map(J2AdocUnit::new);
} catch (Exception e) {
log.error("failed to parse java source file {}", sourceFile, e);
@@ -76,13 +76,13 @@ public class J2AUnit {
}
public String getAsciiDocXref(
- final @NonNull J2AContext j2aContext) {
+ final @NonNull J2AdocContext j2aContext) {
val toAdocConverter = JavaToAsciiDoc.of(j2aContext);
return toAdocConverter.xref(this);
}
public Document toAsciiDoc(
- final @NonNull J2AContext j2aContext) {
+ final @NonNull J2AdocContext j2aContext) {
val doc = AsciiDocFactory.doc();
@@ -129,14 +129,14 @@ public class J2AUnit {
cds.forEach(cd->{
java.append(String.format("\n %s // <.>\n",
- J2AUnits.toNormalizedConstructorDeclaration(cd)));
+ J2AdocUnits.toNormalizedConstructorDeclaration(cd)));
});
mds.forEach(md->{
java.append(String.format("\n %s // <.>\n",
- J2AUnits.toNormalizedMethodDeclaration(md)));
+ J2AdocUnits.toNormalizedMethodDeclaration(md)));
});
diff --git a/tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AUnits.java b/tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AdocUnits.java
similarity index 98%
rename from tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AUnits.java
rename to tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AdocUnits.java
index cdcfaa0..781de0b 100644
--- a/tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AUnits.java
+++ b/tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/J2AdocUnits.java
@@ -27,7 +27,7 @@ import org.apache.isis.tooling.javamodel.ast.Javadocs;
import lombok.NonNull;
import lombok.val;
-final class J2AUnits {
+final class J2AdocUnits {
/**
* Whether to include given {@link TypeDeclaration} with the index.
diff --git a/tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/JavaToAsciiDoc.java b/tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/JavaToAsciiDoc.java
index 0893eba..b9c3c05 100644
--- a/tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/JavaToAsciiDoc.java
+++ b/tooling/java2adoc/src/main/java/org/apache/isis/tooling/j2adoc/JavaToAsciiDoc.java
@@ -51,7 +51,7 @@ import lombok.val;
@Value(staticConstructor = "of")
final class JavaToAsciiDoc {
- private final J2AContext j2aContext;
+ private final J2AdocContext j2aContext;
public String constructorDeclaration(final @NonNull ConstructorDeclaration cd) {
val isDeprecated = cd.getAnnotations().stream()
@@ -204,7 +204,7 @@ final class JavaToAsciiDoc {
}
}
- public String xref(final @NonNull J2AUnit unit) {
+ public String xref(final @NonNull J2AdocUnit unit) {
return String.format("xref:%s[%s]",
String.format(j2aContext.getXrefPageIdFormat(), unit.getName()),
unit.getName());
diff --git a/tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2aTest.java b/tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2AdocTest.java
similarity index 97%
rename from tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2aTest.java
rename to tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2AdocTest.java
index c448797..8a77a21 100644
--- a/tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2aTest.java
+++ b/tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2AdocTest.java
@@ -31,7 +31,7 @@ import org.apache.isis.commons.internal.base._Files;
import org.apache.isis.commons.internal.base._Text;
import org.apache.isis.commons.internal.collections._Sets;
import org.apache.isis.commons.internal.functions._Predicates;
-import org.apache.isis.tooling.j2adoc.J2AContext;
+import org.apache.isis.tooling.j2adoc.J2AdocContext;
import org.apache.isis.tooling.j2adoc.util.AsciiDocIncludeTagFilter;
import org.apache.isis.tooling.javamodel.AnalyzerConfigFactory;
@@ -42,7 +42,7 @@ import guru.nidi.codeassert.config.Language;
import static guru.nidi.codeassert.config.Language.JAVA;
-class J2ATest {
+class J2AdocTest {
@Test //@Disabled
void testJavaDocMining() {
@@ -51,7 +51,7 @@ class J2ATest {
.maven(ProjectSampler.apacheIsisApplib(), Language.JAVA)
.main();
- val j2aContext = J2AContext
+ val j2aContext = J2AdocContext
//.javaSourceWithFootNotesFormat()
.compactFormat()
.xrefPageIdFormat("system:generated:index/%s.adoc")