danmayer-metric_fu 2.1.2

data/spec/base/generator_spec.rb

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

data/spec/base/graph_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe MetricFu do
+
+  describe "responding to #graph" do
+    it "should return an instance of Graph" do
+      MetricFu.graph.should be_a(Graph)
+    end
+  end
+end
+
+describe MetricFu::Graph do
+
+  before(:each) do
+    @graph = MetricFu::Graph.new
+  end
+
+  describe "responding to #add with gchart enabled" do
+    it 'should instantiate a grapher and push it to clazz' do
+      @graph.clazz.should_receive(:push).with(an_instance_of(RcovGchartGrapher))
+      @graph.add("rcov", 'gchart')
+    end
+  end
+
+  describe "responding to #add with gchart enabled" do
+    it 'should instantiate a grapher and push it to clazz' do
+      @graph.clazz.should_receive(:push).with(an_instance_of(RcovGchartGrapher))
+      @graph.add("rcov", 'gchart')
+    end
+  end 
+
+  describe "setting the date on the graph" do
+    before(:each) do
+      @graph.stub!(:puts)
+    end
+
+    it "should set the date once for one data point" do
+      Dir.should_receive(:[]).and_return(["metric_fu/tmp/_data/20101105.yml"])
+      File.should_receive(:join)
+      File.should_receive(:open).and_return("Metrics")
+      mock_grapher = stub
+      mock_grapher.should_receive(:get_metrics).with("Metrics", "11/5")
+      mock_grapher.should_receive(:graph!)
+     
+      @graph.clazz = [mock_grapher]
+      @graph.generate
+    end
+
+    it "should set the date when the data directory isn't in the default place" do
+      Dir.should_receive(:[]).and_return(["/some/kind/of/weird/directory/somebody/configured/_data/20101105.yml"])
+      File.should_receive(:join)
+      File.should_receive(:open).and_return("Metrics")
+      mock_grapher = stub
+      mock_grapher.should_receive(:get_metrics).with("Metrics", "11/5")
+      mock_grapher.should_receive(:graph!)
+
+      @graph.clazz = [mock_grapher]
+      @graph.generate
+    end
+  end 
+end

data/spec/base/line_numbers_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe MetricFu::LineNumbers do
+
+  describe "in_method?" do
+    it "should know if a line is NOT in a method" do
+      ln = MetricFu::LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/foo.rb"))
+      ln.in_method?(2).should == false
+    end
+
+    it "should know if a line is in an instance method" do
+      ln = MetricFu::LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/foo.rb"))
+      ln.in_method?(8).should == true
+    end
+
+    it "should know if a line is in an class method" do
+      ln = MetricFu::LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/foo.rb"))
+      ln.in_method?(3).should == true
+    end
+  end
+
+  describe "method_at_line" do
+    it "should know the name of an instance method at a particular line" do
+      ln = MetricFu::LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/foo.rb"))
+      ln.method_at_line(8).should == "Foo#what"
+    end
+
+    it "should know the name of a class method at a particular line" do
+      ln = MetricFu::LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/foo.rb"))
+      ln.method_at_line(3).should == "Foo::awesome"
+    end
+
+    it "should know the name of a private method at a particular line" do
+      ln = MetricFu::LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/foo.rb"))
+      ln.method_at_line(28).should == "Foo#whoop"
+    end
+
+    it "should know the name of a class method defined in a 'class << self block at a particular line" do
+      ln = MetricFu::LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/foo.rb"))
+      ln.method_at_line(23).should == "Foo::neat"
+    end
+
+    it "should know the name of an instance method at a particular line in a file with two classes" do
+      ln = MetricFu::LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/two_classes.rb"))
+      ln.method_at_line(3).should == "Foo#stuff"
+      ln.method_at_line(9).should == "Bar#stuff"
+    end
+
+    it "should work with modules" do
+      ln = MetricFu::LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/module.rb"))
+      ln.method_at_line(4).should == 'KickAss#get_beat_up?'
+    end
+
+    it "should work with module surrounding class" do
+      ln = MetricFu::LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/module_surrounds_class.rb"))
+      ln.method_at_line(5).should == "StuffModule::ThingClass#do_it"
+      # ln.method_at_line(12).should == "StuffModule#blah" #why no work?
+    end
+
+  end
+
+end

data/spec/base/md5_tracker_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+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,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