metric_fu 2.1.3.7.19 → 2.1.4.pre

data/lib/configuration.rb

@@ -1,227 +0,0 @@
-require 'fileutils'
-MetricFu.reporting_require { 'templates/awesome/awesome_template' }
-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,
-                      :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
-  # 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.
-    # TODO review if these code is functionally duplicated in the
-    # base generator initialize
-    def reset
-      @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
-      set_metrics
-      set_graphs
-      set_code_dirs
-      @flay     = { :dirs_to_flay => @code_dirs,
-                    :minimum_score => 100,
-                    :filetypes => ['rb'] }
-      @flog     = { :dirs_to_flog => @code_dirs  }
-      @reek     = { :dirs_to_reek => @code_dirs,
-                    :config_file_pattern => nil}
-      @roodi    = { :dirs_to_roodi => @code_dirs,
-                    :roodi_config => nil }
-      @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     = { :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",
-                                   "--text-coverage",
-                                   "--no-color",
-                                   "--profile",
-                                   "--rails",
-                                   "--exclude /gems/,/Library/,/usr/,spec"],
-                    :external => nil
-                  }
-      @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 = 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
-
-    # 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,
-          :rails_best_practices
-        ]
-      else
-        @metrics = MetricFu::AVAILABLE_METRICS
-      end
-    end
-
-    def set_graphs
-      if rails?
-        @graphs = MetricFu::AVAILABLE_GRAPHS + [
-          :stats
-        ]
-      else
-        @graphs = MetricFu::AVAILABLE_GRAPHS
-      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 RUBY_PLATFORM
-    end
-
-    def is_cruise_control_rb?
-      !!ENV['CC_BUILD_ARTIFACTS']
-    end
-  end
-end

data/lib/metrics/churn/churn.rb

@@ -1,28 +0,0 @@
-module MetricFu
-
-  class Churn < Generator
-
-    def initialize(options={})
-      super
-    end
-
-    def emit
-      @output = `churn --yaml`
-      yaml_start = @output.index("---")
-      @output = @output[yaml_start...@output.length] if yaml_start
-    end
-
-    def analyze
-      if @output.match(/Churning requires a subversion or git repo/)
-        @churn = [:churn => {}]
-      else
-        @churn = YAML::load(@output)
-      end
-    end
-
-    def to_h
-      {:churn => @churn[:churn]}
-    end
-  end
-
-end

data/lib/version.rb

@@ -1,3 +0,0 @@
-module MetricFu
-  VERSION = "2.1.3.7.19"
-end

data/spec/base/configuration_spec.rb

@@ -1,277 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
-
-describe MetricFu::Configuration do
-
-  def get_new_config
-    @config = Configuration.new
-  end
-
-  def base_directory
-    @config.instance_variable_get(:@base_directory)
-  end
-
-  def output_directory
-    @config.instance_variable_get(:@output_directory)
-  end
-
-  def scratch_directory
-    @config.instance_variable_get(:@scratch_directory)
-  end
-
-  def template_directory
-    @config.instance_variable_get(:@template_directory)
-  end
-
-  def template_class
-    @config.instance_variable_get(:@template_class)
-  end
-
-  def metric_fu_root
-    @config.instance_variable_get(:@metric_fu_root_directory)
-  end
-
-  describe "#reset" do
-
-    before(:each) { get_new_config }
-
-    describe 'when there is a CC_BUILD_ARTIFACTS environment variable' do
-      before(:each) { ENV['CC_BUILD_ARTIFACTS'] = 'foo' }
-
-      it 'should return the CC_BUILD_ARTIFACTS environment variable' do
-        get_new_config
-        compare_paths(base_directory, ENV['CC_BUILD_ARTIFACTS'])
-      end
-    end
-
-    describe 'when there is no CC_BUILD_ARTIFACTS environment variable' do
-      before(:each) { ENV['CC_BUILD_ARTIFACTS'] = nil  }
-
-      it 'should return "tmp/metric_fu"' do
-        get_new_config
-        base_directory.should == "tmp/metric_fu"
-      end
-    end
-
-    it 'should set @metric_fu_root_directory to the base of the '+
-    'metric_fu application' do
-      app_root = File.join(File.dirname(__FILE__), '..', '..')
-      app_root_absolute_path = File.expand_path(app_root)
-      metric_fu_absolute_path = File.expand_path(metric_fu_root)
-      metric_fu_absolute_path.should == app_root_absolute_path
-    end
-
-    it 'should set @template_directory to the lib/templates relative '+
-    'to @metric_fu_root_directory' do
-      template_dir = File.join(File.dirname(__FILE__),
-                               '..', '..', 'lib','templates')
-      template_dir_abs_path = File.expand_path(template_dir)
-      calc_template_dir_abs_path = File.expand_path(template_directory)
-      calc_template_dir_abs_path.should == template_dir_abs_path
-    end
-
-    it 'should set @scratch_directory to scratch relative '+
-    'to @base_directory' do
-      scratch_dir = MetricFu.scratch_dir
-      scratch_directory.should == scratch_dir
-    end
-
-    it 'should set @output_directory to output relative '+
-    'to @base_directory' do
-      output_dir = MetricFu.output_dir
-      output_directory.should == output_dir
-    end
-
-    it 'should set @template_class to AwesomeTemplate' do
-      template_class.should == AwesomeTemplate
-    end
-
-    it 'should set @flay to {:dirs_to_flay => @code_dirs}' do
-      @config.instance_variable_get(:@flay).
-              should == {:dirs_to_flay => ['lib'], :filetypes=>["rb"], :minimum_score => 100}
-    end
-
-    it 'should set @flog to {:dirs_to_flog => @code_dirs}' do
-      @config.instance_variable_get(:@flog).
-              should == {:dirs_to_flog => ['lib']}
-    end
-
-    it 'should set @reek to {:dirs_to_reek => @code_dirs}' do
-      @config.instance_variable_get(:@reek).
-              should == {:config_file_pattern=>nil, :dirs_to_reek => ['lib']}
-    end
-
-    it 'should set @roodi to {:dirs_to_roodi => @code_dirs}' do
-      @config.instance_variable_get(:@roodi).
-              should == {:roodi_config=>nil, :dirs_to_roodi => ['lib']}
-    end
-
-    it 'should set @churn to {}' do
-      @config.instance_variable_get(:@churn).
-              should == {}
-    end
-
-    it 'should set @stats to {}' do
-      @config.instance_variable_get(:@stats).
-              should == {}
-    end
-
-    it 'should set @rails_best_practices to {}' do
-      @config.instance_variable_get(:@rails_best_practices).
-              should == {}
-    end
-
-    it 'should set @rcov to { :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"]}' do
-      @config.instance_variable_get(:@rcov).
-              should ==  { :environment => 'test',
-                           :test_files => ['test/**/*_test.rb',
-                                           'spec/spec_helper.rb',
-                                           'spec/**/*_spec.rb'],
-                           :rcov_opts => ["--sort coverage",
-                                         "--no-html",
-                                         "--text-coverage",
-                                         "--no-color",
-                                         "--profile",
-                                         "--rails",
-                                         "--exclude /gems/,/Library/,/usr/,spec"],
-                          :external => nil}
-    end
-
-    it 'should set @saikuro to { :output_directory => @scratch_directory + "/saikuro",
-                                 :input_directory => @code_dirs,
-                                 :cyclo => "",
-                                 :filter_cyclo => "0",
-                                 :warn_cyclo => "5",
-                                 :error_cyclo => "7",
-                                 :formater => "text" }' do
-      @config.instance_variable_get(:@saikuro).
-              should ==  { :output_directory => "#{scratch_directory}/saikuro",
-                    :input_directory => ['lib'],
-                    :cyclo => "",
-                    :filter_cyclo => "0",
-                    :warn_cyclo => "5",
-                    :error_cyclo => "7",
-                    :formater => "text"}
-    end
-
-    describe 'if #rails? is true ' do
-      before(:each) do
-        @config.stub!(:rails?).and_return(true)
-      end
-
-      describe '#set_metrics ' do
-        it 'should set the @metrics instance var to AVAILABLE_METRICS + '\
-           +'[:stats]' do
-          @config.instance_variable_get(:@metrics).
-                  should == MetricFu::AVAILABLE_METRICS << [:stats]
-        end
-      end
-
-      describe '#set_graphs ' do
-        it 'should set the @graphs instance var to AVAILABLE_GRAPHS' do
-          @config.instance_variable_get(:@graphs).
-                  should == MetricFu::AVAILABLE_GRAPHS
-        end
-      end
-
-      describe '#set_code_dirs ' do
-        it 'should set the @code_dirs instance var to ["app", "lib"]' do
-          # This is hard to spec properly because the @code_dirs variable
-          # is set during the reset process.
-          #@config.instance_variable_get(:@code_dirs).
-          #        should == ['app','lib']
-        end
-      end
-    end
-
-    describe 'if #rails? is false ' do
-      before(:each) do
-        @config.stub!(:rails?).and_return(false)
-      end
-
-      describe '#set_metrics ' do
-        it 'should set the @metrics instance var to AVAILABLE_METRICS' do
-          @config.instance_variable_get(:@metrics).
-                  should == MetricFu::AVAILABLE_METRICS
-        end
-      end
-
-      describe '#set_code_dirs ' do
-        it 'should set the @code_dirs instance var to ["lib"]' do
-          @config.instance_variable_get(:@code_dirs).should == ['lib']
-        end
-      end
-    end
-  end
-
-  describe '#add_attr_accessors_to_self' do
-
-    before(:each) { get_new_config }
-
-    MetricFu::AVAILABLE_METRICS.each do |metric|
-      it "should have a reader for #{metric}" do
-        @config.respond_to?(metric).should be_true
-      end
-
-      it "should have a writer for #{metric}=" do
-        @config.respond_to?((metric.to_s + '=').to_sym).should be_true
-      end
-    end
-  end
-
-  describe '#add_class_methods_to_metric_fu' do
-
-    before(:each) { get_new_config }
-
-    MetricFu::AVAILABLE_METRICS.each do |metric|
-      it "should add a #{metric} class method to the MetricFu module " do
-        MetricFu.should respond_to(metric)
-      end
-    end
-
-    MetricFu::AVAILABLE_GRAPHS.each do |graph|
-      it "should add a #{graph} class metrhod to the MetricFu module" do
-        MetricFu.should respond_to(graph)
-      end
-    end
-  end
-
-  describe '#platform' do
-
-    before(:each) { get_new_config }
-
-    it 'should return the value of the PLATFORM constant' do
-      this_platform = RUBY_PLATFORM
-      @config.platform.should == this_platform
-    end
-  end
-
-  describe '#is_cruise_control_rb? ' do
-
-    before(:each) { get_new_config }
-    describe "when the CC_BUILD_ARTIFACTS env var is not nil" do
-
-      before(:each) { ENV['CC_BUILD_ARTIFACTS'] = 'is set' }
-
-      it 'should return true'  do
-        @config.is_cruise_control_rb?.should be_true
-      end
-
-    end
-
-    describe "when the CC_BUILD_ARTIFACTS env var is nil" do
-      before(:each) { ENV['CC_BUILD_ARTIFACTS'] = nil }
-
-      it 'should return false' do
-        @config.is_cruise_control_rb?.should be_false
-      end
-    end
-  end
-end