Refactored some lines and added some comments to explain the use of self_cyclomatic

Author: giovannitangredi

src/metrics/cyclomatic.rs

@@ -7,6 +7,9 @@ use std::fmt;
 /// The `Cyclomatic` metric.
 #[derive(Debug, Clone)]
 pub struct Stats {
+    /// The self_cyclomatic value is used for mantaining information about
+    /// a space cyclomatic complexity even after the merge is happened.
+    /// It has been added to handle thee case in the c_unit_after test, look at line 374 for more info.
     self_cyclomatic: f64,
     cyclomatic: f64,
     n: usize,
@@ -56,19 +59,12 @@ impl fmt::Display for Stats {
 impl Stats {
     /// Merges a second `Cyclomatic` metric into the first one
     pub fn merge(&mut self, other: &Stats) {
+        //Calculate minimum and maximum values
+        self.cyclomatic_max = self.cyclomatic_max.max(other.cyclomatic_max);
+        self.cyclomatic_min = self.cyclomatic_min.min(other.cyclomatic_min);
+
         self.cyclomatic += other.cyclomatic;
         self.n += other.n;
-
-        //Calculate minimum and maximum values
-        if other.n == 1 {
-            self.cyclomatic_max = self.cyclomatic_max.max(other.cyclomatic);
-            self.cyclomatic_min = self.cyclomatic_min.min(other.cyclomatic);
-        } else {
-            self.cyclomatic_max = self.cyclomatic_max.max(other.cyclomatic_max);
-            self.cyclomatic_min = self.cyclomatic_min.min(other.cyclomatic_min);
-            self.cyclomatic_max = self.cyclomatic_max.max(other.self_cyclomatic);
-            self.cyclomatic_min = self.cyclomatic_min.min(other.self_cyclomatic);
-        }
     }
 
     /// Returns the `Cyclomatic` metric value
@@ -375,7 +371,9 @@ mod tests {
             ]
         );
     }
-
+    /// Test to handle the case of min and max when merge happen before the final value of one module are setted.
+    /// In this case the min value should be 3 because the unit space has 2 branches and a complexity of 3
+    /// while the function sumOfPrimes has a complexity of 4.
     #[test]
     fn c_unit_after() {
         check_metrics!(