code_metric_fu 4.14.0

data/spec/metric_fu/formatter/yaml_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+MetricFu.formatter_require { "yaml" }
+
+describe MetricFu::Formatter::YAML do
+  before do
+    setup_fs
+
+    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)
+  end
+
+  context "In general" do
+    it "creates a report yaml file" do
+      expect {
+        MetricFu::Formatter::YAML.new.finish
+      }.to create_file("#{directory('base_directory')}/report.yml")
+    end
+  end
+
+  context "given a custom output file" do
+    before do
+      @output = "customreport.yml"
+    end
+
+    it "creates a report yaml file to the custom output path" do
+      expect {
+        MetricFu::Formatter::YAML.new(output: @output).finish
+      }.to create_file("#{directory('base_directory')}/customreport.yml")
+    end
+  end
+
+  context "given a custom output stream" do
+    before do
+      @output = $stdout
+    end
+
+    it "creates a report yaml in the custom stream" do
+      out = MetricFu::Utility.capture_output {
+        MetricFu::Formatter::YAML.new(output: @output).finish
+      }
+      expect(out).to include ":#{@metric1}:"
+      expect(out).to include ":#{@metric2}:"
+    end
+  end
+
+  after do
+    cleanup_fs
+  end
+end

data/spec/metric_fu/formatter_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe MetricFu::Formatter do
+  describe "formatter class loading" do
+    context "given a built-in formatter (string)" do
+      subject { MetricFu::Formatter.class_for("html") }
+
+      it "returns the formatter class" do
+        expect(subject).to eq(MetricFu::Formatter::HTML)
+      end
+    end
+
+    context "given a built-in formatter (symbol)" do
+      subject { MetricFu::Formatter.class_for(:yaml) }
+
+      it "returns the formatter class" do
+        expect(subject).to eq(MetricFu::Formatter::YAML)
+      end
+    end
+
+    context "given an unknown built-in formatter" do
+      subject { MetricFu::Formatter.class_for(:unknown) }
+
+      it "raises an error" do
+        expect { subject }.to raise_error(NameError)
+      end
+    end
+
+    context "given a custom formatter that exists" do
+      subject { MetricFu::Formatter.class_for("MyCustomFormatter") }
+
+      before do
+        stub_const("MyCustomFormatter", Class.new { def initialize(*); end })
+      end
+
+      it "returns the formatter class" do
+        expect(subject).to eq(MyCustomFormatter)
+      end
+    end
+
+    context "given a custom formatter that doesnt exist" do
+      subject { MetricFu::Formatter.class_for("MyNonExistentCustomFormatter") }
+
+      it "raises an error" do
+        expect { subject }.to raise_error(NameError)
+      end
+    end
+  end
+end

data/spec/metric_fu/gem_version_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+MetricFu.lib_require { "gem_version" }
+
+describe MetricFu::GemVersion do
+  it "has a list of gem deps" do
+    gem_version = MetricFu::GemVersion.new
+    gem_deps = gem_version.gem_runtime_dependencies.map(&:name)
+    MetricFu::Metric.metrics.reject { |metric| metric.name == :hotspots || metric.name == :stats }.map(&:name).map(&:to_s).each do |metric_name|
+      expect(gem_deps).to include(metric_name)
+    end
+  end
+end

data/spec/metric_fu/generator_spec.rb

@@ -0,0 +1,130 @@
+require "spec_helper"
+
+describe MetricFu::Generator do
+  include TestConstruct::Helpers
+
+  class ConcreteClass < MetricFu::Generator
+    def self.metric
+      :concrete
+    end
+
+    def emit
+    end
+
+    def analyze
+    end
+
+    def to_h
+    end
+  end
+
+  before(:each) do
+    ENV["CC_BUILD_ARTIFACTS"] = nil
+    MetricFu.configuration.reset
+    MetricFu.configure
+    @concrete_class = ConcreteClass.new
+  end
+
+  describe "ConcreteClass#metric_directory" do
+    it "should be '{artifact_dir}/scratch/concreteclass'" do
+      concrete_metric = double("concrete_metric")
+      expect(MetricFu::Metric).to receive(:get_metric).with(:concrete).and_return(concrete_metric)
+      expect(concrete_metric).to receive(:run_options).and_return({})
+      compare_paths(ConcreteClass.metric_directory, scratch_directory("concrete"))
+    end
+  end
+
+  describe "#metric_directory" do
+    it "should return the results of ConcreteClass#metric_directory" do
+      allow(ConcreteClass).to receive(:metric_directory).and_return("foo")
+      expect(@concrete_class.metric_directory).to eq("foo")
+    end
+  end
+
+  describe "#generate_result" do
+    it "should raise an error when calling #emit" do
+      @abstract_class = MetricFu::Generator.new
+      expect { @abstract_class.generate_result }.to raise_error NotImplementedError
+    end
+
+    it "should call #analyze" do
+      @abstract_class = MetricFu::Generator.new
+      expect { @abstract_class.generate_result }.to raise_error NotImplementedError
+    end
+
+    it "should call #to_h" do
+      @abstract_class = MetricFu::Generator.new
+      expect { @abstract_class.generate_result }.to raise_error NotImplementedError
+    end
+  end
+
+  describe "#generate_result (in a concrete class)" do
+    %w[emit analyze].each do |meth|
+      it "should call ##{meth}" do
+        expect(@concrete_class).to receive("#{meth}")
+        @concrete_class.generate_result
+      end
+    end
+
+    it "should call #to_h" do
+      expect(@concrete_class).to receive(:to_h)
+      @concrete_class.generate_result
+    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 = MetricFu.run_dir
+        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)
+        expect(files).to eq(@paths)
+      end
+
+      it "should filter filename at root level" do
+        files = @concrete_class.remove_excluded_files(@paths, ["basic.rb"])
+        expect(files).not_to include("basic.rb")
+      end
+
+      it "should remove files that are two levels deep" do
+        files = @concrete_class.remove_excluded_files(@paths, ["**/fake.rb"])
+        expect(files).not_to include("lib/fake/fake.rb")
+      end
+
+      it "should remove files from an excluded directory" do
+        files = @concrete_class.remove_excluded_files(@paths, ["lib/bad/**"])
+        expect(files).not_to include("lib/bad/one.rb")
+        expect(files).not_to include("lib/bad/two.rb")
+        expect(files).not_to 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"])
+        expect(files).not_to include("lib/this/dan_file.rb")
+        expect(files).not_to include("lib/this/ben_file.rb")
+        expect(files).to include("lib/this/avdi_file.rb")
+      end
+    end
+  end
+end

data/spec/metric_fu/loader_spec.rb

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+describe MetricFu do
+  it "loads the .metrics file" do
+    # Global only for testing that this file gets loaded
+    $metric_file_loaded = false
+    MetricFu.loader.load_user_configuration
+    expect($metric_file_loaded).to be_truthy
+  end
+end

data/spec/metric_fu/metric_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+describe MetricFu::Metric do
+  before do
+    @metric = MetricFu::Metric.get_metric(:flog)
+    # @original_options = @metric.run_options.dup
+  end
+
+  # it "can have its run_options over-written" do
+  # new_options = {:foo => 'bar'}
+  # @metric.run_options = new_options
+  # expect(@original_options).to_not eq(new_options)
+  # expect(@metric.run_options).to eq(new_options)
+  # end
+
+  # it "can have its run_options modified" do
+  # new_options = {:foo => 'bar'}
+  # @metric.run_options.merge!(new_options)
+  # expect(@metric.run_options).to eq(@original_options.merge(new_options))
+  # end
+
+  context "given a valid configurable option" do
+    before do
+      allow(@metric).to receive(:default_run_options).and_return(foo: "baz")
+    end
+
+    it "can be configured as an attribute" do
+      @metric.foo = "qux"
+      expect(@metric.run_options[:foo]).to eq("qux")
+    end
+  end
+
+  context "given an invalid configurable option" do
+    before do
+      allow(@metric).to receive(:default_run_options).and_return({})
+    end
+
+    it "raises an error" do
+      expect { @metric.foo = "bar" }.to raise_error(RuntimeError, /not a valid configuration option/)
+    end
+  end
+
+  after do
+    @metric.configured_run_options.clear
+  end
+end

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

@@ -0,0 +1,22 @@
+require "spec_helper"
+require "shared/configured"
+
+describe MetricFu::Configuration, "for cane" do
+  it_behaves_like "configured" do
+    if MetricFu.configuration.mri?
+      it "should set @cane to " +
+        ':dirs_to_cane => @code_dirs, :abc_max => 15, :line_length => 80, :no_doc => "n", :no_readme => "y"' do
+        load_metric "cane"
+        expect(MetricFu::Metric.get_metric(:cane).run_options).to eq(
+
+            dirs_to_cane: directory("code_dirs"),
+            filetypes: ["rb"],
+            abc_max: 15,
+            line_length: 80,
+            no_doc: "n",
+            no_readme: "n"
+            )
+      end
+    end
+  end # end it_behaves
+end

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

@@ -0,0 +1,184 @@
+require "spec_helper"
+MetricFu.metrics_require { "cane/generator" }
+
+describe CaneGenerator do
+  describe "emit method" do
+    it "should execute cane command" do
+      options = {}
+      @cane = MetricFu::CaneGenerator.new(options)
+      expect(@cane).to receive(:run!).with("")
+      output = @cane.emit
+    end
+
+    it "should use abc max option" do
+      options = { abc_max: 20 }
+      @cane = MetricFu::CaneGenerator.new(options)
+      expect(@cane).to receive(:run!).with(" --abc-max 20")
+      output = @cane.emit
+    end
+
+    it "should use style max line length option" do
+      options = { line_length: 100 }
+      @cane = MetricFu::CaneGenerator.new(options)
+      expect(@cane).to receive(:run!).with(" --style-measure 100")
+      output = @cane.emit
+    end
+
+    it "should use no-doc if specified" do
+      options = { no_doc: "y" }
+      @cane = MetricFu::CaneGenerator.new(options)
+      expect(@cane).to receive(:run!).with(" --no-doc")
+      output = @cane.emit
+    end
+
+    it "should include doc violations if no_doc != 'y'" do
+      options = { no_doc: "n" }
+      @cane = MetricFu::CaneGenerator.new(options)
+      expect(@cane).to receive(:run!).with("")
+      output = @cane.emit
+    end
+
+    it "should use no-readme if specified" do
+      options = { no_readme: "y" }
+      @cane = MetricFu::CaneGenerator.new(options)
+      expect(@cane).to receive(:run!).with(" --no-readme")
+      output = @cane.emit
+    end
+
+    it "should include README violations if no_readme != 'y'" do
+      options = { no_readme: "n" }
+      @cane = MetricFu::CaneGenerator.new(options)
+      expect(@cane).to receive(:run!).with("")
+      output = @cane.emit
+    end
+  end
+
+  describe "parse cane empty output" do
+    before :each do
+      # MetricFu::Configuration.run {}
+      allow(File).to receive(:directory?).and_return(true)
+      options = {}
+      @cane = MetricFu::CaneGenerator.new(options)
+      @cane.instance_variable_set(:@output, "")
+    end
+
+    describe "analyze method" do
+      it "should find total violations" do
+        @cane.analyze
+        expect(@cane.total_violations).to eq(0)
+      end
+    end
+  end
+
+  describe "parse cane output" do
+    before :each do
+      lines = sample_cane_output
+      MetricFu::Configuration.run {}
+      allow(File).to receive(:directory?).and_return(true)
+      @cane = MetricFu::CaneGenerator.new("base_dir")
+      @cane.instance_variable_set(:@output, lines)
+    end
+
+    describe "analyze method" do
+      it "should find total violations" do
+        @cane.analyze
+        expect(@cane.total_violations).to eq(6)
+      end
+
+      it "should extract abc complexity violations" do
+        @cane.analyze
+        expect(@cane.violations[:abc_complexity]).to eq([
+          { file: "lib/abc/foo.rb", method: "Abc::Foo#method", complexity: "11" },
+          { file: "lib/abc/bar.rb", method: "Abc::Bar#method", complexity: "22" }
+        ])
+      end
+
+      it "should extract line style violations" do
+        @cane.analyze
+        expect(@cane.violations[:line_style]).to eq([
+          { line: "lib/line/foo.rb:1", description: "Line is >80 characters (135)" },
+          { line: "lib/line/bar.rb:2", description: "Line contains trailing whitespace" }
+        ])
+      end
+
+      it "should extract comment violations" do
+        @cane.analyze
+        expect(@cane.violations[:comment]).to eq([
+          { line: "lib/comments/foo.rb:1", class_name: "Foo" },
+          { line: "lib/comments/bar.rb:2", class_name: "Bar" }
+        ])
+      end
+
+      it "should extract no readme violations if present" do
+        @cane.analyze
+        expect(@cane.violations[:documentation]).to eq([
+          { description: "No README found" },
+        ])
+      end
+
+      it "should extract unknown violations in others category" do
+        @cane.analyze
+        expect(@cane.violations[:others]).to eq([
+          { description: "Misc issue 1" },
+          { description: "Misc issue 2" }
+        ])
+      end
+    end
+
+    describe "to_h method" do
+      it "should have total violations" do
+        @cane.analyze
+        expect(@cane.to_h[:cane][:total_violations]).to eq(6)
+      end
+
+      it "should have violations by category" do
+        @cane.analyze
+        expect(@cane.to_h[:cane][:violations][:abc_complexity]).to eq([
+          { file: "lib/abc/foo.rb", method: "Abc::Foo#method", complexity: "11" },
+          { file: "lib/abc/bar.rb", method: "Abc::Bar#method", complexity: "22" }
+        ])
+        expect(@cane.to_h[:cane][:violations][:line_style]).to eq([
+          { line: "lib/line/foo.rb:1", description: "Line is >80 characters (135)" },
+          { line: "lib/line/bar.rb:2", description: "Line contains trailing whitespace" }
+        ])
+        expect(@cane.to_h[:cane][:violations][:comment]).to eq([
+          { line: "lib/comments/foo.rb:1", class_name: "Foo" },
+          { line: "lib/comments/bar.rb:2", class_name: "Bar" }
+        ])
+      end
+    end
+  end
+
+  def sample_cane_output
+    <<-OUTPUT
+Methods exceeded maximum allowed ABC complexity (33):
+
+  lib/abc/foo.rb       Abc::Foo#method 11
+  lib/abc/bar.rb       Abc::Bar#method 22
+
+Lines violated style requirements (340):
+
+  lib/line/foo.rb:1       Line is >80 characters (135)
+  lib/line/bar.rb:2       Line contains trailing whitespace
+
+Missing documentation (1):
+
+  No README found
+
+Class definitions require explanatory comments on preceding line (2):
+
+  lib/comments/foo.rb:1       Foo
+  lib/comments/bar.rb:2       Bar
+
+Unknown violation (1):
+
+  Misc issue 1
+
+Another Unknown violation (1):
+
+  Misc issue 2
+
+Total Violations: 6
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,13 @@
+require "spec_helper"
+require "shared/configured"
+
+describe MetricFu::Configuration, "for churn" do
+  it_behaves_like "configured" do
+    it "should set @churn to {}" do
+      load_metric "churn"
+      expect(MetricFu::Metric.get_metric(:churn).run_options).to eq(
+               start_date: '"1 year ago"', minimum_churn_count: 10, ignore_files: [], data_directory: MetricFu::Io::FileSystem.scratch_directory("churn")
+      )
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+require "spec_helper"
+MetricFu.metrics_require { "churn/generator" }
+
+describe MetricFu::ChurnGenerator do
+  # TODO extract yaml
+  let(:churn_hash) { YAML::load("--- \n:churn: \n  :changed_files: \n  - spec/graphs/flog_grapher_spec.rb\n  - spec/base/graph_spec.rb\n  - lib/templates/awesome/layout.html.erb\n  - lib/graphs/rcov_grapher.rb\n  - lib/base/base_template.rb\n  - spec/graphs/grapher_spec.rb\n  - lib/templates/awesome/flog.html.erb\n  - lib/templates/awesome/flay.html.erb\n  - lib/graphs/roodi_grapher.rb\n  - lib/graphs/reek_grapher.rb\n  - HISTORY\n  - spec/graphs/roodi_grapher_spec.rb\n  - lib/generators/rcov.rb\n  - spec/graphs/engines/gchart_spec.rb\n  - spec/graphs/rcov_grapher_spec.rb\n  - lib/templates/javascripts/excanvas.js\n  - lib/templates/javascripts/bluff-min.js\n  - spec/graphs/reek_grapher_spec.rb\n") }
+
+  let(:config_setup) {
+    ENV["CC_BUILD_ARTIFACTS"] = nil
+    MetricFu.configure.reset
+  }
+
+  describe "analyze method" do
+    before :each do
+      config_setup
+      @changes = { "lib/generators/flog.rb" => 2, "lib/metric_fu.rb" => 3 }
+    end
+
+    it "should be empty on error no output captured" do
+      churn = MetricFu::ChurnGenerator.new
+      churn.instance_variable_set(:@output, nil)
+      result = churn.analyze
+      expect(result).to eq(churn: {})
+    end
+
+    it "should return yaml results" do
+      churn = MetricFu::ChurnGenerator.new
+      churn.instance_variable_set(:@output, churn_hash)
+      result = churn.analyze
+      expect(result).to eq(churn: { changed_files: ["spec/graphs/flog_grapher_spec.rb", "spec/base/graph_spec.rb", "lib/templates/awesome/layout.html.erb", "lib/graphs/rcov_grapher.rb", "lib/base/base_template.rb", "spec/graphs/grapher_spec.rb", "lib/templates/awesome/flog.html.erb", "lib/templates/awesome/flay.html.erb", "lib/graphs/roodi_grapher.rb", "lib/graphs/reek_grapher.rb", "HISTORY", "spec/graphs/roodi_grapher_spec.rb", "lib/generators/rcov.rb", "spec/graphs/engines/gchart_spec.rb", "spec/graphs/rcov_grapher_spec.rb", "lib/templates/javascripts/excanvas.js", "lib/templates/javascripts/bluff-min.js", "spec/graphs/reek_grapher_spec.rb"] })
+    end
+  end
+
+  describe "to_h method" do
+    before :each do
+      config_setup
+    end
+
+    it "should put the changes into a hash" do
+      churn = MetricFu::ChurnGenerator.new
+      churn.instance_variable_set(:@churn, churn: "results")
+      expect(churn.to_h[:churn]).to eq("results")
+    end
+  end
+
+  describe "emit method" do
+    before :each do
+      config_setup
+      @churn = MetricFu::ChurnGenerator.new
+    end
+
+    it "returns churn output" do
+      allow(@churn).to receive(:run).and_return(churn_hash)
+      result = @churn.emit
+      expect(result).to eq(churn_hash)
+    end
+
+    it "returns nil, when churn result is not yaml" do
+      allow(@churn).to receive(:run).and_return(nil)
+      result = @churn.emit
+      expect(result).to be nil
+    end
+  end
+end

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

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