reek 4.8.2 → 5.0.0

data/spec/reek/configuration/default_directive_spec.rb

@@ -6,7 +6,7 @@ RSpec.describe Reek::Configuration::DefaultDirective do
     let(:directives) { {}.extend(described_class) }
 
     it 'adds a smell configuration' do
-      directives.add :UncommunicativeVariableName, enabled: false
+      directives.add(UncommunicativeVariableName: { enabled: false })
       expect(directives).to eq(Reek::SmellDetectors::UncommunicativeVariableName => { enabled: false })
     end
   end

data/spec/reek/configuration/directory_directives_spec.rb

@@ -1,4 +1,5 @@
 require_relative '../../spec_helper'
+require_lib 'reek/errors/config_file_error'
 require_lib 'reek/configuration/directory_directives'
 
 RSpec.describe Reek::Configuration::DirectoryDirectives do
@@ -32,12 +33,10 @@ RSpec.describe Reek::Configuration::DirectoryDirectives do
     end
 
     context 'when one of given paths is a file' do
-      let(:file_as_path) { SAMPLES_PATH.join('inline.rb') }
+      let(:file_as_path) { SAMPLES_DIR.join('smelly_source').join('inline.rb') }
 
       it 'raises an error' do
-        Reek::CLI::Silencer.silently do
-          expect { directives.add(file_as_path, {}) }.to raise_error(SystemExit)
-        end
+        expect { directives.add(file_as_path => nil) }.to raise_error(Reek::Errors::ConfigFileError)
       end
     end
   end

data/spec/reek/configuration/excluded_paths_spec.rb

@@ -1,4 +1,5 @@
 require_relative '../../spec_helper'
+require_lib 'reek/errors/config_file_error'
 require_lib 'reek/configuration/excluded_paths'
 
 RSpec.describe Reek::Configuration::ExcludedPaths do
@@ -6,13 +7,12 @@ RSpec.describe Reek::Configuration::ExcludedPaths do
     let(:exclusions) { [].extend(described_class) }
 
     context 'when one of given paths is a file' do
-      let(:file_as_path) { SAMPLES_PATH.join('inline.rb') }
-      let(:paths) { [SAMPLES_PATH, file_as_path] }
+      let(:smelly_source_dir) { SAMPLES_DIR.join('smelly_source') }
+      let(:file_as_path) { smelly_source_dir.join('inline.rb') }
+      let(:paths) { [smelly_source_dir, file_as_path] }
 
       it 'raises an error if one of the given paths is a file' do
-        Reek::CLI::Silencer.silently do
-          expect { exclusions.add(paths) }.to raise_error(SystemExit)
-        end
+        expect { exclusions.add(paths) }.to raise_error(Reek::Errors::ConfigFileError)
       end
     end
   end

data/spec/reek/configuration/rake_task_converter_spec.rb

@@ -0,0 +1,33 @@
+require_relative '../../spec_helper'
+require_lib 'reek/configuration/rake_task_converter'
+
+RSpec.describe Reek::Configuration::RakeTaskConverter do
+  describe 'convert' do
+    let(:configuration_for_smell_detector) do
+      {
+        'exclude' => [/Klass#foobar$/, /^Klass#omg$/],
+        'reject' => [/^[a-z]$/, /[0-9]$/, /[A-Z]/],
+        'accept' => [/^_$/]
+      }
+    end
+
+    let(:expected_exclude) { ['/Klass#foobar$/', '/^Klass#omg$/'] }
+    let(:expected_reject) { ['/^[a-z]$/', '/[0-9]$/', '/[A-Z]/'] }
+    let(:expected_accept) { ['/^_$/'] }
+
+    it 'converts exclude regexes to strings' do
+      converted_configuration = described_class.convert configuration_for_smell_detector
+      expect(converted_configuration['exclude']).to eq(expected_exclude)
+    end
+
+    it 'converts reject regexes to strings' do
+      converted_configuration = described_class.convert configuration_for_smell_detector
+      expect(converted_configuration['reject']).to eq(expected_reject)
+    end
+
+    it 'converts accept regexes to strings' do
+      converted_configuration = described_class.convert configuration_for_smell_detector
+      expect(converted_configuration['accept']).to eq(expected_accept)
+    end
+  end
+end

data/spec/reek/configuration/schema_validator_spec.rb

@@ -0,0 +1,165 @@
+require_relative '../../spec_helper'
+require_lib 'reek/configuration/schema_validator'
+require_lib 'reek/errors/config_file_error'
+
+RSpec.describe Reek::Configuration::SchemaValidator do
+  describe 'validate' do
+    subject(:validator) { described_class.new configuration }
+
+    context 'when configuration is valid' do
+      let(:configuration) do
+        {
+          Reek::Configuration::AppConfiguration::DETECTORS_KEY => {
+            'UncommunicativeVariableName' => { 'enabled' => false },
+            'UncommunicativeMethodName'   => { 'enabled' => false }
+          }
+        }
+      end
+
+      it 'returns nil' do
+        expect(validator.validate).to eq(nil)
+      end
+    end
+
+    context 'when detector is invalid' do
+      let(:configuration) do
+        {
+          Reek::Configuration::AppConfiguration::DETECTORS_KEY => {
+            'DoesNotExist' => { 'enabled' => false }
+          }
+        }
+      end
+
+      it 'raises an error' do
+        message = %r{\[/detectors/DoesNotExist\] key 'DoesNotExist:' is undefined}
+        expect { validator.validate }.to raise_error(Reek::Errors::ConfigFileError, message)
+      end
+    end
+
+    context 'when `enabled` has a non-boolean value' do
+      let(:configuration) do
+        {
+          Reek::Configuration::AppConfiguration::DETECTORS_KEY => {
+            'FeatureEnvy' => { 'enabled' => 'foo' }
+          }
+        }
+      end
+
+      it 'raises an error' do
+        message = %r{\[/detectors/FeatureEnvy/enabled\] 'foo': not a boolean}
+        expect { validator.validate }.to raise_error(Reek::Errors::ConfigFileError, message)
+      end
+    end
+
+    context 'when detector has an unknown option' do
+      let(:configuration) do
+        {
+          Reek::Configuration::AppConfiguration::DETECTORS_KEY => {
+            'DataClump' => { 'does_not_exist' => 42 }
+          }
+        }
+      end
+
+      it 'raises an error' do
+        message = %r{\[/detectors/DataClump/does_not_exist\] key 'does_not_exist:' is undefined}
+        expect { validator.validate }.to raise_error(Reek::Errors::ConfigFileError, message)
+      end
+    end
+
+    context 'when `exclude`, `reject` and `accept`' do
+      %w(exclude reject accept).each do |attribute|
+        context 'when a scalar' do
+          let(:configuration) do
+            {
+              Reek::Configuration::AppConfiguration::DETECTORS_KEY => {
+                'UncommunicativeMethodName' => { attribute => 42 }
+              }
+            }
+          end
+
+          it 'raises an error' do
+            message = %r{\[/detectors/UncommunicativeMethodName/#{attribute}\] '42': not a sequence}
+            expect { validator.validate }.to raise_error(Reek::Errors::ConfigFileError, message)
+          end
+        end
+
+        context 'when types are mixed' do
+          let(:configuration) do
+            {
+              Reek::Configuration::AppConfiguration::DETECTORS_KEY => {
+                'UncommunicativeMethodName' => { attribute => [42, 'foo'] }
+              }
+            }
+          end
+
+          it 'raises an error' do
+            message = %r{\[/detectors/UncommunicativeMethodName/#{attribute}/0\] '42': not a string}
+            expect { validator.validate }.to raise_error(Reek::Errors::ConfigFileError, message)
+          end
+        end
+      end
+    end
+
+    context 'when `exclude_paths` is a scalar' do
+      let(:configuration) do
+        {
+          Reek::Configuration::AppConfiguration::EXCLUDE_PATHS_KEY => 42
+        }
+      end
+
+      it 'raises an error' do
+        message = %r{\[/exclude_paths\] '42': not a sequence}
+        expect { validator.validate }.to raise_error(Reek::Errors::ConfigFileError, message)
+      end
+    end
+
+    context 'when `exclude_paths` mixes types' do
+      let(:configuration) do
+        {
+          Reek::Configuration::AppConfiguration::EXCLUDE_PATHS_KEY => [42, 'foo']
+        }
+      end
+
+      it 'raises an error' do
+        message = %r{\[/exclude_paths/0\] '42': not a string}
+        expect { validator.validate }.to raise_error(Reek::Errors::ConfigFileError, message)
+      end
+    end
+
+    context 'with directory directives' do
+      context 'when bad detector' do
+        let(:configuration) do
+          {
+            Reek::Configuration::AppConfiguration::DIRECTORIES_KEY => {
+              'web_app/app/helpers' => {
+                'Bar' => { 'enabled' => false }
+              }
+            }
+          }
+        end
+
+        it 'raises an error' do
+          message = %r{\[/directories/web_app/app/helpers/Bar\] key 'Bar:' is undefined}
+          expect { validator.validate }.to raise_error(Reek::Errors::ConfigFileError, message)
+        end
+      end
+
+      context 'when unknown attribute' do
+        let(:configuration) do
+          {
+            Reek::Configuration::AppConfiguration::DIRECTORIES_KEY => {
+              'web_app/app/controllers' => {
+                'NestedIterators' => { 'foo' => false }
+              }
+            }
+          }
+        end
+
+        it 'raises an error' do
+          message = %r{\[/directories/web_app/app/controllers/NestedIterators/foo\] key 'foo:' is undefined}
+          expect { validator.validate }.to raise_error(Reek::Errors::ConfigFileError, message)
+        end
+      end
+    end
+  end
+end

data/spec/reek/context/code_context_spec.rb

@@ -121,7 +121,7 @@ RSpec.describe Reek::Context::CodeContext do
   describe '#config_for' do
     let(:src) do
       <<-EOS
-        # :reek:DuplicateMethodCall: { allow_calls: [ puts ] }')
+        # :reek:DuplicateMethodCall { allow_calls: [ puts ] }')
         def repeated_greeting
           puts 'Hello!'
           puts 'Hello!'

data/spec/reek/examiner_spec.rb

@@ -46,7 +46,7 @@ RSpec.describe Reek::Examiner do
                           filter_by_smells: [],
                           configuration: configuration)
     end
-    let(:path) { CONFIG_PATH.join('partial_mask.reek') }
+    let(:path) { CONFIGURATION_DIR.join('partial_mask.reek') }
     let(:expected_first_smell) { 'UncommunicativeVariableName' }
 
     it_behaves_like 'one smell found'
@@ -195,6 +195,33 @@ RSpec.describe Reek::Examiner do
     end
   end
 
+  context 'with a source that triggers a syntax error' do
+    let(:examiner) { described_class.new(source) }
+    let(:source) do
+      <<-SRC.strip_heredoc
+      1 2 3
+      SRC
+    end
+
+    it 'does not raise an error during initialization' do
+      expect { examiner }.not_to raise_error
+    end
+
+    it 'raises an encoding error when asked for smells' do
+      expect { examiner.smells }.to raise_error Reek::Errors::SyntaxError
+    end
+
+    it 'explains the origin of the error' do
+      message = "Source 'string' cannot be processed by Reek due to a syntax error in the source file."
+      expect { examiner.smells }.to raise_error.with_message(/#{message}/)
+    end
+
+    it 'shows the original exception class' do
+      expect { examiner.smells }.
+        to raise_error { |it| expect(it.long_message).to match(/Parser::SyntaxError/) }
+    end
+  end
+
   context 'with a source that triggers an encoding error' do
     let(:examiner) { described_class.new(source) }
     let(:source) do

data/spec/reek/report/json_report_spec.rb

@@ -1,7 +1,6 @@
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
 require_lib 'reek/report/json_report'
-require_lib 'reek/report/formatter'
 
 require 'json'
 require 'stringio'
@@ -34,58 +33,26 @@ RSpec.describe Reek::Report::JSONReport do
       expected = JSON.parse <<-EOS
         [
           {
-            "context":        "simple",
-            "lines":          [1],
-            "message":        "has the parameter name 'a'",
-            "smell_type":     "UncommunicativeParameterName",
-            "source":         "string",
-            "name":           "a"
+            "context":            "simple",
+            "lines":              [1],
+            "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"
+            "context":            "simple",
+            "lines":              [1],
+            "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 = JSON.parse(out.read)
-        expected = JSON.parse <<-EOS
-          [
-            {
-              "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/{formatter/location_formatter_spec.rb → location_formatter_spec.rb}

@@ -1,7 +1,7 @@
-require_relative '../../../spec_helper'
-require_lib 'reek/report/formatter'
+require_relative '../../spec_helper'
+require_lib 'reek/report/location_formatter'
 
-RSpec.describe Reek::Report::Formatter::BlankLocationFormatter do
+RSpec.describe Reek::Report::BlankLocationFormatter do
   let(:warning) { build(:smell_warning, lines: [11, 9, 250, 100]) }
 
   describe '.format' do
@@ -11,7 +11,7 @@ RSpec.describe Reek::Report::Formatter::BlankLocationFormatter do
   end
 end
 
-RSpec.describe Reek::Report::Formatter::DefaultLocationFormatter do
+RSpec.describe Reek::Report::DefaultLocationFormatter do
   let(:warning) { build(:smell_warning, lines: [11, 9, 250, 100]) }
 
   describe '.format' do
@@ -21,7 +21,7 @@ RSpec.describe Reek::Report::Formatter::DefaultLocationFormatter do
   end
 end
 
-RSpec.describe Reek::Report::Formatter::SingleLineLocationFormatter do
+RSpec.describe Reek::Report::SingleLineLocationFormatter do
   let(:warning) { build(:smell_warning, lines: [11, 9, 250, 100]) }
 
   describe '.format' do

data/spec/reek/report/{formatter/progress_formatter_spec.rb → progress_formatter_spec.rb}

@@ -1,7 +1,7 @@
-require_relative '../../../spec_helper'
-require_lib 'reek/report/formatter/progress_formatter'
+require_relative '../../spec_helper'
+require_lib 'reek/report/progress_formatter'
 
-RSpec.describe Reek::Report::Formatter::ProgressFormatter::Dots do
+RSpec.describe Reek::Report::ProgressFormatter::Dots do
   let(:sources_count) { 23 }
   let(:formatter) { described_class.new(sources_count) }
 
@@ -37,7 +37,7 @@ RSpec.describe Reek::Report::Formatter::ProgressFormatter::Dots do
   end
 end
 
-RSpec.describe Reek::Report::Formatter::ProgressFormatter::Quiet do
+RSpec.describe Reek::Report::ProgressFormatter::Quiet do
   let(:sources_count) { 23 }
   let(:formatter) { described_class.new(sources_count) }
 

data/spec/reek/report/text_report_spec.rb

@@ -1,15 +1,15 @@
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
 require_lib 'reek/report/text_report'
-require_lib 'reek/report/formatter'
+require_lib 'reek/report/heading_formatter'
+require_lib 'reek/report/simple_warning_formatter'
 require 'rainbow'
 
 RSpec.describe Reek::Report::TextReport do
   let(:report_options) do
     {
-      warning_formatter: Reek::Report::Formatter::SimpleWarningFormatter.new,
-      report_formatter: Reek::Report::Formatter,
-      heading_formatter: Reek::Report::Formatter::QuietHeadingFormatter
+      warning_formatter: Reek::Report::SimpleWarningFormatter.new,
+      heading_formatter: Reek::Report::QuietHeadingFormatter
     }
   end
   let(:instance) { described_class.new report_options }