Reduce duplication in metric hotspots, move toward explicit strategies

bf4 · bf4 · commit f9654924b285 · 2013-08-21T15:46:56.000-05:00
diff --git a/lib/metric_fu/metrics/churn/churn_hotspot.rb b/lib/metric_fu/metrics/churn/churn_hotspot.rb
@@ -10,15 +10,19 @@ def name
     :churn
   end
 
-  def map(row)
-    MetricFu::HotspotScoringStrategies.present(row)
+  def map_strategy
+    :present
   end
 
-  def reduce(scores)
-    MetricFu::HotspotScoringStrategies.sum(scores)
+  def reduce_strategy
+    :sum
   end
 
-  def score(metric_ranking, item)
+  def score_strategy
+    :calculate_score
+  end
+
+  def calculate_score(metric_ranking, item)
     flat_churn_score = 0.50
     metric_ranking.scored?(item) ? flat_churn_score : 0
   end
diff --git a/lib/metric_fu/metrics/flay/flay_hotspot.rb b/lib/metric_fu/metrics/flay/flay_hotspot.rb
@@ -10,16 +10,16 @@ def name
     :flay
   end
 
-  def map(row)
-    MetricFu::HotspotScoringStrategies.present(row)
+  def map_strategy
+    :present
   end
 
-  def reduce(scores)
-    MetricFu::HotspotScoringStrategies.sum(scores)
+  def reduce_strategy
+    :sum
   end
 
-  def score(metric_ranking, item)
-    MetricFu::HotspotScoringStrategies.percentile(metric_ranking, item)
+  def score_strategy
+    :percentile
   end
 
   def generate_records(data, table)
diff --git a/lib/metric_fu/metrics/flog/flog_hotspot.rb b/lib/metric_fu/metrics/flog/flog_hotspot.rb
@@ -10,16 +10,16 @@ def name
     :flog
   end
 
-  def map(row)
-    row.score
+  def map_strategy
+    :score
   end
 
-  def reduce(scores)
-    MetricFu::HotspotScoringStrategies.average(scores)
+  def reduce_strategy
+    :average
   end
 
-  def score(metric_ranking, item)
-    MetricFu::HotspotScoringStrategies.identity(metric_ranking, item)
+  def score_strategy
+    :identity
   end
 
   def generate_records(data, table)
diff --git a/lib/metric_fu/metrics/hotspots/analysis/ranking.rb b/lib/metric_fu/metrics/hotspots/analysis/ranking.rb
@@ -18,7 +18,7 @@ def percentile(item)
     end
 
     def_delegator :@items_to_score, :has_key?, :scored?
-    def_delegators :@items_to_score, :[], :[]=, :length, :each, :delete
+    def_delegators :@items_to_score, :[], :[]=, :length, :each, :delete, :fetch
 
     private
 
diff --git a/lib/metric_fu/metrics/hotspots/analysis/scoring_strategies.rb b/lib/metric_fu/metrics/hotspots/analysis/scoring_strategies.rb
@@ -1,31 +1,26 @@
 module MetricFu
   module HotspotScoringStrategies
 
+    module_function
+
+    # per project score percentile
     def percentile(ranking, item)
-      ranking.percentile(item) # per project score percentile
+      ranking.percentile(item)
     end
 
+    # Use the score you got
+    #   (ex flog score of 20 is not bad even if it is the top one in project)
     def identity(ranking, item)
-      ranking[item] # Use the score you got (ex flog score of 20 is not bad even if it is the top one in project)
-    end
-
-    def present(row)
-      1 # If present it's a one, not present it's a zero - For things like Reek that don't have a number
+      ranking.fetch(item)
     end
 
     def sum(scores)
-      scores.inject(0) {|s,x| s+x}
+      scores.inject(&:+)
     end
 
     def average(scores)
-      # remove dependency on statarray
-      # scores.to_statarray.mean
-      score_length = scores.length
-      total = 0
-      total= scores.inject( nil ) { |sum,x| sum ? sum+x : x }
-      (total.to_f / score_length.to_f)
+      sum(scores).to_f / scores.size.to_f
     end
 
-    extend self
   end
 end
diff --git a/lib/metric_fu/metrics/hotspots/hotspot.rb b/lib/metric_fu/metrics/hotspots/hotspot.rb
@@ -18,13 +18,65 @@ def self.inherited(subclass)
       @analyzers[subclass.metric] = subclass.new
     end
 
-    # TODO simplify calculation
-    # DUPLICATES CODE IN ScoringStrategies
     def get_mean(collection)
-      collection_length = collection.length
-      total = 0
-      total = collection.inject( nil ) { |sum,x| sum ? sum+x : x }
-      (total.to_f / collection_length.to_f)
+      MetricFu::HotspotScoringStrategies.average(collection)
+    end
+
+    def map(row)
+      mapping_strategies.fetch(map_strategy) { row.public_send(map_strategy) }
+    end
+
+    def mapping_strategies
+      {
+        :present => 1,
+        :absent  => 0,
+      }
+    end
+
+    def map_strategy
+      not_implemented
+    end
+
+    def reduce(scores)
+      {
+        :average => MetricFu::HotspotScoringStrategies.average(scores),
+        :sum     => MetricFu::HotspotScoringStrategies.sum(scores),
+        :absent  => 0,
+      }.fetch(reduce_strategy) { raise "#{reduce_strategy} not a know reduce strategy" }
+    end
+
+    def reduce_strategy
+      not_implemented
+    end
+
+    # @return [Integer]
+    def score(metric_ranking, item)
+      {
+        :identity   => MetricFu::HotspotScoringStrategies.identity(metric_ranking, item),
+        :percentile => MetricFu::HotspotScoringStrategies.percentile(metric_ranking, item),
+        :absent     => 0,
+      }.fetch(score_strategy) { method(score_strategy).call(metric_ranking, item) }
+    end
+
+    def score_strategy
+      not_implemented
+    end
+
+    # Transforms the data param, if non-nil, into a hash with keys:
+    #   'metric',  etc.
+    #   and appends the hash to the table param
+    #   Has no return value
+    def generate_records(data, table)
+      not_implemented
+    end
+
+    # @return [String] description result
+    def present_group(group)
+      not_implemented
+    end
+
+    def not_implemented
+      raise "#{caller[0]} not implemented"
     end
   end
 end
diff --git a/lib/metric_fu/metrics/rcov/rcov_hotspot.rb b/lib/metric_fu/metrics/rcov/rcov_hotspot.rb
@@ -11,15 +11,15 @@ def name
   end
 
   def map(row)
-    row.percentage_uncovered
+    :percentage_uncovered
   end
 
-  def reduce(scores)
-    MetricFu::HotspotScoringStrategies.average(scores)
+  def reduce_strategy
+    :average
   end
 
-  def score(metric_ranking, item)
-    MetricFu::HotspotScoringStrategies.identity(metric_ranking, item)
+  def score_strategy
+    :identity
   end
 
   def generate_records(data, table)
diff --git a/lib/metric_fu/metrics/reek/reek_hotspot.rb b/lib/metric_fu/metrics/reek/reek_hotspot.rb
@@ -15,16 +15,16 @@ def name
     :reek
   end
 
-  def map(row)
-    MetricFu::HotspotScoringStrategies.present(row)
+  def map_strategy
+    :present
   end
 
-  def reduce(scores)
-    MetricFu::HotspotScoringStrategies.sum(scores)
+  def reduce_strategy
+    :sum
   end
 
-  def score(metric_ranking, item)
-    MetricFu::HotspotScoringStrategies.percentile(metric_ranking, item)
+  def score_strategy
+    :percentile
   end
 
   def generate_records(data, table)
@@ -60,6 +60,7 @@ def present_group(group)
     occurences = group.size
     "found #{occurences} code smells"
   end
+
   private
 
   def comparable_message(type_name, message)
diff --git a/lib/metric_fu/metrics/roodi/roodi_hotspot.rb b/lib/metric_fu/metrics/roodi/roodi_hotspot.rb
@@ -10,16 +10,16 @@ def name
     :roodi
   end
 
-  def map(row)
-    MetricFu::HotspotScoringStrategies.present(row)
+  def map_strategy
+    :present
   end
 
-  def reduce(scores)
-    MetricFu::HotspotScoringStrategies.sum(scores)
+  def reduce_strategy
+    :sum
   end
 
-  def score(metric_ranking, item)
-    MetricFu::HotspotScoringStrategies.percentile(metric_ranking, item)
+  def score_strategy
+    :percentile
   end
 
   def generate_records(data, table)
diff --git a/lib/metric_fu/metrics/saikuro/saikuro_hotspot.rb b/lib/metric_fu/metrics/saikuro/saikuro_hotspot.rb
@@ -10,16 +10,16 @@ def name
     :saikuro
   end
 
-  def map(row)
-    row.complexity
+  def map_strategy
+    :complexity
   end
 
-  def reduce(scores)
-    MetricFu::HotspotScoringStrategies.average(scores)
+  def reduce_strategy
+    :average
   end
 
-  def score(metric_ranking, item)
-    MetricFu::HotspotScoringStrategies.identity(metric_ranking, item)
+  def score_strategy
+    :identity
   end
 
   def generate_records(data, table)
diff --git a/lib/metric_fu/metrics/stats/stats_hotspot.rb b/lib/metric_fu/metrics/stats/stats_hotspot.rb
@@ -10,16 +10,16 @@ def name
     :stats
   end
 
-  def map(row)
-    0
+  def map_strategy
+    :absent
   end
 
-  def reduce(scores)
-    0
+  def reduce_strategy
+    :absent
   end
 
-  def score(metric_ranking, item)
-    0
+  def score_strategy
+    :absent
   end
 
   def generate_records(data, table)
