reek 5.4.0 → 6.0.1

data/spec/reek/smell_detectors/base_detector_spec.rb

@@ -5,15 +5,13 @@ require_lib 'reek/smell_detectors/duplicate_method_call'
 RSpec.describe Reek::SmellDetectors::BaseDetector do
   describe '.todo_configuration_for' do
     it 'returns exclusion configuration for the given smells' do
-      detector = described_class.new
-      smell = create(:smell_warning, smell_detector: detector, context: 'Foo#bar')
+      smell = build_smell_warning(smell_type: 'Foo', context: 'Foo#bar')
       result = described_class.todo_configuration_for([smell])
       expect(result).to eq('BaseDetector' => { 'exclude' => ['Foo#bar'] })
     end
 
     it 'merges identical contexts' do
-      detector = described_class.new
-      smell = create(:smell_warning, smell_detector: detector, context: 'Foo#bar')
+      smell = build_smell_warning(smell_type: 'Foo', context: 'Foo#bar')
       result = described_class.todo_configuration_for([smell, smell])
       expect(result).to eq('BaseDetector' => { 'exclude' => ['Foo#bar'] })
     end
@@ -22,8 +20,7 @@ RSpec.describe Reek::SmellDetectors::BaseDetector do
       let(:subclass) { Reek::SmellDetectors::TooManyStatements }
 
       it 'includes default exclusions' do
-        detector = subclass.new
-        smell = create(:smell_warning, smell_detector: detector, context: 'Foo#bar')
+        smell = build_smell_warning(smell_type: 'TooManyStatements', context: 'Foo#bar')
         result = subclass.todo_configuration_for([smell])
 
         aggregate_failures do
@@ -34,16 +31,6 @@ RSpec.describe Reek::SmellDetectors::BaseDetector do
     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
-
   describe '.to_detector' do
     it 'returns the right detector' do
       expect(described_class.to_detector('DuplicateMethodCall')).to eq(Reek::SmellDetectors::DuplicateMethodCall)

data/spec/reek/smell_detectors/data_clump_spec.rb

@@ -76,6 +76,20 @@ RSpec.describe Reek::SmellDetectors::DataClump do
                              parameters: ['echo', 'foxtrot'])
     end
 
+    it 'reports arguments in alphabetical order even if they are never used that way' do
+      src = <<-RUBY
+        #{scope} Alfa
+          def bravo  (foxtrot, echo); end
+          def charlie(foxtrot, echo); end
+          def delta  (foxtrot, echo); end
+        end
+      RUBY
+
+      expect(src).to reek_of(:DataClump,
+                             count: 3,
+                             parameters: ['echo', 'foxtrot'])
+    end
+
     it 'reports parameter sets that are > 2' do
       src = <<-RUBY
         #{scope} Alfa

data/spec/reek/smell_detectors/missing_safe_method_spec.rb

@@ -50,13 +50,19 @@ RSpec.describe Reek::SmellDetectors::MissingSafeMethod do
 
   it 'does not report methods we excluded via comment' do
     source = <<-RUBY
-      # :reek:MissingSafeMethod: { exclude: [ bravo! ] }
+      # :reek:MissingSafeMethod { exclude: [ bravo! ] }
       class Alfa
         def bravo!
         end
+
+        def charlie!
+        end
       end
     RUBY
 
-    expect(source).not_to reek_of(:MissingSafeMethod)
+    aggregate_failures do
+      expect(source).not_to reek_of(:MissingSafeMethod, name: 'bravo!')
+      expect(source).to reek_of(:MissingSafeMethod, name: 'charlie!')
+    end
   end
 end

data/spec/reek/smell_detectors/nil_check_spec.rb

@@ -76,14 +76,14 @@ RSpec.describe Reek::SmellDetectors::NilCheck do
     expect(src).to reek_of(:NilCheck)
   end
 
-  it 'reports when scope uses &.' do
+  it 'does not report when scope uses &.' do
     src = <<-RUBY
       def alfa(bravo)
         bravo&.charlie
       end
     RUBY
 
-    expect(src).to reek_of(:NilCheck)
+    expect(src).not_to reek_of(:NilCheck)
   end
 
   it 'reports all lines when scope uses multiple nilchecks' do
@@ -95,6 +95,6 @@ RSpec.describe Reek::SmellDetectors::NilCheck do
       end
     RUBY
 
-    expect(src).to reek_of(:NilCheck, lines: [2, 3, 4])
+    expect(src).to reek_of(:NilCheck, lines: [2, 3])
   end
 end

data/spec/reek/smell_warning_spec.rb

@@ -2,9 +2,6 @@ require_relative '../spec_helper'
 require_lib 'reek/smell_warning'
 
 RSpec.describe Reek::SmellWarning do
-  let(:duplication_detector)  { build(:smell_detector, smell_type: 'DuplicateMethodCall') }
-  let(:feature_envy_detector) { build(:smell_detector, smell_type: 'FeatureEnvy') }
-  let(:utility_function_detector) { build(:smell_detector, smell_type: 'UtilityFunction') }
   let(:uncommunicative_name_detector) { build(:smell_detector, smell_type: 'UncommunicativeVariableName') }
 
   describe 'sort order' do
@@ -27,23 +24,23 @@ RSpec.describe Reek::SmellWarning do
     end
 
     context 'when smells differ only by detector' do
-      let(:first) { build(:smell_warning, smell_detector: duplication_detector) }
-      let(:second) { build(:smell_warning, smell_detector: feature_envy_detector) }
+      let(:first) { build_smell_warning(smell_type: 'DuplicateMethodCall') }
+      let(:second) { build_smell_warning(smell_type: 'FeatureEnvy') }
 
       it_behaves_like 'first sorts ahead of second'
     end
 
     context 'when smells differ only by lines' do
-      let(:first) { build(:smell_warning, smell_detector: feature_envy_detector, lines: [2]) }
-      let(:second) { build(:smell_warning, smell_detector: feature_envy_detector, lines: [3]) }
+      let(:first) { build_smell_warning(smell_type: 'FeatureEnvy', lines: [2]) }
+      let(:second) { build_smell_warning(smell_type: 'FeatureEnvy', lines: [3]) }
 
       it_behaves_like 'first sorts ahead of second'
     end
 
     context 'when smells differ only by context' do
-      let(:first) { build(:smell_warning, smell_detector: duplication_detector, context: 'first') }
+      let(:first) { build_smell_warning(smell_type: 'DuplicateMethodCall', context: 'first') }
       let(:second) do
-        build(:smell_warning, smell_detector: duplication_detector, context: 'second')
+        build_smell_warning(smell_type: 'DuplicateMethodCall', context: 'second')
       end
 
       it_behaves_like 'first sorts ahead of second'
@@ -51,11 +48,11 @@ RSpec.describe Reek::SmellWarning do
 
     context 'when smells differ only by message' do
       let(:first) do
-        build(:smell_warning, smell_detector: duplication_detector,
+        build_smell_warning(smell_type: 'DuplicateMethodCall',
                               context: 'ctx', message: 'first message')
       end
       let(:second) do
-        build(:smell_warning, smell_detector: duplication_detector,
+        build_smell_warning(smell_type: 'DuplicateMethodCall',
                               context: 'ctx', message: 'second message')
       end
 
@@ -64,10 +61,10 @@ RSpec.describe Reek::SmellWarning do
 
     context 'when smells differ by name and message' do
       let(:first) do
-        build(:smell_warning, smell_detector: feature_envy_detector, message: 'second message')
+        build_smell_warning(smell_type: 'FeatureEnvy', message: 'second message')
       end
       let(:second) do
-        build(:smell_warning, smell_detector: utility_function_detector, message: 'first message')
+        build_smell_warning(smell_type: 'UtilityFunction', message: 'first message')
       end
 
       it_behaves_like 'first sorts ahead of second'
@@ -75,13 +72,13 @@ RSpec.describe Reek::SmellWarning do
 
     context 'when smells differ everywhere' do
       let(:first) do
-        build(:smell_warning, smell_detector: duplication_detector,
+        build_smell_warning(smell_type: 'DuplicateMethodCall',
                               context: 'Dirty#a',
                               message: 'calls @s.title twice')
       end
 
       let(:second) do
-        build(:smell_warning, smell_detector: uncommunicative_name_detector,
+        build_smell_warning(smell_type: 'UncommunicativeVariableName',
                               context: 'Dirty',
                               message: "has the variable name '@s'")
       end
@@ -90,28 +87,20 @@ RSpec.describe Reek::SmellWarning do
     end
   end
 
-  describe '#smell_class' do
-    it "returns the dectector's class" do
-      warning = build(:smell_warning, smell_detector: duplication_detector)
-      expect(warning.smell_class).to eq duplication_detector.class
-    end
-  end
-
   describe '#yaml_hash' do
     let(:context_name) { 'Module::Class#method/block' }
     let(:lines) { [24, 513] }
     let(:message) { 'test message' }
-    let(:detector) { Reek::SmellDetectors::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 = described_class.new(smell_type, source: source,
+                                    context: context_name,
+                                    lines: lines,
+                                    message: message,
+                                    parameters: parameters)
       warning.yaml_hash
     end
 

data/spec/reek/source/source_code_spec.rb

@@ -62,5 +62,18 @@ RSpec.describe Reek::Source::SourceCode do
         expect { src.syntax_tree }.to raise_error error_class, error_message
       end
     end
+
+    if RUBY_VERSION >= '2.7'
+      context 'with ruby 2.7 syntax' do
+        context 'with forward_args (`...`)' do
+          let(:source_code) { described_class.new(source: 'def alpha(...) bravo(...); end') }
+
+          it 'returns a :forward_args node' do
+            result = source_code.syntax_tree
+            expect(result.children[1].type).to eq(:forward_args)
+          end
+        end
+      end
+    end
   end
 end

data/spec/reek/spec/should_reek_of_spec.rb

@@ -1,7 +1,6 @@
 require 'pathname'
 require_relative '../../spec_helper'
 require_lib 'reek/spec'
-require 'active_support/core_ext/hash/except'
 
 RSpec.describe Reek::Spec::ShouldReekOf do
   describe 'smell type selection' do

data/spec/reek/spec/should_reek_only_of_spec.rb

@@ -40,19 +40,16 @@ RSpec.describe Reek::Spec::ShouldReekOnlyOf do
   end
 
   context 'with 1 non-matching smell' do
-    let(:control_couple_detector) { build(:smell_detector, smell_type: 'ControlParameter') }
-    let(:smells) { [build(:smell_warning, smell_detector: control_couple_detector)] }
+    let(:smells) { [build_smell_warning(smell_type: 'ControlParameter')] }
 
     it_behaves_like 'no match'
   end
 
   context 'with 2 non-matching smells' do
-    let(:control_couple_detector) { build(:smell_detector, smell_type: 'ControlParameter') }
-    let(:feature_envy_detector) { build(:smell_detector, smell_type: 'FeatureEnvy') }
     let(:smells) do
       [
-        build(:smell_warning, smell_detector: control_couple_detector),
-        build(:smell_warning, smell_detector: feature_envy_detector)
+        build_smell_warning(smell_type: 'ControlParameter'),
+        build_smell_warning(smell_type: 'FeatureEnvy')
       ]
     end
 
@@ -60,12 +57,10 @@ RSpec.describe Reek::Spec::ShouldReekOnlyOf do
   end
 
   context 'with 1 non-matching and 1 matching smell' do
-    let(:control_couple_detector) { build(:smell_detector, smell_type: 'ControlParameter') }
     let(:smells) do
-      detector = build(:smell_detector, smell_type: expected_smell_type.to_s)
       [
-        build(:smell_warning, smell_detector: control_couple_detector),
-        build(:smell_warning, smell_detector: detector,
+        build_smell_warning(smell_type: 'ControlParameter'),
+        build_smell_warning(smell_type: expected_smell_type.to_s,
                               message: "message mentioning #{expected_context_name}")
       ]
     end
@@ -75,9 +70,7 @@ RSpec.describe Reek::Spec::ShouldReekOnlyOf do
 
   context 'with 1 matching smell' do
     let(:smells) do
-      detector = build(:smell_detector, smell_type: expected_smell_type.to_s)
-
-      [build(:smell_warning, smell_detector: detector,
+      [build_smell_warning(smell_type: expected_smell_type.to_s,
                              message: "message mentioning #{expected_context_name}")]
     end
 

data/spec/reek/spec/smell_matcher_spec.rb

@@ -2,9 +2,8 @@ require_relative '../../spec_helper'
 require_lib 'reek/spec/smell_matcher'
 
 RSpec.describe Reek::Spec::SmellMatcher do
-  let(:detector) { build(:smell_detector, smell_type: 'UncommunicativeVariableName') }
   let(:smell_warning) do
-    build(:smell_warning, smell_detector: detector,
+    build_smell_warning(smell_type: 'UncommunicativeVariableName',
                           message: "has the variable name '@s'",
                           parameters: { test: 'something' })
   end

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
 require 'pathname'
 require 'timeout'
-require 'active_support/core_ext/string/strip'
 require 'rspec-benchmark'
 require_relative '../lib/reek'
 require_relative '../lib/reek/spec'
@@ -11,12 +10,9 @@ require_relative '../samples/paths'
 
 begin
   Reek::CLI::Silencer.without_warnings { require 'pry-byebug' }
-rescue LoadError # rubocop:disable Lint/HandleExceptions
+rescue LoadError # rubocop:disable Lint/SuppressedException
 end
 
-require 'factory_bot'
-FactoryBot.find_definitions
-
 # Simple helpers for our specs.
 module Helpers
   def test_configuration_for(config)
@@ -70,14 +66,32 @@ module Helpers
     @klass_map ||= Reek::AST::ASTNodeClassMap.new
     @klass_map.klass_for(type).new(type, children)
   end
+
+  def build_smell_warning(smell_type: 'FeatureEnvy',
+                          context: 'self',
+                          lines: [42],
+                          message: 'smell warning message',
+                          source: 'dummy_file',
+                          parameters: {})
+    Reek::SmellWarning.new(smell_type,
+                           context: context,
+                           lines: lines,
+                           message: message,
+                           source: source,
+                           parameters: parameters)
+  end
+
+  def build_code_comment(comment: '', line: 1, source: 'string')
+    Reek::CodeComment.new(comment: comment, line: line, source: source)
+  end
 end
 
 RSpec.configure do |config|
   config.filter_run :focus
   config.run_all_when_everything_filtered = true
-  config.include FactoryBot::Syntax::Methods
   config.include Helpers
   config.include RSpec::Benchmark::Matchers
+  config.example_status_persistence_file_path = 'spec/examples.txt'
 
   config.disable_monkey_patching!
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 6.0.1
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,22 +11,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: codeclimate-engine-rb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: kwalify
   requirement: !ruby/object:Gem::Requirement
@@ -45,28 +31,28 @@ dependencies:
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.7'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.0.0
     - - "!="
       - !ruby/object:Gem::Version
         version: 2.5.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.7'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.0.0
     - - "!="
       - !ruby/object:Gem::Version
         version: 2.5.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -281,6 +267,7 @@ files:
 - lib/reek/errors/encoding_error.rb
 - lib/reek/errors/garbage_detector_configuration_in_comment_error.rb
 - lib/reek/errors/incomprehensible_source_error.rb
+- lib/reek/errors/legacy_comment_separator_error.rb
 - lib/reek/errors/syntax_error.rb
 - lib/reek/examiner.rb
 - lib/reek/logging_error_handler.rb
@@ -385,7 +372,6 @@ files:
 - samples/source_with_non_ruby_files/gibberish
 - samples/source_with_non_ruby_files/python_source.py
 - samples/source_with_non_ruby_files/ruby.rb
-- spec/factories/factories.rb
 - spec/performance/reek/smell_detectors/runtime_speed_spec.rb
 - spec/quality/documentation_spec.rb
 - spec/quality/reek_source_spec.rb
@@ -492,15 +478,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby