reek 4.4.1 → 4.4.2

data/spec/reek/report/text_report_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe Reek::Report::TextReport do
       heading_formatter: Reek::Report::HeadingFormatter::Quiet
     }
   end
-  let(:instance) { Reek::Report::TextReport.new report_options }
+  let(:instance) { described_class.new report_options }
 
   context 'with a single empty source' do
     before do
@@ -21,7 +21,7 @@ RSpec.describe Reek::Report::TextReport do
     end
 
     it 'has an empty quiet_report' do
-      expect { instance.show }.to_not output.to_stdout
+      expect { instance.show }.not_to output.to_stdout
     end
   end
 
@@ -32,7 +32,7 @@ RSpec.describe Reek::Report::TextReport do
     end
 
     context 'with colors disabled' do
-      before :each do
+      before do
         Rainbow.enabled = false
       end
 
@@ -42,7 +42,7 @@ RSpec.describe Reek::Report::TextReport do
     end
 
     context 'with colors enabled' do
-      before :each do
+      before do
         Rainbow.enabled = true
       end
 
@@ -67,9 +67,13 @@ RSpec.describe Reek::Report::TextReport do
         expect { instance.show }.to output(/string -- 2 warnings/).to_stdout
       end
 
-      it 'should mention every smell name' do
-        expect { instance.show }.to output(/UncommunicativeParameterName/).to_stdout
-        expect { instance.show }.to output(/UtilityFunction/).to_stdout
+      it 'mentions every smell name' do
+        matcher = match(/UncommunicativeParameterName/).and match(/UtilityFunction/)
+        expect { instance.show }.to output(matcher).to_stdout
+      end
+
+      it 'shows total number of warnings' do
+        expect { instance.show }.to output(/4 total warnings\n\Z/).to_stdout
       end
     end
 
@@ -83,7 +87,7 @@ RSpec.describe Reek::Report::TextReport do
           to output(/\A\e\[36mstring -- \e\[0m\e\[33m2 warning\e\[0m\e\[33ms\e\[0m/).to_stdout
       end
 
-      it 'has a footer in color' do
+      it 'shows total number of warnings in color' do
         expect { instance.show }.
           to output(/\e\[31m4 total warnings\n\e\[0m\Z/).to_stdout
       end

data/spec/reek/report/xml_report_spec.rb

@@ -3,7 +3,7 @@ require_lib 'reek/examiner'
 require_lib 'reek/report/report'
 
 RSpec.describe Reek::Report::XMLReport do
-  let(:xml_report) { Reek::Report::XMLReport.new }
+  let(:xml_report) { described_class.new }
 
   context 'empty source' do
     it 'prints empty checkstyle XML' do

data/spec/reek/report/yaml_report_spec.rb

@@ -8,7 +8,7 @@ require 'stringio'
 
 RSpec.describe Reek::Report::YAMLReport do
   let(:options) { {} }
-  let(:instance) { Reek::Report::YAMLReport.new(options) }
+  let(:instance) { described_class.new(options) }
   let(:examiner) { Reek::Examiner.new(source) }
 
   before do

data/spec/reek/report_spec.rb

@@ -4,25 +4,25 @@ require_lib 'reek/report'
 RSpec.describe Reek::Report do
   describe '.report_class' do
     it 'returns the correct class' do
-      expect(Reek::Report.report_class(:text)).to eq Reek::Report::TextReport
+      expect(described_class.report_class(:text)).to eq Reek::Report::TextReport
     end
   end
 
   describe '.location_formatter' do
     it 'returns the correct class' do
-      expect(Reek::Report.location_formatter(:plain)).to eq Reek::Report::BlankLocationFormatter
+      expect(described_class.location_formatter(:plain)).to eq Reek::Report::BlankLocationFormatter
     end
   end
 
   describe '.heading_formatter' do
     it 'returns the correct class' do
-      expect(Reek::Report.heading_formatter(:quiet)).to eq Reek::Report::HeadingFormatter::Quiet
+      expect(described_class.heading_formatter(:quiet)).to eq Reek::Report::HeadingFormatter::Quiet
     end
   end
 
   describe '.warning_formatter_class' do
     it 'returns the correct class' do
-      expect(Reek::Report.warning_formatter_class(:simple)).to eq Reek::Report::SimpleWarningFormatter
+      expect(described_class.warning_formatter_class(:simple)).to eq Reek::Report::SimpleWarningFormatter
     end
   end
 end

data/spec/reek/smells/attribute_spec.rb

@@ -23,12 +23,9 @@ RSpec.describe Reek::Smells::Attribute do
       end
     EOS
 
-    expect(src).to reek_of(:Attribute,
-                           lines:   [2],
-                           context: 'Alfa#bravo')
-    expect(src).to reek_of(:Attribute,
-                           lines:   [3],
-                           context: 'Alfa#charlie')
+    expect(src).
+      to reek_of(:Attribute, lines: [2], context: 'Alfa#bravo').
+      and reek_of(:Attribute, lines: [3], context: 'Alfa#charlie')
   end
 
   it 'records nothing with no attributes' do
@@ -37,7 +34,7 @@ RSpec.describe Reek::Smells::Attribute do
       end
     EOS
 
-    expect(src).to_not reek_of(:Attribute)
+    expect(src).not_to reek_of(:Attribute)
   end
 
   context 'with attributes' do
@@ -49,7 +46,7 @@ RSpec.describe Reek::Smells::Attribute do
         end
       EOS
 
-      expect(src).to_not reek_of(:Attribute)
+      expect(src).not_to reek_of(:Attribute)
     end
 
     it 'records writer attribute' do
@@ -115,7 +112,7 @@ RSpec.describe Reek::Smells::Attribute do
         end
       EOS
 
-      expect(src).to_not reek_of(:Attribute)
+      expect(src).not_to reek_of(:Attribute)
     end
 
     it "doesn't record private attributes" do
@@ -130,7 +127,7 @@ RSpec.describe Reek::Smells::Attribute do
         end
       EOS
 
-      expect(src).to_not reek_of(:Attribute)
+      expect(src).not_to reek_of(:Attribute)
     end
 
     it 'records attr_writer defined in public section' do

data/spec/reek/smells/boolean_parameter_spec.rb

@@ -22,14 +22,9 @@ RSpec.describe Reek::Smells::BooleanParameter do
       end
     EOS
 
-    expect(src).to reek_of(:BooleanParameter,
-                           lines:   [1],
-                           context: 'alfa',
-                           parameter: 'bravo')
-    expect(src).to reek_of(:BooleanParameter,
-                           lines:   [1],
-                           context: 'alfa',
-                           parameter: 'charlie')
+    expect(src).
+      to reek_of(:BooleanParameter, lines: [1], context: 'alfa', parameter: 'bravo').
+      and reek_of(:BooleanParameter, lines: [1], context: 'alfa', parameter: 'charlie')
   end
 
   context 'in a method' do
@@ -41,17 +36,17 @@ RSpec.describe Reek::Smells::BooleanParameter do
     it 'reports two parameters defaulted to booleans in a mixed parameter list' do
       src = 'def alfa(bravo, charlie = true, delta = false, &echo) end'
 
-      expect(src).to reek_of(:BooleanParameter, parameter: 'charlie')
-      expect(src).to reek_of(:BooleanParameter, parameter: 'delta')
-
-      expect(src).not_to reek_of(:BooleanParameter, parameter: 'bravo')
-      expect(src).not_to reek_of(:BooleanParameter, parameter: 'echo')
+      expect(src).to reek_of(:BooleanParameter, parameter: 'charlie').
+        and reek_of(:BooleanParameter, parameter: 'delta').
+        and not_reek_of(:BooleanParameter, parameter: 'bravo').
+        and not_reek_of(:BooleanParameter, parameter: 'echo')
     end
 
     it 'reports keyword parameters defaulted to booleans' do
       src = 'def alfa(bravo: true, charlie: false) end'
-      expect(src).to reek_of(:BooleanParameter, parameter: 'bravo')
-      expect(src).to reek_of(:BooleanParameter, parameter: 'charlie')
+      expect(src).
+        to reek_of(:BooleanParameter, parameter: 'bravo').
+        and reek_of(:BooleanParameter, parameter: 'charlie')
     end
 
     it 'does not report regular parameters' do
@@ -89,11 +84,10 @@ RSpec.describe Reek::Smells::BooleanParameter do
     it 'reports two parameters defaulted to booleans' do
       src = 'def self.alfa(bravo, charlie = true, delta = false, &echo) end'
 
-      expect(src).to reek_of(:BooleanParameter, parameter: 'charlie')
-      expect(src).to reek_of(:BooleanParameter, parameter: 'delta')
-
-      expect(src).not_to reek_of(:BooleanParameter, parameter: 'bravo')
-      expect(src).not_to reek_of(:BooleanParameter, parameter: 'echo')
+      expect(src).to reek_of(:BooleanParameter, parameter: 'charlie').
+        and reek_of(:BooleanParameter, parameter: 'delta').
+        and not_reek_of(:BooleanParameter, parameter: 'bravo').
+        and not_reek_of(:BooleanParameter, parameter: 'echo')
     end
   end
 end

data/spec/reek/smells/class_variable_spec.rb

@@ -25,8 +25,9 @@ RSpec.describe Reek::Smells::ClassVariable do
       end
     EOS
 
-    expect(src).to reek_of(:ClassVariable, name: '@@bravo')
-    expect(src).to reek_of(:ClassVariable, name: '@@charlie')
+    expect(src).
+      to reek_of(:ClassVariable, name: '@@bravo').
+      and reek_of(:ClassVariable, name: '@@charlie')
   end
 
   it 'does not report class instance variables' do
@@ -36,7 +37,7 @@ RSpec.describe Reek::Smells::ClassVariable do
       end
     EOS
 
-    expect(src).to_not reek_of(:ClassVariable)
+    expect(src).not_to reek_of(:ClassVariable)
   end
 
   context 'with no class variables' do
@@ -47,7 +48,7 @@ RSpec.describe Reek::Smells::ClassVariable do
         end
       EOS
 
-      expect(src).to_not reek_of(:ClassVariable)
+      expect(src).not_to reek_of(:ClassVariable)
     end
 
     it 'records nothing in the module' do
@@ -57,7 +58,7 @@ RSpec.describe Reek::Smells::ClassVariable do
         end
       EOS
 
-      expect(src).to_not reek_of(:ClassVariable)
+      expect(src).not_to reek_of(:ClassVariable)
     end
   end
 

data/spec/reek/smells/control_parameter_spec.rb

@@ -25,8 +25,9 @@ RSpec.describe Reek::Smells::ControlParameter do
       end
     EOS
 
-    expect(src).to reek_of(:ControlParameter, lines: [2], argument: 'bravo')
-    expect(src).to reek_of(:ControlParameter, lines: [3], argument: 'charlie')
+    expect(src).
+      to reek_of(:ControlParameter, lines: [2], argument: 'bravo').
+      and reek_of(:ControlParameter, lines: [3], argument: 'charlie')
   end
 
   context 'parameter not used to determine code path' do

data/spec/reek/smells/data_clump_spec.rb

@@ -33,12 +33,9 @@ RSpec.describe Reek::Smells::DataClump do
       end
     EOS
 
-    expect(src).to reek_of(:DataClump,
-                           lines:      [2, 3, 4],
-                           parameters: ['echo', 'foxtrot'])
-    expect(src).to reek_of(:DataClump,
-                           lines:      [6, 7, 8],
-                           parameters: ['juliett', 'kilo'])
+    expect(src).
+      to reek_of(:DataClump, lines: [2, 3, 4], parameters: ['echo', 'foxtrot']).
+      and reek_of(:DataClump, lines: [6, 7, 8], parameters: ['juliett', 'kilo'])
   end
 
   %w(class module).each do |scope|

data/spec/reek/smells/duplicate_method_call_spec.rb

@@ -36,14 +36,9 @@ RSpec.describe Reek::Smells::DuplicateMethodCall do
       end
     EOS
 
-    expect(src).to reek_of(:DuplicateMethodCall,
-                           lines: [3, 4],
-                           name:  'charlie.delta',
-                           count: 2)
-    expect(src).to reek_of(:DuplicateMethodCall,
-                           lines: [8, 9],
-                           name:  'foxtrot.golf',
-                           count: 2)
+    expect(src).
+      to reek_of(:DuplicateMethodCall, lines: [3, 4], name:  'charlie.delta', count: 2).
+      and reek_of(:DuplicateMethodCall, lines: [8, 9], name:  'foxtrot.golf', count: 2)
   end
 
   context 'with repeated method calls' do
@@ -57,13 +52,14 @@ RSpec.describe Reek::Smells::DuplicateMethodCall do
       expect(src).to reek_of(:DuplicateMethodCall, name: '@bravo.charlie(2, 3)')
     end
 
-    it 'should report nested calls' do
+    it 'reports nested calls' do
       src = 'def alfa; @bravo.charlie.delta + @bravo.charlie.delta; end'
-      expect(src).to reek_of(:DuplicateMethodCall, name: '@bravo.charlie')
-      expect(src).to reek_of(:DuplicateMethodCall, name: '@bravo.charlie.delta')
+      expect(src).
+        to reek_of(:DuplicateMethodCall, name: '@bravo.charlie').
+        and reek_of(:DuplicateMethodCall, name: '@bravo.charlie.delta')
     end
 
-    it 'should ignore calls to new' do
+    it 'ignores calls to new' do
       src = 'def alfa; @bravo.new + @bravo.new; end'
       expect(src).not_to reek_of(:DuplicateMethodCall)
     end
@@ -155,12 +151,12 @@ RSpec.describe Reek::Smells::DuplicateMethodCall do
   end
 
   context 'non-repeated method calls' do
-    it 'should not report similar calls' do
+    it 'does not report similar calls' do
       src = 'def alfa(bravo) bravo.charlie == self.charlie end'
       expect(src).not_to reek_of(:DuplicateMethodCall)
     end
 
-    it 'should respect call parameters' do
+    it 'respects call parameters' do
       src = 'def alfa; @bravo.charlie(3) + @bravo.charlie(2) end'
       expect(src).not_to reek_of(:DuplicateMethodCall)
     end

data/spec/reek/smells/feature_envy_spec.rb

@@ -32,62 +32,69 @@ RSpec.describe Reek::Smells::FeatureEnvy do
       end
     EOS
 
-    expect(src).to reek_of(:FeatureEnvy,
-                           lines: [3, 3],
-                           name:  'charlie')
-    expect(src).to reek_of(:FeatureEnvy,
-                           lines: [7, 7],
-                           name:  'hotel')
+    expect(src).
+      to reek_of(:FeatureEnvy, lines: [3, 3], name:  'charlie').
+      and reek_of(:FeatureEnvy, lines: [7, 7], name:  'hotel')
   end
 
   it 'does not report use of self' do
-    expect('def alfa; self.to_s + self.to_i; end').not_to reek_of(:FeatureEnvy)
+    src = 'def alfa; self.to_s + self.to_i; end'
+    expect(src).not_to reek_of(:FeatureEnvy)
   end
 
   it 'does not report vcall with no argument' do
-    expect('def alfa; bravo; end').not_to reek_of(:FeatureEnvy)
+    src = 'def alfa; bravo; end'
+    expect(src).not_to reek_of(:FeatureEnvy)
   end
 
   it 'does not report single use' do
-    expect('def alfa(bravo); bravo.charlie(@delta); end').not_to reek_of(:FeatureEnvy)
+    src = 'def alfa(bravo); bravo.charlie(@delta); end'
+    expect(src).not_to reek_of(:FeatureEnvy)
   end
 
   it 'does not report return value' do
-    expect('def alfa(bravo); bravo.charlie(@delta); bravo; end').not_to reek_of(:FeatureEnvy)
+    src = 'def alfa(bravo); bravo.charlie(@delta); bravo; end'
+    expect(src).not_to reek_of(:FeatureEnvy)
   end
 
   it 'does ignore global variables' do
-    expect('def alfa; $bravo.to_a; $bravo[@charlie]; end').not_to reek_of(:FeatureEnvy)
+    src = 'def alfa; $bravo.to_a; $bravo[@charlie]; end'
+    expect(src).not_to reek_of(:FeatureEnvy)
   end
 
   it 'does not report class methods' do
-    expect('def alfa; self.class.bravo(self); end').not_to reek_of(:FeatureEnvy)
+    src = 'def alfa; self.class.bravo(self); end'
+    expect(src).not_to reek_of(:FeatureEnvy)
   end
 
   it 'does not report single use of an ivar' do
-    expect('def alfa; @bravo.to_a; end').not_to reek_of(:FeatureEnvy)
+    src = 'def alfa; @bravo.to_a; end'
+    expect(src).not_to reek_of(:FeatureEnvy)
   end
 
   it 'does not report returning an ivar' do
-    expect('def alfa; @bravo.to_a; @bravo; end').not_to reek_of(:FeatureEnvy)
+    src = 'def alfa; @bravo.to_a; @bravo; end'
+    expect(src).not_to reek_of(:FeatureEnvy)
   end
 
   it 'does not report ivar usage in a parameter' do
-    expect('def alfa; @bravo.charlie + delta(@bravo) - echo(@bravo) end').
-      not_to reek_of(:FeatureEnvy)
+    src = 'def alfa; @bravo.charlie + delta(@bravo) - echo(@bravo) end'
+    expect(src).not_to reek_of(:FeatureEnvy)
   end
 
   it 'does not report single use of an lvar' do
-    expect('def alfa; bravo = @charlie; bravo.to_a; end').not_to reek_of(:FeatureEnvy)
+    src = 'def alfa; bravo = @charlie; bravo.to_a; end'
+    expect(src).not_to reek_of(:FeatureEnvy)
   end
 
   it 'does not report returning an lvar' do
-    expect('def alfa; bravo = @charlie; bravo.to_a; lv end').not_to reek_of(:FeatureEnvy)
+    src = 'def alfa; bravo = @charlie; bravo.to_a; lv end'
+    expect(src).not_to reek_of(:FeatureEnvy)
   end
 
   it 'ignores lvar usage in a parameter' do
-    expect('def alfa; bravo = @item; bravo.charlie + delta(bravo) - echo(bravo); end').
-      not_to reek_of(:FeatureEnvy)
+    src = 'def alfa; bravo = @item; bravo.charlie + delta(bravo) - echo(bravo); end'
+    expect(src).not_to reek_of(:FeatureEnvy)
   end
 
   it 'ignores multiple ivars' do
@@ -115,11 +122,12 @@ RSpec.describe Reek::Smells::FeatureEnvy do
       end
       EOS
 
-    expect(src).to reek_of(:FeatureEnvy, name: 'delta')
-    expect(src).not_to reek_of(:FeatureEnvy, name: 'bravo')
+    expect(src).
+      to reek_of(:FeatureEnvy, name: 'delta').
+      and not_reek_of(:FeatureEnvy, name: 'bravo')
   end
 
-  it 'should report multiple affinities' do
+  it 'reports multiple affinities' do
     src = <<-EOS
       def alfa
         bravo = @charlie
@@ -129,8 +137,9 @@ RSpec.describe Reek::Smells::FeatureEnvy do
       end
       EOS
 
-    expect(src).to reek_of(:FeatureEnvy, name: 'delta')
-    expect(src).to reek_of(:FeatureEnvy, name: 'bravo')
+    expect(src).
+      to reek_of(:FeatureEnvy, name: 'delta').
+      and reek_of(:FeatureEnvy, name: 'bravo')
   end
 
   it 'is not be fooled by duplication' do