rferraz-metric_fu 2.1.1

data/lib/generators/rcov.rb

@@ -0,0 +1,122 @@
+require 'enumerator'
+
+module MetricFu
+
+  class Rcov < Generator
+    NEW_FILE_MARKER = /^={80}$/.freeze
+
+    class Line
+      attr_accessor :content, :was_run
+
+      def initialize(content, was_run)
+        @content = content
+        @was_run = was_run
+      end
+
+      def to_h
+        {:content => @content, :was_run => @was_run}
+      end
+    end
+
+    def emit
+      unless MetricFu.rcov[:external]
+        FileUtils.rm_rf(MetricFu::Rcov.metric_directory, :verbose => false)
+        Dir.mkdir(MetricFu::Rcov.metric_directory)
+        test_files = FileList[*MetricFu.rcov[:test_files]].join(' ')
+        rcov_opts = MetricFu.rcov[:rcov_opts].join(' ')
+        output = ">> #{MetricFu::Rcov.metric_directory}/rcov.txt"
+        puts "** Running the specs/tests in the [#{MetricFu.rcov[:environment]}] environment"
+        `RAILS_ENV=#{MetricFu.rcov[:environment]} rcov #{test_files} #{rcov_opts} #{output}`
+      end
+    end
+
+
+    def analyze
+      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) })}
+    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 = 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
+          if line_numbers.in_method?(line_number)
+            method_name = line_numbers.method_at_line(line_number)
+            method_coverage_map[method_name] ||= {}
+            method_coverage_map[method_name][:total] ||= 0
+            method_coverage_map[method_name][:total] += 1
+            method_coverage_map[method_name][:uncovered] ||= 0
+            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}
+      files.each_pair {|fname, content| files[fname] = content.split("\n") }
+      files.each_pair do |fname, content|
+        content.map! do |raw_line|
+          line = Line.new(raw_line[3..-1], !raw_line.match(/^!!/)).to_h
+        end
+        content.reject! {|line| line[:content].blank? }
+        files[fname] = {:lines => content}
+      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
+      end
+    end
+
+  end
+end

data/lib/generators/reek.rb

@@ -0,0 +1,81 @@
+module MetricFu
+
+  class Reek < Generator
+    REEK_REGEX = /^(\S+) (.*) \((.*)\)$/
+
+    def emit
+      files_to_reek = MetricFu.reek[:dirs_to_reek].map{|dir| Dir[File.join(dir, "**/*.rb")] }
+      files = remove_excluded_files(files_to_reek.flatten)
+      config_file_param = MetricFu.reek[:config_file_pattern] ? "--config #{MetricFu.reek[:config_file_pattern]}" : ''
+      @output = `reek #{config_file_param} #{files.join(" ")}`
+      @output = massage_for_reek_12 if reek_12?
+    end
+
+    def reek_12?
+      return false if @output.length == 0
+      (@output =~ /^"/) != 0
+    end
+
+    def massage_for_reek_12
+      section_break = ''
+      @output.split("\n").map do |line|
+        case line
+        when /^  /
+          "#{line.gsub(/^  /, '')}\n"
+        else
+          parts = line.split(" -- ")
+          if parts[1].nil?
+            "#{line}\n"
+          else
+            warnings = parts[1].gsub(/ \(.*\):/, ':')
+            result = "#{section_break}\"#{parts[0]}\" -- #{warnings}\n"
+            section_break = "\n"
+            result
+          end
+        end
+      end.join
+    end
+
+    def analyze
+      @matches = @output.chomp.split("\n\n").map{|m| m.split("\n") }
+      @matches = @matches.map do |match|
+        file_path = match.shift.split('--').first
+        file_path = file_path.gsub('"', ' ').strip
+        code_smells = match.map do |smell|
+          match_object = smell.match(REEK_REGEX)
+          next unless match_object
+          {:method => match_object[1].strip,
+           :message => match_object[2].strip,
+           :type => match_object[3].strip}
+        end.compact
+        {:file_path => file_path, :code_smells => code_smells}
+      end
+    end
+
+    def to_h
+      {:reek => {:matches => @matches}}
+    end
+
+    def per_file_info(out)
+      @matches.each do |file_data|
+        next if File.extname(file_data[:file_path]) == '.erb'
+        begin
+          line_numbers = MetricFu::LineNumbers.new(File.open(file_data[:file_path], 'r').read)
+        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 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
+      end
+    end
+
+  end
+end

data/lib/generators/roodi.rb

@@ -0,0 +1,35 @@
+module MetricFu
+  class Roodi < Generator
+
+    def emit
+      files_to_analyze = MetricFu.roodi[:dirs_to_roodi].map{|dir| Dir[File.join(dir, "**/*.rb")] }
+      files = remove_excluded_files(files_to_analyze.flatten)
+      config = MetricFu.roodi[:roodi_config] ? "-config=#{MetricFu.roodi[:roodi_config]}" : ""
+      @output = `roodi #{config} #{files.join(" ")}`
+    end
+
+    def analyze
+      @matches = @output.chomp.split("\n").map{|m| m.split(" - ") }
+      total = @matches.pop
+      @matches.reject! {|array| array.empty? }
+      @matches.map! do |match|
+        file, line = match[0].split(':')
+        problem = match[1]
+        {:file => file, :line => line, :problem => problem}
+      end
+      @roodi_results = {:total => total, :problems => @matches}
+    end
+
+    def to_h
+      {:roodi => @roodi_results}
+    end
+
+    def per_file_info(out)
+      @matches.each do |match|
+        out[match[:file]] ||= {}
+        out[match[:file]][match[:line]] ||= []
+        out[match[:file]][match[:line]] << {:type => :roodi, :description => match[:problem]}
+      end
+    end
+  end
+end

data/lib/generators/saikuro.rb

@@ -0,0 +1,256 @@
+module MetricFu
+
+  class Saikuro < Generator
+
+    def emit
+      options_string = MetricFu.saikuro.inject("") do |options, option|
+        option[0] == :input_directory ? options : options + "--#{option.join(' ')} "
+      end
+
+      MetricFu.saikuro[:input_directory].each do |input_dir|
+        options_string += "--input_directory #{input_dir} "
+      end
+      sh %{saikuro #{options_string}} do |ok, response|
+        unless ok
+          puts "Saikuro failed with exit status: #{response.exitstatus}"
+          exit 1
+        end
+      end
+    end
+
+    def format_directories
+      dirs = MetricFu.saikuro[:input_directory].join(" | ")
+      "\"#{dirs}\""
+    end
+
+    def analyze
+      @files = sort_files(assemble_files)
+      @classes = sort_classes(assemble_classes(@files))
+      @meths = sort_methods(assemble_methods(@files))
+    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 => @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/
+          puts "ruby_parser blew up while trying to parse #{file_path}. You won't have method level Saikuro information for this file."
+          next
+        end
+
+        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
+        end
+      end
+    end
+
+    private
+    def sort_methods(methods)
+      methods.sort_by {|method| method.complexity.to_i}.reverse
+    end
+
+    def assemble_methods(files)
+      methods = []
+      files.each do |file|
+        file.elements.each do |element|
+          element.defs.each do |defn|
+            defn.name = "#{element.name}##{defn.name}"
+            methods << defn
+          end
+        end
+      end
+      methods
+    end
+
+    def sort_classes(classes)
+      classes.sort_by {|k| k.complexity.to_i}.reverse
+    end
+
+    def assemble_classes(files)
+      files.map {|f| f.elements}.flatten
+    end
+
+    def sort_files(files)
+      files.sort_by do |file|
+        file.elements.
+             max {|a,b| a.complexity.to_i <=> b.complexity.to_i}.
+             complexity.to_i
+      end.reverse
+    end
+
+    def assemble_files
+      files = []
+      Dir.glob("#{metric_directory}/**/*.html").each do |path|
+        if Saikuro::SFile.is_valid_text_file?(path)
+          file = Saikuro::SFile.new(path)
+          if file
+            files << file
+          end
+        end
+      end
+      files
+    end
+
+  end
+
+  class Saikuro::SFile
+
+    attr_reader :elements
+
+    def initialize(path)
+      @path = path
+      @file_handle = File.open(@path, "r")
+      @elements = []
+      get_elements
+    ensure
+      @file_handle.close if @file_handle
+    end
+
+    def self.is_valid_text_file?(path)
+      File.open(path, "r") do |f|
+        if f.eof? || !f.readline.match(/--/)
+          return false
+        else
+          return true
+        end
+      end
+    end
+
+    def filename
+      File.basename(@path, '_cyclo.html')
+    end
+
+    def filepath
+      File.dirname(@path)
+    end
+
+    def to_h
+      merge_classes
+      {:classes => @elements}
+    end
+
+    def get_elements
+      begin
+        while (line = @file_handle.readline) do
+          return [] if line.nil? || line !~ /\S/
+          element ||= nil
+          if line.match /START/
+            unless element.nil?
+              @elements << element
+              element = nil
+            end
+            line = @file_handle.readline
+            element = Saikuro::ParsingElement.new(line)
+          elsif line.match /END/
+            @elements << element if element
+            element = nil
+          else
+            element << line if element
+          end
+        end
+      rescue EOFError
+        nil
+      end
+    end
+
+
+    def merge_classes
+      new_elements = []
+      get_class_names.each do |target_class|
+        elements = @elements.find_all {|el| el.name == target_class }
+        complexity = 0
+        lines = 0
+        defns = []
+        elements.each do |el|
+          complexity += el.complexity.to_i
+          lines += el.lines.to_i
+          defns << el.defs
+        end
+
+        new_element = {:class_name => target_class,
+                       :complexity => complexity,
+                       :lines => lines,
+                       :methods => defns.flatten.map {|d| d.to_h}}
+        new_element[:methods] = new_element[:methods].
+                                sort_by {|x| x[:complexity] }.
+                                reverse
+
+        new_elements << new_element
+      end
+      @elements = new_elements if new_elements
+    end
+
+    def get_class_names
+      class_names = []
+      @elements.each do |element|
+        unless class_names.include?(element.name)
+          class_names << element.name
+        end
+      end
+      class_names
+    end
+
+  end
+
+  class Saikuro::ParsingElement
+    TYPE_REGEX=/Type:(.*) Name/
+    NAME_REGEX=/Name:(.*) Complexity/
+    COMPLEXITY_REGEX=/Complexity:(.*) Lines/
+    LINES_REGEX=/Lines:(.*)/
+
+    attr_reader :complexity, :lines, :defs, :element_type
+    attr_accessor :name
+
+    def initialize(line)
+      @line = line
+      @element_type = line.match(TYPE_REGEX)[1].strip
+      @name = line.match(NAME_REGEX)[1].strip
+      @complexity = line.match(COMPLEXITY_REGEX)[1].strip
+      @lines = line.match(LINES_REGEX)[1].strip
+      @defs = []
+    end
+
+    def <<(line)
+      @defs << Saikuro::ParsingElement.new(line)
+    end
+
+    def to_h
+      base = {:name => @name, :complexity => @complexity.to_i, :lines => @lines.to_i}
+      unless @defs.empty?
+        defs = @defs.map do |my_def|
+          my_def = my_def.to_h
+          my_def.delete(:defs)
+          my_def
+        end
+        base[:defs] = defs
+      end
+      return base
+    end
+  end
+end

data/lib/generators/stats.rb

@@ -0,0 +1,58 @@
+module MetricFu
+
+  class Stats < Generator
+
+    def emit
+      `rake stats > #{metric_directory + '/stats.txt'}`
+    end
+
+    def analyze
+      output = File.open(metric_directory + '/stats.txt').read
+      lines = remove_noise(output)
+
+      @stats = {}
+
+      set_global_stats(lines.pop)
+      set_granular_stats(lines)
+
+      @stats
+    end
+
+    def to_h
+      {:stats => @stats}
+    end
+
+    private
+
+    def remove_noise(output)
+      lines = output.split("\n")
+      lines = lines.find_all {|line| line =~ /^\s*[C|]/ }
+      lines.shift
+      lines
+    end
+
+    def set_global_stats(totals)
+      totals = totals.split("  ").find_all {|el| ! el.empty? }
+      @stats[:codeLOC] = totals[0].match(/\d.*/)[0].to_i
+      @stats[:testLOC] = totals[1].match(/\d.*/)[0].to_i
+      @stats[:code_to_test_ratio] = totals[2].match(/1\:(\d.*)/)[1].to_f
+    end
+
+    def set_granular_stats(lines)
+      @stats[:lines] = lines.map do |line|
+        elements = line.split("|")
+        elements.map! {|el| el.strip }
+        elements = elements.find_all {|el| ! el.empty? }
+        info_line = {}
+        info_line[:name] = elements.shift
+        elements.map! {|el| el.to_i }
+        [:lines, :loc, :classes, :methods,
+         :methods_per_class, :loc_per_method].each do |sym|
+          info_line[sym] = elements.shift
+        end
+        info_line
+      end
+    end
+
+  end
+end

data/lib/graphs/engines/bluff.rb

@@ -0,0 +1,113 @@
+require 'active_support'
+
+module MetricFu
+  class Grapher
+    BLUFF_GRAPH_SIZE = "1000x600"
+    BLUFF_DEFAULT_OPTIONS = <<-EOS
+      var g = new Bluff.Line('graph', "#{BLUFF_GRAPH_SIZE}");
+      g.theme_37signals();
+      g.tooltips = true;
+      g.title_font_size = "24px"
+      g.legend_font_size = "12px"
+      g.marker_font_size = "10px"
+    EOS
+  end
+
+  class FlayBluffGrapher < FlayGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Flay: duplication';
+        g.data('flay', [#{@flay_score.join(',')}]);
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'flay.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class FlogBluffGrapher < FlogGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Flog: code complexity';
+        g.data('average', [#{@flog_average.join(',')}]);
+        g.data('top 5% average', [#{@top_five_percent_average.join(',')}])
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'flog.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class RcovBluffGrapher < RcovGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Rcov: code coverage';
+        g.data('rcov', [#{@rcov_percent.join(',')}]);
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'rcov.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class ReekBluffGrapher < ReekGrapher
+    def graph!
+      legend = @reek_count.keys.sort
+      data = ""
+      legend.each do |name|
+        data += "g.data('#{name}', [#{@reek_count[name].join(',')}])\n"
+      end
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Reek: code smells';
+        #{data}
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'reek.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class RoodiBluffGrapher < RoodiGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Roodi: design problems';
+        g.data('roodi', [#{@roodi_count.join(',')}]);
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'roodi.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class StatsBluffGrapher < StatsGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Stats: LOC & LOT';
+        g.data('LOC', [#{@loc_counts.join(',')}]);
+        g.data('LOT', [#{@lot_counts.join(',')}])
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'stats.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class RailsBestPracticesBluffGrapher < RailsBestPracticesGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Rails Best Practices: design problems';
+        g.data('rails_best_practices', [#{@rails_best_practices_count.join(',')}]);
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'rails_best_practices.js'), 'w') {|f| f << content }
+    end
+  end
+end