Rename ConstantsInsteadOfLiterals detector to better suit `//aderyn…

…-ignore-(..)` (#737)

aderyn_core/src/detect/detector.rs

@@ -26,7 +26,7 @@ pub fn get_all_issue_detectors() -> Vec<Box<dyn IssueDetector>> {
         Box::<UnspecificSolidityPragmaDetector>::default(),
         Box::<ZeroAddressCheckDetector>::default(),
         Box::<UselessPublicFunctionDetector>::default(),
-        Box::<ConstantsInsteadOfLiteralsDetector>::default(),
+        Box::<LiteralsInsteadOfConstantsDetector>::default(),
         Box::<UnindexedEventsDetector>::default(),
         Box::<RequireWithStringDetector>::default(),
         Box::<NonReentrantBeforeOthersDetector>::default(),
@@ -139,8 +139,8 @@ pub(crate) enum IssueDetectorNamePool {
     UnspecificSolidityPragma,
     ZeroAddressCheck,
     UselessPublicFunction,
-    ConstantsInsteadOfLiterals,
     UnindexedEvents,
+    LiteralInsteadOfConstant,
     RequireWithString,
     NonReentrantBeforeOthers,
     BlockTimestampDeadline,
@@ -226,6 +226,9 @@ pub fn request_issue_detector_by_name(detector_name: &str) -> Option<Box<dyn Iss
         IssueDetectorNamePool::StateVariableCouldBeDeclaredConstant => {
             Some(Box::<StateVariableCouldBeConstantDetector>::default())
         }
+        IssueDetectorNamePool::LiteralInsteadOfConstant => {
+            Some(Box::<LiteralsInsteadOfConstantsDetector>::default())
+        }
         IssueDetectorNamePool::FunctionPointerInConstructor => {
             Some(Box::<FucntionPointerInConstructorDetector>::default())
         }
@@ -291,9 +294,6 @@ pub fn request_issue_detector_by_name(detector_name: &str) -> Option<Box<dyn Iss
         IssueDetectorNamePool::UselessPublicFunction => {
             Some(Box::<UselessPublicFunctionDetector>::default())
         }
-        IssueDetectorNamePool::ConstantsInsteadOfLiterals => {
-            Some(Box::<ConstantsInsteadOfLiteralsDetector>::default())
-        }
         IssueDetectorNamePool::UnindexedEvents => Some(Box::<UnindexedEventsDetector>::default()),
         IssueDetectorNamePool::RequireWithString => {
             Some(Box::<RequireWithStringDetector>::default())

aderyn_core/src/detect/low/constants_instead_of_literals.rs → aderyn_core/src/detect/low/literals_instead_of_constants.rs

@@ -18,13 +18,13 @@ use crate::{
 use eyre::Result;
 
 #[derive(Default)]
-pub struct ConstantsInsteadOfLiteralsDetector {
+pub struct LiteralsInsteadOfConstantsDetector {
     // Keys are: [0] source file name, [1] line number, [2] character location of node.
     // Do not add items manually, use `capture!` to add nodes to this BTreeMap.
     found_instances: BTreeMap<(String, usize, String), NodeID>,
 }
 
-impl IssueDetector for ConstantsInsteadOfLiteralsDetector {
+impl IssueDetector for LiteralsInsteadOfConstantsDetector {
     fn detect(&mut self, context: &WorkspaceContext) -> Result<bool, Box<dyn Error>> {
         // Get all contracts
         // For each contract
@@ -128,26 +128,25 @@ impl IssueDetector for ConstantsInsteadOfLiteralsDetector {
     }
 
     fn name(&self) -> String {
-        format!("{}", IssueDetectorNamePool::ConstantsInsteadOfLiterals)
+        format!("{}", IssueDetectorNamePool::LiteralInsteadOfConstant)
     }
 }
 
 #[cfg(test)]
 mod constants_instead_of_literals_tests {
     use serial_test::serial;
 
+    use super::LiteralsInsteadOfConstantsDetector;
     use crate::detect::detector::IssueDetector;
 
-    use super::ConstantsInsteadOfLiteralsDetector;
-
     #[test]
     #[serial]
     fn test_constants_instead_of_literals_by_loading_contract_directly() {
         let context = crate::detect::test_utils::load_solidity_source_unit(
             "../tests/contract-playground/src/ConstantsLiterals.sol",
         );
 
-        let mut detector = ConstantsInsteadOfLiteralsDetector::default();
+        let mut detector = LiteralsInsteadOfConstantsDetector::default();
         // assert that the detector finds the public Function
         let found = detector.detect(&context).unwrap();
         assert!(found);

aderyn_core/src/detect/low/mod.rs

@@ -4,7 +4,6 @@ pub(crate) mod builtin_symbol_shadowing;
 pub(crate) mod cache_array_length;
 pub(crate) mod centralization_risk;
 pub(crate) mod constant_funcs_assembly;
-pub(crate) mod constants_instead_of_literals;
 pub(crate) mod contracts_with_todos;
 pub(crate) mod costly_operations_inside_loops;
 pub(crate) mod dead_code;
@@ -16,6 +15,7 @@ pub(crate) mod function_init_state_vars;
 pub(crate) mod function_pointer_in_constructor;
 pub(crate) mod inconsistent_type_names;
 pub(crate) mod large_literal_value;
+pub(crate) mod literals_instead_of_constants;
 pub(crate) mod local_variable_shadowing;
 pub(crate) mod missing_inheritance;
 pub(crate) mod multiple_placeholders;
@@ -49,7 +49,6 @@ pub use builtin_symbol_shadowing::BuiltinSymbolShadowDetector;
 pub use cache_array_length::CacheArrayLengthDetector;
 pub use centralization_risk::CentralizationRiskDetector;
 pub use constant_funcs_assembly::ConstantFunctionContainsAssemblyDetector;
-pub use constants_instead_of_literals::ConstantsInsteadOfLiteralsDetector;
 pub use contracts_with_todos::ContractsWithTodosDetector;
 pub use costly_operations_inside_loops::CostlyOperationsInsideLoopsDetector;
 pub use dead_code::DeadCodeDetector;
@@ -61,6 +60,7 @@ pub use function_init_state_vars::FunctionInitializingStateDetector;
 pub use function_pointer_in_constructor::FucntionPointerInConstructorDetector;
 pub use inconsistent_type_names::InconsistentTypeNamesDetector;
 pub use large_literal_value::LargeLiteralValueDetector;
+pub use literals_instead_of_constants::LiteralsInsteadOfConstantsDetector;
 pub use local_variable_shadowing::LocalVariableShadowingDetector;
 pub use missing_inheritance::MissingInheritanceDetector;
 pub use multiple_placeholders::MultiplePlaceholdersDetector;