Make section optional, fixes #11

Author: simoncozens

fontspector-checkapi/src/check.rs

@@ -66,7 +66,7 @@ impl<'a> Check<'a> {
         &'a self,
         fn_result: CheckFnResult,
         file: Option<&'a Testable>,
-        section: &str,
+        section: Option<&str>,
     ) -> CheckResult {
         let subresults = match fn_result {
             Ok(results) => results.collect::<Vec<_>>(),
@@ -88,7 +88,7 @@ impl<'a> Check<'a> {
         &'a self,
         testable: &'a TestableType,
         context: &Context,
-        section: &str,
+        section: Option<&str>,
     ) -> Option<CheckResult> {
         match (&self.implementation, testable) {
             (CheckImplementation::CheckAll(_), TestableType::Single(_)) => None,

fontspector-checkapi/src/checkresult.rs

@@ -32,7 +32,7 @@ pub struct CheckResult {
     /// The file which was checked; if None, the check was run on all files
     pub filename: Option<String>,
     /// The section of the profile this check belongs to
-    pub section: String,
+    pub section: Option<String>,
     /// The individual results of the check
     pub subresults: Vec<Status>,
     /// If hotfixing was attempted, the result of the hotfix
@@ -68,15 +68,15 @@ impl CheckResult {
     pub fn new(
         check: &Check,
         filename: Option<&str>,
-        section: &str,
+        section: Option<&str>,
         subresults: Vec<Status>,
     ) -> Self {
         Self {
             check_id: check.id.to_string(),
             check_name: check.title.to_string(),
             check_rationale: check.rationale.to_string(),
             filename: filename.map(|x| x.to_string()),
-            section: section.to_string(),
+            section: section.map(|x| x.to_string()),
             subresults,
             hotfix_result: None,
             sourcefix_result: None,

fontspector-cli/src/main.rs

@@ -192,7 +192,11 @@ fn main() {
     #[allow(clippy::unwrap_used)] // We check for is_some before unwrapping
     let results: RunResults = checkorder_iterator
         .map(|(sectionname, testable, check, context)| {
-            (testable, check, check.run(testable, context, sectionname))
+            (
+                testable,
+                check,
+                check.run(testable, context, Some(sectionname)),
+            )
         })
         .filter(|(_, _, result)| result.is_some())
         .map(|(testable, check, result)| (testable, check, result.unwrap()))

fontspector-cli/src/reporters/mod.rs

@@ -42,7 +42,6 @@ impl RunResults {
     pub fn organize(&self) -> OrganisedResults {
         let mut organised_results: OrganisedResults = HashMap::new();
         for checkresult in self.iter() {
-            // let filename = testable.filename.clone();
             let section = organised_results
                 .entry(
                     checkresult
@@ -51,7 +50,14 @@ impl RunResults {
                         .unwrap_or("All fonts".to_string()),
                 )
                 .or_default();
-            let results = section.entry(checkresult.section.clone()).or_default();
+            let results = section
+                .entry(
+                    checkresult
+                        .section
+                        .clone()
+                        .unwrap_or("No section".to_string()),
+                )
+                .or_default();
             results.push(checkresult.clone());
         }
         organised_results

fontspector-web/src/lib.rs

@@ -56,7 +56,11 @@ pub fn check_fonts(fonts: &JsValue) -> Result<String, JsValue> {
     let results: Vec<CheckResult> = checkorder
         .iter()
         .map(|(sectionname, testable, check, context)| {
-            (testable, check, check.run(testable, context, sectionname))
+            (
+                testable,
+                check,
+                check.run(testable, context, Some(sectionname)),
+            )
         })
         .flat_map(|(_, _, result)| result)
         .collect();