expand docs to argument and field as well

Author: rustopian

codama-attributes/src/codama_directives/argument_directive.rs

@@ -4,7 +4,7 @@ use crate::{
     Attribute, CodamaAttribute, CodamaDirective,
 };
 use codama_errors::CodamaError;
-use codama_nodes::{Docs, InstructionArgumentNode};
+use codama_nodes::InstructionArgumentNode;
 use codama_syn_helpers::Meta;
 
 #[derive(Debug, PartialEq)]
@@ -19,6 +19,7 @@ impl ArgumentDirective {
         let consumer = StructFieldMetaConsumer::from_meta(meta)?
             .consume_field()?
             .consume_argument_default_value()?
+            .consume_docs()?
             .consume_after()?
             .assert_fully_consumed()?;
 
@@ -30,7 +31,7 @@ impl ArgumentDirective {
             argument: InstructionArgumentNode {
                 name: consumer.name.take(meta)?,
                 r#type: consumer.r#type.take(meta)?,
-                docs: Docs::default(),
+                docs: consumer.docs.option().unwrap_or_default(),
                 default_value,
                 default_value_strategy,
             },
@@ -106,4 +107,21 @@ mod tests {
             }
         );
     }
+
+    #[test]
+    fn with_docs_string() {
+        let meta: Meta = syn::parse_quote! { argument("cake", number(u8), docs = "The cake") };
+        let directive = ArgumentDirective::parse(&meta).unwrap();
+        assert_eq!(directive.argument.docs, vec!["The cake".to_string()].into());
+    }
+
+    #[test]
+    fn with_docs_array() {
+        let meta: Meta = syn::parse_quote! { argument("cake", number(u8), docs = ["The cake", "must be a lie"]) };
+        let directive = ArgumentDirective::parse(&meta).unwrap();
+        assert_eq!(
+            directive.argument.docs,
+            vec!["The cake".to_string(), "must be a lie".to_string()].into()
+        );
+    }
 }

codama-attributes/src/codama_directives/field_directive.rs

@@ -4,7 +4,7 @@ use crate::{
     Attribute, CodamaAttribute, CodamaDirective,
 };
 use codama_errors::CodamaError;
-use codama_nodes::{Docs, StructFieldTypeNode};
+use codama_nodes::StructFieldTypeNode;
 use codama_syn_helpers::Meta;
 
 #[derive(Debug, PartialEq)]
@@ -19,6 +19,7 @@ impl FieldDirective {
         let consumer = StructFieldMetaConsumer::from_meta(meta)?
             .consume_field()?
             .consume_default_value()?
+            .consume_docs()?
             .consume_after()?
             .assert_fully_consumed()?;
 
@@ -30,7 +31,7 @@ impl FieldDirective {
             field: StructFieldTypeNode {
                 name: consumer.name.take(meta)?,
                 r#type: consumer.r#type.take(meta)?,
-                docs: Docs::default(),
+                docs: consumer.docs.option().unwrap_or_default(),
                 default_value,
                 default_value_strategy,
             },
@@ -106,4 +107,21 @@ mod tests {
             }
         );
     }
+
+    #[test]
+    fn with_docs_string() {
+        let meta: Meta = syn::parse_quote! { field("splines", number(u8), docs = "Splines") };
+        let directive = FieldDirective::parse(&meta).unwrap();
+        assert_eq!(directive.field.docs, vec!["Splines".to_string()].into());
+    }
+
+    #[test]
+    fn with_docs_array() {
+        let meta: Meta = syn::parse_quote! { field("age", number(u8), docs = ["Splines", "Must be pre-reticulated"]) };
+        let directive = FieldDirective::parse(&meta).unwrap();
+        assert_eq!(
+            directive.field.docs,
+            vec!["Splines".to_string(), "Must be pre-reticulated".to_string()].into()
+        );
+    }
 }

codama-attributes/src/codama_directives/type_nodes/struct_field_meta_consumer.rs

@@ -3,7 +3,7 @@ use crate::{
     DefaultValueDirective,
 };
 use codama_nodes::{
-    CamelCaseString, DefaultValueStrategy, InstructionInputValueNode, TypeNode, ValueNode,
+    CamelCaseString, DefaultValueStrategy, Docs, InstructionInputValueNode, TypeNode, ValueNode,
 };
 use codama_syn_helpers::{extensions::*, Meta};
 
@@ -13,6 +13,7 @@ pub(crate) struct StructFieldMetaConsumer {
     pub r#type: SetOnce<TypeNode>,
     pub default_value: SetOnce<DefaultValueDirective>,
     pub after: SetOnce<bool>,
+    pub docs: SetOnce<Docs>,
 }
 
 impl MetaConsumer for StructFieldMetaConsumer {
@@ -23,6 +24,7 @@ impl MetaConsumer for StructFieldMetaConsumer {
             r#type: SetOnce::new("type"),
             default_value: SetOnce::new("default_value"),
             after: SetOnce::new("after"),
+            docs: SetOnce::new("docs"),
         }
     }
 
@@ -94,6 +96,16 @@ impl StructFieldMetaConsumer {
         })
     }
 
+    pub fn consume_docs(self) -> syn::Result<Self> {
+        self.consume_metas(|this, meta| match meta.path_str().as_str() {
+            "docs" => {
+                this.docs.set(Docs::from_meta(&meta)?, meta)?;
+                Ok(None)
+            }
+            _ => Ok(Some(meta)),
+        })
+    }
+
     pub fn default_value_strategy(&self) -> Option<DefaultValueStrategy> {
         self.default_value
             .option_ref()