Rename method in ValidationContext

This renames function `extend_context_with_struct_field to
`with_struct`.

Signed-off-by: Sebastian Ziebell <[email protected]>

Author: justahero

cyclonedx-bom/src/models/advisory.rs

@@ -49,12 +49,12 @@ impl Validate for Advisory {
         let mut results: Vec<ValidationResult> = vec![];
 
         if let Some(title) = &self.title {
-            let context = context.extend_context_with_struct_field("Advisory", "title");
+            let context = context.with_struct("Advisory", "title");
 
             results.push(title.validate_with_context(context));
         }
 
-        let url_context = context.extend_context_with_struct_field("Advisory", "url");
+        let url_context = context.with_struct("Advisory", "url");
         results.push(self.url.validate_with_context(url_context));
 
         results

cyclonedx-bom/src/models/attached_text.rs

@@ -49,7 +49,7 @@ impl Validate for AttachedText {
         let mut results: Vec<ValidationResult> = vec![];
 
         if let Some(content_type) = &self.content_type {
-            let context = context.extend_context_with_struct_field("AttachedText", "content_type");
+            let context = context.with_struct("AttachedText", "content_type");
 
             results.push(content_type.validate_with_context(context));
         }
@@ -58,8 +58,7 @@ impl Validate for AttachedText {
             match (encoding, STANDARD.decode(self.content.clone())) {
                 (Encoding::Base64, Ok(_)) => results.push(ValidationResult::Passed),
                 (Encoding::Base64, Err(_)) => {
-                    let context =
-                        context.extend_context_with_struct_field("AttachedText", "content");
+                    let context = context.with_struct("AttachedText", "content");
 
                     results.push(ValidationResult::Failed {
                         reasons: vec![FailureReason {
@@ -69,8 +68,7 @@ impl Validate for AttachedText {
                     })
                 }
                 (Encoding::UnknownEncoding(_), _) => {
-                    let context =
-                        context.extend_context_with_struct_field("AttachedText", "encoding");
+                    let context = context.with_struct("AttachedText", "encoding");
 
                     results.push(encoding.validate_with_context(context));
                 }
@@ -124,7 +122,7 @@ impl Validate for Encoding {
 
 #[cfg(test)]
 mod test {
-    use crate::{models::attached_text::Encoding, validation::ValidationPathComponent};
+    use crate::models::attached_text::Encoding;
 
     use super::*;
     use pretty_assertions::assert_eq;
@@ -174,17 +172,12 @@ mod test {
                         message:
                             "NormalizedString contains invalid characters \\r \\n \\t or \\r\\n"
                                 .to_string(),
-                        context: ValidationContext(vec![ValidationPathComponent::Struct {
-                            struct_name: "AttachedText".to_string(),
-                            field_name: "content_type".to_string()
-                        }])
+                        context: ValidationContext::new()
+                            .with_struct("AttachedText", "content_type")
                     },
                     FailureReason {
                         message: "Content is not Base64 encoded".to_string(),
-                        context: ValidationContext(vec![ValidationPathComponent::Struct {
-                            struct_name: "AttachedText".to_string(),
-                            field_name: "content".to_string()
-                        }])
+                        context: ValidationContext::new().with_struct("AttachedText", "content")
                     }
                 ]
             }
@@ -202,16 +195,11 @@ mod test {
 
         assert_eq!(
             validation_result,
-            ValidationResult::Failed {
-                reasons: vec![FailureReason {
-                    message: "Unknown encoding".to_string(),
-                    context: ValidationContext(vec![ValidationPathComponent::Struct {
-                        struct_name: "AttachedText".to_string(),
-                        field_name: "encoding".to_string()
-                    }])
-                }]
-            }
-        );
+            ValidationResult::failure(
+                "Unknown encoding",
+                ValidationContext::new().with_struct("AttachedText", "encoding")
+            )
+        )
     }
 
     #[test]

cyclonedx-bom/src/models/bom.rs

@@ -226,15 +226,15 @@ impl Validate for Bom {
         let mut bom_refs_context = BomReferencesContext::default();
 
         if let Some(serial_number) = &self.serial_number {
-            let context = context.extend_context_with_struct_field("Bom", "serial_number");
+            let context = context.with_struct("Bom", "serial_number");
 
             results.push(serial_number.validate_with_context(context));
         }
 
         if let Some(metadata) = &self.metadata {
-            let context = context.extend_context_with_struct_field("Bom", "metadata");
+            let context = context.with_struct("Bom", "metadata");
             let component_bom_ref_context =
-                context.extend_context_with_struct_field("Metadata", "component");
+                context.with_struct("Metadata", "component");
 
             results.push(metadata.validate_with_context(context));
 
@@ -249,7 +249,7 @@ impl Validate for Bom {
         }
 
         if let Some(components) = &self.components {
-            let context = context.extend_context_with_struct_field("Bom", "components");
+            let context = context.with_struct("Bom", "components");
             let component_bom_ref_context = context.clone();
 
             results.push(components.validate_with_context(context));
@@ -264,7 +264,7 @@ impl Validate for Bom {
         }
 
         if let Some(services) = &self.services {
-            let context = context.extend_context_with_struct_field("Bom", "services");
+            let context = context.with_struct("Bom", "services");
             let service_bom_ref_context = context.clone();
 
             results.push(services.validate_with_context(context));
@@ -279,21 +279,21 @@ impl Validate for Bom {
         }
 
         if let Some(external_references) = &self.external_references {
-            let context = context.extend_context_with_struct_field("Bom", "external_references");
+            let context = context.with_struct("Bom", "external_references");
 
             results.push(external_references.validate_with_context(context));
         }
 
         if let Some(dependencies) = &self.dependencies {
-            let context = context.extend_context_with_struct_field("Bom", "dependencies");
+            let context = context.with_struct("Bom", "dependencies");
 
             for (dependency_index, dependency) in dependencies.0.iter().enumerate() {
                 let context = context.extend_context(vec![ValidationPathComponent::Array {
                     index: dependency_index,
                 }]);
                 if !bom_refs_context.contains(&dependency.dependency_ref) {
                     let dependency_context =
-                        context.extend_context_with_struct_field("Dependency", "dependency_ref");
+                        context.with_struct("Dependency", "dependency_ref");
 
                     results.push(ValidationResult::Failed {
                         reasons: vec![FailureReason {
@@ -330,7 +330,7 @@ impl Validate for Bom {
         }
 
         if let Some(compositions) = &self.compositions {
-            let context = context.extend_context_with_struct_field("Bom", "compositions");
+            let context = context.with_struct("Bom", "compositions");
             let compositions_context = context.clone();
 
             results.push(compositions.validate_with_context(context));
@@ -343,7 +343,7 @@ impl Validate for Bom {
 
                 if let Some(assemblies) = &composition.assemblies {
                     let compositions_context = compositions_context
-                        .extend_context_with_struct_field("Composition", "assemblies");
+                        .with_struct("Composition", "assemblies");
                     for (assembly_index, BomReference(assembly)) in assemblies.iter().enumerate() {
                         if !bom_refs_context.contains(assembly) {
                             let compositions_context = compositions_context.extend_context(vec![
@@ -364,7 +364,7 @@ impl Validate for Bom {
 
                 if let Some(dependencies) = &composition.dependencies {
                     let compositions_context = compositions_context
-                        .extend_context_with_struct_field("Composition", "dependencies");
+                        .with_struct("Composition", "dependencies");
                     for (dependency_index, BomReference(dependency)) in
                         dependencies.iter().enumerate()
                     {
@@ -388,13 +388,13 @@ impl Validate for Bom {
         }
 
         if let Some(properties) = &self.properties {
-            let context = context.extend_context_with_struct_field("Bom", "properties");
+            let context = context.with_struct("Bom", "properties");
 
             results.push(properties.validate_with_context(context));
         }
 
         if let Some(vulnerabilities) = &self.vulnerabilities {
-            let context = context.extend_context_with_struct_field("Bom", "vulnerabilities");
+            let context = context.with_struct("Bom", "vulnerabilities");
             results.push(vulnerabilities.validate_with_context(context));
         }
 
@@ -432,7 +432,7 @@ fn validate_component_bom_refs(
 ) {
     if let Some(bom_ref) = &component.bom_ref {
         if bom_refs.contains(bom_ref) {
-            let context = context.extend_context_with_struct_field("Component", "bom_ref");
+            let context = context.with_struct("Component", "bom_ref");
             results.push(ValidationResult::Failed {
                 reasons: vec![FailureReason {
                     message: format!(r#"Bom ref "{bom_ref}" is not unique"#),
@@ -444,7 +444,7 @@ fn validate_component_bom_refs(
     }
 
     if let Some(components) = &component.components {
-        let context = context.extend_context_with_struct_field("Component", "components");
+        let context = context.with_struct("Component", "components");
         validate_components(components, bom_refs, &context, results);
     }
 }
@@ -473,7 +473,7 @@ fn validate_service_bom_refs(
 ) {
     if let Some(bom_ref) = &service.bom_ref {
         if bom_refs.contains(bom_ref) {
-            let context = context.extend_context_with_struct_field("Service", "bom_ref");
+            let context = context.with_struct("Service", "bom_ref");
             results.push(ValidationResult::Failed {
                 reasons: vec![FailureReason {
                     message: format!(r#"Bom ref "{bom_ref}" is not unique"#),
@@ -485,7 +485,7 @@ fn validate_service_bom_refs(
     }
 
     if let Some(services) = &service.services {
-        let context = context.extend_context_with_struct_field("Service", "services");
+        let context = context.with_struct("Service", "services");
         validate_services(services, bom_refs, &context, results);
     }
 }

cyclonedx-bom/src/models/code.rs

@@ -39,31 +39,31 @@ impl Validate for Commit {
         let mut results: Vec<ValidationResult> = vec![];
 
         if let Some(uid) = &self.uid {
-            let context = context.extend_context_with_struct_field("Commit", "uid");
+            let context = context.with_struct("Commit", "uid");
 
             results.push(uid.validate_with_context(context));
         }
 
         if let Some(url) = &self.url {
-            let context = context.extend_context_with_struct_field("Commit", "url");
+            let context = context.with_struct("Commit", "url");
 
             results.push(url.validate_with_context(context));
         }
 
         if let Some(author) = &self.author {
-            let context = context.extend_context_with_struct_field("Commit", "author");
+            let context = context.with_struct("Commit", "author");
 
             results.push(author.validate_with_context(context));
         }
 
         if let Some(committer) = &self.committer {
-            let context = context.extend_context_with_struct_field("Commit", "committer");
+            let context = context.with_struct("Commit", "committer");
 
             results.push(committer.validate_with_context(context));
         }
 
         if let Some(message) = &self.message {
-            let context = context.extend_context_with_struct_field("Commit", "message");
+            let context = context.with_struct("Commit", "message");
 
             results.push(message.validate_with_context(context));
         }
@@ -104,13 +104,13 @@ impl Validate for Diff {
         let mut results: Vec<ValidationResult> = vec![];
 
         if let Some(text) = &self.text {
-            let context = context.extend_context_with_struct_field("Diff", "text");
+            let context = context.with_struct("Diff", "text");
 
             results.push(text.validate_with_context(context));
         }
 
         if let Some(url) = &self.url {
-            let context = context.extend_context_with_struct_field("Diff", "url");
+            let context = context.with_struct("Diff", "url");
 
             results.push(url.validate_with_context(context));
         }
@@ -134,19 +134,19 @@ impl Validate for IdentifiableAction {
 
         if let Some(timestamp) = &self.timestamp {
             let context =
-                context.extend_context_with_struct_field("IdentifiableAction", "timestamp");
+                context.with_struct("IdentifiableAction", "timestamp");
 
             results.push(timestamp.validate_with_context(context));
         }
 
         if let Some(name) = &self.name {
-            let context = context.extend_context_with_struct_field("IdentifiableAction", "name");
+            let context = context.with_struct("IdentifiableAction", "name");
 
             results.push(name.validate_with_context(context));
         }
 
         if let Some(email) = &self.email {
-            let context = context.extend_context_with_struct_field("IdentifiableAction", "email");
+            let context = context.with_struct("IdentifiableAction", "email");
 
             results.push(email.validate_with_context(context));
         }
@@ -171,30 +171,30 @@ impl Validate for Issue {
     fn validate_with_context(&self, context: ValidationContext) -> ValidationResult {
         let mut results: Vec<ValidationResult> = vec![];
 
-        let issue_context = context.extend_context_with_struct_field("Issue", "issue_type");
+        let issue_context = context.with_struct("Issue", "issue_type");
 
         results.push(self.issue_type.validate_with_context(issue_context));
 
         if let Some(id) = &self.id {
-            let context = context.extend_context_with_struct_field("Issue", "id");
+            let context = context.with_struct("Issue", "id");
 
             results.push(id.validate_with_context(context));
         }
 
         if let Some(name) = &self.name {
-            let context = context.extend_context_with_struct_field("Issue", "name");
+            let context = context.with_struct("Issue", "name");
 
             results.push(name.validate_with_context(context));
         }
 
         if let Some(description) = &self.description {
-            let context = context.extend_context_with_struct_field("Issue", "description");
+            let context = context.with_struct("Issue", "description");
 
             results.push(description.validate_with_context(context));
         }
 
         if let Some(source) = &self.source {
-            let context = context.extend_context_with_struct_field("Issue", "source");
+            let context = context.with_struct("Issue", "source");
 
             results.push(source.validate_with_context(context));
         }
@@ -275,12 +275,12 @@ impl Validate for Patch {
     fn validate_with_context(&self, context: ValidationContext) -> ValidationResult {
         let mut results: Vec<ValidationResult> = vec![];
 
-        let patch_type_context = context.extend_context_with_struct_field("Patch", "patch_type");
+        let patch_type_context = context.with_struct("Patch", "patch_type");
 
         results.push(self.patch_type.validate_with_context(patch_type_context));
 
         if let Some(diff) = &self.diff {
-            let context = context.extend_context_with_struct_field("Patch", "diff");
+            let context = context.with_struct("Patch", "diff");
 
             results.push(diff.validate_with_context(context));
         }
@@ -382,13 +382,13 @@ impl Validate for Source {
         let mut results: Vec<ValidationResult> = vec![];
 
         if let Some(name) = &self.name {
-            let context = context.extend_context_with_struct_field("Source", "name");
+            let context = context.with_struct("Source", "name");
 
             results.push(name.validate_with_context(context));
         }
 
         if let Some(url) = &self.url {
-            let context = context.extend_context_with_struct_field("Source", "url");
+            let context = context.with_struct("Source", "url");
 
             results.push(url.validate_with_context(context));
         }