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 06:56:46 UTC
[isis] branch master updated: ISIS-2473: align var names
'doclet'->'unit'
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 d53bd8a ISIS-2473: align var names 'doclet'->'unit'
d53bd8a is described below
commit d53bd8a97b31d1025854f6082e14709bf1000bce
Author: Andi Huber <ah...@apache.org>
AuthorDate: Fri Dec 11 07:56:30 2020 +0100
ISIS-2473: align var names 'doclet'->'unit'
---
.../org/apache/isis/tooling/cli/CliConfig.java | 8 ++---
.../isis/tooling/cli/projdoc/ProjectDocModel.java | 28 +++++++--------
.../isis/tooling/cli/projdoc/ProjectDocWriter.java | 12 +++----
.../org/apache/isis/tooling/j2adoc/J2aContext.java | 16 ++++-----
.../org/apache/isis/tooling/j2adoc/J2aUnit.java | 14 ++++----
.../apache/isis/tooling/j2adoc/JavaToAsciiDoc.java | 40 +++++++++++-----------
.../j2adoc/test/{AdocletTest.java => J2aTest.java} | 12 +++----
7 files changed, 65 insertions(+), 65 deletions(-)
diff --git a/tooling/cli/src/main/java/org/apache/isis/tooling/cli/CliConfig.java b/tooling/cli/src/main/java/org/apache/isis/tooling/cli/CliConfig.java
index 40564e3..b95c6d9 100644
--- a/tooling/cli/src/main/java/org/apache/isis/tooling/cli/CliConfig.java
+++ b/tooling/cli/src/main/java/org/apache/isis/tooling/cli/CliConfig.java
@@ -34,17 +34,17 @@ public class CliConfig {
private ProjectDoc projectDoc = new ProjectDoc();
private File outputFile = null; // where to write eg. system-overview.adoc
- private String docletPath = "index";
- private String docletXrefPageIdFormat = "system:generated:index/%s.adoc";
+ private String documentGlobalIndexPath = "index";
+ private String documentGlobalIndexXrefPageIdFormat = "system:generated:index/%s.adoc";
public boolean isDryRun() {
return getOutputFile() == null;
}
- public File getDocletOutputFolder() {
+ public File getDocumentGlobalIndexOutputFolder() {
return Optional.ofNullable(getOutputFile())
.map(File::getParentFile)
- .map(folder->new File(folder, getDocletPath()))
+ .map(folder->new File(folder, getDocumentGlobalIndexPath()))
.orElse(null);
}
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 9769f07..58a6702 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
@@ -87,8 +87,8 @@ public class ProjectDocModel {
modules = new TreeSet<ProjectNode>();
projTree.depthFirst(modules::add);
- val docletContext = J2aContext.compactFormat()
- .xrefPageIdFormat(cliConfig.getDocletXrefPageIdFormat())
+ val j2aContext = J2aContext.compactFormat()
+ .xrefPageIdFormat(cliConfig.getDocumentGlobalIndexXrefPageIdFormat())
.build();
val doc = doc();
@@ -101,14 +101,14 @@ public class ProjectDocModel {
.ifPresent(block(doc)::setSource);
cliConfig.getProjectDoc().getArtifactGroups().forEach((section, groupId)->{
- createSection(doc, section, groupId, docletContext);
+ createSection(doc, section, groupId, j2aContext);
});
if(!modules.isEmpty()) {
- createSection(doc, "Other", null, docletContext);
+ createSection(doc, "Other", null, j2aContext);
}
- ProjectDocWriter.write(cliConfig, doc, docletContext);
+ ProjectDocWriter.write(cliConfig, doc, j2aContext);
}
@@ -179,7 +179,7 @@ public class ProjectDocModel {
final @NonNull Document doc,
final @NonNull String sectionName,
final @Nullable String groupIdPattern,
- final @NonNull J2aContext docletContext) {
+ final @NonNull J2aContext j2aContext) {
val titleBlock = block(doc);
@@ -219,7 +219,7 @@ public class ProjectDocModel {
val row = row(table);
cell(table, row, coordinates(module, projRelativePath));
- cell(table, row, details(module, docletContext));
+ cell(table, row, details(module, j2aContext));
});
descriptionBlock.setSource(groupDiagram.toAsciiDoc(sectionName));
@@ -275,7 +275,7 @@ public class ProjectDocModel {
sb.append(String.format("%s: %s\n", key, value));
}
- private String details(ProjectNode module, J2aContext docletContext) {
+ private String details(ProjectNode module, J2aContext j2aContext) {
val description = module.getDescription().trim();
val dependencyList = module.getDependencies()
.stream()
@@ -291,7 +291,7 @@ public class ProjectDocModel {
.collect(Collectors.joining())
.trim();
- val indexEntriesCompactList = gatherAdoclets(module.getProjectDirectory(), docletContext)
+ val indexEntriesCompactList = gatherGlobalDocIndexXrefs(module.getProjectDirectory(), j2aContext)
.stream()
.collect(Collectors.joining(", "))
.trim();
@@ -325,16 +325,16 @@ public class ProjectDocModel {
return String.format("* %s\n", element);
}
- private SortedSet<String> gatherAdoclets(File projDir, J2aContext docletContext) {
+ private SortedSet<String> gatherGlobalDocIndexXrefs(File projDir, J2aContext j2aContext) {
val analyzerConfig = AnalyzerConfigFactory.maven(projDir, Language.JAVA).main();
- SortedSet<String> docletXrefs = analyzerConfig.getSources(JAVA).stream()
- .flatMap(docletContext::add)
- .map(doclet->doclet.getAsciiDocXref(docletContext))
+ final SortedSet<String> docIndexXrefs = analyzerConfig.getSources(JAVA).stream()
+ .flatMap(j2aContext::add)
+ .map(unit->unit.getAsciiDocXref(j2aContext))
.collect(Collectors.toCollection(TreeSet::new));
- return docletXrefs;
+ return docIndexXrefs;
}
private SortedSet<String> gatherSpringComponents(File projDir) {
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 a5a3f90..a277c17 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
@@ -41,7 +41,7 @@ final class ProjectDocWriter {
static void write(
final @NonNull CliConfig cliConfig,
final @NonNull Document doc,
- final @NonNull J2aContext docletContext) {
+ final @NonNull J2aContext j2aContext) {
try {
@@ -49,14 +49,14 @@ final class ProjectDocWriter {
if(cliConfig.isDryRun()) {
System.out.println(adoc);
- for(val doclet : docletContext.getAdocletIndex().values()) {
- System.out.println(doclet.toAsciiDoc(docletContext));
+ for(val unit : j2aContext.getUnitIndex().values()) {
+ System.out.println(unit.toAsciiDoc(j2aContext));
}
} else {
writeTo(cliConfig.getOutputFile(), adoc);
- for(val doclet : docletContext.getAdocletIndex().values()) {
- val docletFile = new File(cliConfig.getDocletOutputFolder(), doclet.getName() + ".adoc");
- writeTo(docletFile, doclet.toAsciiDoc(docletContext));
+ for(val unit : j2aContext.getUnitIndex().values()) {
+ val adocFile = new File(cliConfig.getDocumentGlobalIndexOutputFolder(), unit.getName() + ".adoc");
+ writeTo(adocFile, unit.toAsciiDoc(j2aContext));
}
}
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/J2aContext.java
index 45850b1..49a82dc 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/J2aContext.java
@@ -83,13 +83,13 @@ public class J2aContext {
@Builder.Default
private final boolean includeJavaSource = true;
- private final Map<String, J2aUnit> adocletIndex = _Maps.newTreeMap();
+ private final Map<String, J2aUnit> unitIndex = _Maps.newTreeMap();
- public J2aContext add(final @NonNull J2aUnit adoclet) {
- val previousKey = adocletIndex.put(adoclet.getName(), adoclet);
+ public J2aContext add(final @NonNull J2aUnit unit) {
+ val previousKey = unitIndex.put(unit.getName(), unit);
if(previousKey!=null) {
throw _Exceptions.unrecoverableFormatted(
- "doclet index entries must be unique (index key collision on %s)",
+ "J2aUnit index entries must be unique (index key collision on %s)",
previousKey);
}
return this;
@@ -104,12 +104,12 @@ public class J2aContext {
.stream();
}
- public Stream<J2aUnit> streamAdoclets() {
- return adocletIndex.values().stream();
+ public Stream<J2aUnit> streamUnits() {
+ return unitIndex.values().stream();
}
- public Optional<J2aUnit> getAdoclet(String key) {
- return Optional.ofNullable(adocletIndex.get(key));
+ public Optional<J2aUnit> getUnit(String key) {
+ return Optional.ofNullable(unitIndex.get(key));
}
// -- PREDEFINED FORMATS
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/J2aUnit.java
index 7efdbf1..c1fe876 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/J2aUnit.java
@@ -75,13 +75,13 @@ public class J2aUnit {
}
public String getAsciiDocXref(
- final @NonNull J2aContext docletContext) {
- val toAdocConverter = JavaToAsciiDoc.of(docletContext);
+ final @NonNull J2aContext j2aContext) {
+ val toAdocConverter = JavaToAsciiDoc.of(j2aContext);
return toAdocConverter.xref(this);
}
public String toAsciiDoc(
- final @NonNull J2aContext docletContext) {
+ final @NonNull J2aContext j2aContext) {
val doc = AsciiDocFactory.doc();
@@ -98,7 +98,7 @@ public class J2aUnit {
.collect(Can.toCan());
- val toAdocConverter = JavaToAsciiDoc.of(docletContext);
+ val toAdocConverter = JavaToAsciiDoc.of(j2aContext);
// -- intro
@@ -108,7 +108,7 @@ public class J2aUnit {
// -- java content
- if(docletContext.isIncludeJavaSource()) {
+ if(j2aContext.isIncludeJavaSource()) {
val java = new StringBuilder();
@@ -145,7 +145,7 @@ public class J2aUnit {
cd.getJavadoc()
.ifPresent(javadoc->{
- methodDescriptions.append(String.format(docletContext.getMemberDescriptionFormat(),
+ methodDescriptions.append(String.format(j2aContext.getMemberDescriptionFormat(),
toAdocConverter.constructorDeclaration(cd),
toAdocConverter.javadoc(javadoc, 1)));
});
@@ -156,7 +156,7 @@ public class J2aUnit {
md.getJavadoc()
.ifPresent(javadoc->{
- methodDescriptions.append(String.format(docletContext.getMemberDescriptionFormat(),
+ methodDescriptions.append(String.format(j2aContext.getMemberDescriptionFormat(),
toAdocConverter.methodDeclaration(md),
toAdocConverter.javadoc(javadoc, 1)));
});
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 3ca93c4..e9b8513 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 docletContext;
+ private final J2aContext j2aContext;
public String constructorDeclaration(final @NonNull ConstructorDeclaration cd) {
val isDeprecated = cd.getAnnotations().stream()
@@ -62,17 +62,17 @@ final class JavaToAsciiDoc {
val memberNameFormat = isDeprecated
? cd.isStatic()
- ? docletContext.getDeprecatedStaticMemberNameFormat()
- : docletContext.getDeprecatedMemberNameFormat()
+ ? j2aContext.getDeprecatedStaticMemberNameFormat()
+ : j2aContext.getDeprecatedMemberNameFormat()
: cd.isStatic()
- ? docletContext.getStaticMemberNameFormat()
- : docletContext.getMemberNameFormat();
+ ? j2aContext.getStaticMemberNameFormat()
+ : j2aContext.getMemberNameFormat();
val isGenericMember = cd.getTypeParameters().isNonEmpty();
val constructorFormat = isGenericMember
- ? docletContext.getGenericConstructorFormat()
- : docletContext.getConstructorFormat();
+ ? j2aContext.getGenericConstructorFormat()
+ : j2aContext.getConstructorFormat();
val args = Can.<Object>of(
isGenericMember ? typeParamters(cd.getTypeParameters()) : null, // Cans do ignored null
@@ -96,17 +96,17 @@ final class JavaToAsciiDoc {
val memberNameFormat = isDeprecated
? md.isStatic()
- ? docletContext.getDeprecatedStaticMemberNameFormat()
- : docletContext.getDeprecatedMemberNameFormat()
+ ? j2aContext.getDeprecatedStaticMemberNameFormat()
+ : j2aContext.getDeprecatedMemberNameFormat()
: md.isStatic()
- ? docletContext.getStaticMemberNameFormat()
- : docletContext.getMemberNameFormat();
+ ? j2aContext.getStaticMemberNameFormat()
+ : j2aContext.getMemberNameFormat();
val isGenericMember = md.getTypeParameters().isNonEmpty();
val methodFormat = isGenericMember
- ? docletContext.getGenericMethodFormat()
- : docletContext.getMethodFormat();
+ ? j2aContext.getGenericMethodFormat()
+ : j2aContext.getMethodFormat();
val args = Can.<Object>of(
isGenericMember ? typeParamters(md.getTypeParameters()) : null, // Cans do ignored null
@@ -195,23 +195,23 @@ final class JavaToAsciiDoc {
switch(inlineTag.getType()) {
case LINK:
- val refDoclet = docletContext.getAdoclet(inlineContent).orElse(null);
- if(refDoclet!=null) {
- return String.format(" %s ", xref(refDoclet));
+ val referencedUnit = j2aContext.getUnit(inlineContent).orElse(null);
+ if(referencedUnit!=null) {
+ return String.format(" %s ", xref(referencedUnit));
}
default:
return String.format(" _%s_ ", inlineContent);
}
}
- public String xref(final @NonNull J2aUnit doclet) {
+ public String xref(final @NonNull J2aUnit unit) {
return String.format("xref:%s[%s]",
- String.format(docletContext.getXrefPageIdFormat(), doclet.getName()),
- doclet.getName());
+ String.format(j2aContext.getXrefPageIdFormat(), unit.getName()),
+ unit.getName());
}
public String xrefIfRequired(final @NonNull String docIndexKey) {
- return docletContext.getAdoclet(docIndexKey)
+ return j2aContext.getUnit(docIndexKey)
.map(this::xref)
.orElse(docIndexKey);
}
diff --git a/tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/AdocletTest.java b/tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2aTest.java
similarity index 94%
rename from tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/AdocletTest.java
rename to tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2aTest.java
index 944d4f6..e2c5d29 100644
--- a/tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/AdocletTest.java
+++ b/tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2aTest.java
@@ -42,7 +42,7 @@ import guru.nidi.codeassert.config.Language;
import static guru.nidi.codeassert.config.Language.JAVA;
-class AdocletTest {
+class J2aTest {
@Test //@Disabled
void testJavaDocMining() {
@@ -51,7 +51,7 @@ class AdocletTest {
.maven(ProjectSampler.apacheIsisApplib(), Language.JAVA)
.main();
- val docletContext = J2aContext
+ val j2aContext = J2aContext
//.javaSourceWithFootNotesFormat()
.compactFormat()
.xrefPageIdFormat("system:generated:index/%s.adoc")
@@ -61,12 +61,12 @@ class AdocletTest {
.stream()
.filter(source->source.toString().contains("XmlSnapshotService"))
//.peek(source->System.out.println("parsing source: " + source))
- .forEach(docletContext::add);
+ .forEach(j2aContext::add);
- docletContext.streamAdoclets()
- .forEach(doclet->{
+ j2aContext.streamUnits()
+ .forEach(unit->{
- System.out.println(doclet.toAsciiDoc(docletContext));
+ System.out.println(unit.toAsciiDoc(j2aContext));
System.out.println();
});