bf4-metric_fu 2.1.3.1

data/spec/generators/rails_best_practices_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe RailsBestPractices do
+  describe "emit method" do
+    it "should gather the raw data" do
+      MetricFu::Configuration.run {}
+      practices = MetricFu::RailsBestPractices.new
+      practices.should_receive(:`).with("rails_best_practices --without-color .")
+      practices.emit
+    end
+  end
+
+  describe "analyze method" do
+    before :each do
+      output = <<-HERE.gsub(/^[^\S\n]*/, "")
+      ./app/views/admin/testimonials/_form.html.erb:17 - replace instance variable with local variable
+      ./app/controllers/admin/campaigns_controller.rb:24,45,68,85 - use before_filter for show,edit,update,destroy
+
+      go to http://wiki.github.com/railsbp/rails_best_practices to see how to solve these errors.
+
+      Found 2 errors.
+      HERE
+      MetricFu::Configuration.run {}
+      practices = MetricFu::RailsBestPractices.new
+      practices.instance_variable_set(:@output, output)
+      @results = practices.analyze
+    end
+
+    it "should get the total" do
+      @results[:total].should == ["Found 2 errors."]
+    end
+
+    it "should get the problems" do
+      @results[:problems].size.should == 2
+      @results[:problems].first.should == { :line => "17",
+        :problem => "replace instance variable with local variable",
+        :file => "app/views/admin/testimonials/_form.html.erb" }
+      @results[:problems][1].should == { :line => "24,45,68,85",
+        :problem => "use before_filter for show,edit,update,destroy",
+        :file => "app/controllers/admin/campaigns_controller.rb" }
+    end
+  end
+
+  describe "to_h method" do
+    it "should put things into a hash" do
+      MetricFu::Configuration.run {}
+      practices = MetricFu::RailsBestPractices.new
+      practices.instance_variable_set(:@rails_best_practices_results, "the_practices")
+      practices.to_h[:rails_best_practices].should == "the_practices"
+    end
+  end
+end

data/spec/generators/rcov_spec.rb

@@ -0,0 +1,180 @@
+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)
+      MetricFu.rcov[:external] = nil
+    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
+      MetricFu.rcov[:external] = nil
+      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
+  describe "with external configuration option set" do
+    before :each do
+      @rcov.stub!(:puts)
+      MetricFu.rcov[:external] = "coverage/rcov.txt"
+    end
+
+    it "should emit nothing if external configuration option is set" do
+      FileUtils.should_not_receive(:rm_rf)
+      @rcov.emit
+    end
+
+    it "should open the external rcov analysis file" do
+      File.should_receive(:open).
+            with(MetricFu.rcov[:external]).
+            and_return(mock("io", :read => RCOV_OUTPUT))
+      @files = @rcov.analyze
+    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,134 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Reek do
+  describe "emit" do
+    it "should include config parameters" do
+      MetricFu::Configuration.run do |config|
+        config.reek = {:config_file_pattern => 'lib/config/*.reek', :dirs_to_reek => []}
+      end
+      reek = MetricFu::Reek.new
+      reek.should_receive(:`).with(/--config lib\/config\/\*\.reek/).and_return("")
+      reek.emit
+    end
+  end
+
+  describe "analyze method" do
+    before :each do
+      @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::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/roodi_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Roodi do
+  describe "emit" do
+    it "should add config options when present" do
+      MetricFu::Configuration.run do |config|
+        config.roodi = {:roodi_config => 'lib/config/roodi_config.yml', :dirs_to_roodi => []}
+      end
+      roodi = MetricFu::Roodi.new
+      roodi.should_receive(:`).with(/-config=lib\/config\/roodi_config\.yml/).and_return("")
+      roodi.emit
+    end
+
+    it "should NOT add config options when NOT present" do
+      MetricFu::Configuration.run do |config|
+        config.roodi = {:dirs_to_roodi => []}
+      end
+      roodi = MetricFu::Roodi.new
+      roodi.stub(:`)
+      roodi.should_receive(:`).with(/-config/).never
+      roodi.emit
+    end
+  end
+end

data/spec/generators/saikuro_spec.rb

@@ -0,0 +1,74 @@
+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 == 'app/controllers/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 "per_file_info 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 "doesn't try to get information if the file does not exist" do
+      File.should_receive(:exists?).at_least(:once).and_return(false)
+      @saikuro.per_file_info('ignore_me')
+    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