metric_fu 4.11.3 → 4.11.4

data/spec/metric_fu/templates/metrics_template_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe MetricFu::Templates::MetricsTemplate do
+  let(:template) { Templates::MetricsTemplate.new }
+
+  describe "#html_filename" do
+    it "returns the hashed filename ending with .html" do
+      expect(template.html_filename("some_file.rb")).to eq("10580a1fcbe74a931db8210462a584.html")
+    end
+  end
+end

data/spec/metric_fu/templates/report_spec.rb

@@ -1,12 +1,12 @@
-require 'spec_helper'
-MetricFu.lib_require { 'templates/report' }
+require "spec_helper"
+MetricFu.lib_require { "templates/report" }
 
 describe MetricFu::Templates::Report do
   # TODO: This test only shows how the code works and that it doesn't blow up.
   # Perhaps it should test something more specific?
   it "Reads in a source file, and produces an annotated HTML report" do
-    lines = {"2"=>[{:type=>:reek, :description=>"Bad Param Names"}]}
-    source_file = File.join(MetricFu.root_dir, 'spec','dummy','lib','bad_encoding.rb')
+    lines = { "2" => [{ type: :reek, description: "Bad Param Names" }] }
+    source_file = File.join(MetricFu.root_dir, "spec", "dummy", "lib", "bad_encoding.rb")
     report = MetricFu::Templates::Report.new(source_file, lines)
     expect {
       rendered_report = report.render

data/spec/metric_fu/templates/template_spec.rb

@@ -1,35 +1,33 @@
 require "spec_helper"
-require 'tempfile'
-require 'erb'
+require "tempfile"
+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'
-      erb = double('erb')
+      section = "section"
+      erb = double("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)
+      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
 
   describe "#template_exists? " do
-
     before(:each) do
-      @section = double('section')
+      @section = double("section")
     end
 
     describe "if the template exists" do
       it "should return true" do
-        Tempfile.open('file') do |file|
+        Tempfile.open("file") do |file|
           expect(@template).to receive(:template).with(@section).and_return(file.path)
-          result = @template.send(:template_exists?,@section)
+          result = @template.send(:template_exists?, @section)
           expect(result).to be_truthy
         end
       end
@@ -37,9 +35,9 @@ describe MetricFu::Template do
 
     describe "if the template does not exist" do
       it "should return false" do
-        path = 'path'
+        path = "path"
         expect(@template).to receive(:template).with(@section).and_return(path)
-        result = @template.send(:template_exists?,@section)
+        result = @template.send(:template_exists?, @section)
         expect(result).to be_falsey
       end
     end
@@ -47,8 +45,8 @@ describe MetricFu::Template do
 
   describe "#create_instance_var" do
     it "should set an instance variable with the passed contents" do
-      section = 'section'
-      contents = 'contents'
+      section = "section"
+      contents = "contents"
       @template.send(:create_instance_var, section, contents)
       expect(@template.instance_variable_get(:@section)).to eq(contents)
     end
@@ -56,9 +54,9 @@ describe MetricFu::Template do
 
   describe "#template" do
     it "should generate the filename of the template file" do
-      section = double('section')
-      allow(section).to receive(:to_s).and_return('section')
-      expect(@template).to receive(:template_directory).and_return('dir')
+      section = double("section")
+      allow(section).to receive(:to_s).and_return("section")
+      expect(@template).to receive(:template_directory).and_return("dir")
       result = @template.send(:template, section)
       expect(result).to eq("dir/section.html.erb")
     end
@@ -66,8 +64,8 @@ describe MetricFu::Template do
 
   describe "#output_filename" do
     it "should generate the filename of the output file" do
-      section = double('section')
-      expect(section).to receive(:to_s).and_return('section')
+      section = double("section")
+      expect(section).to receive(:to_s).and_return("section")
       result = @template.send(:output_filename, section)
       expect(result).to eq("section.html")
     end
@@ -75,8 +73,8 @@ describe MetricFu::Template do
 
   describe "#inline_css" do
     it "should return the contents of a css file" do
-      css = 'mycss.css'
-      dir = File.join(MetricFu.lib_dir, 'templates', css)
+      css = "mycss.css"
+      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)
@@ -89,29 +87,29 @@ describe MetricFu::Template do
       before(:each) do
         config = double("configuration")
         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(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
-        expect(@template).to receive(:complete_file_path).with('filename').and_return('/expanded/filename')
-        result = @template.send(:link_to_filename, 'filename')
+        expect(@template).to receive(:complete_file_path).with("filename").and_return("/expanded/filename")
+        result = @template.send(:link_to_filename, "filename")
         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
-        expect(@template).to receive(:complete_file_path).with('/filename').and_return('/expanded/filename')
-        result = @template.send(:link_to_filename, '/filename')
+        expect(@template).to receive(:complete_file_path).with("/filename").and_return("/expanded/filename")
+        result = @template.send(:link_to_filename, "/filename")
         expect(result).to eql("<a href='txmt://open/?url=file://" \
                          + "/expanded/filename'>/filename</a>")
       end
 
       it "should include a line number" do
-        expect(@template).to receive(:complete_file_path).with('filename').and_return('/expanded/filename')
-        result = @template.send(:link_to_filename, 'filename', 6)
+        expect(@template).to receive(:complete_file_path).with("filename").and_return("/expanded/filename")
+        result = @template.send(:link_to_filename, "filename", 6)
         expect(result).to eql("<a href='txmt://open/?url=file://" \
                          + "/expanded/filename&line=6'>filename:6</a>")
       end
@@ -120,11 +118,11 @@ describe MetricFu::Template do
         before(:each) do
           config = double("configuration")
           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(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')
+          expect(@template).to receive(:complete_file_path).and_return("filename")
         end
 
         it "should return a file protocol link" do
@@ -136,8 +134,8 @@ describe MetricFu::Template do
 
       describe "and given link text" do
         it "should use the submitted link text" do
-          expect(@template).to receive(:complete_file_path).with('filename').and_return('/expanded/filename')
-          result = @template.send(:link_to_filename, 'filename', 6, 'link content')
+          expect(@template).to receive(:complete_file_path).with("filename").and_return("/expanded/filename")
+          result = @template.send(:link_to_filename, "filename", 6, "link content")
           expect(result).to eql("<a href='txmt://open/?url=file://" \
                            + "/expanded/filename&line=6'>link content</a>")
         end
@@ -148,9 +146,9 @@ describe MetricFu::Template do
       before(:each) do
         config = double("configuration")
         expect(config).to receive(:osx?).and_return(false)
-        allow(config).to receive(:templates_option).with('link_prefix').and_return('file:/')
+        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')
+        expect(@template).to receive(:complete_file_path).and_return("filename")
       end
 
       it "should return a file protocol link" do
@@ -162,11 +160,11 @@ describe MetricFu::Template do
     describe "when configured with a link_prefix" do
       before(:each) do
         config = double("configuration")
-        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(: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')
+        expect(@template).to receive(:complete_file_path).and_return("filename")
       end
 
       it "should return a http protocol link" do
@@ -175,6 +173,23 @@ describe MetricFu::Template do
         expect(result).to eq("<a href='http://example.org/files/filename'>filename</a>")
       end
     end
+
+    context "given an absolute path" do
+      it "returns a link with that absolute path" do
+        name = "/some/file.rb"
+        result = @template.send(:link_to_filename, name)
+        expect(result).to eq("<a href='file:///some/file.rb'>/some/file.rb</a>")
+      end
+    end
+
+    context "given a relative path" do
+      it "returns a link with the absolute path" do
+        name = "./some/file.rb"
+        expected = File.expand_path(name)
+        result = @template.send(:link_to_filename, name)
+        expect(result).to eq("<a href='file://#{expected}'>./some/file.rb</a>")
+      end
+    end
   end
 
   describe "#cycle" do
@@ -197,23 +212,22 @@ describe MetricFu::Template do
 
   describe "#render_partial" do
     it "should erbify a partial with the name prefixed with an underscore" do
-      expect(@template).to receive(:erbify).with('_some_partial')
-      @template.send(:render_partial, 'some_partial')
+      expect(@template).to receive(:erbify).with("_some_partial")
+      @template.send(:render_partial, "some_partial")
     end
 
     it "should set the given instance variables" do
-      variables = {:answer => 42}
+      variables = { answer: 42 }
       allow(@template).to receive(:erbify)
       expect(@template).to receive(:create_instance_vars).with(variables)
-      @template.send(:render_partial, 'some_partial', variables)
+      @template.send(:render_partial, "some_partial", variables)
     end
   end
 
   describe "#create_instance_vars" do
     it "should set the given instance variables" do
-      @template.send(:create_instance_vars, {:answer => 42})
+      @template.send(:create_instance_vars, answer: 42)
       expect(@template.instance_variable_get(:@answer)).to eq(42)
     end
   end
-
 end

data/spec/metric_fu/utility_spec.rb

@@ -1,5 +1,5 @@
-require 'spec_helper'
-require 'metric_fu/utility'
+require "spec_helper"
+require "metric_fu/utility"
 
 describe MetricFu::Utility do
   it "strips ANSI escape codes from text" do

data/spec/metric_fu_spec.rb

@@ -1,17 +1,16 @@
 # coding: utf-8
-require 'spec_helper'
+require "spec_helper"
 
 describe MetricFu do
-
   specify "the default report_name is the run directory base name" do
-    expect(MetricFu.report_name).to eq('dummy')
+    expect(MetricFu.report_name).to eq("dummy")
   end
 
   specify "the user can set the report_name" do
     original_report_name = MetricFu.report_name
 
-    MetricFu.report_name = 'override'
-    expect(MetricFu.report_name).to eq('override')
+    MetricFu.report_name = "override"
+    expect(MetricFu.report_name).to eq("override")
 
     MetricFu.report_name = original_report_name
   end
@@ -25,11 +24,10 @@ describe MetricFu do
   end
 
   it "has a global report id" do
-    expect(MetricFu.report_id).to eq(Time.now.strftime('%Y%m%d'))
+    expect(MetricFu.report_id).to eq(Time.now.strftime("%Y%m%d"))
   end
 
   it "has a global report fingerprint (corresponding to VCS code state)" do
     expect(MetricFu.report_fingerprint.to_i - Time.now.to_i).to be_within(0.1).of(0)
   end
-
 end

data/spec/shared/configured.rb

@@ -1,7 +1,6 @@
-shared_examples 'configured' do
-
+shared_examples "configured" do
   def get_new_config
-    ENV['CC_BUILD_ARTIFACTS'] = nil
+    ENV["CC_BUILD_ARTIFACTS"] = nil
     @config = MetricFu.configuration
     @config.reset
     MetricFu.configuration.configure_metric(:rcov) do |rcov|
@@ -17,31 +16,30 @@ shared_examples 'configured' do
   end
 
   def base_directory
-    directory('base_directory')
+    directory("base_directory")
   end
 
   def output_directory
-    directory('output_directory')
+    directory("output_directory")
   end
 
   def scratch_directory
-    directory('scratch_directory')
+    directory("scratch_directory")
   end
 
   def template_directory
-    directory('template_directory')
+    directory("template_directory")
   end
 
   def template_class
-    MetricFu::Formatter::Templates.option('template_class')
+    MetricFu::Formatter::Templates.option("template_class")
   end
 
   def metric_fu_root
-    directory('root_directory')
+    directory("root_directory")
   end
 
   def load_metric(metric)
-    load File.join(MetricFu.metrics_dir, metric, 'metric.rb')
+    load File.join(MetricFu.metrics_dir, metric, "metric.rb")
   end
-
 end

data/spec/shared/test_coverage.rb

@@ -1,5 +1,4 @@
 shared_examples "rcov test coverage generator" do |metric_name|
-
   before do
     setup_fs
     MetricFu::Configuration.run do |config|
@@ -15,26 +14,25 @@ shared_examples "rcov test coverage generator" do |metric_name|
 
   describe "emit" do
     before :each do
-      options = {:external =>  nil}
+      options = { external: nil }
       @rcov = MetricFu::RcovGenerator.new(@default_options.merge(options))
     end
 
     # TODO: should this be true of this metric?
     it "should clear out previous output and make output folder" do
-      expect(MetricFu::Utility).to receive(:rm_rf).with(MetricFu::RcovGenerator.metric_directory, :verbose => false)
+      expect(MetricFu::Utility).to receive(:rm_rf).with(MetricFu::RcovGenerator.metric_directory, verbose: false)
       expect(MetricFu::Utility).to receive(:mkdir_p).with(MetricFu::RcovGenerator.metric_directory)
       @rcov.reset_output_location
     end
-
   end
 
   def rcov_output
-    FIXTURE.load_file('rcov_output.txt')
+    FIXTURE.load_file("rcov_output.txt")
   end
 
   describe "with rcov_output fed into" do
     before :each do
-      options = {:external =>  nil}
+      options = { external: nil }
       @rcov = MetricFu::RcovGenerator.new(@default_options.merge(options))
       expect(@rcov).to receive(:load_output).and_return(rcov_output)
       @files = @rcov.analyze
@@ -76,7 +74,7 @@ shared_examples "rcov test coverage generator" do |metric_name|
   end
   describe "with external configuration option set" do
     before :each do
-      options = {:external =>  'coverage/rcov.txt'}
+      options = { external: "coverage/rcov.txt" }
       @rcov = MetricFu::RcovGenerator.new(@default_options.merge(options))
     end
 
@@ -89,11 +87,9 @@ shared_examples "rcov test coverage generator" do |metric_name|
       expect(@rcov).to receive(:load_output).and_return(rcov_output)
       @files = @rcov.analyze
     end
-
   end
 
   after do
     cleanup_fs
   end
-
 end

data/spec/spec_helper.rb

@@ -1,25 +1,25 @@
 # add lib to the load path just like rubygems does
 $:.unshift File.expand_path("../../lib", __FILE__)
-require 'simplecov'
+require "simplecov"
 
-require 'date'
-require 'test_construct'
-require 'json'
-require 'pry-nav'
+require "date"
+require "test_construct"
+require "json"
+require "pry-nav"
 
-require 'metric_fu'
+require "metric_fu"
 include MetricFu
 def mf_log(msg); mf_debug(msg); end
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
-Dir[MetricFu.root_dir + "/spec/support/**/*.rb"].each {|f| require f}
+Dir[MetricFu.root_dir + "/spec/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
   config.filter_run focus: true
   config.run_all_when_everything_filtered = true
   config.filter_run_excluding :slow unless ENV["SLOW_SPECS"]
-  config.fail_fast = ENV.include?('FAIL_FAST')
+  config.fail_fast = ENV.include?("FAIL_FAST")
   config.order = :rand
   config.color = true
   config.expect_with :rspec do |expectations|
@@ -34,7 +34,7 @@ RSpec.configure do |config|
   # :all every it block
 
   def run_dir
-    File.expand_path('dummy', File.dirname(__FILE__))
+    File.expand_path("dummy", File.dirname(__FILE__))
   end
 
   config.before(:suite) do