edouard-metric_fu 1.0.2 → 1.0.3

data/lib/base/configuration.rb

@@ -1,207 +0,0 @@
-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]
-
-  # 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')
-      @data_directory = File.join(@base_directory, '_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 white red blue pink yellow),
-                       :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 PLATFORM
-    end
-    
-    def is_cruise_control_rb?
-      !!ENV['CC_BUILD_ARTIFACTS']
-    end
-  end
-end

data/lib/base/generator.rb

@@ -1,160 +0,0 @@
-module MetricFu
-
-  # = Generator
-  #
-  # The Generator class is an abstract class that provides the 
-  # skeleton for producing different types of metrics.
-  #
-  # It drives the production of the metrics through a template 
-  # method - #generate_report(options={}).  This method calls
-  # #emit, #analyze and #to_h in order to produce the metrics.
-  #
-  # To implement a concrete class to generate a metric, therefore,
-  # the class must implement those three methods. 
-  #
-  # * #emit should take care of running the metric tool and 
-  #   gathering its output.  
-  # * #analyze should take care of manipulating the output from
-  #   #emit and making it possible to store it in a programmatic way.
-  # * #to_h should provide a hash representation of the output from
-  #   #analyze ready to be serialized into yaml at some point.
-  #
-  # == Pre-conditions
-  #
-  # Based on the class name of the concrete class implementing a
-  # Generator, the Generator class will create a 'metric_directory'
-  # named after the class under the MetricFu.scratch_directory, where
-  # any output from the #emit method should go.
-  #
-  # It will also create the MetricFu.output_directory if neccessary, and
-  # in general setup the directory structure that the MetricFu system
-  # expects.
-  class Generator
-    attr_reader :report, :template
-
-    def initialize(options={})
-      self.class.verify_dependencies!
-      create_metric_dir_if_missing
-      create_output_dir_if_missing
-      create_data_dir_if_missing
-    end
-    
-    # Creates a new generator and returns the output of the 
-    # #generate_report method.  This is the typical way to 
-    # generate a new MetricFu report. For more information see
-    # the #generate_report instance method.
-    #
-    # @params options Hash
-    #   A currently unused hash to configure the Generator
-    #
-    # @see generate_report
-    def self.generate_report(options={})
-      generator = self.new(options)
-      generator.generate_report
-    end
-
-    # Provides the unqualified class name of an implemented concrete
-    # class, as a string.  For example:
-    #
-    #   class Flay < Generator; end
-    #   klass = Flay.new
-    #   klass.class_name
-    #   > "flay"
-    #
-    # @return String
-    #   The unqualified class name of this concrete class, returned
-    #   as a string.
-    def self.class_name
-      self.to_s.split('::').last.downcase
-    end
-   
-    # Returns the directory where the Generator will write any output
-    def self.metric_directory
-      File.join(MetricFu.scratch_directory, class_name) 
-    end
-
-    def create_metric_dir_if_missing #:nodoc:
-      unless File.directory?(metric_directory)
-        FileUtils.mkdir_p(metric_directory, :verbose => false) 
-      end
-    end
-    
-    def create_output_dir_if_missing #:nodoc:
-      unless File.directory?(MetricFu.output_directory)
-        FileUtils.mkdir_p(MetricFu.output_directory, :verbose => false) 
-      end
-    end
-    
-    def create_data_dir_if_missing #:nodoc:
-      unless File.directory?(MetricFu.data_directory)
-        FileUtils.mkdir_p(MetricFu.data_directory, :verbose => false) 
-      end
-    end
-
-    # @return String
-    #   The path of the metric directory this class is using.
-    def metric_directory
-      self.class.metric_directory
-    end
-
-   
-    # Defines some hook methods for the concrete classes to hook into.
-    %w[emit analyze].each do |meth|
-      define_method("before_#{meth}".to_sym) {}
-      define_method("after_#{meth}".to_sym) {}
-    end
-    define_method("before_to_h".to_sym) {}
-
-    # Provides a template method to drive the production of a metric
-    # from a concrete implementation of this class.  Each concrete
-    # class must implement the three methods that this template method
-    # calls: #emit, #analyze and #to_h.  For more details, see the
-    # class documentation.
-    #
-    # This template method also calls before_emit, after_emit... etc.
-    # methods to allow extra hooks into the processing methods, and help
-    # to keep the logic of your Generators clean.
-    def generate_report
-      %w[emit analyze].each do |meth|
-        send("before_#{meth}".to_sym)
-        send("#{meth}".to_sym)
-        send("after_#{meth}".to_sym)
-      end
-      before_to_h()
-      to_h()
-    end
-
-    def round_to_tenths(decimal)
-      (decimal * 10).round / 10.0 
-    end
-    
-    # Allows subclasses to check for required gems
-    def self.verify_dependencies!
-      true
-    end
-
-    def emit #:nodoc:
-      raise <<-EOF
-        This method must be implemented by a concrete class descending
-        from Generator.  See generator class documentation for more 
-        information.
-      EOF
-    end
-
-    def analyze #:nodoc:
-      raise <<-EOF
-        This method must be implemented by a concrete class descending
-        from Generator.  See generator class documentation for more 
-        information.
-      EOF
-    end
-    
-    def to_graph #:nodoc:
-      raise <<-EOF
-        This method must be implemented by a concrete class descending
-        from Generator.  See generator class documentation for more 
-        information.
-      EOF
-    end
-  end
-end

data/lib/base/graph.rb

@@ -1,37 +0,0 @@
-module MetricFu
-
-  def self.graph
-    @graph ||= Graph.new
-  end
-
-  class Graph
-    
-    attr_accessor :clazz
-    
-    def initialize
-      self.clazz = []
-    end
-    
-    def add(graph_type)
-      grapher_name = graph_type.to_s.capitalize + "Grapher"
-      self.clazz.push MetricFu.const_get(grapher_name).new
-    end
-    
-    
-    def generate
-      puts "Generating graphs"
-      Dir[File.join(MetricFu.data_directory, '*.yml')].sort.each do |metric_file|
-        puts "Generating graphs for #{metric_file}"
-        date = metric_file.split('/')[3].split('.')[0]
-        metrics = YAML::load(File.open(metric_file))
-        
-        self.clazz.each do |grapher|
-          grapher.get_metrics(metrics, date)
-        end
-      end
-      self.clazz.each do |grapher|
-        grapher.graph!
-      end
-    end
-  end
-end

data/lib/base/md5_tracker.rb

@@ -1,52 +0,0 @@
-require 'digest/md5'
-require 'fileutils'
-
-module MetricFu
-  class MD5Tracker
-
-    @@unchanged_md5s = []
-
-    class << self
-      def md5_dir(path_to_file, base_dir)
-        File.join(base_dir,
-                  path_to_file.split('/')[0..-2].join('/'))
-      end
-
-      def md5_file(path_to_file, base_dir)
-        File.join(md5_dir(path_to_file, base_dir),
-                  path_to_file.split('/').last.sub(/\.[a-z]+/, '.md5'))
-      end
-
-      def track(path_to_file, base_dir)
-        md5 = Digest::MD5.hexdigest(File.read(path_to_file))
-        FileUtils.mkdir_p(md5_dir(path_to_file, base_dir), :verbose => false)
-        f = File.new(md5_file(path_to_file, base_dir), "w")
-        f.puts(md5)
-        f.close
-        md5
-      end
-
-      def file_changed?(path_to_file, base_dir)
-        orig_md5_file = md5_file(path_to_file, base_dir)
-        return !!track(path_to_file, base_dir) unless File.exist?(orig_md5_file)
-
-        current_md5 = ""
-        file = File.open(orig_md5_file, 'r')
-        file.each_line { |line| current_md5 << line }
-        file.close
-        current_md5.chomp!
-
-        new_md5 = Digest::MD5.hexdigest(File.read(path_to_file))
-        new_md5.chomp!
-
-        @@unchanged_md5s << path_to_file if new_md5 == current_md5
-
-        return new_md5 != current_md5
-      end
-
-      def file_already_counted?(path_to_file)
-        return @@unchanged_md5s.include?(path_to_file)
-      end
-    end
-  end
-end