kwala 0.9.0

data/lib/kwala/actions/cycle_detection.rb

@@ -0,0 +1,118 @@
+# $Id: cycle_detection.rb 32 2008-04-02 07:50:18Z zev $
+#
+# Implements a Ruby require cycle detection and graphing action.
+
+# 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)
+
+require 'stringio'
+
+require "#{LIB_DIR}/cycle_detector"
+
+class CycleDetectionAction < BuildAction
+
+  def initialize
+    @cycle_detector = CycleDetector.new
+    @cycle_detector.print_strategy = self
+    @output_directory = nil
+    @cycles = nil
+  end
+
+  def build_action(context)
+    # convert obj?
+    @cycle_detector.make_graph(context.project_directory)
+  end
+
+
+  def summary_display(context)
+    template = TemplateFile.new(self.class.summary_template_file)
+    @cycle_detector.print_unique_cycles( @cycle_detector.find_cycles )
+
+    if @cycles.empty?
+      context.amrita_data[:cycle_results] = "There are no require cycles."
+    else
+      data = @cycles.map do |cycle|
+        {
+          :name => "#{ cycle.first} <=> #{ cycle.last }",
+          :list => cycle
+        }
+      end
+      context.amrita_data[:cycle_results] = { :entry => data  }
+    end
+
+
+    loc_base = "#{context.project_name}_cycle.html"
+    context.amrita_data[:cycle_details] =
+      Amrita.e(:a, :href => loc_base ) { "Require Graph Details" }
+
+    summary_expand(template, context)
+  end
+
+  def detailed_display(context)
+    template = TemplateFile.new(self.class.detailed_template_file)
+
+    @output_directory = context.output_directory
+    @cycle_detector.print_graph
+
+    ["demos.jar", "prefuse.jar"].each do |jarfile|
+      FileUtils.cp(EXTERNAL_DIR + jarfile, context.output_directory)
+    end
+
+    det_res = ProjectBuilderUtils.expand_template(template, context.amrita_data)
+    det_file = "#{context.output_directory}/#{context.project_name}_cycle.html"
+    [det_file, det_res]
+  end
+
+
+  def print_graph(graph)
+    graph_ml = CycleDetector::GraphMLPrintStrategy.new
+    begin
+      oldstd = $stdout
+      $stdout = StringIO.new
+      graph_ml.print_graph(graph)
+      gxml = $stdout.string
+    ensure
+      $stdout = oldstd
+    end
+    # now dump that into the out dir
+    File.open(@output_directory + "/require_graph.xml", "w") { |f| f.puts gxml }
+  end
+
+  def print_cycles(cycles)
+    @cycles = cycles
+  end
+
+end

data/lib/kwala/actions/cyclomatic_complexity.rb

@@ -0,0 +1,159 @@
+# $Id: cyclomatic_complexity.rb 34 2008-04-03 06:01:19Z zev $
+#
+# This file checks the cyclomatic complexity of a source base.
+#
+# Uses Saikuro http://saikuro.rubyforge.org
+
+# 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 CyclomaticComplexityAction < BuildAction
+
+  def initialize
+    @limit = 11 # 1 more for header
+    @cyclo_count = nil
+    @bound = 0 # This should be methods instead of files.
+  end
+
+  def build_action(context)
+    args = [ "-o #{context.output_directory}" ]
+    args << [ "-c -t"]
+    args << [ "-y 0 -w 11 -e 15"]
+    args << [ "-k 0 -s 30 -d 35"]
+    args << [ "-i #{context.project_directory}" ]
+
+    stdout_data = stderr_data = Array.new
+    system("/usr/bin/env saikuro #{args.join(" ")}")
+    @cyclo_count = get_cyclo_violations(context)
+    @bound = context.ruby_files.size + context.test_files.size
+  end
+
+  def summary_display(context)
+    template = TemplateFile.new(self.class.summary_template_file)
+    context.amrita_data[:saikuro_metrics_summary] = {
+      :cyclo_summary => get_cyclo_summary(context),
+      :token_summary => get_token_summary(context),
+      :cyclo_violations => get_cyclo_violations(context),
+      :token_violations => get_token_violations(context),
+      :cyclo_link => Amrita::e(:a, :href => "index_cyclo.html") { "Cyclomatic Complexity Details" },
+      :token_link => Amrita::e(:a, :href => "index_token.html") { "Token Count Details" }
+    }
+    summary_expand(template, context)
+  end
+
+  def score
+    # high complexity is probably one of the things that should weigh higher.
+    score_scaling(( @cyclo_count[:errors] * 3 + @cyclo_count[:warnings]), @bound)
+  end
+
+  def self.detailed_template_file
+    nil
+  end
+
+  def get_cyclo_summary(context)
+    get_summary_from_file(context.output_directory + "/index_cyclo.html")
+  end
+
+  def get_token_summary(context)
+    get_summary_from_file(context.output_directory + "/index_token.html")
+  end
+
+  def get_cyclo_violations(context)
+    count_violations(context.output_directory + "/index_cyclo.html")
+  end
+
+  def get_token_violations(context)
+    count_violations(context.output_directory + "/index_token.html")
+  end
+
+  def get_summary_from_file(file)
+    if !File.exists?(file)
+      STDERR.puts "Saikuro : Cannot find #{file}"
+      return ""
+    end
+    data = IO.readlines(file).join
+    res = ""
+    if m = /(<table.*?>)(.*)(<\/table>)/mi.match(data)
+      head = m[1]
+      data = m[2]
+      tail = m[3]
+      rows = Array.new
+      while rows.size < @limit && m = /(<tr>.*?<\/tr>)(.*)/mi.match(data)
+        rows << m[1]
+        data = m[2]
+      end
+
+      res = head.to_s + rows.join("\n") + tail.to_s
+    end
+
+    SanitizedString.new(res)
+  end
+
+
+  # XXX: This is basically the same as get_summary_from_file, there
+  # should be a nice way to reuse the logic in a more clean way.
+  def count_violations(file)
+    if !File.exists?(file)
+      return 0
+    end
+
+    data = IO.readlines(file).join
+    errors = 0
+    warnings = 0
+
+    if m = /(<table.*?>)(.*)(<\/table>)/mi.match(data)
+      data = m[2]
+      while m = /(<tr>.*?<\/tr>)(.*)/mi.match(data)
+        if /^<tr><th>/ !~ m[1]
+          # Make sure not to count the header row.
+          if /class=\"error\"/ =~ m[1]
+            errors += 1
+          elsif /class=\"warning\"/ =~ m[1]
+            warnings += 1
+          end
+        end
+        data = m[2]
+      end
+    end
+
+    {
+      :total => errors + warnings,
+      :errors => errors,
+      :warnings => warnings
+    }
+  end
+
+end

data/lib/kwala/actions/dead_code.rb

@@ -0,0 +1,68 @@
+# $Id$
+#
+# This file handles logic for dead code checking
+
+# 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 ()
+
+class DeadCodeAction < BuildAction
+
+  def initialize
+  end
+
+  def build_action(context)
+  end
+
+  def summary_display(context)
+    template = TemplateFile.new("#{TEMPLATE_DIR}/dead_code_template.html")
+    summary_expand(template, context)
+  end
+
+  def detailed_display(context)
+    context.amrita_data[:syntax_results] = {
+      :entry => @syntax_results
+    }
+    det_res = expand_syntax_check_template(context.amrita_data[:syntax_results])
+    det_file = "#{context.output_directory}/#{context.project_name}_dead_code.html"
+    [det_file, det_res]
+  end
+
+  def score
+    10
+  end
+  
+  
+  
+end

data/lib/kwala/actions/executable_files_check.rb

@@ -0,0 +1,111 @@
+# $Id: executable_files_check.rb 29 2008-04-02 07:32:44Z zev $
+#
+# This action checks for the code size within ruby scripts starting with
+# a shell bang. By our convention, we want to keep those files as small
+# as possible, all logic should be in reusable classes.
+
+# 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
+# Michael Reinsch (mr@ubit.com)
+
+require File.dirname(__FILE__) + "/loc_count.rb"
+
+class ExecutableFilesCheckAction < BuildAction
+  include LOCCountModule
+
+  def initialize
+    @problem_files = Array.new
+    @shellbang_files_LOC = Hash.new
+  end
+
+  def build_action(context)
+    context.ruby_files.each do |f|
+      exec = File.executable?(f)
+      bang = ("#!/" == IO.read(f, 3, 0))
+      if exec ^ bang
+        if exec
+          prob = "executable, no shell bang"
+        else
+          prob = "shell bang, not executable"
+        end
+        @problem_files << { :filename => f, :problem => prob }
+      end
+      @shellbang_files_LOC[f] = count_loc(f) if bang
+    end
+    @sorted_shellbang_files_LOC = @shellbang_files_LOC.sort {|a,b| b[1] <=> a[1] }
+  end
+
+  def summary_display(context)
+    template = TemplateFile.new(self.class.summary_template_file)
+
+    res = {}
+    if @problem_files.size > 0
+      res[:problem_files] = { :files => @problem_files }
+    end
+
+    # get top 10
+    top_ten_files = @sorted_shellbang_files_LOC[0..9]
+    res[:files] = top_ten_files.map do |f, l|
+      { :filename => f, :lines_of_code => l }
+    end
+
+    context.amrita_data[:executable_files_check_results] = res
+    execfilecodesize_base = "#{context.project_name}_executable_files_check.html"
+    context.amrita_data[:executable_files_check_details] =
+      (Amrita::e(:a, :href => execfilecodesize_base) { "Executable Files Check Details" } )
+
+    summary_expand(template, context)
+  end
+
+  def detailed_display(context)
+    template = TemplateFile.new(self.class.detailed_template_file)
+
+    res = {}
+    if @problem_files.size > 0
+      res[:problem_files] = { :files => @problem_files }
+    end
+
+    res[:files] = @sorted_shellbang_files_LOC.map do |f, l|
+      { :filename => f, :lines_of_code => l }
+    end
+
+    context.amrita_data[:executable_files_check_results] = res
+
+    det_res = ProjectBuilderUtils.expand_template(template, context.amrita_data)
+    det_file = "#{context.output_directory}/#{context.project_name}_executable_files_check.html"
+    [det_file, det_res]
+  end
+
+end