latex 0.3.1

use std::ops::Deref;
use std::slice::Iter;

/// Wrapper around a single list item.
///
/// An item will usually be rendered with `\item` followed by the item's text.
#[derive(Clone, Debug, PartialEq)]
pub struct Item(pub String);

impl Deref for Item {
    type Target = str;
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

/// Which kind of list should be used?
#[derive(Clone, Debug, PartialEq)]
pub enum ListKind {
    /// A numbered list.
    Enumerate,
    /// An un-numbered list.
    Itemize,
}

impl ListKind {
    /// Get the `ListKind`'s environment name.
    pub fn environment_name(&self) -> &str {
        match *self {
            ListKind::Enumerate => "enumerate",
            ListKind::Itemize => "itemize",
        }
    }
}

/// A list (either dot points or numbered).
///
/// # Examples
///
/// A list can be used like so:
///
/// ```rust
/// use latex::{List, ListKind};
///
/// let mut list = List::new(ListKind::Itemize);
/// list.push("Hello").push("From").push("Some").push("Dot-points");
/// ```
///
/// Calling the `render()` method on the list will then give something like
/// this:
///
/// ```tex
/// \begin{itemize}
/// \item Hello
/// \item From
/// \item Some
/// \item Dot-points
/// \end{itemize}
/// ```
#[derive(Clone, Debug, PartialEq)]
pub struct List {
    /// The kind of list this is.
    pub kind: ListKind,
    items: Vec<Item>,
}

impl List {
    /// Create an empty list of the specified type.
    pub fn new(kind: ListKind) -> List {
        List {
            kind,
            items: Vec::new(),
        }
    }

    /// Add an element to the list.
    pub fn push<S: AsRef<str>>(&mut self, item: S) -> &mut Self {
        self.items.push(Item(item.as_ref().to_string()));
        self
    }

    /// Iterate over the items in the list.
    pub fn iter(&self) -> Iter<Item> {
        self.items.iter()
    }
}

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

    #[test]
    fn push_item_to_list() {
        let mut list = List::new(ListKind::Itemize);

        assert_eq!(list.items.len(), 0);
        list.push("Hello World");
        assert_eq!(list.items.len(), 1);
    }
}