edouard-metric_fu 1.0.2

data/spec/base/generator_spec.rb

@@ -0,0 +1,181 @@
+require File.dirname(__FILE__) + "/../spec_helper.rb"
+
+describe MetricFu::Generator do
+
+  MetricFu::Configuration.run do |config|
+  end
+
+  class ConcreteClass < MetricFu::Generator
+    def emit
+    end
+
+    def analyze
+    end
+
+    def to_h
+    end
+  end
+
+  before(:each) do
+    @concrete_class = ConcreteClass.new 
+  end
+
+  describe "ConcreteClass#class_name" do
+    it "should be 'concreteclass'" do
+      ConcreteClass.class_name.should == 'concreteclass'
+    end
+  end
+
+  describe "ConcreteClass#metric_directory" do
+    it "should be 'tmp/metric_fu/scratch/concreteclass'" do
+      ConcreteClass.metric_directory.
+                    should == "tmp/metric_fu/scratch/concreteclass"
+    end
+  end
+
+  describe "#create_metric_dir_if_missing " do
+    describe "when the metric_dir exists " do
+      it 'should not call mkdir_p on FileUtils' do
+        File.stub!(:directory?).and_return(true)
+        FileUtils.should_not_receive(:mkdir_p)
+        @concrete_class.create_metric_dir_if_missing
+      end
+    end
+
+    describe "when the metric_dir does not exist " do
+      it 'should call mkdir_p on FileUtils' do
+        File.stub!(:directory?).and_return(false)
+        FileUtils.should_receive(:mkdir_p)
+        @concrete_class.create_metric_dir_if_missing
+      end
+    end
+  end
+
+  describe "#create_output_dir_if_missing" do
+    describe "when the output_dir exists " do
+      it 'should not call mkdir_p on FileUtils' do
+        File.stub!(:directory?).and_return(true)
+        FileUtils.should_not_receive(:mkdir_p)
+        @concrete_class.create_output_dir_if_missing
+      end
+    end
+
+    describe "when the output_dir does not exist " do
+      it 'should call mkdir_p on FileUtils' do
+        File.stub!(:directory?).and_return(false)
+        FileUtils.should_receive(:mkdir_p)
+        @concrete_class.create_output_dir_if_missing
+      end
+    end
+  end
+
+  describe '#metric_directory' do
+    it 'should return the results of ConcreteClass#metric_directory' do
+      ConcreteClass.stub!(:metric_directory).and_return('foo')
+      @concrete_class.metric_directory.should == 'foo'
+    end
+  end
+
+  describe 'ConcreteClass#generate_report' do
+    it 'should create a new instance of ConcreteClass' do
+      ConcreteClass.should_receive(:new).and_return(@concrete_class)
+      @concrete_class.should_receive(:generate_report).and_return(true)
+      ConcreteClass.generate_report
+    end
+
+    it 'should call #generate_report on the new ConcreteClass' do
+      ConcreteClass.should_receive(:new).and_return(@concrete_class)
+      @concrete_class.should_receive(:generate_report).and_return(true)
+      ConcreteClass.generate_report
+    end
+  end
+  
+  describe '@concrete_class should have hook methods for '\
+           +'[before|after]_[emit|analyze|to_h]' do
+
+    %w[emit analyze].each do |meth|
+
+      it "should respond to #before_#{meth}" do
+        @concrete_class.respond_to?("before_#{meth}".to_sym).should be_true
+      end
+
+      it "should respond to #after_#{meth}" do
+        @concrete_class.respond_to?("after_#{meth}".to_sym).should be_true
+      end
+    end
+      
+    it "should respond to #before_to_h" do
+      @concrete_class.respond_to?("before_to_h".to_sym).should be_true
+    end
+  end
+
+  describe "#generate_report" do
+    it 'should  raise an error when calling #emit' do
+      @abstract_class = MetricFu::Generator.new
+      lambda { @abstract_class.generate_report }.should  raise_error
+    end
+
+    it 'should call #analyze' do
+      @abstract_class = MetricFu::Generator.new
+      lambda { @abstract_class.generate_report }.should  raise_error
+    end
+
+    it 'should call #to_h' do
+      @abstract_class = MetricFu::Generator.new
+      lambda { @abstract_class.generate_report }.should  raise_error
+    end
+  end
+
+  describe "#generate_report (in a concrete class)" do
+    
+    %w[emit analyze].each do |meth|
+      it "should call #before_#{meth}" do
+        @concrete_class.should_receive("before_#{meth}")
+        @concrete_class.generate_report
+      end
+
+      it "should call ##{meth}" do
+        @concrete_class.should_receive("#{meth}")
+        @concrete_class.generate_report
+      end
+
+      it "should call #after_#{meth}" do
+        @concrete_class.should_receive("after_#{meth}")
+        @concrete_class.generate_report
+      end
+    end
+    
+    it "should call #before_to_h" do
+      @concrete_class.should_receive("before_to_h")
+      @concrete_class.generate_report
+    end
+    
+    it "should call #to_h" do
+      @concrete_class.should_receive(:to_h)
+      @concrete_class.generate_report
+    end
+    
+    it "should raise error if the concrete class is missing a required dependency" do
+      concrete_class_with_missing_gem = Class.new(MetricFu::Generator) do
+        def self.verify_dependencies!
+          raise 'gem install something # if you want these tasks'
+        end
+      end
+      lambda { concrete_class_with_missing_gem.generate_report }.should raise_error("gem install something # if you want these tasks")
+    end
+
+  end
+  
+  describe "instantiation" do
+    it "should fail is dependencies not verified" do
+      ConcreteClass.should_receive(:verify_dependencies!).and_raise("Missing a required gem. Please 'gem install something'")      
+      lambda { ConcreteClass.new() }.should raise_error("Missing a required gem. Please 'gem install something'")
+    end
+
+    it "should succeed when dependencies verified" do
+      ConcreteClass.should_receive(:verify_dependencies!).and_return(true)
+      ConcreteClass.new()
+    end
+  end
+  
+end

data/spec/base/md5_tracker_spec.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe MetricFu::MD5Tracker do
+  before do
+    @tmp_dir = File.join(File.dirname(__FILE__), 'tmp')
+    FileUtils.mkdir_p(@tmp_dir, :verbose => false) unless File.directory?(@tmp_dir)
+    @file1 = File.new(File.join(@tmp_dir, 'file1.txt'), 'w')
+    @file2 = File.new(File.join(@tmp_dir, 'file2.txt'), 'w')
+  end
+
+  after do
+    FileUtils.rm_rf(@tmp_dir, :verbose => false)
+  end
+
+  it "identical files should match" do
+    @file1.puts("Hello World")
+    @file1.close
+    file1_md5 = MD5Tracker.track(@file1.path, @tmp_dir)
+
+    @file2.puts("Hello World")
+    @file2.close
+    file2_md5 = MD5Tracker.track(@file2.path, @tmp_dir)
+
+    file2_md5.should == file1_md5
+  end
+
+  it "different files should not match" do
+    @file1.puts("Hello World")
+    @file1.close
+    file1_md5 = MD5Tracker.track(@file1.path, @tmp_dir)
+
+    @file2.puts("Goodbye World")
+    @file2.close
+    file2_md5 = MD5Tracker.track(@file2.path, @tmp_dir)
+
+    file2_md5.should_not == file1_md5
+  end
+
+  it "file_changed? should detect a change" do
+      @file2.close
+
+      @file1.puts("Hello World")
+      @file1.close
+      file1_md5 = MD5Tracker.track(@file1.path, @tmp_dir)
+
+      @file1 = File.new(File.join(@tmp_dir, 'file1.txt'), 'w')
+      @file1.puts("Goodbye World")
+      @file1.close
+      MD5Tracker.file_changed?(@file1.path, @tmp_dir).should be_true
+  end
+
+  it "should detect a new file" do
+    @file2.close
+    MD5Tracker.file_changed?(@file1.path, @tmp_dir).should be_true
+    File.exist?(MD5Tracker.md5_file(@file1.path, @tmp_dir)).should be_true
+  end
+end

data/spec/base/report_spec.rb

@@ -0,0 +1,139 @@
+require File.dirname(__FILE__) + "/../spec_helper.rb"
+
+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(: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_type.should_receive(:generate_report).and_return({:a => 'b'})
+      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,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
+      MetricFu::Churn.should_receive(:system).and_return(true)
+      Churn::Git.should_receive(:new)
+      MetricFu::Churn.new
+    end
+    
+    it "should setup git if .svn exits" do
+      MetricFu::Churn.should_receive(:system).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
+      MetricFu::Churn.should_receive(:system).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)
+      MetricFu::Churn.should_receive(:system).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)
+      MetricFu::Churn.should_receive(:system).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)
+      MetricFu::Churn.should_receive(:system).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)
+      MetricFu::Churn.should_receive(:system).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,104 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Flay do 
+  before :each do
+    MetricFu::Flay.stub!(:verify_dependencies!).and_return(true)
+  end
+  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