Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

fix(#1051): Ignore potential ordinal suffixes of length greater than 2 (#1054)

Grant Lemonsaa8ea9ddfa12
diff --git a/harper-core/src/document.rs b/harper-core/src/document.rs
index 94e85249c..5edbad29a 100644
--- a/harper-core/src/document.rs
+++ b/harper-core/src/document.rs
@@ -13,7 +13,7 @@ use crate::vec_ext::VecExt;
use crate::{
Dictionary, FatStringToken, FatToken, FstDictionary, Lrc, Token, TokenKind, TokenStringExt,
};
-use crate::{NumberSuffix, Span};
+use crate::{OrdinalSuffix, Span};
/// A document containing some amount of lexed and parsed English text.
#[derive(Debug, Clone)]
@@ -351,7 +351,8 @@ impl Document {
// TODO: Allow spaces between `a` and `b`
if let (TokenKind::Number(..), TokenKind::Word(..)) = (&a.kind, &b.kind) {
- if let Some(found_suffix) = NumberSuffix::from_chars(self.get_span_content(&b.span))
+ if let Some(found_suffix) =
+ OrdinalSuffix::from_chars(self.get_span_content(&b.span))
{
self.tokens[idx].kind.as_mut_number().unwrap().suffix = Some(found_suffix);
replace_starts.push(idx);
diff --git a/harper-core/src/lib.rs b/harper-core/src/lib.rs
index 24d1c93aa..275209def 100644
--- a/harper-core/src/lib.rs
+++ b/harper-core/src/lib.rs
@@ -35,7 +35,7 @@ pub use fat_token::{FatStringToken, FatToken};
pub use ignored_lints::IgnoredLints;
use linting::Lint;
pub use mask::{Mask, Masker};
-pub use number::{Number, NumberSuffix};
+pub use number::{Number, OrdinalSuffix};
pub use punctuation::{Punctuation, Quote};
pub use span::Span;
pub use spell::{Dictionary, FstDictionary, MergedDictionary, MutableDictionary, WordId};
diff --git a/harper-core/src/linting/correct_number_suffix.rs b/harper-core/src/linting/correct_number_suffix.rs
index 38e38d871..146798e34 100644
--- a/harper-core/src/linting/correct_number_suffix.rs
+++ b/harper-core/src/linting/correct_number_suffix.rs
@@ -1,5 +1,5 @@
use super::{Lint, LintKind, Linter, Suggestion};
-use crate::{Document, NumberSuffix, Span, TokenKind};
+use crate::{Document, OrdinalSuffix, Span, TokenKind};
use crate::{Number, TokenStringExt};
/// Detect and warn that the sentence is too long.
@@ -21,7 +21,7 @@ impl Linter for CorrectNumberSuffix {
..
}) = number_tok.kind
{
- if let Some(correct_suffix) = NumberSuffix::correct_suffix_for(value) {
+ if let Some(correct_suffix) = OrdinalSuffix::correct_suffix_for(value) {
if suffix != correct_suffix {
output.push(Lint {
span: suffix_span,
diff --git a/harper-core/src/number.rs b/harper-core/src/number.rs
index bcd68d6d3..03316e2d0 100644
--- a/harper-core/src/number.rs
+++ b/harper-core/src/number.rs
@@ -7,7 +7,7 @@ use serde::{Deserialize, Serialize};
#[derive(Debug, Serialize, Deserialize, Clone, Copy, Default, PartialEq, Eq, Hash, PartialOrd)]
pub struct Number {
pub value: OrderedFloat<f64>,
- pub suffix: Option<NumberSuffix>,
+ pub suffix: Option<OrdinalSuffix>,
pub radix: u32,
pub precision: usize,
}
@@ -33,7 +33,7 @@ impl Display for Number {
#[derive(
Debug, Serialize, Deserialize, Default, PartialEq, PartialOrd, Clone, Copy, Is, Hash, Eq,
)]
-pub enum NumberSuffix {
+pub enum OrdinalSuffix {
#[default]
Th,
St,
@@ -41,7 +41,7 @@ pub enum NumberSuffix {
Rd,
}
-impl NumberSuffix {
+impl OrdinalSuffix {
pub fn correct_suffix_for(number: impl Into<f64>) -> Option<Self> {
let number = number.into();
@@ -72,37 +72,37 @@ impl NumberSuffix {
pub fn to_chars(self) -> Vec<char> {
match self {
- NumberSuffix::Th => vec!['t', 'h'],
- NumberSuffix::St => vec!['s', 't'],
- NumberSuffix::Nd => vec!['n', 'd'],
- NumberSuffix::Rd => vec!['r', 'd'],
+ OrdinalSuffix::Th => vec!['t', 'h'],
+ OrdinalSuffix::St => vec!['s', 't'],
+ OrdinalSuffix::Nd => vec!['n', 'd'],
+ OrdinalSuffix::Rd => vec!['r', 'd'],
}
}
/// Check the first several characters in a buffer to see if it matches a
/// number suffix.
pub fn from_chars(chars: &[char]) -> Option<Self> {
- if chars.len() < 2 {
+ if chars.len() != 2 {
return None;
}
match (chars[0], chars[1]) {
- ('t', 'h') => Some(NumberSuffix::Th),
- ('T', 'h') => Some(NumberSuffix::Th),
- ('t', 'H') => Some(NumberSuffix::Th),
- ('T', 'H') => Some(NumberSuffix::Th),
- ('s', 't') => Some(NumberSuffix::St),
- ('S', 't') => Some(NumberSuffix::St),
- ('s', 'T') => Some(NumberSuffix::St),
- ('S', 'T') => Some(NumberSuffix::St),
- ('n', 'd') => Some(NumberSuffix::Nd),
- ('N', 'd') => Some(NumberSuffix::Nd),
- ('n', 'D') => Some(NumberSuffix::Nd),
- ('N', 'D') => Some(NumberSuffix::Nd),
- ('r', 'd') => Some(NumberSuffix::Rd),
- ('R', 'd') => Some(NumberSuffix::Rd),
- ('r', 'D') => Some(NumberSuffix::Rd),
- ('R', 'D') => Some(NumberSuffix::Rd),
+ ('t', 'h') => Some(OrdinalSuffix::Th),
+ ('T', 'h') => Some(OrdinalSuffix::Th),
+ ('t', 'H') => Some(OrdinalSuffix::Th),
+ ('T', 'H') => Some(OrdinalSuffix::Th),
+ ('s', 't') => Some(OrdinalSuffix::St),
+ ('S', 't') => Some(OrdinalSuffix::St),
+ ('s', 'T') => Some(OrdinalSuffix::St),
+ ('S', 'T') => Some(OrdinalSuffix::St),
+ ('n', 'd') => Some(OrdinalSuffix::Nd),
+ ('N', 'd') => Some(OrdinalSuffix::Nd),
+ ('n', 'D') => Some(OrdinalSuffix::Nd),
+ ('N', 'D') => Some(OrdinalSuffix::Nd),
+ ('r', 'd') => Some(OrdinalSuffix::Rd),
+ ('R', 'd') => Some(OrdinalSuffix::Rd),
+ ('r', 'D') => Some(OrdinalSuffix::Rd),
+ ('R', 'D') => Some(OrdinalSuffix::Rd),
_ => None,
}
}
@@ -110,9 +110,10 @@ impl NumberSuffix {
#[cfg(test)]
mod tests {
+ use itertools::Itertools;
use ordered_float::OrderedFloat;
- use crate::NumberSuffix;
+ use crate::OrdinalSuffix;
use super::Number;
@@ -149,7 +150,7 @@ mod tests {
assert_eq!(
Number {
value: OrderedFloat(15.0),
- suffix: Some(NumberSuffix::Th),
+ suffix: Some(OrdinalSuffix::Th),
radix: 10,
precision: 0
}
@@ -171,4 +172,10 @@ mod tests {
"15.50"
)
}
+
+ #[test]
+ fn issue_1051() {
+ let word = "story".chars().collect_vec();
+ assert_eq!(None, OrdinalSuffix::from_chars(&word));
+ }
}