cdd-metric_fu 1.3.1

data/spec/generators/rcov_spec.rb

@@ -0,0 +1,159 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe MetricFu::Rcov do
+  
+  before :each do
+    MetricFu::Configuration.run {}
+    File.stub!(:directory?).and_return(true)
+    @rcov = MetricFu::Rcov.new('base_dir')
+  end
+  
+  describe "emit" do
+    before :each do
+      @rcov.stub!(:puts)
+    end
+    
+    it "should clear out previous output and make output folder" do
+      @rcov.stub!(:`)
+      FileUtils.should_receive(:rm_rf).with(MetricFu::Rcov.metric_directory, :verbose => false)
+      Dir.should_receive(:mkdir).with(MetricFu::Rcov.metric_directory)
+      @rcov.emit
+    end
+    
+    it "should set the RAILS_ENV" do
+      FileUtils.stub!(:rm_rf)
+      Dir.stub!(:mkdir)
+      MetricFu.rcov[:environment] = "metrics"
+      @rcov.should_receive(:`).with(/RAILS_ENV=metrics/)
+      @rcov.emit
+    end
+  end
+  
+  describe "with RCOV_OUTPUT fed into" do
+    before :each do
+      File.should_receive(:open).
+            with(MetricFu::Rcov.metric_directory + '/rcov.txt').
+            and_return(mock("io", :read => RCOV_OUTPUT))
+      @files = @rcov.analyze
+    end
+    
+    describe "analyze" do
+      it "should compute percent of lines run" do
+        @files["lib/templates/awesome/awesome_template.rb"][:percent_run].should == 13
+        @files["lib/templates/standard/standard_template.rb"][:percent_run].should == 14
+      end
+
+      it "should know which lines were run" do
+        @files["lib/templates/awesome/awesome_template.rb"][:lines].
+              should include({:content=>"   require 'fileutils'", :was_run=>true})
+      end
+
+      it "should know which lines NOT were run" do
+        @files["lib/templates/awesome/awesome_template.rb"][:lines].
+              should include({:content=>"         if template_exists?(section)", :was_run=>false})
+      end
+    end
+
+    describe "to_h" do
+      it "should calculate total percentage for all files" do
+        @rcov.to_h[:rcov][:global_percent_run].should == 13.7
+      end
+    end
+  end
+
+
+RCOV_OUTPUT = <<-HERE
+Profiling enabled.
+.............................................................................................................................................................................................
+
+
+Top 10 slowest examples:
+0.2707830 MetricFu::RoodiGrapher responding to #get_metrics should push 13 to roodi_count
+0.1994550 MetricFu::RcovGrapher responding to #get_metrics should update labels with the date
+0.1985800 MetricFu::ReekGrapher responding to #get_metrics should set a hash of code smells to reek_count
+0.1919860 MetricFu::ReekGrapher responding to #get_metrics should update labels with the date
+0.1907400 MetricFu::RoodiGrapher responding to #get_metrics should update labels with the date
+0.1883000 MetricFu::FlogGrapher responding to #get_metrics should update labels with the date
+0.1882650 MetricFu::FlayGrapher responding to #get_metrics should push 476 to flay_score
+0.1868780 MetricFu::FlogGrapher responding to #get_metrics should push to top_five_percent_average
+0.1847730 MetricFu::FlogGrapher responding to #get_metrics should push 9.9 to flog_average
+0.1844090 MetricFu::FlayGrapher responding to #get_metrics should update labels with the date
+
+Finished in 2.517686 seconds
+
+189 examples, 0 failures
+================================================================================
+lib/templates/awesome/awesome_template.rb
+================================================================================
+   require 'fileutils'
+   
+   class AwesomeTemplate < MetricFu::Template
+   
+     def write
+!!     # Getting rid of the crap before and after the project name from integrity
+!!     @name = File.basename(Dir.pwd).gsub(/^\w+-|-\w+$/, "")
+!! 
+!!     # Copy Bluff javascripts to output directory
+!!     Dir[File.join(this_directory, '..', 'javascripts', '*')].each do |f|
+!!       FileUtils.copy(f, File.join(MetricFu.output_directory, File.basename(f)))
+!!     end
+!! 
+!!     report.each_pair do |section, contents|
+!!       if template_exists?(section)
+!!         create_instance_var(section, contents)
+!!         @html = erbify(section)
+!!         html = erbify('layout')
+!!         fn = output_filename(section)
+!!         MetricFu.report.save_output(html, MetricFu.output_directory, fn)
+!!       end
+!!     end
+!! 
+!!     # Instance variables we need should already be created from above
+!!     if template_exists?('index')
+!!       @html = erbify('index')
+!!       html = erbify('layout')
+!!       fn = output_filename('index')
+!!       MetricFu.report.save_output(html, MetricFu.output_directory, fn)
+!!     end
+!!   end
+   
+     def this_directory
+!!     File.dirname(__FILE__)
+!!   end
+!! end
+   
+================================================================================
+lib/templates/standard/standard_template.rb
+================================================================================
+   class StandardTemplate < MetricFu::Template
+   
+   
+     def write
+!!     report.each_pair do |section, contents|
+!!       if template_exists?(section)
+!!         create_instance_var(section, contents)
+!!         html = erbify(section)
+!!         fn = output_filename(section)
+!!         MetricFu.report.save_output(html, MetricFu.output_directory, fn)
+!!       end
+!!     end
+!! 
+!!     # Instance variables we need should already be created from above
+!!     if template_exists?('index')
+!!       html = erbify('index')
+!!       fn = output_filename('index')
+!!       MetricFu.report.save_output(html, MetricFu.output_directory, fn)
+!!     end
+!!   end
+   
+     def this_directory
+!!     File.dirname(__FILE__)
+!!   end
+!! end
+
+HERE
+
+end
+
+
+

data/spec/generators/reek_spec.rb

@@ -0,0 +1,125 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Reek do
+  describe "analyze method" do
+    before :each do
+      MetricFu::Reek.stub!(:verify_dependencies!).and_return(true)
+      @lines = <<-HERE
+"app/controllers/activity_reports_controller.rb" -- 4 warnings:
+ActivityReportsController#authorize_user calls current_user.primary_site_ids multiple times (Duplication)
+ActivityReportsController#authorize_user calls params[id] multiple times (Duplication)
+ActivityReportsController#authorize_user calls params[primary_site_id] multiple times (Duplication)
+ActivityReportsController#authorize_user has approx 6 statements (Long Method)
+
+"app/controllers/application.rb" -- 1 warnings:
+ApplicationController#start_background_task/block/block is nested (Nested Iterators)
+
+"app/controllers/link_targets_controller.rb" -- 1 warnings:
+LinkTargetsController#authorize_user calls current_user.role multiple times (Duplication)
+
+"app/controllers/newline_controller.rb" -- 1 warnings:
+NewlineController#some_method calls current_user.<< "new line\n" multiple times (Duplication)
+      HERE
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+      reek = MetricFu::Reek.new
+      reek.instance_variable_set(:@output, @lines)
+      @matches = reek.analyze
+    end
+      
+    it "should find the code smell's method name" do
+      smell = @matches.first[:code_smells].first
+      smell[:method].should == "ActivityReportsController#authorize_user"
+    end
+    
+    it "should find the code smell's type" do
+      smell = @matches[1][:code_smells].first
+      smell[:type].should == "Nested Iterators"
+    end
+    
+    it "should find the code smell's message" do
+      smell = @matches[1][:code_smells].first
+      smell[:message].should == "is nested"
+    end
+    
+    it "should find the code smell's type" do
+      smell = @matches.first
+      smell[:file_path].should == "app/controllers/activity_reports_controller.rb"
+    end
+    
+    it "should NOT insert nil smells into the array when there's a newline in the method call" do
+      @matches.last[:code_smells].should == @matches.last[:code_smells].compact
+      @matches.last.should == {:file_path=>"app/controllers/newline_controller.rb", 
+                                :code_smells=>[{:type=>"Duplication", 
+                                                  :method=>"\"", 
+                                                  :message=>"multiple times"}]}
+      # Note: hopefully a temporary solution until I figure out how to deal with newlines in the method call more effectively -Jake 5/11/2009
+    end
+  end
+  
+end
+
+describe Reek do
+  before :each do
+    MetricFu::Reek.stub!(:verify_dependencies!).and_return(true)
+    MetricFu::Configuration.run {}
+    @reek = MetricFu::Reek.new
+    @lines11 = <<-HERE
+"app/controllers/activity_reports_controller.rb" -- 4 warnings:
+ActivityReportsController#authorize_user calls current_user.primary_site_ids multiple times (Duplication)
+ActivityReportsController#authorize_user calls params[id] multiple times (Duplication)
+ActivityReportsController#authorize_user calls params[primary_site_id] multiple times (Duplication)
+ActivityReportsController#authorize_user has approx 6 statements (Long Method)
+
+"app/controllers/application.rb" -- 1 warnings:
+ApplicationController#start_background_task/block/block is nested (Nested Iterators)
+
+"app/controllers/link_targets_controller.rb" -- 1 warnings:
+LinkTargetsController#authorize_user calls current_user.role multiple times (Duplication)
+
+"app/controllers/newline_controller.rb" -- 1 warnings:
+NewlineController#some_method calls current_user.<< "new line\n" multiple times (Duplication)
+      HERE
+    @lines12 = <<-HERE
+app/controllers/activity_reports_controller.rb -- 4 warnings (+3 masked):
+  ActivityReportsController#authorize_user calls current_user.primary_site_ids multiple times (Duplication)
+  ActivityReportsController#authorize_user calls params[id] multiple times (Duplication)
+  ActivityReportsController#authorize_user calls params[primary_site_id] multiple times (Duplication)
+  ActivityReportsController#authorize_user has approx 6 statements (Long Method)
+app/controllers/application.rb -- 1 warnings:
+  ApplicationController#start_background_task/block/block is nested (Nested Iterators)
+app/controllers/link_targets_controller.rb -- 1 warnings (+1 masked):
+  LinkTargetsController#authorize_user calls current_user.role multiple times (Duplication)
+app/controllers/newline_controller.rb -- 1 warnings:
+  NewlineController#some_method calls current_user.<< "new line\n" multiple times (Duplication)
+      HERE
+  end
+
+  context 'with Reek 1.1 output format' do
+    it 'reports 1.1 style when the output is empty' do
+      @reek.instance_variable_set(:@output, "")
+      @reek.should_not be_reek_12
+    end
+    it 'detects 1.1 format output' do
+      @reek.instance_variable_set(:@output, @lines11)
+      @reek.should_not be_reek_12
+    end
+
+    it 'massages empty output to be unchanged' do
+      @reek.instance_variable_set(:@output, "")
+      @reek.massage_for_reek_12.should be_empty
+    end
+  end
+
+  context 'with Reek 1.2 output format' do
+    it 'detects 1.2 format output' do
+      @reek.instance_variable_set(:@output, @lines12)
+      @reek.should be_reek_12
+    end
+
+    it 'correctly massages 1.2 output' do
+      @reek.instance_variable_set(:@output, @lines12)
+      @reek.massage_for_reek_12.should == @lines11
+    end
+  end
+end

data/spec/generators/saikuro_spec.rb

@@ -0,0 +1,58 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+ 
+describe Saikuro do
+  describe "to_h method" do
+    before :all do
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+      saikuro = MetricFu::Saikuro.new
+      saikuro.stub!(:metric_directory).and_return(File.join(File.dirname(__FILE__), "..", "resources", "saikuro"))
+      saikuro.analyze
+      @output = saikuro.to_h
+    end
+
+    it "should find the filename of a file" do
+      @output[:saikuro][:files].first[:filename].should == 'users_controller.rb'
+    end
+ 
+    it "should find the name of the classes" do
+      @output[:saikuro][:classes].first[:name].should == "UsersController"
+      @output[:saikuro][:classes][1][:name].should == "SessionsController"
+    end
+
+    it "should put the most complex method first" do
+      @output[:saikuro][:methods].first[:name].should == "UsersController#create"
+      @output[:saikuro][:methods].first[:complexity].should == 4
+    end
+ 
+    it "should find the complexity of a method" do
+      @output[:saikuro][:methods].first[:complexity].should == 4
+    end
+ 
+    it "should find the lines of a method" do
+      @output[:saikuro][:methods].first[:lines].should == 15
+    end
+  end
+
+  describe "format_directories method" do
+    it "should format the directories" do
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+      saikuro = MetricFu::Saikuro.new
+ 
+      MetricFu.saikuro[:input_directory] = ["app", "lib"]
+  
+      saikuro.format_directories.should == "\"app | lib\""
+    end
+  end
+ 
+  describe Saikuro::SFile do
+    describe "getting elements from a Saikuro result file" do
+      it "should parse nested START/END sections" do
+        path = File.join(File.dirname(__FILE__), "..", "resources", "saikuro_sfiles", "thing.rb_cyclo.html")
+        sfile = Saikuro::SFile.new path
+        sfile.elements.map { |e| e.complexity }.sort.should eql(["0","0","2"])
+      end
+    end
+  end
+end

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,17 @@
+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|
+      graphs[graph] = MetricFu.const_get("#{graph.to_s.capitalize}BluffGrapher").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,109 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
+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
+  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
+end