indirect-metric_fu 0.8.1 → 0.8.2

data/lib/metric_fu/base.rb

@@ -0,0 +1,53 @@
+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
+
+  module Base
+    class Generator
+
+      def initialize(base_dir, options={})
+        @base_dir = base_dir
+      end
+
+      def self.generate_report(base_dir, options={})
+        self.new(base_dir, options).generate_report
+      end
+
+      def save_html(content, file='index')
+        open("#{@base_dir}/#{file}.html", "w") do |f|
+          f.puts content
+        end
+      end
+
+      def generate_report
+        save_html(generate_html)
+      end
+
+      def generate_html
+        analyze
+        html = ERB.new(File.read(template_file)).result(binding)
+      end
+
+      def template_file
+        File.join(MetricFu::TEMPLATE_DIR, "#{template_name}.html.erb")
+      end
+
+      def link_to_filename(name, line = nil)
+        filename = File.expand_path(name)
+        if PLATFORM['darwin']
+          %{<a href="txmt://open/?url=file://#{filename}&line=#{line}">#{name}</a>}
+        else
+          %{<a href="file://#{filename}">#{name}</a>}
+        end
+      end
+    end
+  end
+end

data/lib/metric_fu/churn.rb

@@ -1,127 +1,87 @@
 module MetricFu
-  class Churn
-    class << self
-      def generate_report(output_dir, options)
-        date_range, minimum_churn_count, source_control_type = churn_options(options)
-        
-        changes = parse_log_for_changes(source_control_type, date_range)
-        changes.reject! {|file, change_count| change_count < minimum_churn_count}
-        write_churn_file(changes, output_dir)
+  class Churn < Base::Generator
+
+    def initialize(base_dir, options={})
+      @base_dir = base_dir
+      if File.exist?(".git")
+        @source_control = Git.new(options[:start_date])
+      elsif File.exist?(".svn")
+        @source_control = Svn.new(options[:start_date])
+      else
+        raise "Churning requires a subversion or git repo"
+      end
+
+      @minimum_churn_count = options[:minimum_churn_count] || 5
+    end
+
+    def analyze
+      @changes = parse_log_for_changes.reject! {|file, change_count| change_count < @minimum_churn_count}
+    end
+
+    # should be dynamically read from the class
+    def template_name
+      'churn'
+    end
+
+    private
+
+    def parse_log_for_changes
+      changes = {}
+
+      logs = @source_control.get_logs
+      logs.each do |line|
+        changes[line] ? changes[line] += 1 : changes[line] = 1
       end
-      
+      changes
+    end
+
+
+    class SourceControl
+      def initialize(start_date=nil)
+        @start_date = start_date
+      end
+
       private
-      
-      def parse_log_for_changes(source_control_type, date_range)
-        changes = {}
-        
-        logs = get_logs(source_control_type, date_range)
-        logs.each do |line|
-          changes[line] ? changes[line] += 1 : changes[line] = 1 
+      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
+      def get_logs
+        `git log #{date_range} --name-only --pretty=format:`.split(/\n/).reject{|line| line == ""}
+      end
+
+      private
+      def date_range
+        if @start_date
+          require_rails_env
+          "--after=#{@start_date.call.strftime('%Y-%m-%d')}"
         end
-        
-        changes
       end
-      
-      def get_logs(source_control_type, date_range)
-        if source_control_type == :git
-          `git log #{date_range} --name-only --pretty=format:`.split(/\n/).reject{|line| line == ""}
-        else
-          `svn log #{date_range} --verbose`.split(/\n/).map { |line| clean_up_svn_line(line) }.compact
+
+    end
+
+    class Svn < SourceControl
+      def get_logs
+        `svn log #{date_range} --verbose`.split(/\n/).map { |line| clean_up_svn_line(line) }.compact
+      end
+
+      private
+      def date_range
+        if @start_date
+          require_rails_env
+          "--revision {#{@start_date.call.strftime('%Y-%m-%d')}}:{#{Time.now.strftime('%Y-%m-%d')}}"
         end
       end
-      
+
       def clean_up_svn_line(line)
         m = line.match(/\W*[A,M]\W+(\/.*)\b/)
         m ? m[1] : nil
       end
-      
-      def churn_options(options)
-        if File.exist?(".git")
-          scm = :git
-        elsif File.exist?(".svn")
-          scm = :svn
-        end
-        raise "Churning requires a subversion or git repo" unless scm
-
-        if options[:start_date]
-          require 'activesupport'
-          if scm == :git
-            date_range = "--after=#{options[:start_date].call.strftime('%Y-%m-%d')}"
-          else
-            date_range = "--revision {#{options[:start_date].call.strftime('%Y-%m-%d')}}:{#{Time.now.strftime('%Y-%m-%d')}}"
-          end
-        end
-
-        minimum_churn_count = options[:minimum_churn_count] ? options[:minimum_churn_count] : 5
-        return date_range, minimum_churn_count, scm
-      end
-      
-      def write_churn_file(changes, output_dir)
-        FileUtils.mkdir_p(output_dir, :verbose => false) unless File.directory?(output_dir)
-        File.open("#{output_dir}/index.html", "w+") do |file|
-          file << CHURN_FILE_BEGINING
-          changes.to_a.sort {|x,y| y[1] <=> x[1]}.each do |change|
-            file << "<tr><td>#{change[0]}</td><td class='warning'>#{change[1]}</td></tr>\n"
-          end
-          file << CHURN_FILE_END
-        end    
-      end
     end
-  
-    CHURN_FILE_BEGINING = <<-EOS
-    <html><head><title>Source Control Churn Results</title></head>
-    <style>
-    body {
-    	margin: 20px;
-    	padding: 0;
-    	font-size: 12px;
-    	font-family: bitstream vera sans, verdana, arial, sans serif;
-    	background-color: #efefef;
-    }
-
-    table {	
-    	border-collapse: collapse;
-    	/*border-spacing: 0;*/
-    	border: 1px solid #666;
-    	background-color: #fff;
-    	margin-bottom: 20px;
-    }
-
-    table, th, th+th, td, td+td  {
-    	border: 1px solid #ccc;
-    }
-
-    table th {
-    	font-size: 12px;
-    	color: #fc0;
-    	padding: 4px 0;
-    	background-color: #336;
-    }
-
-    th, td {
-    	padding: 4px 10px;
-    }
-
-    td {	
-    	font-size: 13px;
-    }
-
-    .warning {
-    	background-color: yellow;
-    }
-    </style>
-
-    <body>
-    <h1>Source Control Churn Results</h1>
-      <table width="100%" border="1">
-        <tr><th>File Path</th><th>Times Changed</th></tr>
-    EOS
-
-    CHURN_FILE_END = <<-EOS
-      </table>
-    </body>
-    </html>
-    EOS
-  
+
   end
 end

data/lib/metric_fu/flay_reporter.rb

@@ -0,0 +1,17 @@
+require 'erb'
+
+module MetricFu
+  class FlayReporter < Base::Generator
+
+    def analyze
+      files_to_flay = MetricFu::CODE_DIRS.map{|dir| Dir[File.join(dir, "**/*.rb")] }
+      output = `flay #{files_to_flay.join(" ")}`
+      @matches = output.chomp.split("\n\n").map{|m| m.split("\n  ") }
+    end
+
+    def template_name
+      'flay'
+    end
+
+  end
+end

data/lib/metric_fu/flog_reporter/base.rb

@@ -1,10 +1,10 @@
 module MetricFu::FlogReporter
-  
+
   SCORE_FORMAT = "%0.2f"
-  
+
   class InvalidFlog < RuntimeError
   end
-  
+
   class Base
     MODULE_NAME = "([A-Za-z]+)+"
     METHOD_NAME = "#([a-z0-9]+_?)+\\??\\!?"
@@ -12,7 +12,7 @@ module MetricFu::FlogReporter
 
     METHOD_NAME_RE = Regexp.new("#{MODULE_NAME}#{METHOD_NAME}")
     SCORE_RE = Regexp.new(SCORE)
-  
+
     METHOD_LINE_RE = Regexp.new("#{MODULE_NAME}#{METHOD_NAME}:\\s\\(#{SCORE}\\)")
     OPERATOR_LINE_RE = Regexp.new("\\s+(#{SCORE}):\\s(.*)$")
 
@@ -22,15 +22,6 @@ module MetricFu::FlogReporter
         return second_value
       end
 
-      def load_css(css_file = nil)
-        filepath = css_file || File.join(File.dirname(__FILE__), 'flog_reporter.css')
-        css = ""
-        file = File.open(filepath, "r")
-        file.each_line { |line| css << line }
-        file.close
-        css
-      end
-
       def parse(text)
         score = text[/\w+ = (\d+\.\d+)/, 1]
         return nil unless score
@@ -50,7 +41,7 @@ module MetricFu::FlogReporter
              page.scanned_methods.last.operators << Operator.new(score, operator)
           end
         end
-      
+
         page
       end
     end

data/lib/metric_fu/flog_reporter/generator.rb

@@ -1,71 +1,39 @@
 module MetricFu::FlogReporter
-  class Generator
-    class << self
-      def generate_report(base_dir)
-        flog_hashes = []
-        Dir.glob("#{base_dir}/**/*.txt").each do |filename|
-          content = ""
-          File.open(filename, "r").each_line do |file|
-            content << file
-          end
-
-          begin
-            page = Base.parse(content)
-          rescue InvalidFlog
-            puts "Invalid flog for #{filename}"
-            next
-          end
+  class Generator < MetricFu::Base::Generator
+    def generate_report
+      flog_hashes = []
+      Dir.glob("#{@base_dir}/**/*.txt").each do |filename|
+        begin
+          page = Base.parse(open(filename, "r") { |f| f.read })
+        rescue InvalidFlog
+          puts "Invalid flog for #{filename}"
+          next
+        end
 
-          next unless page
+        next unless page
 
-          if MetricFu::MD5Tracker.file_already_counted?(filename)            
-            flog_hashes << {
-              :page => page,
-              :path => filename.sub('.txt', '.html').sub("#{base_dir}/", "")
-            }
-          else  
-            flog_hashes << generate_page(filename, page, base_dir)
-          end
+        unless MetricFu::MD5Tracker.file_already_counted?(filename)
+          generate_page(filename, page)
         end
-        
-        generate_index(flog_hashes, base_dir)
-      end
-
-      def generate_page(filename, page, base_dir)
-        html_file = File.new(filename.gsub(/\.txt/, '.html'), "w")
-        html_file.puts page.to_html
-        html_file.close
-        return { :path => html_file.path.sub("#{base_dir}/", ''),
+        flog_hashes << { :path => File.basename(filename, ".txt") + '.html',
                  :page => page }
       end
 
-      def generate_index(flog_hashes, base_dir)
-        html = "<html><head><title>Flog Reporter</title><style>"
-        html << Base.load_css
-        html << "</style></head><body>"
-        html << "<p><strong>Flogged files</strong></p>\n"
-        html << "<p>Generated on #{Time.now.localtime} with <a href='http://ruby.sadi.st/Flog.html'>flog</a></p>\n"
-        html << "<table class='report'>\n"
-        html << "<tr><th>File</th><th>Total score</th><th>Methods</th><th>Average score</th><th>Highest score</th></tr>"
-        count = 0
-        flog_hashes.sort {|x,y| y[:page].highest_score <=> x[:page].highest_score }.each do |flog_hash|
-          html << <<-EOF
-                    <tr class='#{Base.cycle("light", "dark", count)}'>
-                      <td><a href='#{flog_hash[:path]}'>#{flog_hash[:path].sub('.html', '.rb')}</a></td>
-                      <td class='score'>#{sprintf(SCORE_FORMAT, flog_hash[:page].score)}</td>
-                      <td class='score'>#{flog_hash[:page].scanned_methods.length}</td>
-                      <td class='score'>#{sprintf(SCORE_FORMAT, flog_hash[:page].average_score)}</td>
-                      <td class='score'>#{sprintf(SCORE_FORMAT, flog_hash[:page].highest_score)}</td>
-                    </tr>
-                  EOF
-          count += 1
-        end
-        html << "</table>\n"
-        html << "</body></html>\n"
-        index = File.new("#{base_dir}/index.html", "w")
-        index.puts html
-        index.close
-      end
+      generate_index(flog_hashes)
+    end
+
+    def generate_page(filename, page)
+      save_html(page.to_html, File.basename(filename, ".txt"))
+    end
+
+    # should be dynamically read from the class
+    def template_name
+      'flog'
+    end
+
+    def generate_index(flog_hashes)
+      html = ERB.new(File.read(template_file)).result(binding)
+      save_html(html)
     end
   end
 end

data/lib/metric_fu/flog_reporter/operator.rb

@@ -1,7 +1,7 @@
 module MetricFu::FlogReporter
   class Operator
     attr_accessor :score, :operator
-    
+
     def initialize(score, operator)
       @score = score.to_f
       @operator = operator

data/lib/metric_fu/flog_reporter/page.rb

@@ -1,24 +1,16 @@
 module MetricFu::FlogReporter
-  class Page
+  class Page < MetricFu::Base::Generator
     attr_accessor :score, :scanned_methods
-    
+
     def initialize(score, scanned_methods = [])
       @score = score.to_f
       @scanned_methods = scanned_methods
     end
-    
+
     def to_html
-      output = "<html><head><style>"
-      output << Base.load_css
-      output << "</style></head><body>"
-      output << "Score: #{score}\n"
-      scanned_methods.each do |sm|
-        output << sm.to_html
-      end
-      output << "</body></html>"
-      output
+      ERB.new(File.read(template_file)).result(binding)
     end
-    
+
     def average_score
       sum = 0
       scanned_methods.each do |m|
@@ -26,11 +18,16 @@ module MetricFu::FlogReporter
       end
       sum / scanned_methods.length
     end
-    
+
     def highest_score
       scanned_methods.inject(0) do |highest, m|
         m.score > highest ? m.score : highest
       end
     end
+
+    # should be dynamically read from the class
+    def template_name
+      'flog_page'
+    end
   end
 end

data/lib/metric_fu/flog_reporter/scanned_method.rb

@@ -1,13 +1,13 @@
 module MetricFu::FlogReporter
   class ScannedMethod
     attr_accessor :name, :score, :operators
-    
+
     def initialize(name, score, operators = [])
       @name = name
       @score = score.to_f
       @operators = operators
     end
-    
+
     def to_html
       output = "<p><strong>#{name} (#{score})</strong></p>\n"
       output << "<table>\n"

data/lib/metric_fu/md5_tracker.rb

@@ -9,11 +9,11 @@ module MetricFu
     class << self
       def md5_dir(path_to_file, base_dir)
         File.join(base_dir,
-                  path_to_file.split('/')[0..-2].join('/'))        
+                  path_to_file.split('/')[0..-2].join('/'))
       end
 
       def md5_file(path_to_file, base_dir)
-        File.join(md5_dir(path_to_file, base_dir),    
+        File.join(md5_dir(path_to_file, base_dir),
                   path_to_file.split('/').last.sub(/\.[a-z]+/, '.md5'))
       end
 
@@ -25,7 +25,7 @@ module MetricFu
         f.close
         md5
       end
-      
+
       def file_changed?(path_to_file, base_dir)
         orig_md5_file = md5_file(path_to_file, base_dir)
         return !!track(path_to_file, base_dir) unless File.exist?(orig_md5_file)
@@ -35,7 +35,7 @@ module MetricFu
         file.each_line { |line| current_md5 << line }
         file.close
         current_md5.chomp!
-        
+
         new_md5 = Digest::MD5.hexdigest(File.read(path_to_file))
         new_md5.chomp!
 
@@ -43,7 +43,7 @@ module MetricFu
 
         return new_md5 != current_md5
       end
-  
+
       def file_already_counted?(path_to_file)
         return @@unchanged_md5s.include?(path_to_file)
       end

data/lib/metric_fu.rb

@@ -1,14 +1,3 @@
-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
-
+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 }

data/lib/tasks/churn.rake

@@ -1,7 +1,7 @@
 require File.join(File.dirname(__FILE__), '../metric_fu/churn')
 
 namespace :metrics do
-  
+
   desc "Which files change the most"
   task :churn do
     churn_dir = File.join(MetricFu::BASE_DIRECTORY, 'churn')

data/lib/tasks/coverage.rake

@@ -13,10 +13,11 @@ begin
 
     namespace :coverage do
       rcov_output = COVERAGE_DIR
-      
+
       desc "Delete aggregate coverage data."
       task(:clean) { rm_f("rcov_tmp", :verbose => false) }
-        
+
+      desc "RCov task to generate report"
       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']
@@ -27,10 +28,10 @@ begin
         t.rcov_dir = COVERAGE_DIR
       end
     end
-    
-    desc "Generate RCov report"
+
+    desc "Generate and open coverage report"
     task :coverage => ['coverage:do'] do
-      system("open #{SPEC_HTML_FILE}") if PLATFORM['darwin']
+      system("open #{COVERAGE_DIR}/index.html") if PLATFORM['darwin']
     end
   end
 rescue LoadError
@@ -38,5 +39,6 @@ rescue LoadError
     puts 'running in jruby - rcov tasks not available'
   else
     puts 'sudo gem install rcov # if you want the rcov tasks'
+
   end
 end

data/lib/tasks/flay.rake

@@ -0,0 +1,9 @@
+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']
+  end
+end

data/lib/tasks/flog.rake

@@ -10,40 +10,40 @@ begin
   end
 
   namespace :metrics do
-  
+
     task :flog => ['flog:all'] do
     end
-    
+
     namespace :flog do
       desc "Delete aggregate flog data."
       task(:clean) { rm_rf(FLOG_DIR, :verbose => false) }
-  
+
       desc "Flog code in app/models"
       task :models do
         flog "models", "app/models"
       end
 
-      desc "Flog code in app/controllers"  
+      desc "Flog code in app/controllers"
       task :controllers do
         flog "controllers", "app/controllers"
       end
 
-      desc "Flog code in app/helpers"  
+      desc "Flog code in app/helpers"
       task :helpers do
         flog "helpers", "app/helpers"
       end
 
-      desc "Flog code in lib"  
+      desc "Flog code in lib"
       task :lib do
         flog "lib", "lib"
-      end  
+      end
 
       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)
-      end      
-      
+      end
+
       desc "Generate and open flog report"
       if MetricFu::RAILS
         task :all => [:models, :controllers, :helpers, :lib] do
@@ -56,7 +56,7 @@ begin
           system("open #{FLOG_DIR}/index.html") if PLATFORM['darwin']
         end
       end
-      
+
     end
 
   end