jscruggs-metric_fu 0.9.0 → 1.0.0

data/lib/base/report.rb

@@ -0,0 +1,100 @@
+module MetricFu
+
+  # MetricFu.report memoizes access to a Report object, that will be
+  # used throughout the lifecycle of the MetricFu app.
+  def self.report
+    @report ||= Report.new
+  end
+
+  # = Report
+  #
+  # The Report class is responsible two things:
+  #
+  # 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 
+  # 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 
+    #   process
+    def to_yaml
+      report_hash.to_yaml
+    end
+
+    
+    def report_hash #:nodoc:
+      @report_hash ||= {}
+    end
+
+    # Instantiates a new template class based on the configuration set
+    # in MetricFu::Configuration, or through the MetricFu.config block
+    # in your rake file (defaults to the included StandardTemplate) and
+    # assigns the report_hash to the report_hash to the template and
+    # asks itself to write itself out.
+    def save_templatized_report
+      @template = MetricFu.template_class.new
+      @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.
+    #
+    # @param report_type Hash
+    #   The hash to add to the aggregate report_hash
+    def add(report_type)
+      clazz = MetricFu.const_get(report_type.to_s.capitalize)
+      report_hash.merge!(clazz.generate_report)
+    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 
+    # file, otherwise it will default to 'index.html'
+    #
+    # @param content String
+    #   A string containing the content (usually html) to be written
+    #   to the file.
+    #
+    # @param dir String
+    #   A dir containing the path to the directory to write the file in.
+    #
+    # @param file String
+    #   A filename to save the path as.  Defaults to 'index.html'.
+    #
+    def save_output(content, dir, file='index.html')
+      open("#{dir}/#{file}", "w") do |f|
+        f.puts content
+      end
+    end
+
+    # 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 
+    # CruiseControl.rb environment.  See MetricFu.configuration for more
+    # details about how we make those guesses.
+    #
+    # @return Boolean
+    #   Should we open in the browser or not?
+    def open_in_browser?
+      MetricFu.configuration.platform.include?('darwin') &&
+      ! MetricFu.configuration.is_cruise_control_rb?
+    end
+
+    # Shows 'index.html' from the passed directory in the browser
+    # 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  
+    #   stored
+    def show_in_browser(dir)
+      system("open #{dir}/index.html") if open_in_browser?
+    end
+  end
+end

data/lib/{metric_fu → generators}/churn.rb

@@ -1,27 +1,32 @@
+require 'chronic'
+require 'generator'
 module MetricFu
   
-  def self.generate_churn_report
-    Churn.generate_report(MetricFu.churn)
-    system("open #{Churn.metric_dir}/index.html") if open_in_browser?
-  end
-  
-  class Churn < Base::Generator
+  class Churn < Generator
 
     def initialize(options={})
-      @base_dir = File.join(MetricFu::BASE_DIRECTORY, template_name)
+      super
       if File.exist?(".git")
-        @source_control = Git.new(options[:start_date])
+        @source_control = Git.new(MetricFu.churn[:start_date])
       elsif File.exist?(".svn")
-        @source_control = Svn.new(options[:start_date])
+        @source_control = Svn.new(MetricFu.churn[:start_date])
       else
         raise "Churning requires a subversion or git repo"
       end
+      @minimum_churn_count = MetricFu.churn[:minimum_churn_count] || 5
+    end
 
-      @minimum_churn_count = options[:minimum_churn_count] || 5
+    def emit
+      @changes = parse_log_for_changes.reject {|file, change_count| change_count < @minimum_churn_count}
     end
 
     def analyze
-      @changes = parse_log_for_changes.reject! {|file, change_count| change_count < @minimum_churn_count}
+      @changes = @changes.to_a.sort {|x,y| y[1] <=> x[1]}
+      @changes = @changes.map {|change| {:file_path => change[0], :times_changed => change[1] }}
+    end
+
+    def to_h
+      {:churn => {:changes => @changes}}
     end
 
     private
@@ -41,13 +46,6 @@ module MetricFu
       def initialize(start_date=nil)
         @start_date = start_date
       end
-
-      private
-      def require_rails_env
-        # not sure if the following works because active_support might only be in vendor/rails
-        # require 'activesupport'
-        require RAILS_ROOT + '/config/environment'
-      end
     end
 
     class Git < SourceControl
@@ -58,8 +56,8 @@ module MetricFu
       private
       def date_range
         if @start_date
-          require_rails_env
-          "--after=#{@start_date.call.strftime('%Y-%m-%d')}"
+          date = Chronic.parse(@start_date)
+          "--after=#{date.strftime('%Y-%m-%d')}"
         end
       end
 
@@ -73,8 +71,8 @@ module MetricFu
       private
       def date_range
         if @start_date
-          require_rails_env
-          "--revision {#{@start_date.call.strftime('%Y-%m-%d')}}:{#{Time.now.strftime('%Y-%m-%d')}}"
+          date = Chronic.parse(@start_date)
+          "--revision {#{date.strftime('%Y-%m-%d')}}:{#{Time.now.strftime('%Y-%m-%d')}}"
         end
       end
 

data/lib/generators/flay.rb

@@ -0,0 +1,29 @@
+require 'generator'
+module MetricFu
+  
+  class Flay < Generator
+
+    def emit
+      files_to_flay = MetricFu.flay[:dirs_to_flay].map{|dir| Dir[File.join(dir, "**/*.rb")] }
+      @output = `flay #{files_to_flay.join(" ")}`
+    end
+
+    def analyze
+      @matches = @output.chomp.split("\n\n").map{|m| m.split("\n  ") }
+    end
+
+    def to_h
+      target = []
+      total_score = @matches.shift.first.split('=').last.strip
+      @matches.each do |problem|
+        reason = problem.shift.strip
+        lines_info = problem.map do |full_line|
+          name, line = full_line.split(":")
+          {:name => name.strip, :line => line.strip}
+        end
+        target << [:reason => reason, :matches => lines_info]
+      end
+      {:flay => {:total_score => total_score, :matches => target.flatten}}
+    end
+  end
+end

data/lib/generators/flog.rb

@@ -0,0 +1,130 @@
+module MetricFu
+
+  class Flog < Generator
+    attr_reader :pages
+
+    SCORE_FORMAT = "%0.2f"
+    METHOD_LINE_REGEX = /(\d+\.\d+):\s+([A-Za-z]+#.*)/
+    OPERATOR_LINE_REGEX = /\s*(\d+\.\d+):\s(.*)$/
+
+    def emit
+      metric_dir = MetricFu::Flog.metric_directory
+      MetricFu.flog[:dirs_to_flog].each do |directory|
+        Dir.glob("#{directory}/**/*.rb").each do |filename|
+          output_dir = "#{metric_dir}/#{filename.split("/")[0..-2].join("/")}"
+          mkdir_p(output_dir, :verbose => false) unless File.directory?(output_dir)
+          if MetricFu::MD5Tracker.file_changed?(filename, metric_dir)
+            `flog -ad #{filename} > #{metric_dir}/#{filename.split('.')[0]}.txt`
+          end
+        end
+      end
+    rescue LoadError
+      if RUBY_PLATFORM =~ /java/
+        puts 'running in jruby - flog tasks not available'
+      else
+        puts 'sudo gem install flog # if you want the flog tasks'
+      end
+    end
+
+    def parse(text)
+      summary, methods_summary = text.split "\n\n"
+      score, average = summary.split("\n").map {|line| line[OPERATOR_LINE_REGEX, 1]}
+      return nil unless score && methods_summary
+      page = Flog::Page.new(score, average)
+      methods_summary.each_line do |method_line|
+        if match = method_line.match(METHOD_LINE_REGEX)
+         page.scanned_methods << ScannedMethod.new(match[2], match[1])
+        elsif match = method_line.match(OPERATOR_LINE_REGEX)
+          return if page.scanned_methods.empty?
+          page.scanned_methods.last.operators << Operator.new(match[1], match[2])
+        end
+      end
+      page
+    end
+
+    def analyze
+      @pages = []
+      flog_results.each do |path|
+        page = parse(open(path, "r") { |f| f.read })
+        if page
+          page.path = path.sub(metric_directory, "").sub(".txt", ".rb") 
+          @pages << page
+        end
+      end
+    end
+
+    def to_h
+      number_of_methods = @pages.inject(0) {|count, page| count += page.scanned_methods.size}
+      total_flog_score = @pages.inject(0) {|total, page| total += page.score}
+      sorted_pages = @pages.sort_by {|page| page.score }.reverse 
+      {:flog => { :total => total_flog_score,
+                  :average => round_to_tenths(total_flog_score/number_of_methods),
+                  :pages => sorted_pages.map {|page| page.to_h}}}
+    end
+  
+    def round_to_tenths(decimal)
+      (decimal * 10).round / 10.0 
+    end
+    def flog_results
+      Dir.glob("#{metric_directory}/**/*.txt")
+    end
+  
+    class Operator
+      attr_accessor :score, :operator
+
+      def initialize(score, operator)
+        @score = score.to_f
+        @operator = operator
+      end
+    
+      def to_h
+        {:score => @score, :operator => @operator}
+      end
+    end  
+
+    class ScannedMethod
+      attr_accessor :name, :score, :operators
+
+      def initialize(name, score, operators = [])
+        @name = name
+        @score = score.to_f
+        @operators = operators
+      end
+
+      def to_h
+        {:name => @name,
+         :score => @score,
+         :operators => @operators.map {|o| o.to_h}}
+      end
+    end  
+  
+  end
+
+  class Flog::Page < MetricFu::Generator
+    attr_accessor :path, :score, :scanned_methods, :average_score
+
+    def initialize(score, average_score, scanned_methods = [])
+      @score = score.to_f
+      @scanned_methods = scanned_methods
+      @average_score = average_score.to_f
+    end
+
+    def filename 
+      File.basename(path, ".txt") 
+    end
+
+    def to_h
+      {:score => @score, 
+       :scanned_methods => @scanned_methods.map {|sm| sm.to_h},
+       :highest_score => highest_score,
+       :average_score => average_score,
+       :path => path}
+    end
+
+    def highest_score
+      scanned_methods.inject(0) do |highest, m|
+        m.score > highest ? m.score : highest
+      end
+    end
+  end  
+end

data/lib/generators/rcov.rb

@@ -0,0 +1,74 @@
+require 'enumerator'
+
+module MetricFu
+
+  class Rcov < Generator
+    NEW_FILE_MARKER =  ("=" * 80) + "\n"
+
+
+    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
+      begin
+        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"
+        `rcov --include-file #{test_files}  #{rcov_opts} #{output}`
+      rescue LoadError
+        if RUBY_PLATFORM =~ /java/
+          puts 'running in jruby - rcov tasks not available'
+        else
+          puts 'sudo gem install rcov # if you want the rcov tasks'
+        end
+      end
+    end
+
+
+    def analyze
+      output = File.open(MetricFu::Rcov.metric_directory + '/rcov.txt').read
+      output = output.split(NEW_FILE_MARKER)
+      # Throw away the first entry - it's the execution time etc.
+      output.shift
+      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|
+          if raw_line.match(/^!!/)
+            line = Line.new(raw_line.gsub('!!', '  '), false).to_h
+          else
+            line = Line.new(raw_line, true).to_h
+          end
+        end
+        files[fname] = {:lines => content}
+      end
+
+      # Calculate the percentage of lines run in each file
+      files.each_pair do |fname, content|
+        lines = content[:lines]
+        lines_run = lines.find_all {|line| line[:was_run] == true }.length
+        total_lines = lines.length
+        percent_run = ((lines_run.to_f / total_lines.to_f) * 100).round
+        files[fname][:percent_run] = percent_run 
+      end
+      @rcov = files
+    end
+
+    def to_h
+      {:rcov => @rcov}   
+    end
+  end
+end

data/lib/generators/reek.rb

@@ -0,0 +1,31 @@
+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")] }
+      @output = `reek #{files_to_reek.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)
+          {:method => match_object[1].strip,
+           :message => match_object[2].strip,
+           :type => match_object[3].strip}
+        end
+        {:file_path => file_path, :code_smells => code_smells}
+      end
+    end
+
+    def to_h
+      {:reek => {:matches => @matches}}
+    end
+
+  end
+end

data/lib/generators/roodi.rb

@@ -0,0 +1,28 @@
+module MetricFu
+  
+    
+  class Roodi < Generator
+
+    def emit
+      files_to_analyze = MetricFu.roodi[:dirs_to_roodi].map{|dir| Dir[File.join(dir, "**/*.rb")] }
+      @output = `roodi #{files_to_analyze.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
+  end
+end

data/lib/generators/saikuro.rb

@@ -0,0 +1,201 @@
+module MetricFu
+
+class Saikuro < Generator
+
+
+  def emit
+    relative_path = [File.dirname(__FILE__), '..', '..', 
+                     'vendor', 'saikuro', 'saikuro.rb']
+    saikuro = File.expand_path(File.join(relative_path))
+    options_string = MetricFu.saikuro.inject("") do |o, h|
+      o + "--#{h.join(' ')} " 
+    end  
+    sh %{ruby "#{saikuro}" #{options_string}} do |ok, response|
+      unless ok
+        puts "Saikuro failed with exit status: #{response.exitstatus}"
+        exit 1
+      end
+    end
+  end
+
+  def analyze
+    @files = []
+    saikuro_results.each do |path|
+      if Saikuro::SFile.is_valid_text_file?(path)
+        file = Saikuro::SFile.new(path) 
+        if file 
+          @files << file 
+        end
+      end
+    end
+    @files = @files.sort_by do |file|
+      file.elements.
+           max {|a,b| a.complexity.to_i <=> b.complexity.to_i}.
+           complexity.to_i
+    end
+    @files.reverse!
+    klasses = []
+    @files.each {|f| klasses << f.elements}
+    klasses.flatten!
+    @classes = klasses.sort_by {|k| k.complexity.to_i}
+    @classes.reverse!
+    meths = []
+    @files.each {|f| 
+      f.elements.each {|el|
+        el.defs.each {|defn|
+          defn.name = "#{el.name}##{defn.name}"
+          meths <<  defn}
+      }
+    }
+    meths = meths.sort_by {|meth| meth.complexity.to_i}
+    @meths = meths.reverse
+    
+  end
+
+  def to_h
+    files = @files.map do |file|
+      my_file = file.to_h
+      my_file[:filename] = file.filename
+      my_file 
+    end
+    {:saikuro => {:files => files, 
+                  :classes => @classes.map {|c| c.to_h},
+                  :methods => @meths.map {|m| m.to_h} 
+                 }
+    }  
+  end
+
+  def saikuro_results
+    Dir.glob("#{metric_directory}/**/*.html")
+  end
+
+  private
+
+
+end
+
+class Saikuro::SFile
+
+  attr_reader :elements
+  
+  def initialize(path)
+    @path = path
+    @file_handle = File.open(@path, "r")
+    @elements = []
+    get_elements
+  end
+
+  def self.is_valid_text_file?(path)
+    File.open(path, "r") do |f|
+      unless f.readline.match /--/
+        return false
+      else
+        return true
+      end
+    end
+  end
+
+  def filename
+    File.basename(@path, '_cyclo.html')
+  end
+
+  def to_h
+    merge_classes
+    {:classes => @elements}
+  end
+
+  def get_elements
+    begin
+      while ( line = @file_handle.readline) do
+        if line.match /START/
+          line = @file_handle.readline
+          element = Saikuro::ParsingElement.new(line)
+        elsif line.match /END/
+          @elements << element 
+          element = nil
+        else
+          element << line
+        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