metric_fu 2.0.0 → 2.0.1

data/lib/base/ranking.rb

@@ -1,33 +1,34 @@
 require 'forwardable'
+module MetricFu
+  class Ranking
+    extend Forwardable
 
-class Ranking
-  extend Forwardable
+    def initialize
+      @items_to_score = {}
+    end
 
-  def initialize
-    @items_to_score = {}
-  end
+    def top(num=nil)
+      if(num.is_a?(Numeric))
+        sorted_items[0,num]
+      else
+        sorted_items
+      end
+    end
 
-  def top(num=nil)
-    if(num.is_a?(Numeric))
-      sorted_items[0,num]
-    else
-      sorted_items
+    def percentile(item)
+      index = sorted_items.index(item)
+      worse_item_count = (length - (index+1))
+      worse_item_count.to_f/length
     end
-  end
 
-  def percentile(item)
-    index = sorted_items.index(item)
-    worse_item_count = (length - (index+1))
-    worse_item_count.to_f/length
-  end
+    def_delegator :@items_to_score, :has_key?, :scored?
+    def_delegators :@items_to_score, :[], :[]=, :length, :each, :delete
 
-  def_delegator :@items_to_score, :has_key?, :scored?
-  def_delegators :@items_to_score, :[], :[]=, :length, :each, :delete
+    private
 
-  private
+    def sorted_items
+      @sorted_items ||= @items_to_score.sort_by {|item, score| -score}.map {|item, score| item}
+    end
 
-  def sorted_items
-    @sorted_items ||= @items_to_score.sort_by {|item, score| -score}.map {|item, score| item}
   end
-
 end

data/lib/base/rcov_analyzer.rb

@@ -6,7 +6,7 @@ class RcovAnalyzer
   def columns
     COLUMNS
   end
-  
+
   def name
     :rcov
   end
@@ -22,13 +22,13 @@ class RcovAnalyzer
   def score(metric_ranking, item)
     ScoringStrategies.identity(metric_ranking, item)
   end
-  
+
   def generate_records(data, table)
    return if data==nil
    data.each do |file_name, info|
      next if (file_name == :global_percent_run) || (info[:methods].nil?)
      info[:methods].each do |method_name, percentage_uncovered|
-       location = Location.for(method_name)
+       location = MetricFu::Location.for(method_name)
        table << {
          "metric" => :rcov,
          'file_path' => file_name,

data/lib/base/reek_analyzer.rb

@@ -1,7 +1,9 @@
+# coding: utf-8
+
 class ReekAnalyzer
   include ScoringStrategies
 
-  REEK_ISSUE_INFO = {'Uncommunicative Name' => 
+  REEK_ISSUE_INFO = {'Uncommunicative Name' =>
     {'link' => 'http://wiki.github.com/kevinrutherford/reek/uncommunicative-name', 'info' => 'An Uncommunicative Name is a name that doesn’t communicate its intent well enough.'},
     'Class Variable' =>
     {'link' => 'http://wiki.github.com/kevinrutherford/reek/class-variable', 'info' => 'Class variables form part of the global runtime state, and as such make it easy for one part of the system to accidentally or inadvertently depend on another part of the system.'},
@@ -32,7 +34,7 @@ class ReekAnalyzer
   def columns
     COLUMNS.map{|column| "#{name}__#{column}"}
   end
-  
+
   def name
     :reek
   end
@@ -46,20 +48,20 @@ class ReekAnalyzer
   end
 
   def score(metric_ranking, item)
-    ScoringStrategies.percentile(metric_ranking, item)
+    ScoringStrategies.percentile(metric_ranking, item) 
   end
-  
+
   def generate_records(data, table)
     return if data==nil
     data[:matches].each do |match|
       file_path = match[:file_path]
       match[:code_smells].each do |smell|
-        location = Location.for(smell[:method])
+        location = MetricFu::Location.for(smell[:method])
         smell_type = smell[:type]
         message = smell[:message]
         table << {
-          "metric" => name,
-          "file_path" => file_path,
+          "metric" => name, # important
+          "file_path" => file_path, # important
           # NOTE: ReekAnalyzer is currently different than other analyzers with regard
           # to column name. Note the COLUMNS constant and #columns method
           "reek__message" => message,
@@ -67,8 +69,8 @@ class ReekAnalyzer
           "reek__value" => parse_value(message),
           "reek__value_description" => build_value_description(smell_type, message),
           "reek__comparable_message" => comparable_message(smell_type, message),
-          "class_name" => location.class_name,
-          "method_name" => location.method_name,
+          "class_name" => location.class_name, # important
+          "method_name" => location.method_name, # important
         }
       end
     end
@@ -101,7 +103,7 @@ class ReekAnalyzer
       nil
     end
   end
-  
+
   def parse_value(message)
     match = message.match(/\d+/)
     if(match)

data/lib/base/report.rb

@@ -10,25 +10,25 @@ module MetricFu
   #
   # The Report class is responsible two things:
   #
-  # It adds information to the yaml report, produced by the system 
+  # It adds information to the yaml report, produced by the system
   # as a whole, for each of the generators used in this test run.
   #
   # It also handles passing the information from each generator used
-  # in this test run out to the template class set in 
+  # in this test run out to the template class set in
   # MetricFu::Configuration.
   class Report
-    
+
     # Renders the result of the report_hash into a yaml serialization
     # ready for writing out to a file.
     #
     # @return YAML
-    #   A YAML object containing the results of the report generation 
+    #   A YAML object containing the results of the report generation
     #   process
     def to_yaml
       report_hash.to_yaml
     end
 
-    
+
     def report_hash #:nodoc:
       @report_hash ||= {}
     end
@@ -43,7 +43,7 @@ module MetricFu
       @template.report = report_hash
       @template.write
     end
-   
+
     # Adds a hash from a passed report, produced by one of the Generator
     # classes to the aggregate report_hash managed by this hash.
     #
@@ -55,7 +55,7 @@ module MetricFu
     end
 
     # Saves the passed in content to the passed in directory.  If
-    # a filename is passed in it will be used as the name of the 
+    # a filename is passed in it will be used as the name of the
     # file, otherwise it will default to 'index.html'
     #
     # @param content String
@@ -76,7 +76,7 @@ module MetricFu
 
     # Checks to discover whether we should try and open the results
     # of the report in the browser on this system.  We only try and open
-    # in the browser if we're on OS X and we're not running in a 
+    # in the browser if we're on OS X and we're not running in a
     # CruiseControl.rb environment.  See MetricFu.configuration for more
     # details about how we make those guesses.
     #
@@ -91,7 +91,7 @@ module MetricFu
     # if we're able to open the browser on this platform.
     #
     # @param dir String
-    #   The directory path where the 'index.html' we want to open is  
+    #   The directory path where the 'index.html' we want to open is
     #   stored
     def show_in_browser(dir)
       system("open #{dir}/index.html") if open_in_browser?

data/lib/base/roodi_analyzer.rb

@@ -6,7 +6,7 @@ class RoodiAnalyzer
   def columns
     COLUMNS
   end
-  
+
   def name
     :roodi
   end
@@ -22,7 +22,7 @@ class RoodiAnalyzer
   def score(metric_ranking, item)
     ScoringStrategies.percentile(metric_ranking, item)
   end
-  
+
   def generate_records(data, table)
     return if data==nil
     Array(data[:problems]).each do |problem|

data/lib/base/saikuro_analyzer.rb

@@ -6,7 +6,7 @@ class SaikuroAnalyzer
   def columns
     COLUMNS
   end
-  
+
   def name
     :saikuro
   end
@@ -22,16 +22,16 @@ class SaikuroAnalyzer
   def score(metric_ranking, item)
     ScoringStrategies.identity(metric_ranking, item)
   end
-  
+
   def generate_records(data, table)
     return if data == nil
     data[:files].each do |file|
       file_name = file[:filename]
       file[:classes].each do |klass|
-        location = Location.for(klass[:class_name])
+        location = MetricFu::Location.for(klass[:class_name])
         offending_class = location.class_name
         klass[:methods].each do |match|
-          offending_method = Location.for(match[:name]).method_name
+          offending_method = MetricFu::Location.for(match[:name]).method_name
           table << {
             "metric" => name,
             "lines" => match[:lines],

data/lib/base/scoring_strategies.rb

@@ -1,15 +1,15 @@
 module ScoringStrategies
 
   def percentile(ranking, item)
-    ranking.percentile(item)
+    ranking.percentile(item) # per project score percentile
   end
-  
+
   def identity(ranking, item)
-    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
+    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)
@@ -24,6 +24,6 @@ module ScoringStrategies
     sum = scores.inject( nil ) { |sum,x| sum ? sum+x : x }
     (sum.to_f / score_length.to_f)
   end
-  
+
   extend self
 end

data/lib/base/stats_analyzer.rb

@@ -5,7 +5,7 @@ class StatsAnalyzer
   def columns
     COLUMNS
   end
-  
+
   def name
     :stats
   end
@@ -13,7 +13,7 @@ class StatsAnalyzer
   def map(row)
     0
   end
-  
+
   def reduce(scores)
     0
   end

data/lib/base/table.rb

@@ -1,9 +1,9 @@
 class Table
-  
+
   def initialize(opts = {})
     @rows = []
     @columns = opts.fetch(:column_names)
-    
+
     @make_index = opts.fetch(:make_index) {true}
     @metric_index = {}
   end
@@ -44,7 +44,7 @@ class Table
     end
     arr
   end
-  
+
   def group_by_metric
     @metric_index.to_a
   end
@@ -64,7 +64,7 @@ class Table
   def to_a
     @rows
   end
-  
+
   def map
     new_table = Table.new(:column_names => @columns)
     @rows.map do |row|

data/lib/generators/churn.rb

@@ -5,7 +5,7 @@ module MetricFu
     def initialize(options={})
       super
     end
-    
+
     def emit
       @output = `churn --yaml`
       yaml_start = @output.index("---")

data/lib/generators/flay.rb

@@ -1,7 +1,7 @@
 require 'flay'
 
 module MetricFu
-  
+
   class Flay < Generator
 
     def emit

data/lib/generators/hotspots.rb

@@ -18,23 +18,23 @@ module MetricFu
       num = nil
       worst_items = {}
       if @analyzer
-        worst_items[:files] = 
+        worst_items[:files] =
           @analyzer.worst_files(num).inject([]) do |array, worst_file|
-          array << 
+          array <<
             {:location => @analyzer.location(:file, worst_file),
             :details => @analyzer.problems_with(:file, worst_file)}
           array
         end
         worst_items[:classes] = @analyzer.worst_classes(num).inject([]) do |array, class_name|
           location = @analyzer.location(:class, class_name)
-          array << 
+          array <<
             {:location => location,
             :details => @analyzer.problems_with(:class, class_name)}
           array
         end
         worst_items[:methods] = @analyzer.worst_methods(num).inject([]) do |array, method_name|
           location = @analyzer.location(:method, method_name)
-          array << 
+          array <<
             {:location => location,
             :details => @analyzer.problems_with(:method, method_name)}
           array

data/lib/generators/rails_best_practices.rb

@@ -1,6 +1,6 @@
 module MetricFu
   class RailsBestPractices < Generator
-    
+
     def emit
       @output = `rails_best_practices .`
     end

data/lib/generators/rcov.rb

@@ -35,43 +35,43 @@ module MetricFu
       output_file = MetricFu.rcov[:external] ? MetricFu.rcov[:external] : MetricFu::Rcov.metric_directory + '/rcov.txt'
       output = File.open(output_file).read
       output = output.split(NEW_FILE_MARKER)
-      
+
       output.shift # Throw away the first entry - it's the execution time etc.
-      
+
       files = assemble_files(output)
 
       @global_total_lines = 0
       @global_total_lines_run = 0
-      
+
       @rcov = add_coverage_percentage(files)
     end
 
     def to_h
       global_percent_run = ((@global_total_lines_run.to_f / @global_total_lines.to_f) * 100)
       add_method_data
-      {:rcov => @rcov.merge({:global_percent_run => round_to_tenths(global_percent_run) })}   
+      {:rcov => @rcov.merge({:global_percent_run => round_to_tenths(global_percent_run) })}
     end
-    
+
     private
-    
+
     def add_method_data
       @rcov.each_pair do |file_path, info|
         file_contents = ""
         coverage = []
-        
+
         info[:lines].each_with_index do |line, index|
           file_contents << "#{line[:content]}\n"
           coverage << line[:was_run]
         end
-        
+
         begin
-          line_numbers = LineNumbers.new(file_contents)
+          line_numbers = MetricFu::LineNumbers.new(file_contents)
         rescue StandardError => e
           raise e unless e.message =~ /you shouldn't be able to get here/
           puts "ruby_parser blew up while trying to parse #{file_path}. You won't have method level Rcov information for this file."
           next
         end
-        
+
         method_coverage_map = {}
         coverage.each_with_index do |covered, index|
           line_number = index + 1
@@ -84,16 +84,16 @@ module MetricFu
             method_coverage_map[method_name][:uncovered] += 1 if !covered
           end
         end
-        
+
         @rcov[file_path][:methods] = {}
-        
+
         method_coverage_map.each do |method_name, coverage_data|
           @rcov[file_path][:methods][method_name] = (coverage_data[:uncovered] / coverage_data[:total].to_f) * 100.0
         end
-        
+
       end
     end
-    
+
     def assemble_files(output)
       files = {}
       output.each_slice(2) {|out| files[out.first.strip] = out.last}
@@ -111,16 +111,16 @@ module MetricFu
       end
       files
     end
-    
+
     def add_coverage_percentage(files)
       files.each_pair do |fname, content|
         lines = content[:lines]
         @global_total_lines_run += lines_run = lines.find_all {|line| line[:was_run] == true }.length
         @global_total_lines += total_lines = lines.length
         percent_run = ((lines_run.to_f / total_lines.to_f) * 100).round
-        files[fname][:percent_run] = percent_run 
+        files[fname][:percent_run] = percent_run
       end
     end
-    
+
   end
 end