Opt out from default derives and attributes (#925)

* No default derives

* Clippy

* Clippy

* Review

* Review

* Typo

codegen/src/lib.rs

@@ -32,7 +32,7 @@
 //!     pub mod api {}
 //! );
 //! // Default module derivatives.
-//! let mut derives = DerivesRegistry::new(&CratePath::default());
+//! let mut derives = DerivesRegistry::with_default_derives(&CratePath::default());
 //! // Default type substitutes.
 //! let substs = TypeSubstitutes::new(&CratePath::default());
 //! // Generate the Runtime API.

codegen/src/types/derives.rs

@@ -16,21 +16,40 @@ pub struct DerivesRegistry {
     specific_type_derives: HashMap<syn::TypePath, Derives>,
 }
 
+impl Default for DerivesRegistry {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
 impl DerivesRegistry {
-    /// Creates a new `DerivesRegistry` with the supplied `crate_path`.
+    /// Creates a new `DerivesRegistry` with no default derives.
+    pub fn new() -> Self {
+        Self {
+            default_derives: Derives::new(),
+            specific_type_derives: Default::default(),
+        }
+    }
+
+    /// Creates a new `DerivesRegistry` with default derives.
     ///
     /// The `crate_path` denotes the `subxt` crate access path in the
     /// generated code.
-    pub fn new(crate_path: &CratePath) -> Self {
+    pub fn with_default_derives(crate_path: &CratePath) -> Self {
         Self {
-            default_derives: Derives::new(crate_path),
+            default_derives: Derives::with_defaults(crate_path),
             specific_type_derives: Default::default(),
         }
     }
 
     /// Insert derives to be applied to all generated types.
-    pub fn extend_for_all(&mut self, derives: impl IntoIterator<Item = syn::Path>) {
-        self.default_derives.derives.extend(derives)
+    pub fn extend_for_all(
+        &mut self,
+        derives: impl IntoIterator<Item = syn::Path>,
+        attributes: impl IntoIterator<Item = syn::Attribute>,
+    ) {
+        self.default_derives.derives.extend(derives);
+        self.default_derives.attributes.extend(attributes);
     }
 
     /// Insert derives to be applied to a specific generated type.
@@ -38,13 +57,14 @@ impl DerivesRegistry {
         &mut self,
         ty: syn::TypePath,
         derives: impl IntoIterator<Item = syn::Path>,
-        crate_path: &CratePath,
+        attributes: impl IntoIterator<Item = syn::Attribute>,
     ) {
         let type_derives = self
             .specific_type_derives
             .entry(ty)
-            .or_insert_with(|| Derives::new(crate_path));
-        type_derives.derives.extend(derives)
+            .or_insert_with(Derives::new);
+        type_derives.derives.extend(derives);
+        type_derives.attributes.extend(attributes);
     }
 
     /// Returns the derives to be applied to all generated types.
@@ -73,6 +93,12 @@ pub struct Derives {
     attributes: HashSet<syn::Attribute>,
 }
 
+impl Default for Derives {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
 impl FromIterator<syn::Path> for Derives {
     fn from_iter<T: IntoIterator<Item = Path>>(iter: T) -> Self {
         let derives = iter.into_iter().collect();
@@ -84,9 +110,17 @@ impl FromIterator<syn::Path> for Derives {
 }
 
 impl Derives {
+    /// Creates an empty instance of `Derives` (with no default derives).
+    pub fn new() -> Self {
+        Self {
+            derives: HashSet::new(),
+            attributes: HashSet::new(),
+        }
+    }
+
     /// Creates a new instance of `Derives` with the `crate_path` prepended
     /// to the set of default derives that reside in `subxt`.
-    pub fn new(crate_path: &CratePath) -> Self {
+    pub fn with_defaults(crate_path: &CratePath) -> Self {
         let mut derives = HashSet::new();
         let mut attributes = HashSet::new();
 
@@ -99,8 +133,6 @@ impl Derives {
         attributes.insert(syn::parse_quote!(#[decode_as_type(crate_path = #decode_crate_path)]));
 
         derives.insert(syn::parse_quote!(#crate_path::ext::codec::Encode));
-        attributes.insert(syn::parse_quote!(#[codec(crate = #crate_path::ext::codec)]));
-
         derives.insert(syn::parse_quote!(#crate_path::ext::codec::Decode));
         attributes.insert(syn::parse_quote!(#[codec(crate = #crate_path::ext::codec)]));
 

codegen/src/types/tests.rs

@@ -39,7 +39,7 @@ fn generate_struct_with_primitives() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -91,7 +91,7 @@ fn generate_struct_with_a_struct_field() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -145,7 +145,7 @@ fn generate_tuple_struct() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -236,7 +236,7 @@ fn derive_compact_as_for_uint_wrapper_structs() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -333,7 +333,7 @@ fn generate_enum() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -397,7 +397,7 @@ fn compact_fields() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -465,7 +465,7 @@ fn compact_generic_parameter() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -512,7 +512,7 @@ fn generate_array_field() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -555,7 +555,7 @@ fn option_fields() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -601,7 +601,7 @@ fn box_fields_struct() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -647,7 +647,7 @@ fn box_fields_enum() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -693,7 +693,7 @@ fn range_fields() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -743,7 +743,7 @@ fn generics() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -800,7 +800,7 @@ fn generics_nested() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -857,7 +857,7 @@ fn generate_bitvec() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -916,7 +916,7 @@ fn generics_with_alias_adds_phantom_data_marker() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -987,7 +987,7 @@ fn modules() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -1056,7 +1056,7 @@ fn dont_force_struct_names_camel_case() {
         &portable_types,
         "root",
         TypeSubstitutes::new(&crate_path),
-        DerivesRegistry::new(&crate_path),
+        DerivesRegistry::with_default_derives(&crate_path),
         crate_path,
         true,
     );
@@ -1096,8 +1096,11 @@ fn apply_user_defined_derives_for_all_types() {
 
     let crate_path = "::subxt_path".into();
     // configure derives
-    let mut derives = DerivesRegistry::new(&crate_path);
-    derives.extend_for_all(vec![parse_quote!(Clone), parse_quote!(Eq)]);
+    let mut derives = DerivesRegistry::with_default_derives(&crate_path);
+    derives.extend_for_all(
+        vec![parse_quote!(Clone), parse_quote!(Eq)],
+        vec![parse_quote!(#[some_attribute])],
+    );
 
     let type_gen = TypeGenerator::new(
         &portable_types,
@@ -1120,12 +1123,14 @@ fn apply_user_defined_derives_for_all_types() {
                 #[codec(crate = ::subxt_path::ext::codec)]
                 #[decode_as_type(crate_path = ":: subxt_path :: ext :: scale_decode")]
                 #[encode_as_type(crate_path = ":: subxt_path :: ext :: scale_encode")]
+                #[some_attribute]
                 pub struct A(pub root :: subxt_codegen :: types :: tests :: B,);
 
                 #[derive(::subxt_path::ext::codec::Decode, ::subxt_path::ext::codec::Encode, ::subxt_path::ext::scale_decode::DecodeAsType, ::subxt_path::ext::scale_encode::EncodeAsType, Clone, Debug, Eq)]
                 #[codec(crate = ::subxt_path::ext::codec)]
                 #[decode_as_type(crate_path = ":: subxt_path :: ext :: scale_decode")]
                 #[encode_as_type(crate_path = ":: subxt_path :: ext :: scale_encode")]
+                #[some_attribute]
                 pub struct B;
             }
         }
@@ -1153,14 +1158,14 @@ fn apply_user_defined_derives_for_specific_types() {
 
     let crate_path = "::subxt_path".into();
     // configure derives
-    let mut derives = DerivesRegistry::new(&crate_path);
+    let mut derives = DerivesRegistry::with_default_derives(&crate_path);
     // for all types
-    derives.extend_for_all(vec![parse_quote!(Eq)]);
+    derives.extend_for_all(vec![parse_quote!(Eq)], vec![]);
     // for specific types
     derives.extend_for_type(
         parse_quote!(subxt_codegen::types::tests::B),
         vec![parse_quote!(Hash)],
-        &crate_path,
+        vec![parse_quote!(#[some_attribute])],
     );
     // duplicates (in this case `Eq`) will be combined (i.e. a set union)
     derives.extend_for_type(
@@ -1170,7 +1175,7 @@ fn apply_user_defined_derives_for_specific_types() {
             parse_quote!(Ord),
             parse_quote!(PartialOrd),
         ],
-        &crate_path,
+        vec![],
     );
 
     let type_gen = TypeGenerator::new(
@@ -1200,6 +1205,7 @@ fn apply_user_defined_derives_for_specific_types() {
                 #[codec(crate = ::subxt_path::ext::codec)]
                 #[decode_as_type(crate_path = ":: subxt_path :: ext :: scale_decode")]
                 #[encode_as_type(crate_path = ":: subxt_path :: ext :: scale_encode")]
+                #[some_attribute]
                 pub struct B(pub root :: subxt_codegen :: types :: tests :: C,);
 
                 #[derive(::subxt_path::ext::codec::Decode, ::subxt_path::ext::codec::Encode, ::subxt_path::ext::scale_decode::DecodeAsType, ::subxt_path::ext::scale_encode::EncodeAsType, Debug, Eq, Ord, PartialOrd)]
@@ -1212,3 +1218,61 @@ fn apply_user_defined_derives_for_specific_types() {
             .to_string()
     )
 }
+
+#[test]
+fn opt_out_from_default_derives() {
+    #[allow(unused)]
+    #[derive(TypeInfo)]
+    struct A(B);
+
+    #[allow(unused)]
+    #[derive(TypeInfo)]
+    struct B;
+
+    let mut registry = Registry::new();
+    registry.register_type(&meta_type::<A>());
+    let portable_types: PortableRegistry = registry.into();
+
+    let crate_path = "::subxt_path".into();
+    // configure derives
+    let mut derives = DerivesRegistry::new();
+    derives.extend_for_all(
+        vec![parse_quote!(Clone), parse_quote!(Eq)],
+        vec![parse_quote!(#[some_attribute])],
+    );
+    derives.extend_for_type(
+        parse_quote!(subxt_codegen::types::tests::B),
+        vec![parse_quote!(Hash)],
+        vec![parse_quote!(#[some_other_attribute])],
+    );
+
+    let type_gen = TypeGenerator::new(
+        &portable_types,
+        "root",
+        TypeSubstitutes::new(&crate_path),
+        derives,
+        crate_path,
+        true,
+    );
+    let types = type_gen.generate_types_mod().expect("Valid type mod; qed");
+    let tests_mod = get_mod(&types, MOD_PATH).unwrap();
+
+    assert_eq!(
+        tests_mod.into_token_stream().to_string(),
+        quote! {
+            pub mod tests {
+                use super::root;
+
+                #[derive(Clone, Eq)]
+                #[some_attribute]
+                pub struct A(pub root :: subxt_codegen :: types :: tests :: B,);
+
+                #[derive(Clone, Eq, Hash)]
+                #[some_attribute]
+                #[some_other_attribute]
+                pub struct B;
+            }
+        }
+        .to_string()
+    )
+}