fastruby-metric_fu 5.0.0

data/spec/metric_fu/metrics/rcov/generator_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+MetricFu.metrics_require { "rcov/generator" }
+require "shared/test_coverage"
+
+describe MetricFu::RcovGenerator, "configured as rcov" do
+  it_behaves_like "rcov test coverage generator", :rcov do
+    describe "emit" do
+      before :each do
+        options = { external: nil }
+        @test_coverage = MetricFu::RcovGenerator.new(@default_options.merge(options))
+      end
+
+      it "should set the RAILS_ENV" 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)
+        options = { environment: "metrics", external: nil }
+        @test_coverage = MetricFu::RcovGenerator.new(@default_options.merge(options))
+        expect(@test_coverage.command).to include("RAILS_ENV=metrics")
+      end
+    end
+  end
+end

data/spec/metric_fu/metrics/rcov/grapher_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+MetricFu.metrics_require { "rcov/grapher" }
+
+describe RcovGrapher do
+  before :each do
+    @rcov_grapher = MetricFu::RcovGrapher.new
+    MetricFu.configuration
+  end
+
+  it "should respond to rcov_percent and labels" do
+    expect(@rcov_grapher).to respond_to(:rcov_percent)
+    expect(@rcov_grapher).to respond_to(:labels)
+  end
+
+  describe "responding to #initialize" do
+    it "should initialise rcov_percent and labels" do
+      expect(@rcov_grapher.rcov_percent).to eq([])
+      expect(@rcov_grapher.labels).to eq({})
+    end
+  end
+
+  describe "responding to #get_metrics" do
+    context "when metrics were not generated" do
+      before(:each) do
+        @metrics = FIXTURE.load_metric("metric_missing.yml")
+        @date = "1/2"
+      end
+
+      it "should not push to rcov_percent" do
+        expect(@rcov_grapher.rcov_percent).not_to receive(:push)
+        @rcov_grapher.get_metrics(@metrics, @date)
+      end
+
+      it "should not update labels with the date" do
+        expect(@rcov_grapher.labels).not_to receive(:update)
+        @rcov_grapher.get_metrics(@metrics, @date)
+      end
+    end
+
+    context "when metrics have been generated" do
+      before(:each) do
+        @metrics = FIXTURE.load_metric("20090630.yml")
+        @date = "1/2"
+      end
+
+      it "should push to rcov_percent" do
+        expect(@rcov_grapher.rcov_percent).to receive(:push).with(49.6)
+        @rcov_grapher.get_metrics(@metrics, @date)
+      end
+
+      it "should update labels with the date" do
+        expect(@rcov_grapher.labels).to receive(:update).with(0 => "1/2")
+        @rcov_grapher.get_metrics(@metrics, @date)
+      end
+    end
+  end
+end

data/spec/metric_fu/metrics/rcov/hotspot_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+MetricFu.metrics_require { "hotspots/metric" }
+MetricFu.metrics_require { "hotspots/hotspot" }
+MetricFu.metrics_require { "hotspots/analysis/record" }
+MetricFu.metrics_require { "rcov/hotspot" }
+
+describe MetricFu::RcovHotspot do
+  describe "map" do
+    let(:zero_row) do
+      MetricFu::Record.new({ "percentage_uncovered" => 0.0 }, nil)
+    end
+
+    let(:non_zero_row) do
+      MetricFu::Record.new({ "percentage_uncovered" => 0.75 }, nil)
+    end
+
+    it { expect(subject.map(zero_row)).to eql(0.0) }
+    it { expect(subject.map(non_zero_row)).to eql(0.75) }
+  end
+end

data/spec/metric_fu/metrics/rcov/rcov_line_spec.rb

@@ -0,0 +1,89 @@
+require "spec_helper"
+require "metric_fu/metrics/rcov/rcov_line"
+
+describe MetricFu::RCovLine do
+  describe "#to_h" do
+    it "returns a hash with the content and was_run" do
+      rcov_line = RCovLine.new("some content", 1)
+
+      expect(rcov_line.to_h).to eq(content: "some content", was_run: 1)
+    end
+  end
+
+  describe "#covered?" do
+    it "returns true if was_run is 1" do
+      rcov_line = RCovLine.new("", 1)
+
+      expect(rcov_line.covered?).to eq(true)
+    end
+
+    it "returns false if was_run is 0" do
+      rcov_line = RCovLine.new("", 0)
+
+      expect(rcov_line.covered?).to eq(false)
+    end
+
+    it "returns false if was_run is nil" do
+      rcov_line = RCovLine.new("", nil)
+
+      expect(rcov_line.covered?).to eq(false)
+    end
+  end
+
+  describe "#missed?" do
+    it "returns true if was_run is 0" do
+      rcov_line = RCovLine.new("", 0)
+
+      expect(rcov_line.missed?).to eq(true)
+    end
+
+    it "returns false if was_run is 1" do
+      rcov_line = RCovLine.new("", 1)
+
+      expect(rcov_line.missed?).to eq(false)
+    end
+
+    it "returns false if was_run is nil" do
+      rcov_line = RCovLine.new("", nil)
+
+      expect(rcov_line.missed?).to eq(false)
+    end
+  end
+
+  describe "#ignored?" do
+    it "returns true if was_run is nil" do
+      rcov_line = RCovLine.new("", nil)
+
+      expect(rcov_line.ignored?).to eq(true)
+    end
+
+    it "returns false if was_run is 1" do
+      rcov_line = RCovLine.new("", 1)
+
+      expect(rcov_line.ignored?).to eq(false)
+    end
+
+    it "returns false if was_run is 0" do
+      rcov_line = RCovLine.new("", 0)
+
+      expect(rcov_line.ignored?).to eq(false)
+    end
+  end
+
+  describe "#css_class" do
+    it "returns 'rcov_run' for an ignored line" do
+      rcov_line = RCovLine.new("", nil)
+      expect(rcov_line.css_class).to eq("rcov_run")
+    end
+
+    it "returns 'rcov_not_run' for a missed line" do
+      rcov_line = RCovLine.new("", 0)
+      expect(rcov_line.css_class).to eq("rcov_not_run")
+    end
+
+    it "returns 'rcov_run' for a covered line" do
+      rcov_line = RCovLine.new("", 1)
+      expect(rcov_line.css_class).to eq("rcov_run")
+    end
+  end
+end

data/spec/metric_fu/metrics/rcov/simplecov_formatter_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+require "simplecov"
+require "metric_fu/metrics/rcov/simplecov_formatter"
+require "metric_fu/metrics/rcov/generator"
+
+describe SimpleCov::Formatter::MetricFu do
+  before do
+    @rcov_file =  subject.coverage_file_path
+    File.delete(@rcov_file) if File.exists?(@rcov_file)
+
+    @result = SimpleCov::Result.new(
+
+       FIXTURE.fixtures_path.join("coverage.rb").expand_path.to_s =>
+        [1, 1, 1, 1, nil, 1, 0, 1, 1, nil, 0, 1, 1]
+
+    )
+  end
+
+  it "test_format" do
+    SimpleCov::Formatter::MetricFu.new.format(@result)
+
+    expect(File.exists?(@rcov_file)).to be_truthy
+  end
+
+  if SimpleCov.running
+    MetricFu.logger.info "Skipping specs while SimpleCov is running"
+  else
+    it "test_create_content" do
+      content = SimpleCov::Formatter::MetricFu::FormatLikeRCov.new(@result).format
+      test = "\=" * 80
+
+      expect(content).to match(/#{test}/)
+      expect(content).to match(/!!     value \* value/)
+    end
+
+    if defined?(JRUBY_VERSION)
+      STDOUT.puts "Skipping spec 'cause JRuby doesn't do Coverage right"
+    else
+      it "calculates the same coverage from an RCov report as from SimpleCov" do
+        SimpleCov.start # start coverage
+        require "fixtures/coverage-153"
+        result = SimpleCov.result # end coverage
+        source_file = result.source_files.first
+
+        # formatter ouputs this from simplecov result
+        rcov_text = SimpleCov::Formatter::MetricFu::FormatLikeRCov.new(result).format
+
+        # generator analyzes the rcov text
+        analyzed_rcov_text = MetricFu::RCovFormatCoverage.new(rcov_text).to_h
+        # [:lines, :percent_run, :methods]
+        covered_lines_from_rcov_text = analyzed_rcov_text["./spec/fixtures/coverage-153.rb"][:lines]
+        # https://github.com/colszowka/simplecov/blob/master/lib/simplecov/source_file.rb
+        expect(source_file.coverage.count).to eq(covered_lines_from_rcov_text.count)
+
+        line_coverage_from_rcov_text = covered_lines_from_rcov_text.map { |line| line[:was_run] }
+        expect(source_file.coverage).to eq(line_coverage_from_rcov_text)
+
+        expect(source_file.covered_percent).to eq(MetricFu::RCovFormatCoverage::TestCoverage.percent_run(covered_lines_from_rcov_text))
+
+        source_file.lines.each_with_index do |line, index|
+          expect(line.coverage).to eq(line_coverage_from_rcov_text[index])
+        end
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,13 @@
+require "spec_helper"
+require "shared/configured"
+
+describe MetricFu::Configuration, "for reek" do
+  it_behaves_like "configured" do
+    it "should set @reek to {:dirs_to_reek => @code_dirs}" do
+      load_metric "reek"
+      expect(MetricFu::Metric.get_metric(:reek).run_options).to eq(
+              config_file_pattern: nil, dirs_to_reek: ["lib"]
+      )
+    end
+  end
+end

data/spec/metric_fu/metrics/reek/generator_spec.rb

@@ -0,0 +1,203 @@
+require "spec_helper"
+
+MetricFu.metrics_require { "reek/generator" }
+
+describe MetricFu::ReekGenerator do
+  describe "emit" do
+    let(:options) { { dirs_to_reek: [] } }
+    let(:files_to_analyze) { ["lib/foo.rb", "lib/bar.rb"] }
+    let(:reek) { MetricFu::ReekGenerator.new(options) }
+
+    before(:each) do
+      allow(reek).to receive(:files_to_analyze).and_return(files_to_analyze)
+    end
+
+    it "includes config file pattern into reek parameters when specified" do
+      options.merge!(config_file_pattern: "lib/config/*.reek")
+
+      expect(reek).to receive(:run!) do |_files, config_files|
+        expect(config_files).to eq(["lib/config/*.reek"])
+      end.and_return("")
+
+      reek.emit
+    end
+
+    it "passes an empty array when no config file pattern is specified" do
+      expect(reek).to receive(:run!) do |_files, config_files|
+        expect(config_files).to eq([])
+      end.and_return("")
+
+      reek.emit
+    end
+
+    it "includes files to analyze into reek parameters" do
+      expect(reek).to receive(:run!) do |files, _config_files|
+        expect(files).to eq(["lib/foo.rb", "lib/bar.rb"])
+      end.and_return("")
+
+      reek.emit
+    end
+  end
+
+  describe "analyze method" do
+    before :each do
+      MetricFu::Configuration.run {}
+      allow(File).to receive(:directory?).and_return(true)
+      @generator = MetricFu::ReekGenerator.new
+      @examiner = @generator.send(:examiner)
+      @smell_warning = Reek.const_defined?(:SmellWarning) ? Reek.const_get(:SmellWarning) : Reek.const_get(:Smells).const_get(:SmellWarning)
+      if @smell_warning.instance_methods.include?(:subclass)
+        @smell_warning.send(:alias_method, :smell_type, :subclass)
+      end
+    end
+
+    context "with reek warnings" do
+      before :each do
+        @smells = [
+            instance_double(@smell_warning,
+                            source: "app/controllers/activity_reports_controller.rb",
+                            context: "ActivityReportsController#authorize_user",
+                            message: "calls current_user.primary_site_ids multiple times",
+                            smell_type: "Duplication",
+                            lines: [2, 4]),
+            instance_double(@smell_warning,
+                            source: "app/controllers/activity_reports_controller.rb",
+                            context: "ActivityReportsController#authorize_user",
+                            message: "calls params[id] multiple times",
+                            smell_type: "Duplication",
+                            lines: [5, 7]),
+            instance_double(@smell_warning,
+                            source: "app/controllers/activity_reports_controller.rb",
+                            context: "ActivityReportsController#authorize_user",
+                            message: "calls params[primary_site_id] multiple times",
+                            smell_type: "Duplication",
+                            lines: [11, 15]),
+            instance_double(@smell_warning,
+                            source: "app/controllers/activity_reports_controller.rb",
+                            context: "ActivityReportsController#authorize_user",
+                            message: "has approx 6 statements",
+                            smell_type: "Long Method",
+                            lines: [8]),
+
+            instance_double(@smell_warning,
+                            source: "app/controllers/application.rb",
+                            context: "ApplicationController#start_background_task/block/block",
+                            message: "is nested",
+                            smell_type: "Nested Iterators",
+                            lines: [23]),
+
+            instance_double(@smell_warning,
+                            source: "app/controllers/link_targets_controller.rb",
+                            context: "LinkTargetsController#authorize_user",
+                            message: "calls current_user.role multiple times",
+                            smell_type: "Duplication",
+                            lines: [8]),
+
+            instance_double(@smell_warning,
+                            source: "app/controllers/newline_controller.rb",
+                            context: "NewlineController#some_method",
+                            message: "calls current_user.<< \"new line\n\" multiple times",
+                            smell_type: "Duplication",
+                            lines: [6, 9])
+        ]
+        @examiners = [
+          instance_double(Reek::Examiner, smells: @smells)
+        ]
+        @generator.instance_variable_set(:@output, @examiners)
+        @matches = @generator.analyze
+      end
+
+      it "should find the code smell's line numbers" do
+        smell = @matches.first[:code_smells].first
+        expect(smell[:lines]).to eq([2, 4])
+      end
+
+      it "should find the code smell's method name" do
+        smell = @matches.first[:code_smells].first
+        expect(smell[:method]).to eq("ActivityReportsController#authorize_user")
+      end
+
+      it "should find the code smell's type" do
+        smell = @matches[1][:code_smells].first
+        expect(smell[:type]).to eq("Nested Iterators")
+      end
+
+      it "should find the code smell's message" do
+        smell = @matches[1][:code_smells].first
+        expect(smell[:message]).to eq("is nested")
+      end
+
+      it "should find the code smell's type" do
+        smell = @matches.first
+        expect(smell[:file_path]).to eq("app/controllers/activity_reports_controller.rb")
+      end
+
+      it "should NOT insert nil smells into the array when there's a newline in the method call" do
+        expect(@matches.last[:code_smells]).to eq(@matches.last[:code_smells].compact)
+      end
+    end
+
+    context "with reek 1.3 output" do
+      before :each do
+        @smells = [
+            double(source: "app/controllers/activity_reports_controller.rb",
+                   context: "ActivityReportsController#authorize_user",
+                   message: "calls current_user.primary_site_ids multiple times",
+                   subclass: "Duplication",
+                   lines: [2, 4]),
+        ]
+        @examiners = [
+          instance_double(Reek::Examiner, smells: @smells)
+        ]
+        @generator.instance_variable_set(:@output, @examiners)
+        @matches = @generator.analyze
+      end
+
+      it "uses the subclass field to find the smell type" do
+        smell = @matches.first[:code_smells].first
+        expect(smell[:type]).to eq('Duplication')
+      end
+    end
+
+    context "with real output, not mocked nor doubled" do
+      let(:result) do
+        {
+          file_path: "spec/support/samples/reek/alfa.rb",
+          code_smells: [
+            {
+              lines: [1],
+              message: "has unused parameter 'echo'",
+              method: "foo",
+              type: "UnusedParameters"
+            }
+          ]
+        }
+      end
+
+      it "returns real data" do
+        MetricFu.with_run_dir File.expand_path("../../..", __FILE__) do
+          @generator = MetricFu::ReekGenerator.new(dirs_to_reek: ["spec/support/samples"])
+          @generator.emit
+
+          @matches = @generator.analyze
+
+          expect(@matches.first).to eq(result)
+        end
+      end
+    end
+
+    context "without reek warnings" do
+      before :each do
+        @examiners = [
+          instance_double(Reek::Examiner, smells: [])
+        ]
+        @generator.instance_variable_set(:@output, @examiners)
+        @matches = @generator.analyze
+      end
+
+      it "returns empty analysis" do
+        expect(@matches).to eq([])
+      end
+    end
+  end
+end