jscruggs-metric_fu 0.9.0 → 1.0.0

data/spec/base/configuration_spec.rb

@@ -0,0 +1,303 @@
+require File.dirname(__FILE__) + "/../spec_helper.rb"
+
+describe MetricFu::Configuration do
+    
+  def get_new_config
+    @config = Configuration.new
+  end
+  
+  def base_directory
+    @config.instance_variable_get(:@base_directory)
+  end
+
+  def output_directory
+    @config.instance_variable_get(:@output_directory)
+  end
+
+  def scratch_directory
+    @config.instance_variable_get(:@scratch_directory)
+  end
+
+  def template_directory
+    @config.instance_variable_get(:@template_directory)
+  end
+
+  def template_class
+    @config.instance_variable_get(:@template_class)
+  end
+
+  def metric_fu_root
+    @config.instance_variable_get(:@metric_fu_root_directory)
+  end
+
+  describe '#warn_about_deprecated_config_options' do
+
+    def get_new_config_and_raise_runtime_error
+      lambda { get_new_config  }.should raise_error
+    end
+
+    describe 'when ::MetricFu::CHURN_OPTIONS is present' do
+      before(:each) { ::MetricFu::CHURN_OPTIONS = 'option' }
+      after(:each)  { ::MetricFu.send(:remove_const, 'CHURN_OPTIONS') }
+      
+      it 'should raise a RuntimeError with "Use config.churn '+ 
+      'instead of MetricFu::CHURN_OPTIONS"' do
+        get_new_config_and_raise_runtime_error
+      end
+    end
+    
+    describe 'when ::MetricFu::DIRECTORIES_TO_FLOG is present' do
+      before(:each) { ::MetricFu::DIRECTORIES_TO_FLOG = 'option' }
+      after(:each)  { ::MetricFu.send(:remove_const,'DIRECTORIES_TO_FLOG')}
+
+      it 'should raise a RuntimeError with "Use config.flog '+
+      '[:dirs_to_flog] instead of MetricFu::DIRECTORIES_TO_FLOG' do
+        get_new_config_and_raise_runtime_error
+      end 
+    end
+
+    describe 'when ::MetricFu::SAIKURO_OPTIONS is present' do
+      before(:each) { ::MetricFu::SAIKURO_OPTIONS = 'option' }
+      after(:each)  { ::MetricFu.send(:remove_const,'SAIKURO_OPTIONS')}
+      
+      it 'should raise a RuntimeError with "Use config.saikuro '+
+      'instead of MetricFu::SAIKURO_OPTIONS' do 
+        get_new_config_and_raise_runtime_error
+      end
+    end
+
+    describe 'when SAIKURO_OPTIONS is present' do
+      before(:each) { SAIKURO_OPTIONS = 'option' }
+      after(:each)  { Object.send(:remove_const,'SAIKURO_OPTIONS')}
+      
+      it 'should raise a RuntimeError with "Use config.saikuro '+
+      'instead of SAIKURO_OPTIONS' do
+        get_new_config_and_raise_runtime_error
+      end
+    end
+  end
+
+  describe "#reset" do
+    
+    before(:each) { get_new_config } 
+    
+    describe 'when there is a CC_BUILD_ARTIFACTS environment variable' do
+      before(:each) { ENV['CC_BUILD_ARTIFACTS'] = 'foo' } 
+   
+      it 'should return the CC_BUILD_ARTIFACTS environment variable' do
+        get_new_config
+        base_directory.should == ENV['CC_BUILD_ARTIFACTS']
+      end
+    end
+
+    describe 'when there is no CC_BUILD_ARTIFACTS environment variable' do
+      before(:each) { ENV['CC_BUILD_ARTIFACTS'] = nil  }
+      
+      it 'should return "tmp/metric_fu"' do
+        get_new_config
+        base_directory.should == "tmp/metric_fu"
+      end
+    end
+    
+    it 'should set @metric_fu_root_directory to the base of the '+
+    'metric_fu application' do
+      app_root = File.join(File.dirname(__FILE__), '..', '..')
+      app_root_absolute_path = File.expand_path(app_root)
+      metric_fu_absolute_path = File.expand_path(metric_fu_root)
+      metric_fu_absolute_path.should == app_root_absolute_path 
+    end
+
+    it 'should set @template_directory to the lib/templates relative '+
+    'to @metric_fu_root_directory' do
+      template_dir = File.join(File.dirname(__FILE__), 
+                               '..', '..', 'lib','templates')
+      template_dir_abs_path = File.expand_path(template_dir)
+      calc_template_dir_abs_path = File.expand_path(template_directory)
+      calc_template_dir_abs_path.should == template_dir_abs_path
+    end
+    
+    it 'should set @scratch_directory to scratch relative '+
+    'to @base_directory' do
+      scratch_dir = File.join(base_directory, 'scratch')
+      scratch_directory.should == scratch_dir
+    end
+
+    it 'should set @output_directory to output relative '+
+    'to @base_directory' do
+      output_dir = File.join(base_directory, 'output')
+      output_directory.should == output_dir
+    end
+    
+    it 'should set @template_class to StandardTemplate' do
+      template_class.should == StandardTemplate
+    end
+
+    it 'should set @flay to {:dirs_to_flay => @code_dirs}' do
+      @config.instance_variable_get(:@flay).
+              should == {:dirs_to_flay => ['lib']}
+    end
+    
+    it 'should set @flog to {:dirs_to_flog => @code_dirs}' do
+      @config.instance_variable_get(:@flog).
+              should == {:dirs_to_flog => ['lib']}
+    end
+    
+    it 'should set @reek to {:dirs_to_reek => @code_dirs}' do
+      @config.instance_variable_get(:@reek).
+              should == {:dirs_to_reek => ['lib']}
+    end
+
+    it 'should set @roodi to {:dirs_to_roodi => @code_dirs}' do
+      @config.instance_variable_get(:@roodi).
+              should == {:dirs_to_roodi => ['lib']}
+    end
+   
+    it 'should set @churn to {}' do
+      @config.instance_variable_get(:@churn).
+              should == {}
+    end
+
+    it 'should set @stats to {}' do
+      @config.instance_variable_get(:@stats).
+              should == {}
+    end
+
+    it 'should set @rcov to { :test_files => ["test/**/*_test.rb", 
+                                              "spec/**/*_spec.rb"] 
+                              :rcov_opts  => ["--sort coverage",   
+                                              "--no-html",         
+                                              "--text-coverage",   
+                                              "--no-color",        
+                                              "--profile",         
+                                              "--rails",           
+                                              "--exclude /gems/,/Library/,spec"]}' do
+      @config.instance_variable_get(:@rcov).
+              should ==  { :test_files => ['test/**/*_test.rb', 
+                                           'spec/**/*_spec.rb'],
+                           :rcov_opts => ["--sort coverage", 
+                                         "--no-html", 
+                                         "--text-coverage",
+                                         "--no-color",
+                                         "--profile",
+                                         "--rails",
+                                         "--exclude /gems/,/Library/,spec"]}
+    end
+
+    it 'should set @saikuro to { :output_directory => @scratch_directory + "/saikuro",
+                                 :input_directory => @code_dirs,
+                                 :cyclo => "",
+                                 :filter_cyclo => "0",
+                                 :warn_cyclo => "5",
+                                 :error_cyclo => "7",
+                                 :formater => "text" }' do
+      @config.instance_variable_get(:@saikuro).
+              should ==  { :output_directory => 'tmp/metric_fu/scratch/saikuro', 
+                    :input_directory => ['lib'],
+                    :cyclo => "",
+                    :filter_cyclo => "0",
+                    :warn_cyclo => "5",
+                    :error_cyclo => "7",
+                    :formater => "text"}
+    end
+
+    describe 'if #rails? is true ' do
+      before(:each) do
+        @config.stub!(:rails?).and_return(true)
+      end
+
+      describe '#set_metrics ' do
+        it 'should set the @metrics instance var to AVAILABLE_METRICS + '\
+           +'[:stats]' do
+          @config.instance_variable_get(:@metrics).
+                  should == MetricFu::AVAILABLE_METRICS << [:stats]
+        end
+      end
+
+      describe '#set_code_dirs ' do
+        it 'should set the @code_dirs instance var to ["app", "lib"]' do
+          # This is hard to spec properly because the @code_dirs variable
+          # is set during the reset process.
+          #@config.instance_variable_get(:@code_dirs).
+          #        should == ['app','lib']
+        end
+      end
+    end
+
+    describe 'if #rails? is false ' do
+      before(:each) do
+        @config.stub!(:rails?).and_return(false)
+      end
+     
+      describe '#set_metrics ' do
+        it 'should set the @metrics instance var to AVAILABLE_METRICS' do
+          @config.instance_variable_get(:@metrics).
+                  should == MetricFu::AVAILABLE_METRICS
+        end
+      end
+
+      describe '#set_code_dirs ' do
+        it 'should set the @code_dirs instance var to ["lib"]' do
+          @config.instance_variable_get(:@code_dirs).should == ['lib']
+        end
+      end
+    end
+  end
+
+  describe '#add_attr_accessors_to_self' do
+    
+    before(:each) { get_new_config } 
+  
+    MetricFu::AVAILABLE_METRICS.each do |metric|
+      it "should have a reader for #{metric}" do
+        @config.respond_to?(metric).should be_true
+      end
+
+      it "should have a writer for #{metric}=" do
+        @config.respond_to?((metric.to_s + '=').to_sym).should be_true
+      end
+    end
+  end
+
+  describe '#add_class_methods_to_metric_fu' do
+  
+    before(:each) { get_new_config }
+
+    MetricFu::AVAILABLE_METRICS.each do |metric|
+      it "should add a #{metric} class method to the MetricFu module " do
+        MetricFu.respond_to?(metric).should be_true
+      end
+    end
+  end
+
+  describe '#platform' do
+
+    before(:each) { get_new_config }
+
+    it 'should return the value of the PLATFORM constant' do
+      this_platform = PLATFORM
+      @config.platform.should == this_platform
+    end
+  end
+
+  describe '#is_cruise_control_rb? ' do
+
+    before(:each) { get_new_config }
+    describe "when the CC_BUILD_ARTIFACTS env var is not nil" do
+
+      before(:each) { ENV['CC_BUILD_ARTIFACTS'] = 'is set' }
+
+      it 'should return true'  do
+        @config.is_cruise_control_rb?.should be_true
+      end
+
+    end
+
+    describe "when the CC_BUILD_ARTIFACTS env var is nil" do
+      before(:each) { ENV['CC_BUILD_ARTIFACTS'] = nil }
+     
+      it 'should return false' do
+        @config.is_cruise_control_rb?.should be_false
+      end
+    end
+  end
+end

data/spec/base/generator_spec.rb

@@ -0,0 +1,159 @@
+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
+
+  end
+end

data/spec/{md5_tracker_spec.rb → base/md5_tracker_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.dirname(__FILE__) + '/../spec_helper.rb'
 
 describe MetricFu::MD5Tracker do
   before do

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