From 5eec996eff79a7c659886a2de365da644e07a375 Mon Sep 17 00:00:00 2001 From: Gerd Aschemann Date: Tue, 17 Sep 2024 09:51:55 +0200 Subject: [PATCH] Replace missing (outdated) external link wrt. #185 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Original article by Przemysław Wojnowski (https://farenda.com/spring-find-annotated-classes/) seems to have vanished -> Add generic Baeldung article - unify design discussions - add current state of issues (open/close) - Drop "plantumldir" AsciiDoctor attribute as it is not necessary --- src/docs/_common.adoc | 3 +++ .../arc42/chapters/chap-05-BuildingBlocks.adoc | 2 +- src/docs/development/_includes/issue-185.adoc | 14 ++++++-------- src/docs/development/_includes/issue-190.adoc | 6 +++--- src/docs/development/_includes/issue-219.adoc | 8 ++++---- src/docs/development/_includes/issue-244.adoc | 3 ++- src/docs/development/_includes/issue-252.adoc | 15 ++++----------- src/docs/development/design-discussions.adoc | 17 +++++++++++------ 8 files changed, 34 insertions(+), 34 deletions(-) create mode 100644 src/docs/_common.adoc diff --git a/src/docs/_common.adoc b/src/docs/_common.adoc new file mode 100644 index 00000000..f6111ebe --- /dev/null +++ b/src/docs/_common.adoc @@ -0,0 +1,3 @@ +ifndef::imagesdir[:imagesdir: ./images] +:issue-open: 🟢 +:issue-closed: 🟣 diff --git a/src/docs/arc42/chapters/chap-05-BuildingBlocks.adoc b/src/docs/arc42/chapters/chap-05-BuildingBlocks.adoc index 7e75dd94..82f3bcd5 100644 --- a/src/docs/arc42/chapters/chap-05-BuildingBlocks.adoc +++ b/src/docs/arc42/chapters/chap-05-BuildingBlocks.adoc @@ -8,7 +8,7 @@ include::_config.adoc[] === Whitebox HtmlSanityChecker -[plantuml,"{plantumldir}whitbox-hsc-level-1",svg] +[plantuml,whitbox-hsc-level-1,svg] .... include::../../plantuml/whitebox-hsc-level-1.puml[] .... diff --git a/src/docs/development/_includes/issue-185.adoc b/src/docs/development/_includes/issue-185.adoc index 919937de..98c88065 100644 --- a/src/docs/development/_includes/issue-185.adoc +++ b/src/docs/development/_includes/issue-185.adoc @@ -1,12 +1,14 @@ :filename: development/issue-185.adoc +include::../../_common.adoc[] -== Automated Checker Factory +== {issue-open} Automated Checker Factory (185) https://github.com/aim42/htmlSanityCheck/issues/185[Issue 185] proposes to automatically detect and instantiate Checker -(sub-)classes. +(sub-) classes. === Problem + We want to adhere to the Open-Close principle (OCP) when adding new checkers: @@ -37,12 +39,8 @@ class AllCheckers { A solution needs to address two issues: -1.) _find_ all Checker subclasses -One approach here relies on Java annotations, -described by https://farenda.com/spring-find-annotated-classes/[Przemysław Wojnowski], -and uses the https://github.com/ronmamo/reflections[Reflections] library. - -2.) _instantiate_ these classes (aka _Factory_ for the checkers) +. _find_ all Checker subclasses, e.g., by https://www.baeldung.com/java-scan-annotations-runtime[Java Annotations]. +. _instantiate_ these classes (aka _Factory_ for the checkers) diff --git a/src/docs/development/_includes/issue-190.adoc b/src/docs/development/_includes/issue-190.adoc index 42516371..a725a1d7 100644 --- a/src/docs/development/_includes/issue-190.adoc +++ b/src/docs/development/_includes/issue-190.adoc @@ -1,14 +1,14 @@ :filename: development/issue-190.adoc -ifndef::plantumldir[:plantumldir: .plantuml/] +include::../../_common.adoc[] -== Refactoring the Main Checking Loop +== {issue-closed} Refactoring the Main Checking Loop (190) https://github.com/aim42/htmlSanityCheck/issues/190[Issue 190] proposes to merge the two classes AllChecksRunner and ChecksRunner. === Proposed (new) Scenario -[plantuml,"{plantumldir}mainloop-new",svg] +[plantuml,mainloop-new,svg] .... include::MainLoop-new.puml[] .... diff --git a/src/docs/development/_includes/issue-219.adoc b/src/docs/development/_includes/issue-219.adoc index 341c63a4..3dde890b 100644 --- a/src/docs/development/_includes/issue-219.adoc +++ b/src/docs/development/_includes/issue-219.adoc @@ -1,7 +1,7 @@ :filename: development/issue-219.adoc -ifndef::plantumldir[:plantumldir: .plantuml/] +include::../../_common.adoc[] -== Handling 403 and 405 Status Codes +== {issue-open} Handling 403 and 405 Status Codes (219) https://github.com/aim42/htmlSanityCheck/issues/219[Issue 219] @@ -30,7 +30,7 @@ page exists. === Proposed Approach -[plantuml,"{plantumldir}GET-after-HEAD-failapproach",svg] +[plantuml,GET-after-HEAD-failapproach,svg] .... @startuml skinparam maxmessagesize 80 @@ -60,7 +60,7 @@ endfooter @enduml .... -Reason for this "double check" is to keep the transmitted data volume low (and performance higher). +The reason for this "double check" is to keep the transmitted data volume low (and performance higher). The general behavior we implement shall be the following ` diff --git a/src/docs/development/_includes/issue-244.adoc b/src/docs/development/_includes/issue-244.adoc index 51423e01..1a67f903 100644 --- a/src/docs/development/_includes/issue-244.adoc +++ b/src/docs/development/_includes/issue-244.adoc @@ -1,6 +1,7 @@ :filename: development/issue-244.adoc +include::../../_common.adoc[] -== Handling 30x Status Codes +== {issue-closed} Handling 30x Status Codes (244) https://github.com/aim42/htmlSanityCheck/issues/244[Issue 244] diff --git a/src/docs/development/_includes/issue-252.adoc b/src/docs/development/_includes/issue-252.adoc index 39f938d1..78ccf10f 100644 --- a/src/docs/development/_includes/issue-252.adoc +++ b/src/docs/development/_includes/issue-252.adoc @@ -1,18 +1,15 @@ :filename: development/issue-252.adoc +include::../../_common.adoc[] -== Issue 252 (MissingLocalResourcesChecker gives false positives) +== {issue-open} MissingLocalResourcesChecker gives false positives (252) -**** -.Problem Description +=== Problem -The MLR-Checker currently gives false positives ("false alarms") -if the link has a form like +https://github.com/aim42/htmlSanityCheck/issues/252[Issue 252]: complains that the MLR-Checker currently gives false positives ("false alarms") if the link has a form like [source,html] -**** - === Background The short form of a URL: @@ -28,7 +25,6 @@ can actually mean one of the following: where the extension is one of the following: `html, htm, shtml, phtml, php, asp, aspx, xml` - === Proposed Approach * Define a proper name for the "link without extension" (`prefixOnlyHref`) @@ -39,9 +35,6 @@ The default should be the list given above. * Add these defaults to `Web` - - - === Decision **** diff --git a/src/docs/development/design-discussions.adoc b/src/docs/development/design-discussions.adoc index 224a0370..05a2ac55 100644 --- a/src/docs/development/design-discussions.adoc +++ b/src/docs/development/design-discussions.adoc @@ -7,12 +7,17 @@ == {jbake-title} :icons: font :toc: right -:toclevels: 3 +:toclevels: 4 :toc-position: right // :experimental: -include::_includes/issue-185.adoc[leveloffset=+1] -include::_includes/issue-190.adoc[leveloffset=+1] -include::_includes/issue-219.adoc[leveloffset=+1] -include::_includes/issue-244.adoc[leveloffset=+1] -include::_includes/issue-252.adoc[leveloffset=+1] \ No newline at end of file +=== Open Issues + +include::_includes/issue-185.adoc[leveloffset=+2] +include::_includes/issue-219.adoc[leveloffset=+2] +include::_includes/issue-252.adoc[leveloffset=+2] + +=== Resolved Issues + +include::_includes/issue-244.adoc[leveloffset=+2] +include::_includes/issue-190.adoc[leveloffset=+2]