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
#![allow(clippy::needless_doctest_main)]
//! # FuzzyDate: Date Input for Humans
//!
//! A Parser which can turn a variety of input strings into a DateTime
//!
//! ## Usage
//!
//! Put this in your `Cargo.toml`:
//!
//! ```toml
//! fuzzydate = "0.2"
//! ```
//!
//! ## Example
//!
//! ```rust
//! use fuzzydate::parse;
//! use chrono::NaiveDateTime;
//!
//! fn main() {
//! let date_string = "Five days after 2/12/22 5:00 PM";
//! let date = parse(date_string).unwrap();
//! println!("{:?}", date);
//! }
//! ```
//!
//! Any relevant date time information not specified is assumed to be
//! the value of the current date time.
//!
//! ## Grammar
//! ```text
//! <datetime> ::= <time>
//! | <date> <time>
//! | <date> , <time>
//! | <duration> after <datetime>
//! | <duration> from <datetime>
//! | <duration> before <datetime>
//! | <duration> ago
//! | now
//!
//! <article> ::= a
//! | an
//! | the
//!
//! <date> ::= today
//! | tomorrow
//! | yesterday
//! | <num> / <num> / <num>
//! | <num> - <num> - <num>
//! | <num> . <num> . <num>
//! | <month> <num> <num>
//! | <relative_specifier> <unit>
//! | <relative_specifier> <weekday>
//! | <weekday>
//!
//! <relative_specifier> ::= this
//! | next
//! | last
//!
//! <weekday> ::= monday
//! | tuesday
//! | wednesday
//! | thursday
//! | friday
//! | saturday
//! | sunday
//! | mon
//! | tue
//! | wed
//! | thu
//! | fri
//! | sat
//! | sun
//!
//! <month> ::= january
//! | february
//! | march
//! | april
//! | may
//! | june
//! | july
//! | august
//! | september
//! | october
//! | november
//! | december
//! | jan
//! | feb
//! | mar
//! | apr
//! | jun
//! | jul
//! | aug
//! | sep
//! | oct
//! | nov
//! | dec
//!
//! <duration> ::= <num> <unit>
//! | <article> <unit>
//! | <duration> and <duration>
//!
//! <time> ::= <num>:<num>
//! | <num>:<num> am
//! | <num>:<num> pm
//! |
//!
//! <unit> ::= day
//! | days
//! | week
//! | weeks
//! | hour
//! | hours
//! | minute
//! | minutes
//! | min
//! | mins
//! | month
//! | months
//! | year
//! | years
//!
//! <num> ::= <num_triple> <num_triple_unit> and <num>
//! | <num_triple> <num_triple_unit> <num>
//! | <num_triple> <num_triple_unit>
//! | <num_triple_unit> and <num>
//! | <num_triple_unit> <num>
//! | <num_triple_unit>
//! | <num_triple>
//! | NUM ; number literal greater than or equal to 1000
//!
//! <num_triple> ::= <ones> hundred and <num_double>
//! | <ones> hundred <num_double>
//! | <ones> hundred
//! | hundred and <num_double>
//! | hundred <num_double>
//! | hundred
//! | <num_double>
//! | NUM ; number literal less than 1000 and greater than 99
//!
//! <num_triple_unit> ::= thousand
//! | million
//! | billion
//!
//! <num_double> ::= <ones>
//! | <tens> - <ones>
//! | <tens> <ones>
//! | <tens>
//! | <teens>
//! | NUM ; number literal less than 100 and greater than 19
//!
//! <tens> ::= twenty
//! | thirty
//! | forty
//! | fifty
//! | sixty
//! | seventy
//! | eighty
//! | ninety
//!
//! <teens> ::= ten
//! | eleven
//! | twelve
//! | thirteen
//! | fourteen
//! | fifteen
//! | sixteen
//! | seventeen
//! | eighteen
//! | nineteen
//! | NUM ; number literal less than 20 and greater than 9
//!
//! <ones> ::= one
//! | two
//! | three
//! | four
//! | five
//! | six
//! | seven
//! | eight
//! | nine
//! | NUM ; number literal less than 10
//! ```
mod ast;
mod lexer;
use chrono::{Local, NaiveDateTime, NaiveTime};
#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
pub enum Error {
#[error("Invalid date")]
/// The date is invalid,
/// e.g. `"31st of February"`, `"December 32nd"`, `"32/13/2019"`
InvalidDate(String),
#[error("Unrecognized Token while lexing")]
/// The lexer found a token that it doesn't recognize
UnrecognizedToken(String),
#[error("Unable to parse date")]
/// The date _may_ be valid, but the parser was unable to parse it,
/// e.g. `"tomorrow at at 5pm"`
ParseError,
}
// so that we don't have to change this in both places
// doesn't show up in the docs
type Output = Result<NaiveDateTime, Error>;
/// Parse an input string into a chrono NaiveDateTime, using the default
/// values from the specified default value where not specified
pub fn parse_with_default_time(input: impl Into<String>, default: NaiveTime) -> Output {
let lexemes = lexer::Lexeme::lex_line(input.into())?;
let (tree, _) = ast::DateTime::parse(lexemes.as_slice()).ok_or(Error::ParseError)?;
tree.to_chrono(default)
}
/// Parse an input string into a chrono NaiveDateTime with the default
/// time being now
pub fn parse(input: impl Into<String>) -> Output {
parse_with_default_time(input, Local::now().naive_local().time())
}
#[test]
fn test_parse() {
use chrono::Datelike;
let input = "2/12/2022";
let date = parse(input).unwrap();
assert_eq!(2, date.month());
assert_eq!(12, date.day());
assert_eq!(2022, date.year());
}
#[test]
fn test_malformed() {
let input = "Hello World";
let date = parse(input);
assert!(date.is_err());
}
#[test]
fn test_empty() {
let input = "";
let date = parse(input);
assert!(date.is_err());
}