tabled 0.20.0

//! The module contains a [`Location`] trait and implementations for it.
//!
//! # Example
//!
#![cfg_attr(all(feature = "derive", feature = "assert"), doc = "```")]
#![cfg_attr(not(all(feature = "derive", feature = "assert")), doc = "```ignore")]
//! use tabled::{
//!     settings::{
//!         location::Locator,
//!         object::{Columns, Object},
//!         Alignment, Modify, Padding,
//!     },
//!     assert::assert_table,
//!     Table, Tabled,
//! };
//!
//! #[derive(Tabled)]
//! struct Reading {
//!     link: &'static str,
//!     comment: &'static str,
//! }
//!
//! let data = [
//!     Reading { link: "https://www.gnu.org/software/grub/manual/multiboot/multiboot.html", comment: "todo" },
//!     Reading { link: "https://wiki.debian.org/initramfs", comment: "todo" },
//!     Reading { link: "http://jdebp.uk/FGA/efi-boot-process.html", comment: "todo,2" },
//!     Reading { link: "https://wiki.debian.org/UEFI", comment: "todo,2" },
//! ];
//!
//! let mut table = Table::new(data);
//! table.with(Padding::zero());
//! table.modify(Locator::column("link"), Alignment::right());
//! table.modify(Locator::content("todo"), "todo,1");
//! table.modify(
//!     Columns::one(1).intersect(Locator::by(|text| text.contains("todo"))),
//!     Padding::new(4, 0, 0, 0),
//! );
//!
//! assert_table!(
//!     table,
//!     "+-----------------------------------------------------------------+----------+"
//!     "|                                                             link|comment   |"
//!     "+-----------------------------------------------------------------+----------+"
//!     "|https://www.gnu.org/software/grub/manual/multiboot/multiboot.html|    todo,1|"
//!     "+-----------------------------------------------------------------+----------+"
//!     "|                                https://wiki.debian.org/initramfs|    todo,1|"
//!     "+-----------------------------------------------------------------+----------+"
//!     "|                        http://jdebp.uk/FGA/efi-boot-process.html|    todo,2|"
//!     "+-----------------------------------------------------------------+----------+"
//!     "|                                     https://wiki.debian.org/UEFI|    todo,2|"
//!     "+-----------------------------------------------------------------+----------+"
//! );
//! ```

mod by_column_name;
mod by_condition;
mod by_content;
mod by_value;
mod locator;

pub use by_column_name::ByColumnName;
pub use by_condition::ByCondition;
pub use by_content::ByContent;
pub use by_value::ByValue;
pub use locator::Locator;

use core::ops::Bound;
use std::{
    iter::{self, Once},
    ops::{Range, RangeBounds},
};

use crate::{
    grid::records::{ExactRecords, Records},
    settings::object::{Column, Columns, FirstColumn, FirstRow, LastColumn, LastRow, Row, Rows},
};

/// Location is an interface which searches for a particular thing in the [`Records`],
/// and returns coordinate of the foundings if any.
pub trait Location<Records> {
    /// A coordinate of the finding.
    type Coordinate;
    /// An iterator of the coordinates.
    /// If it's empty it's considered that nothing is found.
    type IntoIter: IntoIterator<Item = Self::Coordinate>;

    /// Search for the thing in [`Records`], returning a list of coordinates.
    fn locate(&mut self, records: &Records) -> Self::IntoIter;
}

impl<B, R> Location<R> for Columns<B>
where
    B: RangeBounds<usize>,
    R: Records,
{
    type Coordinate = usize;
    type IntoIter = Range<usize>;

    fn locate(&mut self, records: &R) -> Self::IntoIter {
        let range = self.get_range();
        let max = records.count_columns();
        let (from, to) = bounds_to_usize(range.start_bound(), range.end_bound(), max);

        from..to
    }
}

impl<R> Location<R> for Column {
    type Coordinate = usize;
    type IntoIter = Once<usize>;

    fn locate(&mut self, _: &R) -> Self::IntoIter {
        iter::once((*self).into())
    }
}

impl<R> Location<R> for FirstColumn {
    type Coordinate = usize;
    type IntoIter = Once<usize>;

    fn locate(&mut self, _: &R) -> Self::IntoIter {
        iter::once(0)
    }
}

impl<R> Location<R> for LastColumn
where
    R: Records,
{
    type Coordinate = usize;
    type IntoIter = Once<usize>;

    fn locate(&mut self, records: &R) -> Self::IntoIter {
        if records.count_columns() > 0 {
            iter::once(records.count_columns() - 1)
        } else {
            iter::once(0)
        }
    }
}

impl<B, R> Location<R> for Rows<B>
where
    R: ExactRecords,
    B: RangeBounds<usize>,
{
    type Coordinate = usize;
    type IntoIter = Range<usize>;

    fn locate(&mut self, records: &R) -> Self::IntoIter {
        let (from, to) = bounds_to_usize(
            self.get_range().start_bound(),
            self.get_range().end_bound(),
            records.count_rows(),
        );

        from..to
    }
}

impl<R> Location<R> for Row {
    type Coordinate = usize;
    type IntoIter = Once<usize>;

    fn locate(&mut self, _: &R) -> Self::IntoIter {
        iter::once((*self).into())
    }
}

impl<R> Location<R> for FirstRow {
    type Coordinate = usize;
    type IntoIter = Once<usize>;

    fn locate(&mut self, _: &R) -> Self::IntoIter {
        iter::once(0)
    }
}

impl<R> Location<R> for LastRow
where
    R: ExactRecords,
{
    type Coordinate = usize;
    type IntoIter = Once<usize>;

    fn locate(&mut self, records: &R) -> Self::IntoIter {
        if records.count_rows() > 0 {
            iter::once(records.count_rows() - 1)
        } else {
            iter::once(0)
        }
    }
}

fn bounds_to_usize(
    left: Bound<&usize>,
    right: Bound<&usize>,
    count_elements: usize,
) -> (usize, usize) {
    match (left, right) {
        (Bound::Included(x), Bound::Included(y)) => (*x, y + 1),
        (Bound::Included(x), Bound::Excluded(y)) => (*x, *y),
        (Bound::Included(x), Bound::Unbounded) => (*x, count_elements),
        (Bound::Unbounded, Bound::Unbounded) => (0, count_elements),
        (Bound::Unbounded, Bound::Included(y)) => (0, y + 1),
        (Bound::Unbounded, Bound::Excluded(y)) => (0, *y),
        (Bound::Excluded(_), Bound::Unbounded)
        | (Bound::Excluded(_), Bound::Included(_))
        | (Bound::Excluded(_), Bound::Excluded(_)) => {
            unreachable!("A start bound can't be excluded")
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::{
        grid::config::Entity,
        grid::records::vec_records::Text,
        grid::records::vec_records::VecRecords,
        settings::location::{ByColumnName, ByCondition, ByContent},
        settings::object::Object,
    };

    use Entity::*;

    #[test]
    fn object_by_column_name_test() {
        let data = [
            vec![vec![1, 2, 3], vec![1, 2, 3], vec![1, 2, 3]],
            vec![vec![1, 2, 3], vec![1, 1, 3], vec![1, 2, 1]],
            vec![vec![1, 1, 3], vec![1, 1, 3], vec![1, 1, 1]],
            vec![vec![1, 1, 1], vec![1, 1, 3], vec![1, 1, 1]],
            vec![vec![0, 1, 1], vec![1, 1, 3], vec![1, 1, 1]],
            vec![vec![0, 0, 0], vec![1, 1, 3], vec![1, 1, 1]],
        ];

        assert_eq!(cells(by_colname("1"), &data[0]), [Column(0)]);
        assert_eq!(cells(by_colname("1"), &data[1]), [Column(0)]);
        assert_eq!(cells(by_colname("1"), &data[2]), [Column(0), Column(1)]);
        assert_eq!(
            cells(by_colname("1"), &data[3]),
            [Column(0), Column(1), Column(2)]
        );
        assert_eq!(cells(by_colname("1"), &data[4]), [Column(1), Column(2)]);
        assert_eq!(cells(by_colname("1"), &data[5]), []);
    }

    #[test]
    fn object_by_content_test() {
        let data = [
            vec![vec![1, 2, 3], vec![1, 2, 3], vec![1, 2, 3]],
            vec![vec![1, 2, 3], vec![1, 1, 3], vec![1, 2, 1]],
            vec![vec![1, 1, 3], vec![1, 1, 3], vec![1, 1, 1]],
            vec![vec![1, 1, 1], vec![1, 1, 3], vec![1, 1, 1]],
            vec![vec![0, 1, 1], vec![1, 1, 3], vec![1, 1, 1]],
            vec![vec![0, 0, 0], vec![1, 1, 3], vec![1, 1, 1]],
        ];

        assert_eq!(cells(by_content("1"), &[]), []);
        assert_eq!(cells(by_content("1"), &[vec![], vec![], vec![]]), []);
        assert_eq!(
            cells(by_content("1"), &data[0]),
            [Cell(0, 0), Cell(1, 0), Cell(2, 0)]
        );
        assert_eq!(
            cells(by_content("1"), &data[1]),
            [Cell(0, 0), Cell(1, 0), Cell(1, 1), Cell(2, 0), Cell(2, 2)]
        );
        assert_eq!(
            cells(by_content("1"), &data[2]),
            [
                Cell(0, 0),
                Cell(0, 1),
                Cell(1, 0),
                Cell(1, 1),
                Cell(2, 0),
                Cell(2, 1),
                Cell(2, 2)
            ]
        );
        assert_eq!(
            cells(by_content("1"), &data[3]),
            [
                Cell(0, 0),
                Cell(0, 1),
                Cell(0, 2),
                Cell(1, 0),
                Cell(1, 1),
                Cell(2, 0),
                Cell(2, 1),
                Cell(2, 2)
            ]
        );
        assert_eq!(
            cells(by_content("1"), &data[4]),
            [
                Cell(0, 1),
                Cell(0, 2),
                Cell(1, 0),
                Cell(1, 1),
                Cell(2, 0),
                Cell(2, 1),
                Cell(2, 2)
            ]
        );
        assert_eq!(
            cells(by_content("1"), &data[5]),
            [Cell(1, 0), Cell(1, 1), Cell(2, 0), Cell(2, 1), Cell(2, 2)]
        );
    }

    #[test]
    fn object_by_condition_test() {
        let data = [
            vec![vec![1, 2, 3], vec![1, 2, 3], vec![1, 2, 3]],
            vec![vec![1, 2, 3], vec![1, 1, 3], vec![1, 2, 1]],
            vec![vec![1, 1, 3], vec![1, 1, 3], vec![1, 1, 1]],
            vec![vec![1, 1, 1], vec![1, 1, 3], vec![1, 1, 1]],
            vec![vec![0, 1, 1], vec![1, 1, 3], vec![1, 1, 1]],
            vec![vec![0, 0, 0], vec![1, 1, 3], vec![1, 1, 1]],
        ];

        assert_eq!(cells(by_cond("1"), &[]), []);
        assert_eq!(cells(by_cond("1"), &[vec![], vec![], vec![]]), []);
        assert_eq!(
            cells(by_cond("1"), &data[0]),
            [Cell(0, 0), Cell(1, 0), Cell(2, 0)]
        );
        assert_eq!(
            cells(by_cond("1"), &data[1]),
            [Cell(0, 0), Cell(1, 0), Cell(1, 1), Cell(2, 0), Cell(2, 2)]
        );
        assert_eq!(
            cells(by_cond("1"), &data[2]),
            [
                Cell(0, 0),
                Cell(0, 1),
                Cell(1, 0),
                Cell(1, 1),
                Cell(2, 0),
                Cell(2, 1),
                Cell(2, 2)
            ]
        );
        assert_eq!(
            cells(by_cond("1"), &data[3]),
            [
                Cell(0, 0),
                Cell(0, 1),
                Cell(0, 2),
                Cell(1, 0),
                Cell(1, 1),
                Cell(2, 0),
                Cell(2, 1),
                Cell(2, 2)
            ]
        );
        assert_eq!(
            cells(by_cond("1"), &data[4]),
            [
                Cell(0, 1),
                Cell(0, 2),
                Cell(1, 0),
                Cell(1, 1),
                Cell(2, 0),
                Cell(2, 1),
                Cell(2, 2)
            ]
        );
        assert_eq!(
            cells(by_cond("1"), &data[5]),
            [Cell(1, 0), Cell(1, 1), Cell(2, 0), Cell(2, 1), Cell(2, 2)]
        );
    }

    fn by_colname(text: &str) -> ByColumnName<&str> {
        ByColumnName::new(text)
    }

    fn by_content(text: &str) -> ByContent<&str> {
        ByContent::new(text)
    }

    fn by_cond(text: &'static str) -> ByCondition<impl Fn(&str) -> bool> {
        ByCondition::new(move |content| content == text)
    }

    fn cells<O>(o: O, data: &[Vec<usize>]) -> Vec<Entity>
    where
        O: Object<VecRecords<Text<String>>>,
    {
        let data = data
            .iter()
            .map(|row| row.iter().map(|n| n.to_string()).map(Text::new).collect())
            .collect();

        let records = VecRecords::new(data);
        o.cells(&records).collect::<Vec<_>>()
    }
}