mit-commit 3.3.1

For building commit linters. This makes it easy.
Documentation 
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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469

use std::{
    convert::TryFrom,
    fmt,
    fmt::{Display, Formatter},
    slice::Iter,
    vec::IntoIter,
};

use crate::{body::Body, fragment::Fragment, trailer::Trailer};

/// A collection of body paragraphs from a commit message.
///
/// This struct represents multiple body paragraphs that make up the content of a commit message.
///
/// # Examples
///
/// ```
/// use mit_commit::{Bodies, Body, Subject};
///
/// let bodies: Vec<Body> = Vec::default();
/// assert_eq!(None, Bodies::from(bodies).first());
///
/// let bodies: Vec<Body> = vec![
///     Body::from("First"),
///     Body::from("Second"),
///     Body::from("Third"),
/// ];
/// assert_eq!(Some(Body::from("First")), Bodies::from(bodies).first());
/// ```
#[derive(Debug, PartialEq, Eq, Clone, Default)]
pub struct Bodies<'a> {
    bodies: Vec<Body<'a>>,
}

impl Bodies<'_> {
    /// Get the first [`Body`] in this list of [`Bodies`]
    ///
    /// # Arguments
    ///
    /// * `self` - The Bodies collection to get the first element from
    ///
    /// # Returns
    ///
    /// The first Body in the list, or None if the list is empty
    ///
    /// # Examples
    ///
    /// ```
    /// use mit_commit::{Bodies, Body, Subject};
    ///
    /// let bodies: Vec<Body> = Vec::default();
    /// assert_eq!(None, Bodies::from(bodies).first());
    ///
    /// let bodies: Vec<Body> = vec![
    ///     Body::from("First"),
    ///     Body::from("Second"),
    ///     Body::from("Third"),
    /// ];
    /// assert_eq!(Some(Body::from("First")), Bodies::from(bodies).first());
    /// ```
    #[must_use]
    pub fn first(&self) -> Option<Body<'_>> {
        self.bodies.first().cloned()
    }

    /// Iterate over the [`Body`] in the [`Bodies`]
    ///
    /// # Arguments
    ///
    /// * `self` - The Bodies collection to iterate over
    ///
    /// # Returns
    ///
    /// An iterator over the Body elements in the Bodies collection
    ///
    /// # Examples
    ///
    /// ```
    /// use mit_commit::{Bodies, Body};
    /// let bodies = Bodies::from(vec![
    ///     Body::from("Body 1"),
    ///     Body::from("Body 2"),
    ///     Body::from("Body 3"),
    /// ]);
    /// let mut iterator = bodies.iter();
    ///
    /// assert_eq!(iterator.next(), Some(&Body::from("Body 1")));
    /// assert_eq!(iterator.next(), Some(&Body::from("Body 2")));
    /// assert_eq!(iterator.next(), Some(&Body::from("Body 3")));
    /// assert_eq!(iterator.next(), None);
    /// ```
    pub fn iter(&self) -> Iter<'_, Body<'_>> {
        self.bodies.iter()
    }
}

impl<'a> IntoIterator for Bodies<'a> {
    type Item = Body<'a>;
    type IntoIter = IntoIter<Body<'a>>;

    /// Iterate over the [`Body`] in the [`Bodies`]
    ///
    /// # Arguments
    ///
    /// * `self` - The Bodies collection to consume and iterate over
    ///
    /// # Returns
    ///
    /// An iterator that takes ownership of the Bodies collection
    ///
    /// # Examples
    ///
    /// ```
    /// use mit_commit::{Bodies, Body};
    /// let bodies = Bodies::from(vec![
    ///     Body::from("Body 1"),
    ///     Body::from("Body 2"),
    ///     Body::from("Body 3"),
    /// ]);
    /// let mut iterator = bodies.into_iter();
    ///
    /// assert_eq!(iterator.next(), Some(Body::from("Body 1")));
    /// assert_eq!(iterator.next(), Some(Body::from("Body 2")));
    /// assert_eq!(iterator.next(), Some(Body::from("Body 3")));
    /// assert_eq!(iterator.next(), None);
    /// ```
    fn into_iter(self) -> Self::IntoIter {
        self.bodies.into_iter()
    }
}

impl<'a> IntoIterator for &'a Bodies<'a> {
    type IntoIter = Iter<'a, Body<'a>>;
    type Item = &'a Body<'a>;

    /// Iterate over the [`Body`] in the [`Bodies`]
    ///
    /// # Arguments
    ///
    /// * `self` - A reference to the Bodies collection to iterate over
    ///
    /// # Returns
    ///
    /// An iterator over references to the Body elements in the Bodies collection
    ///
    /// # Examples
    ///
    /// ```
    /// use std::borrow::Borrow;
    ///
    /// use mit_commit::{Bodies, Body};
    /// let bodies = Bodies::from(vec![
    ///     Body::from("Body 1"),
    ///     Body::from("Body 2"),
    ///     Body::from("Body 3"),
    /// ]);
    /// let bodies_ref = bodies.borrow();
    /// let mut iterator = bodies_ref.into_iter();
    ///
    /// assert_eq!(iterator.next(), Some(&Body::from("Body 1")));
    /// assert_eq!(iterator.next(), Some(&Body::from("Body 2")));
    /// assert_eq!(iterator.next(), Some(&Body::from("Body 3")));
    /// assert_eq!(iterator.next(), None);
    /// ```
    fn into_iter(self) -> Self::IntoIter {
        self.bodies.iter()
    }
}

impl Display for Bodies<'_> {
    /// Render the [`Bodies`] as text
    ///
    /// # Arguments
    ///
    /// * `self` - The Bodies collection to format
    /// * `f` - The formatter to write the formatted string to
    ///
    /// # Returns
    ///
    /// A string representation of the Bodies with each Body separated by double newlines
    ///
    /// # Examples
    ///
    /// ```
    /// use mit_commit::{Bodies, Body};
    /// let bodies = Bodies::from(vec![
    ///     Body::from("Body 1"),
    ///     Body::from("Body 2"),
    ///     Body::from("Body 3"),
    /// ]);
    ///
    /// assert_eq!(format!("{}", bodies), "Body 1\n\nBody 2\n\nBody 3");
    /// ```
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        if self.bodies.is_empty() {
            return Ok(());
        }

        let mut iter = self.bodies.iter();
        if let Some(first) = iter.next() {
            write!(f, "{first}")?;
            for body in iter {
                write!(f, "\n\n{body}")?;
            }
        }

        Ok(())
    }
}

impl<'a> From<Vec<Body<'a>>> for Bodies<'a> {
    /// Combine a [`Vec`] of [`Body`] into [`Bodies`]
    ///
    /// # Arguments
    ///
    /// * `bodies` - A vector of Body objects to be combined into a Bodies collection
    ///
    /// # Returns
    ///
    /// A new Bodies instance containing all the provided Body objects
    ///
    /// # Examples
    ///
    /// ```
    /// use mit_commit::{Bodies, Body};
    /// let bodies = Bodies::from(vec![
    ///     Body::from("Body 1"),
    ///     Body::from("Body 2"),
    ///     Body::from("Body 3"),
    /// ]);
    /// let mut iterator = bodies.into_iter();
    ///
    /// assert_eq!(iterator.next(), Some(Body::from("Body 1")));
    /// assert_eq!(iterator.next(), Some(Body::from("Body 2")));
    /// assert_eq!(iterator.next(), Some(Body::from("Body 3")));
    /// assert_eq!(iterator.next(), None);
    /// ```
    fn from(bodies: Vec<Body<'a>>) -> Self {
        Self { bodies }
    }
}

impl From<Bodies<'_>> for String {
    /// Convert a [`Bodies`] collection to a [`String`]
    ///
    /// # Arguments
    ///
    /// * `bodies` - The Bodies collection to convert to a string
    ///
    /// # Returns
    ///
    /// A string representation of the Bodies with each Body separated by double newlines
    ///
    /// # Examples
    ///
    /// ```
    /// use mit_commit::{Bodies, Body};
    /// let bodies = Bodies::from(vec![
    ///     Body::from("Body 1"),
    ///     Body::from("Body 2"),
    ///     Body::from("Body 3"),
    /// ]);
    ///
    /// assert_eq!(String::from(bodies), "Body 1\n\nBody 2\n\nBody 3");
    /// ```
    fn from(bodies: Bodies<'_>) -> Self {
        bodies
            .bodies
            .into_iter()
            .map(Self::from)
            .collect::<Vec<_>>()
            .join("\n\n")
    }
}

impl<'a> From<Vec<Fragment<'a>>> for Bodies<'a> {
    /// Convert a vector of [`Fragment`] to [`Bodies`]
    ///
    /// This extracts all Body fragments from the input, skipping the first one (which is typically
    /// the subject line) and any trailers at the end of the message.
    ///
    /// # Arguments
    ///
    /// * `bodies` - A vector of Fragment objects to extract Body fragments from
    ///
    /// # Returns
    ///
    /// A new Bodies instance containing only the Body fragments that are not the subject line
    /// and not trailers
    ///
    /// # Examples
    ///
    /// ```
    /// use mit_commit::{Bodies, Body, Fragment};
    ///
    /// let fragments = vec![
    ///     Fragment::Body(Body::from("Subject Line")),
    ///     Fragment::Body(Body::default()),
    ///     Fragment::Body(Body::from("Some content in the body")),
    ///     Fragment::Body(Body::default()),
    ///     Fragment::Body(Body::from("Co-authored-by: Someone <someone@example.com>")),
    /// ];
    ///
    /// let bodies = Bodies::from(fragments);
    ///
    /// assert_eq!(
    ///     bodies,
    ///     Bodies::from(vec![
    ///         Body::default(),
    ///         Body::from("Some content in the body"),
    ///     ])
    /// );
    /// ```
    fn from(bodies: Vec<Fragment<'a>>) -> Self {
        // Extract all Body fragments
        let raw_body = bodies
            .iter()
            .filter_map(|fragment| match fragment {
                Fragment::Body(body) => Some(body.clone()),
                Fragment::Comment(_) => None,
            })
            .collect::<Vec<_>>();

        // Count trailers at the end (including empty lines before them)
        let trailer_count = raw_body
            .iter()
            .skip(1)
            .rev()
            .take_while(|body| body.is_empty() || Trailer::try_from((*body).clone()).is_ok())
            .count();

        // Calculate how many non-trailer items to keep, excluding the subject line
        let non_trailer_item_count = raw_body
            .len()
            .saturating_sub(trailer_count)
            .saturating_sub(1);

        // Extract the body content, skipping subject and trailers
        raw_body
            .into_iter()
            .skip(1) // Skip subject line
            .take(non_trailer_item_count) // Take only non-trailer content
            .collect::<Vec<Body<'_>>>()
            .into()
    }
}

#[cfg(test)]
mod tests {
    use indoc::indoc;

    use super::Bodies;
    use crate::{body::Body, fragment::Fragment};

    #[test]
    fn test_iter_returns_bodies_in_order() -> Result<(), String> {
        let bodies = Bodies::from(vec![
            Body::from("Body 1"),
            Body::from("Body 2"),
            Body::from("Body 3"),
        ]);
        let mut iterator = bodies.iter();

        if iterator.next() != Some(&Body::from("Body 1")) {
            return Err("First body should be 'Body 1'".to_string());
        }

        if iterator.next() != Some(&Body::from("Body 2")) {
            return Err("Second body should be 'Body 2'".to_string());
        }

        if iterator.next() != Some(&Body::from("Body 3")) {
            return Err("Third body should be 'Body 3'".to_string());
        }

        if iterator.next().is_some() {
            return Err("Iterator should be exhausted after three elements".to_string());
        }

        Ok(())
    }

    #[test]
    fn test_from_bodies_to_string_conversion_formats_correctly() -> Result<(), String> {
        let bodies = Bodies::from(vec![
            Body::from("Message Body"),
            Body::from("Another Message Body"),
        ]);

        let expected = String::from(indoc!(
            "
            Message Body

            Another Message Body"
        ));

        if String::from(bodies) != expected {
            return Err(
                "Bodies should be converted to a string with double newlines between them"
                    .to_string(),
            );
        }

        Ok(())
    }

    #[test]
    fn test_display_trait_formats_bodies_correctly() -> Result<(), String> {
        let bodies = Bodies::from(vec![
            Body::from("Message Body"),
            Body::from("Another Message Body"),
        ]);

        let expected = String::from(indoc!(
            "
            Message Body

            Another Message Body"
        ));

        if format!("{bodies}") != expected {
            return Err(
                "Display implementation should format bodies with double newlines between them"
                    .to_string(),
            );
        }

        Ok(())
    }

    #[test]
    fn test_first_returns_first_body_when_present() -> Result<(), String> {
        let bodies = Bodies::from(vec![
            Body::from("Message Body"),
            Body::from("Another Message Body"),
        ]);

        if bodies.first() != Some(Body::from("Message Body")) {
            return Err("First method should return the first body in the collection".to_string());
        }

        Ok(())
    }

    #[test]
    fn test_from_fragments_extracts_body_content_correctly() {
        let bodies = Bodies::from(vec![
            Fragment::Body(Body::from("Subject Line")),
            Fragment::Body(Body::default()),
            Fragment::Body(Body::from("Some content in the body of the message")),
            Fragment::Body(Body::default()),
            Fragment::Body(Body::from(indoc!(
                "
                Co-authored-by: Billie Thomposon <billie@example.com>
                Co-authored-by: Someone Else <someone@example.com>
                "
            ))),
        ]);

        assert_eq!(
            bodies,
            Bodies::from(vec![
                Body::default(),
                Body::from("Some content in the body of the message"),
            ]),
            "From<Vec<Fragment>> should extract body content, skipping subject and trailers"
        );
    }
}