metric_fu 4.4.4 → 4.5.1

data/lib/metric_fu/metrics/rails_best_practices/rails_best_practices.rb

@@ -34,11 +34,9 @@ module MetricFu
       @rails_best_practices_results[:problems].each do |problem|
         next if problem[:file] == '' || problem[:problem].nil?
 
-        out[problem[:file]] ||= {}
 
         lines = problem[:line].split(/\s*,\s*/)
         lines.each do |line|
-          out[problem[:file]][line] ||= []
           out[problem[:file]][line] << {:type => :rails_best_practices, :description => problem[:problem]}
         end
       end

data/lib/metric_fu/metrics/rails_best_practices/rails_best_practices_grapher.rb

@@ -3,6 +3,10 @@ module MetricFu
   class RailsBestPracticesGrapher < Grapher
     attr_accessor :rails_best_practices_count, :labels
 
+    def self.metric
+      :rails_best_practices
+    end
+
     def initialize
       super
       @rails_best_practices_count = []
@@ -16,5 +20,20 @@ module MetricFu
         @labels.update( { @labels.size => date })
       end
     end
+
+    def title
+      'Rails Best Practices: design problems'
+    end
+
+    def data
+      [
+        ['rails_best_practices', @rails_best_practices_count.join(',')]
+      ]
+    end
+
+    def output_filename
+      'rails_best_practices.js'
+    end
+
   end
 end

data/lib/metric_fu/metrics/rails_best_practices/template_awesome/rails_best_practices.html.erb

@@ -3,12 +3,8 @@
 <p><a href="http://github.com/railsbp/rails_best_practices">rails_best_practices</a> is a code metric tool for rails projects.</p>
 
 <% graph_name = 'rails_best_practices' %>
-<% if MetricFu.configuration.graph_engine == :gchart %>
-<img src="<%= graph_name %>.png?<%= Time.now.to_i %>" />
-<% else %>
 <canvas id="graph"></canvas>
 <script language="javascript" src="<%= graph_name %>.js?<%= Time.now.to_i %>" type="text/javascript"></script>
-<% end %>
 
 <table>
   <tr>

data/lib/metric_fu/metrics/rcov/rcov_grapher.rb

@@ -3,6 +3,10 @@ module MetricFu
   class RcovGrapher < Grapher
     attr_accessor :rcov_percent, :labels
 
+    def self.metric
+      :rcov
+    end
+
     def initialize
       super
       self.rcov_percent = []
@@ -15,5 +19,20 @@ module MetricFu
         self.labels.update( { self.labels.size => date })
       end
     end
+
+    def title
+      'Rcov: code coverage'
+    end
+
+    def data
+      [
+        ['rcov', @rcov_percent.join(',')]
+      ]
+    end
+
+    def output_filename
+      'rcov.js'
+    end
+
   end
 end

data/lib/metric_fu/metrics/rcov/template_awesome/rcov.html.erb

@@ -3,12 +3,8 @@
 <p>C0 code coverage information.</p>
 
 <% graph_name = 'rcov' %>
-<% if MetricFu.configuration.graph_engine == :gchart %>
-<img src="<%= graph_name %>.png?<%= Time.now.to_i %>" />
-<% else %>
 <canvas id="graph"></canvas>
 <script language="javascript" src="<%= graph_name %>.js?<%= Time.now.to_i %>" type="text/javascript"></script>
-<% end %>
 
 <p>Total Coverage: <%= @rcov.delete(:global_percent_run) %>% </p>
 <table>

data/lib/metric_fu/metrics/reek/init.rb

@@ -7,7 +7,7 @@ module MetricFu
 
     def default_run_options
       { :dirs_to_reek => MetricFu::Io::FileSystem.directory('code_dirs'),
-                    :config_file_pattern => nil}
+                    :config_file_pattern => 'config/*.reek'}
     end
 
     def has_graph?

data/lib/metric_fu/metrics/reek/reek.rb

@@ -13,9 +13,8 @@ module MetricFu
         mf_log "Skipping Reek, no files found to analyze"
         @output = ""
       else
-        command = %Q(mf-reek #{cli_options(files)})
-        mf_debug "** #{command}"
-        @output = `#{command}`
+        args =  cli_options(files)
+        @output = run!(args)
         @output = massage_for_reek_12 if reek_12?
       end
     end
@@ -46,17 +45,15 @@ module MetricFu
         file_path = file_data[:file_path]
         next if File.extname(file_path) =~ /\.erb|\.html|\.haml/
         begin
-          line_numbers = MetricFu::LineNumbers.new(File.open(file_path, 'r').read,file_path)
+          line_numbers = MetricFu::LineNumbers.new(File.read(file_path),file_path)
         rescue StandardError => e
           raise e unless e.message =~ /you shouldn't be able to get here/
           mf_log "ruby_parser blew up while trying to parse #{file_path}. You won't have method level reek information for this file."
           next
         end
 
-        out[file_data[:file_path]] ||= {}
         file_data[:code_smells].each do |smell_data|
           line = line_numbers.start_line_for_method(smell_data[:method])
-          out[file_data[:file_path]][line.to_s] ||= []
           out[file_data[:file_path]][line.to_s] << {:type => :reek,
                                                     :description => "#{smell_data[:type]} - #{smell_data[:message]}"}
         end
@@ -97,8 +94,15 @@ module MetricFu
     end
 
     def cli_options(files)
-      config_file_param = options[:config_file_pattern] ? "--config #{options[:config_file_pattern]}" : ''
-      cli_options = "#{config_file_param} #{files.join(' ')}"
+      '--line-number ' <<
+        config_option(options[:config_file_pattern]) << ' ' <<
+        files.join(' ')
+    end
+
+    def config_option(location)
+      return '' if location.to_s.empty?
+      option = "--config #{location}"
+      '--config .reek ' << option unless location == '.reek'
     end
 
   end

data/lib/metric_fu/metrics/reek/reek_grapher.rb

@@ -3,6 +3,10 @@ module MetricFu
   class ReekGrapher < Grapher
     attr_accessor :reek_count, :labels
 
+    def self.metric
+      :reek
+    end
+
     def initialize
       super
       @reek_count = {}
@@ -27,5 +31,20 @@ module MetricFu
         end
       end
     end
+
+    def title
+      'Reek: code smells'
+    end
+
+    def data
+      @reek_count.map do |name, count|
+        [name, count.join(',')]
+      end
+    end
+
+    def output_filename
+      'reek.js'
+    end
+
   end
 end

data/lib/metric_fu/metrics/reek/template_awesome/reek.html.erb

@@ -3,12 +3,8 @@
 <p><a href="http://github.com/troessner/reek">Reek</a> detects common code smells in ruby code.</p>
 
 <% graph_name = 'reek' %>
-<% if MetricFu.configuration.graph_engine == :gchart %>
-<img src="<%= graph_name %>.png?<%= Time.now.to_i %>" />
-<% else %>
 <canvas id="graph"></canvas>
 <script language="javascript" src="<%= graph_name %>.js?<%= Time.now.to_i %>" type="text/javascript"></script>
-<% end %>
 
 <table>
   <tr>

data/lib/metric_fu/metrics/roodi/roodi.rb

@@ -9,9 +9,8 @@ module MetricFu
       files_to_analyze = options[:dirs_to_roodi].map{|dir| Dir[File.join(dir, "**/*.rb")] }
       files = remove_excluded_files(files_to_analyze.flatten)
       config = options[:roodi_config] ? "-config=#{options[:roodi_config]}" : ""
-      command = %Q(mf-roodi #{config} #{files.join(" ")})
-      mf_debug "** #{command}"
-      @output = `#{command}`
+      args = "#{config} #{files.join(" ")}"
+      @output = run!(args)
     end
 
     def analyze

data/lib/metric_fu/metrics/roodi/roodi_grapher.rb

@@ -3,6 +3,10 @@ module MetricFu
   class RoodiGrapher < Grapher
     attr_accessor :roodi_count, :labels
 
+    def self.metric
+      :roodi
+    end
+
     def initialize
       super
       @roodi_count = []
@@ -15,5 +19,20 @@ module MetricFu
         @labels.update( { @labels.size => date })
       end
     end
+
+    def title
+      'Roodi: design problems'
+    end
+
+    def data
+      [
+        ['roodi', @roodi_count.join(',')]
+      ]
+    end
+
+    def output_filename
+      'roodi.js'
+    end
+
   end
 end

data/lib/metric_fu/metrics/roodi/template_awesome/roodi.html.erb

@@ -3,12 +3,8 @@
 <p><a href="http://roodi.rubyforge.org/">Roodi</a> parses your Ruby code and warns you about design issues you have based on the checks that is has configured.</p>
 
 <% graph_name = 'roodi' %>
-<% if MetricFu.configuration.graph_engine == :gchart %>
-<img src="<%= graph_name %>.png?<%= Time.now.to_i %>" />
-<% else %>
 <canvas id="graph"></canvas>
 <script language="javascript" src="<%= graph_name %>.js?<%= Time.now.to_i %>" type="text/javascript"></script>
-<% end %>
 
 <table>
   <tr>

data/lib/metric_fu/metrics/saikuro/saikuro.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+MetricFu.lib_require       { 'utility'                 }
 MetricFu.metrics_require   { 'saikuro/scratch_file'    }
 MetricFu.metrics_require   { 'saikuro/parsing_element' }
 module MetricFu
@@ -17,9 +19,7 @@ module MetricFu
         options_string += "--input_directory #{input_dir} "
       end
 
-      command = %Q(mf-saikuro #{options_string})
-      mf_debug "** #{command}"
-      `#{command}`
+      @output = run!(options_string)
     end
 
     def analyze
@@ -29,47 +29,65 @@ module MetricFu
     end
 
     def to_h
-      files = @files.map do |file|
-        my_file = file.to_h
-
-        f = file.filepath
-        f.gsub!(%r{^#{metric_directory}/}, '')
-        f << "/#{file.filename}"
-
-        my_file[:filename] = f
-        my_file
-      end
-      @saikuro_data = {:files => files,
-                       :classes => @classes.map {|c| c.to_h},
-                       :methods => @meths.map {|m| m.to_h}
-                      }
+      @saikuro_data = {
+        files:    files_with_relative_paths(@files),
+        classes:  @classes.map { |c| c.to_h },
+        methods:  @meths.map   { |m| m.to_h },
+       }
+      clear_scratch_files!
       {:saikuro => @saikuro_data}
     end
 
     def per_file_info(out)
       @saikuro_data[:files].each do |file_data|
-        next if File.extname(file_data[:filename]) == '.erb' || !File.exists?(file_data[:filename])
-        begin
-          line_numbers = MetricFu::LineNumbers.new(File.open(file_data[:filename], 'r').read)
-        rescue StandardError => e
-          raise e unless e.message =~ /you shouldn't be able to get here/
-          mf_log "ruby_parser blew up while trying to parse #{file_path}. You won't have method level Saikuro information for this file."
-          next
-        end
+        filename = file_data[:filename]
+        next if erb_file?(filename) || file_not_exists?(filename)
+        next unless line_numbers = line_numbers_from_file(filename)
 
-        out[file_data[:filename]] ||= {}
-        file_data[:classes].each do |class_data|
-          class_data[:methods].each do |method_data|
-            line = line_numbers.start_line_for_method(method_data[:name])
-            out[file_data[:filename]][line.to_s] ||= []
-            out[file_data[:filename]][line.to_s] << {:type => :saikuro,
-                                                      :description => "Complexity #{method_data[:complexity]}"}
-          end
+        build_output_from_line_numbers(out, line_numbers, file_data)
+      end
+    end
+
+    def build_output_from_line_numbers(out, line_numbers, file_data)
+      filename = file_data[:filename]
+      output = out[filename]
+      method_data_for_file_data(file_data) do |method_data|
+         line = line_numbers.start_line_for_method(method_data[:name]).to_s
+         result = {
+           :type => :saikuro,
+           :description => "Complexity #{method_data[:complexity]}"
+         }
+         output[line] <<  result
+      end
+      out
+    end
+
+    def line_numbers_from_file(filename)
+      MetricFu::LineNumbers.new(File.read(filename))
+    rescue StandardError => e
+      raise e unless e.message =~ /you shouldn't be able to get here/
+      mf_log "ruby_parser blew up while trying to parse #{file_path}. You won't have method level Saikuro information for this file."
+    end
+
+    def method_data_for_file_data(file_data, &block)
+      return unless block_given?
+      file_data[:classes].each do |class_data|
+        class_data[:methods].each do |method_data|
+          yield method_data
         end
       end
     end
 
     private
+
+    def erb_file?(filename)
+      File.extname(filename) == '.erb'
+    end
+
+    def file_not_exists?(filename)
+      !File.exists?(filename)
+    end
+
     def sort_methods(methods)
       methods.sort_by {|method| method.complexity.to_i}.reverse
     end
@@ -107,6 +125,24 @@ module MetricFu
       SaikuroScratchFile.assemble_files( Dir.glob("#{metric_directory}/**/*.html") )
     end
 
+    def files_with_relative_paths(files)
+      files.map do |file|
+        file_hash = file.to_h
+        file_hash[:filename] = file_relative_path(file)
+        file_hash
+      end.to_a
+    end
+
+    def file_relative_path(file)
+      filepath = file.filepath
+      path = filepath.gsub(/^#{metric_directory}\//, '')
+      "#{path}/#{file.filename}"
+    end
+
+    def clear_scratch_files!
+      MetricFu::Utility.rm_rf(metric_directory)
+    end
+
   end
 
 end

data/lib/metric_fu/metrics/saikuro/scratch_file.rb

@@ -19,16 +19,15 @@ module MetricFu
 
     def initialize(path)
       @path = path
-      @file_handle = File.open(@path, "r")
       @elements = []
-      get_elements
-    ensure
-      @file_handle.close if @file_handle
+      File.open(@path, "r") do |file|
+        get_elements(file)
+      end
     end
 
     def self.is_valid_text_file?(path)
-      File.open(path, "r") do |f|
-        if f.eof? || !f.readline.match(/--/)
+      File.open(path, "r") do |file|
+        if file.eof? || !file.readline.match(/--/)
           return false
         else
           return true
@@ -49,9 +48,9 @@ module MetricFu
       {:classes => @elements}
     end
 
-    def get_elements
+    def get_elements(io)
       begin
-        while (line = @file_handle.readline) do
+        while (line = io.readline) do
           return [] if line.nil? || line !~ /\S/
           element ||= nil
           if line.match(/START/)
@@ -59,7 +58,7 @@ module MetricFu
               @elements << element
               element = nil
             end
-            line = @file_handle.readline
+            line = io.readline
             element = MetricFu::SaikuroParsingElement.new(line)
           elsif line.match(/END/)
             @elements << element if element

data/lib/metric_fu/metrics/stats/stats_grapher.rb

@@ -3,6 +3,10 @@ module MetricFu
   class StatsGrapher < Grapher
     attr_accessor :loc_counts, :lot_counts, :labels
 
+    def self.metric
+      :stats
+    end
+
     def initialize
       super
       self.loc_counts = []
@@ -17,5 +21,21 @@ module MetricFu
         self.labels.update( { self.labels.size => date })
       end
     end
+
+    def title
+      'Stats: LOC & LOT'
+    end
+
+    def data
+      [
+        ['LOC', @loc_counts.join(',')],
+        ['LOT', @lot_counts.join(',')],
+      ]
+    end
+
+    def output_filename
+      'stats.js'
+    end
+
   end
 end