add ReplyRule initialisation

Author: Mr-Leshiy

rust/catalyst-signed-doc-spec/src/metadata/mod.rs

@@ -1,6 +1,7 @@
 //! `metadata` field definition
 
 pub mod doc_ref;
+pub mod reply;
 pub mod template;
 
 /// Document's metadata fields definition
@@ -10,4 +11,5 @@ pub struct Metadata {
     pub template: template::Template,
     #[serde(rename = "ref")]
     pub doc_ref: doc_ref::Ref,
+    pub reply: reply::Reply,
 }

rust/catalyst-signed-doc-spec/src/metadata/reply.rs

@@ -0,0 +1,17 @@
+//! `signed_doc.json` "reply" field JSON definition
+
+use std::ops::Deref;
+
+use crate::metadata::doc_ref::Ref;
+
+/// `signed_doc.json` "reply" field JSON object
+#[derive(serde::Deserialize)]
+pub struct Reply(pub Ref);
+
+impl Deref for Reply {
+    type Target = Ref;
+
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}

rust/signed_doc/src/validator/mod.rs

@@ -93,7 +93,7 @@ fn proposal_comment_rule() -> Rules {
             optional: false,
         },
         reply: ReplyRule::Specified {
-            exp_reply_type: PROPOSAL_COMMENT.clone(),
+            allowed_type: PROPOSAL_COMMENT.clone(),
             optional: true,
         },
         section: SectionRule::NotSpecified,

rust/signed_doc/src/validator/rules/mod.rs

@@ -130,7 +130,7 @@ impl Rules {
                 template: TemplateRule::new(&spec.docs, &doc_spec.metadata.template)?,
                 parameters: ParametersRule::NotSpecified,
                 doc_ref: RefRule::new(&spec.docs, &doc_spec.metadata.doc_ref)?,
-                reply: ReplyRule::NotSpecified,
+                reply: ReplyRule::new(&spec.docs, &doc_spec.metadata.reply)?,
                 section: SectionRule::NotSpecified,
                 content: ContentRule::new(&doc_spec.payload)?,
                 kid: SignatureKidRule::new(&doc_spec.signers.roles),

rust/signed_doc/src/validator/rules/reply.rs

@@ -1,5 +1,11 @@
 //! `reply` rule type impl.
 
+use std::collections::HashMap;
+
+use catalyst_signed_doc_spec::{
+    is_required::IsRequired, metadata::reply::Reply, DocSpec, DocumentName,
+};
+
 use crate::{
     providers::CatalystSignedDocumentProvider, validator::rules::doc_ref::doc_refs_check,
     CatalystSignedDocument, DocType,
@@ -10,8 +16,8 @@ use crate::{
 pub(crate) enum ReplyRule {
     /// Is 'reply' specified
     Specified {
-        /// expected `type` field of the replied doc
-        exp_reply_type: DocType,
+        /// allowed `type` field of the replied doc
+        allowed_type: DocType,
         /// optional flag for the `ref` field
         optional: bool,
     },
@@ -20,6 +26,37 @@ pub(crate) enum ReplyRule {
 }
 
 impl ReplyRule {
+    /// Generating `RefRule` from specs
+    pub(crate) fn new(
+        docs: &HashMap<DocumentName, DocSpec>,
+        spec: &Reply,
+    ) -> anyhow::Result<Self> {
+        let optional = match spec.required {
+            IsRequired::Yes => false,
+            IsRequired::Optional => true,
+            IsRequired::Excluded => {
+                return Ok(Self::NotSpecified);
+            },
+        };
+
+        anyhow::ensure!(spec.doc_type.len() == 1, "'type' field should exists and has only one entry for the required 'reply' metadata definition");
+        anyhow::ensure!(
+            spec.multiple.is_some_and(|v| !v),
+            "'multiple' field should be only set to false for the required 'reply' metadata definition"
+        );
+
+        let doc_name = spec.doc_type.first().ok_or(anyhow::anyhow!("'type' field should exists and has only one entry for the required 'reply' metadata definition"))?;
+        let docs_spec = docs.get(doc_name).ok_or(anyhow::anyhow!(
+            "cannot find a document definition {doc_name}"
+        ))?;
+        let allowed_type = docs_spec.doc_type.as_str().parse()?;
+
+        Ok(Self::Specified {
+            allowed_type,
+            optional,
+        })
+    }
+
     /// Field validation rule
     pub(crate) async fn check<Provider>(
         &self,
@@ -31,7 +68,7 @@ impl ReplyRule {
     {
         let context: &str = "Reply rule check";
         if let Self::Specified {
-            exp_reply_type,
+            allowed_type: exp_reply_type,
             optional,
         } = self
         {
@@ -339,15 +376,15 @@ mod tests {
         let doc = doc_gen(exp_type.clone(), &mut provider);
 
         let non_optional_res = ReplyRule::Specified {
-            exp_reply_type: exp_type.clone(),
+            allowed_type: exp_type.clone(),
             optional: false,
         }
         .check(&doc, &provider)
         .await
         .unwrap();
 
         let optional_res = ReplyRule::Specified {
-            exp_reply_type: exp_type.clone(),
+            allowed_type: exp_type.clone(),
             optional: true,
         }
         .check(&doc, &provider)
@@ -362,7 +399,7 @@ mod tests {
     async fn reply_specified_optional_test() {
         let provider = TestCatalystProvider::default();
         let rule = ReplyRule::Specified {
-            exp_reply_type: UuidV4::new().into(),
+            allowed_type: UuidV4::new().into(),
             optional: true,
         };
 
@@ -371,7 +408,7 @@ mod tests {
 
         let provider = TestCatalystProvider::default();
         let rule = ReplyRule::Specified {
-            exp_reply_type: UuidV4::new().into(),
+            allowed_type: UuidV4::new().into(),
             optional: false,
         };