sub-strs 0.29.2

/*
==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--

sub-strs

Copyright (C) 2019-2023  Anonymous

There are several releases over multiple years,
they are listed as ranges, such as: "2019-2023".

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

::--::--::--::--::--::--::--::--::--::--::--::--::--::--::--::--
*/

//! # Glob set

use {
    alloc::{
        borrow::Cow,
        collections::BTreeSet,
    },
    crate::Glob,
};

/// # Glob set
///
/// This struct contains a set of [`Glob`][struct:Glob]'s.
///
/// [struct:Glob]: struct.Glob.html
#[derive(Debug, Eq, PartialEq)]
pub struct GlobSet<'a> {

    globs: BTreeSet<Glob<'a>>,

}

impl<'a> GlobSet<'a> {

    /// # Makes new instance from an iterator of [`Cow<'a, str>`][r::Cow]
    ///
    /// ## Notes
    ///
    /// - Empty strings will be ignored.
    /// - If the iterator contains no globs, `None` is returned.
    ///
    /// ## Examples
    ///
    /// ```
    /// use sub_strs::GlobSet;
    ///
    /// let glob_set = GlobSet::from_iter("*.rs|*.md".split('|')).unwrap();
    /// assert!(glob_set.any("this.rs"));
    /// assert!(glob_set.any("that.md"));
    /// assert!(glob_set.any("not-this") == false);
    /// ```
    ///
    /// [r::Cow]: https://doc.rust-lang.org/std/borrow/enum.Cow.html
    pub fn from_iter<I0, I1>(iter: I0) -> Option<Self> where I0: IntoIterator<Item=I1>, I1: Into<Cow<'a, str>> {
        let globs: BTreeSet<_> = iter.into_iter().filter_map(|s| {
            let s = s.into();
            (s.is_empty() == false).then(|| Glob::from(s))
        }).collect();
        (globs.is_empty() == false).then_some(Self { globs })
    }

    /// # Merges an iterator of [`GlobSet<'a>`][::GlobSet] into one
    ///
    /// ## Notes
    ///
    /// - If there are no inner [`Glob`][::Glob]'s, `None` is returned.
    /// - For `#![no_std]` users: this function takes little effort to remove duplicates. You should help with that yourself (by not providing
    ///   duplicates).
    ///
    /// ## Examples
    ///
    /// ```
    /// use sub_strs::GlobSet;
    ///
    /// let program_args = &["*.svg,*.OGG", "*.md"];
    /// let glob_set = GlobSet::merge(
    ///     program_args.iter().filter_map(|s|
    ///         GlobSet::from_iter(s.to_lowercase().split(',').map(|s| s.to_string()))
    ///     )
    /// );
    /// assert!(glob_set.map(|g| g.any("some.ogg")).unwrap_or(false));
    /// ```
    ///
    /// [::Glob]: struct.Glob.html
    /// [::GlobSet]: struct.GlobSet.html
    pub fn merge<I>(iter: I) -> Option<Self> where I: IntoIterator<Item=Self> {
        let result = iter.into_iter().fold(Self { globs: BTreeSet::new() }, |mut result, mut item| {
            result.globs.append(&mut item.globs);
            result
        });
        (result.globs.is_empty() == false).then_some(result)
    }

    /// # Checks if _any_ glob inside matches the input string
    pub fn any<S>(&self, s: S) -> bool where S: AsRef<str> {
        self.globs.iter().any(|g| g.matches(&s))
    }

}