Merge pull request #71 from baoyachi/chinese_unit

Supports parsing of Chinese time unit names

Author: baoyachi

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "duration-str"
-version = "0.16.1"
+version = "0.17.0"
 authors = ["baoyachi <[email protected]>"]
 edition = "2021"
 description = "duration string parser"
@@ -17,6 +17,7 @@ default = ["chrono", "serde", "time", "calc"]
 lowercase = []
 no_calc = []
 calc = []
+cn_unit = []
 
 [dependencies]
 thiserror = "2.0.0"
@@ -25,7 +26,7 @@ time = { version = "0.3.17", optional = true, default-features = false }
 
 serde = { version = "1.0.147", features = ["derive"], optional = true }
 rust_decimal = { version = "1.29.1", default-features = false }
-winnow = "0.7.3"
+winnow = "0.7.4"
 
 [dev-dependencies]
 serde_json = { version = "1.0.87" }

README.md

@@ -17,6 +17,7 @@
 ## Features:
 
 * 🚀 Strong compatibility, accommodating leading or trailing whitespaces in strings.
+* 🌏 Supports parsing of Chinese time unit names (requires the `cn_unit` feature)
 * 👍️ Offers [Playground](https://baoyachi.github.io/duration-str/) support for online debugging.
 * ⭐ Integrated with the [serde](https://docs.rs/serde) library.
 * 🎉 Supports parsing of various `Duration` types:
@@ -105,6 +106,60 @@ fn main() {
 
     let duration = parse("1m * 1m").unwrap();
     assert_eq!(duration, Duration::new(3600, 0));
+
+
+    // The following code requires the `cn_unit` feature.
+    // Add it to your `Cargo.toml` like this:
+    // duration-str = { version = "{latest version}", features = ["cn_unit"] } 
+
+    let duration = parse("1年").unwrap();
+    assert_eq!(duration, Duration::new(31536000, 0));
+
+    let duration = parse("1月").unwrap();
+    assert_eq!(duration, Duration::new(2592000, 0));
+
+    let duration = parse("1周").unwrap();
+    assert_eq!(duration, Duration::new(604800, 0));
+
+    let duration = parse("1日").unwrap();
+    assert_eq!(duration, Duration::new(86400, 0));
+
+    let duration = parse("1天").unwrap();
+    assert_eq!(duration, Duration::new(86400, 0));
+
+    let duration = parse("1时").unwrap();
+    assert_eq!(duration, Duration::new(3600, 0));
+
+    let duration = parse("1分").unwrap();
+    assert_eq!(duration, Duration::new(60, 0));
+
+    let duration = parse("1秒").unwrap();
+    assert_eq!(duration, Duration::new(1, 0));
+
+    let duration = parse("1毫秒").unwrap();
+    assert_eq!(duration, Duration::new(0, 1 * 1000 * 1000));
+
+    let duration = parse("1微秒").unwrap();
+    assert_eq!(duration, Duration::new(0, 1 * 1000));
+
+    let duration = parse("1纳秒").unwrap();
+    assert_eq!(duration, Duration::new(0, 1));
+
+    let duration = parse("1年 2日").unwrap();
+    assert_eq!(duration, Duration::new(31708800, 0));
+
+    let duration = parse("1分31秒").unwrap();
+    assert_eq!(duration, Duration::new(91, 0));
+
+    let duration = parse("1分+31秒").unwrap();
+    assert_eq!(duration, Duration::new(91, 0));
+
+    let duration = parse("1分+31秒+2毫秒+3纳秒").unwrap();
+    assert_eq!(duration, Duration::new(91, 2 * 1000 * 1000 + 3));
+
+    let duration = parse(" 1分+   31秒 + 2毫秒+  3纳秒  ").unwrap();
+    assert_eq!(duration, Duration::new(91, 2 * 1000 * 1000 + 3));
+    
 }
 ```
 

playground/wasm/Cargo.toml

@@ -9,7 +9,7 @@ crate-type = ["cdylib", "rlib"]
 
 
 [dependencies]
-duration-str = { path = "../../"}
+duration-str = { path = "../../", features = ["cn_unit"] }
 serde-wasm-bindgen = "0.5"
 serde_json = "1.0.108"
 wasm-bindgen = "0.2.92"

src/parser.rs

@@ -191,6 +191,58 @@ mod tests {
         assert_eq!(duration, Duration::new(144, 0))
     }
 
+    #[cfg(feature = "cn_unit")]
+    #[test]
+    fn test_parse_unit_cn() {
+        let duration = parse("1年").unwrap();
+        assert_eq!(duration, Duration::new(31536000, 0));
+
+        let duration = parse("1月").unwrap();
+        assert_eq!(duration, Duration::new(2592000, 0));
+
+        let duration = parse("1周").unwrap();
+        assert_eq!(duration, Duration::new(604800, 0));
+
+        let duration = parse("1日").unwrap();
+        assert_eq!(duration, Duration::new(86400, 0));
+
+        let duration = parse("1天").unwrap();
+        assert_eq!(duration, Duration::new(86400, 0));
+
+        let duration = parse("1时").unwrap();
+        assert_eq!(duration, Duration::new(3600, 0));
+
+        let duration = parse("1分").unwrap();
+        assert_eq!(duration, Duration::new(60, 0));
+
+        let duration = parse("1秒").unwrap();
+        assert_eq!(duration, Duration::new(1, 0));
+
+        let duration = parse("1毫秒").unwrap();
+        assert_eq!(duration, Duration::new(0, 1 * 1000 * 1000));
+
+        let duration = parse("1微秒").unwrap();
+        assert_eq!(duration, Duration::new(0, 1 * 1000));
+
+        let duration = parse("1纳秒").unwrap();
+        assert_eq!(duration, Duration::new(0, 1));
+
+        let duration = parse("1年 2日").unwrap();
+        assert_eq!(duration, Duration::new(31708800, 0));
+
+        let duration = parse("1分31秒").unwrap();
+        assert_eq!(duration, Duration::new(91, 0));
+
+        let duration = parse("1分+31秒").unwrap();
+        assert_eq!(duration, Duration::new(91, 0));
+
+        let duration = parse("1分+31秒+2毫秒+3纳秒").unwrap();
+        assert_eq!(duration, Duration::new(91, 2 * 1000 * 1000 + 3));
+
+        let duration = parse(" 1分+   31秒 + 2毫秒+  3纳秒  ").unwrap();
+        assert_eq!(duration, Duration::new(91, 2 * 1000 * 1000 + 3));
+    }
+
     #[test]
     fn test_duration_err() {
         assert_eq!(

src/unit.rs

@@ -47,6 +47,15 @@ impl Display for TimeUnit {
 }
 
 impl TimeUnit {
+    #[inline]
+    #[cfg(feature = "cn_unit")]
+    fn is_cn_unit(c: char) -> bool {
+        [
+            '年', '月', '周', '日', '天', '时', '分', '秒', '毫', '微', '纳',
+        ]
+        .contains(&c)
+    }
+
     pub(crate) fn duration(&self, time_str: impl AsRef<str>) -> DResult<u64> {
         let time = time_str
             .as_ref()
@@ -93,7 +102,28 @@ impl FromStr for TimeUnit {
             "µs" | "µsec" | "µsecond" | "us" | "usec" | "usecond" | "microsecond"
             | "microseconds" => Ok(TimeUnit::MicroSecond),
             "ns" | "nsec" | "nanosecond" | "nanoseconds" => Ok(TimeUnit::NanoSecond),
-            _ => Err(DError::ParseError(Self::expect_err(s))),
+
+            #[cfg(feature = "cn_unit")]
+            "年" => Ok(TimeUnit::Year),
+            #[cfg(feature = "cn_unit")]
+            "月" => Ok(TimeUnit::Month),
+            #[cfg(feature = "cn_unit")]
+            "周" => Ok(TimeUnit::Week),
+            #[cfg(feature = "cn_unit")]
+            "日" | "天" => Ok(TimeUnit::Day),
+            #[cfg(feature = "cn_unit")]
+            "时" => Ok(TimeUnit::Hour),
+            #[cfg(feature = "cn_unit")]
+            "分" => Ok(TimeUnit::Minute),
+            #[cfg(feature = "cn_unit")]
+            "秒" => Ok(TimeUnit::Second),
+            #[cfg(feature = "cn_unit")]
+            "毫秒" => Ok(TimeUnit::MilliSecond),
+            #[cfg(feature = "cn_unit")]
+            "微秒" => Ok(TimeUnit::MicroSecond),
+            #[cfg(feature = "cn_unit")]
+            "纳秒" => Ok(TimeUnit::NanoSecond),
+            _ => Err(DError::ParseError(Self::expect_err(case))),
         }
     }
 }
@@ -105,7 +135,17 @@ impl_expect_err!(
 );
 
 pub(crate) fn unit_abbr1(input: &mut &str) -> WResult<TimeUnit> {
-    take_while(1.., |c: char| c.is_alpha() || c == 'µ')
+    let set = |c: char| c.is_alpha() || c == 'µ';
+    let set = {
+        #[cfg(feature = "cn_unit")]
+        {
+            move |c: char| set(c) || TimeUnit::is_cn_unit(c)
+        }
+        #[cfg(not(feature = "cn_unit"))]
+        set
+    };
+
+    take_while(1.., set)
         .parse_to()
         .context(StrContext::Expected(StrContextValue::Description(
             TimeUnit::get_expect_val(),
@@ -182,6 +222,55 @@ mod tests {
         );
     }
 
+    #[cfg(feature = "cn_unit")]
+    #[test]
+    fn test_time_cn_unit_abbr() {
+        assert_eq!(
+            unit_abbr1.parse_peek(&Partial::new("年")),
+            Ok(("", TimeUnit::Year))
+        );
+        assert_eq!(
+            unit_abbr1.parse_peek(&Partial::new("月")),
+            Ok(("", TimeUnit::Month))
+        );
+        assert_eq!(
+            unit_abbr1.parse_peek(&Partial::new("周")),
+            Ok(("", TimeUnit::Week))
+        );
+        assert_eq!(
+            unit_abbr1.parse_peek(&Partial::new("日")),
+            Ok(("", TimeUnit::Day))
+        );
+        assert_eq!(
+            unit_abbr1.parse_peek(&Partial::new("天")),
+            Ok(("", TimeUnit::Day))
+        );
+        assert_eq!(
+            unit_abbr1.parse_peek(&Partial::new("时")),
+            Ok(("", TimeUnit::Hour))
+        );
+        assert_eq!(
+            unit_abbr1.parse_peek(&Partial::new("分")),
+            Ok(("", TimeUnit::Minute))
+        );
+        assert_eq!(
+            unit_abbr1.parse_peek(&Partial::new("秒")),
+            Ok(("", TimeUnit::Second))
+        );
+        assert_eq!(
+            unit_abbr1.parse_peek(&Partial::new("毫秒")),
+            Ok(("", TimeUnit::MilliSecond))
+        );
+        assert_eq!(
+            unit_abbr1.parse_peek(&Partial::new("微秒")),
+            Ok(("", TimeUnit::MicroSecond))
+        );
+        assert_eq!(
+            unit_abbr1.parse_peek(&Partial::new("纳秒")),
+            Ok(("", TimeUnit::NanoSecond))
+        );
+    }
+
     #[test]
     fn test_time_unit() {
         let (input, format) = unit_abbr1.parse_peek("m123").unwrap();