khall-metric_fu 1.0.2.1

data/HISTORY

@@ -0,0 +1,119 @@
+=== MetricFu 1.0.2 / 2009-5-11
+
+* Fixing problems with Reek new line character (thanks to all who pointed this out)
+* Flog now recognizes namespaces in method names thanks to Daniel Guettler
+* Saikuro now looks at multiple directories, again.
+
+=== MetricFu 1.0.1 / 2009-5-3
+
+* metrics:all task no longer requires a MetricFu::Configuration.run {} if you want to accept the defaults
+* rcov task now reports total coverage percent
+
+=== MetricFu 1.0.0 / 2009-4-30
+
+* Merged in Grant McInnes' work on creating yaml output for all metrics to aid harvesting by other tools
+* Supporting Flog 2.1.0
+* Supporting Reek 1.0.0
+* Removed dependency on Rails Env for 3.months.ago (for churn report), now using chronic gem ("3 months ago").
+* Almost all code is out of Rakefiles now and so is more easily testable
+* Metrics inherit from a refactored Generator now.  New metrics generators just have to implement "emit", "analyze", "to_h" and inherit from Generator.  They also must have a template.  See the flay generator and template for a simple implementation.
+* You now define the metrics you wish to run in the configuration and then run "metrics:all".  No other metrics task is exposed by default.
+
+=== MetricFu 0.9.0 / 2009-1-25
+
+* Adding line numbers to the views so that people viewing it on cc.rb can figure out where the problems are
+* Merging in changes from Jay Zeschin having to do with the railroad task -- I still have no idea how to use it (lemme know if you figure it out)
+* Added totals to Flog results
+* Moved rcov options to configuration
+
+=== MetricFu 0.8.9 / 2009-1-20
+
+* Thanks to Andre Arko and Petrik de Heus for adding the following features:
+* The source control type is auto-detected for Churn
+* Moved all presentation to templates
+* Wrote specs for all classes
+* Added flay, Reek and Roodi metrics
+* There's now a configuration class (see README for details)
+* Unification of metrics reports
+* Metrics can be generated using one command
+* Adding new metrics reports has been standardized
+
+=== MetricFu 0.8.0 / 2008-10-06
+
+* Source Control Churn now supports git (thanks to Erik St Martin)
+* Flog Results are sorted by Highest Flog Score
+* Fix for a bunch of 'already initialized constant' warnings that metric_fu caused
+* Fixing bug so the flog reporter can handle methods with digits in the name (thanks to Andy Gregorowicz)
+* Internal Rake task now allows metric_fu to flog/churn itself
+
+=== MetricFu 0.7.6 / 2008-09-15
+
+* CHURN_OPTIONS has become MetricFu::CHURN_OPTIONS
+* SAIKURO_OPTIONS has become MetricFu::SAIKURO_OPTIONS
+* Rcov now looks at test and specs
+* Exclude gems and Library ruby code from rcov
+* Fixed bug with churn start_date functionality (bad path)
+
+=== MetricFu 0.7.5 / 2008-09-12
+
+* Flog can now flog any set of directories you like (see README).
+* Saikuro can now look at any set of directories you like (see README).
+
+=== MetricFu 0.7.1 / 2008-09-12
+
+* Fixed filename bugs pointed out by Bastien
+
+=== MetricFu 0.7.0 / 2008-09-11
+
+* Merged in Sean Soper's changes to metric_fu.  
+* Metric_fu is now a gem.
+* Flogging now uses a MD5 hash to figure out if it should re-flog a file (if it's changed)
+* Flogging also has a cool new output screen(s)
+* Thanks Sean!
+
+    === Metricks 0.4.2 / 2008-07-01
+
+    * Changed rcov output directory so that it is no longer 'coverage/unit' but just 'coverage' for better integration with CC.rb
+
+    === Metricks 0.4.1 / 2008-06-13
+
+    * Rcov tests now extend beyond one level depth directory by using RcovTask instead of the shell
+
+    === Metricks 0.4.0 / 2008-06-13
+
+    * Implementing functionality for use as a gem
+    * Added Rakefile to facilitate testing
+
+    === Metricks 0.3.0 / 2008-06-11
+
+    * Generated reports now open on darwin automatically
+    * Generated reports reside under tmp/metricks unless otherwise specified by ENV['CC_BUILD_ARTIFACTS']
+    * MD5Tracker works with Flog reports for speed optimization
+
+    === Metricks 0.2.0 / 2008-06-11
+
+    * Integrated use of base directory constant
+    * Have all reports automatically open in a browser if platform is darwin
+    * Namespaced under Metricks
+    * Dropped use of shell md5 command in favor of Ruby's Digest::MD5 libraries
+
+    === Metricks 0.1.0 / 2008-06-10
+
+    * Initial integration of metric_fu and my enhancements to flog
+    * Metrics are generated but are all over the place  
+
+=== MetricFu 0.6.0 / 2008-05-11
+
+* Add source control churn report
+
+=== MetricFu 0.5.1 / 2008-04-25
+
+* Fixed bug with Saikuro report generation
+
+=== MetricFu 0.5.0 / 2008-04-25
+
+* create MetricFu as a Rails Plugin
+* Add Flog Report
+* Add Coverage Report
+* Add Saikuro Report
+* Add Stats Report

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2008,2009 Jake Scruggs
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,25 @@
+History.txt
+Manifest.txt
+metric_fu-0.7.gem
+metric_fu.gemspec
+MIT-LICENSE
+Rakefile
+README
+TODO.txt
+lib/metric_fu.rb
+lib/metric_fu/base.rb
+lib/metric_fu/churn.rb
+lib/metric_fu/flay_reporter.rb
+lib/metric_fu/flog_reporter.rb
+lib/metric_fu/md5_tracker.rb
+lib/metric_fu/saikuro/saikuro.rb
+lib/metric_fu/saikuro/SAIKURO_README
+lib/tasks/churn.rake
+lib/tasks/coverage.rake
+lib/tasks/flog.rake
+lib/tasks/metric_fu.rake
+lib/tasks/metric_fu.rb
+lib/tasks/saikuro.rake
+lib/tasks/stats.rake
+test/test_helper.rb
+test/test_md5_tracker.rb

data/README

@@ -0,0 +1 @@
+See http://metric-fu.rubyforge.org/ for documentation, or the HISTORY file for a change log.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+require 'lib/metric_fu'
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+   t.rcov = true
+   t.rcov_opts = ['--exclude', 'spec,config,Library,usr/lib/ruby']
+   t.rcov_dir = File.join(File.dirname(__FILE__), "tmp")
+end
+
+MetricFu::Configuration.run do |config|
+end
+
+namespace :metrics do
+  desc "Generate all reports"
+  task :all do
+    MetricFu.metrics.each {|metric| MetricFu.report.add(metric) }
+    MetricFu.report.save_output(MetricFu.report.to_yaml,
+                                MetricFu.base_directory, 
+                                'report.yml')
+    MetricFu.report.save_templatized_report
+    if MetricFu.report.open_in_browser?
+      MetricFu.report.show_in_browser(MetricFu.output_directory)
+    end
+  end
+
+  MetricFu.metrics.each do |metric|
+    desc "Generate report for #{metric}"
+    task metric do
+
+      MetricFu.report.add(metric)
+      MetricFu.report.save_output(MetricFu.report.to_yaml,
+                                  MetricFu.base_directory,
+                                  'report.yml')
+      MetricFu.report.save_templatized_report
+      if MetricFu.report.open_in_browser?
+        MetricFu.report.show_in_browser(MetricFu.output_directory)
+      end
+    end
+  end
+end
+
+task :default => [:"metrics:all"]

data/TODO

@@ -0,0 +1,14 @@
+== TODO list
+
+* Color code flog results with scale from: http://jakescruggs.blogspot.com/2008/08/whats-good-flog-score.html
+* Extract functionality from rake files and put under test
+* Integrate Flog, Saikuro, and Coverage into one report so you can see methods that have high complexity and low coverage (this is a big one)
+* Integrate MD5 hashing with remainder of reports
+* Move HTML out of code and into templates/
+* Replace #generate_report with #new on each metric class
+* Make each class descend from MetricFu::CodeMetric
+* Generate metrics:* rake tasks for each of CodeMetric's descendants
+* Update flog specs so that they actually run flog
+* Add flay specs that run flay
+* Convert readme to markdown and rename to README.mkdn so github will render it
+* Saikuro.rb falls over if tries to parse an empty file.  Fair enough.  We shouldn't feed it empty files

data/lib/base/base_template.rb

@@ -0,0 +1,134 @@
+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)
+      filename = File.expand_path(name)
+      if MetricFu.configuration.platform.include?('darwin')
+        "<a href='txmt://open/?url=file://" \
+        +"#{filename}&line=#{line}'>#{name}:#{line}</a>"
+      else 
+       "<a href='file://#{filename}'>#{name}:#{line}</a>"
+      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]
+
+
+  # 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:#
+      warn_about_deprecated_config_options
+      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
+
+    # Check if certain constants that are deprecated have been
+    # assigned.  If so, warn the user about them, and the 
+    # fact that they will have no effect.
+    def warn_about_deprecated_config_options
+      if defined?(::MetricFu::CHURN_OPTIONS)
+        raise("Use config.churn instead of MetricFu::CHURN_OPTIONS")
+      end
+      if defined?(::MetricFu::DIRECTORIES_TO_FLOG)
+        raise("Use config.flog[:dirs_to_flog] "+
+              "instead of MetricFu::DIRECTORIES_TO_FLOG") 
+      end
+      if defined?(::MetricFu::SAIKURO_OPTIONS)
+        raise("Use config.saikuro instead of MetricFu::SAIKURO_OPTIONS")
+      end
+      if defined?(SAIKURO_OPTIONS)
+        raise("Use config.saikuro instead of SAIKURO_OPTIONS")
+      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')
+      @metric_fu_root_directory = File.join(File.dirname(__FILE__), 
+                                                        '..', '..')
+      @template_directory =  File.join(@metric_fu_root_directory, 
+                                       'lib', 'templates') 
+      @template_class = StandardTemplate
+      set_metrics
+      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"]}
+    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
+
+    # 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 PLATFORM
+    end
+    
+    def is_cruise_control_rb?
+      !!ENV['CC_BUILD_ARTIFACTS']
+    end
+  end
+end