iain-metric_fu 0.1.0

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/base_template.rb

@@ -0,0 +1,146 @@
+module MetricFu
+
+  # The Template class is intended as an abstract class for concrete
+  # template classes to subclass.  It provides a variety of utility
+  # methods to make templating a bit easier.  However, classes do not
+  # have to inherit from here in order to provide a template.  The only
+  # requirement for a template class is that it provides a #write method
+  # to actually write out the template.  See StandardTemplate for an
+  # example.
+  class Template
+    attr_accessor :report
+    
+    private
+    # Creates a new erb evaluated result from the passed in section.
+    #
+    # @param section String
+    #   The section name of 
+    #
+    # @return String
+    #   The erb evaluated string
+    def erbify(section)
+      require 'erb'
+      erb_doc = File.read(template(section))
+      ERB.new(erb_doc).result(binding)
+    end
+
+    # Determines whether a template file exists for a given section
+    # of the full template.
+    #
+    # @param section String
+    #   The section of the template to check against
+    #
+    # @return Boolean
+    #   Does a template file exist for this section or not?
+    def template_exists?(section)
+      File.exist?(template(section))
+    end
+    
+    # Copies an instance variable mimicing the name of the section
+    # we are trying to render, with a value equal to the passed in 
+    # constant.  Allows the concrete template classes to refer to 
+    # that instance variable from their ERB rendering
+    #
+    # @param section String
+    #  The name of the instance variable to create
+    #
+    # @param contents Object
+    #   The value to set as the value of the created instance
+    #   variable
+    def create_instance_var(section, contents)
+      instance_variable_set("@#{section}", contents)        
+    end
+
+    # Generates the filename of the template file to load and 
+    # evaluate.  In this case, the path to the template directory +
+    # the section name + .html.erb
+    #
+    # @param section String
+    #   A section of the template to render
+    #
+    # @return String
+    #   A file path
+    def template(section)
+      File.join(this_directory,  section.to_s + ".html.erb")
+    end
+
+    # Returns the filename that the template will render into for
+    # a given section.  In this case, the section name + '.html'
+    #
+    # @param section String
+    #   A section of the template to render
+    #
+    # @return String
+    #   The output filename
+    def output_filename(section)
+      section.to_s + ".html"
+    end
+
+    # Returns the contents of a given css file in order to 
+    # render it inline into a template.
+    #
+    # @param css String
+    #   The name of a css file to open
+    #
+    # @return String
+    #   The contents of the css file
+    def inline_css(css)
+      open(File.join(this_directory, css)) { |f| f.read }      
+    end
+  
+    # Provides a link to open a file through the textmate protocol
+    # on Darwin, or otherwise, a simple file link.
+    #
+    # @param name String
+    #   
+    # @param line Integer
+    #   The line number to link to, if textmate is available.  Defaults
+    #   to nil
+    #
+    # @return String
+    #   An anchor link to a textmate reference or a file reference
+    def link_to_filename(name, line = nil, link_content = nil)
+      "<a href='#{file_url(name, line)}'>#{link_content(name, line, link_content)}</a>"
+    end
+    
+    def link_content(name, line=nil, link_content=nil) # :nodoc:
+      if link_content
+        link_content
+      elsif line
+        "#{name}:#{line}"
+      else
+        name
+      end
+    end
+    
+    def file_url(name, line) # :nodoc:
+      filename = File.expand_path(name.gsub(/^\//, ''))
+      if MetricFu.configuration.platform.include?('darwin')
+        "txmt://open/?url=file://#{filename}" << (line ? "&line=#{line}" : "")
+      else 
+       "file://#{filename}"
+      end
+    end
+
+    # Provides a brain dead way to cycle between two values during
+    # an iteration of some sort.  Pass in the first_value, the second_value,
+    # and the cardinality of the iteration.
+    #
+    # @param first_value Object
+    #
+    # @param second_value Object
+    #
+    # @param iteration Integer
+    #   The number of times through the iteration.
+    #
+    # @return Object
+    #   The first_value if iteration is even.  The second_value if
+    #   iteration is odd.
+    def cycle(first_value, second_value, iteration)
+      return first_value if iteration % 2 == 0
+      return second_value
+    end      
+    
+
+  end
+end

data/lib/base/configuration.rb

@@ -0,0 +1,187 @@
+module MetricFu
+
+  # A list of metrics which are available in the MetricFu system.
+  #
+  # 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, :saikuro, :rcov]
+
+  AVAILABLE_GRAPHS = [:flog, :flay, :reek, :roodi, :rcov, :stats]
+
+  # The @@configuration class variable holds a global type configuration
+  # object for any parts of the system to use.
+  def self.configuration
+    @@configuration ||= Configuration.new
+  end
+
+  # = Configuration
+  #
+  # The Configuration class, as it sounds, provides methods for
+  # configuring the behaviour of MetricFu.
+  #
+  # == Customization for Rails
+  #
+  # The Configuration class checks for the presence of a
+  # 'config/environment.rb' file.  If the file is present, it assumes
+  # it is running in a Rails project.  If it is, it will:
+  #
+  # * Add 'app' to the @code_dirs directory to include the
+  #   code in the app directory in the processing
+  # * Add :stats to the list of metrics to run to get the Rails stats
+  #   task
+  #
+  # == Customization for CruiseControl.rb
+  #
+  # The Configuration class checks for the presence of a 
+  # 'CC_BUILD_ARTIFACTS' environment variable.  If it's found
+  # it will change the default output directory from the default
+  # "tmp/metric_fu to the directory represented by 'CC_BUILD_ARTIFACTS'
+  #
+  # == Deprications
+  #
+  # The Configuration class checks for several deprecated constants
+  # that were previously used to configure MetricFu.  These include
+  # CHURN_OPTIONS, DIRECTORIES_TO_FLOG, SAIKURO_OPTIONS, 
+  # and MetricFu::SAIKURO_OPTIONS.
+  #
+  # These have been replaced by config.churn, config.flog and
+  # config.saikuro respectively.
+  class Configuration
+
+    def initialize #:nodoc:#
+      reset
+      add_attr_accessors_to_self
+      add_class_methods_to_metric_fu
+    end
+  
+    # Searches through the instance variables of the class and
+    # creates a class method on the MetricFu module to read the value
+    # of the instance variable from the Configuration class.
+    def add_class_methods_to_metric_fu
+      instance_variables.each do |name|
+        method_name = name[1..-1].to_sym
+        method = <<-EOF
+                  def self.#{method_name}
+                    configuration.send(:#{method_name})
+                  end
+        EOF
+        MetricFu.module_eval(method)
+      end
+    end
+   
+    # Searches through the instance variables of the class and creates
+    # an attribute accessor on this instance of the Configuration 
+    # class for each instance variable.
+    def add_attr_accessors_to_self
+      instance_variables.each do |name|
+        method_name = name[1..-1].to_sym
+        MetricFu::Configuration.send(:attr_accessor, method_name)
+      end
+    end
+
+    # This allows us to have a nice syntax like:
+    #
+    #   MetricFu.run do |config|
+    #     config.base_directory = 'tmp/metric_fu'
+    #   end
+    #
+    # See the README for more information on configuration options.
+    def self.run
+      yield MetricFu.configuration
+    end
+   
+    # 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.
+    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__), 
+                                                        '..', '..')
+      @template_directory =  File.join(@metric_fu_root_directory, 
+                                       'lib', 'templates') 
+      @template_class = AwesomeTemplate
+      set_metrics
+      set_graphs
+      set_code_dirs
+      @flay     = { :dirs_to_flay => @code_dirs  } 
+      @flog     = { :dirs_to_flog => @code_dirs  }
+      @reek     = { :dirs_to_reek => @code_dirs  }
+      @roodi    = { :dirs_to_roodi => @code_dirs }
+      @saikuro  = { :output_directory => @scratch_directory + '/saikuro', 
+                    :input_directory => @code_dirs,
+                    :cyclo => "",
+                    :filter_cyclo => "0",
+                    :warn_cyclo => "5",
+                    :error_cyclo => "7",
+                    :formater => "text"}
+      @churn    = {}
+      @stats    = {}
+      @rcov     = { :test_files => ['test/**/*_test.rb', 
+                                    'spec/**/*_spec.rb'],
+                    :rcov_opts => ["--sort coverage", 
+                                   "--no-html", 
+                                   "--text-coverage",
+                                   "--no-color",
+                                   "--profile",
+                                   "--rails",
+                                   "--exclude /gems/,/Library/,/usr/,spec"]}
+                                   
+      @graph_theme = { :colors => %w(orange purple green teal red blue pink yellow black),
+                       :marker_color => 'blue',
+                       :background_colors => %w(white white)}
+      
+      relative_font_path = [File.dirname(__FILE__), '..', '..', 'vendor', '_fonts', 'monaco.ttf']
+      @graph_font = File.expand_path(File.join(relative_font_path))
+      @graph_size = "1000x400"
+      @graph_title_font_size = 12
+      @graph_legend_box_size = 12
+      @graph_legend_font_size = 10
+      @graph_marker_font_size = 10
+      
+    end
+
+    # Perform a simple check to try and guess if we're running
+    # against a rails app.
+    #
+    # @todo  This should probably be made a bit more robust.
+    def rails?
+      @rails = File.exist?("config/environment.rb")
+    end
+
+    # Add the :stats task to the AVAILABLE_METRICS constant if we're
+    # running within rails.
+    def set_metrics
+      if rails?
+        @metrics = MetricFu::AVAILABLE_METRICS + [:stats]
+      else
+        @metrics = MetricFu::AVAILABLE_METRICS
+      end 
+    end
+    
+    def set_graphs
+      @graphs = MetricFu::AVAILABLE_GRAPHS 
+    end
+
+    # Add the 'app' directory if we're running within rails.
+    def set_code_dirs
+      if rails?
+        @code_dirs = ['app', 'lib']
+      else
+        @code_dirs = ['lib']
+      end
+    end
+    
+    def platform #:nodoc:
+      return RUBY_PLATFORM
+    end
+    
+    def is_cruise_control_rb?
+      !!ENV['CC_BUILD_ARTIFACTS']
+    end
+  end
+end