Skip to content

Commit

Permalink
Replace missing (outdated) external link wrt. #185
Browse files Browse the repository at this point in the history
- 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
  • Loading branch information
ascheman committed Sep 17, 2024
1 parent 3f63016 commit 5eec996
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 34 deletions.
3 changes: 3 additions & 0 deletions src/docs/_common.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
ifndef::imagesdir[:imagesdir: ./images]
:issue-open: 🟢
:issue-closed: 🟣
2 changes: 1 addition & 1 deletion src/docs/arc42/chapters/chap-05-BuildingBlocks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
....
Expand Down
14 changes: 6 additions & 8 deletions src/docs/development/_includes/issue-185.adoc
Original file line number Diff line number Diff line change
@@ -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:

Expand Down Expand Up @@ -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)



Expand Down
6 changes: 3 additions & 3 deletions src/docs/development/_includes/issue-190.adoc
Original file line number Diff line number Diff line change
@@ -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[]
....
8 changes: 4 additions & 4 deletions src/docs/development/_includes/issue-219.adoc
Original file line number Diff line number Diff line change
@@ -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]
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
`
Expand Down
3 changes: 2 additions & 1 deletion src/docs/development/_includes/issue-244.adoc
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
15 changes: 4 additions & 11 deletions src/docs/development/_includes/issue-252.adoc
Original file line number Diff line number Diff line change
@@ -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]
<a href="/foo">

****

=== Background

The short form of a URL:
Expand All @@ -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`)
Expand All @@ -39,9 +35,6 @@ The default should be the list given above.

* Add these defaults to `Web`




=== Decision

****
Expand Down
17 changes: 11 additions & 6 deletions src/docs/development/design-discussions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
=== 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]

0 comments on commit 5eec996

Please sign in to comment.