reek 4.4.1 → 4.4.2

data/spec/reek/smells/instance_variable_assumption_spec.rb

@@ -17,7 +17,7 @@ RSpec.describe Reek::Smells::InstanceVariableAssumption do
                            context:    'Alfa',
                            message:    "assumes too much for instance variable '@charlie'",
                            source:     'string',
-                           assumption: :@charlie)
+                           assumption: '@charlie')
   end
 
   it 'does count all occurences' do
@@ -34,15 +34,12 @@ RSpec.describe Reek::Smells::InstanceVariableAssumption do
 
     EOS
 
-    expect(src).to reek_of(:InstanceVariableAssumption,
-                           lines: [1],
-                           assumption: :@charlie)
-    expect(src).to reek_of(:InstanceVariableAssumption,
-                           lines: [1],
-                           assumption: :@echo)
+    expect(src).
+      to reek_of(:InstanceVariableAssumption, lines: [1], assumption: '@charlie').
+      and reek_of(:InstanceVariableAssumption, lines: [1], assumption: '@echo')
   end
 
-  it 'should not report an empty class' do
+  it 'does not report an empty class' do
     src = <<-EOS
       class Alfa
       end
@@ -76,7 +73,7 @@ RSpec.describe Reek::Smells::InstanceVariableAssumption do
       end
     EOS
 
-    expect(src).to reek_of(:InstanceVariableAssumption, assumption: :@delta)
+    expect(src).to reek_of(:InstanceVariableAssumption, assumption: '@delta')
   end
 
   it 'reports inner class even if outer class initializes the variable' do

data/spec/reek/smells/irresponsible_module_spec.rb

@@ -25,12 +25,9 @@ RSpec.describe Reek::Smells::IrresponsibleModule do
       end
     EOS
 
-    expect(src).to reek_of(:IrresponsibleModule,
-                           lines:   [1],
-                           context: 'Alfa')
-    expect(src).to reek_of(:IrresponsibleModule,
-                           lines:   [4],
-                           context: 'Alfa::Charlie')
+    expect(src).
+      to reek_of(:IrresponsibleModule, lines: [1], context: 'Alfa').
+      and reek_of(:IrresponsibleModule, lines: [4], context: 'Alfa::Charlie')
   end
 
   %w(class module).each do |scope|

data/spec/reek/smells/long_parameter_list_spec.rb

@@ -29,16 +29,14 @@ RSpec.describe Reek::Smells::LongParameterList do
       end
     EOS
 
-    expect(src).to reek_of(:LongParameterList,
-                           lines:   [2],
-                           context: 'Alfa#bravo')
-    expect(src).to reek_of(:LongParameterList,
-                           lines:   [5],
-                           context: 'Alfa#golf')
+    expect(src).
+      to reek_of(:LongParameterList, lines: [2], context: 'Alfa#bravo').
+      and reek_of(:LongParameterList, lines: [5], context: 'Alfa#golf')
   end
 
   it 'reports nothing for 3 parameters' do
-    expect('def alfa(bravo, charlie, delta); end').not_to reek_of(:LongParameterList)
+    src = 'def alfa(bravo, charlie, delta); end'
+    expect(src).not_to reek_of(:LongParameterList)
   end
 
   it 'does not count an optional block' do

data/spec/reek/smells/long_yield_list_spec.rb

@@ -32,12 +32,9 @@ RSpec.describe Reek::Smells::LongYieldList do
       end
     EOS
 
-    expect(src).to reek_of(:LongYieldList,
-                           lines:   [3],
-                           context: 'Alfa#bravo')
-    expect(src).to reek_of(:LongYieldList,
-                           lines:   [7],
-                           context: 'Alfa#golf')
+    expect(src).
+      to reek_of(:LongYieldList, lines: [3], context: 'Alfa#bravo').
+      and reek_of(:LongYieldList, lines: [7], context: 'Alfa#golf')
   end
 
   it 'does not report yield with 3 parameters' do

data/spec/reek/smells/manual_dispatch_spec.rb

@@ -31,12 +31,9 @@ RSpec.describe Reek::Smells::ManualDispatch do
       end
     EOS
 
-    expect(src).to reek_of(:ManualDispatch,
-                           lines:   [3],
-                           context: 'Alfa#bravo')
-    expect(src).to reek_of(:ManualDispatch,
-                           lines:   [7],
-                           context: 'Alfa#delta')
+    expect(src).
+      to reek_of(:ManualDispatch, lines: [3], context: 'Alfa#bravo').
+      and reek_of(:ManualDispatch, lines: [7], context: 'Alfa#delta')
   end
 
   it 'reports manual dispatch smell when using #respond_to? on implicit self' do

data/spec/reek/smells/nested_iterators_spec.rb

@@ -34,8 +34,9 @@ RSpec.describe Reek::Smells::NestedIterators do
       end
     EOS
 
-    expect(src).to reek_of(:NestedIterators, lines: [3], depth: 2)
-    expect(src).to reek_of(:NestedIterators, lines: [8], depth: 3)
+    expect(src).
+      to reek_of(:NestedIterators, lines: [3], depth: 2).
+      and reek_of(:NestedIterators, lines: [8], depth: 3)
   end
 
   it 'reports no smells with no iterators' do
@@ -53,7 +54,7 @@ RSpec.describe Reek::Smells::NestedIterators do
     expect(src).not_to reek_of(:NestedIterators)
   end
 
-  it 'should not report nested iterators for Object#tap' do
+  it 'does not report nested iterators for Object#tap' do
     src = <<-EOS
       def alfa(bravo)
         bravo.tap do |charlie|
@@ -65,7 +66,7 @@ RSpec.describe Reek::Smells::NestedIterators do
     expect(src).not_to reek_of(:NestedIterators)
   end
 
-  it 'should not report method with successive iterators' do
+  it 'does not report method with successive iterators' do
     src = <<-EOS
       def alfa
         @bravo.each   { |charlie| charlie }
@@ -76,7 +77,7 @@ RSpec.describe Reek::Smells::NestedIterators do
     expect(src).not_to reek_of(:NestedIterators)
   end
 
-  it 'should not report method with chained iterators' do
+  it 'does not report method with chained iterators' do
     src = <<-EOS
       def alfa
         bravo.sort_by { |charlie| charlie }.each { |delta| delta }
@@ -123,8 +124,9 @@ RSpec.describe Reek::Smells::NestedIterators do
       end
     EOS
 
-    expect(src).not_to reek_of(:NestedIterators, depth: 2)
-    expect(src).to reek_of(:NestedIterators, depth: 3, lines: [4])
+    expect(src).
+      to not_reek_of(:NestedIterators, depth: 2).
+      and reek_of(:NestedIterators, depth: 3, lines: [4])
   end
 
   it 'reports all lines on which nested iterators occur' do
@@ -314,7 +316,7 @@ RSpec.describe Reek::Smells::NestedIterators do
       expect(src).to reek_of(:NestedIterators, depth: 2).with_config(config)
     end
 
-    it 'should report nested iterators with the ignored iterator between them' do
+    it 'reports nested iterators with the ignored iterator between them' do
       src = <<-EOS
         def alfa(bravo)
           bravo.each do |charlie|

data/spec/reek/smells/nil_check_spec.rb

@@ -30,7 +30,8 @@ RSpec.describe Reek::Smells::NilCheck do
   end
 
   it 'reports nothing when scope includes no nil checks' do
-    expect('def alfa; end').not_to reek_of(:NilCheck)
+    src = 'def alfa; end'
+    expect(src).not_to reek_of(:NilCheck)
   end
 
   it 'reports when scope uses == nil' do

data/spec/reek/smells/prima_donna_method_spec.rb

@@ -15,7 +15,7 @@ RSpec.describe Reek::Smells::PrimaDonnaMethod do
                            context: 'Alfa',
                            message: "has prima donna method 'bravo!'",
                            source:  'string',
-                           name:    :bravo!)
+                           name:    'bravo!')
   end
 
   it 'does count all occurences' do
@@ -29,15 +29,12 @@ RSpec.describe Reek::Smells::PrimaDonnaMethod do
       end
     EOS
 
-    expect(src).to reek_of(:PrimaDonnaMethod,
-                           lines: [1],
-                           name:  :bravo!)
-    expect(src).to reek_of(:PrimaDonnaMethod,
-                           lines: [1],
-                           name:  :charlie!)
+    expect(src).
+      to reek_of(:PrimaDonnaMethod, lines: [1], name: 'bravo!').
+      and reek_of(:PrimaDonnaMethod, lines: [1], name: 'charlie!')
   end
 
-  it 'should report nothing when method and bang counterpart exist' do
+  it 'reports nothing when method and bang counterpart exist' do
     src = <<-EOS
       class Alfa
         def bravo

data/spec/reek/smells/smell_configuration_spec.rb

@@ -27,7 +27,7 @@ RSpec.describe Reek::Smells::SmellConfiguration do
       expect(updated).to eq(base_config)
     end
 
-    it 'should override single values' do
+    it 'overrides single values' do
       updated = smell_config.merge('enabled' => false)
       expect(updated).to eq('accept'  => ['_'],
                             'enabled' => false,
@@ -35,7 +35,7 @@ RSpec.describe Reek::Smells::SmellConfiguration do
                             'reject'  => [/^.$/, /[0-9]$/, /[A-Z]/])
     end
 
-    it 'should override arrays of values' do
+    it 'overrides arrays of values' do
       updated = smell_config.merge('reject' => [/^.$/, /[3-9]$/])
       expect(updated).to eq('accept'  => ['_'],
                             'enabled' => true,
@@ -43,7 +43,7 @@ RSpec.describe Reek::Smells::SmellConfiguration do
                             'reject'  => [/^.$/, /[3-9]$/])
     end
 
-    it 'should override multiple values' do
+    it 'overrides multiple values' do
       updated = smell_config.merge('accept' => [/[A-Z]$/], 'enabled' => false)
       expect(updated).to eq('accept'  => [/[A-Z]$/],
                             'enabled' => false,

data/spec/reek/smells/smell_detector_spec.rb

@@ -33,4 +33,14 @@ RSpec.describe Reek::Smells::SmellDetector do
       end
     end
   end
+
+  describe '.valid_detector?' do
+    it 'returns true for a valid detector' do
+      expect(described_class.valid_detector?('DuplicateMethodCall')).to be true
+    end
+
+    it 'returns false for an invalid detector' do
+      expect(described_class.valid_detector?('Unknown')).to be false
+    end
+  end
 end

data/spec/reek/smells/smell_repository_spec.rb

@@ -6,16 +6,16 @@ RSpec.describe Reek::Smells::SmellRepository do
   describe '.smell_types' do
     let(:smell_types) { described_class.smell_types }
 
-    it 'should include existing smell_types' do
-      expect(smell_types).to include(Reek::Smells::IrresponsibleModule)
-      expect(smell_types).to include(Reek::Smells::TooManyStatements)
+    it 'includes existing smell_types' do
+      expect(smell_types).to include(Reek::Smells::IrresponsibleModule).
+        and include(Reek::Smells::TooManyStatements)
     end
 
-    it 'should exclude the smell detector base class' do
-      expect(smell_types).to_not include(Reek::Smells::SmellDetector)
+    it 'excludes the smell detector base class' do
+      expect(smell_types).not_to include(Reek::Smells::SmellDetector)
     end
 
-    it 'should return the smell types in alphabetic order' do
+    it 'returns the smell types in alphabetic order' do
       expect(smell_types).to eq(smell_types.sort_by(&:name))
     end
   end

data/spec/reek/smells/smell_warning_spec.rb

@@ -12,15 +12,17 @@ RSpec.describe Reek::Smells::SmellWarning do
       it 'hash differently' do
         expect(first.hash).not_to eq(second.hash)
       end
+
       it 'are not equal' do
         expect(first).not_to eq(second)
       end
+
       it 'sort correctly' do
         expect(first <=> second).to be < 0
       end
+
       it 'does not match using eql?' do
         expect(first).not_to eql(second)
-        expect(second).not_to eql(first)
       end
     end
 
@@ -96,52 +98,46 @@ RSpec.describe Reek::Smells::SmellWarning do
   end
 
   context '#yaml_hash' do
-    let(:class) { 'FeatureEnvy' }
     let(:context_name) { 'Module::Class#method/block' }
     let(:lines) { [24, 513] }
     let(:message) { 'test message' }
+    let(:detector) { Reek::Smells::FeatureEnvy.new }
+    let(:parameters) { { 'one' => 34, 'two' => 'second' } }
+    let(:smell_type) { 'FeatureEnvy' }
+    let(:source) { 'a/ruby/source/file.rb' }
+
+    let(:yaml) do
+      warning = described_class.new(detector, source: source,
+                                              context: context_name,
+                                              lines: lines,
+                                              message: message,
+                                              parameters: parameters)
+      warning.yaml_hash
+    end
 
-    shared_examples_for 'common fields' do
-      it 'includes the smell type' do
-        expect(yaml['smell_type']).to eq 'FeatureEnvy'
-      end
-      it 'includes the context' do
-        expect(yaml['context']).to eq context_name
-      end
-      it 'includes the message' do
-        expect(yaml['message']).to eq message
-      end
-      it 'includes the line numbers' do
-        expect(yaml['lines']).to match_array lines
-      end
+    it 'includes the smell type' do
+      expect(yaml['smell_type']).to eq 'FeatureEnvy'
     end
 
-    context 'with all details specified' do
-      let(:detector) { Reek::Smells::FeatureEnvy.new }
-      let(:parameters) { { 'one' => 34, 'two' => 'second' } }
-      let(:smell_type) { 'FeatureEnvy' }
-      let(:source) { 'a/ruby/source/file.rb' }
-      let(:yaml) do
-        warning = Reek::Smells::SmellWarning.new(detector, source: source,
-                                                           context: context_name,
-                                                           lines: lines,
-                                                           message: message,
-                                                           parameters: parameters)
-        warning.yaml_hash
-      end
+    it 'includes the context' do
+      expect(yaml['context']).to eq context_name
+    end
 
-      it_should_behave_like 'common fields'
+    it 'includes the message' do
+      expect(yaml['message']).to eq message
+    end
 
-      it 'includes the smell type' do
-        expect(yaml['smell_type']).to eq smell_type
-      end
-      it 'includes the source' do
-        expect(yaml['source']).to eq source
-      end
-      it 'includes the parameters' do
-        parameters.each do |key, value|
-          expect(yaml[key]).to eq value
-        end
+    it 'includes the line numbers' do
+      expect(yaml['lines']).to match_array lines
+    end
+
+    it 'includes the source' do
+      expect(yaml['source']).to eq source
+    end
+
+    it 'includes the parameters' do
+      parameters.each do |key, value|
+        expect(yaml[key]).to eq value
       end
     end
   end

data/spec/reek/smells/subclassed_from_core_class_spec.rb

@@ -33,7 +33,7 @@ RSpec.describe Reek::Smells::SubclassedFromCoreClass do
       end
     EOS
 
-    expect(src).to_not reek_of(:SubclassedFromCoreClass)
+    expect(src).not_to reek_of(:SubclassedFromCoreClass)
   end
 
   it 'does not report on coincidental core class names in other namespaces' do
@@ -42,7 +42,7 @@ RSpec.describe Reek::Smells::SubclassedFromCoreClass do
       end
     EOS
 
-    expect(src).to_not reek_of(:SubclassedFromCoreClass)
+    expect(src).not_to reek_of(:SubclassedFromCoreClass)
   end
 
   it 'reports if we inherit from a core class using Class#new' do
@@ -67,16 +67,16 @@ RSpec.describe Reek::Smells::SubclassedFromCoreClass do
 
   it 'does not report class which inherits from allowed class via Class.new' do
     src = 'Alfa = Class.new(StandardError)'
-    expect(src).to_not reek_of(:SubclassedFromCoreClass)
+    expect(src).not_to reek_of(:SubclassedFromCoreClass)
   end
 
   it 'does not report classes created with Struct.new' do
     src = "Alfa = Struct.new('Array')"
-    expect(src).to_not reek_of(:SubclassedFromCoreClass)
+    expect(src).not_to reek_of(:SubclassedFromCoreClass)
   end
 
   it 'does not report class created by another class constructor taking a core class as argument' do
     src = 'Charlie = Delta.new(Array)'
-    expect(src).to_not reek_of(:SubclassedFromCoreClass)
+    expect(src).not_to reek_of(:SubclassedFromCoreClass)
   end
 end

data/spec/reek/smells/too_many_constants_spec.rb

@@ -21,7 +21,7 @@ RSpec.describe Reek::Smells::TooManyConstants do
                            count:   3).with_config(config)
   end
 
-  it 'should not report for non-excessive constants' do
+  it 'does not report for non-excessive constants' do
     src = <<-EOS
       class Alfa
         Bravo = Charlie = 1
@@ -31,7 +31,7 @@ RSpec.describe Reek::Smells::TooManyConstants do
     expect(src).not_to reek_of(:TooManyConstants).with_config(config)
   end
 
-  it 'should not report when increasing default' do
+  it 'does not report when increasing default' do
     src = <<-EOS
       # :reek:TooManyConstants: { max_constants: 3 }
       class Alfa
@@ -42,7 +42,7 @@ RSpec.describe Reek::Smells::TooManyConstants do
     expect(src).not_to reek_of(:TooManyConstants).with_config(config)
   end
 
-  it 'should not report when disabled' do
+  it 'does not report when disabled' do
     src = <<-EOS
       # :reek:TooManyConstants: { enabled: false }
       class Alfa
@@ -53,7 +53,7 @@ RSpec.describe Reek::Smells::TooManyConstants do
     expect(src).not_to reek_of(:TooManyConstants).with_config(config)
   end
 
-  it 'should not account class definition' do
+  it 'does not account class definition' do
     src = <<-EOS
       class Alfa
         Bravo = Charlie = 1
@@ -64,7 +64,7 @@ RSpec.describe Reek::Smells::TooManyConstants do
     expect(src).not_to reek_of(:TooManyConstants).with_config(config)
   end
 
-  it 'should not account struct definition' do
+  it 'does not account struct definition' do
     src = <<-EOS
       class Alfa
         Bravo = Charlie = 1
@@ -72,10 +72,10 @@ RSpec.describe Reek::Smells::TooManyConstants do
       end
     EOS
 
-    expect(src).to_not reek_of(:TooManyConstants).with_config(config)
+    expect(src).not_to reek_of(:TooManyConstants).with_config(config)
   end
 
-  it 'should count each constant only once' do
+  it 'counts each constant only once' do
     src = <<-EOS
       class Alfa
         Bravo = Charlie = 1
@@ -93,7 +93,7 @@ RSpec.describe Reek::Smells::TooManyConstants do
     expect(src).not_to reek_of(:TooManyConstants).with_config(config)
   end
 
-  it 'should not report outer module when inner module suppressed' do
+  it 'does not report outer module when inner module suppressed' do
     src = <<-EOS
       module Alfa
         # ignore :reek:TooManyConstants:
@@ -106,7 +106,7 @@ RSpec.describe Reek::Smells::TooManyConstants do
     expect(src).not_to reek_of(:TooManyConstants).with_config(config)
   end
 
-  it 'should count each constant only once for each namespace' do
+  it 'counts each constant only once for each namespace' do
     src = <<-EOS
       module Alfa
         Bravo = Charlie = 1
@@ -120,7 +120,7 @@ RSpec.describe Reek::Smells::TooManyConstants do
     expect(src).not_to reek_of(:TooManyConstants).with_config(config)
   end
 
-  it 'should report for excessive constants inside a module' do
+  it 'reports for excessive constants inside a module' do
     src = <<-EOS
       module Alfa
         Bravo = Charlie = Delta = 1