Skip to content

Commit

Permalink
Changing conformance criteria roll up count from a list to a table (#354
Browse files Browse the repository at this point in the history 
)

* Drupal upgrade NextGen (#18)

* Just the new drupal files

* delete old acr

* delete old acr

* pre-commit fixes

---------

Co-authored-by: pre-commit <[email protected]>

* Updated html (#19)

* Update drupal-10-16.yaml

Changing the path to CivicActions.

* Update drupal-10-16.html

Using the CLI

* Moving the 16 Simple

* Adding Drupal 10 16 Simple

* pre-commit fixes

* Updated Drupal 10 yaml version.

---------

Co-authored-by: pre-commit <[email protected]>
Co-authored-by: Daniel Mundra <[email protected]>

* Criteria counts as table (#20)

* Redoing progressPerChapter to output counts as a table.

* Removed skipping of none label.

* Adjusted table counts per row display.

* Added functions to get level and component labels to use in the progress table.

* Updating markdown examples after testing. Reset output functions.

* Changed any column header to all and added margin to simple table.

* Removed un-needed conditional check.

* Added check for undefined and updated all examples.

* Added test when first criteria has missing components. Updated output logic and regenerated examples.

* Updated tests.

* Updated version and ran JS build.

---------

Co-authored-by: Mike Gifford <[email protected]>
Co-authored-by: pre-commit <[email protected]>
  • Loading branch information
@dmundra @mgifford
3 people authored Mar 12, 2024
1 parent 76250c2 commit 86f890a
Show file tree
Hide file tree
Showing 26 changed files with 2,845 additions and 1,244 deletions.
111 changes: 86 additions & 25 deletions dist/createOutput.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,20 @@ function createOutput(data, catalogData, templateType, templateString) {
}
}
});
const getCatalogComponentLabel = (componentId) => {
if (catalogData.components) {
for (const component of catalogData.components) {
if (component.id === componentId) {
if (component.label != "") {
return component.label;
}
else {
return "All";
}
}
}
}
};
handlebars_1.default.registerHelper("catalogComponentLabel", function (componentId) {
if (catalogData.components) {
for (const component of catalogData.components) {
Expand All @@ -61,7 +75,7 @@ function createOutput(data, catalogData, templateType, templateString) {
}
}
});
handlebars_1.default.registerHelper("levelLabel", function (level) {
const getLevelLabel = (level) => {
if (catalogData.terms) {
for (const terms of catalogData.terms) {
if (terms.id === level) {
Expand All @@ -71,7 +85,8 @@ function createOutput(data, catalogData, templateType, templateString) {
}
// If a level is provided but has no matching terms, provide a default.
return "Not Applicable";
});
};
handlebars_1.default.registerHelper("levelLabel", getLevelLabel);
handlebars_1.default.registerHelper("standardsIncluded", function (standardChapters) {
const result = [];
for (const standardChapter of standardChapters) {
Expand Down Expand Up @@ -145,42 +160,88 @@ function createOutput(data, catalogData, templateType, templateString) {
return levelCount;
});
handlebars_1.default.registerHelper("progressPerChapter", function (criterias) {
let supportCount = 0;
let partiallySupportCount = 0;
let doesNotSupportCount = 0;
let notApplicableCount = 0;
let tableHeader = "";
let tableHeaderMarkdownUnderline = "";
const tableCounts = [];
for (const component of criterias[0].components) {
if (templateType === "html") {
tableHeader += `<th>${getCatalogComponentLabel(component.name)}</th>`;
}
else {
tableHeader += ` | ${getCatalogComponentLabel(component.name)}`;
tableHeaderMarkdownUnderline += " | ---";
}
tableCounts[component.name] = [];
}
for (const criteria of criterias) {
if (criteria.components) {
for (const component of criteria.components) {
if (component.adherence && component.adherence.level === "supports") {
supportCount = supportCount + 1;
if (component.adherence) {
if (tableCounts[component.name] === undefined) {
if (templateType === "html") {
tableHeader += `<th>${getCatalogComponentLabel(component.name)}</th>`;
}
else {
tableHeader += ` | ${getCatalogComponentLabel(component.name)}`;
tableHeaderMarkdownUnderline += " | ---";
}
tableCounts[component.name] = [];
}
if (tableCounts[component.name][component.adherence.level]) {
tableCounts[component.name][component.adherence.level] += 1;
}
else {
tableCounts[component.name][component.adherence.level] = 1;
}
}
else if (component.adherence &&
component.adherence.level === "partially-supports") {
partiallySupportCount = partiallySupportCount + 1;
}
}
}
let tableBody = "";
if (catalogData.terms) {
for (const term of catalogData.terms) {
if (term.label != "" && term.id != "not-evaluated") {
if (templateType === "html") {
tableBody += `<tr><td>${getLevelLabel(term.id)}</td>`;
}
else {
tableBody += `| ${getLevelLabel(term.id)}`;
}
for (const component in tableCounts) {
if (templateType === "html") {
if (tableCounts[component] && tableCounts[component][term.id]) {
tableBody += `<td>${tableCounts[component][term.id]}</td>`;
}
else {
tableBody += "<td>0</td>";
}
}
else {
if (tableCounts[component] && tableCounts[component][term.id]) {
tableBody += ` | ${tableCounts[component][term.id]}`;
}
else {
tableBody += " | 0";
}
}
}
else if (component.adherence &&
component.adherence.level === "does-not-support") {
doesNotSupportCount = doesNotSupportCount + 1;
if (templateType === "html") {
tableBody += "</tr>";
}
else if (component.adherence &&
component.adherence.level === "not-applicable") {
notApplicableCount = notApplicableCount + 1;
else {
tableBody += ` |
`;
}
}
}
}
if (templateType === "html") {
return new handlebars_1.default.SafeString(`<li>${supportCount} supported</li>
<li>${partiallySupportCount} partially supported</li>
<li>${doesNotSupportCount} not supported</li>
<li>${notApplicableCount} not applicable</li>`);
return new handlebars_1.default.SafeString(`<thead><tr><th>Conformance Level</th>${tableHeader}</tr></thead>${tableBody}`);
}
else {
return `- ${supportCount} supported
- ${partiallySupportCount} partially supported
- ${doesNotSupportCount} not supported
- ${notApplicableCount} not applicable`;
return `| Conformance Level${tableHeader} |
| ---${tableHeaderMarkdownUnderline} |
${tableBody}`;
}
});
handlebars_1.default.registerHelper("sanitizeMarkdown", function (text) {
Expand Down
4 changes: 2 additions & 2 deletions docs/CLI.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ Current example OpenACRs that are tracked in this repository are in the `openacr

OpenACRs:

- drupal-10-15.yaml: Drupal 10 OpenACR.
- drupal-10-16.yaml: Drupal 10 OpenACR.
- drupal-9.yaml: Drupal 9 OpenACR.
- govready-0.9.yaml
- Moodle-3.yaml
Expand All @@ -180,7 +180,7 @@ OpenACRs:
To regenerate the above OpenACR markdown and HTML reports run the following commands:

```bash
npx ts-node src/openacr.ts output -f openacr/drupal-10-15.yaml -c catalog/2.4-edition-wcag-2.1-en.yaml -o openacr/drupal-10-15.html
npx ts-node src/openacr.ts output -f openacr/drupal-10-16.yaml -c catalog/2.4-edition-wcag-2.1-en.yaml -o openacr/drupal-10-16.html
npx ts-node src/openacr.ts output -f openacr/drupal-9.yaml -c catalog/2.4-edition-wcag-2.1-508-en.yaml -o openacr/drupal-9.html
npx ts-node src/openacr.ts output -f openacr/drupal-9.yaml -c catalog/2.4-edition-wcag-2.1-508-en.yaml -o openacr/drupal-9.markdown
npx ts-node src/openacr.ts output -f openacr/govready-0.9.yaml -c catalog/2.4-edition-wcag-2.0-508-en.yaml -o openacr/govready-0.9.html
Expand Down
Loading

0 comments on commit 86f890a

Please sign in to comment.