You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2019/10/23 07:19:39 UTC
[isis] branch ISIS-2062 updated (7ef867c -> a887d0b)
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a change to branch ISIS-2062
in repository https://gitbox.apache.org/repos/asf/isis.git.
from 7ef867c ISIS-2062: integrates generated config docs
new a18ff6b ISIS-2062: improves formatting
new a887d0b ISIS-2062: cleans up generated asciidoc a bit
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../isis/commons/internal/strings/FormatTest.java | 66 ++++++++++++++++
core/config/_adoc/modules/cfg/examples/.gitignore | 3 +-
.../modules/cfg/pages/spring-configuration.adoc | 91 ++++++++++++----------
core/config/_adoc/modules/cfg/partials/Other.adoc | 4 +
extensions/asciidoc/_adoc/antora.yml | 2 +-
extensions/markdown/_adoc/antora.yml | 2 +-
extensions/viewer-wicket-excel/_adoc/antora.yml | 2 +-
preview.sh | 4 +-
scripts/generateConfigDocs.groovy | 68 ++++++++++++++--
site.yml | 3 +
10 files changed, 194 insertions(+), 51 deletions(-)
create mode 100644 core/commons/src/test/java/org/apache/isis/commons/internal/strings/FormatTest.java
create mode 100644 core/config/_adoc/modules/cfg/partials/Other.adoc
[isis] 01/02: ISIS-2062: improves formatting
Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-2062
in repository https://gitbox.apache.org/repos/asf/isis.git
commit a18ff6bc60bd93743431ee744d98f4ebc5ed6cc9
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Wed Oct 23 00:19:50 2019 +0100
ISIS-2062: improves formatting
---
core/config/_adoc/modules/cfg/examples/.gitignore | 3 +-
.../modules/cfg/pages/spring-configuration.adoc | 65 +++++++++++++---------
core/config/_adoc/modules/cfg/partials/Other.adoc | 4 ++
preview.sh | 4 +-
4 files changed, 46 insertions(+), 30 deletions(-)
diff --git a/core/config/_adoc/modules/cfg/examples/.gitignore b/core/config/_adoc/modules/cfg/examples/.gitignore
index 2606a20..f0d619c 100644
--- a/core/config/_adoc/modules/cfg/examples/.gitignore
+++ b/core/config/_adoc/modules/cfg/examples/.gitignore
@@ -1,2 +1 @@
-!generated/_attributes.adoc
-generated
+generated/*.adoc
diff --git a/core/config/_adoc/modules/cfg/pages/spring-configuration.adoc b/core/config/_adoc/modules/cfg/pages/spring-configuration.adoc
index 0a5944e..744b27c 100644
--- a/core/config/_adoc/modules/cfg/pages/spring-configuration.adoc
+++ b/core/config/_adoc/modules/cfg/pages/spring-configuration.adoc
@@ -5,7 +5,8 @@ include::_attributes.adoc[]
-.Shiro Authentication
+== Shiro Authentication
+
[cols="2a,1,3a", options="header"]
|===
|Property
@@ -14,12 +15,13 @@ include::_attributes.adoc[]
|Description
-include::rg:cfg:example$generated/spring-configuration-metadata/isis.authentication.shiro.adoc
+include::rg:cfg:example$generated/isis.authentication.shiro.adoc[]
|===
-.Persistors (in general)
+== Persistors (in general)
+
[cols="2a,1,3a", options="header"]
|===
|Property
@@ -27,12 +29,13 @@ include::rg:cfg:example$generated/spring-configuration-metadata/isis.authenticat
(default value)
|Description
-include::rg:cfg:example$generated/spring-configuration-metadata/isis.persistor.adoc
+include::rg:cfg:example$generated/isis.persistor.adoc[]
|===
-.DataNucleus Persistor
+== DataNucleus Persistor
+
[cols="2a,1,3a", options="header"]
|===
|Property
@@ -40,15 +43,15 @@ include::rg:cfg:example$generated/spring-configuration-metadata/isis.persistor.a
(default value)
|Description
-include::rg:cfg:example$generated/spring-configuration-metadata/isis.persistor.datanucleus.adoc
+include::rg:cfg:example$generated/isis.persistor.datanucleus.adoc[]
|===
+== DataNucleus Persistor Pass-thru Settings
-.DataNucleus Persistor Pass-thru Settings
[cols="2a,1,3a", options="header"]
|===
|Property
@@ -56,13 +59,14 @@ include::rg:cfg:example$generated/spring-configuration-metadata/isis.persistor.d
(default value)
|Description
-include::rg:cfg:example$generated/spring-configuration-metadata/isis.persistor.datanucleus.impl.adoc
+include::rg:cfg:example$generated/isis.persistor.datanucleus.impl.adoc[]
|===
-.Metamodel Reflector
+== Metamodel Reflector
+
[cols="2a,1,3a", options="header"]
|===
|Property
@@ -70,14 +74,15 @@ include::rg:cfg:example$generated/spring-configuration-metadata/isis.persistor.d
(default value)
|Description
-include::rg:cfg:example$generated/spring-configuration-metadata/isis.reflector.adoc
+include::rg:cfg:example$generated/isis.reflector.adoc[]
|===
-.MetaModel Facets
+== MetaModel Facets
+
[cols="2a,1,3a", options="header"]
|===
|Property
@@ -85,14 +90,15 @@ include::rg:cfg:example$generated/spring-configuration-metadata/isis.reflector.a
(default value)
|Description
-include::rg:cfg:example$generated/spring-configuration-metadata/isis.reflector.facet.adoc
+include::rg:cfg:example$generated/isis.reflector.facet.adoc[]
|===
-.Metamodel Validation
+== Metamodel Validation
+
[cols="2a,1,3a", options="header"]
|===
|Property
@@ -100,13 +106,14 @@ include::rg:cfg:example$generated/spring-configuration-metadata/isis.reflector.f
(default value)
|Description
-include::rg:cfg:example$generated/spring-configuration-metadata/isis.reflector.validator.adoc
+include::rg:cfg:example$generated/isis.reflector.validator.adoc[]
|===
-.Individual Domain Services
+== Individual Domain Services
+
[cols="2a,1,3a", options="header"]
|===
|Property
@@ -114,13 +121,14 @@ include::rg:cfg:example$generated/spring-configuration-metadata/isis.reflector.v
(default value)
|Description
-include::rg:cfg:example$generated/spring-configuration-metadata/isis.service.email.adoc
+include::rg:cfg:example$generated/isis.service.email.adoc[]
|===
-.Domain Services (in general)
+== Domain Services (in general)
+
[cols="2a,1,3a", options="header"]
|===
|Property
@@ -128,13 +136,14 @@ include::rg:cfg:example$generated/spring-configuration-metadata/isis.service.ema
(default value)
|Description
-include::rg:cfg:example$generated/spring-configuration-metadata/isis.services.adoc
+include::rg:cfg:example$generated/isis.services.adoc[]
|===
-.Restful Objects Viewer
+== Restful Objects Viewer
+
[cols="2a,1,3a", options="header"]
|===
|Property
@@ -142,13 +151,14 @@ include::rg:cfg:example$generated/spring-configuration-metadata/isis.services.ad
(default value)
|Description
-include::rg:cfg:example$generated/spring-configuration-metadata/isis.viewer.restfulobjects.adoc
+include::rg:cfg:example$generated/isis.viewer.restfulobjects.adoc[]
|===
-.Wicket Viewer
+== Wicket Viewer
+
[cols="2a,1,3a", options="header"]
|===
|Property
@@ -156,13 +166,14 @@ include::rg:cfg:example$generated/spring-configuration-metadata/isis.viewer.rest
(default value)
|Description
-include::rg:cfg:example$generated/spring-configuration-metadata/isis.viewer.wicket.adoc
+include::rg:cfg:example$generated/isis.viewer.wicket.adoc[]
|===
-.Viewers (in general)
+== Viewers (in general)
+
[cols="2a,1,3a", options="header"]
|===
|Property
@@ -170,12 +181,13 @@ include::rg:cfg:example$generated/spring-configuration-metadata/isis.viewer.wick
(default value)
|Description
-include::rg:cfg:example$generated/spring-configuration-metadata/isis.viewers.adoc
+include::rg:cfg:example$generated/isis.viewers.adoc[]
|===
-.Other
+== Other
+
[cols="2a,1,3a", options="header"]
|===
|Property
@@ -183,11 +195,12 @@ include::rg:cfg:example$generated/spring-configuration-metadata/isis.viewers.ado
(default value)
|Description
-include::rg:cfg:example$generated/spring-configuration-metadata/Other.adoc
+include::rg:cfg:example$generated/Other.adoc[]
|===
+include::rg:cfg:example$generated/Other.adoc[]
diff --git a/core/config/_adoc/modules/cfg/partials/Other.adoc b/core/config/_adoc/modules/cfg/partials/Other.adoc
new file mode 100644
index 0000000..3b739d3
--- /dev/null
+++ b/core/config/_adoc/modules/cfg/partials/Other.adoc
@@ -0,0 +1,4 @@
+| isis.objects.editing
+|
+|
+
diff --git a/preview.sh b/preview.sh
index 5f04a1c..0bea1e6 100644
--- a/preview.sh
+++ b/preview.sh
@@ -1,6 +1,6 @@
#!/usr/bin/env bash
rm -rf antora/target/site \
-&& rm -rf core/config/_adoc/modules/cfg/examples/generated/spring-configuration-metadata \
-&& groovy scripts/generateConfigDocs -f "./core/config/target/classes/META-INF/spring-configuration-metadata.json" -o ./core/config/_adoc/modules/cfg/examples/generated/spring-configuration-metadata \
+&& rm -rf core/config/_adoc/modules/cfg/examples/generated \
+&& groovy scripts/generateConfigDocs -f "./core/config/target/classes/META-INF/spring-configuration-metadata.json" -o ./core/config/_adoc/modules/cfg/examples/generated \
&& antora site.yml $@ \
&& serve antora/target/site
[isis] 02/02: ISIS-2062: cleans up generated asciidoc a bit
Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-2062
in repository https://gitbox.apache.org/repos/asf/isis.git
commit a887d0b9d6d2d413a7537c97cd3323f38ff68770
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Wed Oct 23 08:19:13 2019 +0100
ISIS-2062: cleans up generated asciidoc a bit
---
.../isis/commons/internal/strings/FormatTest.java | 66 +++++++++++++++++++++
.../modules/cfg/pages/spring-configuration.adoc | 26 ++++-----
extensions/asciidoc/_adoc/antora.yml | 2 +-
extensions/markdown/_adoc/antora.yml | 2 +-
extensions/viewer-wicket-excel/_adoc/antora.yml | 2 +-
scripts/generateConfigDocs.groovy | 68 ++++++++++++++++++++--
site.yml | 3 +
7 files changed, 148 insertions(+), 21 deletions(-)
diff --git a/core/commons/src/test/java/org/apache/isis/commons/internal/strings/FormatTest.java b/core/commons/src/test/java/org/apache/isis/commons/internal/strings/FormatTest.java
new file mode 100644
index 0000000..c61e84c
--- /dev/null
+++ b/core/commons/src/test/java/org/apache/isis/commons/internal/strings/FormatTest.java
@@ -0,0 +1,66 @@
+package org.apache.isis.commons.internal.strings;
+
+
+import org.junit.Test;
+import org.junit.jupiter.api.Assertions;
+
+public class FormatTest {
+
+ // copy of code in scripts/generateConfigDocs.groovy
+ public static String format(final String str, int len) {
+ if(str.length() <= len) {
+ return str;
+ }
+
+ final StringBuilder buf = new StringBuilder();
+ String remaining = str;
+
+ while(remaining.length() > 0) {
+ int lastDot = remaining.substring(0, len).lastIndexOf('.');
+ int lastDash = remaining.substring(0, len).lastIndexOf('-');
+ int splitAt = lastDot > 0
+ ? lastDot + 1
+ : lastDash > 0
+ ? lastDash + 1
+ : len;
+ if(buf.length() > 0) {
+ buf.append("\n");
+ }
+ buf.append(remaining, 0, splitAt);
+ remaining = remaining.substring(splitAt);
+
+ if(remaining.length() <= len) {
+ buf.append("\n").append(remaining);
+ remaining = "";
+ }
+ }
+ return buf.toString();
+ }
+
+ @Test
+ public void split_once() {
+ Assertions.assertEquals("abc.def.ghi.jkl.mno.\npqr.stu.vwx.yza", format("abc.def.ghi.jkl.mno.pqr.stu.vwx.yza", 20));
+ }
+
+ @Test
+ public void split_twice() {
+ Assertions.assertEquals("abc.def.ghi.jkl.\nmno.pqr.stu.vwx.\nyza", format("abc.def.ghi.jkl.mno.pqr.stu.vwx.yza", 16));
+ }
+
+ @Test
+ public void split_not_on_divider() {
+ Assertions.assertEquals("abc.def.ghi.\njkl.mno.pqr.\nstu.vwx.yza", format("abc.def.ghi.jkl.mno.pqr.stu.vwx.yza", 15));
+ }
+
+ @Test
+ public void no_divider() {
+ Assertions.assertEquals("abcdefghij\nklmnopqrst\nuvwxyza", format("abcdefghijklmnopqrstuvwxyza", 10));
+ }
+
+ @Test
+ public void real_world() {
+ Assertions.assertEquals("isis.persistor.\ndatanucleus.\nclass-metadata-\nloaded-listener", format("isis.persistor.datanucleus.class-metadata-loaded-listener", 20));
+ }
+
+
+}
diff --git a/core/config/_adoc/modules/cfg/pages/spring-configuration.adoc b/core/config/_adoc/modules/cfg/pages/spring-configuration.adoc
index 744b27c..be8d31e 100644
--- a/core/config/_adoc/modules/cfg/pages/spring-configuration.adoc
+++ b/core/config/_adoc/modules/cfg/pages/spring-configuration.adoc
@@ -7,7 +7,7 @@ include::_attributes.adoc[]
== Shiro Authentication
-[cols="2a,1,3a", options="header"]
+[cols="2a,2a,3a", options="header"]
|===
|Property
|Value +
@@ -22,7 +22,7 @@ include::rg:cfg:example$generated/isis.authentication.shiro.adoc[]
== Persistors (in general)
-[cols="2a,1,3a", options="header"]
+[cols="2a,2a,3a", options="header"]
|===
|Property
|Value +
@@ -36,7 +36,7 @@ include::rg:cfg:example$generated/isis.persistor.adoc[]
== DataNucleus Persistor
-[cols="2a,1,3a", options="header"]
+[cols="2a,2a,3a", options="header"]
|===
|Property
|Value +
@@ -52,7 +52,7 @@ include::rg:cfg:example$generated/isis.persistor.datanucleus.adoc[]
== DataNucleus Persistor Pass-thru Settings
-[cols="2a,1,3a", options="header"]
+[cols="2a,2a,3a", options="header"]
|===
|Property
|Value +
@@ -67,7 +67,7 @@ include::rg:cfg:example$generated/isis.persistor.datanucleus.impl.adoc[]
== Metamodel Reflector
-[cols="2a,1,3a", options="header"]
+[cols="2a,2a,3a", options="header"]
|===
|Property
|Value +
@@ -83,7 +83,7 @@ include::rg:cfg:example$generated/isis.reflector.adoc[]
== MetaModel Facets
-[cols="2a,1,3a", options="header"]
+[cols="2a,2a,3a", options="header"]
|===
|Property
|Value +
@@ -99,7 +99,7 @@ include::rg:cfg:example$generated/isis.reflector.facet.adoc[]
== Metamodel Validation
-[cols="2a,1,3a", options="header"]
+[cols="2a,2a,3a", options="header"]
|===
|Property
|Value +
@@ -114,7 +114,7 @@ include::rg:cfg:example$generated/isis.reflector.validator.adoc[]
== Individual Domain Services
-[cols="2a,1,3a", options="header"]
+[cols="2a,2a,3a", options="header"]
|===
|Property
|Value +
@@ -129,7 +129,7 @@ include::rg:cfg:example$generated/isis.service.email.adoc[]
== Domain Services (in general)
-[cols="2a,1,3a", options="header"]
+[cols="2a,2a,3a", options="header"]
|===
|Property
|Value +
@@ -144,7 +144,7 @@ include::rg:cfg:example$generated/isis.services.adoc[]
== Restful Objects Viewer
-[cols="2a,1,3a", options="header"]
+[cols="2a,2a,3a", options="header"]
|===
|Property
|Value +
@@ -159,7 +159,7 @@ include::rg:cfg:example$generated/isis.viewer.restfulobjects.adoc[]
== Wicket Viewer
-[cols="2a,1,3a", options="header"]
+[cols="2a,2a,3a", options="header"]
|===
|Property
|Value +
@@ -174,7 +174,7 @@ include::rg:cfg:example$generated/isis.viewer.wicket.adoc[]
== Viewers (in general)
-[cols="2a,1,3a", options="header"]
+[cols="2a,2a,3a", options="header"]
|===
|Property
|Value +
@@ -188,7 +188,7 @@ include::rg:cfg:example$generated/isis.viewers.adoc[]
== Other
-[cols="2a,1,3a", options="header"]
+[cols="2a,2a,3a", options="header"]
|===
|Property
|Value +
diff --git a/extensions/asciidoc/_adoc/antora.yml b/extensions/asciidoc/_adoc/antora.yml
index d93aa8f..cb832ae 100644
--- a/extensions/asciidoc/_adoc/antora.yml
+++ b/extensions/asciidoc/_adoc/antora.yml
@@ -1,2 +1,2 @@
-name: uvw
+name: vw
version: master
diff --git a/extensions/markdown/_adoc/antora.yml b/extensions/markdown/_adoc/antora.yml
index d93aa8f..cb832ae 100644
--- a/extensions/markdown/_adoc/antora.yml
+++ b/extensions/markdown/_adoc/antora.yml
@@ -1,2 +1,2 @@
-name: uvw
+name: vw
version: master
diff --git a/extensions/viewer-wicket-excel/_adoc/antora.yml b/extensions/viewer-wicket-excel/_adoc/antora.yml
index d93aa8f..cb832ae 100644
--- a/extensions/viewer-wicket-excel/_adoc/antora.yml
+++ b/extensions/viewer-wicket-excel/_adoc/antora.yml
@@ -1,2 +1,2 @@
-name: uvw
+name: vw
version: master
diff --git a/scripts/generateConfigDocs.groovy b/scripts/generateConfigDocs.groovy
index 14f8c0e..1f6d5c2 100644
--- a/scripts/generateConfigDocs.groovy
+++ b/scripts/generateConfigDocs.groovy
@@ -190,20 +190,21 @@ for (PropertyGroup group in groups) {
if(group.properties.size() > 0) {
for (Property property in group.properties) {
- buf << "| ${property.name}\n"
+ buf << "| "
+ buf << format("${property.name}\n")
// buf << "|"
// if(property.type) {
// buf << " ${property.type}"
// }
// buf << "\n"
- buf << "|"
+ buf << "| "
if(property.defaultValue) {
- buf << " ${property.defaultValue}"
+ buf << format(" ${property.defaultValue}")
}
buf << "\n"
- buf << "|"
+ buf << "| "
if(property.description) {
- buf << " ${property.description}"
+ buf << toAsciidoc(" ${property.description}")
}
buf << "\n"
buf << "\n"
@@ -214,3 +215,60 @@ for (PropertyGroup group in groups) {
outputFile.write(buf.toString())
}
}
+
+static String toAsciidoc(String str) {
+
+ String lineFeed = " +\n";
+
+ // simple html -> asciidoc substitutions
+ str = str.replace("<p>", lineFeed);
+ str = str.replace("</p>", "");
+
+ str = str.replace("<i>", "_");
+ str = str.replace("<b>", "*");
+ //str = str.replaceAll("<a href=\"(.*)\">(.*?)</a>", "link:$1[$2]");
+
+ str = str.replace("<code>", "`");
+ str = str.replace("<\\code>", "`");
+ str = str.replace("<tt>", "`");
+ str = str.replace("<\\tt>", "`");
+
+ return str;
+}
+
+static String format(String str, int len = 30) {
+
+ String lineFeed = " +\n";
+
+ if(str.length() <= len) {
+ return str;
+ }
+
+ final StringBuilder buf = new StringBuilder();
+ String remaining = str;
+
+ while(remaining.length() > 0) {
+ int lastDot = remaining.substring(0, len).lastIndexOf('.');
+ int lastDash = remaining.substring(0, len).lastIndexOf('-');
+ int splitAt = lastDot > 0
+ ? lastDot + 1
+ : lastDash > 0
+ ? lastDash + 1
+ : len;
+ if(buf.length() > 0) {
+ buf.append(lineFeed);
+ }
+ buf.append(remaining, 0, splitAt);
+ remaining = remaining.substring(splitAt);
+
+ if(remaining.length() <= len) {
+ buf.append(lineFeed).append(remaining);
+ remaining = "";
+ }
+ }
+
+ def string = buf.toString()
+// System.out.println(str)
+// System.out.println(string)
+ return string;
+}
diff --git a/site.yml b/site.yml
index 6b1f569..12ec137 100644
--- a/site.yml
+++ b/site.yml
@@ -98,6 +98,9 @@ content:
start_path: antora/components/security
branches: HEAD
- url: .
+ start_path: core/security/api/_adoc
+ branches: HEAD
+ - url: .
start_path: core/security/bypass/_adoc
branches: HEAD
- url: .