kwala 0.9.0

data/lib/kwala/actions/flagged_comments.rb

@@ -0,0 +1,128 @@
+# $Id: flagged_comments.rb 32 2008-04-02 07:50:18Z zev $
+#
+# This file implements the logic to scan for special comments in
+# a source base.
+
+# Copyright (c) 2006, Ubiquitous Business Technology (http://ubit.com)
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#
+#    * Redistributions of source code must retain the above copyright
+#      notice, this list of conditions and the following disclaimer.
+#
+#    * Redistributions in binary form must reproduce the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer in the documentation and/or other materials provided
+#      with the distribution.
+#
+#    * Neither the name of Ubit nor the names of its
+#      contributors may be used to endorse or promote products derived
+#      from this software without specific prior written permission.
+#
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# == Author
+# Zev Blut (zb@ubit.com)
+
+
+class FlaggedCommentsAction < BuildAction
+  COMMENTFLAGS = [ "BUG", "FIXME", "???", "TODO", "XXX" ]
+  COMMENTREGEXP = Regexp.new("\#\s*(" +
+                               COMMENTFLAGS.map { |i| Regexp.escape(i)}.join("|") +
+                               ")\s*:?(.*)")
+
+  def initialize
+    @comment_count = Hash.new { |h,k| h[k] = Array.new }
+  end
+
+  def build_action(context)
+    projbase = context.project_directory.split("/").last
+    (context.ruby_files + context.test_files).each do |file|
+      fcount = collect_comments_from_file(file)
+      fcount.each do |cflag, val|
+        fnamemap = val.map do |idx, txt|
+          nfile = file.split(context.project_directory).last
+          ["#{ projbase }/#{ nfile }\##{ idx }" , txt]
+        end
+        @comment_count[cflag].concat( fnamemap )
+      end
+    end
+  end
+
+  def summary_display(context)
+    template = TemplateFile.new(self.class.summary_template_file)
+
+    ares = COMMENTFLAGS.map do |ctype|
+      { :type => ctype,
+        :count => @comment_count[ctype].size
+      }
+    end
+
+    context.amrita_data[:com_results] = { :entry => ares }
+    loc_base = "#{context.project_name}_com.html"
+    context.amrita_data[:com_details] =
+     (Amrita::e(:a, :href => loc_base) { "Flagged Comments Details" } )
+
+    summary_expand(template, context)
+  end
+
+  def detailed_display(context)
+    template = TemplateFile.new(self.class.detailed_template_file)
+
+
+    ares = COMMENTFLAGS.map do |ctype|
+      { :type => ctype,
+        :count => @comment_count[ctype].size,
+        :entries => @comment_count[ctype].map do |file, txt|
+          {
+            :file => Amrita::e(:a, :href => link_to_file(file)) { file },
+            :txt => txt
+          }
+        end
+      }
+    end
+
+    context.amrita_data[:com_details] = { :entry => ares }
+    det_res = ProjectBuilderUtils.expand_template(template, context.amrita_data)
+    det_file = "#{context.output_directory}/#{context.project_name}_com.html"
+    [det_file, det_res]
+  end
+
+
+  def collect_comments_from_file(file)
+    res = Hash.new { |h,k| h[k] = Array.new }
+    IO.readlines(file).each_with_index do |line, idx|
+      if m = COMMENTREGEXP.match(line)
+        res[m[1]]<< [idx + 1 , m[2]]
+      end
+    end
+    res
+  end
+
+  #annotate does the line numbering and pointing
+  def link_to_file(file)
+    file, line = file.split("#")
+    view_url = annotate_url +
+      file.to_s + "?annotate=HEAD\#" + line.to_s
+  end
+
+  def annotate_url
+    "http://localhost/cgi-bin/viewcvs/cgi/viewcvs.cgi/"
+  end
+
+end

data/lib/kwala/actions/gem_plugin.rb

@@ -0,0 +1,31 @@
+# This is a base action that all external plugins (i.e. gems)
+# should subclass
+
+# How would I test this?
+class GemPluginAction < BuildAction
+  
+  
+  # For now I assume that the gem's templates are in the same directory as the action file
+  def self.summary_template_file
+    "#{File.dirname(__FILE__)}/#{command_line_action_name}_summary.html"
+  end
+
+  def self.detailed_template_file
+    "#{File.dirname(__FILE__)}/#{command_line_action_name}_detailed.html"
+  end
+
+  def self.load_external_gems
+    require 'rubygems'
+    # Here we do stuff with the gem api to find all external gems that require kwala.
+    # We will assume that they are actions and require them
+    # Thanks to Chad Fowler for this bit of code
+    Gem.cache.search(//).select do |specification|
+      specification.dependencies.map{ |dep| dep.name }.include('kwala')
+    end.each do |depname|
+      require depname.name
+    end
+  end
+
+end
+
+GemPluginAction.load_external_gems

data/lib/kwala/actions/loc_count.rb

@@ -0,0 +1,153 @@
+# $Id: loc_count.rb 29 2008-04-02 07:32:44Z zev $
+#
+# This file implements the logic to count the lines of code in
+# a source base.
+
+# Copyright (c) 2006, Ubiquitous Business Technology (http://ubit.com)
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#
+#    * Redistributions of source code must retain the above copyright
+#      notice, this list of conditions and the following disclaimer.
+#
+#    * Redistributions in binary form must reproduce the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer in the documentation and/or other materials provided
+#      with the distribution.
+#
+#    * Neither the name of Ubit nor the names of its
+#      contributors may be used to endorse or promote products derived
+#      from this software without specific prior written permission.
+#
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# == Author
+# Zev Blut (zb@ubit.com)
+
+module LOCCountModule
+  def count_loc(file)
+    code = comments = blank = 0
+    inside_embedded_doc = false
+
+    IO.readlines(file).each do |line|
+      if line =~ /\s*#/
+        #ignore comments
+        comments += 1
+      elsif line =~ /^=begin/
+        inside_embedded_doc = true
+        comments += 1
+      elsif line =~ /^=end/
+        inside_embedded_doc = false
+        comments += 1
+      elsif inside_embedded_doc
+        comments += 1
+      elsif line =~ /^\s*$/
+        #blank space to ignore
+        blank += 1
+      else
+        code+= 1
+      end
+    end
+
+    [code, comments, blank]
+  end
+end
+
+
+class LocCountAction < BuildAction
+  include LOCCountModule
+
+  TOTAL = "TOTAL_LOC"
+  PROD_CODE = "TOTAL_PRODUCTION_LOC"
+  TEST_CODE = "TOTAL_TEST_LOC"
+
+  def initialize
+    @file_loc = Hash.new { |h, k| h[k] = Array.new }
+  end
+
+  def build_action(context)
+
+    (context.ruby_files + context.test_files).each do |file|
+      @file_loc[file] = count_loc(file)
+    end
+
+    @file_loc[TOTAL] = sum_count(@file_loc.keys)
+    @file_loc[PROD_CODE] = sum_count(context.ruby_files)
+    @file_loc[TEST_CODE] = sum_count(context.test_files)
+  end
+
+  def summary_display(context)
+    template = TemplateFile.new(self.class.summary_template_file)
+
+    ares = [ ["Total", @file_loc[TOTAL]],
+    ["Production Code", @file_loc[PROD_CODE]],
+    ["Test Code", @file_loc[TEST_CODE]] ].map do |ctype, cdata|
+      code, comments, blank, files = *cdata
+      ttl = code + comments + blank
+      { :type => ctype, :total => ttl,
+        :code => code, :code_per => percent(code, ttl),
+        :comments => comments, :comments_per => percent(comments, ttl),
+        :blank => blank, :blank_per => percent(blank, ttl) ,
+        :files => files
+      }
+    end
+
+    context.amrita_data[:loc_results] = { :entry => ares }
+    loc_base = "#{context.project_name}_loc.html"
+    context.amrita_data[:loc_details] =
+     (Amrita::e(:a, :href => loc_base) { "Lines of Code Details" } )
+
+    summary_expand(template, context)
+  end
+
+  def detailed_display(context)
+    template = TemplateFile.new(self.class.detailed_template_file)
+
+    ares = (@file_loc.keys - [TOTAL, PROD_CODE, TEST_CODE]).sort.map do |file|
+      code, comments, blank = *(@file_loc[file])
+      ttl = code + comments + blank
+      { :file => file, :total => ttl,
+        :code => code, :code_per => percent(code, ttl),
+        :comments => comments, :comments_per => percent(comments, ttl),
+        :blank => blank, :blank_per => percent(blank, ttl) }
+    end
+
+    context.amrita_data[:loc_details] = { :entry => ares }
+    det_res = ProjectBuilderUtils.expand_template(template, context.amrita_data)
+    det_file = "#{context.output_directory}/#{context.project_name}_loc.html"
+    [det_file, det_res]
+  end
+
+  def percent(val, total)
+    sprintf("%.2f%",  (val.to_f / total) * 100)
+  end
+
+  def sum_count(files)
+    code = comments = blank = 0
+
+    files.each do |file|
+      fcode, fcomments, fblank = *( @file_loc[file] )
+      code += fcode
+      comments += fcomments
+      blank += fblank
+    end
+
+    [code, comments, blank, files.size]
+  end
+
+end

data/lib/kwala/actions/multi_ruby_unit_test.rb

@@ -0,0 +1,62 @@
+require "#{File.dirname(__FILE__)}/unit_test"
+
+# requires multiruby, part of ZenTest: http://www.zenspider.com/ZSS/Products/ZenTest/
+class MultiRubyUnitTestBuildAction < UnitTestBuildAction
+
+  MULTIRUBY = '/usr/local/bin/multiruby'
+  SITE_RUBY = '/usr/local/lib/ruby/site_ruby/1.8'
+
+  def self.summary_template_file
+    superclass.summary_template_file
+  end
+
+  def self.detailed_template_file
+    superclass.detailed_template_file
+  end
+
+  #################
+  # Protected
+
+  def ruby_version
+    return @ruby_version if defined? @ruby_version
+    version = `#{MULTIRUBY} -v`
+    @ruby_version = version.scan(/VERSION = ([\.0-9]*)/).join(', ')
+  end
+
+  def ruby_command_line(pre_requires, file)
+    req_cmd = "-I#{SITE_RUBY} -I#{SITE_RUBY}/i686-linux/"
+    if pre_requires
+      req_cmd << " -r #{pre_requires}"
+    end
+    "#{MULTIRUBY} #{req_cmd} #{file}"
+  end
+
+  def parse_test_results(data, file)
+    version_reg = /([0-9\.]*)#{RES_REGEXP}/im
+    version_array = data.split('VERSION = ').map{|s| s.match(version_reg)}.compact
+    if version_array.empty?
+      [no_match_result(data, file)]
+    else
+      version_array.map do |m|
+        {
+          :file_name => file,
+          :version_name => m[1],
+          :time => m[3],
+          :tests => m[5],
+          :assertions => m[6],
+          :failures => template_error_num(m[7]),
+          :errors => template_error_num(m[8]),
+          :test_results => parse_out_test_info(m[4]).map {|i| {:test_info => i}}
+        }
+      end
+    end
+  end
+
+  alias :old_time_out_readlines :time_out_readlines
+
+  def time_out_readlines(io)
+    # We give it a minute and a half now
+    old_time_out_readlines(io, 90)
+  end
+
+end

data/lib/kwala/actions/outside_links.rb

@@ -0,0 +1,85 @@
+# $Id: outside_links.rb 34 2008-04-03 06:01:19Z zev $
+#
+# This file implements an action that creates links to reports
+# not generated by the project builder
+
+# Copyright (c) 2006, Ubiquitous Business Technology (http://ubit.com)
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#
+#    * Redistributions of source code must retain the above copyright
+#      notice, this list of conditions and the following disclaimer.
+#
+#    * Redistributions in binary form must reproduce the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer in the documentation and/or other materials provided
+#      with the distribution.
+#
+#    * Neither the name of Ubit nor the names of its
+#      contributors may be used to endorse or promote products derived
+#      from this software without specific prior written permission.
+#
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# == Author
+# Zev Blut (zb@ubit.com)
+
+class OutsideLinksAction < BuildAction
+  BASE_URL = ""
+
+  def initialize
+    no_http = Proc.new do |link, project_name|
+      "#{BASE_URL}/#{link}/#{project_name}/"
+    end
+    http = Proc.new do |link, project_name|
+      "#{link}/#{project_name}/"
+    end
+
+    @links = [
+      ["rdocs", "Documentation", no_http],
+      ["statcvs_output", "StatCVS", no_http],
+      ["http://localhost/viewvc", "ViewVC", http],
+      ["http://localhost/pragprog/data/rss", "CVS Commit RSS",
+        Proc.new { |link, project_name|  "#{link}/#{project_name}.rss" }
+      ]
+    ]
+  end
+
+  def build_action(context)
+    #Do nothing
+  end
+
+  def summary_display(context)
+    template = TemplateFile.new(self.class.summary_template_file)
+    context.amrita_data[:outside_links] = @links.map do |link, lname, action|
+      {
+        :item => Amrita::e(:h3) do
+          url = action.call(link, context.project_name)
+          Amrita::e(:a, :href => url) { lname }
+        end
+      }
+    end
+
+    summary_expand(template, context)
+  end
+
+  def self.detailed_template_file
+    nil
+  end
+
+end