use crate::{
Lint, Token, TokenStringExt,
char_string::CharStringExt,
expr::{Expr, FirstMatchOf, OwnedExprExt, ReflexivePronoun, SequenceExpr},
linting::{ExprLinter, LintKind, Suggestion, expr_linter::Chunk},
};
pub struct RedundantSelf {
expr: FirstMatchOf,
}
impl Default for RedundantSelf {
fn default() -> Self {
let reflexive_verb = Box::new(
SequenceExpr::aco("self")
.t_ws_h()
.t_set(&[
"censor",
"censored",
"censors",
"censoring",
"correct",
"corrected",
"correcting",
"corrects",
"defend",
"defended",
"defending",
"defends",
"describe",
"described",
"describes",
"describing",
"diagnose",
"diagnosed",
"diagnoses",
"diagnosing",
"govern",
"governed",
"governs",
"governing",
"harm",
"harmed",
"harming",
"harms",
"identify",
"identified",
"identifies",
"identifying",
"medicate",
"medicated",
"medicates",
"medicating",
"regulate",
"regulated",
"regulates",
"regulating",
"right",
"righted",
"righting",
"rights",
"sabotage",
"sabotaged",
"sabotages",
"sabotaging",
"taught",
"teach",
"teaches",
"teaching",
])
.t_ws()
.then(ReflexivePronoun::with_common_errors())
.but_not(
SequenceExpr::anything()
.t_any()
.t_aco("harm")
.t_any()
.t_aco("itself"),
),
);
let noun = Box::new(
SequenceExpr::aco("self")
.t_ws_h()
.t_aco("harm")
.t_ws()
.t_aco("to")
.t_ws()
.then(ReflexivePronoun::with_common_errors()),
);
let transitive_verb = Box::new(
SequenceExpr::aco("self")
.t_ws_h()
.t_set(&["host", "hosted", "hosting", "hosts"])
.t_ws()
.t_set(&["it", "them", "one"])
.t_ws()
.then(ReflexivePronoun::with_common_errors()),
);
Self {
expr: FirstMatchOf::new(vec![reflexive_verb as Box<dyn Expr>, noun, transitive_verb]),
}
}
}
impl ExprLinter for RedundantSelf {
type Unit = Chunk;
fn match_to_lint(&self, toks: &[Token], src: &[char]) -> Option<Lint> {
let span = toks.span()?;
let suggestions = match (toks.len(), toks[4].get_ch(src).eq_ch(&['t', 'o'])) {
(5, _) => [0..=2, 2..=4],
(7, true) => [0..=2, 2..=6],
(7, false) => [0..=4, 2..=6],
_ => {
return None;
}
}
.iter()
.map(|range| range.clone().collect::<Vec<_>>())
.map(|indices| {
Suggestion::replace_with_match_case(
indices
.into_iter()
.flat_map(|i| toks[i].get_ch(src))
.copied()
.collect(),
span.get_content(src),
)
})
.collect();
Some(Lint {
span: toks.span()?,
lint_kind: LintKind::Redundancy,
suggestions,
message: "Avoid redundancy by using `self` only once.".to_string(),
..Default::default()
})
}
fn expr(&self) -> &dyn Expr {
&self.expr
}
fn description(&self) -> &str {
"Detects redundant use of `self-` prefixes with reflexive pronouns (e.g., `self-host it themselves`)."
}
}
#[cfg(test)]
mod tests {
use crate::linting::tests::{
assert_good_and_bad_suggestions, assert_no_lints, assert_suggestion_result,
};
use super::RedundantSelf;
#[test]
fn fix_self_harm_herself_hy() {
assert_good_and_bad_suggestions(
"Camille about to self-harm herself",
RedundantSelf::default(),
&[
"Camille about to harm herself",
"Camille about to self-harm",
],
&[],
);
}
#[test]
fn fix_self_harming_herself_hy() {
assert_good_and_bad_suggestions(
"At times she was suicidal and started self-harming herself when she was 12.",
RedundantSelf::default(),
&[
"At times she was suicidal and started harming herself when she was 12.",
"At times she was suicidal and started self-harming when she was 12.",
],
&[],
);
}
#[test]
fn fix_self_harming_herself_sp() {
assert_good_and_bad_suggestions(
"Violet self harming herself is inter-spliced in this montage and Tate walks in to tell her she's cutting the wrong way.",
RedundantSelf::default(),
&[
"Violet harming herself is inter-spliced in this montage and Tate walks in to tell her she's cutting the wrong way.",
"Violet self harming is inter-spliced in this montage and Tate walks in to tell her she's cutting the wrong way.",
],
&[],
);
}
#[test]
fn fix_self_harming_himself_hy() {
assert_good_and_bad_suggestions(
"I don't know the reason till now for doing so but I'm sure he was self-harming himself.",
RedundantSelf::default(),
&[
"I don't know the reason till now for doing so but I'm sure he was harming himself.",
"I don't know the reason till now for doing so but I'm sure he was self-harming.",
],
&[],
);
}
#[test]
fn fix_self_harming_myself_sp() {
assert_good_and_bad_suggestions(
"I'm no programmer or anything like that but I like staying up late at night and self harming myself trying to get ajax to work.",
RedundantSelf::default(),
&[
"I'm no programmer or anything like that but I like staying up late at night and harming myself trying to get ajax to work.",
"I'm no programmer or anything like that but I like staying up late at night and self harming trying to get ajax to work.",
],
&[],
);
}
#[test]
fn fix_self_harming_myself_hy() {
assert_good_and_bad_suggestions(
"How I stopped self-harming myself",
RedundantSelf::default(),
&["How I stopped harming myself", "How I stopped self-harming"],
&[],
);
}
#[test]
fn fix_self_harm_to_myself_hy() {
assert_good_and_bad_suggestions(
"I'm glad that I didn't do any self-harm to myself",
RedundantSelf::default(),
&[
"I'm glad that I didn't do any harm to myself",
"I'm glad that I didn't do any self-harm",
],
&[],
);
}
#[test]
fn fix_self_harm_to_myself_sp() {
assert_good_and_bad_suggestions(
"so I did self harm to myself with the teacher noticing",
RedundantSelf::default(),
&[
"so I did harm to myself with the teacher noticing",
"so I did self harm with the teacher noticing",
],
&[],
);
}
#[test]
fn fix_self_harmed_myself_sp() {
assert_good_and_bad_suggestions(
"I haven't self harmed myself in exactly 3 months and 4 days!!!",
RedundantSelf::default(),
&[
"I haven't harmed myself in exactly 3 months and 4 days!!!",
"I haven't self harmed in exactly 3 months and 4 days!!!",
],
&[],
);
}
#[test]
fn fix_self_harmed_themself_sp() {
assert_good_and_bad_suggestions(
"trusted you enough to tell you that they self harmed themself",
RedundantSelf::default(),
&[
"trusted you enough to tell you that they harmed themself",
"trusted you enough to tell you that they self harmed",
],
&[],
);
}
#[test]
fn fix_self_harming_yourself_hy() {
assert_good_and_bad_suggestions(
"Is psychologically self-harming yourself on purpose possible",
RedundantSelf::default(),
&[
"Is psychologically harming yourself on purpose possible",
"Is psychologically self-harming on purpose possible",
],
&[],
);
}
#[test]
fn fix_self_harming_yourself_sp() {
assert_good_and_bad_suggestions(
"What isn't seen as self harming yourself but actually is?",
RedundantSelf::default(),
&[
"What isn't seen as harming yourself but actually is?",
"What isn't seen as self harming but actually is?",
],
&[],
);
}
#[test]
fn fix_self_harm_to_yourself_hy() {
assert_good_and_bad_suggestions(
"First of all, do not turn to physical abuse or any type of self-harm to yourself.",
RedundantSelf::default(),
&[
"First of all, do not turn to physical abuse or any type of harm to yourself.",
"First of all, do not turn to physical abuse or any type of self-harm.",
],
&[],
);
}
#[test]
fn fix_self_teaching_myself() {
assert_suggestion_result(
"This is a reference of me self-teaching myself the Barvinok algorithm.",
RedundantSelf::default(),
"This is a reference of me teaching myself the Barvinok algorithm.",
);
}
#[test]
fn fix_self_taught_myself() {
assert_suggestion_result(
"Since I wasn't blessed to learn security related topic back when I was undergrad, I self taught myself using udemy, and CTF Challenge online.",
RedundantSelf::default(),
"Since I wasn't blessed to learn security related topic back when I was undergrad, I taught myself using udemy, and CTF Challenge online.",
);
}
#[test]
fn fix_self_teach_myself() {
assert_suggestion_result(
"I decided to self-teach myself python so I could get more involved in wider aspects of research, specifically data science.",
RedundantSelf::default(),
"I decided to teach myself python so I could get more involved in wider aspects of research, specifically data science.",
);
}
#[test]
fn fix_self_teaching_themselves() {
assert_suggestion_result(
"The point of OSSU is to make things easier for people self-teaching themselves CS.",
RedundantSelf::default(),
"The point of OSSU is to make things easier for people teaching themselves CS.",
);
}
#[test]
fn fix_self_host_it_yourself() {
assert_good_and_bad_suggestions(
"If you want to self-host it yourself, get the latest release and download the distributable zip file attached to it",
RedundantSelf::default(),
&[
"If you want to self-host it, get the latest release and download the distributable zip file attached to it",
"If you want to host it yourself, get the latest release and download the distributable zip file attached to it",
],
&[],
);
}
#[test]
fn fix_self_hosting_it_themselves() {
assert_good_and_bad_suggestions(
"I've open-sourced the codebase and written an installation guide to make it as easy as possible for others who are interested in self-hosting it themselves.",
RedundantSelf::default(),
&[
"I've open-sourced the codebase and written an installation guide to make it as easy as possible for others who are interested in self-hosting it.",
"I've open-sourced the codebase and written an installation guide to make it as easy as possible for others who are interested in hosting it themselves.",
],
&[],
);
}
#[test]
fn fix_self_hosted_one_myself() {
assert_good_and_bad_suggestions(
"I though WalletConnect bridge server might be too flooded with requests, so I self-hosted one myself, same result.",
RedundantSelf::default(),
&[
"I though WalletConnect bridge server might be too flooded with requests, so I self-hosted one, same result.",
"I though WalletConnect bridge server might be too flooded with requests, so I hosted one myself, same result.",
],
&[],
);
}
#[test]
fn fix_self_diagnosed_myself() {
assert_good_and_bad_suggestions(
"As a professional amateur doctor I have self-diagnosed myself with a mild case of alzheimer",
RedundantSelf::default(),
&[
"As a professional amateur doctor I have self-diagnosed with a mild case of alzheimer",
"As a professional amateur doctor I have diagnosed myself with a mild case of alzheimer",
],
&[],
);
}
#[test]
fn fix_self_diagnose_himself() {
assert_good_and_bad_suggestions(
"a user can add his X-ray image in the application and he will be able to self diagnose himself",
RedundantSelf::default(),
&[
"a user can add his X-ray image in the application and he will be able to self diagnose",
"a user can add his X-ray image in the application and he will be able to diagnose himself",
],
&[],
);
}
#[test]
fn fix_self_diagnose_itself() {
assert_good_and_bad_suggestions(
"a spare should self-diagnose itself and generate then store its performance stats in performance.txt",
RedundantSelf::default(),
&[
"a spare should self-diagnose and generate then store its performance stats in performance.txt",
"a spare should diagnose itself and generate then store its performance stats in performance.txt",
],
&[],
);
}
#[test]
fn fix_self_diagnose_themselves() {
assert_good_and_bad_suggestions(
"Team application designed as a mediatery to help users self diagnose themselves or seek medical attention",
RedundantSelf::default(),
&[
"Team application designed as a mediatery to help users self diagnose or seek medical attention",
"Team application designed as a mediatery to help users diagnose themselves or seek medical attention",
],
&[],
);
}
#[test]
fn fix_self_describe_myself() {
assert_good_and_bad_suggestions(
"Moreover, each thing itself can self-describe itself under well-known, e.g.",
RedundantSelf::default(),
&[
"Moreover, each thing itself can self-describe under well-known, e.g.",
"Moreover, each thing itself can describe itself under well-known, e.g.",
],
&[],
);
}
#[test]
fn fix_self_described_yourself() {
assert_good_and_bad_suggestions(
"I know this is asking for a lot, but since you self-described yourself as a documentation nerd- would you be willing to help ...",
RedundantSelf::default(),
&[
"I know this is asking for a lot, but since you self-described as a documentation nerd- would you be willing to help ...",
"I know this is asking for a lot, but since you described yourself as a documentation nerd- would you be willing to help ...",
],
&[],
);
}
#[test]
fn fix_self_describes_itself() {
assert_good_and_bad_suggestions(
"httpx self-describes itself as HTTPX is a fully featured HTTP client for Python 3",
RedundantSelf::default(),
&[
"httpx self-describes as HTTPX is a fully featured HTTP client for Python 3",
"httpx describes itself as HTTPX is a fully featured HTTP client for Python 3",
],
&[],
);
}
#[test]
fn fix_self_describe_themselves() {
assert_good_and_bad_suggestions(
"This, along with some other capabilities, will better allow route handler delegates to self-describe themselves from just the type",
RedundantSelf::default(),
&[
"This, along with some other capabilities, will better allow route handler delegates to self-describe from just the type",
"This, along with some other capabilities, will better allow route handler delegates to describe themselves from just the type",
],
&[],
);
}
#[test]
fn fix_self_medicate_ourselves() {
assert_good_and_bad_suggestions(
"Needless to say we took advantage of this to self-medicate ourselves during the scheduled downtime.",
RedundantSelf::default(),
&[
"Needless to say we took advantage of this to self-medicate during the scheduled downtime.",
"Needless to say we took advantage of this to medicate ourselves during the scheduled downtime.",
],
&[],
);
}
#[test]
fn fix_self_medicate_themselves() {
assert_good_and_bad_suggestions(
"the patient decides to self-medicate themselves, thereby subjecting themselves to additional harms",
RedundantSelf::default(),
&[
"the patient decides to self-medicate, thereby subjecting themselves to additional harms",
"the patient decides to medicate themselves, thereby subjecting themselves to additional harms",
],
&[],
);
}
#[test]
fn fix_self_sabotaging_yourself() {
assert_good_and_bad_suggestions(
"How to stop self-sabotaging yourself. (My struggle with self-sabotagers) has already been recorded in the archive",
RedundantSelf::default(),
&[
"How to stop self-sabotaging. (My struggle with self-sabotagers) has already been recorded in the archive",
"How to stop sabotaging yourself. (My struggle with self-sabotagers) has already been recorded in the archive",
],
&[],
);
}
#[test]
fn fix_self_sabotage_themselves() {
assert_good_and_bad_suggestions(
"I also just don't get why as an artist you'd self sabotage yourself, but you do you if you want you work to be replaced by lazy bastards",
RedundantSelf::default(),
&[
"I also just don't get why as an artist you'd self sabotage, but you do you if you want you work to be replaced by lazy bastards",
"I also just don't get why as an artist you'd sabotage yourself, but you do you if you want you work to be replaced by lazy bastards",
],
&[],
);
}
#[test]
fn fix_self_correct_itself() {
assert_good_and_bad_suggestions(
"Going against the gradient assure that the algorithm self-correct itself, i.e. we obtain parameters that lead to predictions closer and closer to the actual ...",
RedundantSelf::default(),
&[
"Going against the gradient assure that the algorithm correct itself, i.e. we obtain parameters that lead to predictions closer and closer to the actual ...",
"Going against the gradient assure that the algorithm self-correct, i.e. we obtain parameters that lead to predictions closer and closer to the actual ...",
],
&[],
);
}
#[test]
fn fix_self_corrects_itself() {
assert_good_and_bad_suggestions(
"Self corrects itself by fetching the width of the parent",
RedundantSelf::default(),
&[
"Self corrects by fetching the width of the parent",
"Corrects itself by fetching the width of the parent",
],
&[],
);
}
#[test]
fn fix_self_correcting_itself() {
assert_good_and_bad_suggestions(
"the server handling the http site being out of date and then self-correcting itself",
RedundantSelf::default(),
&[
"the server handling the http site being out of date and then correcting itself",
"the server handling the http site being out of date and then self-correcting",
],
&[],
);
}
#[test]
fn fix_self_regulate_myself() {
assert_good_and_bad_suggestions(
"Fun fact: Self Regulate myself with Meditation",
RedundantSelf::default(),
&[
"Fun fact: Self Regulate with Meditation",
],
&[],
);
}
#[test]
fn fix_self_regulating_ourselves() {
assert_good_and_bad_suggestions(
"in general we should be self regulating ourselves and trying to help each other succeed",
RedundantSelf::default(),
&[
"in general we should be regulating ourselves and trying to help each other succeed",
"in general we should be self regulating and trying to help each other succeed",
],
&[],
);
}
#[test]
fn fix_self_censor_themselves() {
assert_good_and_bad_suggestions(
"this would not be desirable, as capturees would be able to self-censor themselves when captured",
RedundantSelf::default(),
&[
"this would not be desirable, as capturees would be able to censor themselves when captured",
"this would not be desirable, as capturees would be able to self-censor when captured",
],
&[],
);
}
#[test]
fn fix_self_censoring_themselves() {
assert_good_and_bad_suggestions(
"Although people often realize that they are self-censoring themselves, it is not always the case.",
RedundantSelf::default(),
&[
"Although people often realize that they are censoring themselves, it is not always the case.",
"Although people often realize that they are self-censoring, it is not always the case.",
],
&[],
);
}
#[test]
fn fix_self_govern_themselves() {
assert_good_and_bad_suggestions(
"system that enables Founders and investors to coordinate and self-govern themselves through a set of self-executing rules published on a public blockchain",
RedundantSelf::default(),
&[
"system that enables Founders and investors to coordinate and govern themselves through a set of self-executing rules published on a public blockchain",
"system that enables Founders and investors to coordinate and self-govern through a set of self-executing rules published on a public blockchain",
],
&[],
);
}
#[test]
fn fix_self_identify_itself() {
assert_good_and_bad_suggestions(
"We need this in order for a job to be able to self-identify itself and potentially send it's own ID to a different service",
RedundantSelf::default(),
&[
"We need this in order for a job to be able to identify itself and potentially send it's own ID to a different service",
"We need this in order for a job to be able to self-identify and potentially send it's own ID to a different service",
],
&[],
);
}
#[test]
fn fix_self_identified_themselves() {
assert_good_and_bad_suggestions(
"This is how the workers self-identified themselves to the scheduler.",
RedundantSelf::default(),
&[
"This is how the workers identified themselves to the scheduler.",
"This is how the workers self-identified to the scheduler.",
],
&[],
);
}
#[test]
fn dont_flag_self_harm_itself() {
assert_no_lints(
"I understand that self harm itself isn't something that you would have to report.",
RedundantSelf::default(),
);
}
#[test]
fn dont_flag_self_host_without_pronoun() {
assert_no_lints(
"I prefer to self-host my applications",
RedundantSelf::default(),
);
}
#[test]
fn dont_flag_host_without_self() {
assert_no_lints(
"They decided to host it themselves",
RedundantSelf::default(),
);
}
#[test]
fn fix_self_right_itself() {
assert_good_and_bad_suggestions(
"Witch Doctor was able to self-right itself but End Game delivered another massive hit that sent Witch Doctor several feet in the air.",
RedundantSelf::default(),
&[
"Witch Doctor was able to right itself but End Game delivered another massive hit that sent Witch Doctor several feet in the air.",
"Witch Doctor was able to self-right but End Game delivered another massive hit that sent Witch Doctor several feet in the air.",
],
&[],
);
}
#[test]
fn fix_self_rights_itself() {
assert_good_and_bad_suggestions(
"Bite Force self-rights itself.",
RedundantSelf::default(),
&["Bite Force rights itself.", "Bite Force self-rights."],
&[],
);
}
#[test]
fn fix_self_righted_itself() {
assert_good_and_bad_suggestions(
"End Game took Witch Doctor for a ride into the screws but Witch Doctor once again self-righted itself.",
RedundantSelf::default(),
&[
"End Game took Witch Doctor for a ride into the screws but Witch Doctor once again righted itself.",
"End Game took Witch Doctor for a ride into the screws but Witch Doctor once again self-righted.",
],
&[],
);
}
#[test]
fn fix_self_defend_itself() {
assert_suggestion_result(
"I'm on dudes side, the person that self defended himself",
RedundantSelf::default(),
"I'm on dudes side, the person that defended himself",
);
}
}