metric_fu 2.1.1 → 2.1.3.4

data/home_page/styles.css

@@ -0,0 +1,245 @@
+/*
+Design by Metamorphosis Design
+http://www.metamorphozis.com
+Released for free under a Creative Commons Attribution 2.5 License
+*/
+
+a:link {
+	color: #3886E0;
+}
+
+a:hover, {
+	text-decoration: underline;
+	color: #FF0000;
+}
+
+a:visited {
+	color: #3886E0;
+}
+
+*
+{
+border: 0;
+margin: 0;
+}
+
+body
+{
+	background: #ffffff url(back_all.jpg) repeat-x top;
+	font: 12px Tahoma, Arial, Helvetica, sans-serif;
+	color: #666666;
+	margin-top: 10px;
+}
+
+#main
+{
+margin: 0 auto;
+width: 912px;
+background: url(table_back.jpg) repeat-y;
+}
+
+#header
+{
+background: url(header.jpg) no-repeat;
+width: 912px;
+height: 262px;
+}
+
+#logo
+{
+padding-left: 40px;
+text-align: left;
+padding-top: 40px;
+height: 40px;
+}
+
+#logo a {
+	text-decoration: none;
+	text-transform: lowercase;
+	font-style: italic;
+	font-size: 16px;
+	color: #000000;
+	font-weight: bold;
+}
+
+
+#logo H2 a
+{
+font-size: 10px;
+}
+
+#buttons
+{
+padding-top: 140px;
+height: 40px;
+padding-left: 120px;
+}
+
+#buttons li {
+	display: inline;
+	display: block;
+	float: left;
+	height: 30px;
+	margin-left: 1px;
+	text-align: center;
+	text-decoration: none;
+	color: #000000;
+	font-weight: bold;
+	font-size: 16px;
+	padding-top: 10px;
+}
+
+#buttons a {
+	display: block;
+	float: left;
+	width: 120px;
+	height: 30px;
+	margin-left: 1px;
+	text-align: center;
+	text-decoration: none;
+	color: #000000;
+	font-weight: bold;
+	font-size: 16px;
+	padding-top: 10px;
+
+}
+
+#buttons a:hover {
+	text-decoration: underline;
+	color: #FF0000;
+}
+
+#content
+{
+width: 870px;
+padding: 15px;
+}
+
+#left
+{
+width: 580px;
+padding: 10px;
+}
+
+#left H1
+{
+color: #99A067;
+margin: 0;
+padding: 0;
+font-size: 24px;
+}
+#left H2
+{
+color: #99A067;
+margin: 0;
+padding: 0;
+font-size: 18px;
+padding-top: 10px;
+}
+
+#left a
+{
+ color: #99A067;
+}
+
+#left a:hover, {
+	text-decoration: none;
+	color: #FF0000;
+}
+
+#left a:visited {
+	color: #99A067;
+}
+
+.small
+{
+margin: 15px;
+padding: 5px;
+border: 1px solid #99A067
+}
+
+#right
+{
+float: right;
+width: 254px;
+}
+
+#sidebar 
+{
+width: 254px;
+}
+
+#sidebar ul 
+{
+	margin: 0;
+	padding: 0;
+	list-style: none;
+	background: url(title_back.gif) no-repeat;
+}
+
+#sidebar li 
+{
+	margin-bottom: 15px;
+
+}
+
+#sidebar li ul {
+	padding: 10px;
+	border-top: none;
+}
+
+#sidebar li li {
+	margin: 0;
+	padding: 3px 0;
+}
+
+
+#sidebar li h2 {
+	height: 34px;
+	margin: 0;
+	padding: 10px 0 0 20px;
+	background: #ffffff url(title.gif) no-repeat;
+	font-size: 18px;
+	color: #000000;
+}
+
+#sidebar a:link {
+	text-decoration: none;
+}
+
+#sidebar a:hover {
+	text-decoration: underline;
+}
+#sidebar a:visited {
+		text-decoration: none;
+}
+
+#sidebar li a {
+	padding-left: 10px;
+	background: url(img09.gif) no-repeat 1px 5px;
+}
+
+
+#footer
+{
+	background: url(footer.gif) repeat-x;
+	height: 52px;
+	font-size: 10px;
+	color: #99A067;
+	padding-top: 20px;
+	text-align: center;
+	border-top: #99A067 solid 5px;
+}
+
+#footer a
+{
+color: #99A067;
+font-size: 10px;
+text-decoration: none;
+}
+.padding
+{
+padding: 10px;
+color:#FF0000;
+font-weight: bold;
+}

data/lib/{base/configuration.rb → configuration.rb}

@@ -1,3 +1,5 @@
+require 'fileutils'
+MetricFu.reporting_require { 'templates/awesome/awesome_template' }
 module MetricFu
 
   # A list of metrics which are available in the MetricFu system.
@@ -5,13 +7,24 @@ module MetricFu
   # These are metrics which have been developed for the system.  Of
   # course, in order to use these metrics, their respective gems must
   # be installed on the system.
-  AVAILABLE_METRICS = [:churn, :flog, :flay, :reek,
-                       :roodi, :rcov,
-                      :hotspots]
-
-  AVAILABLE_METRICS << :saikuro unless RUBY_VERSION == '1.9.2'
-
-  AVAILABLE_GRAPHS = [:flog, :flay, :reek, :roodi, :rcov, :rails_best_practices]
+  AVAILABLE_METRICS = [:churn,
+                      :flog,
+                      :flay,
+                      :reek,
+                      :roodi,
+                      :rcov,
+                      :hotspots,
+                      :saikuro
+  ]
+
+  AVAILABLE_GRAPHS = [
+    :flog,
+    :flay,
+    :reek,
+    :roodi,
+    :rcov,
+    :rails_best_practices
+  ]
   AVAILABLE_GRAPH_ENGINES = [:gchart, :bluff]
 
   # The @@configuration class variable holds a global type configuration
@@ -99,13 +112,19 @@ module MetricFu
     # This does the real work of the Configuration class, by setting
     # up a bunch of instance variables to represent the configuration
     # of the MetricFu app.
+    # TODO review if these code is functionally duplicated in the
+    # base generator initialize
     def reset
-      @base_directory = ENV['CC_BUILD_ARTIFACTS'] || 'tmp/metric_fu'
-      @scratch_directory = File.join(@base_directory, 'scratch')
-      @output_directory = File.join(@base_directory, 'output')
-      @data_directory = File.join('tmp/metric_fu', '_data')
-      @metric_fu_root_directory = File.join(File.dirname(__FILE__),
-                                                        '..', '..')
+      @base_directory    = MetricFu.artifact_dir
+      @scratch_directory = MetricFu.scratch_dir
+      @output_directory  = MetricFu.output_dir
+      @data_directory    = MetricFu.data_dir
+      # due to behavior differences between ruby 1.8.7 and 1.9.3
+      # this is good enough for now
+      [@base_directory, @scratch_directory, @output_directory].each do |dir|
+        FileUtils.mkdir_p dir
+      end
+      @metric_fu_root_directory = MetricFu.root_dir
       @template_directory =  File.join(@metric_fu_root_directory,
                                        'lib', 'templates')
       @template_class = AwesomeTemplate
@@ -120,7 +139,7 @@ module MetricFu
                     :config_file_pattern => nil}
       @roodi    = { :dirs_to_roodi => @code_dirs,
                     :roodi_config => nil}
-      @saikuro  = { :output_directory => @scratch_directory + '/saikuro',
+      @saikuro  = { :output_directory => "#{@scratch_directory}/saikuro",
                     :input_directory => @code_dirs,
                     :cyclo => "",
                     :filter_cyclo => "0",
@@ -131,6 +150,7 @@ module MetricFu
       @stats    = {}
       @rcov     = { :environment => 'test',
                     :test_files => ['test/**/*_test.rb',
+                                    'spec/spec_helper.rb', # NOTE: ensure it is loaded before the specs
                                     'spec/**/*_spec.rb'],
                     :rcov_opts => ["--sort coverage",
                                    "--no-html",
@@ -144,12 +164,15 @@ module MetricFu
       @rails_best_practices = {}
       @hotspots = {}
       @file_globs_to_ignore = []
+      @link_prefix = nil
+
 
       @verbose = false
 
       @graph_engine = :bluff # can be :bluff or :gchart
 
-      @darwin_txmt_protocol_no_thanks = false
+      @darwin_txmt_protocol_no_thanks = true
+      # uses the CodeRay gem (was syntax gem)
       @syntax_highlighting = true #Can be set to false to avoid UTF-8 issues with Ruby 1.9.2 and Syntax 1.0
     end
 
@@ -165,7 +188,10 @@ module MetricFu
     # running within rails.
     def set_metrics
       if rails?
-        @metrics = MetricFu::AVAILABLE_METRICS + [:stats, :rails_best_practices]
+        @metrics = MetricFu::AVAILABLE_METRICS + [
+          :stats,
+          :rails_best_practices
+        ]
       else
         @metrics = MetricFu::AVAILABLE_METRICS
       end
@@ -173,7 +199,9 @@ module MetricFu
 
     def set_graphs
       if rails?
-        @graphs = MetricFu::AVAILABLE_GRAPHS + [:stats]
+        @graphs = MetricFu::AVAILABLE_GRAPHS + [
+          :stats
+        ]
       else
         @graphs = MetricFu::AVAILABLE_GRAPHS
       end

data/lib/data_structures/careful_array.rb

@@ -0,0 +1,9 @@
+module CarefulArray
+
+  def carefully_remove(elements)
+    missing_elements = elements - self
+    raise "Cannot delete missing elements: #{missing_elements.inspect}" unless missing_elements.empty?
+    (self - elements).extend(CarefulArray)
+  end
+
+end

data/lib/{base → data_structures}/code_issue.rb

@@ -1,26 +1,27 @@
 require 'delegate'
-require MetricFu::LIB_ROOT + '/base/metric_analyzer'
-require MetricFu::LIB_ROOT + '/base/flog_analyzer'
-require MetricFu::LIB_ROOT + '/base/saikuro_analyzer'
-require MetricFu::LIB_ROOT + '/base/churn_analyzer'
-require MetricFu::LIB_ROOT + '/base/reek_analyzer'
-require MetricFu::LIB_ROOT + '/base/flay_analyzer'
-
-module CarefulArray
-
-  def carefully_remove(elements)
-    missing_elements = elements - self
-    raise "Cannot delete missing elements: #{missing_elements.inspect}" unless missing_elements.empty?
-    (self - elements).extend(CarefulArray)
-  end
 
+[ 'metric_analyzer',
+  'flog/flog_analyzer',
+  'saikuro/saikuro_analyzer',
+  'churn/churn_analyzer',
+  'reek/reek_analyzer',
+  'flay/flay_analyzer'].each do |path|
+  MetricFu.metrics_require { path }
 end
+MetricFu.data_structures_require { 'careful_array' }
 
-class CodeIssue < DelegateClass(Record) #DelegateClass(Ruport::Data::Record)
+class CodeIssue < DelegateClass(MetricFu::Record) #DelegateClass(Ruport::Data::Record)
   include Comparable
 
   # TODO: Yuck! 'stat_value' is a column for StatAnalyzer
-  EXCLUDED_COLUMNS = FlogAnalyzer::COLUMNS + SaikuroAnalyzer::COLUMNS + ['stat_value'] + ChurnAnalyzer::COLUMNS + ReekAnalyzer.new.columns.extend(CarefulArray).carefully_remove(['reek__type_name', 'reek__comparable_message']) + FlayAnalyzer.new.columns.extend(CarefulArray).carefully_remove(['flay_matching_reason'])
+  EXCLUDED_COLUMNS =
+    FlogAnalyzer::COLUMNS +
+    SaikuroAnalyzer::COLUMNS +
+    ['stat_value'] +
+    ChurnAnalyzer::COLUMNS +
+    ReekAnalyzer.new.columns.extend(CarefulArray).carefully_remove(['reek__type_name',
+    'reek__comparable_message']) +
+    FlayAnalyzer.new.columns.extend(CarefulArray).carefully_remove(['flay_matching_reason'])
 
   def <=>(other)
     spaceship_for_columns(self.attributes, other)

data/lib/data_structures/grouping.rb

@@ -0,0 +1,40 @@
+%w(table).each do |path|
+  MetricFu.data_structures_require { path }
+end
+module MetricFu
+  class Grouping
+
+    def initialize(table, opts)
+      column_name = opts.fetch(:by)
+      order = opts.fetch(:order) { nil }
+      hash = {}
+      if column_name.to_sym == :metric # special optimized case
+        hash = table.group_by_metric
+      else
+        table.each do |row|
+          hash[row[column_name]] ||= Table.new(:column_names => row.attributes)
+          hash[row[column_name]] << row
+        end
+      end
+      if order
+        @arr = hash.sort_by &order
+      else
+        @arr = hash.to_a
+      end
+    end
+
+    def [](key)
+      @arr.each do |group_key, table|
+        return table if group_key == key
+      end
+      return nil
+    end
+
+    def each
+      @arr.each do |value, rows|
+        yield value, rows
+      end
+    end
+
+  end
+end