rferraz-metric_fu 2.1.1

data/spec/base/report_spec.rb

@@ -0,0 +1,146 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe MetricFu do
+
+  describe "#report" do
+    it 'should return an instance of Report' do
+      MetricFu.report.instance_of?(Report).should be(true)
+    end
+  end
+end
+
+describe MetricFu::Report do
+
+  before(:each) do
+    @report = MetricFu::Report.new
+  end
+
+  describe "#to_yaml" do
+    it 'should call #report_hash' do
+      report_hash = mock('report_hash')
+      report_hash.should_receive(:to_yaml)
+      @report.should_receive(:report_hash).and_return(report_hash)
+      @report.to_yaml
+    end
+  end
+
+  describe "#report_hash" do
+  end
+
+  describe "#save_templatized_report" do
+    it 'should create a new template class assign a report_hash '\
+       'to the template class, and ask it to write itself out' do
+      template_class = mock('template_class')
+      template_class.should_receive(:new).and_return(template_class)
+      MetricFu.should_receive(:template_class).and_return(template_class)
+      template_class.should_receive(:report=)
+      template_class.should_receive(:per_file_data=)
+      template_class.should_receive(:write)
+      @report.save_templatized_report
+    end
+  end
+
+  describe "#add" do
+    it 'should add a passed hash to the report_hash instance variable' do
+      report_type = mock('report_type')
+      report_type.should_receive(:to_s).and_return('type')
+
+      report_inst = mock('report_inst')
+      report_type.should_receive(:new).and_return(report_inst)
+
+      report_inst.should_receive(:generate_report).and_return({:a => 'b'})
+      report_inst.should_receive(:respond_to?).and_return(false)
+
+      MetricFu.should_receive(:const_get).
+               with('Type').and_return(report_type)
+      report_hash = mock('report_hash')
+      report_hash.should_receive(:merge!).with({:a => 'b'})
+      @report.should_receive(:report_hash).and_return(report_hash)
+      @report.add(report_type)
+    end
+  end
+
+  describe "#save_output" do
+    it 'should write the passed content to dir/index.html' do
+      f = mock('file')
+      content = 'content'
+      @report.should_receive(:open).with('dir/file', 'w').and_yield(f)
+      f.should_receive(:puts).with(content)
+      @report.save_output(content, 'dir', 'file')
+    end
+  end
+
+  describe '#open_in_browser? ' do
+
+    before(:each) do
+      @config = mock('configuration')
+    end
+
+    describe 'when the platform is os x ' do
+
+      before(:each) do
+        @config.should_receive(:platform).and_return('darwin')
+      end
+
+      describe 'and we are in cruise control ' do
+
+        before(:each) do
+          @config.should_receive(:is_cruise_control_rb?).and_return(true)
+          MetricFu.stub!(:configuration).and_return(@config)
+        end
+
+        it 'should return false' do
+          @report.open_in_browser?.should be_false
+        end
+      end
+
+      describe 'and we are not in cruise control' do
+
+        before(:each) do
+          @config.should_receive(:is_cruise_control_rb?).and_return(false)
+          MetricFu.stub!(:configuration).and_return(@config)
+        end
+
+        it 'should return true' do
+          @report.open_in_browser?.should be_true
+        end
+      end
+    end
+
+    describe 'when the platform is not os x ' do
+      before(:each) do
+        @config.should_receive(:platform).and_return('other')
+      end
+
+      describe 'and we are in cruise control' do
+        before(:each) do
+          MetricFu.stub!(:configuration).and_return(@config)
+        end
+
+        it 'should return false' do
+          @report.open_in_browser?.should be_false
+        end
+      end
+
+      describe 'and we are not in cruise control' do
+        before(:each) do
+          MetricFu.stub!(:configuration).and_return(@config)
+        end
+
+        it 'should return false' do
+          @report.open_in_browser?.should be_false
+        end
+      end
+    end
+  end
+
+
+  describe '#show_in_browser' do
+    it 'should call open with the passed directory' do
+      @report.should_receive(:open_in_browser?).and_return(true)
+      @report.should_receive(:system).with("open my_dir/index.html")
+      @report.show_in_browser('my_dir')
+    end
+
+  end
+end

data/spec/generators/churn_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Churn do
+
+  describe "analyze method" do
+    before :each do
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+      @changes = {"lib/generators/flog.rb"=>2, "lib/metric_fu.rb"=>3}
+    end
+
+    it "should be empty on error" do
+      churn = MetricFu::Churn.new
+      churn.instance_variable_set(:@output, "Churning requires a subversion or git repo")
+      result = churn.analyze
+      result.should == [:churn => {}]
+    end
+
+    it "should return yaml results" do
+      churn = MetricFu::Churn.new
+      churn.instance_variable_set(:@output, "--- \n:churn: \n  :changed_files: \n  - spec/graphs/flog_grapher_spec.rb\n  - spec/base/graph_spec.rb\n  - lib/templates/awesome/layout.html.erb\n  - lib/graphs/rcov_grapher.rb\n  - lib/base/base_template.rb\n  - spec/graphs/grapher_spec.rb\n  - lib/templates/awesome/flog.html.erb\n  - lib/templates/awesome/flay.html.erb\n  - lib/graphs/roodi_grapher.rb\n  - lib/graphs/reek_grapher.rb\n  - HISTORY\n  - spec/graphs/roodi_grapher_spec.rb\n  - lib/generators/rcov.rb\n  - spec/graphs/engines/gchart_spec.rb\n  - spec/graphs/rcov_grapher_spec.rb\n  - lib/templates/javascripts/excanvas.js\n  - lib/templates/javascripts/bluff-min.js\n  - spec/graphs/reek_grapher_spec.rb\n")
+      result = churn.analyze
+      result.should == {:churn=>{:changed_files=>["spec/graphs/flog_grapher_spec.rb", "spec/base/graph_spec.rb", "lib/templates/awesome/layout.html.erb", "lib/graphs/rcov_grapher.rb", "lib/base/base_template.rb", "spec/graphs/grapher_spec.rb", "lib/templates/awesome/flog.html.erb", "lib/templates/awesome/flay.html.erb", "lib/graphs/roodi_grapher.rb", "lib/graphs/reek_grapher.rb", "HISTORY", "spec/graphs/roodi_grapher_spec.rb", "lib/generators/rcov.rb", "spec/graphs/engines/gchart_spec.rb", "spec/graphs/rcov_grapher_spec.rb", "lib/templates/javascripts/excanvas.js", "lib/templates/javascripts/bluff-min.js", "spec/graphs/reek_grapher_spec.rb"]}}
+    end
+
+  end
+
+  describe "to_h method" do
+    before :each do
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+    end
+
+    it "should put the changes into a hash" do
+      churn = MetricFu::Churn.new
+      churn.instance_variable_set(:@churn, {:churn => 'results'})
+      churn.to_h[:churn].should == "results"
+    end
+  end
+end
+

data/spec/generators/flay_spec.rb

@@ -0,0 +1,105 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Flay do
+  describe "emit method" do
+    it "should look at the dirs" do
+      MetricFu::Configuration.run {|config| config.flay = { :dirs_to_flay => ['app', 'lib'], :filetypes => ['rb']  } }
+      File.stub!(:directory?).and_return(true)
+      @flay = MetricFu::Flay.new('base_dir')
+
+      @flay.should_receive(:`).with("flay  app lib")
+      output = @flay.emit
+    end
+
+    it "should limit flay scores by the minimum_score" do
+      MetricFu::Configuration.run {|config| config.flay = { :dirs_to_flay => [], :minimum_score => 99 } }
+      File.stub!(:directory?).and_return(true)
+      @flay = MetricFu::Flay.new('base_dir')
+
+      @flay.should_receive(:`).with("flay --mass 99  ")
+      output = @flay.emit
+    end
+  end
+
+  describe "analyze method" do
+    before :each do
+      lines = <<-HERE
+Total score (lower is better) = 246
+
+
+1) IDENTICAL code found in :or (mass*2 = 68)
+  app/controllers/link_targets_controller.rb:57
+  app/controllers/primary_sites_controller.rb:138
+
+2) Similar code found in :if (mass = 64)
+  app/controllers/primary_sites_controller.rb:75
+  app/controllers/primary_sites_controller.rb:76
+  app/controllers/primary_sites_controller.rb:88
+  app/controllers/primary_sites_controller.rb:89
+      HERE
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+      @flay = MetricFu::Flay.new('base_dir')
+      @flay.instance_variable_set(:@output, lines)
+    end
+
+    it "should analyze and return matches" do
+      @flay.analyze.should == [ ["Total score (lower is better) = 246"],
+                                ["\n1) IDENTICAL code found in :or (mass*2 = 68)",
+                                  "app/controllers/link_targets_controller.rb:57",
+                                  "app/controllers/primary_sites_controller.rb:138"],
+                                ["2) Similar code found in :if (mass = 64)",
+                                  "app/controllers/primary_sites_controller.rb:75",
+                                  "app/controllers/primary_sites_controller.rb:76",
+                                  "app/controllers/primary_sites_controller.rb:88",
+                                  "app/controllers/primary_sites_controller.rb:89"] ]
+    end
+  end
+
+  describe "to_h method" do
+
+    before :each do
+      lines = [ ["Total score (lower is better) = 284"],
+                  ["\n1) IDENTICAL code found in :or (mass*2 = 68)",
+                    "app/controllers/link_targets_controller.rb:57",
+                    "app/controllers/primary_sites_controller.rb:138"],
+                  ["2) Similar code found in :if (mass = 64)",
+                    "app/controllers/primary_sites_controller.rb:75",
+                    "app/controllers/primary_sites_controller.rb:76",
+                    "app/controllers/primary_sites_controller.rb:88",
+                    "app/controllers/primary_sites_controller.rb:89"],
+                  ["3) Similar code found in :defn (mass = 40)",
+                    "app/controllers/link_targets_controller.rb:40",
+                    "app/controllers/primary_sites_controller.rb:98"],
+                  ["4) Similar code found in :defn (mass = 38)",
+                    "app/controllers/link_targets_controller.rb:13",
+                    "app/controllers/primary_sites_controller.rb:50"],
+                  ["5) Similar code found in :defn (mass = 38)",
+                    "app/models/primary_site.rb:104",
+                    "app/models/primary_site.rb:109"],
+                  ["6) Similar code found in :call (mass = 36)",
+                    "app/controllers/bookmarklet_integration_controller.rb:6",
+                    "app/controllers/bookmarklet_integration_controller.rb:17"]]
+
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+      flay = MetricFu::Flay.new('base_dir')
+      flay.instance_variable_set(:@matches, lines)
+      @results = flay.to_h
+    end
+
+    it "should find the total_score" do
+      @results[:flay][:total_score].should == '284'
+    end
+
+    it "should have 6 matches" do
+      @results[:flay][:matches].size.should == 6
+    end
+
+    it "should capture info for match" do
+      @results[:flay][:matches].first[:reason].should =~ /IDENTICAL/
+      @results[:flay][:matches].first[:matches].first[:name].should =~ /link_targets_controller/
+      @results[:flay][:matches].first[:matches].first[:line].should == "57"
+    end
+  end
+end

data/spec/generators/flog_spec.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+describe Flog do
+  before :each do
+    MetricFu::Configuration.run {}
+    File.stub!(:directory?).and_return(true)
+    @flog = MetricFu::Flog.new('base_dir')
+  end
+
+  describe "emit method" do
+    it "should look for files and flog them" do
+      Dir.should_receive(:glob).with("lib/**/*.rb").and_return(["found/file.rb"])
+      ::Flog.should_receive(:parse_options).with(["--all", "--details"]).and_return("options")
+      ::Flog.should_receive(:new).with("options").and_return(flogger = mock('flogger'))
+      flogger.should_receive(:flog).with(["found/file.rb"])
+      @flog.emit
+    end
+  end
+
+  describe "analyze method" do
+    it "should harvest the flog information and put it into method_containers" do
+      first_full_method_name = "ClassName#first_method_name"
+      second_full_method_name = "ClassName#second_method_name"
+
+      flogger = mock('flogger', :calls => {first_full_method_name => {:branch => 11.1, :puts => 1.1},
+                                           second_full_method_name => {:branch => 22.2, :puts => 2.2}},
+                                :method_locations => {first_full_method_name => '/file/location.rb:11',
+                                                      second_full_method_name => '/file/location.rb:22'},
+                                :totals => {first_full_method_name => 11.11,
+                                            second_full_method_name => 22.22})
+      @flog.instance_variable_set(:@flogger, flogger)
+      @flog.analyze
+      method_containers = @flog.instance_variable_get(:@method_containers)
+      method_containers.size.should == 1
+
+      expected={:methods=>{"ClassName#first_method_name" => { :path=>"/file/location.rb:11",
+                                                              :score=>11.11,
+                                                              :operators=>{ :branch=>11.1,
+                                                                            :puts=>1.1}},
+                           "ClassName#second_method_name" => {:path=>"/file/location.rb:22",
+                                                              :score=>22.22,
+                                                              :operators=>{ :branch=>22.2,
+                                                                            :puts=>2.2}}},
+                :path=>"/file/location.rb",
+                :average_score=>((11.11 + 22.22) / 2.0),
+                :total_score=>33.33,
+                :highest_score=>22.22,
+                :name=>"ClassName"}
+
+      method_containers["ClassName"].to_h.should == expected
+    end
+  end
+
+  describe "to_h method" do
+    it "should make-a nice hash" do
+      flogger = mock('flogger', :total => 111.1, :average => 7.3)
+      @flog.instance_variable_set(:@flogger, flogger)
+      method_containers = {:ignore_me_1 =>  mock('container_1', :highest_score => 11.1, :to_h => 'container_1'),
+                           :ignore_me_2 =>  mock('container_2', :highest_score => 33.3, :to_h => 'container_2'),
+                           :ignore_me_3 =>  mock('container_3', :highest_score => 22.2, :to_h => 'container_3')}
+      @flog.instance_variable_set(:@method_containers, method_containers)
+
+      expected = {:flog => { :total => 111.1,
+                  :average => 7.3,
+                  :method_containers => ['container_2', 'container_3', 'container_1']}}
+
+      @flog.to_h.should == expected
+    end
+
+  end
+end

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/flyerhzm/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
+
+
+