metric_fu 4.6.0 → 4.7.0

data/spec/metric_fu/data_structures/location_spec.rb

@@ -1,9 +1,10 @@
 require "spec_helper"
+MetricFu.data_structures_require { 'location' }
 
 describe MetricFu::Location do
 
   context "with non-standard Reek method names" do
-    # reek reports the method with :: not # on modules like 
+    # reek reports the method with :: not # on modules like
     # module ApplicationHelper \n def signed_in?, convert it so it records correctly
     # class_or_method_name = class_or_method_name.gsub(/\:\:/,"#") if method_bug_conversion
 
@@ -12,85 +13,85 @@ describe MetricFu::Location do
     end
 
     it "has method name" do
-      @location.method_name.should == 'ApplicationHelper#section_link'
+      expect(@location.method_name).to eq('ApplicationHelper#section_link')
     end
 
     it "has nil file path" do
-      @location.file_path.should   == nil
+      expect(@location.file_path).to   eq(nil)
     end
 
     it "has class name" do
-      @location.class_name.should  == 'ApplicationHelper'
+      expect(@location.class_name).to  eq('ApplicationHelper')
     end
-    
+
   end
 
   context "using new" do
-    
-    before do 
+
+    before do
       @location = Location.new("lib/foo.rb", "Foo", "Foo#some_method")
     end
 
     it "should return fully qualified method" do
-      @location.method_name.should == 'Foo#some_method'
+      expect(@location.method_name).to eq('Foo#some_method')
     end
-    
+
   end
 
   context "using .for with class" do
 
-    before do 
+    before do
       @location = Location.for("Module::Foo")
     end
 
     it "has nil method_name" do
-      @location.method_name.should be nil
+      expect(@location.method_name).to be nil
     end
 
     it "has nil file_path" do
-      @location.file_path.should be nil
+      expect(@location.file_path).to be nil
     end
 
     it "has class_name" do
-      @location.class_name.should == 'Foo'
+      expect(@location.class_name).to eq('Foo')
     end
 
   end
 
   context "using .for with method" do
-    
-    before do 
+
+    before do
       @location = Location.for("Module::Foo#some_method")
     end
 
     it "strips module from class name" do
-      @location.class_name.should == 'Foo'
+      expect(@location.class_name).to eq('Foo')
     end
 
     it "strips module from method name" do
-      @location.method_name.should == 'Foo#some_method'
+      expect(@location.method_name).to eq('Foo#some_method')
     end
 
     it "has nil file_path" do
-      @location.file_path.should be nil
+      expect(@location.file_path).to be nil
     end
 
   end
 
   context "with class method" do
-    
+
     it "provides non-qualified name" do
       location = Location.for("Foo.some_class_method")
-      location.simple_method_name.should == '.some_class_method'
+      expect(location.simple_method_name).to eq('.some_class_method')
     end
 
   end
 
   context "with instance method" do
-    
+
     it "provides non-qualified name" do
       location = Location.for("Foo#some_class_method")
-      location.simple_method_name.should == '#some_class_method'
+      expect(location.simple_method_name).to eq('#some_class_method')
     end
 
   end
@@ -110,16 +111,16 @@ describe MetricFu::Location do
       hsh2 = {}
       hsh2[@location2] = 1
 
-      hsh1.should == hsh2
-      hsh1.eql?(hsh2).should be_true
+      expect(hsh1).to eq(hsh2)
+      expect(hsh1.eql?(hsh2)).to be_truthy
 
-      @location1.eql?(@location2).should be_true
+      expect(@location1.eql?(@location2)).to be_truthy
     end
 
 
     it "should produce the same hash value given the same paths" do
 
-      @location1.hash.should == @location2.hash
+      expect(@location1.hash).to eq(@location2.hash)
     end
 
   end

data/spec/metric_fu/formatter/html_spec.rb

@@ -1,4 +1,5 @@
 require "spec_helper"
+MetricFu.formatter_require { 'html' }
 
 describe MetricFu::Formatter::HTML do
 
@@ -9,9 +10,18 @@ describe MetricFu::Formatter::HTML do
     # Right now, have to select from metrics
     # based on platform, resulting in slow specs
     # for some platforms.
-    @metric_with_graph = MetricFu.configuration.mri? ? :cane : :flay
+    config = MetricFu.configuration
+    if config.mri?
+       @metric_with_graph = :cane
+    else
+       @metric_with_graph = :stats
+       config.templates_configuration do |c|
+         c.syntax_highlighting = false
+       end
+    end
+    allow(MetricFu::Metric.get_metric(@metric_with_graph)).to receive(:run_external).and_return('')
     @metric_without_graph = :hotspots
-    MetricFu.configuration.configure_metrics.each do |metric|
+    config.configure_metrics.each do |metric|
       metric.enabled = true if [@metric_with_graph, @metric_without_graph].include?(metric.name)
     end
 
@@ -70,13 +80,13 @@ describe MetricFu::Formatter::HTML do
 
     context 'when on OS X' do
       before do
-        MetricFu.configuration.stub(:osx?).and_return(true)
-        MetricFu.configuration.stub(:is_cruise_control_rb?).and_return(false)
+        allow(MetricFu.configuration).to receive(:osx?).and_return(true)
+        allow(MetricFu.configuration).to receive(:is_cruise_control_rb?).and_return(false)
       end
 
       it "can open the results in the browser" do
         formatter = MetricFu::Formatter::HTML.new
-        formatter.should_receive(:system).with("open #{MetricFu.run_path.join(directory('output_directory')).join('index.html')}")
+        expect(formatter).to receive(:system).with("open #{MetricFu.run_path.join(directory('output_directory')).join('index.html')}")
         formatter.finish
         formatter.display_results
       end
@@ -121,14 +131,14 @@ describe MetricFu::Formatter::HTML do
 
     context 'when on OS X' do
       before do
-        MetricFu.configuration.stub(:osx?).and_return(true)
-        MetricFu.configuration.stub(:is_cruise_control_rb?).and_return(false)
+        allow(MetricFu.configuration).to receive(:osx?).and_return(true)
+        allow(MetricFu.configuration).to receive(:is_cruise_control_rb?).and_return(false)
       end
 
       it "can open the results in the browser from the custom output directory" do
         formatter = MetricFu::Formatter::HTML.new(output: @output)
         path = MetricFu.run_path.join("#{directory('base_directory')}/#{@output}/index.html")
-        formatter.should_receive(:system).with("open #{path}")
+        expect(formatter).to receive(:system).with("open #{path}")
         formatter.finish
         formatter.display_results
       end

data/spec/metric_fu/formatter/yaml_spec.rb

@@ -1,11 +1,22 @@
 require "spec_helper"
+MetricFu.formatter_require { 'yaml' }
 
 describe MetricFu::Formatter::YAML do
 
   before do
     setup_fs
 
-    @metric1 = MetricFu.configuration.mri? ? :cane : :flay
+    config = MetricFu.configuration
+
+    if config.mri?
+       @metric1 = :cane
+    else
+       @metric1 = :stats
+       config.templates_configuration do |c|
+         c.syntax_highlighting = false
+       end
+    end
+    allow(MetricFu::Metric.get_metric(@metric1)).to receive(:run_external).and_return('')
     @metric2 = :hotspots
     MetricFu.result.add(@metric1)
     MetricFu.result.add(@metric2)
@@ -45,8 +56,8 @@ describe MetricFu::Formatter::YAML do
       out = MfDebugger::Logger.capture_output {
         MetricFu::Formatter::YAML.new(output: @output).finish
       }
-      out.should include ":#{@metric1}:"
-      out.should include ":#{@metric2}:"
+      expect(out).to include ":#{@metric1}:"
+      expect(out).to include ":#{@metric2}:"
     end
 
   end

data/spec/metric_fu/formatter_spec.rb

@@ -6,7 +6,7 @@ describe MetricFu::Formatter do
       subject { MetricFu::Formatter.class_for('html') }
 
       it 'returns the formatter class' do
-        subject.should eq(MetricFu::Formatter::HTML)
+        expect(subject).to eq(MetricFu::Formatter::HTML)
       end
     end
 
@@ -14,7 +14,7 @@ describe MetricFu::Formatter do
       subject { MetricFu::Formatter.class_for(:yaml) }
 
       it 'returns the formatter class' do
-        subject.should eq(MetricFu::Formatter::YAML)
+        expect(subject).to eq(MetricFu::Formatter::YAML)
       end
     end
 
@@ -22,7 +22,7 @@ describe MetricFu::Formatter do
       subject { MetricFu::Formatter.class_for(:unknown) }
 
       it 'raises an error' do
-        lambda{ subject }.should raise_error(NameError)
+        expect{ subject }.to raise_error(NameError)
       end
     end
 
@@ -34,7 +34,7 @@ describe MetricFu::Formatter do
       end
 
       it 'returns the formatter class' do
-        subject.should eq(MyCustomFormatter)
+        expect(subject).to eq(MyCustomFormatter)
       end
     end
 
@@ -42,7 +42,7 @@ describe MetricFu::Formatter do
       subject { MetricFu::Formatter.class_for('MyNonExistentCustomFormatter') }
 
       it 'raises an error' do
-        lambda{ subject }.should raise_error(NameError)
+        expect{ subject }.to raise_error(NameError)
       end
     end
   end

data/spec/metric_fu/loader_spec.rb

@@ -6,7 +6,7 @@ describe MetricFu do
     # Global only for testing that this file gets loaded
     $metric_file_loaded = false
     MetricFu.loader.load_user_configuration
-    $metric_file_loaded.should be_true
+    expect($metric_file_loaded).to be_truthy
   end
 
 end

data/spec/metric_fu/metric_spec.rb

@@ -22,7 +22,7 @@ describe MetricFu::Metric do
   context 'given a valid configurable option' do
 
     before do
-      @metric.stub(:default_run_options).and_return({:foo => 'baz'})
+      allow(@metric).to receive(:default_run_options).and_return({:foo => 'baz'})
     end
 
     it 'can be configured as an attribute' do
@@ -35,7 +35,7 @@ describe MetricFu::Metric do
   context 'given an invalid configurable option' do
 
     before do
-      @metric.stub(:default_run_options).and_return({})
+      allow(@metric).to receive(:default_run_options).and_return({})
     end
 
     it 'raises an error' do

data/spec/metric_fu/metrics/base_template_spec.rb

@@ -12,9 +12,9 @@ describe MetricFu::Template do
     it 'should evaluate a erb doc' do
       section = 'section'
       erb = double('erb')
-      erb.should_receive(:result)
-      @template.should_receive(:template).and_return('foo')
-      @template.should_receive(:erb_template_source).with('foo').and_return(erb)
+      expect(erb).to receive(:result)
+      expect(@template).to receive(:template).and_return('foo')
+      expect(@template).to receive(:erb_template_source).with('foo').and_return(erb)
       @template.send(:erbify, section)
     end
   end
@@ -28,9 +28,9 @@ describe MetricFu::Template do
     describe 'if the template exists' do
       it 'should return true' do
         Tempfile.open('file') do |file|
-          @template.should_receive(:template).with(@section).and_return(file.path)
+          expect(@template).to receive(:template).with(@section).and_return(file.path)
           result = @template.send(:template_exists?,@section)
-          result.should be_true
+          expect(result).to be_truthy
         end
       end
     end
@@ -38,9 +38,9 @@ describe MetricFu::Template do
     describe 'if the template does not exist' do
       it 'should return false' do
         path = 'path'
-        @template.should_receive(:template).with(@section).and_return(path)
+        expect(@template).to receive(:template).with(@section).and_return(path)
         result = @template.send(:template_exists?,@section)
-        result.should be_false
+        expect(result).to be_falsey
       end
     end
   end
@@ -50,37 +50,37 @@ describe MetricFu::Template do
       section = 'section'
       contents = 'contents'
       @template.send(:create_instance_var, section, contents)
-      @template.instance_variable_get(:@section).should == contents
+      expect(@template.instance_variable_get(:@section)).to eq(contents)
     end
   end
 
   describe "#template" do
     it 'should generate the filename of the template file' do
       section = double('section')
-      section.stub(:to_s).and_return('section')
-      @template.should_receive(:template_directory).and_return('dir')
+      allow(section).to receive(:to_s).and_return('section')
+      expect(@template).to receive(:template_directory).and_return('dir')
       result = @template.send(:template, section)
-      result.should == "dir/section.html.erb"
+      expect(result).to eq("dir/section.html.erb")
     end
   end
 
   describe "#output_filename" do
     it 'should generate the filename of the output file' do
       section = double('section')
-      section.should_receive(:to_s).and_return('section')
+      expect(section).to receive(:to_s).and_return('section')
       result = @template.send(:output_filename, section)
-      result.should == "section.html"
+      expect(result).to eq("section.html")
     end
   end
 
   describe "#inline_css" do
     it 'should return the contents of a css file' do
       css = 'mycss.css'
-      @template.should_receive(:template_directory).and_return('dir')
-      io = double('io', :read => "css contents")
-      @template.should_receive(:open).and_yield(io)
+      dir = File.join(MetricFu.lib_dir, 'templates', css)
+      contents = "css contents"
+      expect(MetricFu::Utility).to receive(:binread).with(dir).and_return(contents)
       result = @template.send(:inline_css, css)
-      result.should == 'css contents'
+      expect(result).to eq(contents)
     end
   end
 
@@ -88,57 +88,57 @@ describe MetricFu::Template do
     describe "when on OS X" do
       before(:each) do
         config = double("configuration")
-        config.stub(:osx?).and_return(true)
-        config.stub(:platform).and_return('universal-darwin-9.0')
-        config.stub(:templates_option).with('darwin_txmt_protocol_no_thanks').and_return(false)
-        config.stub(:templates_option).with('link_prefix').and_return(nil)
-        MetricFu.stub(:configuration).and_return(config)
+        allow(config).to receive(:osx?).and_return(true)
+        allow(config).to receive(:platform).and_return('universal-darwin-9.0')
+        allow(config).to receive(:templates_option).with('darwin_txmt_protocol_no_thanks').and_return(false)
+        allow(config).to receive(:templates_option).with('link_prefix').and_return(nil)
+        allow(MetricFu).to receive(:configuration).and_return(config)
       end
 
       it 'should return a textmate protocol link' do
-        @template.should_receive(:complete_file_path).with('filename').and_return('/expanded/filename')
+        expect(@template).to receive(:complete_file_path).with('filename').and_return('/expanded/filename')
         result = @template.send(:link_to_filename, 'filename')
-        result.should eql("<a href='txmt://open/?url=file://" \
+        expect(result).to 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
-        @template.should_receive(:complete_file_path).with('/filename').and_return('/expanded/filename')
+        expect(@template).to receive(:complete_file_path).with('/filename').and_return('/expanded/filename')
         result = @template.send(:link_to_filename, '/filename')
-        result.should eql("<a href='txmt://open/?url=file://" \
+        expect(result).to eql("<a href='txmt://open/?url=file://" \
                          + "/expanded/filename'>/filename</a>")
       end
 
       it "should include a line number" do
-        @template.should_receive(:complete_file_path).with('filename').and_return('/expanded/filename')
+        expect(@template).to receive(:complete_file_path).with('filename').and_return('/expanded/filename')
         result = @template.send(:link_to_filename, 'filename', 6)
-        result.should eql("<a href='txmt://open/?url=file://" \
+        expect(result).to eql("<a href='txmt://open/?url=file://" \
                          + "/expanded/filename&line=6'>filename:6</a>")
       end
 
       describe "but no thanks for txtmt" do
         before(:each) do
           config = double("configuration")
-          config.stub(:osx?).and_return(true)
-          config.stub(:platform).and_return('universal-darwin-9.0')
-          config.stub(:templates_option).with('darwin_txmt_protocol_no_thanks').and_return(true)
-          config.stub(:templates_option).with('link_prefix').and_return('file:/')
-          MetricFu.stub(:configuration).and_return(config)
-          @template.should_receive(:complete_file_path).and_return('filename')
+          allow(config).to receive(:osx?).and_return(true)
+          allow(config).to receive(:platform).and_return('universal-darwin-9.0')
+          allow(config).to receive(:templates_option).with('darwin_txmt_protocol_no_thanks').and_return(true)
+          allow(config).to receive(:templates_option).with('link_prefix').and_return('file:/')
+          allow(MetricFu).to receive(:configuration).and_return(config)
+          expect(@template).to receive(:complete_file_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>"
+          expect(result).to eq("<a href='file://filename'>filename</a>")
         end
       end
 
       describe "and given link text" do
         it "should use the submitted link text" do
-          @template.should_receive(:complete_file_path).with('filename').and_return('/expanded/filename')
+          expect(@template).to receive(:complete_file_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://" \
+          expect(result).to eql("<a href='txmt://open/?url=file://" \
                            + "/expanded/filename&line=6'>link content</a>")
         end
       end
@@ -147,32 +147,32 @@ describe MetricFu::Template do
     describe "when on other platforms"  do
       before(:each) do
         config = double("configuration")
-        config.should_receive(:osx?).and_return(false)
-        config.stub(:templates_option).with('link_prefix').and_return('file:/')
-        MetricFu.stub(:configuration).and_return(config)
-        @template.should_receive(:complete_file_path).and_return('filename')
+        expect(config).to receive(:osx?).and_return(false)
+        allow(config).to receive(:templates_option).with('link_prefix').and_return('file:/')
+        allow(MetricFu).to receive(:configuration).and_return(config)
+        expect(@template).to receive(:complete_file_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>"
+        expect(result).to eq("<a href='file://filename'>filename</a>")
       end
     end
     describe "when configured with a link_prefix" do
       before(:each) do
         config = double("configuration")
-        config.stub(:templates_option).with('darwin_txmt_protocol_no_thanks').and_return(true)
-        config.stub(:templates_option).with('link_prefix').and_return('http://example.org/files')
-        config.stub(:osx?).and_return(true)
-        MetricFu.stub(:configuration).and_return(config)
-        @template.should_receive(:complete_file_path).and_return('filename')
+        allow(config).to receive(:templates_option).with('darwin_txmt_protocol_no_thanks').and_return(true)
+        allow(config).to receive(:templates_option).with('link_prefix').and_return('http://example.org/files')
+        allow(config).to receive(:osx?).and_return(true)
+        allow(MetricFu).to receive(:configuration).and_return(config)
+        expect(@template).to receive(:complete_file_path).and_return('filename')
       end
 
       it 'should return a http protocol link' do
         name = "filename"
         result = @template.send(:link_to_filename, name)
-        result.should == "<a href='http://example.org/files/filename'>filename</a>"
+        expect(result).to eq("<a href='http://example.org/files/filename'>filename</a>")
       end
     end
   end
@@ -183,7 +183,7 @@ describe MetricFu::Template do
       second_val = "second"
       iter = 2
       result = @template.send(:cycle, first_val, second_val, iter)
-      result.should == first_val
+      expect(result).to eq(first_val)
     end
 
     it 'should return the second_value passed if iteration passed is odd' do
@@ -191,7 +191,7 @@ describe MetricFu::Template do
       second_val = "second"
       iter = 1
       result = @template.send(:cycle, first_val, second_val, iter)
-      result.should == second_val
+      expect(result).to eq(second_val)
     end
   end