grenade/cull-gmail
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor(rules): apply idiomatic patterns and resolve clippy warnings

Browse Source 
- Change add_rule parameter from Option<&String> to Option<&str> for better ergonomics
- Use iterator methods (flat_map, any) instead of manual loops and collections
- Collapse nested if conditions using let-else patterns
- Use format string interpolation instead of separate arguments
- Avoid unnecessary String allocations in label comparisons
- Update CLI code to use as_deref() for Option<String> to Option<&str> conversion
- Update all documentation examples and tests to match new API
- All functionality preserved; API is more idiomatic and efficient
This commit is contained in:
Jeremiah Russell
2025-10-19 08:29:35 +01:00
committed by Jeremiah Russell
parent a43eb9e4a2
commit 8f908df8f3
2 changed files with 28 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/cli/rules_cli/config_cli/rules_cli/add_cli.rs
View File

@@ -44,7 +44,7 @@ impl AddCli {
let message_age = MessageAge::new(self.period.to_string().as_str(), self.count)?; let message_age = MessageAge::new(self.period.to_string().as_str(), self.count)?;
let retention = Retention::new(message_age, generate); let retention = Retention::new(message_age, generate);
config.add_rule(retention, self.label.as_ref(), self.delete); config.add_rule(retention, self.label.as_deref(), self.delete);
config.save() config.save()
} }
} }

59
src/rules.rs
View File

@@ -23,11 +23,11 @@
//! //!
//! // Add a rule to delete old newsletters after 6 months //! // Add a rule to delete old newsletters after 6 months
//! let newsletter_retention = Retention::new(MessageAge::Months(6), true); //! let newsletter_retention = Retention::new(MessageAge::Months(6), true);
//! rules.add_rule(newsletter_retention, Some(&"newsletter".to_string()), true); //! rules.add_rule(newsletter_retention, Some("newsletter"), true);
//! //!
//! // Add a rule to trash spam after 30 days //! // Add a rule to trash spam after 30 days
//! let spam_retention = Retention::new(MessageAge::Days(30), false); //! let spam_retention = Retention::new(MessageAge::Days(30), false);
//! rules.add_rule(spam_retention, Some(&"spam".to_string()), false); //! rules.add_rule(spam_retention, Some("spam"), false);
//! //!
//! // Save the rules to disk //! // Save the rules to disk
//! rules.save().expect("Failed to save rules"); //! rules.save().expect("Failed to save rules");
@@ -184,30 +184,27 @@ impl Rules {
/// ///
/// // Add a rule to trash newsletters after 3 months /// // Add a rule to trash newsletters after 3 months
/// let retention = Retention::new(MessageAge::Months(3), false); /// let retention = Retention::new(MessageAge::Months(3), false);
/// rules.add_rule(retention, Some(&"newsletter".to_string()), false); /// rules.add_rule(retention, Some("newsletter"), false);
/// ///
/// // Add a rule to delete spam after 7 days /// // Add a rule to delete spam after 7 days
/// let spam_retention = Retention::new(MessageAge::Days(7), false); /// let spam_retention = Retention::new(MessageAge::Days(7), false);
/// rules.add_rule(spam_retention, Some(&"spam".to_string()), true); /// rules.add_rule(spam_retention, Some("spam"), true);
/// ``` /// ```
pub fn add_rule( pub fn add_rule(
&mut self, &mut self,
retention: Retention, retention: Retention,
label: Option<&String>, label: Option<&str>,
delete: bool, delete: bool,
) -> &mut Self { ) -> &mut Self {
let mut current_labels = Vec::new(); let current_labels: Vec<String> = self.rules.values()
for rule in self.rules.values() { .flat_map(|rule| rule.labels())
let mut ls = rule.labels().clone(); .collect();
current_labels.append(&mut ls);
}
if let Some(label_ref) = label { if let Some(label_ref) = label
if current_labels.contains(label_ref) { && current_labels.iter().any(|l| l == label_ref) {
log::warn!("a rule already applies to label {}", label_ref); log::warn!("a rule already applies to label {label_ref}");
return self; return self;
} }
}
let id = if let Some((_, max)) = self.rules.iter().max_by_key(|(_, r)| r.id()) { let id = if let Some((_, max)) = self.rules.iter().max_by_key(|(_, r)| r.id()) {
max.id() + 1 max.id() + 1
@@ -240,18 +237,16 @@ impl Rules {
/// ///
/// let mut rules = Rules::new(); /// let mut rules = Rules::new();
/// let retention = Retention::new(MessageAge::Days(30), false); /// let retention = Retention::new(MessageAge::Days(30), false);
/// rules.add_rule(retention, Some(&"test-label".to_string()), false); /// rules.add_rule(retention, Some("test-label"), false);
/// ///
/// let labels = rules.labels(); /// let labels = rules.labels();
/// assert!(labels.len() > 0); /// assert!(labels.len() > 0);
/// println!("Configured labels: {:?}", labels); /// println!("Configured labels: {:?}", labels);
/// ``` /// ```
pub fn labels(&self) -> Vec<String> { pub fn labels(&self) -> Vec<String> {
let mut labels = Vec::new(); self.rules.values()
for rule in self.rules.values() { .flat_map(|rule| rule.labels())
labels.append(&mut rule.labels().clone()); .collect()
}
labels
} }
/// Find the id of the rule that contains a label /// Find the id of the rule that contains a label
@@ -309,7 +304,7 @@ impl Rules {
/// ///
/// let mut rules = Rules::new(); /// let mut rules = Rules::new();
/// let retention = Retention::new(MessageAge::Days(30), false); /// let retention = Retention::new(MessageAge::Days(30), false);
/// rules.add_rule(retention, Some(&"newsletter".to_string()), false); /// rules.add_rule(retention, Some("newsletter"), false);
/// ///
/// // Remove the rule targeting the newsletter label /// // Remove the rule targeting the newsletter label
/// rules.remove_rule_by_label("newsletter") /// rules.remove_rule_by_label("newsletter")
@@ -324,7 +319,7 @@ impl Rules {
pub fn remove_rule_by_label(&mut self, label: &str) -> crate::Result<()> { pub fn remove_rule_by_label(&mut self, label: &str) -> crate::Result<()> {
let labels = self.labels(); let labels = self.labels();
if !labels.contains(&label.to_string()) { if !labels.iter().any(|l| l == label) {
return Err(Error::LabelNotFoundInRules(label.to_string())); return Err(Error::LabelNotFoundInRules(label.to_string()));
} }
@@ -352,7 +347,7 @@ impl Rules {
/// ///
/// let mut rules = Rules::new(); /// let mut rules = Rules::new();
/// let retention = Retention::new(MessageAge::Days(30), false); /// let retention = Retention::new(MessageAge::Days(30), false);
/// rules.add_rule(retention, Some(&"test".to_string()), false); /// rules.add_rule(retention, Some("test"), false);
/// ///
/// let label_map = rules.get_rules_by_label(); /// let label_map = rules.get_rules_by_label();
/// if let Some(rule) = label_map.get("test") { /// if let Some(rule) = label_map.get("test") {
@@ -488,7 +483,7 @@ impl Rules {
/// ///
/// let mut rules = Rules::new(); /// let mut rules = Rules::new();
/// let retention = Retention::new(MessageAge::Days(30), false); /// let retention = Retention::new(MessageAge::Days(30), false);
/// rules.add_rule(retention, Some(&"test".to_string()), false); /// rules.add_rule(retention, Some("test"), false);
/// ///
/// rules.save().expect("Failed to save configuration"); /// rules.save().expect("Failed to save configuration");
/// ``` /// ```
@@ -642,7 +637,7 @@ mod tests {
let initial_label_count = rules.labels().len(); let initial_label_count = rules.labels().len();
let retention = Retention::new(MessageAge::Days(30), false); let retention = Retention::new(MessageAge::Days(30), false);
rules.add_rule(retention, Some(&"test-label".to_string()), false); rules.add_rule(retention, Some("test-label"), false);
let labels = rules.labels(); let labels = rules.labels();
assert!(labels.contains(&"test-label".to_string())); assert!(labels.contains(&"test-label".to_string()));
@@ -670,7 +665,7 @@ mod tests {
let mut rules = Rules::new(); let mut rules = Rules::new();
let retention = Retention::new(MessageAge::Days(7), false); let retention = Retention::new(MessageAge::Days(7), false);
rules.add_rule(retention, Some(&"delete-test".to_string()), true); rules.add_rule(retention, Some("delete-test"), true);
let rules_by_label = rules.get_rules_by_label(); let rules_by_label = rules.get_rules_by_label();
let rule = rules_by_label.get("delete-test").unwrap(); let rule = rules_by_label.get("delete-test").unwrap();
@@ -685,11 +680,11 @@ mod tests {
let retention1 = Retention::new(MessageAge::Days(30), false); let retention1 = Retention::new(MessageAge::Days(30), false);
let retention2 = Retention::new(MessageAge::Days(60), false); let retention2 = Retention::new(MessageAge::Days(60), false);
rules.add_rule(retention1, Some(&"duplicate".to_string()), false); rules.add_rule(retention1, Some("duplicate"), false);
let initial_count = rules.labels().len(); let initial_count = rules.labels().len();
// Try to add another rule with the same label // Try to add another rule with the same label
rules.add_rule(retention2, Some(&"duplicate".to_string()), false); rules.add_rule(retention2, Some("duplicate"), false);
// Should not increase the count of labels // Should not increase the count of labels
assert_eq!(rules.labels().len(), initial_count); assert_eq!(rules.labels().len(), initial_count);
@@ -724,7 +719,7 @@ mod tests {
let mut rules = Rules::new(); let mut rules = Rules::new();
let retention = Retention::new(MessageAge::Days(30), false); let retention = Retention::new(MessageAge::Days(30), false);
rules.add_rule(retention, Some(&"custom-label".to_string()), false); rules.add_rule(retention, Some("custom-label"), false);
let labels = rules.labels(); let labels = rules.labels();
assert!(labels.contains(&"custom-label".to_string())); assert!(labels.contains(&"custom-label".to_string()));
@@ -736,7 +731,7 @@ mod tests {
let mut rules = Rules::new(); let mut rules = Rules::new();
let retention = Retention::new(MessageAge::Days(30), false); let retention = Retention::new(MessageAge::Days(30), false);
rules.add_rule(retention, Some(&"mapped-label".to_string()), false); rules.add_rule(retention, Some("mapped-label"), false);
let label_map = rules.get_rules_by_label(); let label_map = rules.get_rules_by_label();
let rule = label_map.get("mapped-label"); let rule = label_map.get("mapped-label");
@@ -775,7 +770,7 @@ mod tests {
let mut rules = Rules::new(); let mut rules = Rules::new();
let retention = Retention::new(MessageAge::Days(30), false); let retention = Retention::new(MessageAge::Days(30), false);
rules.add_rule(retention, Some(&"remove-me".to_string()), false); rules.add_rule(retention, Some("remove-me"), false);
let result = rules.remove_rule_by_label("remove-me"); let result = rules.remove_rule_by_label("remove-me");
assert!(result.is_ok()); assert!(result.is_ok());
@@ -919,7 +914,7 @@ mod tests {
let mut rules = Rules::new(); let mut rules = Rules::new();
let retention = Retention::new(MessageAge::Days(30), false); let retention = Retention::new(MessageAge::Days(30), false);
rules.add_rule(retention, Some(&"save-test".to_string()), false); rules.add_rule(retention, Some("save-test"), false);
// Save to disk // Save to disk
let save_result = rules.save(); let save_result = rules.save();