continuous4r 0.0.1 → 0.0.2

data/lib/dcov_builder.rb

@@ -0,0 +1,144 @@
+require 'dcov'
+
+# ==========================================================================
+# Surcharge du module Dcov pour l'adapter aux besoins de continous4r
+# author: Vincent Dubois
+# date: 10 fevrier 2009
+# ==========================================================================
+module Dcov
+  # Generates HTML output
+  class Generator # < Ruport::Formatter::HTML
+    # renders :html, :for => StatsRenderer
+
+    include Dcov::StatsRenderer::Helpers
+
+    attr_reader :data
+    def initialize(data)
+      @data = data
+    end
+
+    def to_s
+      build_stats_header + build_stats_body + build_stats_footer
+    end
+
+    def build_stats_header
+      # Little CSS, a little HTML...
+      output = ""
+      output << """<h2>Dcov results</h2>\n\n<p><a href='http://dcov.rubyforge.org' target='_blank'>Dcov</a> is a documentation coverage analyzer for ruby.</p>"""
+    end
+
+    def build_stats_body
+      output = ""
+      output << "<h3>Summary</h3><p>\n"
+      output << "<table class='bodyTable' style='width: 200px;'><tr><th>Type</th><th>Coverage</th></tr>"
+      output << "<tr class='a'><td><b>Class</b></td><td style='text-align: right;'>#{class_coverage}%</td></tr>\n"
+      output << "<tr class='b'><td><b>Module</b></td><td style='text-align: right;'>#{module_coverage}%</td></tr>\n"
+      output << "<tr class='a'><td><b>Method</b></td><td style='text-align: right;'>#{method_coverage}%</td></tr></table>\n"
+      output << "</p>\n\n"
+
+      if data[:structured].length > 0
+        output << "<h3>Details</h3><p><table class='bodyTable'><tr><th>Class/Module name</th><th>Method name</th></tr>\n"
+      end
+      indice = 0
+      nbtr = 0
+      data[:structured].each do |key,value|
+        class_error_presence = (value[0].comment.nil? or value[0].comment == '') unless value[0].is_a?(Dcov::TopLevel)
+        method_error_presence = false
+        count_method_error_presence = 0
+        value[1].each do |itm|
+          method_error_presence = true if (itm.comment.nil? or itm.comment == '')
+          count_method_error_presence += 1 if (itm.comment.nil? or itm.comment == '')
+        end
+        if class_error_presence == true or method_error_presence == true
+          nbtr += 1
+          output << "<tr class='#{indice % 2 == 0 ? 'a' : 'b'}'>"
+          if class_error_presence == true or method_error_presence == true
+            output << "<td>#{"<b>" if class_error_presence == true}#{key.is_a?(String) ? key : key.full_name }#{"</b> in <a href='xdoclet/#{value[0].in_files.first.file_absolute_name.gsub(/\//,'_')}.html' target='_blank'>#{value[0].in_files.first.file_absolute_name}</a>" if class_error_presence == true}</td>"
+          else
+            output << "<td>&#160;</td>"
+          end
+          if count_method_error_presence == 1
+            value[1].each do |itm|
+              output << ((itm.comment.nil? || itm.comment == '') ? "<td><ol><li><b>#{itm.name}</b> in <a href='xdoclet/#{itm.token_stream.first.text.sub(/^# File /, '').sub(/, line (\d+)$/, '').gsub(/\//,'_')}.html##{itm.token_stream.first.text.sub(/^# File /, '').sub(/, line (\d+)$/, ':\1').split(/:/)[1]}' target='_blank'>#{itm.token_stream.first.text.sub(/^# File /, '').sub(/, line (\d+)$/, ':\1')}</a></b></li></ol></td>" : "")
+            end
+          elsif count_method_error_presence > 1
+            output << "<td><ol>"
+            value[1].each do |itm|
+              output << ((itm.comment.nil? || itm.comment == '') ? "<li><b>#{itm.name}</b> in <a href='xdoclet/#{itm.token_stream.first.text.sub(/^# File /, '').sub(/, line (\d+)$/, '').gsub(/\//,'_')}.html##{itm.token_stream.first.text.sub(/^# File /, '').sub(/, line (\d+)$/, ':\1').split(/:/)[1]}' target='_blank'>#{itm.token_stream.first.text.sub(/^# File /, '').sub(/, line (\d+)$/, ':\1')}</a></b></li>" : "")
+            end
+            output << "</ol></td>"
+          else
+            output << "<td>&#160;</td>"
+          end
+          if class_error_presence == true or method_error_presence == true
+            indice += 1
+            output << "</tr>"
+          end
+        end
+      end
+      if nbtr == 0
+        output << "<tr class='a'><td colspan='2'>There is no undocumented Ruby code.</td></tr>"
+      end
+      output << "</table>"
+      output
+    end
+
+    def build_stats_footer
+      output = ""
+      output << "</ol>\n\n</body></html>"
+    end
+
+  end
+
+  class Analyzer
+    def generate
+      print "Generating dcov report..."
+
+      generator = Dcov::Generator.new @stats.renderable_data
+      report = generator.to_s
+      print "done.\n"
+
+      print "Writing report..."
+      FileUtils.mkdir("#{Continuous4r::WORK_DIR}/dcov")
+      if (!File.exists?("#{Continuous4r::WORK_DIR}/dcov/coverage.html")) || (File.writable?("#{Continuous4r::WORK_DIR}/dcov/coverage.html"))
+        output_file = File.open("#{Continuous4r::WORK_DIR}/dcov/coverage.html", "w")
+        output_file.write report
+        output_file.close
+        print "done.\n"
+      else
+        raise "Can't write to [#{Continuous4r::WORK_DIR}/dcov/coverage.html]."
+      end
+    end
+  end
+end
+
+# ==========================================================================
+# Construction de la tache dcov (couverture rdoc)
+# author: Vincent Dubois
+# date: 06 fevrier 2009
+# ==========================================================================
+class DcovBuilder
+  include Utils
+
+  # Implementation de la construction de la tache
+  def build(project_name, auto_install, proxy_option)
+    # On verifie la presence de dcov
+    Utils.verify_gem_presence("dcov", auto_install, proxy_option)
+    # On lance la generation
+    puts " Building dcov rdoc coverage report..."
+    files = Array.new
+    files << Dir.glob("app/**/*.rb")
+    files << Dir.glob("lib/**/*.rb")
+    files.flatten!
+    options = {
+      :path => RAILS_ROOT,
+      :output_format => 'html',
+      :files => files
+    }
+    Dcov::Analyzer.new(options)
+    if !File.exist?("#{Continuous4r::WORK_DIR}/dcov/coverage.html")
+      raise " Execution of dcov failed.\n BUILD FAILED."
+    end
+  end
+end
+ 

data/lib/flay_builder.rb

@@ -0,0 +1,38 @@
+# ==========================================================================
+#  Construction de la tache flay (doublons dans du code ruby)
+#  author: Vincent Dubois
+#  date: 08 fevrier 2009
+# ==========================================================================
+class FlayBuilder
+  include Utils
+
+  # Implementation de la construction de la tache
+  def build(project_name, auto_install, proxy_option)
+    # On verifie la presence de flay
+    Utils.verify_gem_presence("flay", auto_install, proxy_option)
+    # On lance la generation (produite dans tmp/metric_fu/flay)
+    puts " Building flay report..."
+    ENV['HOME'] = ENV['USERPROFILE'] if Config::CONFIG['host_os'] =~ /mswin/ and ENV['HOME'].nil?
+    files = Array.new
+    files << Dir.glob("app/**/*.rb")
+    files << Dir.glob("lib/**/*.rb")
+    files << Dir.glob("test/**/*.rb")
+    files.flatten!
+    flay_command = "flay"
+    files.each do |file|
+      flay_command += " '#{file}'"
+    end
+    flay_result = Utils.run_command(flay_command)
+    matches = flay_result.chomp.split("\n\n").map{|m| m.split("\n  ") }
+    FileUtils.mkdir("#{Continuous4r::WORK_DIR}/flay")
+    flay_file = File.open("#{Continuous4r::WORK_DIR}/flay/index.html","w")
+    matches.each_with_index do |match, count|
+      flay_file.write("<tr class='#{count % 2 == 0 ? "a" : "b"}'><td>")
+      match[1..-1].each do |filename|
+        flay_file.write("<a href='xdoclet/#{filename.split(":")[0].gsub(/\//,'_')}.html##{filename.split(":")[1]}' target='_blank'>#{filename}</a><br/>")
+      end
+      flay_file.write("</td><td>#{match.first}</td></tr>")
+    end
+    flay_file.close
+  end
+end

data/lib/flog_builder.rb

@@ -0,0 +1,120 @@
+# ==========================================================================
+#  Construction de la tache flog (complexite du code ruby)
+#  Code inspired by the metric_fu gem by Jake Scruggs
+#  author: Vincent Dubois
+#  date: 06 fevrier 2009
+# ==========================================================================
+class FlogBuilder
+  include Utils
+
+  class Page
+    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(File.join(File.dirname(__FILE__), "site/flog_page.html.erb"))).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
+
+  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
+
+  METHOD_LINE_REGEX = /([A-Za-z]+#.*):\s\((\d+\.\d+)\)/
+  OPERATOR_LINE_REGEX = /\s+(\d+\.\d+):\s(.*)$/
+
+  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
+
+  def save_html(content, file='index.html')
+    f = File.open("#{Continuous4r::WORK_DIR}/flog/#{file}", "w")
+    f.write(content)
+    f.close
+  end
+
+  # Implementation de la construction de la tache
+  def build(project_name, auto_install, proxy_option)
+    # On verifie la presence de flog
+    Utils.verify_gem_presence("flog", auto_install, proxy_option)
+    # On lance la generation
+    puts " Building flog report..."
+    FileUtils.mkdir("#{Continuous4r::WORK_DIR}/flog")
+    files = Array.new
+    files << Dir.glob("app/**/*.rb")
+    files << Dir.glob("lib/**/*.rb")
+    files << Dir.glob("test/**/*.rb")
+    files.flatten!
+    files.each do |filename|
+      puts "Processing #{filename}..."
+      output_dir = "#{Continuous4r::WORK_DIR}/flog/#{filename.split("/")[0..-2].join("/")}"
+      FileUtils.mkdir_p(output_dir, :verbose => false) unless File.directory?(output_dir)
+      Utils.run_command("flog #{filename} > #{Continuous4r::WORK_DIR}/flog/#{filename.split('.')[0]}.txt")
+    end
+    pages = Array.new
+    Dir.glob("#{Continuous4r::WORK_DIR}/flog/**/*.txt").each do |filename|
+      page = parse(File.read(filename))
+      if page
+        page.filename = filename
+        pages << page
+      end
+    end
+    pages.each do |page|
+      save_html(page.to_html, page.path)
+    end
+    save_html(ERB.new(File.read(File.join(File.dirname(__FILE__), "site/flog.html.erb"))).result(binding))
+  end
+end

data/lib/git_extractor.rb

@@ -0,0 +1,48 @@
+# ====================================================
+# Classe d'extraction des informations de Git
+# Author: Vincent Dubois
+# Date: 19 fevrier 2009
+# ====================================================
+module GitExtractor
+
+  # Methode qui permet de fabriquer le flux HTML a partir des informations
+  # presentes dans le referentiel
+  def self.extract_changelog scm_current_version, file_name
+    git_revisions = Utils.run_command("git log").split(/$/).select{ |l| l =~ /^commit / }.collect { |l| l[8..(l.length-1)] }
+    revision = git_revisions[0]
+    begin
+      git_url = File.read(".git/config").split(/$/).select {|l| l =~ /url = /}[0].split(/url = /)[1]
+      puts " Computing changelog for #{git_url}..."
+    rescue
+      puts " Computing changelog, from commit #{scm_current_version} to revision #{revision}..."
+    end
+    i = 0
+    html = "<table class='bodyTable'><thead><th>Commit</th><th>Date</th><th>Author</th><th>File(s)</th><th>Comment</th></thead><tbody>"
+    commits = Utils.run_command("git log --name-status").split(/^commit/)
+    commits.delete_at(0)
+    commits.each_with_index do |commit, index|
+      commit_details = commit.split(/$/)
+      puts " Changelog for commit #{commit_details[0].strip}..."
+      html = html + "<tr class='#{ index % 2 == 0 ? 'a' : 'b'}'><td><strong>#{commit_details[0].strip}</strong></td>"
+      html = html + "<td>#{commit_details[2].strip.split(/Date:   /)[1]}</td><td>#{commit_details[1].strip.split(/Author: /)[1]}</td><td>"
+      (6..(commit_details.length - 3)).to_a.each do |file_detail|
+        file_status = "added"
+        if commit_details[file_detail].strip.at(0) == 'A'
+          file_status = "added"
+        elsif commit_details[file_detail].strip.at(0) == 'M'
+          file_status = "modified"
+        elsif commit_details[file_detail].strip.at(0) == 'D'
+          file_status = "deleted"
+        end
+        html = html + "<img src='images/#{file_status}.png' align='absmiddle'/>&#160;#{commit_details[file_detail].strip.split(Regexp.new("\t"))[1]}<br/>"
+      end
+      html = html + "</td><td>#{commit_details[4].strip}</td></tr>"
+    end
+    html = html + "</tbody></table>"
+    changelog_file = File.open(file_name,"w")
+    changelog_file.write(html)
+    changelog_file.close
+    return revision
+  end
+
+end

data/lib/rcov_builder.rb

@@ -0,0 +1,23 @@
+# ==========================================================================
+#  Construction de la tache rcov (couverture des tests sur le code)
+#  author: Vincent Dubois
+#  date: 06 fevrier 2009
+# ==========================================================================
+class RcovBuilder
+  include Utils
+
+  # Implementation de la construction de la tache
+  def build(project_name, auto_install, proxy_option)
+      # On verifie la presence de rcov
+      Utils.verify_gem_presence("rcov", auto_install, proxy_option)
+      # On lance la generation
+      puts " Building rcov code coverage report..."
+      rcov_pass = Utils.run_command("rcov --rails --exclude rcov,rubyforge,builder,mime-types,xml-simple test/rcov*.rb")
+      if rcov_pass.index("Finished in").nil?
+        raise " Execution of rcov failed with command 'rcov --rails --exclude rcov,rubyforge test/rcov*.rb'.\n BUILD FAILED."
+      end
+      # On recupere le rapport genere
+      Dir.mkdir "#{Continuous4r::WORK_DIR}/rcov"
+      FileUtils.mv("coverage", "#{Continuous4r::WORK_DIR}/rcov/")
+  end
+end

data/lib/rdoc_builder.rb

@@ -0,0 +1,33 @@
+# ==========================================================================
+#  Construction de la tache rdoc (apidoc)
+#  author: Vincent Dubois
+#  date: 06 fevrier 2009
+# ==========================================================================
+class RdocBuilder
+  include Utils
+
+  # Implementation de la construction de la tache
+  def build(project_name, auto_install, proxy_option)
+    # On lance la generation
+    puts " Building rdoc api and rdoc generation report..."
+    if !File.exist?("#{RAILS_ROOT}/doc")
+      FileUtils.mkdir("#{RAILS_ROOT}/doc")
+    end
+    if !File.exist?("#{RAILS_ROOT}/doc/README_FOR_APP")
+      if File.exist?("#{RAILS_ROOT}/README")
+        FileUtils.copy_file("#{RAILS_ROOT}/README", "#{RAILS_ROOT}/doc/README_FOR_APP")
+      else
+        FileUtils.touch("#{RAILS_ROOT}/doc/README_FOR_APP")
+      end
+    end
+    File.delete("rdoc.log") if File.exist?("rdoc.log")
+    rdoc_pass = system("rake doc:app > rdoc.log")
+    if !rdoc_pass
+      raise " Execution of rdoc failed with command 'rake doc:reapp'.\n BUILD FAILED."
+    end
+    # On recupere la documentation et le fichier de log generes
+    Dir.mkdir "#{Continuous4r::WORK_DIR}/rdoc"
+    FileUtils.mv("doc/app/", "#{Continuous4r::WORK_DIR}/rdoc/")
+    FileUtils.mv("rdoc.log", "#{Continuous4r::WORK_DIR}/rdoc/")
+  end
+end

data/lib/reek_builder.rb

@@ -0,0 +1,38 @@
+# ==========================================================================
+#  Construction de la tache reek (imperfections dans le code Ruby)
+#  author: Vincent Dubois
+#  date: 08 fevrier 2009
+# ==========================================================================
+class ReekBuilder
+  include Utils
+
+  # Implementation de la construction de la tache
+  def build(project_name, auto_install, proxy_option)
+    # On verifie la presence de reek
+    Utils.verify_gem_presence("reek", auto_install, proxy_option)
+    # On lance la generation
+    puts " Building reek report..."
+    files = Array.new
+    files << Dir.glob("app/**/*.rb")
+    files << Dir.glob("lib/**/*.rb")
+    files << Dir.glob("test/**/*.rb")
+    files.flatten!
+    reek_command = "reek"
+    files.each do |file|
+      reek_command += " '#{file}'"
+    end
+    reek_result = Utils.run_command(reek_command)
+    matches = reek_result.chomp.split("\n\n").map{|m| m.split("\n") }
+    FileUtils.mkdir("#{Continuous4r::WORK_DIR}/reek")
+    reek_file = File.open("#{Continuous4r::WORK_DIR}/reek/index.html","w")
+    matches.each_with_index do |match, count|
+      reek_file.write("<tr class='#{count % 2 == 0 ? "a" : "b"}'>")
+      reek_file.write("<td><a href='xdoclet/#{match.first.split("\"")[1].gsub(/\//,'_')}.html' target='_blank'>#{match.first.split("\"")[1]}</a> #{match.first.split("\"")[2]}</td><td>")
+      match[1..-1].each do |filename|
+        reek_file.write("#{filename}<br/>")
+      end
+      reek_file.write("</td></tr>")
+    end
+    reek_file.close
+  end
+end