reek 4.8.2 → 5.0.0

data/spec/reek/report/xml_report_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe Reek::Report::XMLReport do
   context 'with a source with violations' do
     it 'prints non-empty checkstyle XML' do
       xml_report.add_examiner Reek::Examiner.new(SMELLY_FILE)
-      xml = SAMPLES_PATH.join('checkstyle.xml').read
+      xml = SAMPLES_DIR.join('checkstyle.xml').read
       xml = xml.gsub(SMELLY_FILE.to_s, SMELLY_FILE.expand_path.to_s)
       expect { xml_report.show }.to output(xml).to_stdout
     end

data/spec/reek/report/yaml_report_spec.rb

@@ -1,7 +1,6 @@
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
 require_lib 'reek/report/yaml_report'
-require_lib 'reek/report/formatter'
 
 require 'yaml'
 require 'stringio'
@@ -36,49 +35,21 @@ RSpec.describe Reek::Report::YAMLReport do
         - context:        "simple"
           lines:
           - 1
-          message:        "has the parameter name 'a'"
-          smell_type:     "UncommunicativeParameterName"
-          source:         "string"
-          name:           "a"
+          message:            "has the parameter name 'a'"
+          smell_type:         "UncommunicativeParameterName"
+          source:             "string"
+          name:               "a"
+          documentation_link: "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Uncommunicative-Parameter-Name.md"
         - context:        "simple"
           lines:
           - 1
-          message:        "doesn't depend on instance state (maybe move it to another class?)"
-          smell_type:     "UtilityFunction"
-          source:         "string"
+          message:            "doesn't depend on instance state (maybe move it to another class?)"
+          smell_type:         "UtilityFunction"
+          source:             "string"
+          documentation_link: "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Utility-Function.md"
       EOS
 
       expect(result).to eq expected
     end
-    context 'with link formatter' do
-      let(:options) { { warning_formatter: Reek::Report::Formatter::WikiLinkWarningFormatter.new } }
-
-      it 'prints documentation links' do
-        out = StringIO.new
-        instance.show(out)
-        out.rewind
-        result = YAML.safe_load(out.read)
-        expected = YAML.safe_load <<-EOS.strip_heredoc
-          ---
-          - context:        "simple"
-            lines:
-            - 1
-            message:        "has the parameter name 'a'"
-            smell_type:     "UncommunicativeParameterName"
-            source:         "string"
-            name:           "a"
-            wiki_link:      "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Uncommunicative-Parameter-Name.md"
-          - context:        "simple"
-            lines:
-            - 1
-            message:        "doesn't depend on instance state (maybe move it to another class?)"
-            smell_type:     "UtilityFunction"
-            source:         "string"
-            wiki_link:      "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Utility-Function.md"
-        EOS
-
-        expect(result).to eq expected
-      end
-    end
   end
 end

data/spec/reek/report_spec.rb

@@ -10,19 +10,19 @@ RSpec.describe Reek::Report do
 
   describe '.location_formatter' do
     it 'returns the correct class' do
-      expect(described_class.location_formatter(:plain)).to eq Reek::Report::Formatter::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(described_class.heading_formatter(:quiet)).to eq Reek::Report::Formatter::QuietHeadingFormatter
+      expect(described_class.heading_formatter(:quiet)).to eq Reek::Report::QuietHeadingFormatter
     end
   end
 
   describe '.warning_formatter_class' do
     it 'returns the correct class' do
-      expect(described_class.warning_formatter_class(:simple)).to eq Reek::Report::Formatter::SimpleWarningFormatter
+      expect(described_class.warning_formatter_class(:simple)).to eq Reek::Report::SimpleWarningFormatter
     end
   end
 end

data/spec/reek/smell_detectors/feature_envy_spec.rb

@@ -130,7 +130,7 @@ RSpec.describe Reek::SmellDetectors::FeatureEnvy do
         delta += bravo.foxtrot
         delta *= 1.15
       end
-      EOS
+    EOS
 
     expect(src).
       to reek_of(:FeatureEnvy, name: 'delta').
@@ -145,7 +145,7 @@ RSpec.describe Reek::SmellDetectors::FeatureEnvy do
         delta += bravo.echo
         delta += bravo.foxtrot
       end
-      EOS
+    EOS
 
     expect(src).
       to reek_of(:FeatureEnvy, name: 'delta').

data/spec/reek/smell_detectors/{prima_donna_method_spec.rb → missing_safe_method_spec.rb}

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_lib 'reek/smell_detectors/prima_donna_method'
+require_lib 'reek/smell_detectors/missing_safe_method'
 
-RSpec.describe Reek::SmellDetectors::PrimaDonnaMethod do
+RSpec.describe Reek::SmellDetectors::MissingSafeMethod do
   it 'reports the right values' do
     src = <<-EOS
       class Alfa
@@ -10,10 +10,10 @@ RSpec.describe Reek::SmellDetectors::PrimaDonnaMethod do
       end
     EOS
 
-    expect(src).to reek_of(:PrimaDonnaMethod,
+    expect(src).to reek_of(:MissingSafeMethod,
                            lines:   [2],
                            context: 'Alfa',
-                           message: "has prima donna method 'bravo!'",
+                           message: "has missing safe method 'bravo!'",
                            source:  'string',
                            name:    'bravo!')
   end
@@ -30,8 +30,8 @@ RSpec.describe Reek::SmellDetectors::PrimaDonnaMethod do
     EOS
 
     expect(src).
-      to reek_of(:PrimaDonnaMethod, lines: [2], name: 'bravo!').
-      and reek_of(:PrimaDonnaMethod, lines: [5], name: 'charlie!')
+      to reek_of(:MissingSafeMethod, lines: [2], name: 'bravo!').
+      and reek_of(:MissingSafeMethod, lines: [5], name: 'charlie!')
   end
 
   it 'reports nothing when method and bang counterpart exist' do
@@ -45,18 +45,18 @@ RSpec.describe Reek::SmellDetectors::PrimaDonnaMethod do
       end
     EOS
 
-    expect(src).not_to reek_of(:PrimaDonnaMethod)
+    expect(src).not_to reek_of(:MissingSafeMethod)
   end
 
   it 'does not report methods we excluded via comment' do
     source = <<-EOF
-      # :reek:PrimaDonnaMethod: { exclude: [ bravo! ] }
+      # :reek:MissingSafeMethod: { exclude: [ bravo! ] }
       class Alfa
         def bravo!
         end
       end
     EOF
 
-    expect(source).not_to reek_of(:PrimaDonnaMethod)
+    expect(source).not_to reek_of(:MissingSafeMethod)
   end
 end

data/spec/reek/smell_detectors/too_many_constants_spec.rb

@@ -33,7 +33,7 @@ RSpec.describe Reek::SmellDetectors::TooManyConstants do
 
   it 'does not report when increasing default' do
     src = <<-EOS
-      # :reek:TooManyConstants: { max_constants: 3 }
+      # :reek:TooManyConstants { max_constants: 3 }
       class Alfa
         Bravo = Charlie = Delta = 1
       end
@@ -44,7 +44,7 @@ RSpec.describe Reek::SmellDetectors::TooManyConstants do
 
   it 'does not report when disabled' do
     src = <<-EOS
-      # :reek:TooManyConstants: { enabled: false }
+      # :reek:TooManyConstants { enabled: false }
       class Alfa
         Bravo = Charlie = Delta = 1
       end
@@ -96,7 +96,7 @@ RSpec.describe Reek::SmellDetectors::TooManyConstants do
   it 'does not report outer module when inner module suppressed' do
     src = <<-EOS
       module Alfa
-        # ignore :reek:TooManyConstants:
+        # ignore :reek:TooManyConstants
         module Bravo
           Charlie = Delta = Echo = 1
         end

data/spec/reek/smell_detectors/too_many_instance_variables_spec.rb

@@ -37,7 +37,7 @@ RSpec.describe Reek::SmellDetectors::TooManyInstanceVariables do
 
   it 'has a configurable maximum' do
     src = <<-EOS
-      # :reek:TooManyInstanceVariables: { max_instance_variables: 3 }
+      # :reek:TooManyInstanceVariables { max_instance_variables: 3 }
       class Alfa
         def bravo
           @charlie = @delta = @echo = 1

data/spec/reek/smell_detectors/uncommunicative_method_name_spec.rb

@@ -41,18 +41,18 @@ RSpec.describe Reek::SmellDetectors::UncommunicativeMethodName do
   describe '`accept` patterns' do
     let(:source) { 'def x; end' }
 
-    it 'make smelly names pass via regex / strings given by list / literal' do
-      [[/x/], /x/, ['x'], 'x'].each do |pattern|
-        expect(source).not_to reek_of(:UncommunicativeMethodName).with_config('accept' => pattern)
-      end
+    it 'make smelly names pass' do
+      pattern = /x/
+      expect(source).not_to reek_of(:UncommunicativeMethodName).with_config('accept' => pattern)
     end
   end
 
   describe '`reject` patterns' do
     let(:source) { 'def alfa; end' }
 
-    it 'reject smelly names via regex / strings given by list / literal' do
-      [[/alfa/], /alfa/, ['alfa'], 'alfa'].each do |pattern|
+    it 'reject smelly names' do
+      patterns = [/alf/, /lfa/]
+      patterns.each do |pattern|
         expect(source).to reek_of(:UncommunicativeMethodName).with_config('reject' => pattern)
       end
     end

data/spec/reek/smell_detectors/uncommunicative_module_name_spec.rb

@@ -39,8 +39,9 @@ RSpec.describe Reek::SmellDetectors::UncommunicativeModuleName do
   describe '`accept` patterns' do
     let(:source) { 'class Alfa1; end' }
 
-    it 'makes smelly names pass via regex / strings given by list / literal' do
-      [[/lfa/], /lfa/, ['lfa'], 'lfa'].each do |pattern|
+    it 'make smelly names pass ' do
+      patterns = [/lfa1/, /Alfa1/]
+      patterns.each do |pattern|
         expect(source).not_to reek_of(:UncommunicativeModuleName).with_config('accept' => pattern)
       end
     end
@@ -49,8 +50,9 @@ RSpec.describe Reek::SmellDetectors::UncommunicativeModuleName do
   describe '`reject` patterns' do
     let(:source) { 'class Alfa; end' }
 
-    it 'rejects smelly names via regex / strings given by list / literal' do
-      [[/Alfa/], /Alfa/, ['Alfa'], 'Alfa'].each do |pattern|
+    it 'reject smelly names' do
+      patterns = [/lfa/, /Alf/]
+      patterns.each do |pattern|
         expect(source).to reek_of(:UncommunicativeModuleName).with_config('reject' => pattern)
       end
     end

data/spec/reek/smell_detectors/uncommunicative_parameter_name_spec.rb

@@ -107,8 +107,9 @@ RSpec.describe Reek::SmellDetectors::UncommunicativeParameterName do
   describe '`accept` patterns' do
     let(:source) { 'def alfa(bar2); charlie(bar2); end' }
 
-    it 'make smelly names pass via regex / strings given by list / literal' do
-      [[/bar2/], /bar2/, ['bar2'], 'bar2'].each do |pattern|
+    it 'make smelly names pass' do
+      patterns = [/bar2/, /ar2/]
+      patterns.each do |pattern|
         expect(source).not_to reek_of(:UncommunicativeParameterName).with_config('accept' => pattern)
       end
     end
@@ -117,8 +118,9 @@ RSpec.describe Reek::SmellDetectors::UncommunicativeParameterName do
   describe '`reject` patterns' do
     let(:source) { 'def alfa(bravo); charlie(bravo); end' }
 
-    it 'reject smelly names via regex / strings given by list / literal' do
-      [[/bravo/], /bravo/, ['bravo'], 'bravo'].each do |pattern|
+    it 'reject smelly names' do
+      patterns = [/brav/, /ravo/]
+      patterns.each do |pattern|
         expect(source).to reek_of(:UncommunicativeParameterName).with_config('reject' => pattern)
       end
     end

data/spec/reek/smell_detectors/uncommunicative_variable_name_spec.rb

@@ -159,9 +159,9 @@ RSpec.describe Reek::SmellDetectors::UncommunicativeVariableName do
   describe '`accept` patterns' do
     let(:src) { 'def alfa; bravo2 = 42; end' }
 
-    # FIXME: Move the loop out of the it?
-    it 'make smelly names pass via regex / strings given by list / literal' do
-      [[/bravo2/], /bravo2/, ['bravo2'], 'bravo2'].each do |pattern|
+    it 'make smelly names pass' do
+      patterns = [/ravo2/, /bravo2/]
+      patterns.each do |pattern|
         expect(src).to reek_of(:UncommunicativeVariableName).
           and not_reek_of(:UncommunicativeVariableName).with_config('accept' => pattern)
       end
@@ -171,9 +171,9 @@ RSpec.describe Reek::SmellDetectors::UncommunicativeVariableName do
   describe '`reject` patterns' do
     let(:src) { 'def alfa; foobar = 42; end' }
 
-    # FIXME: Move the loop out of the it?
-    it 'reject smelly names via regex / strings given by list / literal' do
-      [[/foobar/], /foobar/, ['foobar'], 'foobar'].each do |pattern|
+    it 'reject smelly names' do
+      patterns = [/fooba/, /oobar/]
+      patterns.each do |pattern|
         expect(src).to not_reek_of(:UncommunicativeVariableName).
           and reek_of(:UncommunicativeVariableName).with_config('reject' => pattern)
       end

data/spec/reek/smell_detectors/unused_private_method_spec.rb

@@ -119,7 +119,7 @@ RSpec.describe Reek::SmellDetectors::UnusedPrivateMethod do
   context 'when the detector is configured via a source code comment' do
     it 'does not report methods we excluded' do
       source = <<-EOF
-        # :reek:UnusedPrivateMethod: { exclude: [ bravo ] }
+        # :reek:UnusedPrivateMethod { exclude: [ bravo ] }
         class Alfa
           private
           def bravo; end

data/spec/reek/smell_warning_spec.rb

@@ -135,6 +135,10 @@ RSpec.describe Reek::SmellWarning do
       expect(yaml['source']).to eq source
     end
 
+    it 'includes the documentation link' do
+      expect(yaml['documentation_link']).to eq Reek::DocumentationLink.build('FeatureEnvy')
+    end
+
     it 'includes the parameters' do
       parameters.each do |key, value|
         expect(yaml[key]).to eq value

data/spec/reek/source/source_code_spec.rb

@@ -6,62 +6,56 @@ RSpec.describe Reek::Source::SourceCode do
   describe '#syntax_tree' do
     it 'associates comments with the AST' do
       source = "# this is\n# a comment\ndef foo; end"
-      source_code = described_class.new(code: source, origin: '(string)')
+      source_code = described_class.new(source: source, origin: '(string)')
       result = source_code.syntax_tree
       expect(result.leading_comment).to eq "# this is\n# a comment"
     end
 
     it 'cleanly processes empty source' do
-      source_code = described_class.new(code: '', origin: '(string)')
+      source_code = described_class.new(source: '', origin: '(string)')
       result = source_code.syntax_tree
-      expect(result).to be_nil
+      expect(result.type).to eq :empty
     end
 
     it 'cleanly processes empty source with comments' do
       source = "# this is\n# a comment\n"
-      source_code = described_class.new(code: source, origin: '(string)')
+      source_code = described_class.new(source: source, origin: '(string)')
       result = source_code.syntax_tree
-      expect(result).to be_nil
+      expect(result.type).to eq :empty
     end
 
     it 'does not crash with sequences incompatible with UTF-8' do
       source = '"\xFF"'
-      source_code = described_class.new(code: source, origin: '(string)')
+      source_code = described_class.new(source: source, origin: '(string)')
       result = source_code.syntax_tree
       expect(result.children.first).to eq "\xFF"
     end
 
     it 'returns a :lambda node for lambda expressions' do
       source = '->() { }'
-      source_code = described_class.new(code: source, origin: '(string)')
+      source_code = described_class.new(source: source, origin: '(string)')
       result = source_code.syntax_tree
       expect(result.children.first.type).to eq :lambda
     end
-  end
-
-  context 'when the parser fails' do
-    let(:source_name) { 'Test source' }
-    let(:src) { described_class.new(code: code, origin: source_name, **options) }
 
-    context 'with a Parser::SyntaxError' do
+    context 'when the parser fails with a Parser::SyntaxError' do
+      let(:src) { described_class.new(source: code) }
       let(:code) { '== Invalid Syntax ==' }
-      let(:options) { {} }
 
-      it 'adds a diagnostic' do
-        expect(src.diagnostics.size).to eq 2
+      it 'raises the error' do
+        expect { src.syntax_tree }.to raise_error Parser::SyntaxError
       end
     end
 
-    context 'with a generic error' do
+    context 'when the parser fails with a generic error' do
       let(:code) { '' }
+      let(:parser) { instance_double('Parser::Ruby25') }
+      let(:src) { described_class.new(source: code, parser: parser) }
       let(:error_class) { RuntimeError }
       let(:error_message) { 'An error' }
-      let(:options) do
-        parser = instance_double('Parser::Ruby25')
+
+      before do
         allow(parser).to receive(:parse_with_comments).and_raise(error_class, error_message)
-        {
-          parser: parser
-        }
       end
 
       it 'raises the error' do

data/spec/reek/source/source_locator_spec.rb

@@ -6,14 +6,14 @@ require_lib 'reek/source/source_locator'
 RSpec.describe Reek::Source::SourceLocator do
   describe '#sources' do
     context 'when applied to hidden directories' do
-      let(:path) { SAMPLES_PATH.join('source_with_hidden_directories') }
+      let(:path) { SAMPLES_DIR.join('source_with_hidden_directories') }
 
       let(:expected_paths) do
-        [path.join('uncommunicative_parameter_name.rb')]
+        [path.join('not_hidden.rb')]
       end
 
       let(:paths_that_are_expected_to_be_ignored) do
-        [path.join('.hidden/uncommunicative_method_name.rb')]
+        [path.join('.hidden/hidden.rb')]
       end
 
       it 'does not scan hidden directories' do
@@ -32,16 +32,16 @@ RSpec.describe Reek::Source::SourceLocator do
     # rubocop:disable RSpec/NestedGroups
     context 'with excluded paths' do
       let(:configuration) do
-        test_configuration_for(CONFIG_PATH.join('with_excluded_paths.reek'))
+        test_configuration_for(CONFIGURATION_DIR.join('with_excluded_paths.reek'))
       end
 
       let(:options) { instance_double('Reek::CLI::Options', force_exclusion?: false) }
 
       context 'when the path is absolute' do
         let(:path) do
-          SAMPLES_PATH.join('source_with_exclude_paths',
-                            'ignore_me',
-                            'uncommunicative_method_name.rb').expand_path
+          SAMPLES_DIR.join('source_with_exclude_paths',
+                           'ignore_me',
+                           'uncommunicative_method_name.rb').expand_path
         end
 
         context 'when options.force_exclusion? is true' do
@@ -68,7 +68,7 @@ RSpec.describe Reek::Source::SourceLocator do
       end
 
       context 'when the path is a file name in an excluded directory' do
-        let(:path) { SAMPLES_PATH.join('source_with_exclude_paths', 'ignore_me', 'uncommunicative_method_name.rb') }
+        let(:path) { SAMPLES_DIR.join('source_with_exclude_paths', 'ignore_me', 'uncommunicative_method_name.rb') }
 
         context 'when options.force_exclusion? is true' do
           before do
@@ -94,7 +94,7 @@ RSpec.describe Reek::Source::SourceLocator do
       end
 
       context 'when path is a directory' do
-        let(:path) { SAMPLES_PATH.join('source_with_exclude_paths') }
+        let(:path) { SAMPLES_DIR.join('source_with_exclude_paths') }
 
         let(:expected_paths) do
           [path.join('nested/uncommunicative_parameter_name.rb')]
@@ -121,9 +121,9 @@ RSpec.describe Reek::Source::SourceLocator do
     # rubocop:enable RSpec/NestedGroups
 
     context 'with non-Ruby paths' do
-      let(:path) { SAMPLES_PATH.join('source_with_non_ruby_files') }
+      let(:path) { SAMPLES_DIR.join('source_with_non_ruby_files') }
       let(:expected_sources) do
-        [path.join('uncommunicative_parameter_name.rb')]
+        [path.join('ruby.rb')]
       end
       let(:paths_that_are_expected_to_be_ignored) do
         [