refactor: new structure

Author: apskhem

rust/catalyst-signed-doc-macro/src/rules/content_type.rs

@@ -0,0 +1,61 @@
+//! `RefRule` generation
+
+use proc_macro2::TokenStream;
+use quote::quote;
+
+use crate::signed_doc_spec::{self, IsRequired};
+
+/// Generating `RefRule` instantiation
+pub(crate) fn rule(
+    content_type: &signed_doc_spec::content_type::ContentType
+) -> anyhow::Result<TokenStream> {
+    if matches!(content_type.required, IsRequired::Excluded) {
+        anyhow::ensure!(
+            content_type.value.is_empty(),
+            "'value' field must not exist when 'required' is 'excluded'"
+        );
+
+        return Ok(quote! {
+            crate::validator::rules::ContentTypeRule::Unspecified
+        });
+    }
+
+    if matches!(content_type.required, IsRequired::Yes) {
+        anyhow::ensure!(!content_type.value.is_empty(), "'value' field must exist");
+    }
+
+    let exp = match content_type.value.as_str() {
+        "application/cbor" => quote! { ContentTypeRule::Cbor },
+        "application/cddl" => quote! { ContentTypeRule::Cddl },
+        "application/json" => quote! { ContentTypeRule::Json },
+        "application/json+schema" => quote! { ContentTypeRule::JsonSchema },
+        "text/css; charset=utf-8" => quote! { ContentTypeRule::Css },
+        "text/css; charset=utf-8; template=handlebars" => {
+            quote! { ContentTypeRule::CssHandlebars }
+        },
+        "text/html; charset=utf-8" => quote! { ContentTypeRule::Html },
+        "text/html; charset=utf-8; template=handlebars" => {
+            quote! { ContentTypeRule::HtmlHandlebars }
+        },
+        "text/markdown; charset=utf-8" => quote! { ContentTypeRule::Markdown },
+        "text/markdown; charset=utf-8; template=handlebars" => {
+            quote! { ContentTypeRule::MarkdownHandlebars }
+        },
+        "text/plain; charset=utf-8" => quote! { ContentTypeRule::Plain },
+        "text/plain; charset=utf-8; template=handlebars" => {
+            quote! { ContentTypeRule::PlainHandlebars }
+        },
+        _ => {
+            return Err(anyhow::anyhow!(
+                "Unsupported Content Type: {}",
+                content_type.value
+            ))
+        },
+    };
+
+    Ok(quote! {
+        crate::validator::rules::ContentTypeRule::Specified {
+            exp: crate::validator::rules::#exp,
+        }
+    })
+}

rust/catalyst-signed-doc-macro/src/rules/mod.rs

@@ -1,5 +1,6 @@
 //! `catalyst_signed_documents_rules!` macro implementation
 
+pub(crate) mod content_type;
 pub(crate) mod doc_ref;
 
 use proc_macro2::TokenStream;
@@ -15,13 +16,14 @@ pub(crate) fn catalyst_signed_documents_rules_impl() -> anyhow::Result<TokenStre
     for (doc_name, doc_spec) in spec.docs {
         let const_type_name_ident = doc_name.ident();
 
+        let content_type_rule = content_type::rule(&doc_spec.headers.content_type)?;
         let ref_rule = doc_ref::ref_rule(&doc_spec.metadata.doc_ref)?;
         // TODO: implement a proper initialization for all specific validation rules
         let rules = quote! {
             crate::validator::rules::Rules {
                 id: crate::validator::rules::IdRule,
                 ver: crate::validator::rules::VerRule,
-                content_type: crate::validator::rules::ContentTypeRule::NotSpecified,
+                content_type: #content_type_rule,
                 content_encoding: crate::validator::rules::ContentEncodingRule::Specified {
                     exp: ContentEncoding::Brotli,
                     optional: false,

rust/catalyst-signed-doc-macro/src/signed_doc_spec/content_type.rs

@@ -0,0 +1,10 @@
+//! `signed_doc.json` headers content type field JSON definition
+
+/// `signed_doc.json` "content type" field JSON object
+#[derive(serde::Deserialize)]
+#[allow(clippy::missing_docs_in_private_items)]
+pub(crate) struct ContentType {
+    #[allow(dead_code)]
+    pub(crate) required: super::IsRequired,
+    pub(crate) value: String,
+}

rust/catalyst-signed-doc-macro/src/signed_doc_spec/mod.rs

@@ -1,7 +1,7 @@
 //! Catalyst Signed Document spec type
 
+pub(crate) mod content_type;
 pub(crate) mod doc_ref;
-pub(crate) mod field;
 
 use std::{collections::HashMap, ops::Deref};
 
@@ -46,7 +46,7 @@ pub(crate) struct DocSpec {
     #[serde(rename = "type")]
     pub(crate) doc_type: String,
     /// `headers` field
-    pub(crate) headers: field::Headers,
+    pub(crate) headers: Headers,
     /// Document type metadata definitions
     pub(crate) metadata: Metadata,
 }
@@ -59,6 +59,14 @@ pub(crate) struct Metadata {
     pub(crate) doc_ref: doc_ref::Ref,
 }
 
+/// Document's metadata fields definition
+#[derive(serde::Deserialize)]
+#[allow(clippy::missing_docs_in_private_items)]
+pub(crate) struct Headers {
+    #[serde(rename = "content type")]
+    pub(crate) content_type: content_type::ContentType,
+}
+
 /// "required" field definition
 #[derive(serde::Deserialize)]
 #[serde(rename_all = "lowercase")]