1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
use std::convert::{TryFrom, TryInto};
use serde::{Deserialize, Serialize};
use validator::Validate;

use crate::impl_from_contents;
use crate::text;
use crate::compose;
use crate::val_helpr::ValidationResult;

/// # Context Block
///
/// _[slack api docs 🔗][context_docs]_
///
/// 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)]
pub struct Contents {
    #[validate(length(max = 10))]
    elements: Vec<Compose>,

    #[validate(length(max = 255))]
    block_id: Option<String>,
}

impl Contents {
    /// Create an empty Context block (shorthand for `Default::default()`)
    ///
    /// # Example
    /// ```
    /// use slack_blocks::blocks::{Block, context};
    /// use slack_blocks::text;
    ///
    /// let context = context::Contents::new()
    ///     .with_element(text::Plain::from("my unformatted text"));
    ///
    /// let block: Block = context.into();
    /// // < send block to slack's API >
    /// ```
    pub fn new() -> Self {
        Default::default()
    }

    /// Set the `block_id` for interactions on an existing `context::Contents`
    ///
    /// # Arguments
    /// - `block_id` - A string acting as a unique identifier for a block.
    ///     You can use this `block_id` when you receive an interaction payload
    ///     to [identify the source of the action 🔗].
    ///     If not specified, a `block_id` will be generated.
    ///     Maximum length for this field is 255 characters.
    ///
    /// [identify the source of the action 🔗]: https://api.slack.com/interactivity/handling#payloads
    ///
    /// # Example
    /// ```
    /// use slack_blocks::blocks::{Block, context};
    /// use slack_blocks::text;
    ///
    /// let text = text::Mrkdwn::from("_flavor_ *text*");
    /// let context: Block = context::Contents::new()
    ///     .with_element(text)
    ///     .with_block_id("msg_id_12346")
    ///     .into();
    ///
    /// // < send block to slack's API >
    /// ```
    pub fn with_block_id(mut self, block_id: impl ToString) -> Self {
        self.block_id = Some(block_id.to_string());
        self
    }

    /// Construct a new `context::Contents` from a collection of
    /// composition objects that are definitely supported by Context
    /// Blocks.
    ///
    /// If you _can_ guarantee that a collection only contains image
    /// or text objects, `from_context_elements` may be more ergonomic for you.
    ///
    ///
    /// # Arguments
    /// - `elements` - An array of composition objects;
    ///     Must be image elements or text objects.
    ///     Maximum number of items is 10.
    ///
    /// # Examples
    /// ```
    /// use slack_blocks::blocks::{Block, context};
    /// use slack_blocks::text;
    ///
    /// # pub fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let text = text::Mrkdwn::from("*s i c k*");
    /// let context = context::Contents::from_elements(vec![text])?;
    /// let block: Block = context.into();
    /// // < send block to slack's API >
    /// # Ok(())
    /// # }
    /// ```
    pub fn from_elements(elements: impl IntoIterator<Item = impl Into<compose::Compose>>) -> Result<Self, UnsupportedComposeError> {
        elements
            .into_iter()
            .map(Into::<compose::Compose>::into)
            .map(TryInto::<self::Compose>::try_into)
            .collect::<Result<Vec<_>, _>>()
            .map(Into::<Self>::into)
    }

    /// Add a composition object to a context block.
    ///
    /// This is chainable, and can be used to easily
    /// populate the elements of a context block
    /// right after invoking `new`.
    ///
    /// # Arguments
    /// - `element` - A composition object;
    ///     Must be image elements or text objects.
    ///     Maximum number of items is 10.
    ///
    /// # Example
    /// ```
    /// use slack_blocks::blocks::{Block, context};
    /// use slack_blocks::text;
    ///
    /// let context = context::Contents::new()
    ///     .with_element(text::Plain::from("my unformatted text"));
    ///
    /// let block: Block = context.into();
    /// // < send block to slack's API >
    /// ```
    pub fn with_element(mut self, element: impl Into<self::Compose>) -> Self {
        self.elements.push(element.into());
        self
    }

    /// Construct a new `context::Contents` from a collection of
    /// composition objects that are may not be supported by Context
    /// Blocks.
    ///
    /// If you _can't_ guarantee that a collection only contains image
    /// or text objects, `from_elements` may be more ergonomic for you.
    ///
    /// # Arguments
    /// - `elements` - An array of composition objects;
    ///     Must be image elements or text objects.
    ///     Maximum number of items is 10.
    ///
    /// # Examples
    /// ```
    /// use slack_blocks::blocks::{Block, context};
    /// use slack_blocks::text;
    ///
    /// pub fn main() {
    ///     let objs: Vec<text::Mrkdwn> = vec![
    ///         text::Mrkdwn::from("*s i c k*"),
    ///         text::Mrkdwn::from("*t i g h t*"),
    ///     ];
    ///     let context = context::Contents::from_context_elements(objs);
    ///     let block: Block = context.into();
    ///     // < send block to slack's API >
    /// }
    /// ```
    pub fn from_context_elements(elements: impl IntoIterator<Item = impl Into<Compose>>) -> Self {
        elements
            .into_iter()
            .map(Into::<self::Compose>::into)
            .collect::<Vec<_>>()
            .into()
    }

    /// 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
    ///
    /// # Example
    /// ```
    /// use slack_blocks::blocks;
    ///
    /// let long_string = std::iter::repeat(' ').take(256).collect::<String>();
    ///
    /// let block = blocks::context
    ///     ::Contents
    ///     ::new()
    ///     .with_block_id(long_string);
    ///
    /// assert_eq!(true, matches!(block.validate(), Err(_)));
    /// ```
    pub fn validate(&self) -> ValidationResult {
        Validate::validate(self)
    }
}

impl From<Vec<Compose>> for Contents {
    fn from(elements: Vec<Compose>) -> Self {
        Self {
            elements,
            ..Default::default()
        }
    }
}

/// The Composition objects supported by this block
#[derive(Clone, Debug, Deserialize, Hash, PartialEq, Serialize)]
pub enum Compose {
    Text(text::Text),
    Image,
}

impl TryFrom<compose::Compose> for Compose {
    type Error = UnsupportedComposeError;
    fn try_from(comp: compose::Compose) -> Result<Self, Self::Error> {
        match comp {
            compose::Compose::Text(txt) => Ok(Compose::Text(txt))
        }
    }
}

impl_from_contents!(Compose, Text, text::Text);

impl From<text::plain::Contents> for Compose {
    fn from(text: text::plain::Contents) -> Self {
        Into::<text::Text>::into(text).into()
    }
}

impl From<text::mrkdwn::Contents> for Compose {
    fn from(text: text::mrkdwn::Contents) -> Self {
        Into::<text::Text>::into(text).into()
    }
}

#[derive(Debug)]
pub struct UnsupportedComposeError(Vec<compose::Compose>);

impl std::fmt::Display for UnsupportedComposeError {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(f, "Unsupported composition object in Context block: {:?}", self.0)
    }
}

impl std::error::Error for UnsupportedComposeError {}