Updated progress function to also aggregate summary counts by level (#5)

* missed typo "anythng" * Updated progress function to also aggregate summary counts by term (levels). Displaying those values before each table. Adjusted the tests to consider the new div in there. * Added assertions for new summary section. * Added term labels for display purposes in new summary view. Co-authored-by: Mike Gifford <[email protected]>
CivicActions · Jan 25, 2023 · 9d399f1 · 9d399f1
1 parent 090f301
commit 9d399f1
Show file tree

Hide file tree

Showing 8 changed files with 71 additions and 13 deletions.
diff --git a/cypress/integration/catalog.test.js b/cypress/integration/catalog.test.js
@@ -56,7 +56,7 @@ describe("Catalogs", () => {
 
     cy.get("button").contains("View Report").click();
 
-    cy.get("#success_criteria_level_a-editor + table tbody tr").should(
+    cy.get("#success_criteria_level_a-summary + table tbody tr").should(
       "contain",
       wcag21Criteria
     );
@@ -74,7 +74,7 @@ describe("Catalogs", () => {
 
     cy.get("button").contains("View Report").click();
 
-    cy.get("#success_criteria_level_a-editor + table tbody tr").should(
+    cy.get("#success_criteria_level_a-summary + table tbody tr").should(
       "not.contain",
       wcag21Criteria
     );

diff --git a/cypress/integration/import.test.js b/cypress/integration/import.test.js
@@ -17,6 +17,11 @@ describe("Import", () => {
       hardware: 0,
       software: 0,
       support_documentation_and_services: 4,
+      summary: 25,
+      summary_supports: 58,
+      summary_partially: 3,
+      summary_does_not_supports: 5,
+      summary_na: 34,
     },
     {
       filename: "govready-0.9.yaml",
@@ -32,6 +37,11 @@ describe("Import", () => {
       hardware: 0,
       software: 0,
       support_documentation_and_services: 4,
+      summary: 25,
+      summary_supports: 32,
+      summary_partially: 9,
+      summary_does_not_supports: 7,
+      summary_na: 52,
     },
   ];
 
@@ -128,7 +138,23 @@ describe("Import", () => {
           "contain",
           `Last Modified Date: ${yamlExample.lastModifiedDate}`
         )
-        .should("contain", `Version: ${yamlExample.version}`);
+        .should("contain", `Version: ${yamlExample.version}`)
+        .get('[id="success_criteria_level_a-summary"] p')
+        .should(
+          "contain",
+          `Conformance to the ${yamlExample.summary} criteria listed below is distributed as follows:`
+        )
+        .get('[id="success_criteria_level_a-summary"] li')
+        .should("contain", `${yamlExample.summary_supports} supported`)
+        .should(
+          "contain",
+          `${yamlExample.summary_partially} partially supported`
+        )
+        .should(
+          "contain",
+          `${yamlExample.summary_does_not_supports} not supported`
+        )
+        .should("contain", `${yamlExample.summary_na} not applicable`);
 
       cy.get("@consoleError").should("not.be.called");
     });

diff --git a/cypress/integration/report.test.js b/cypress/integration/report.test.js
@@ -136,7 +136,7 @@ describe("Report", () => {
 
     cy.get("a[href='/report#non-text-content-editor']").click();
 
-    cy.get("#success_criteria_level_a-editor + table tbody tr")
+    cy.get("#success_criteria_level_a-summary + table tbody tr")
       .should("be.focused")
       .should("contain", "Web: Supports")
       .should("contain", "Web: Does support non-text content.");
@@ -155,7 +155,7 @@ describe("Report", () => {
     cy.get("a[href='/report#non-text-content-editor']").click();
 
     cy.get(
-      "#success_criteria_level_a-editor + table tbody tr td:nth-child(3) a"
+      "#success_criteria_level_a-summary + table tbody tr td:nth-child(3) a"
     )
       .should("have.attr", "href")
       .and("contains", "https://www.drupal.org/");
@@ -202,6 +202,6 @@ describe("Report", () => {
 
     cy.get("#hardware-editor + table").should("not.exist");
 
-    cy.get("#software-editor + table").should("exist");
+    cy.get("#software-summary + table").should("exist");
   });
 });
diff --git a/src/components/Component.svelte b/src/components/Component.svelte
@@ -99,8 +99,8 @@
       <HelpText type="components" field="notes" />
     </div>
   {:else}
-    <p>Could not find component '{component}' for critera '{criteria}' in '{chapterId}'.</p>
+    <p>Could not find component '{component}' for criteria '{criteria}' in '{chapterId}'.</p>
   {/if}
 {:else}
-  <p>Could not find component '{component}' for critera '{criteria}' in '{chapterId}'.</p>
+  <p>Could not find component '{component}' for criteria '{criteria}' in '{chapterId}'.</p>
 {/if}
diff --git a/src/components/report/ReportChapter.svelte b/src/components/report/ReportChapter.svelte
@@ -4,13 +4,19 @@
   import ReportChapterTableResult from "./ReportChapterTableResult.svelte";
   import HeaderWithAnchor from "../HeaderWithAnchor.svelte";
   import { sanitizeMarkdown } from "../../utils/sanitizeMarkdown.js";
+  import { getProgressPerChapter } from "../../utils/getEvaluatedItems.js";
+  import { getCatalog } from "../../utils/getCatalogs.js";
+  import termLabel from "../../data/termLabel.yaml";
 
   export let standard;
   export let chapterId;
   export let download = false;
   let catalogName = $evaluation.catalog;
+  let catalog = getCatalog($evaluation.catalog);
+  let terms = catalog.terms;
 
   $: chapter = getCatalogChapter(catalogName, chapterId);
+  $: progressPerChapter = getProgressPerChapter($evaluation);
 </script>
 
 <style>
@@ -44,6 +50,19 @@
 {/if}
 
 {#if $evaluation['chapters'][chapterId]['criteria'] && !$evaluation['chapters'][chapterId]['disabled'] }
+  <div id="{chapterId}-summary">
+    <p>
+      Conformance to the {$evaluation['chapters'][chapterId]['criteria'].length} criteria listed below is distributed as follows:
+    </p>
+    <ul>
+      {#each terms as term}
+        {#if termLabel[term.id]}
+          <li>{progressPerChapter[chapterId]['evaluated_by_term'][term.id]} {termLabel[term.id]}</li>
+        {/if}
+      {/each}
+    </ul>
+  </div>
+
   <table class="usa-table">
     <thead>
     <tr>

diff --git a/src/data/helpText.yaml b/src/data/helpText.yaml
@@ -20,7 +20,7 @@ report:
   last_modified_date: "Last modified date is a read-only field that is automatically updated."
   version: "Version is a read-only field that is automatically updated when report is uploaded."
   notes: "Any comments that you would like to add for the report. This can include related projects."
-  evaluation_methods_used: "Please describe in detail how this report was created. What tools and processes were used. How many and what type of pages were evaluated, along with anythng else which would provide context."
+  evaluation_methods_used: "Please describe in detail how this report was created. What tools and processes were used. How many and what type of pages were evaluated, along with anything else which would provide context."
   legal_disclaimer: "Optional field for legal disclaimer. Please list license here if it is not released under an open license. "
   repository: "URL for the git repository that contains the ACR."
   feedback: "Details about feedback from author."

diff --git a/src/data/termLabel.yaml b/src/data/termLabel.yaml
@@ -0,0 +1,4 @@
+supports: "supported"
+partially-supports: "partially supported"
+does-not-support: "not supported"
+not-applicable: "not applicable"
diff --git a/src/utils/getEvaluatedItems.js b/src/utils/getEvaluatedItems.js
@@ -4,7 +4,10 @@ export function getProgressPerChapter(evaluation) {
   let progressPerChapter = {};
 
   function getEvaluatedForChapter(chapter) {
-    const components = [];
+    const components_with_terms = {};
+    terms.forEach((term) => {
+      components_with_terms[term.id] = 0;
+    });
     if (evaluation.chapters[chapter.id].criteria) {
       evaluation.chapters[chapter.id].criteria.forEach((item) => {
         item.components.forEach((component) => {
@@ -13,12 +16,12 @@ export function getProgressPerChapter(evaluation) {
             component["adherence"]["level"] &&
             component["adherence"]["level"] != ""
           ) {
-            components.push(component);
+            components_with_terms[component["adherence"]["level"]]++;
           }
         });
       });
     }
-    return components.length;
+    return components_with_terms;
   }
 
   function getTotalForChapter(chapter) {
@@ -32,11 +35,17 @@ export function getProgressPerChapter(evaluation) {
   }
 
   let catalog = getCatalog(evaluation.catalog);
+  const terms = catalog.terms;
   catalog.chapters.forEach((chapter) => {
     const total = getTotalForChapter(chapter);
-    const evaluated = getEvaluatedForChapter(chapter);
+    const evaluated_by_term = getEvaluatedForChapter(chapter);
+    let evaluated = 0;
+    terms.forEach((term) => {
+      evaluated += evaluated_by_term[term.id];
+    });
 
     progressPerChapter[chapter.id] = {
+      evaluated_by_term: evaluated_by_term,
       evaluated: evaluated,
       total: total,
     };