Release v2.3.0 (#170)

* Allow `PortableRegistry` to be used at runtime Signed-off-by: xermicus <bigcyrill@hotmail.com> Co-authored-by: Andrew Jones <ascjones@gmail.com>
paritytech · Oct 31, 2022 · ad90cb1 · ad90cb1
1 parent a69ac55
commit ad90cb1
Show file tree

Hide file tree

Showing 10 changed files with 109 additions and 74 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.3.0] - 2022-10.27
+
+Implement the missing pieces for constructing `PortableRegistry` dynamically at runtime. This allows languages where static rust types are not available to use it.
+
 ## [2.2.0] - 2022-09-14
 
 The minimum Rust version is bumped to 1.60.0 in this release owing to using weak dependency crate features. Otherwise there are no breaking changes.

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "scale-info"
-version = "2.2.0"
+version = "2.3.0"
 authors = ["Parity Technologies <admin@parity.io>"]
 edition = "2021"
 rust-version = "1.60.0"
@@ -17,7 +17,7 @@ include = ["Cargo.toml", "src/**/*.rs", "README.md", "LICENSE"]
 [dependencies]
 bitvec = { version = "1", default-features = false, features = ["alloc"], optional = true }
 cfg-if = "1.0"
-scale-info-derive = { version = "2.2.0", path = "derive", default-features = false, optional = true }
+scale-info-derive = { version = "2.3.0", path = "derive", default-features = false, optional = true }
 serde = { version = "1", default-features = false, optional = true, features = ["derive", "alloc"] }
 derive_more = { version = "0.99.1", default-features = false, features = ["from"] }
 scale = { package = "parity-scale-codec", version = "3", default-features = false, features = ["derive"] }

diff --git a/derive/Cargo.toml b/derive/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "scale-info-derive"
-version = "2.2.0"
+version = "2.3.0"
 authors = [
     "Parity Technologies <admin@parity.io>",
     "Centrality Developers <support@centrality.ai>",

diff --git a/derive/src/lib.rs b/derive/src/lib.rs
@@ -290,7 +290,7 @@ impl TypeInfoImpl {
 
         if !docs.is_empty() {
             Some(quote! {
-                .#docs_builder_fn([ #( #docs ),* ])
+                .#docs_builder_fn(&[ #( #docs ),* ])
             })
         } else {
             None

diff --git a/src/build.rs b/src/build.rs
@@ -214,33 +214,38 @@ impl<F: Form, S> TypeBuilder<F, S> {
         self.type_params = type_params.into_iter().collect();
         self
     }
+}
 
+impl<S> TypeBuilder<PortableForm, S> {
     #[cfg(feature = "docs")]
-    /// Set the type documentation
-    pub fn docs<I>(mut self, docs: I) -> Self
+    /// Set the type documentation (for types in portable form).
+    pub fn docs_portable<I>(mut self, docs: I) -> Self
     where
-        I: IntoIterator<Item = F::String>,
+        I: IntoIterator<Item = <PortableForm as Form>::String>,
     {
         self.docs = docs.into_iter().collect();
         self
     }
+}
+
+impl<S> TypeBuilder<MetaForm, S> {
+    #[cfg(feature = "docs")]
+    /// Set the type documentation
+    pub fn docs(mut self, docs: &[&'static str]) -> Self {
+        self.docs = docs.to_vec();
+        self
+    }
 
     #[cfg(not(feature = "docs"))]
     #[inline]
     /// Doc capture is not enabled via the "docs" feature so this is a no-op.
-    pub fn docs<I>(self, _docs: I) -> Self
-    where
-        I: IntoIterator<Item = F::String>,
-    {
+    pub fn docs(self, _docs: &'static [&'static str]) -> Self {
         self
     }
 
     /// Set the type documentation, always captured even if the "docs" feature is not enabled.
-    pub fn docs_always<I>(mut self, docs: I) -> Self
-    where
-        I: IntoIterator<Item = F::String>,
-    {
-        self.docs = docs.into_iter().collect();
+    pub fn docs_always(mut self, docs: &[&'static str]) -> Self {
+        self.docs = docs.to_vec();
         self
     }
 }
@@ -503,43 +508,48 @@ impl<F: Form, N, T> FieldBuilder<F, N, T> {
             marker: PhantomData,
         }
     }
+}
 
+impl<N, T> FieldBuilder<PortableForm, N, T> {
     #[cfg(feature = "docs")]
-    /// Initialize the documentation of a field (optional).
-    pub fn docs<I>(self, docs: I) -> FieldBuilder<F, N, T>
+    /// Initialize the documentation of a field (for types in portable form, optional).
+    pub fn docs_portable<I>(mut self, docs: I) -> Self
     where
-        I: IntoIterator<Item = F::String>,
+        I: IntoIterator<Item = <PortableForm as Form>::String>,
     {
+        self.docs = docs.into_iter().collect();
+        self
+    }
+}
+
+impl<N, T> FieldBuilder<MetaForm, N, T> {
+    #[cfg(feature = "docs")]
+    /// Initialize the documentation of a field (optional).
+    pub fn docs(self, docs: &'static [&'static str]) -> Self {
         FieldBuilder {
             name: self.name,
             ty: self.ty,
             type_name: self.type_name,
-            docs: docs.into_iter().collect(),
+            docs: docs.to_vec(),
             marker: PhantomData,
         }
     }
 
     #[cfg(not(feature = "docs"))]
     #[inline]
     /// Doc capture is not enabled via the "docs" feature so this is a no-op.
-    pub fn docs<I>(self, _docs: I) -> FieldBuilder<F, N, T>
-    where
-        I: IntoIterator<Item = F::String>,
-    {
+    pub fn docs(self, _docs: &'static [&'static str]) -> Self {
         self
     }
 
     /// Initialize the documentation of a field, always captured even if the "docs" feature is not
     /// enabled.
-    pub fn docs_always<I>(self, docs: I) -> Self
-    where
-        I: IntoIterator<Item = F::String>,
-    {
+    pub fn docs_always(self, docs: &'static [&'static str]) -> Self {
         FieldBuilder {
             name: self.name,
             ty: self.ty,
             type_name: self.type_name,
-            docs: docs.into_iter().collect(),
+            docs: docs.to_vec(),
             marker: PhantomData,
         }
     }
@@ -652,34 +662,39 @@ impl<F: Form, S> VariantBuilder<F, S> {
         self.fields = fields_builder.finalize();
         self
     }
+}
 
+impl<S> VariantBuilder<PortableForm, S> {
     #[cfg(feature = "docs")]
-    /// Initialize the variant's documentation.
-    pub fn docs<I>(mut self, docs: I) -> Self
+    /// Initialize the variant's documentation (for types in portable form).
+    pub fn docs_portable<I>(mut self, docs: I) -> Self
     where
-        I: IntoIterator<Item = F::String>,
+        I: IntoIterator<Item = <PortableForm as Form>::String>,
     {
-        self.docs = docs.into_iter().map(Into::into).collect();
+        self.docs = docs.into_iter().collect();
+        self
+    }
+}
+
+impl<S> VariantBuilder<MetaForm, S> {
+    #[cfg(feature = "docs")]
+    /// Initialize the variant's documentation.
+    pub fn docs(mut self, docs: &[&'static str]) -> Self {
+        self.docs = docs.to_vec();
         self
     }
 
     #[cfg(not(feature = "docs"))]
     #[inline]
     /// Doc capture is not enabled via the "docs" feature so this is a no-op.
-    pub fn docs<I>(self, _docs: I) -> Self
-    where
-        I: IntoIterator<Item = F::String>,
-    {
+    pub fn docs(self, _docs: &[&'static str]) -> Self {
         self
     }
 
     /// Initialize the variant's documentation, always captured even if the "docs" feature is not
     /// enabled.
-    pub fn docs_always<I>(mut self, docs: I) -> Self
-    where
-        I: IntoIterator<Item = F::String>,
-    {
-        self.docs = docs.into_iter().collect();
+    pub fn docs_always(mut self, docs: &[&'static str]) -> Self {
+        self.docs = docs.to_vec();
         self
     }
 }

diff --git a/src/impls.rs b/src/impls.rs
@@ -337,7 +337,7 @@ impl<T> TypeInfo for PhantomData<T> {
         // Fields of this type should be filtered out and never appear in the type graph.
         Type::builder()
             .path(Path::prelude("PhantomData"))
-            .docs(["PhantomData placeholder, this type should be filtered out"])
+            .docs(&["PhantomData placeholder, this type should be filtered out"])
             .composite(Fields::unit())
     }
 }

diff --git a/src/registry.rs b/src/registry.rs
@@ -23,11 +23,14 @@
 //! namespaces. The normal Rust namespace of a type is used, except for the Rust
 //! prelude types that live in the so-called root namespace which is empty.
 
-use crate::prelude::{
-    any::TypeId,
-    collections::BTreeMap,
-    fmt::Debug,
-    vec::Vec,
+use crate::{
+    form::Form,
+    prelude::{
+        any::TypeId,
+        collections::BTreeMap,
+        fmt::Debug,
+        vec::Vec,
+    },
 };
 
 use crate::{
@@ -49,6 +52,14 @@ pub trait IntoPortable {
     fn into_portable(self, registry: &mut Registry) -> Self::Output;
 }
 
+impl IntoPortable for &'static str {
+    type Output = <PortableForm as Form>::String;
+
+    fn into_portable(self, _registry: &mut Registry) -> Self::Output {
+        self.into()
+    }
+}
+
 /// The registry for space-efficient storage of type identifiers and
 /// definitions.
 ///

diff --git a/src/tests.rs b/src/tests.rs
@@ -111,7 +111,7 @@ fn phantom_data() {
         PhantomData<i32>,
         Type::builder()
             .path(Path::prelude("PhantomData"))
-            .docs(["PhantomData placeholder, this type should be filtered out"])
+            .docs(&["PhantomData placeholder, this type should be filtered out"])
             .composite(Fields::unit())
     )
 }

diff --git a/src/ty/path.rs b/src/ty/path.rs
@@ -129,7 +129,7 @@ impl Path<MetaForm> {
     /// - If the supplied ident is not a valid Rust identifier
     pub(crate) fn prelude(ident: <MetaForm as Form>::String) -> Self {
         Self::from_segments([ident])
-            .unwrap_or_else(|_| panic!("{:?} is not a valid Rust identifier", ident))
+            .unwrap_or_else(|_| panic!("{ident:?} is not a valid Rust identifier"))
     }
 }