metric_fu 2.1.3.4 → 2.1.3.5

data/lib/metrics/roodi/{roodi_analyzer.rb → roodi_hotspot.rb}

@@ -1,5 +1,5 @@
-class RoodiAnalyzer
-  include ScoringStrategies
+class RoodiHotspot
+  include MetricFu::HotspotScoringStrategies
 
   COLUMNS = %w{problems}
 
@@ -12,15 +12,15 @@ class RoodiAnalyzer
   end
 
   def map(row)
-    ScoringStrategies.present(row)
+    MetricFu::HotspotScoringStrategies.present(row)
   end
 
   def reduce(scores)
-    ScoringStrategies.sum(scores)
+    MetricFu::HotspotScoringStrategies.sum(scores)
   end
 
   def score(metric_ranking, item)
-    ScoringStrategies.percentile(metric_ranking, item)
+    MetricFu::HotspotScoringStrategies.percentile(metric_ranking, item)
   end
 
   def generate_records(data, table)

data/lib/metrics/saikuro/{saikuro_analyzer.rb → saikuro_hotspot.rb}

@@ -1,5 +1,5 @@
-class SaikuroAnalyzer
-  include ScoringStrategies
+class SaikuroHotspot
+  include MetricFu::HotspotScoringStrategies
 
   COLUMNS = %w{lines complexity}
 
@@ -16,11 +16,11 @@ class SaikuroAnalyzer
   end
 
   def reduce(scores)
-    ScoringStrategies.average(scores)
+    MetricFu::HotspotScoringStrategies.average(scores)
   end
 
   def score(metric_ranking, item)
-    ScoringStrategies.identity(metric_ranking, item)
+    MetricFu::HotspotScoringStrategies.identity(metric_ranking, item)
   end
 
   def generate_records(data, table)

data/lib/metrics/stats/{stats_analyzer.rb → stats_hotspot.rb}

@@ -1,4 +1,4 @@
-class StatsAnalyzer
+class StatsHotspot
 
   COLUMNS = %w{stat_name stat_value}
 

data/lib/scoring_strategies.rb

@@ -1,29 +1,31 @@
-module ScoringStrategies
+module MetricFu
+  module HotspotScoringStrategies
 
-  def percentile(ranking, item)
-    ranking.percentile(item) # per project score percentile
-  end
+    def percentile(ranking, item)
+      ranking.percentile(item) # per project score percentile
+    end
 
-  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 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
-  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
+    end
 
-  def sum(scores)
-    scores.inject(0) {|s,x| s+x}
-  end
+    def sum(scores)
+      scores.inject(0) {|s,x| s+x}
+    end
 
-  def average(scores)
-    # remove dependency on statarray
-    # scores.to_statarray.mean
-    score_length = scores.length
-    sum = 0
-    sum = scores.inject( nil ) { |sum,x| sum ? sum+x : x }
-    (sum.to_f / score_length.to_f)
-  end
+    def average(scores)
+      # remove dependency on statarray
+      # scores.to_statarray.mean
+      score_length = scores.length
+      sum = 0
+      sum = scores.inject( nil ) { |sum,x| sum ? sum+x : x }
+      (sum.to_f / score_length.to_f)
+    end
 
-  extend self
+    extend self
+  end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module MetricFu
-  VERSION = "2.1.3.4"
+  VERSION = "2.1.3.5"
 end

data/metric_fu.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = MetricFu::VERSION
   s.summary     = "A fistful of code metrics, with awesome templates and graphs"
   s.email       = "github@benjaminfleischer.com"
-  s.homepage    = "http://github.com/bf4/metric_fu"
+  s.homepage    = "http://github.com/metricfu/metric_fu"
   s.description = "Code metrics from Flog, Flay, Simplecov-RCov, Saikuro, Churn, Reek, Roodi, Rails' stats task and Rails Best Practices"
   s.authors     = ["Jake Scruggs", "Sean Soper", "Andre Arko", "Petrik de Heus", "Grant McInnes", "Nick Quaranto", "Édouard Brière", "Carl Youngblood", "Richard Huang", "Dan Mayer", "Benjamin Fleischer"]
   s.required_ruby_version     = ">= 1.8.7"

data/spec/base/{metric_analyzer_spec.rb → hotspot_analyzer_spec.rb}

@@ -1,31 +1,31 @@
 require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
 
-describe MetricAnalyzer do
+describe HotspotAnalyzer do
 
   context "with several types of data" do
-    
+
     before do
       @yaml =<<-__
---- 
-:reek: 
-  :matches: 
+---
+:reek:
+  :matches:
   - :file_path: lib/client/client.rb
-    :code_smells: 
+    :code_smells:
     - :type: Large Class
       :message: has at least 27 methods
       :method: Devver::Client
     - :type: Long Method
       :message: has approx 6 statements
       :method: Devver::Client#client_requested_sync
-:flog: 
-  :method_containers: 
+:flog:
+  :method_containers:
   - :highest_score: 61.5870319141946
     :path: /lib/client/client.rb
-    :methods: 
-      Client#client_requested_sync: 
+    :methods:
+      Client#client_requested_sync:
         :path: /lib/client/client.rb
         :score: 37.9270319141946
-        :operators: 
+        :operators:
           :+: 1.70000000000001
           :/: 1.80000000000001
           :method_at_line: 1.90000000000001
@@ -47,8 +47,8 @@ describe MetricAnalyzer do
     :average_score: 11.1209009055421
     :total_score: 1817.6
     :name: Client#client_requested_sync
-:churn: 
-  :changes: 
+:churn:
+  :changes:
   - :file_path: lib/client/client.rb
     :times_changed: 54
   - :file_path: lib/client/foo.rb
@@ -56,8 +56,8 @@ describe MetricAnalyzer do
 __
     end
 
-    it "gives all files, in order, from worst to best" do 
-      analyzer = MetricAnalyzer.new(@yaml)
+    it "gives all files, in order, from worst to best" do
+      analyzer = HotspotAnalyzer.new(@yaml)
       expected = [
                   "lib/client/client.rb",
                   "lib/client/foo.rb"]
@@ -65,7 +65,7 @@ __
     end
 
     it "gives all issues for a class" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       expected = {
         :reek => "found 2 code smells",
         :flog => "complexity is 37.9"
@@ -74,16 +74,16 @@ __
     end
 
     it "gives all issues for a method" do
-      analyzer = MetricAnalyzer.new(@yaml)
-      expected = { 
-        :reek => "found 1 code smells", 
+      analyzer = HotspotAnalyzer.new(@yaml)
+      expected = {
+        :reek => "found 1 code smells",
         :flog => "complexity is 37.9"}
       analyzer.problems_with(:method, "Client#client_requested_sync").should == expected
     end
 
     it "gives all issues for a file" do
-      analyzer = MetricAnalyzer.new(@yaml)
-      expected = { 
+      analyzer = HotspotAnalyzer.new(@yaml)
+      expected = {
         :reek => "found 2 code smells" ,
         :flog => "complexity is 37.9",
         :churn => "detected high level of churn (changed 54 times)"}
@@ -91,7 +91,7 @@ __
     end
 
     it "provide location for a method" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       expected = Location.new("lib/client/client.rb",
                               "Client",
                               "Client#client_requested_sync")
@@ -99,7 +99,7 @@ __
     end
 
     it "provides location for a class" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       expected = Location.new("lib/client/client.rb",
                               "Client",
                               nil)
@@ -107,7 +107,7 @@ __
     end
 
     it "provides location for a file" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       expected = Location.new("lib/client/client.rb",
                               nil,
                               nil)
@@ -120,11 +120,11 @@ __
 
     before do
       @yaml =<<-__
---- 
-:reek: 
-  :matches: 
+---
+:reek:
+  :matches:
   - :file_path: lib/client/client.rb
-    :code_smells: 
+    :code_smells:
     - :type: Large Class
       :message: has at least 27 methods
       :method: Devver::Client
@@ -138,17 +138,17 @@ __
     end
 
     it "gives worst method" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       analyzer.worst_methods(1).should == ["Client#client_requested_sync"]
     end
 
     it "gives worst class" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       analyzer.worst_classes(1).should == ["Client"]
     end
 
     it "gives worst file" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       analyzer.worst_files(1).should == ["lib/client/client.rb"]
     end
 
@@ -156,18 +156,18 @@ __
 
 
   context "with Saikuro data" do
-    
+
     before do
       @yaml =<<-__
-:saikuro: 
-  :files: 
-  - :classes: 
+:saikuro:
+  :files:
+  - :classes:
     - :complexity: 0
       :methods: []
       :lines: 3
       :class_name: Shorty
     - :complexity: 19
-      :methods: 
+      :methods:
       - :complexity: 9
         :lines: 6
         :name: Shorty::Supr#self.handle_full_or_hash_option
@@ -177,9 +177,9 @@ __
       :lines: 92
       :class_name: Shorty::Supr
     :filename: supr.rb
-  - :classes: 
+  - :classes:
     - :complexity: 12
-      :methods: 
+      :methods:
       - :complexity: 8
         :lines: 10
         :name: Shorty::Bitly#info
@@ -188,27 +188,27 @@ __
     :filename: bitly.rb
 __
     end
-    
+
     it "gives worst method" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       analyzer.worst_methods(1).should == ["Supr#self.handle_full_or_hash_option"]
     end
 
     it "gives worst class" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       analyzer.worst_classes(1).should == ["Bitly"]
     end
 
     it "gives complexity for method" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       expected = {
         :saikuro => "complexity is 1.0"
       }
       analyzer.problems_with(:method, "Supr#initialize").should == expected
     end
-    
+
     it "gives average complexity for class" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       expected = {
         :saikuro => "average complexity is 5.0"
       }
@@ -218,19 +218,19 @@ __
   end
 
   context "with Flog data" do
-    
+
     before do
       @yaml =<<-__
---- 
-:flog: 
-  :method_containers: 
+---
+:flog:
+  :method_containers:
   - :highest_score: 85.5481735632041
     :path: ""
-    :methods: 
-      main#none: 
-        :path: 
+    :methods:
+      main#none:
+        :path:
         :score: 85.5481735632041
-        :operators: 
+        :operators:
           :+: 9.10000000000001
           :assignment: 11.6000000000001
           :require: 38.5000000000002
@@ -245,11 +245,11 @@ __
     :name: main
   - :highest_score: 61.5870319141946
     :path: lib/generators/rcov.rb
-    :methods: 
-      Rcov#add_method_data: 
+    :methods:
+      Rcov#add_method_data:
         :path: lib/generators/rcov.rb:57
         :score: 61.5870319141946
-        :operators: 
+        :operators:
           :+: 1.70000000000001
           :/: 1.80000000000001
           :method_at_line: 1.90000000000001
@@ -268,10 +268,10 @@ __
           :each_with_index: 3.00000000000001
           :[]: 22.3000000000001
           :new: 1.60000000000001
-      Rcov#analyze: 
+      Rcov#analyze:
         :path: lib/generators/rcov.rb:34
         :score: 19.1504569136092
-        :operators: 
+        :operators:
           :+: 1.40000000000001
           :metric_directory: 1.6
           :assignment: 9.10000000000004
@@ -288,17 +288,17 @@ __
   :total_score: 195.23642381151
   - :highest_score: 60.0573892206447
     :path: lib/base/metric_analyzer.rb
-    :methods: 
-      MetricAnalyzer#grouping_key: 
+    :methods:
+      HotspotAnalyzer#grouping_key:
         :path: lib/base/metric_analyzer.rb:117
         :score: 2.6
-        :operators: 
+        :operators:
           :inspect: 1.3
           :object_id: 1.3
-      MetricAnalyzer#fix_row_file_path!: 
+      HotspotAnalyzer#fix_row_file_path!:
         :path: lib/base/metric_analyzer.rb:148
         :score: 20.2743680542699
-        :operators: 
+        :operators:
           :assignment: 10.0
           :include?: 3.1
           :branch: 7.20000000000001
@@ -309,32 +309,32 @@ __
           :[]: 5.40000000000001
 __
     end
-    
+
     it "gives worst method" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       analyzer.worst_methods(1).should == ["main#none"]
     end
 
     it "gives worst class" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       analyzer.worst_classes(1).should == ["main"]
     end
 
     it "gives worst file" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       analyzer.worst_files(1).should == ["lib/generators/rcov.rb:57"]
     end
 
   end
 
   context "with Roodi data" do
-    
+
     before do
       @yaml =<<-__
-:roodi: 
-  :total: 
+:roodi:
+  :total:
   - Found 164 errors.
-  :problems: 
+  :problems:
   - :line: "158"
     :file: lib/client/client.rb
     :problem: Method name "process" cyclomatic complexity is 10.  It should be 8 or less.
@@ -348,37 +348,37 @@ __
     end
 
     it "gives worst file" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       analyzer.worst_files(1).should == ["lib/client/client.rb"]
     end
 
   end
 
   context "with Stats data" do
-    
+
     before do
  @yaml =<<-__
-:stats: 
+:stats:
   :codeLOC: 4222
   :testLOC: 2111
   :code_to_test_ratio: 2
 __
 end
-    
+
     it "should have codeLOC" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       row = analyzer.table.rows_with('stat_name' => :codeLOC).first
       row['stat_value'].should == 4222
     end
 
     it "should have testLOC" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       row = analyzer.table.rows_with('stat_name' => :testLOC).first
       row['stat_value'].should == 2111
     end
 
     it "should have code_to_test_ration" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       row = analyzer.table.rows_with('stat_name' => :code_to_test_ratio).first
       row['stat_value'].should == 2
     end
@@ -389,11 +389,11 @@ end
 
         before do
       @yaml =<<-__
-:saikuro: 
-  :files: 
-  - :classes: 
+:saikuro:
+  :files:
+  - :classes:
     - :complexity: 19
-      :methods: 
+      :methods:
       - :complexity: 1
         :lines: 9
         :name: Client#client_requested_sync
@@ -403,24 +403,24 @@ end
       :lines: 92
       :class_name: Devver::Client
     :filename: client.rb
-:reek: 
-  :matches: 
+:reek:
+  :matches:
   - :file_path: lib/client/client.rb
-    :code_smells: 
+    :code_smells:
     - :type: Large Class
       :message: has at least 27 methods
       :method: Devver::Client
     - :type: Long Method
       :message: has approx 6 statements
       :method: Devver::Client#client_requested_sync
-:flog: 
+:flog:
   :total: 1817.6
-  :pages: 
+  :pages:
   - :path: /lib/client/client.rb
     :highest_score: 37.9
     :average_score: 13.6
-    :scanned_methods: 
-    - :operators: 
+    :scanned_methods:
+    - :operators:
       - :operator: "[]"
         :score: 11.1
       :score: 37.9
@@ -429,19 +429,19 @@ __
     end
 
     specify "all records should have full file_path" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       analyzer.table.each do |row|
         row['file_path'].should == 'lib/client/client.rb'
       end
     end
-    
+
     specify "all records should have class name" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       analyzer.table.rows_with(:class_name => nil).should have(0).rows
     end
 
     specify "one record should not have method name" do
-      analyzer = MetricAnalyzer.new(@yaml)
+      analyzer = HotspotAnalyzer.new(@yaml)
       analyzer.table.rows_with(:method_name => nil).should have(1).rows
     end