bf4-metric_fu 2.1.3.1

data/spec/generators/stats_spec.rb

@@ -0,0 +1,74 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Stats do
+  describe "emit method" do
+    it "should gather the raw data" do
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+      stats = MetricFu::Stats.new
+      stats.should_receive(:`).with("rake stats > tmp/metric_fu/scratch/stats/stats.txt")
+      stats.emit
+    end
+  end
+
+  describe "analyze method" do
+    before :each do
+      @lines =  <<-HERE.gsub(/^\s*/, "")
+      +----------------------+-------+-------+---------+---------+-----+-------+
+      | Name                 | Lines |   LOC | Classes | Methods | M/C | LOC/M |
+      +----------------------+-------+-------+---------+---------+-----+-------+
+      | Controllers          |   470 |   382 |       7 |      53 |   7 |     5 |
+      | Helpers              |   128 |    65 |       0 |       6 |   0 |     8 |
+      | Models               |   351 |   285 |       9 |      31 |   3 |     7 |
+      | Libraries            |   305 |   183 |       2 |      30 |  15 |     4 |
+      | Model specs          |   860 |   719 |       0 |       2 |   0 |   357 |
+      | View specs           |     0 |     0 |       0 |       0 |   0 |     0 |
+      | Controller specs     |  1570 |  1308 |       1 |      10 |  10 |   128 |
+      | Helper specs         |   191 |   172 |       0 |       0 |   0 |     0 |
+      | Library specs        |    31 |    27 |       0 |       0 |   0 |     0 |
+      +----------------------+-------+-------+---------+---------+-----+-------+
+      | Total                |  3906 |  3141 |      19 |     132 |   6 |    21 |
+      +----------------------+-------+-------+---------+---------+-----+-------+
+        Code LOC: 915     Test LOC: 2226     Code to Test Ratio: 1:2.4
+
+      HERE
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+      stats = MetricFu::Stats.new
+      File.should_receive(:open).and_return(mock("file", :read => @lines))
+      @results = stats.analyze
+    end
+
+    it "should get code Lines Of Code" do
+      @results[:codeLOC].should == 915
+    end
+
+    it "should get test Lines Of Code" do
+      @results[:testLOC].should == 2226
+    end
+
+    it "should get code to test ratio" do
+      @results[:code_to_test_ratio].should == 2.4
+    end
+
+    it "should get data on models" do
+      model_data = @results[:lines].find {|line| line[:name] == "Models"}
+      model_data[:classes].should == 9
+      model_data[:methods].should == 31
+      model_data[:loc].should == 285
+      model_data[:lines].should == 351
+      model_data[:methods_per_class].should == 3
+      model_data[:loc_per_method].should == 7
+    end
+  end
+
+  describe "to_h method" do
+    it "should put things into a hash" do
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+      stats = MetricFu::Stats.new
+      stats.instance_variable_set(:@stats, "the_stats")
+      stats.to_h[:stats].should == "the_stats"
+    end
+  end
+end

data/spec/graphs/engines/bluff_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
+
+describe "Bluff graphers responding to #graph!" do
+  it "should write chart file" do
+    MetricFu.configuration
+    graphs = {}
+    available_graphs = MetricFu::AVAILABLE_GRAPHS + [:stats]
+    available_graphs.each do |graph|
+      grapher_name = graph.to_s.gsub("MetricFu::",'').gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+      grapher_name =  grapher_name+"BluffGrapher"
+      graphs[graph] = MetricFu.const_get(grapher_name).new
+    end
+    graphs.each do |key, val|
+      val.graph!
+      output_dir = File.expand_path(File.join(MetricFu.output_directory))
+      lambda{ File.open(File.join(output_dir, "#{key.to_s.downcase}.js")) }.should_not raise_error
+    end
+  end
+end

data/spec/graphs/engines/gchart_spec.rb

@@ -0,0 +1,156 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
+describe MetricFu::Grapher do
+  describe "require_graphing_gem" do
+    it "should give a warning if trying to use gchart but gem is not installed" do
+      MetricFu::Configuration.run {|config| config.graph_engine = :gchart}
+      MetricFu::Grapher.should_receive(:require).with('gchart').and_raise(LoadError)
+      MetricFu::Grapher.should_receive(:puts).with(/If you want to use google charts/)
+      MetricFu::Grapher.require_graphing_gem
+    end
+  end
+end
+
+describe MetricFu::GchartGrapher do
+  describe "determine_y_axis_scale" do
+    it "should set defaults when empty array" do
+      grapher = Object.new.extend(MetricFu::GchartGrapher)
+      grapher.determine_y_axis_scale([])
+      grapher.instance_variable_get(:@max_value).should == 10
+      grapher.instance_variable_get(:@yaxis).should == [0, 2, 4, 6, 8, 10]
+    end
+
+    it "should set max value of the graph above largest value" do
+      grapher = Object.new.extend(MetricFu::GchartGrapher)
+      grapher.determine_y_axis_scale([19])
+      grapher.instance_variable_get(:@max_value).should == 20
+
+      grapher.determine_y_axis_scale([20])
+      grapher.instance_variable_get(:@max_value).should == 25
+    end
+  end
+end
+
+describe "Gchart graphers" do
+  before :each do
+    MetricFu::Configuration.run {|config| config.graph_engine = :gchart}
+  end
+
+  describe "FlayGchartGrapher graph! method" do
+    it "should set static values for graph" do
+      grapher = FlayGchartGrapher.new
+      expected = {
+        :size => MetricFu::GchartGrapher::GCHART_GRAPH_SIZE,
+        :title => URI.escape("Flay: duplication"),
+        :axis_with_labels => 'x,y',
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'flay.png'),
+      }
+      Gchart.should_receive(:line).with(hash_including(expected))
+      grapher.graph!
+    end
+  end
+
+  describe "FlogGchartGrapher graph! method" do
+    it "should set static values for graph" do
+      grapher = FlogGchartGrapher.new
+      expected = {
+        :size => MetricFu::GchartGrapher::GCHART_GRAPH_SIZE,
+        :title => URI.escape("Flog: code complexity"),
+        :stacked => false,
+        :bar_colors => MetricFu::GchartGrapher::COLORS[0..1],
+        :legend => ['average', 'top 5% average'],
+        :custom => "chdlp=t",
+        :axis_with_labels => 'x,y',
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'flog.png'),
+      }
+      Gchart.should_receive(:line).with(hash_including(expected))
+      grapher.graph!
+    end
+  end
+
+  describe "RcovGchartGrapher graph! method" do
+    it "should set static values for graph" do
+      grapher = RcovGchartGrapher.new
+      expected = {
+        :size => MetricFu::GchartGrapher::GCHART_GRAPH_SIZE,
+        :title => URI.escape("Rcov: code coverage"),
+        :max_value => 101,
+        :axis_with_labels => 'x,y',
+        :axis_labels => [grapher.labels.values, [0,20,40,60,80,100]],
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'rcov.png'),
+      }
+      Gchart.should_receive(:line).with(hash_including(expected))
+      grapher.graph!
+    end
+  end
+
+  describe "ReekGchartGrapher graph! method" do
+    it "should set static values for graph" do
+      grapher = ReekGchartGrapher.new
+      expected = {
+        :size => MetricFu::GchartGrapher::GCHART_GRAPH_SIZE,
+        :title => URI.escape("Reek: code smells"),
+        :stacked => false,
+        :bar_colors => MetricFu::GchartGrapher::COLORS,
+        :axis_with_labels => 'x,y',
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'reek.png'),
+      }
+      Gchart.should_receive(:line).with(hash_including(expected))
+      grapher.graph!
+    end
+  end
+
+  describe "RoodiGchartGrapher graph! method" do
+    it "should set static values for graph" do
+      grapher = RoodiGchartGrapher.new
+      expected = {
+        :size => MetricFu::GchartGrapher::GCHART_GRAPH_SIZE,
+        :title => URI.escape("Roodi: potential design problems"),
+        :axis_with_labels => 'x,y',
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'roodi.png'),
+      }
+      Gchart.should_receive(:line).with(hash_including(expected))
+      grapher.graph!
+    end
+  end
+
+  describe "StatsGchartGrapher graph! method" do
+    it "should set static values for graph" do
+      grapher = StatsGchartGrapher.new
+      expected = {
+        :size => MetricFu::GchartGrapher::GCHART_GRAPH_SIZE,
+        :title => URI.escape("Stats: LOC & LOT"),
+        :bar_colors => MetricFu::GchartGrapher::COLORS[0..1],
+        :legend => ['Lines of code', 'Lines of test'],
+        :custom => "chdlp=t",
+        :axis_with_labels => 'x,y',
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'stats.png'),
+      }
+      Gchart.should_receive(:line).with(hash_including(expected))
+      grapher.graph!
+    end
+  end
+
+  describe "RailsBestPracticesGchartGrapher graph! method" do
+    it "should set static values for graph" do
+      grapher = RailsBestPracticesGchartGrapher.new
+      expected = {
+        :size => MetricFu::GchartGrapher::GCHART_GRAPH_SIZE,
+        :title => URI.escape("Rails Best Practices: design problems"),
+        :bar_colors => MetricFu::GchartGrapher::COLORS[0..1],
+        :legend => ['Problems'],
+        :custom => "chdlp=t",
+        :axis_with_labels => 'x,y',
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'rails_best_practices.png'),
+      }
+      Gchart.should_receive(:line).with(hash_including(expected))
+      grapher.graph!
+    end
+  end
+end

data/spec/graphs/flay_grapher_spec.rb

@@ -0,0 +1,56 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe FlayGrapher do
+  before :each do
+    @flay_grapher = MetricFu::FlayGrapher.new
+    MetricFu.configuration
+  end
+
+  it "should respond to flay_score and labels" do
+    @flay_grapher.should respond_to(:flay_score)
+    @flay_grapher.should respond_to(:labels)
+  end
+
+  describe "responding to #initialize" do
+    it "should initialise flay_score and labels" do
+      @flay_grapher.flay_score.should == []
+      @flay_grapher.labels.should == {}
+    end
+  end
+
+  describe "responding to #get_metrics" do
+    context "when metrics were not generated" do
+      before(:each) do
+        @metrics = YAML::load(File.open(File.join(File.dirname(__FILE__), "..", "resources", "yml", "metric_missing.yml")))
+        @date = "1/2"
+      end
+
+      it "should not push to flay_score" do
+        @flay_grapher.flay_score.should_not_receive(:push)
+        @flay_grapher.get_metrics(@metrics, @date)
+      end
+
+      it "should not update labels with the date" do
+        @flay_grapher.labels.should_not_receive(:update)
+        @flay_grapher.get_metrics(@metrics, @date)
+      end
+    end
+
+    context "when metrics have been generated" do
+      before(:each) do
+        @metrics = YAML::load(File.open(File.join(File.dirname(__FILE__), "..", "resources", "yml", "20090630.yml")))
+        @date = "1/2"
+      end
+
+      it "should push to flay_score" do
+        @flay_grapher.flay_score.should_receive(:push).with(476)
+        @flay_grapher.get_metrics(@metrics, @date)
+      end
+
+      it "should update labels with the date" do
+        @flay_grapher.labels.should_receive(:update).with({ 0 => "1/2" })
+        @flay_grapher.get_metrics(@metrics, @date)
+      end
+    end
+  end
+end

data/spec/graphs/flog_grapher_spec.rb

@@ -0,0 +1,108 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe MetricFu::FlogGrapher do
+  before :each do
+    MetricFu.configuration
+    @flog_grapher = MetricFu::FlogGrapher.new
+
+  end
+
+  it "should respond to flog_total, flog_average and labels" do
+    @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 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
+
+  describe "responding to #get_metrics" do
+    before(:each) do
+      methods = {}
+      100.times do |i|
+        methods["method_name_#{i}"] = {:score => i.to_f}
+      end
+
+      @metrics = {:flog => {:total => 111.1,
+                            :average => 7.7,
+                            :method_containers => [ {:methods => methods } ] } }
+      @date = "1/2"
+    end
+
+    it "should push to top_five_percent_average" do
+      average = (99.0 + 98.0 + 97.0 + 96.0 + 95.0) / 5.0
+      @flog_grapher.top_five_percent_average.should_receive(:push).with(average)
+      @flog_grapher.get_metrics(@metrics, @date)
+    end
+
+    it "should push 9.9 to flog_average" do
+      @flog_grapher.flog_average.should_receive(:push).with(7.7)
+      @flog_grapher.get_metrics(@metrics, @date)
+    end
+
+    context "when metrics were not generated" do
+      before(:each) do
+        @metrics = YAML::load(File.open(File.join(File.dirname(__FILE__), "..", "resources", "yml", "metric_missing.yml")))
+        @date = "1/2"
+      end
+
+      it "should not push to top_five_percent_average" do
+        @flog_grapher.top_five_percent_average.should_not_receive(:push)
+        @flog_grapher.get_metrics(@metrics, @date)
+      end
+
+      it "should not push to flog_average" do
+        @flog_grapher.flog_average.should_not_receive(:push)
+        @flog_grapher.get_metrics(@metrics, @date)
+      end
+
+      it "should not update labels with the date" do
+        @flog_grapher.labels.should_not_receive(:update)
+        @flog_grapher.get_metrics(@metrics, @date)
+      end
+    end
+
+    context "when metrics have been generated" do
+      before(:each) do
+        @metrics = YAML::load(File.open(File.join(File.dirname(__FILE__), "..", "resources", "yml", "20090630.yml")))
+        @date = "1/2"
+      end
+
+      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
+
+      it "should push to flog_average" do
+        @flog_grapher.flog_average.should_receive(:push).with(9.9)
+        @flog_grapher.get_metrics(@metrics, @date)
+      end
+
+      it "should update labels with the date" do
+        @flog_grapher.labels.should_receive(:update).with({ 0 => "1/2" })
+        @flog_grapher.get_metrics(@metrics, @date)
+      end
+    end
+  end
+
+  describe "responding to #get_metrics with legacy data" do
+    before(:each) do
+      @metrics = YAML::load(File.open(File.join(File.dirname(__FILE__), "..", "resources", "yml", "20090630.yml")))
+
+      @date = "1/2"
+    end
+
+    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
+  end
+
+end

data/spec/graphs/rails_best_practices_grapher_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe RailsBestPracticesGrapher do
+  before :each do
+    @stats_grapher = MetricFu::RailsBestPracticesGrapher.new
+    MetricFu.configuration
+  end
+
+  it "should respond to rails_best_practices_count and labels" do
+    @stats_grapher.should respond_to(:rails_best_practices_count)
+    @stats_grapher.should respond_to(:labels)
+  end
+
+  describe "responding to #initialize" do
+    it "should initialise rails_best_practices_count and labels" do
+      @stats_grapher.rails_best_practices_count.should == []
+      @stats_grapher.labels.should == {}
+    end
+  end
+
+  describe "responding to #get_metrics" do
+    context "when metrics were not generated" do
+      before(:each) do
+        @metrics = YAML::load(File.open(File.join(File.dirname(__FILE__), "..", "resources", "yml", "metric_missing.yml")))
+        @date = "01022003"
+      end
+
+      it "should not push to rails_best_practices_count" do
+        @stats_grapher.rails_best_practices_count.should_not_receive(:push)
+        @stats_grapher.get_metrics(@metrics, @date)
+      end
+
+      it "should not update labels with the date" do
+        @stats_grapher.labels.should_not_receive(:update)
+        @stats_grapher.get_metrics(@metrics, @date)
+      end
+    end
+
+    context "when metrics have been generated" do
+      before(:each) do
+        @metrics = YAML::load(File.open(File.join(File.dirname(__FILE__), "..", "resources", "yml", "20090630.yml")))
+        @date = "01022003"
+      end
+
+      it "should push to rails_best_practices_count" do
+        @stats_grapher.rails_best_practices_count.should_receive(:push).with(2)
+        @stats_grapher.get_metrics(@metrics, @date)
+      end
+
+      it "should push 0 to rails_best_practices_count when no problems were found" do
+        @stats_grapher.rails_best_practices_count.should_receive(:push).with(0)
+        @stats_grapher.get_metrics({ :rails_best_practices => {} }, @date)
+      end
+
+      it "should update labels with the date" do
+        @stats_grapher.labels.should_receive(:update).with({ 0 => "01022003" })
+        @stats_grapher.get_metrics(@metrics, @date)
+      end
+    end
+  end
+end