metric_fu 4.10.0 → 4.11.0

data/spec/metric_fu/metrics/reek/{reek_spec.rb → generator_spec.rb}

@@ -1,5 +1,5 @@
 require "spec_helper"
-MetricFu.metrics_require { 'reek/reek' }
+MetricFu.metrics_require { 'reek/generator' }
 
 describe MetricFu::ReekGenerator do
   describe "emit" do

data/spec/metric_fu/metrics/reek/{reek_grapher_spec.rb → grapher_spec.rb}

@@ -1,5 +1,5 @@
 require "spec_helper"
-MetricFu.metrics_require { 'reek/reek_grapher' }
+MetricFu.metrics_require { 'reek/grapher' }
 
 describe ReekGrapher do
   before :each do

data/spec/metric_fu/metrics/roodi/configuration_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'shared/configured'
+
+describe MetricFu::Configuration, 'for roodi' do
+  it_behaves_like 'configured' do
+
+    it 'should set @roodi to {:dirs_to_roodi => @code_dirs}' do
+      load_metric 'roodi'
+      expect(MetricFu::Metric.get_metric(:roodi).run_options).to eq(
+              { :dirs_to_roodi => directory('code_dirs'),
+                  :roodi_config => "#{directory('root_directory')}/config/roodi_config.yml"}
+              )
+    end
+
+  end
+end

data/spec/metric_fu/metrics/roodi/{roodi_spec.rb → generator_spec.rb}

@@ -1,5 +1,5 @@
 require "spec_helper"
-MetricFu.metrics_require { 'roodi/roodi' }
+MetricFu.metrics_require { 'roodi/generator' }
 
 describe MetricFu::RoodiGenerator do
   describe "emit" do

data/spec/metric_fu/metrics/roodi/{roodi_grapher_spec.rb → grapher_spec.rb}

@@ -1,5 +1,5 @@
 require "spec_helper"
-MetricFu.metrics_require { 'roodi/roodi_grapher' }
+MetricFu.metrics_require { 'roodi/grapher' }
 
 describe RoodiGrapher do
   before :each do

data/spec/metric_fu/metrics/saikuro/configuration_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'shared/configured'
+
+describe MetricFu::Configuration, 'for saikuro' do
+  it_behaves_like 'configured' do
+
+      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
+        load_metric 'saikuro'
+        expect(MetricFu::Metric.get_metric(:saikuro).run_options).to eq(
+                { :output_directory => "#{scratch_directory}/saikuro",
+                      :input_directory => ['lib'],
+                      :cyclo => "",
+                      :filter_cyclo => "0",
+                      :warn_cyclo => "5",
+                      :error_cyclo => "7",
+                      :formater => "text"}
+                      )
+      end
+  end
+end

data/spec/metric_fu/metrics/saikuro/{saikuro_spec.rb → generator_spec.rb}

@@ -1,5 +1,5 @@
 require "spec_helper"
-MetricFu.metrics_require { 'saikuro/saikuro' }
+MetricFu.metrics_require { 'saikuro/generator' }
 
 describe MetricFu::SaikuroGenerator do
   STUB_TEST_DATA = lambda do |generator|

data/spec/metric_fu/metrics/stats/{stats_spec.rb → generator_spec.rb}

@@ -1,5 +1,5 @@
 require "spec_helper"
-MetricFu.metrics_require { 'stats/stats' }
+MetricFu.metrics_require { 'stats/generator' }
 
 describe StatsGenerator do
   describe "emit method" do

data/spec/metric_fu/metrics/stats/{stats_grapher_spec.rb → grapher_spec.rb}

@@ -1,5 +1,5 @@
 require "spec_helper"
-MetricFu.metrics_require { 'stats/stats_grapher' }
+MetricFu.metrics_require { 'stats/grapher' }
 
 describe StatsGrapher do
   before :each do

data/spec/metric_fu/{metrics → reporting/graphs}/graph_spec.rb

@@ -1,5 +1,5 @@
 require "spec_helper"
-MetricFu.metrics_require { 'graph' }
+MetricFu.reporting_require { 'graphs/graph' }
 
 describe MetricFu do
 

data/spec/metric_fu/run_spec.rb

@@ -191,7 +191,7 @@ describe MetricFu do
 
   def metric_fu(options = "--no-open")
     message = ''
-    out = MfDebugger::Logger.capture_output {
+    out = MetricFu::Utility.capture_output {
       begin
         argv = Shellwords.shellwords(options)
         MetricFu::Cli::Client.new.run(argv)

data/spec/metric_fu/templates/configuration_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'shared/configured'
+
+describe MetricFu::Configuration, 'for templates' do
+  it_behaves_like 'configured' do
+    describe 'when there is no CC_BUILD_ARTIFACTS environment variable' do
+
+      before(:each) do
+        ENV['CC_BUILD_ARTIFACTS'] = nil
+        get_new_config
+      end
+
+    it 'should set @template_directory to the lib/templates relative '+
+    'to @metric_fu_root_directory' do
+      expected_template_dir = MetricFu.root.join('lib','templates').to_s
+      expect(template_directory).to eq(expected_template_dir)
+    end
+
+
+    it 'should set @template_class to MetricFu::Templates::MetricsTemplate by default' do
+      expect(template_class).to eq(MetricFu::Templates::MetricsTemplate)
+    end
+
+    describe 'when a templates configuration is given' do
+
+      before do
+        class DummyTemplate;end
+
+        @config.templates_configuration do |config|
+          config.template_class = DummyTemplate
+          config.link_prefix = 'http:/'
+          config.syntax_highlighting = false
+          config.darwin_txmt_protocol_no_thanks = false
+        end
+      end
+
+      it 'should set given template_class' do
+        expect(template_class).to eq(DummyTemplate)
+      end
+
+      it 'should set given link_prefix' do
+        expect(MetricFu::Formatter::Templates.option('link_prefix')).to eq('http:/')
+      end
+
+      it 'should set given darwin_txmt_protocol_no_thanks' do
+        expect(MetricFu::Formatter::Templates.option('darwin_txmt_protocol_no_thanks')).to be_falsey
+      end
+
+      it 'should set given syntax_highlighting' do
+        expect(MetricFu::Formatter::Templates.option('syntax_highlighting')).to be_falsey
+      end
+
+    end
+
+    end
+  end
+end

data/spec/metric_fu/templates/report_spec.rb

@@ -0,0 +1,15 @@
+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')
+    report = MetricFu::Templates::Report.new(source_file, lines)
+    expect {
+      rendered_report = report.render
+    }.not_to raise_error
+  end
+end

data/spec/quality_spec.rb

@@ -0,0 +1,86 @@
+# coding: utf-8
+# from https://github.com/vcr/vcr/blob/master/spec/quality_spec.rb
+# from https://raw.githubusercontent.com/bundler/bundler/master/spec/quality_spec.rb
+require "spec_helper"
+
+if defined?(Encoding) && Encoding.default_external != "UTF-8"
+  Encoding.default_external = "UTF-8"
+end
+
+describe "The library itself" do
+
+  def check_for_spec_defs_with_single_quotes(filename)
+    failing_lines = []
+
+    File.readlines(filename).each_with_index do |line,number|
+      failing_lines << number + 1 if line =~ /^ *(describe|it|context) {1}'{1}/
+    end
+
+    unless failing_lines.empty?
+      "#{filename} uses inconsistent single quotes on lines #{failing_lines.join(', ')}"
+    end
+  end
+
+  def check_for_tab_characters(filename)
+    failing_lines = []
+    File.readlines(filename).each_with_index do |line,number|
+      failing_lines << number + 1 if line =~ /\t/
+    end
+
+    unless failing_lines.empty?
+      "#{filename} has tab characters on lines #{failing_lines.join(', ')}"
+    end
+  end
+
+  def check_for_extra_spaces(filename)
+    failing_lines = []
+    File.readlines(filename).each_with_index do |line,number|
+      next if line =~ /^\s+#.*\s+\n$/
+      failing_lines << number + 1 if line =~ /\s+\n$/
+    end
+
+    unless failing_lines.empty?
+      "#{filename} has spaces on the EOL on lines #{failing_lines.join(', ')}"
+    end
+  end
+
+  RSpec::Matchers.define :be_well_formed do
+    failure_message do |actual|
+      actual.join("\n")
+    end
+
+    match do |actual|
+      actual.empty?
+    end
+  end
+
+  it "has no malformed whitespace" do
+    exempt = /\.gitmodules|\.marshal|fixtures|vendor|ssl_certs|LICENSE|etc/
+    error_messages = []
+    Dir.chdir(File.expand_path("../..", __FILE__)) do
+      `git ls-files -z`.split("\x0").each do |filename|
+        next if filename =~ exempt
+        error_messages << check_for_tab_characters(filename)
+        error_messages << check_for_extra_spaces(filename)
+      end
+    end
+    expect(error_messages.compact).to be_well_formed
+  end
+
+  it "uses double-quotes consistently in specs" do
+    included = /spec/
+    error_messages = []
+    Dir.chdir(File.expand_path("../", __FILE__)) do
+      `git ls-files -z`.split("\x0").each do |filename|
+        next unless filename =~ included
+        error_messages << check_for_spec_defs_with_single_quotes(filename)
+      end
+    end
+    error_messages.compact.each do |error_message|
+      warn error_message
+    end
+    # TODO: fail build once this spec emits no warnings
+    # expect(error_messages.compact).to be_well_formed
+  end
+
+end

data/spec/shared/configured.rb

@@ -0,0 +1,47 @@
+shared_examples 'configured' do
+
+  def get_new_config
+    ENV['CC_BUILD_ARTIFACTS'] = nil
+    @config = MetricFu.configuration
+    @config.reset
+    MetricFu.configuration.configure_metric(:rcov) do |rcov|
+      rcov.enabled = true
+    end
+    MetricFu.configure
+    allow(MetricFu::Io::FileSystem).to receive(:create_directories) # no need to create directories for the tests
+    @config
+  end
+
+  def directory(name)
+    MetricFu::Io::FileSystem.directory(name)
+  end
+
+  def base_directory
+    directory('base_directory')
+  end
+
+  def output_directory
+    directory('output_directory')
+  end
+
+  def scratch_directory
+    directory('scratch_directory')
+  end
+
+  def template_directory
+    directory('template_directory')
+  end
+
+  def template_class
+    MetricFu::Formatter::Templates.option('template_class')
+  end
+
+  def metric_fu_root
+    directory('root_directory')
+  end
+
+  def load_metric(metric)
+    load File.join(MetricFu.metrics_dir, metric, 'metric.rb')
+  end
+
+end

data/spec/shared/test_coverage.rb

@@ -0,0 +1,99 @@
+shared_examples "rcov test coverage generator" do |metric_name|
+
+  before do
+    setup_fs
+    MetricFu::Configuration.run do |config|
+      config.configure_metric(metric_name) do |rcov|
+        rcov.enabled = true
+      end
+    end
+  end
+
+  before :each do
+    @default_options = MetricFu::Metric.get_metric(metric_name).run_options
+  end
+
+  describe "emit" do
+    before :each do
+      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(:mkdir_p).with(MetricFu::RcovGenerator.metric_directory)
+      @rcov.reset_output_location
+    end
+
+  end
+
+  def rcov_output
+    FIXTURE.load_file('rcov_output.txt')
+  end
+
+  describe "with rcov_output fed into" do
+    before :each do
+      options = {:external =>  nil}
+      @rcov = MetricFu::RcovGenerator.new(@default_options.merge(options))
+      expect(@rcov).to receive(:load_output).and_return(rcov_output)
+      @files = @rcov.analyze
+    end
+
+    describe "analyze" do
+      it "should compute percent of lines run" do
+        expect(@files["./lib/metric_fu/metrics/hotspots/analysis/record.rb"][:percent_run]).to eq(94)
+        expect(@files["./lib/metric_fu/metrics/hotspots/analysis/table.rb"][:percent_run]).to eq(93)
+      end
+
+      it "should know which lines were run" do
+        expect(@files["./lib/metric_fu/metrics/hotspots/analysis/record.rb"][:lines].any? {|line|
+          line[:content].strip == "@data[key]" &&
+          line[:was_run] == 1
+        }).to be_truthy
+      end
+
+      it "should know which lines NOT were run" do
+        expect(@files["./lib/metric_fu/metrics/hotspots/analysis/record.rb"][:lines].any? {|line|
+          line[:content].strip == "super(name, *args, &block)" &&
+          line[:was_run] == 0
+        }).to be_truthy
+      end
+
+      it "should know which lines were ignored" do
+        expect(@files["./lib/metric_fu/metrics/hotspots/analysis/record.rb"][:lines].any? {|line|
+          line[:content].strip == "end" &&
+          line[:was_run] == nil
+        }).to be_truthy
+      end
+    end
+
+    describe "to_h" do
+      it "should calculate total percentage for all files" do
+        expect(@rcov.to_h[:rcov][:global_percent_run]).to eq(93.3)
+      end
+    end
+  end
+  describe "with external configuration option set" do
+    before :each do
+      options = {:external =>  'coverage/rcov.txt'}
+      @rcov = MetricFu::RcovGenerator.new(@default_options.merge(options))
+    end
+
+    it "should emit nothing if external configuration option is set" do
+      expect(MetricFu::Utility).not_to receive(:rm_rf)
+      @rcov.emit
+    end
+
+    it "should open the external rcov analysis file" do
+      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

@@ -3,6 +3,7 @@ $:.unshift File.expand_path("../../lib", __FILE__)
 if ENV['COVERAGE']
   require 'simplecov'
   formatters = [SimpleCov::Formatter::HTMLFormatter]
+  SimpleCov.start 'metric_fu'
   begin
     puts '[COVERAGE] Running with SimpleCov HTML Formatter'
     require 'metric_fu/metrics/rcov/simplecov_formatter'
@@ -12,10 +13,8 @@ if ENV['COVERAGE']
     puts '[COVERAGE] SimpleCov MetricFu formatter could not be loaded'
   end
   SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[ *formatters ]
-  SimpleCov.start
 end
 
-require 'rspec/autorun'
 require 'date'
 require 'test_construct'
 require 'json'
@@ -30,13 +29,18 @@ def mf_log(msg); mf_debug(msg); end
 Dir[MetricFu.root_dir + "/spec/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-  config.mock_with :rspec
-
   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.order = 'random'
+  config.order = :rand
+  config.color_enabled = true
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+  end
 
   # :suite after/before all specs
   # :each every describe block