feat!: move runtime validation to crate feature (#160)

* pain

* more pain

* :o

* fmt

* validation should dep on derive too

* update comments

Author: cakekindel

Cargo.toml

@@ -17,7 +17,7 @@ categories = ["data-structures"]
 [features]
 unstable = ["blox", "validation"]
 blox = ["mox"]
-validation = []
+validation = ["validator", "validator_derive"]
 
 [package.metadata.docs.rs]
 all-features = true
@@ -28,12 +28,12 @@ maintenance = { status = "actively-developed" }
 
 [dependencies]
 serde = { version = "^1", features = ["derive"] }
-serde_json = "^1"
-validator = "0.10.0"
-validator_derive = "0.10.0"
+validator = { version = "0.10.0", optional = true }
+validator_derive = { version = "0.10.0", optional = true }
 mox = { version = "0.12", optional = true }
 
 [dev-dependencies]
+serde_json = "^1"
 lazy_static = "1.4.0"
 mox = "0.12"
 pretty_assertions = "0.7.2"

src/blocks/actions.rs

@@ -10,8 +10,11 @@
 use std::{borrow::Cow, convert::TryFrom};
 
 use serde::{Deserialize, Serialize};
+#[cfg(feature = "validation")]
 use validator::Validate;
 
+#[cfg(feature = "validation")]
+use crate::val_helpr::*;
 use crate::{convert,
             elems::{select,
                     BlockElement,
@@ -20,8 +23,7 @@ use crate::{convert,
                     DatePicker,
                     Overflow,
                     Radio,
-                    TextInput},
-            val_helpr::*};
+                    TextInput}};
 
 /// # Actions Block
 ///
@@ -31,20 +33,15 @@ use crate::{convert,
 ///
 /// [slack api docs 🔗]: https://api.slack.com/reference/block-kit/blocks#actions
 /// [elements 🔗]: https://api.slack.com/reference/messaging/block-elements
-#[derive(Clone,
-           Debug,
-           Default,
-           Deserialize,
-           Hash,
-           PartialEq,
-           Serialize,
-           Validate)]
+#[derive(Clone, Debug, Default, Deserialize, Hash, PartialEq, Serialize)]
+#[cfg_attr(feature = "validation", derive(Validate))]
 pub struct Actions<'a> {
-  #[validate(length(max = 5))]
+  #[cfg_attr(feature = "validation", validate(length(max = 5)))]
   elements: Vec<SupportedElement<'a>>,
 
   #[serde(skip_serializing_if = "Option::is_none")]
-  #[validate(custom = "super::validate_block_id")]
+  #[cfg_attr(feature = "validation",
+             validate(custom = "super::validate_block_id"))]
   block_id: Option<Cow<'a, str>>,
 }
 
@@ -59,10 +56,8 @@ impl<'a> Actions<'a> {
   /// Validate that this Section block agrees with Slack's model requirements
   ///
   /// # Errors
-  /// - If `with_block_id` was called with a block id longer
-  ///     than 255 chars
-  /// - If `from_elements` or `from_action_elements` was
-  ///     called with more than 5 elements.
+  /// - If `block_id` longer than 255 chars
+  /// - If `elements` contains more than 5 elements
   ///
   /// # Example
   /// ```
@@ -79,6 +74,8 @@ impl<'a> Actions<'a> {
   ///
   /// assert!(matches!(block.validate(), Err(_)));
   /// ```
+  #[cfg(feature = "validation")]
+  #[cfg_attr(docsrs, doc(cfg(feature = "validation")))]
   pub fn validate(&self) -> ValidationResult {
     Validate::validate(self)
   }

src/blocks/context.rs

@@ -9,12 +9,14 @@
 use std::borrow::Cow;
 
 use serde::{Deserialize, Serialize};
+#[cfg(feature = "validation")]
 use validator::Validate;
 
+#[cfg(feature = "validation")]
+use crate::val_helpr::ValidationResult;
 use crate::{convert,
             elems::{BlockElement, Image},
-            text,
-            val_helpr::ValidationResult};
+            text};
 
 /// # Context Block
 ///
@@ -23,20 +25,15 @@ use crate::{convert,
 /// Displays message context, which can include both images and text.
 ///
 /// [context_docs]: https://api.slack.com/reference/block-kit/blocks#context
-#[derive(Clone,
-           Debug,
-           Default,
-           Deserialize,
-           Hash,
-           PartialEq,
-           Serialize,
-           Validate)]
+#[derive(Clone, Debug, Default, Deserialize, Hash, PartialEq, Serialize)]
+#[cfg_attr(feature = "validation", derive(Validate))]
 pub struct Context<'a> {
-  #[validate(length(max = 10))]
+  #[cfg_attr(feature = "validation", validate(length(max = 10)))]
   elements: Vec<ImageOrText<'a>>,
 
   #[serde(skip_serializing_if = "Option::is_none")]
-  #[validate(custom = "super::validate_block_id")]
+  #[cfg_attr(feature = "validation",
+             validate(custom = "super::validate_block_id"))]
   block_id: Option<Cow<'a, str>>,
 }
 
@@ -51,10 +48,8 @@ impl<'a> Context<'a> {
   /// Validate that this Context block agrees with Slack's model requirements
   ///
   /// # Errors
-  /// - If `with_block_id` was called with a block id longer
-  ///     than 255 chars
-  /// - If `from_elements`, `from_context_elements`, or `with_element` was called with
-  ///     more than 10 objects
+  /// - If `block_id` longer than 255 chars
+  /// - If `elements` contains more than 10 objects
   ///
   /// # Example
   /// ```
@@ -68,6 +63,8 @@ impl<'a> Context<'a> {
   ///
   /// assert_eq!(true, matches!(block.validate(), Err(_)));
   /// ```
+  #[cfg(feature = "validation")]
+  #[cfg_attr(docsrs, doc(cfg(feature = "validation")))]
   pub fn validate(&self) -> ValidationResult {
     Validate::validate(self)
   }

src/blocks/file.rs

@@ -10,8 +10,10 @@
 use std::borrow::Cow;
 
 use serde::{Deserialize, Serialize};
+#[cfg(feature = "validation")]
 use validator::Validate;
 
+#[cfg(feature = "validation")]
 use crate::val_helpr::ValidationResult;
 
 /// # File Block
@@ -22,12 +24,15 @@ use crate::val_helpr::ValidationResult;
 ///
 /// [slack api docs 🔗]: https://api.slack.com/reference/block-kit/blocks#file
 /// [remote file 🔗]: https://api.slack.com/messaging/files/remote
-#[derive(Clone, Debug, Deserialize, Hash, PartialEq, Serialize, Validate)]
+#[derive(Clone, Debug, Deserialize, Hash, PartialEq, Serialize)]
+#[cfg_attr(feature = "validation", derive(Validate))]
 pub struct File<'a> {
   external_id: Cow<'a, str>,
   source: Cow<'a, str>,
+
   #[serde(skip_serializing_if = "Option::is_none")]
-  #[validate(custom = "super::validate_block_id")]
+  #[cfg_attr(feature = "validation",
+             validate(custom = "super::validate_block_id"))]
   block_id: Option<Cow<'a, str>>,
 }
 
@@ -42,8 +47,7 @@ impl<'a> File<'a> {
   /// Validate that this File block agrees with Slack's model requirements
   ///
   /// # Errors
-  /// - If `with_block_id` was called with a block id longer
-  ///     than 256 chars
+  /// - If `block_id` longer than 256 chars
   ///
   /// # Example
   /// ```
@@ -63,6 +67,8 @@ impl<'a> File<'a> {
   /// # Ok(())
   /// # }
   /// ```
+  #[cfg(feature = "validation")]
+  #[cfg_attr(docsrs, doc(cfg(feature = "validation")))]
   pub fn validate(&self) -> ValidationResult {
     Validate::validate(self)
   }

src/blocks/image.rs

@@ -9,9 +9,12 @@
 use std::borrow::Cow;
 
 use serde::{Deserialize, Serialize};
+#[cfg(feature = "validation")]
 use validator::Validate;
 
-use crate::{compose::text, val_helpr::ValidationResult};
+use crate::compose::text;
+#[cfg(feature = "validation")]
+use crate::val_helpr::ValidationResult;
 
 /// # Image Block
 ///
@@ -20,27 +23,22 @@ use crate::{compose::text, val_helpr::ValidationResult};
 /// A simple image block, designed to make those cat photos really pop.
 ///
 /// [slack api docs 🔗]: https://api.slack.com/reference/block-kit/blocks#image
-#[derive(Clone,
-           Debug,
-           Default,
-           Deserialize,
-           Hash,
-           PartialEq,
-           Serialize,
-           Validate)]
+#[derive(Clone, Debug, Default, Deserialize, Hash, PartialEq, Serialize)]
+#[cfg_attr(feature = "validation", derive(Validate))]
 pub struct Image<'a> {
-  #[validate(length(max = 3000))]
+  #[cfg_attr(feature = "validation", validate(length(max = 3000)))]
   image_url: Cow<'a, str>,
 
-  #[validate(length(max = 2000))]
+  #[cfg_attr(feature = "validation", validate(length(max = 2000)))]
   alt_text: Cow<'a, str>,
 
   #[serde(skip_serializing_if = "Option::is_none")]
-  #[validate(custom = "validate::title")]
+  #[cfg_attr(feature = "validation", validate(custom = "validate::title"))]
   title: Option<text::Text>,
 
   #[serde(skip_serializing_if = "Option::is_none")]
-  #[validate(custom = "super::validate_block_id")]
+  #[cfg_attr(feature = "validation",
+             validate(custom = "super::validate_block_id"))]
   block_id: Option<Cow<'a, str>>,
 }
 
@@ -55,14 +53,11 @@ impl<'a> Image<'a> {
   /// Validate that this Image block agrees with Slack's model requirements
   ///
   /// # Errors
-  /// - If `with_block_id` was called with a block id longer
+  /// - If `block_id` longer
   ///     than 255 chars
-  /// - If `with_title` was called with a title longer
-  ///     than 2000 chars
-  /// - If `from_url_and_alt_text` was called with `alt_text` longer
-  ///     than 2000 chars
-  /// - If `from_url_and_alt_text` was called with `image_url` longer
-  ///     than 3000 chars
+  /// - If title longer than 2000 chars
+  /// - If `alt_text` longer than 2000 chars
+  /// - If `image_url` longer than 3000 chars
   ///
   /// # Example
   /// ```
@@ -77,6 +72,8 @@ impl<'a> Image<'a> {
   ///
   /// assert_eq!(true, matches!(block.validate(), Err(_)));
   /// ```
+  #[cfg(feature = "validation")]
+  #[cfg_attr(docsrs, doc(cfg(feature = "validation")))]
   pub fn validate(&self) -> ValidationResult {
     Validate::validate(self)
   }
@@ -257,6 +254,7 @@ pub mod build {
   }
 }
 
+#[cfg(feature = "validation")]
 mod validate {
   use crate::{compose::text,
               val_helpr::{below_len, ValidatorResult}};

src/blocks/input.rs

@@ -13,13 +13,15 @@
 use std::borrow::Cow;
 
 use serde::{Deserialize, Serialize};
+#[cfg(feature = "validation")]
 use validator::Validate;
 
+#[cfg(feature = "validation")]
+use crate::val_helpr::ValidationResult;
 use crate::{compose::text,
             convert,
             elems,
-            elems::{select, BlockElement},
-            val_helpr::ValidationResult};
+            elems::{select, BlockElement}};
 
 /// # Input Block
 ///
@@ -32,19 +34,21 @@ use crate::{compose::text,
 ///
 /// [slack api docs 🔗]: https://api.slack.com/reference/block-kit/blocks#input
 /// [slack's guide to using modals 🔗]: https://api.slack.com/surfaces/modals/using#gathering_input
-#[derive(Clone, Debug, Deserialize, Hash, PartialEq, Serialize, Validate)]
+#[derive(Clone, Debug, Deserialize, Hash, PartialEq, Serialize)]
+#[cfg_attr(feature = "validation", derive(Validate))]
 pub struct Input<'a> {
-  #[validate(custom = "validate::label")]
+  #[cfg_attr(feature = "validation", validate(custom = "validate::label"))]
   label: text::Text,
 
   element: SupportedElement<'a>,
 
   #[serde(skip_serializing_if = "Option::is_none")]
-  #[validate(custom = "super::validate_block_id")]
+  #[cfg_attr(feature = "validation",
+             validate(custom = "super::validate_block_id"))]
   block_id: Option<Cow<'a, str>>,
 
   #[serde(skip_serializing_if = "Option::is_none")]
-  #[validate(custom = "validate::hint")]
+  #[cfg_attr(feature = "validation", validate(custom = "validate::hint"))]
   hint: Option<text::Text>,
 
   #[serde(skip_serializing_if = "Option::is_none")]
@@ -67,10 +71,8 @@ impl<'a> Input<'a> {
   /// # Errors
   /// - If `from_label_and_element` was passed a Text object longer
   ///     than 2000 chars
-  /// - If `with_hint` was called with a block id longer
-  ///     than 2000 chars
-  /// - If `with_block_id` was called with a block id longer
-  ///     than 256 chars
+  /// - If `hint` longer than 2000 chars
+  /// - If `block_id` longer than 256 chars
   ///
   /// # Example
   /// ```
@@ -94,6 +96,8 @@ impl<'a> Input<'a> {
   ///
   /// // < send to slack API >
   /// ```
+  #[cfg(feature = "validation")]
+  #[cfg_attr(docsrs, doc(cfg(feature = "validation")))]
   pub fn validate(&self) -> ValidationResult {
     Validate::validate(self)
   }
@@ -338,6 +342,7 @@ convert!(impl<'a> From<select::multi::User<'a>> for SupportedElement<'a> => |r|
 convert!(impl<'a> From<select::multi::Conversation<'a>> for SupportedElement<'a> => |r| SupportedElement(BlockElement::from(r)));
 convert!(impl<'a> From<select::multi::PublicChannel<'a>> for SupportedElement<'a> => |r| SupportedElement(BlockElement::from(r)));
 
+#[cfg(feature = "validation")]
 mod validate {
   use crate::{compose::text,
               val_helpr::{below_len, ValidatorResult}};

src/blocks/mod.rs

@@ -45,8 +45,6 @@ pub mod section;
 #[doc(inline)]
 pub use section::Section;
 
-type ValidationResult = Result<(), validator::ValidationErrors>;
-
 /// # Layout Blocks
 ///
 /// Blocks are a series of components that can be combined
@@ -119,6 +117,8 @@ impl<'a> Block<'a> {
   ///
   /// assert!(matches!(img.validate(), Err(_)), "validation should fail!")
   /// ```
+  #[cfg(feature = "validation")]
+  #[cfg_attr(docsrs, doc(cfg(feature = "validation")))]
   pub fn validate(&self) -> ValidationResult {
     use Block::*;
 
@@ -141,6 +141,7 @@ convert!(impl<'a> From<Image<'a>>   for Block<'a> => |a| Block::Image(a));
 convert!(impl<'a> From<Context<'a>> for Block<'a> => |a| Block::Context(a));
 convert!(impl<'a> From<File<'a>>    for Block<'a> => |a| Block::File(a));
 
+#[cfg(feature = "validation")]
 fn validate_block_id(id: &std::borrow::Cow<str>)
                      -> crate::val_helpr::ValidatorResult {
   crate::val_helpr::below_len("block_id", 255, id)