darklua_core/rules/
remove_assertions.rs

1use crate::nodes::{Block, Prefix};
2use crate::process::{IdentifierTracker, NodeVisitor, ScopeVisitor};
3use crate::rules::{
4    Context, FlawlessRule, RuleConfiguration, RuleConfigurationError, RuleProperties,
5};
6
7use super::remove_call_match::RemoveFunctionCallProcessor;
8
9const ASSERT_FUNCTION_NAME: &str = "assert";
10
11pub const REMOVE_ASSERTIONS_RULE_NAME: &str = "remove_assertions";
12
13/// A rule that removes `assert` calls.
14#[derive(Debug, PartialEq, Eq)]
15pub struct RemoveAssertions {
16    preserve_args_side_effects: bool,
17}
18
19impl Default for RemoveAssertions {
20    fn default() -> Self {
21        Self {
22            preserve_args_side_effects: true,
23        }
24    }
25}
26
27fn should_remove_call(identifiers: &IdentifierTracker, prefix: &Prefix) -> bool {
28    if identifiers.is_identifier_used(ASSERT_FUNCTION_NAME) {
29        return false;
30    }
31
32    match prefix {
33        Prefix::Identifier(identifier) => identifier.get_name() == ASSERT_FUNCTION_NAME,
34        _ => false,
35    }
36}
37
38impl FlawlessRule for RemoveAssertions {
39    fn flawless_process(&self, block: &mut Block, _: &Context) {
40        let mut processor =
41            RemoveFunctionCallProcessor::new(self.preserve_args_side_effects, should_remove_call);
42        ScopeVisitor::visit_block(block, &mut processor);
43    }
44}
45
46impl RuleConfiguration for RemoveAssertions {
47    fn configure(&mut self, properties: RuleProperties) -> Result<(), RuleConfigurationError> {
48        for (key, value) in properties {
49            match key.as_str() {
50                "preserve_arguments_side_effects" => {
51                    self.preserve_args_side_effects = value.expect_bool(&key)?;
52                }
53                _ => return Err(RuleConfigurationError::UnexpectedProperty(key)),
54            }
55        }
56
57        Ok(())
58    }
59
60    fn get_name(&self) -> &'static str {
61        REMOVE_ASSERTIONS_RULE_NAME
62    }
63
64    fn serialize_to_properties(&self) -> RuleProperties {
65        let mut properties = RuleProperties::new();
66
67        if !self.preserve_args_side_effects {
68            properties.insert("preserve_arguments_side_effects".to_owned(), false.into());
69        }
70
71        properties
72    }
73}
74
75#[cfg(test)]
76mod test {
77    use super::*;
78    use crate::rules::Rule;
79
80    use insta::assert_json_snapshot;
81
82    fn new_rule() -> RemoveAssertions {
83        RemoveAssertions::default()
84    }
85
86    #[test]
87    fn serialize_default_rule() {
88        let rule: Box<dyn Rule> = Box::new(new_rule());
89
90        assert_json_snapshot!("default_remove_assertions", rule);
91    }
92
93    #[test]
94    fn serialize_rule_without_side_effects() {
95        let rule: Box<dyn Rule> = Box::new(RemoveAssertions {
96            preserve_args_side_effects: false,
97        });
98
99        assert_json_snapshot!("remove_assertions_without_side_effects", rule);
100    }
101
102    #[test]
103    fn configure_with_extra_field_error() {
104        let result = json5::from_str::<Box<dyn Rule>>(
105            r#"{
106            rule: 'remove_assertions',
107            prop: "something",
108        }"#,
109        );
110        pretty_assertions::assert_eq!(result.unwrap_err().to_string(), "unexpected field 'prop'");
111    }
112}
darklua_core/rules/remove_assertions.rs

darklua_core/rules/
remove_assertions.rs
