metric_fu 4.11.1 → 4.13.0

data/spec/metric_fu/loader_spec.rb

@@ -1,12 +1,13 @@
-require 'spec_helper'
+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
+    MetricFu.with_run_dir "spec/support" do
+      MetricFu.loader.load_user_configuration
+    end
+
     expect($metric_file_loaded).to be_truthy
   end
-
 end

data/spec/metric_fu/metric_spec.rb

@@ -1,47 +1,43 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe MetricFu::Metric do
   before do
     @metric = MetricFu::Metric.get_metric(:flog)
-    #@original_options = @metric.run_options.dup
+    # @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 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
+  # 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'})
+      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')
+    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
-
+  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/)
+    it "raises an error" do
+      expect { @metric.foo = "bar" }.to raise_error(RuntimeError, /not a valid configuration option/)
     end
-
   end
 
   after do

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

@@ -1,20 +1,20 @@
-require 'spec_helper'
-require 'shared/configured'
+require "spec_helper"
+require "shared/configured"
 
-describe MetricFu::Configuration, 'for cane' do
-  it_behaves_like 'configured' do
+describe MetricFu::Configuration, "for cane" do
+  it_behaves_like "configured" do
     if MetricFu.configuration.mri?
-      it 'should set @cane to ' +
-                          %q(:dirs_to_cane => @code_dirs, :abc_max => 15, :line_length => 80, :no_doc => 'n', :no_readme => 'y') do
-        load_metric 'cane'
+      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"}
+
+            dirs_to_cane: directory("code_dirs"),
+            filetypes: ["rb"],
+            abc_max: 15,
+            line_length: 80,
+            no_doc: "n",
+            no_readme: "n"
             )
       end
     end

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

@@ -1,9 +1,8 @@
-require 'spec_helper'
-MetricFu.metrics_require { 'cane/generator' }
+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)
@@ -12,42 +11,42 @@ describe CaneGenerator do
     end
 
     it "should use abc max option" do
-      options = {abc_max: 20}
+      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}
+      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'}
+      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'}
+      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'}
+      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'}
+      options = { no_readme: "n" }
       @cane = MetricFu::CaneGenerator.new(options)
       expect(@cane).to receive(:run!).with("")
       output = @cane.emit
@@ -60,11 +59,10 @@ describe CaneGenerator do
       allow(File).to receive(:directory?).and_return(true)
       options = {}
       @cane = MetricFu::CaneGenerator.new(options)
-      @cane.instance_variable_set(:@output, '')
+      @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)
@@ -77,12 +75,11 @@ describe CaneGenerator do
       lines = sample_cane_output
       MetricFu::Configuration.run {}
       allow(File).to receive(:directory?).and_return(true)
-      @cane = MetricFu::CaneGenerator.new('base_dir')
+      @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)
@@ -91,39 +88,39 @@ describe CaneGenerator do
       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'}
+          { 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'}
+          { 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'}
+          { 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'},
+          { 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'}
+          { description: "Misc issue 1" },
+          { description: "Misc issue 2" }
         ])
       end
     end
@@ -134,19 +131,19 @@ describe CaneGenerator do
         expect(@cane.to_h[:cane][:total_violations]).to eq(6)
       end
 
-      it  "should have violations by category" do
+      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'}
+          { 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'}
+          { 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'}
+          { line: "lib/comments/foo.rb:1", class_name: "Foo" },
+          { line: "lib/comments/bar.rb:2", class_name: "Bar" }
         ])
       end
     end

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

@@ -1,15 +1,13 @@
-require 'spec_helper'
-require 'shared/configured'
+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'
+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 => %q("1 year ago"), :minimum_churn_count => 10, :ignore_files=>[], :data_directory=> MetricFu::Io::FileSystem.scratch_directory('churn')}
+               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

@@ -1,39 +1,36 @@
 require "spec_helper"
-MetricFu.metrics_require { 'churn/generator' }
+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
+    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}
+      @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 => {}})
+      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"]}})
+      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
@@ -41,12 +38,11 @@ describe MetricFu::ChurnGenerator do
 
     it "should put the changes into a hash" do
       churn = MetricFu::ChurnGenerator.new
-      churn.instance_variable_set(:@churn, {:churn => 'results'})
+      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
@@ -66,4 +62,3 @@ describe MetricFu::ChurnGenerator do
     end
   end
 end
-

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

@@ -1,15 +1,13 @@
-require 'spec_helper'
-require 'shared/configured'
+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'
+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}
+              dirs_to_flay: ["lib"], minimum_score: nil
       )
     end
-
   end
 end

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

@@ -1,10 +1,10 @@
 require "spec_helper"
-MetricFu.metrics_require { 'flay/generator' }
+MetricFu.metrics_require { "flay/generator" }
 
 describe MetricFu::FlayGenerator do
   describe "emit method" do
     it "should look at the dirs" do
-      options = { :dirs_to_flay => ['app', 'lib'] }
+      options = { dirs_to_flay: ["app", "lib"] }
       allow(File).to receive(:directory?).and_return(true)
       @flay = MetricFu::FlayGenerator.new(options)
 
@@ -13,7 +13,7 @@ describe MetricFu::FlayGenerator do
     end
 
     it "should limit flay scores by the minimum_score" do
-      options = { :dirs_to_flay => [], :minimum_score => 99 }
+      options = { dirs_to_flay: [], minimum_score: 99 }
       allow(File).to receive(:directory?).and_return(true)
       @flay = MetricFu::FlayGenerator.new(options)
 
@@ -40,57 +40,56 @@ Total score (lower is better) = 246
       HERE
       MetricFu::Configuration.run {}
       allow(File).to receive(:directory?).and_return(true)
-      @flay = MetricFu::FlayGenerator.new('base_dir')
+      @flay = MetricFu::FlayGenerator.new("base_dir")
       @flay.instance_variable_set(:@output, lines)
     end
 
     it "should analyze and return matches" do
-      expect(@flay.analyze).to eq([ ["Total score (lower is better) = 246"],
-                                ["\n1) IDENTICAL code found in :or (mass*2 = 68)",
-                                  "app/controllers/link_targets_controller.rb:57",
-                                  "app/controllers/primary_sites_controller.rb:138"],
-                                ["2) Similar code found in :if (mass = 64)",
-                                  "app/controllers/primary_sites_controller.rb:75",
-                                  "app/controllers/primary_sites_controller.rb:76",
-                                  "app/controllers/primary_sites_controller.rb:88",
-                                  "app/controllers/primary_sites_controller.rb:89"] ])
+      expect(@flay.analyze).to eq([["Total score (lower is better) = 246"],
+                                   ["\n1) IDENTICAL code found in :or (mass*2 = 68)",
+                                    "app/controllers/link_targets_controller.rb:57",
+                                    "app/controllers/primary_sites_controller.rb:138"],
+                                   ["2) Similar code found in :if (mass = 64)",
+                                    "app/controllers/primary_sites_controller.rb:75",
+                                    "app/controllers/primary_sites_controller.rb:76",
+                                    "app/controllers/primary_sites_controller.rb:88",
+                                    "app/controllers/primary_sites_controller.rb:89"]])
     end
   end
 
   describe "to_h method" do
-
     before :each do
-      lines = [ ["Total score (lower is better) = 284"],
-                  ["\n1) IDENTICAL code found in :or (mass*2 = 68)",
-                    "app/controllers/link_targets_controller.rb:57",
-                    "app/controllers/primary_sites_controller.rb:138"],
-                  ["2) Similar code found in :if (mass = 64)",
-                    "app/controllers/primary_sites_controller.rb:75",
-                    "app/controllers/primary_sites_controller.rb:76",
-                    "app/controllers/primary_sites_controller.rb:88",
-                    "app/controllers/primary_sites_controller.rb:89"],
-                  ["3) Similar code found in :defn (mass = 40)",
-                    "app/controllers/link_targets_controller.rb:40",
-                    "app/controllers/primary_sites_controller.rb:98"],
-                  ["4) Similar code found in :defn (mass = 38)",
-                    "app/controllers/link_targets_controller.rb:13",
-                    "app/controllers/primary_sites_controller.rb:50"],
-                  ["5) Similar code found in :defn (mass = 38)",
-                    "app/models/primary_site.rb:104",
-                    "app/models/primary_site.rb:109"],
-                  ["6) Similar code found in :call (mass = 36)",
-                    "app/controllers/bookmarklet_integration_controller.rb:6",
-                    "app/controllers/bookmarklet_integration_controller.rb:17"]]
+      lines = [["Total score (lower is better) = 284"],
+               ["\n1) IDENTICAL code found in :or (mass*2 = 68)",
+                "app/controllers/link_targets_controller.rb:57",
+                "app/controllers/primary_sites_controller.rb:138"],
+               ["2) Similar code found in :if (mass = 64)",
+                "app/controllers/primary_sites_controller.rb:75",
+                "app/controllers/primary_sites_controller.rb:76",
+                "app/controllers/primary_sites_controller.rb:88",
+                "app/controllers/primary_sites_controller.rb:89"],
+               ["3) Similar code found in :defn (mass = 40)",
+                "app/controllers/link_targets_controller.rb:40",
+                "app/controllers/primary_sites_controller.rb:98"],
+               ["4) Similar code found in :defn (mass = 38)",
+                "app/controllers/link_targets_controller.rb:13",
+                "app/controllers/primary_sites_controller.rb:50"],
+               ["5) Similar code found in :defn (mass = 38)",
+                "app/models/primary_site.rb:104",
+                "app/models/primary_site.rb:109"],
+               ["6) Similar code found in :call (mass = 36)",
+                "app/controllers/bookmarklet_integration_controller.rb:6",
+                "app/controllers/bookmarklet_integration_controller.rb:17"]]
 
       MetricFu::Configuration.run {}
       allow(File).to receive(:directory?).and_return(true)
-      flay = MetricFu::FlayGenerator.new('base_dir')
+      flay = MetricFu::FlayGenerator.new("base_dir")
       flay.instance_variable_set(:@matches, lines)
       @results = flay.to_h
     end
 
     it "should find the total_score" do
-      expect(@results[:flay][:total_score]).to eq('284')
+      expect(@results[:flay][:total_score]).to eq("284")
     end
 
     it "should have 6 matches" do