cdd-metric_fu 1.3.1

data/spec/base/base_template_spec.rb

@@ -0,0 +1,161 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+require 'erb'
+
+describe MetricFu::Template do
+
+  before(:each) do
+    @template =  Template.new
+  end
+
+  describe "#erbify" do
+    it 'should evaluate a erb doc' do
+      section = 'section'
+      File.stub!(:read).and_return('foo')
+      erb = mock('erb')
+      erb.should_receive(:result)
+      ERB.should_receive(:new).with('foo').and_return(erb)
+      @template.should_receive(:template).and_return('foo')
+      @template.send(:erbify, section)
+    end
+  end
+
+  describe "#template_exists? " do
+
+    before(:each) do
+      @section = mock('section')
+      @template.should_receive(:template).
+                with(@section).and_return(@section)
+    end
+
+    describe 'if the template exists' do
+      it 'should return true' do
+        File.should_receive(:exist?).with(@section).and_return(true)
+        result = @template.send(:template_exists?, @section)
+        result.should be_true
+      end
+    end
+
+    describe 'if the template does not exist' do
+      it 'should return false' do
+        File.should_receive(:exist?).with(@section).and_return(false)
+        result = @template.send(:template_exists?, @section)
+        result.should be_false
+      end
+    end
+  end
+
+  describe "#create_instance_var" do
+    it 'should set an instance variable with the passed contents' do
+      section = 'section'
+      contents = 'contents'
+      @template.send(:create_instance_var, section, contents)
+      @template.instance_variable_get(:@section).should == contents
+    end
+  end
+
+  describe "#template" do
+    it 'should generate the filename of the template file' do
+      section = mock('section')
+      section.should_receive(:to_s).and_return('section')
+      @template.should_receive(:this_directory).and_return('dir')
+      result = @template.send(:template, section)
+      result.should == "dir/section.html.erb"
+    end
+  end
+
+  describe "#output_filename" do
+    it 'should generate the filename of the output file' do
+      section = mock('section')
+      section.should_receive(:to_s).and_return('section')
+      result = @template.send(:output_filename, section)
+      result.should == "section.html"
+    end
+  end
+
+  describe "#inline_css" do
+    it 'should return the contents of a css file' do
+      css = 'mycss.css'
+      @template.should_receive(:this_directory).and_return('dir')
+      io = mock('io', :read => "css contents")
+      @template.should_receive(:open).and_yield(io)
+      result = @template.send(:inline_css, css)
+      result.should == 'css contents'
+    end
+  end
+  
+  describe "#link_to_filename " do
+    describe "when on OS X" do
+      before(:each) do
+        config = mock("configuration")
+        config.stub!(:platform).and_return('universal-darwin-9.0')
+        MetricFu.stub!(:configuration).and_return(config)
+      end
+
+      it 'should return a textmate protocol link' do
+        File.stub!(:expand_path).with('filename').and_return('/expanded/filename')
+        result = @template.send(:link_to_filename, 'filename')
+        result.should eql("<a href='txmt://open/?url=file://" \
+                         + "/expanded/filename'>filename</a>")
+      end
+
+      it "should do the right thing with a filename that starts with a slash" do
+        File.stub!(:expand_path).with('filename').and_return('/expanded/filename')
+        result = @template.send(:link_to_filename, '/filename')
+        result.should eql("<a href='txmt://open/?url=file://" \
+                         + "/expanded/filename'>/filename</a>")
+      end
+
+      it "should include a line number" do
+        File.stub!(:expand_path).with('filename').and_return('/expanded/filename')
+        result = @template.send(:link_to_filename, 'filename', 6)
+        result.should eql("<a href='txmt://open/?url=file://" \
+                         + "/expanded/filename&line=6'>filename:6</a>")
+      end
+
+      describe "and given link text" do
+        it "should use the submitted link text" do
+          File.stub!(:expand_path).with('filename').and_return('/expanded/filename')
+          result = @template.send(:link_to_filename, 'filename', 6, 'link content')
+          result.should eql("<a href='txmt://open/?url=file://" \
+                           + "/expanded/filename&line=6'>link content</a>")
+        end
+      end
+    end
+
+    describe "when on other platforms"  do
+      before(:each) do
+        config = mock("configuration")
+        config.should_receive(:platform).and_return('other')
+        MetricFu.stub!(:configuration).and_return(config)
+        File.should_receive(:expand_path).and_return('filename')
+      end
+
+      it 'should return a file protocol link' do
+        name = "filename"
+        result = @template.send(:link_to_filename, name)
+        result.should == "<a href='file://filename'>filename</a>"
+      end
+    end
+  end
+
+  describe "#cycle" do
+    it 'should return the first_value passed if iteration passed is even' do
+      first_val = "first"
+      second_val = "second"
+      iter = 2
+      result = @template.send(:cycle, first_val, second_val, iter)
+      result.should == first_val
+    end
+
+    it 'should return the second_value passed if iteration passed is odd' do
+      first_val = "first"
+      second_val = "second"
+      iter = 1
+      result = @template.send(:cycle, first_val, second_val, iter)
+      result.should == second_val
+    end
+  end
+
+end
+
+

data/spec/base/configuration_spec.rb

@@ -0,0 +1,274 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+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 "#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 AwesomeTemplate' do
+      template_class.should == AwesomeTemplate
+    end
+
+    it "should set #graph_period to 30" do
+      @config.instance_variable_get(:@graph_period).should == 30
+    end    
+
+    it 'should set @flay to {:dirs_to_flay => @code_dirs}' do
+      @config.instance_variable_get(:@flay).
+              should == {:dirs_to_flay => ['lib'], :minimum_score => 100}
+    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/,/usr/,spec"]}' do
+      @config.instance_variable_get(:@rcov).
+              should ==  { :environment => 'test',
+                           :test_files => ['test/**/*_test.rb', 
+                                           'spec/**/*_spec.rb'],
+                           :rcov_opts => ["--sort coverage", 
+                                         "--no-html", 
+                                         "--text-coverage",
+                                         "--no-color",
+                                         "--profile",
+                                         "--rails",
+                                         "--exclude /gems/,/Library/,/usr/,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 => "#{scratch_directory}/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_graphs ' do
+        it 'should set the @graphs instance var to AVAILABLE_GRAPHS' do
+          @config.instance_variable_get(:@graphs).
+                  should == MetricFu::AVAILABLE_GRAPHS
+        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.should respond_to(metric)
+      end
+    end
+    
+    MetricFu::AVAILABLE_GRAPHS.each do |graph|
+      it "should add a #{graph} class metrhod to the MetricFu module" do
+        MetricFu.should respond_to(graph)
+      end
+    end
+  end
+
+  describe '#platform' do
+
+    before(:each) { get_new_config }
+
+    it 'should return the value of the PLATFORM constant' do
+      this_platform = RUBY_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,244 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe MetricFu::Generator do
+
+  include Construct::Helpers
+
+  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
+
+  describe "path filter" do
+    
+    context "given a list of paths" do
+
+      before do
+        @paths = %w(lib/fake/fake.rb
+                  lib/this/dan_file.rb
+                  lib/this/ben_file.rb
+                  lib/this/avdi_file.rb
+                  basic.rb
+                  lib/bad/one.rb
+                  lib/bad/two.rb
+                  lib/bad/three.rb
+                  lib/worse/four.rb)
+        @container = create_construct 
+        @paths.each do |path|
+          @container.file(path)
+        end
+        @old_dir = Dir.pwd
+        Dir.chdir(@container)
+      end
+      
+      after do
+        Dir.chdir(@old_dir)
+        @container.destroy!
+      end
+
+      it "should return entire pathlist given no exclude pattens" do
+        files = @concrete_class.remove_excluded_files(@paths)
+        files.should be == @paths
+      end
+
+      it "should filter filename at root level" do
+        files = @concrete_class.remove_excluded_files(@paths, ['basic.rb'])
+        files.should_not include('basic.rb')
+      end
+
+      it "should remove files that are two levels deep" do
+        files = @concrete_class.remove_excluded_files(@paths, ['**/fake.rb'])
+        files.should_not include('lib/fake/fake.rb')
+      end
+
+      it "should remove files from an excluded directory" do
+        files = @concrete_class.remove_excluded_files(@paths, ['lib/bad/**'])
+        files.should_not include('lib/bad/one.rb')
+        files.should_not include('lib/bad/two.rb')
+        files.should_not include('lib/bad/three.rb')
+      end
+
+      it "should support shell alternation globs" do
+        files = @concrete_class.remove_excluded_files(@paths, ['lib/this/{ben,dan}_file.rb'])
+        files.should_not include('lib/this/dan_file.rb')
+        files.should_not include('lib/this/ben_file.rb')
+        files.should include('lib/this/avdi_file.rb')
+      end
+
+    end
+
+
+  end
+  
+end