jscruggs-metric_fu 1.1.2 → 1.1.3

data/HISTORY

@@ -1,3 +1,10 @@
+=== MetricFu 1.1.3 / 2009-7-10
+
+* MetricFu is now Ruby 1.9x compatible
+* Removed the check for deprecated ways of configuring metric_fu as the tests were causing Ruby 1.9x problems and it's been forever since they were supported.
+* Removed total flog score from graph (which will always go up and so doesn't mean much) and replacing it with top_five_percent_average which is an average of the worst 5 percent of your methods.
+* Sort Flog by highest score in the class which I feel is more important than the total flog flog score.
+
 === MetricFu 1.1.2 / 2009-7-09
 
 * Removed dependency on gruff and rmagick (unless the user wants graphs, of course).

data/lib/base/configuration.rb

@@ -51,7 +51,6 @@ module MetricFu
   class Configuration
 
     def initialize #:nodoc:#
-      warn_about_deprecated_config_options
       reset
       add_attr_accessors_to_self
       add_class_methods_to_metric_fu
@@ -82,25 +81,6 @@ module MetricFu
       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|
@@ -197,7 +177,7 @@ module MetricFu
     end
     
     def platform #:nodoc:
-      return PLATFORM
+      return RUBY_PLATFORM
     end
     
     def is_cruise_control_rb?

data/lib/generators/churn.rb

@@ -1,5 +1,4 @@
 require 'chronic'
-require 'generator'
 module MetricFu
   
   class Churn < Generator

data/lib/generators/flay.rb

@@ -1,4 +1,3 @@
-require 'generator'
 module MetricFu
   
   class Flay < Generator

data/lib/generators/flog.rb

@@ -62,7 +62,7 @@ module MetricFu
     def to_h
       number_of_methods = @pages.inject(0) {|count, page| count += page.scanned_methods.size}
       total_flog_score = @pages.inject(0) {|total, page| total += page.score}
-      sorted_pages = @pages.sort_by {|page| page.score }.reverse 
+      sorted_pages = @pages.sort_by {|page| page.highest_score }.reverse 
       {:flog => { :total => total_flog_score,
                   :average => average_score(total_flog_score, number_of_methods),
                   :pages => sorted_pages.map {|page| page.to_h}}}

data/lib/graphs/flog_grapher.rb

@@ -2,17 +2,17 @@ module MetricFu
   
   class FlogGrapher < Grapher
     
-    attr_accessor :flog_total, :flog_average, :labels
+    attr_accessor :flog_average, :labels, :top_five_percent_average
     
     def initialize
       super
-      self.flog_total = []
       self.flog_average = []
       self.labels = {}
+      self.top_five_percent_average =[]
     end
     
     def get_metrics(metrics, date)
-      self.flog_total.push(metrics[:flog][:total])
+      self.top_five_percent_average.push(calc_top_five_percent_average(metrics))
       self.flog_average.push(metrics[:flog][:average])
       self.labels.update( { self.labels.size => date })
     end
@@ -22,7 +22,7 @@ module MetricFu
       g.title = "Flog: code complexity"
       g.theme = MetricFu.graph_theme
       g.font = MetricFu.graph_font
-      g.data('flog total', self.flog_total)
+      g.data('top five percent average', self.top_five_percent_average)
       g.data('flog average', self.flog_average)
       g.labels = self.labels
       g.title_font_size = MetricFu.graph_title_font_size
@@ -32,6 +32,20 @@ module MetricFu
       g.write(File.join(MetricFu.output_directory, 'flog.png'))
     end
     
+    private
+    
+    def calc_top_five_percent_average(metrics)
+      methods = metrics[:flog][:pages].inject([]) {|methods, page| methods << page[:scanned_methods]}
+      methods.flatten!
+      
+      methods = methods.sort_by {|method| method[:score]}.reverse
+
+      number_of_methods_that_is_five_percent = (methods.size * 0.05).ceil
+
+      total_for_five_percent = methods[0...number_of_methods_that_is_five_percent].inject(0) {|total, method| total += method[:score]}
+      total_for_five_percent / number_of_methods_that_is_five_percent.to_f
+    end
+    
   end
   
 end

data/lib/graphs/grapher.rb

@@ -8,8 +8,8 @@ module MetricFu
       require 'gruff'
     rescue LoadError
       puts "#"*99 + "\n" +
-           "If you want to use metric_fu's graphing features then you'll need to install the gems 'topfunky-gruff' and 'rmagick' "+
-           "(and rmagick requires ImageMagick).  "+
+           "If you want to use metric_fu's graphing features then you'll need to install the gems " + 
+           "'topfunky-gruff' (or 'umang-gruff' if you use 1.9x) and 'rmagick' (and rmagick requires ImageMagick).  "+
            "If you don't want to deal with that, then make sure you set config.graphs = [] (see the metric_fu's homepage for more details) "+
            "to indicate that you don't want graphing." +
            "\n" + "#"*99 

data/lib/metric_fu.rb

@@ -1,4 +1,5 @@
 require 'rake'
+require 'yaml'
 # Load a few things to make our lives easier elsewhere.
 module MetricFu
   LIB_ROOT = File.dirname(__FILE__)

data/spec/base/configuration_spec.rb

@@ -30,53 +30,6 @@ describe MetricFu::Configuration do
     @config.instance_variable_get(:@metric_fu_root_directory)
   end
 
-  describe '#warn_about_deprecated_config_options' do
-
-    def get_new_config_and_raise_runtime_error
-      lambda { get_new_config  }.should raise_error
-    end
-
-    describe 'when ::MetricFu::CHURN_OPTIONS is present' do
-      before(:each) { ::MetricFu::CHURN_OPTIONS = 'option' }
-      after(:each)  { ::MetricFu.send(:remove_const, 'CHURN_OPTIONS') }
-      
-      it 'should raise a RuntimeError with "Use config.churn '+ 
-      'instead of MetricFu::CHURN_OPTIONS"' do
-        get_new_config_and_raise_runtime_error
-      end
-    end
-    
-    describe 'when ::MetricFu::DIRECTORIES_TO_FLOG is present' do
-      before(:each) { ::MetricFu::DIRECTORIES_TO_FLOG = 'option' }
-      after(:each)  { ::MetricFu.send(:remove_const,'DIRECTORIES_TO_FLOG')}
-
-      it 'should raise a RuntimeError with "Use config.flog '+
-      '[:dirs_to_flog] instead of MetricFu::DIRECTORIES_TO_FLOG' do
-        get_new_config_and_raise_runtime_error
-      end 
-    end
-
-    describe 'when ::MetricFu::SAIKURO_OPTIONS is present' do
-      before(:each) { ::MetricFu::SAIKURO_OPTIONS = 'option' }
-      after(:each)  { ::MetricFu.send(:remove_const,'SAIKURO_OPTIONS')}
-      
-      it 'should raise a RuntimeError with "Use config.saikuro '+
-      'instead of MetricFu::SAIKURO_OPTIONS' do 
-        get_new_config_and_raise_runtime_error
-      end
-    end
-
-    describe 'when SAIKURO_OPTIONS is present' do
-      before(:each) { SAIKURO_OPTIONS = 'option' }
-      after(:each)  { Object.send(:remove_const,'SAIKURO_OPTIONS')}
-      
-      it 'should raise a RuntimeError with "Use config.saikuro '+
-      'instead of SAIKURO_OPTIONS' do
-        get_new_config_and_raise_runtime_error
-      end
-    end
-  end
-
   describe "#reset" do
     
     before(:each) { get_new_config } 
@@ -318,7 +271,7 @@ describe MetricFu::Configuration do
     before(:each) { get_new_config }
 
     it 'should return the value of the PLATFORM constant' do
-      this_platform = PLATFORM
+      this_platform = RUBY_PLATFORM
       @config.platform.should == this_platform
     end
   end

data/spec/graphs/flog_grapher_spec.rb

@@ -7,16 +7,16 @@ describe MetricFu::FlogGrapher do
   end
   
   it "should respond to flog_total, flog_average and labels" do
-    @flog_grapher.should respond_to(:flog_total)
     @flog_grapher.should respond_to(:flog_average)
     @flog_grapher.should respond_to(:labels)
+    @flog_grapher.should respond_to(:top_five_percent_average)
   end
   
   describe "responding to #initialize" do
-    it "should initialize flog_total, flog_average and labels" do
-      @flog_grapher.flog_total.should == []
+    it "should initialize top_five_percent_average, flog_average and labels" do
       @flog_grapher.flog_average.should == []
       @flog_grapher.labels.should == {}
+      @flog_grapher.top_five_percent_average.should == []
     end
   end
   
@@ -26,8 +26,9 @@ describe MetricFu::FlogGrapher do
       @date = "01022003"
     end
     
-    it "should push 1491.1 to flog_total" do
-      @flog_grapher.flog_total.should_receive(:push).with(1491.1)      
+    it "should push to top_five_percent_average" do
+      average = (73.6 + 68.5 + 66.1 + 46.6 + 44.8 + 44.1 + 41.2 + 36.0) / 8.0
+      @flog_grapher.top_five_percent_average.should_receive(:push).with(average)      
       @flog_grapher.get_metrics(@metrics, @date)
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jscruggs-metric_fu
 version: !ruby/object:Gem::Version 
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors: 
 - Jake Scruggs