time-tz 2.0.0

Implementation of tz database (IANA) for the time Rust crate.
Documentation
// Copyright (c) 2022, Yuri6037
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
// * Neither the name of time-tz nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

use nom::branch::alt;
use nom::bytes::complete::{is_not, take_while_m_n};
use nom::character::complete::{char as cchar, digit1};
use nom::combinator::{eof, map_res, opt};
use nom::sequence::{delimited, preceded, terminated, tuple};
use nom::IResult;

const TZNAME_MAX: usize = 16;

type Result<'a, T> = IResult<&'a str, T>;

#[derive(Eq, PartialEq, Debug)]
pub struct Time {
    pub hh: u8,
    pub mm: Option<u8>,
    pub ss: Option<u8>,
}

#[derive(Eq, PartialEq, Debug)]
pub struct Offset {
    pub positive: bool,
    pub time: Time,
}

#[derive(Eq, PartialEq, Debug, Copy, Clone)]
pub enum Date {
    J(u16),
    N(u16),
    M { m: u8, n: u8, d: u8 },
}

#[derive(Eq, PartialEq, Debug)]
pub struct Rule {
    pub start: (Date, Option<Time>),
    pub end: (Date, Option<Time>),
}

#[derive(Eq, PartialEq, Debug)]
pub struct Std<'a> {
    pub name: &'a str,
    pub offset: Offset,
}

#[derive(Eq, PartialEq, Debug)]
pub struct Dst<'a> {
    pub name: &'a str,
    pub offset: Option<Offset>,
    pub rule: Option<Rule>,
}

#[derive(Eq, PartialEq, Debug)]
pub enum Tz<'a> {
    Short(&'a str),
    Expanded { std: Std<'a>, dst: Option<Dst<'a>> },
}

fn quoted_name(input: &str) -> Result<&str> {
    delimited(cchar('<'), is_not("<>"), cchar('>'))(input)
}

fn unquoted_name(input: &str) -> Result<&str> {
    take_while_m_n(3, TZNAME_MAX, |c: char| c.is_alphabetic())(input)
}

fn name(input: &str) -> Result<&str> {
    alt((quoted_name, unquoted_name))(input)
}

fn time_component(input: &str) -> Result<u8> {
    map_res(digit1, |v: &str| v.parse::<u8>())(input)
}

fn time_component_opt(input: &str) -> Result<u8> {
    let (v, v1) = preceded(cchar(':'), time_component)(input)?;
    Ok((v, v1))
}

fn sign(input: &str) -> Result<char> {
    alt((cchar('+'), cchar('-')))(input)
}

fn time(input: &str) -> Result<Time> {
    tuple((
        time_component,
        opt(time_component_opt),
        opt(time_component_opt),
    ))(input)
    .map(|(input, (hh, mm, ss))| (input, Time { hh, mm, ss }))
}

fn time_opt(input: &str) -> Result<Time> {
    preceded(
        cchar('/'),
        tuple((
            time_component,
            opt(time_component_opt),
            opt(time_component_opt),
        )),
    )(input)
    .map(|(input, (hh, mm, ss))| (input, Time { hh, mm, ss }))
}

fn offset(input: &str) -> Result<Offset> {
    let (input, (sign, time)) = tuple((opt(sign), time))(input)?;
    let positive = sign.map(|v| v == '+').unwrap_or(true);
    Ok((input, Offset { positive, time }))
}

fn date_j(input: &str) -> Result<Date> {
    preceded(cchar('J'), map_res(digit1, |v: &str| v.parse::<u16>()))(input)
        .map(|(input, n)| (input, Date::J(n)))
}

fn date_n(input: &str) -> Result<Date> {
    map_res(digit1, |v: &str| v.parse::<u16>())(input).map(|(input, n)| (input, Date::N(n)))
}

fn date_m(input: &str) -> Result<Date> {
    tuple((
        preceded(cchar('M'), map_res(digit1, |v: &str| v.parse::<u8>())),
        preceded(cchar('.'), map_res(digit1, |v: &str| v.parse::<u8>())),
        preceded(cchar('.'), map_res(digit1, |v: &str| v.parse::<u8>())),
    ))(input)
    .map(|(input, (m, n, d))| (input, Date::M { m, n, d }))
}

fn date(input: &str) -> Result<Date> {
    alt((date_j, date_m, date_n))(input)
}

fn rule(input: &str) -> Result<Rule> {
    tuple((
        preceded(cchar(','), tuple((date, opt(time_opt)))),
        preceded(cchar(','), tuple((date, opt(time_opt)))),
    ))(input)
    .map(|(input, (start, end))| (input, Rule { start, end }))
}

fn std(input: &str) -> Result<Std> {
    tuple((name, offset))(input).map(|(input, (name, offset))| (input, Std { name, offset }))
}

fn dst(input: &str) -> Result<Dst> {
    tuple((name, opt(offset), opt(rule)))(input)
        .map(|(input, (name, offset, rule))| (input, Dst { name, offset, rule }))
}

fn tz_short(input: &str) -> Result<Tz> {
    preceded(cchar(':'), name)(input).map(|(input, name)| (input, Tz::Short(name)))
}

fn tz_expanded(input: &str) -> Result<Tz> {
    tuple((std, opt(dst)))(input).map(|(input, (std, dst))| (input, Tz::Expanded { std, dst }))
}

pub fn entry(input: &str) -> Result<Tz> {
    terminated(alt((tz_short, tz_expanded)), eof)(input)
}

#[cfg(test)]
mod tests {
    use crate::posix_tz::parser::{entry, Date, Dst, Offset, Rule, Std, Time, Tz};

    #[test]
    fn basic() {
        let str = "ABC+1:00DEF,M1.2.3/4,56";
        let (_, test) = entry(str).unwrap();
        assert_eq!(
            test,
            Tz::Expanded {
                std: Std {
                    name: "ABC",
                    offset: Offset {
                        positive: true,
                        time: Time {
                            hh: 1,
                            mm: Some(0),
                            ss: None,
                        },
                    },
                },
                dst: Some(Dst {
                    name: "DEF",
                    offset: None,
                    rule: Some(Rule {
                        start: (
                            Date::M { m: 1, n: 2, d: 3 },
                            Some(Time {
                                hh: 4,
                                mm: None,
                                ss: None,
                            })
                        ),
                        end: (Date::N(56), None),
                    }),
                }),
            }
        )
    }
}