indirect-metric_fu 0.8.2 → 0.9.0

data/lib/metric_fu/flog.rb

@@ -0,0 +1,129 @@
+module MetricFu
+
+  def self.generate_flog_report
+    Flog::Generator.generate_report
+    system("open #{Flog::Generator.metric_dir}/index.html") if open_in_browser?
+  end
+
+  module Flog
+    class Generator < Base::Generator
+      def generate_report
+        @base_dir = self.class.metric_dir
+        pages = []
+        flog_results.each do |filename|
+          page = Base.parse(open(filename, "r") { |f| f.read })
+          if page
+            page.filename = filename
+            pages << page
+          end
+        end
+        generate_pages(pages)
+      end
+
+      def generate_pages(pages)
+        pages.each do |page|
+          unless MetricFu::MD5Tracker.file_already_counted?(page.filename)
+            generate_page(page)
+          end
+        end
+        save_html(ERB.new(File.read(template_file)).result(binding))
+      end
+
+      def generate_page(page)
+        save_html(page.to_html, page.path)
+      end
+
+      def flog_results
+        Dir.glob("#{@base_dir}/**/*.txt")
+      end
+
+      def self.template_name
+        "flog"
+      end
+    end
+
+    SCORE_FORMAT = "%0.2f"
+
+    class Base
+      METHOD_LINE_REGEX = /([A-Za-z]+#.*):\s\((\d+\.\d+)\)/
+      OPERATOR_LINE_REGEX = /\s+(\d+\.\d+):\s(.*)$/
+
+      class << self
+
+        def parse(text)
+          score = text[/\w+ = (\d+\.\d+)/, 1]
+          return nil unless score
+          page = Page.new(score)
+
+          text.each_line do |method_line|
+           if match = method_line.match(METHOD_LINE_REGEX)
+              page.scanned_methods << ScannedMethod.new(match[1], match[2])
+            end
+
+            if 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
+
+      end
+    end
+
+    class Page < MetricFu::Base::Generator
+      attr_accessor :filename, :score, :scanned_methods
+
+      def initialize(score, scanned_methods = [])
+        @score = score.to_f
+        @scanned_methods = scanned_methods
+      end
+
+      def path
+        @path ||= File.basename(filename, ".txt") + '.html'
+      end
+
+      def to_html
+        ERB.new(File.read(template_file)).result(binding)
+      end
+
+      def average_score
+        return 0 if scanned_methods.length == 0
+        sum = 0
+        scanned_methods.each do |m|
+          sum += m.score
+        end
+        sum / scanned_methods.length
+      end
+
+      def highest_score
+        scanned_methods.inject(0) do |highest, m|
+          m.score > highest ? m.score : highest
+        end
+      end
+
+      def template_name
+        'flog_page'
+      end
+    end
+
+    class Operator
+      attr_accessor :score, :operator
+
+      def initialize(score, operator)
+        @score = score.to_f
+        @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
+    end
+  end
+end

data/lib/metric_fu/reek.rb

@@ -0,0 +1,17 @@
+module MetricFu
+
+  def self.generate_reek_report
+    Reek.generate_report
+    system("open #{Reek.metric_dir}/index.html") if open_in_browser?
+  end
+
+  class Reek < Base::Generator
+
+    def analyze
+      files_to_reek = MetricFu.reek[:dirs_to_reek].map{|dir| Dir[File.join(dir, "**/*.rb")] }
+      output = `reek #{files_to_reek.join(" ")}`
+      @matches = output.chomp.split("\n\n").map{|m| m.split("\n") }
+    end
+
+  end
+end

data/lib/metric_fu/roodi.rb

@@ -0,0 +1,17 @@
+module MetricFu
+
+  def self.generate_roodi_report
+    MetricFu::Roodi.generate_report
+    system("open #{Roodi.metric_dir}/index.html") if open_in_browser?
+  end
+
+  class Roodi < Base::Generator
+
+    def analyze
+      files_to_analyze = MetricFu.roodi[:dirs_to_roodi].map{|dir| Dir[File.join(dir, "**/*.rb")] }
+      output = `roodi #{files_to_analyze.join(" ")}`
+      @matches = output.chomp.split("\n").map{|m| m.split(" - ") }
+    end
+
+  end
+end

data/lib/metric_fu.rb

@@ -1,3 +1,17 @@
-require File.join(File.dirname(__FILE__), 'metric_fu', 'base') #require first because of dependecies
-require File.join(File.dirname(__FILE__), 'tasks', 'metric_fu')
-Dir[File.join(File.dirname(__FILE__), 'metric_fu/*.rb')].each{|l| require l }
+module MetricFu
+  TEMPLATE_DIR = File.join(File.dirname(__FILE__), '..', 'templates')
+  BASE_DIRECTORY = ENV['CC_BUILD_ARTIFACTS'] || 'tmp/metric_fu'
+  RAILS = File.exist?("config/environment.rb")
+
+  if RAILS
+    CODE_DIRS = ['app', 'lib']
+  else
+    CODE_DIRS = ['lib']
+  end
+end
+
+# Load metric_fu base class
+require File.join(File.dirname(__FILE__), 'metric_fu', 'base')
+# Load metrics tasks
+require "rake"
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].each { |ext| load ext }

data/lib/tasks/churn.rake

@@ -4,8 +4,6 @@ namespace :metrics do
 
   desc "Which files change the most"
   task :churn do
-    churn_dir = File.join(MetricFu::BASE_DIRECTORY, 'churn')
-    MetricFu::Churn.generate_report(churn_dir, defined?(MetricFu::CHURN_OPTIONS) ? MetricFu::CHURN_OPTIONS : {} )
-    system("open #{churn_dir}/index.html") if PLATFORM['darwin']
+    MetricFu.generate_churn_report
   end
 end

data/lib/tasks/coverage.rake

@@ -1,5 +1,4 @@
 require 'fileutils'
-
 begin
   require 'rcov'
   require 'rcov/rcovtask'
@@ -18,20 +17,30 @@ begin
       task(:clean) { rm_f("rcov_tmp", :verbose => false) }
 
       desc "RCov task to generate report"
-      Spec::Rake::SpecTask.new(:do => :clean) do |t|
+      Rcov::RcovTask.new(:do => :clean) do |t|
         FileUtils.mkdir_p(MetricFu::BASE_DIRECTORY) unless File.directory?(MetricFu::BASE_DIRECTORY)
-        t.ruby_opts = ['-rtest/unit']
-        t.spec_files = FileList['test/**/*_test.rb', 'spec/**/*spec.rb']
-        t.spec_opts = ["--format", "html:#{SPEC_HTML_FILE}", "--diff"]
-        t.rcov = true
-        t.rcov_opts = ["--sort coverage", "--html", "--rails", "--exclude /gems/,/Library/"]
-        t.rcov_dir = COVERAGE_DIR
+        t.test_files = FileList[*MetricFu.coverage[:test_files]]
+        t.rcov_opts = MetricFu.coverage[:rcov_opts]
+        t.output_dir = COVERAGE_DIR
+        # this line is a fix for Rails 2.1 relative loading issues
+        t.libs << 'test'
       end
+      # TODO not sure what this improves but it requires the diff-lcs gem
+      # http://github.com/indirect/metric_fu/commit/b9c1cf75f09d5b531b388cd01661eb16b5126968#diff-1
+      # Spec::Rake::SpecTask.new(:do => :clean) do |t|
+      # FileUtils.mkdir_p(MetricFu::BASE_DIRECTORY) unless File.directory?(MetricFu::BASE_DIRECTORY)
+      # t.ruby_opts = ['-rtest/unit']
+      # t.spec_files = FileList['test/**/*_test.rb', 'spec/**/*spec.rb']
+      # t.spec_opts = ["--format", "html:#{SPEC_HTML_FILE}", "--diff"]
+      # t.rcov = true
+      # t.rcov_opts = ["--sort coverage", "--html", "--rails", "--exclude /gems/,/Library/"]
+      # t.rcov_dir = COVERAGE_DIR
+      # end
     end
 
     desc "Generate and open coverage report"
     task :coverage => ['coverage:do'] do
-      system("open #{COVERAGE_DIR}/index.html") if PLATFORM['darwin']
+      system("open #{COVERAGE_DIR}/index.html") if MetricFu.open_in_browser?
     end
   end
 rescue LoadError
@@ -41,4 +50,4 @@ rescue LoadError
     puts 'sudo gem install rcov # if you want the rcov tasks'
 
   end
-end
+end

data/lib/tasks/flay.rake

@@ -1,9 +1,6 @@
-FLAY_DIR = File.join(MetricFu::BASE_DIRECTORY, 'flay')
-
 namespace :metrics do
   desc "Generate code duplication report with flay"
   task :flay do
-    MetricFu::FlayReporter.generate_report(FLAY_DIR)
-    system("open #{FLAY_DIR}/index.html") if PLATFORM['darwin']
+    MetricFu.generate_flay_report
   end
 end

data/lib/tasks/flog.rake

@@ -1,11 +1,13 @@
 begin
-  FLOG_DIR = File.join(MetricFu::BASE_DIRECTORY, 'flog')
 
   def flog(output, directory)
+    metric_dir = MetricFu::Flog::Generator.metric_dir
     Dir.glob("#{directory}/**/*.rb").each do |filename|
-      output_dir = "#{FLOG_DIR}/#{filename.split("/")[0..-2].join("/")}"
+      output_dir = "#{metric_dir}/#{filename.split("/")[0..-2].join("/")}"
       mkdir_p(output_dir, :verbose => false) unless File.directory?(output_dir)
-      `flog #{filename} > #{FLOG_DIR}/#{filename.split('.')[0]}.txt` if MetricFu::MD5Tracker.file_changed?(filename, FLOG_DIR)
+      if MetricFu::MD5Tracker.file_changed?(filename, metric_dir)
+        `flog #{filename} > #{metric_dir}/#{filename.split('.')[0]}.txt`
+      end
     end
   end
 
@@ -16,7 +18,7 @@ begin
 
     namespace :flog do
       desc "Delete aggregate flog data."
-      task(:clean) { rm_rf(FLOG_DIR, :verbose => false) }
+      task(:clean) { rm_rf(MetricFu::Flog.metric_dir, :verbose => false) }
 
       desc "Flog code in app/models"
       task :models do
@@ -40,20 +42,18 @@ begin
 
       desc "Generate a flog report from specified directories"
       task :custom do
-        MetricFu::CODE_DIRS.each { |directory| flog(directory, directory) }
-        MetricFu::FlogReporter::Generator.generate_report(FLOG_DIR)
+        MetricFu::flog[:dirs_to_flog].each { |directory| flog(directory, directory) }
+        MetricFu.generate_flog_report
       end
 
       desc "Generate and open flog report"
       if MetricFu::RAILS
         task :all => [:models, :controllers, :helpers, :lib] do
-          MetricFu::FlogReporter::Generator.generate_report(FLOG_DIR)
-          system("open #{FLOG_DIR}/index.html") if PLATFORM['darwin']
+          MetricFu.generate_flog_report
         end
       else
         task :all => [:custom] do
-          MetricFu::FlogReporter::Generator.generate_report(FLOG_DIR)
-          system("open #{FLOG_DIR}/index.html") if PLATFORM['darwin']
+          MetricFu.generate_flog_report
         end
       end
 

data/lib/tasks/metric_fu.rake

@@ -1,8 +1,11 @@
+# only load configured metrics
+MetricFu.metrics.each { |task| import "#{File.dirname(__FILE__)}/#{task}.rake" }
+
 namespace :metrics do
   if MetricFu::RAILS
 
-    desc "Generate coverage, cyclomatic complexity, flog, stats, duplication and churn reports"
-    task :all => [:coverage, :stats, :saikuro, :churn, :flog, :flay]
+    desc "Generate coverage, cyclomatic complexity, flog, flay, railroad, reek, roodi, stats and churn reports"
+    task :all => MetricFu.metrics
 
     task :set_testing_env do
       RAILS_ENV = 'test'
@@ -13,8 +16,9 @@ namespace :metrics do
 
   else
 
-    desc "Generate coverage, cyclomatic complexity, flog, duplication and churn reports"
-    task :all => [:coverage, :saikuro, :churn, :flog, :flay]
+    desc "Generate coverage, cyclomatic complexity, flog, flay, railroad and churn reports"
+    task :all => MetricFu.metrics
 
   end
+
 end

data/lib/tasks/metric_fu.rb

@@ -3,4 +3,4 @@ require 'rubygems'
 require 'rake'
 
 # Load rake files
-Dir["#{File.dirname(__FILE__)}/*.rake"].each { |ext| load ext }
+import "#{File.dirname(__FILE__)}/metric_fu.rake"

data/lib/tasks/railroad.rake

@@ -0,0 +1,39 @@
+namespace :metrics do
+
+  RAILROAD_DIR = File.join(MetricFu::BASE_DIRECTORY, 'railroad')
+  RAILROAD_FILE = File.join(RAILROAD_DIR, 'index.html')
+
+  task :railroad => ['railroad:all'] do
+  end
+
+  namespace :railroad do
+
+    desc "Create all railroad reports"
+    task :all => [:models, :controllers, :aasm] do
+      #system("open #{RAILROAD_INDEX}") if PLATFORM['darwin']
+    end
+
+    desc "Create a railroad models report"
+    task :models do
+      #mkdir_p(RAILROAD_DIR) unless File.directory?(RAILROAD_DIR)
+      `railroad -M -a -m -l -v | neato -Tpng > #{File.join(MetricFu::BASE_DIRECTORY,'model-diagram.png')}`
+      #`echo "<a href=\"railroad/models.png\">Model diagram</a><br />" >> #{RAILROAD_FILE}`
+    end
+
+    desc "Create a railroad controllers report"
+    task :controllers do
+      #mkdir_p(RAILROAD_DIR) unless File.directory?(RAILROAD_DIR)
+      `railroad -C -l -v | neato -Tpng > #{File.join(MetricFu::BASE_DIRECTORY,'controller-diagram.png')}`
+      #`echo "<a href=\"railroad/controllers.png\">Controller diagram</a><br />" >> #{RAILROAD_FILE}`
+    end
+
+    desc "Create a railroad acts_as_state_machine report"
+    task :aasm do
+      #mkdir_p(RAILROAD_DIR) unless File.directory?(RAILROAD_DIR)
+      `railroad -A -l -v | neato -Tpng > #{File.join(MetricFu::BASE_DIRECTORY,'aasm-diagram.png')}`
+      #`echo "<a href=\"railroad/aasm.png\">State machine diagram</a><br />" >> #{RAILROAD_FILE}`
+    end
+
+  end
+
+end

data/lib/tasks/reek.rake

@@ -0,0 +1,6 @@
+namespace :metrics do
+  desc "A code smell report using Reek"
+  task :reek do
+    MetricFu.generate_reek_report
+  end
+end

data/lib/tasks/roodi.rake

@@ -0,0 +1,7 @@
+namespace :metrics do
+
+  desc "A Ruby coding standards report using Roodi"
+  task :roodi do
+    MetricFu.generate_roodi_report
+  end
+end

data/lib/tasks/saikuro.rake

@@ -30,6 +30,6 @@ namespace :metrics do
          "#{SAIKURO_DIR}/index.html"
     end
 
-    system("open #{SAIKURO_DIR}/index.html") if PLATFORM['darwin']
+    system("open #{SAIKURO_DIR}/index.html") if MetricFu.open_in_browser?
   end
 end

data/lib/tasks/stats.rake

@@ -1,5 +1,4 @@
 namespace :metrics do
-
   STATS_DIR = File.join(MetricFu::BASE_DIRECTORY, 'stats')
   STATS_FILE = File.join(STATS_DIR, 'index.html')
 
@@ -9,6 +8,6 @@ namespace :metrics do
     `echo '<pre>' > #{STATS_FILE}`
     `rake stats >> #{STATS_FILE}`
     `echo '</pre>' >> #{STATS_FILE}`
-    system("open #{STATS_FILE}") if PLATFORM['darwin']
+    system("open #{STATS_FILE}") if MetricFu.open_in_browser?
   end
-end
+end if MetricFu::RAILS

data/lib/templates/churn.html.erb

@@ -2,18 +2,21 @@
 <head>
 	<title>Source Control Churn Results</title>
 	<style>
-	<%= open(File.join(MetricFu::TEMPLATE_DIR, "#{template_name}.css")) { |f| f.read } %>
+	<%= inline_css("default.css") %>
 	</style>
 </head>
 
 <body>
 	<h1>Source Control Churn Results</h1>
-	<table width="100%" border="1">
+	<p>Files that change a lot in your project may be bad a sign.
+	  This task uses your source control log to identify those files.
+	  </p>
+	<table>
 		<tr><th>File Path</th><th>Times Changed</th></tr>
 		<% @changes.to_a.sort {|x,y| y[1] <=> x[1]}.each do |change| %>
 		<tr><td><%= change[0] %></td><td class='warning'><%= change[1] %></td></tr>
 		<% end %>
-
 	</table>
+	<p>Generated on <%= Time.now.localtime %></p>
 </body>
-</html>
+</html>