jscruggs-metric_fu 0.9.0 → 1.0.0

data/spec/generators/churn_spec.rb

@@ -0,0 +1,152 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Churn do
+  describe "initialize" do
+    before :each do
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+    end
+    
+    it "should setup git if .git exits" do
+      File.should_receive(:exist?).with(".git").and_return(true)
+      Churn::Git.should_receive(:new)
+      MetricFu::Churn.new
+    end
+    
+    it "should setup git if .svn exits" do
+      File.should_receive(:exist?).with(".git").and_return(false)
+      File.should_receive(:exist?).with(".svn").and_return(true)
+      Churn::Svn.should_receive(:new)
+      MetricFu::Churn.new()
+    end
+    
+    it "should raise an error if not .svn or .git" do
+      File.stub!(:exist?).and_return(false)
+      lambda{MetricFu::Churn.new()}.should raise_error(Exception)
+    end
+  end
+  
+  describe "emit method with git" do
+    before :each do
+      MetricFu::Configuration.run {|config| config.churn = {:minimum_churn_count => 2} }
+      File.stub!(:directory?).and_return(true)
+      File.should_receive(:exist?).with(".git").and_return(true)
+      @git = Churn::Git.new
+      Churn::Git.should_receive(:new).and_return(@git)
+      @lines = <<-HERE.gsub(/^\s*/, "")
+      
+      lib/generators/flog.rb
+      spec/generators/flog_spec.rb
+
+
+      lib/generators/flog.rb
+      spec/generators/flay_spec.rb
+
+
+      lib/metric_fu.rb
+
+
+      lib/generators/saikuro.rb
+      lib/metric_fu.rb
+      tasks/metric_fu.rake
+
+
+      spec/churn_spec.rb
+      spec/config_spec.rb
+      spec/flay_spec.rb
+      spec/flog_spec.rb
+      lib/metric_fu.rb
+      spec/reek_spec.rb
+      HERE
+    end
+    
+    it "should read the logs" do
+      churn = MetricFu::Churn.new
+      @git.should_receive(:`).with("git log  --name-only --pretty=format:").and_return(@lines)
+      changes = churn.emit
+      changes["lib/generators/flog.rb"].should == 2
+      changes["lib/metric_fu.rb"].should == 3
+    end
+  end
+  
+  describe "emit method with svn" do
+    before :each do
+      MetricFu::Configuration.run{|config| config.churn = {:minimum_churn_count => 2} }
+      File.stub!(:directory?).and_return(true)
+      File.should_receive(:exist?).with(".git").and_return(false)
+      File.should_receive(:exist?).with(".svn").and_return(true)
+      @svn = Churn::Svn.new
+      Churn::Svn.should_receive(:new).and_return(@svn)
+      @lines = <<-HERE.gsub(/^\s*/, "")
+      ------------------------------------------------------------------------
+      r3183 | dave | 2009-04-28 07:23:37 -0500 (Tue, 28 Apr 2009) | 1 line
+      Changed paths:
+         M /trunk/app/views/promotions/index.erb
+         M /trunk/app/models/email_personalizer.rb
+
+      making custom macros case-insensitive
+      ------------------------------------------------------------------------
+      r3182 | marc | 2009-04-28 03:59:32 -0500 (Tue, 28 Apr 2009) | 1 line
+      Changed paths:
+         M /trunk/app/models/file_extraction.rb
+         M /trunk/app/views/promotions/index.erb
+         M /trunk/config/environment.rb
+
+      Demo of the drop out effect for uploading promotions.
+      ------------------------------------------------------------------------
+      r3181 | dave | 2009-04-27 21:40:04 -0500 (Mon, 27 Apr 2009) | 1 line
+      Changed paths:
+         M /trunk/app/views/promotions/index.erb
+         A /trunk/app/models/file_extraction.rb
+         A /trunk/app/models/url_file_extraction.rb
+         M /trunk/app/models/zip_file_extraction.rb
+         M /trunk/test/data/zip_test.zip
+         M /trunk/test/unit/zip_file_extraction_test.rb
+
+      URL imports
+      HERE
+    end
+    
+    it "should read the logs" do
+      churn = MetricFu::Churn.new
+      @svn.should_receive(:`).with("svn log  --verbose").and_return(@lines)
+      changes = churn.emit
+      changes["/trunk/app/views/promotions/index.erb"].should == 3
+      changes["/trunk/app/models/file_extraction.rb"].should == 2
+    end
+  end
+  
+  describe "analyze method" do
+    before :each do
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+      File.should_receive(:exist?).with(".git").and_return(true)
+      @changes = {"lib/generators/flog.rb"=>2, "lib/metric_fu.rb"=>3}
+    end
+    
+    it "should organize and format" do
+      churn = MetricFu::Churn.new
+      churn.instance_variable_set(:@changes, @changes)
+      changes = churn.analyze
+      changes.first[:file_path].should == "lib/metric_fu.rb"
+      changes.first[:times_changed].should == 3
+      changes[1][:file_path].should == "lib/generators/flog.rb"
+      changes[1][:times_changed].should == 2
+    end
+  end
+  
+  describe "to_h method" do
+    before :each do
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+      File.should_receive(:exist?).with(".git").and_return(true)
+    end
+    
+    it "should put the changes into a hash" do
+      churn = MetricFu::Churn.new
+      churn.instance_variable_set(:@changes, "churn_info")
+      churn.to_h[:churn][:changes].should == "churn_info"
+    end
+  end
+end
+

data/spec/generators/flay_spec.rb

@@ -0,0 +1,101 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Flay do 
+  describe "emit method" do
+    before :each do
+      MetricFu::Configuration.run {|config| config.flay = { :dirs_to_flay => ['app', 'lib']  } }
+      File.stub!(:directory?).and_return(true)
+      @flay = MetricFu::Flay.new('base_dir')
+      
+    end
+    
+    it "should look at the dirs" do
+      Dir.should_receive(:[]).with(File.join("app", "**/*.rb")).and_return("path/to/app")
+      Dir.should_receive(:[]).with(File.join("lib", "**/*.rb")).and_return("path/to/lib")
+      @flay.should_receive(:`).with("flay path/to/app path/to/lib")
+      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,189 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Flog do
+  before :each do
+    @text = <<-HERE
+    157.9: flog total
+     11.3: flog/method average
+
+     34.8: UsersController#create
+      9.2: branch
+      6.8: current_user
+      5.2: assignment
+      3.4: role
+      3.0: render
+      3.0: ==
+      2.8: flash
+      1.6: after_create_page
+      1.6: params
+      1.5: activate!
+      1.5: errors
+      1.4: login
+      1.4: redirect_to
+      1.4: []
+      1.3: empty?
+      1.3: save
+      1.2: new
+     24.2: UsersController#authorize_user
+      4.8: branch
+      4.7: current_user
+      3.6: params
+      3.2: []
+      2.6: ==
+      1.5: role
+      1.5: to_i
+      1.5: id
+      1.4: new_session_path
+      1.3: include?
+      1.2: assignment
+      1.2: flash
+      1.2: redirect_to
+     16.4: UsersController#thank_you
+      4.0: assignment
+      3.3: params
+      2.9: []
+      2.7: redirect_to
+      2.4: branch
+      1.5: new_session_path
+      1.4: flash
+      1.4: activate!
+      1.3: can_activate?
+      1.2: find_by_id
+     14.2: UsersController#update
+      3.2: params
+      2.8: []
+      2.6: assignment
+      1.4: login
+      1.4: flash
+      1.4: redirect_to
+      1.3: render
+      1.2: branch
+      1.2: update_attributes
+      1.2: find_by_id
+     12.5: UsersController#sanitize_params
+      3.9: assignment
+      3.6: branch
+      3.0: current_user
+      1.6: params
+      1.5: role
+      1.4: []
+      1.3: include?
+      1.3: ==
+      1.2: reject!
+     10.6: UsersController#users_have_changed
+      3.9: assignment
+      2.6: branch
+      1.6: params
+      1.5: refresh_from_external
+      1.4: find_by_id
+      1.4: []
+      1.2: split
+      1.2: each
+      1.2: head
+     10.0: UsersController#after_create_page
+      3.0: current_user
+      2.6: id
+      2.4: branch
+      1.5: role
+      1.3: login
+      1.3: ==
+      8.4: UsersController#add_primary_site
+      2.4: assignment
+      1.6: params
+      1.4: []
+      1.4: new
+      1.2: find_by_id
+      1.2: all
+      1.2: render
+      7.7: UsersController#none
+      3.3: before_filter
+      1.1: private
+      1.1: caches_page
+      1.1: after_filter
+      1.1: skip_before_filter
+      7.2: UsersController#destroy
+      1.8: params
+      1.6: []
+      1.4: find_by_id
+      1.2: destroy
+      1.2: redirect_to
+      5.9: UsersController#edit
+      2.4: assignment
+      1.6: params
+      1.4: []
+      1.2: all
+      1.2: find_by_id
+      2.7: UsersController#signup
+      1.2: render
+      1.2: assignment
+      1.2: new
+      1.7: UsersController#new
+      1.2: assignment
+      1.2: new
+      1.7: UsersController#index
+      1.2: assignment
+      1.2: all
+    HERE
+  end
+  
+  describe "parse method" do
+    before :each do
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+      flog = MetricFu::Flog.new('base_dir')
+      @flog_page = flog.parse(@text)
+    end
+    
+    it "should find the total score" do
+      @flog_page.score.should == 157.9
+    end
+    
+    it "should find the average score" do
+      @flog_page.average_score.should == 11.3
+    end
+    
+    it "should find the scanned method score" do
+      @flog_page.scanned_methods.first.score.should == 34.8
+    end
+    
+    it "should find the scanned method name" do
+      @flog_page.scanned_methods.first.name.should == "UsersController#create"
+    end
+    
+    it "should find the scanned method opperators names" do
+      @flog_page.scanned_methods.first.operators.first.operator.should == "branch"
+    end
+    
+    it "should find the scanned method opperators scores" do
+      @flog_page.scanned_methods.first.operators.first.score.should == 9.2
+    end
+  end
+  
+  describe "to_h function" do
+    before :each do
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+      flog = MetricFu::Flog.new('base_dir')
+      flog.should_receive(:open).and_return(@text)
+      Dir.should_receive(:glob).and_return(["tmp/metric_fu/scratch/flog/app/controllers/user_controller.txt"])
+      flog.analyze
+      @flog_hash = flog.to_h
+    end
+    
+    it "should put the total in the hash" do
+      @flog_hash[:flog][:total].should == 157.9
+    end
+    
+    it "should put the average in the hash" do
+      @flog_hash[:flog][:average].should == 11.3
+    end
+    
+    it "should put pages into the hash" do
+      @flog_hash[:flog][:pages].first[:scanned_methods].first[:score].should == 34.8
+    end
+    
+    it "should put the filename into the hash" do
+      @flog_hash[:flog][:pages].first[:path].should == "/app/controllers/user_controller.rb"
+    end
+  end
+end

data/spec/generators/reek_spec.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Reek do
+  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)
+      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
+      first_smell = @matches.first[:code_smells].first
+      first_smell[:method].should == "ActivityReportsController#authorize_user"
+    end
+    
+    it "should find the code smell's type" do
+      first_smell = @matches[1][:code_smells].first
+      first_smell[:type].should == "Nested Iterators"
+    end
+    
+    it "should find the code smell's message" do
+      first_smell = @matches[1][:code_smells].first
+      first_smell[:message].should == "is nested"
+    end
+    
+    it "should find the code smell's type" do
+      first_smell = @matches.first
+      first_smell[:file_path].should == "app/controllers/activity_reports_controller.rb"
+    end
+  end
+  
+end

data/spec/generators/saikuro_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Saikuro 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

data/spec/generators/stats_spec.rb

@@ -0,0 +1,74 @@
+require 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/spec_helper.rb

@@ -2,10 +2,27 @@ require 'rubygems'
 require 'spec'
 require 'date'
 
-require File.join(File.dirname(__FILE__), '/../lib/metric_fu/base')
-require File.join(File.dirname(__FILE__), '/../lib/metric_fu/flay')
-require File.join(File.dirname(__FILE__), '/../lib/metric_fu/flog')
-require File.join(File.dirname(__FILE__), '/../lib/metric_fu/md5_tracker')
-require File.join(File.dirname(__FILE__), '/../lib/metric_fu/churn')
-require File.join(File.dirname(__FILE__), '/../lib/metric_fu/reek')
-include MetricFu
+require File.join(File.dirname(__FILE__), '/../lib/metric_fu.rb')
+include MetricFu
+
+Mystat = <<-EOF
+(in /Users/gmcinnes/Documents/projects/NeerBeer/src/Web)
++----------------------+-------+-------+---------+---------+-----+-------+
+| Name                 | Lines |   LOC | Classes | Methods | M/C | LOC/M |
++----------------------+-------+-------+---------+---------+-----+-------+
+| Controllers          |   893 |   405 |      16 |      41 |   2 |     7 |
+| Helpers              |   569 |   352 |       0 |      52 |   0 |     4 |
+| Models               |  1758 |   453 |      26 |      48 |   1 |     7 |
+| Libraries            |  2507 |  1320 |      19 |     175 |   9 |     5 |
+| Model specs          |  2285 |   965 |       0 |       1 |   0 |   963 |
+| View specs           |   821 |   654 |       0 |       2 |   0 |   325 |
+| Controller specs     |  1144 |   871 |       0 |       9 |   0 |    94 |
+| Helper specs         |   652 |   465 |       0 |       1 |   0 |   463 |
+| Library specs        |  1456 |  1141 |       8 |      14 |   1 |    79 |
++----------------------+-------+-------+---------+---------+-----+-------+
+| Total                | 12085 |  6626 |      69 |     343 |   4 |    17 |
++----------------------+-------+-------+---------+---------+-----+-------+
+  Code LOC: 2530     Test LOC: 4096     Code to Test Ratio: 1:1.6
+
+EOF
+

data/tasks/metric_fu.rake

@@ -0,0 +1,14 @@
+require 'rake'
+namespace :metrics do
+  desc "Generate all metrics reports"
+  task :all do
+    MetricFu.metrics.each {|metric| MetricFu.report.add(metric) }
+    MetricFu.report.save_output(MetricFu.report.to_yaml,
+                                MetricFu.base_directory, 
+                                'report.yml')
+    MetricFu.report.save_templatized_report
+    if MetricFu.report.open_in_browser?
+      MetricFu.report.show_in_browser(MetricFu.output_directory)
+    end
+  end
+end