reek 5.6.0 → 6.0.3

data/lib/reek/source/source_locator.rb

@@ -33,23 +33,26 @@ module Reek
 
       attr_reader :configuration, :paths, :options
 
-      # @quality :reek:TooManyStatements { max_statements: 7 }
-      # @quality :reek:NestedIterators { max_allowed_nesting: 2 }
       def source_paths
         paths.each_with_object([]) do |given_path, relevant_paths|
-          unless given_path.exist?
+          if given_path.exist?
+            relevant_paths.concat source_files_from_path(given_path)
+          else
             print_no_such_file_error(given_path)
-            next
           end
+        end
+      end
 
-          given_path.find do |path|
-            if path.directory?
-              ignore_path?(path) ? Find.prune : next
-            elsif ruby_file?(path)
-              relevant_paths << path unless ignore_file?(path)
-            end
+      def source_files_from_path(given_path)
+        relevant_paths = []
+        given_path.find do |path|
+          if path.directory?
+            Find.prune if ignore_path?(path)
+          elsif ruby_file?(path)
+            relevant_paths << path unless ignore_file?(path)
           end
         end
+        relevant_paths
       end
 
       def ignore_file?(path)

data/lib/reek/spec/smell_matcher.rb

@@ -43,8 +43,9 @@ module Reek
         raise ArgumentError, "The attribute '#{extra_keys.first}' is not available for comparison"
       end
 
+      # :reek:FeatureEnvy
       def common_parameters_equal?(other_parameters)
-        smell_warning.parameters.slice(*other_parameters.keys) == other_parameters
+        smell_warning.parameters.values_at(*other_parameters.keys) == other_parameters.values
       end
 
       def common_attributes_equal?(attributes)

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '5.6.0'
+    STRING = '6.0.3'
   end
 end

data/lib/reek.rb

@@ -8,6 +8,7 @@ require_relative 'reek/examiner'
 require_relative 'reek/report'
 
 module Reek
+  DEFAULT_SMELL_CONFIGURATION = File.join(__dir__, '../docs/defaults.reek.yml').freeze
   DEFAULT_CONFIGURATION_FILE_NAME = '.reek.yml'
   DETECTORS_KEY = 'detectors'
   EXCLUDE_PATHS_KEY = 'exclude_paths'

data/reek.gemspec

@@ -16,12 +16,19 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^bin/}).map { |path| File.basename(path) }
   s.homepage = 'https://github.com/troessner/reek'
   s.rdoc_options = %w(--main README.md -x assets/|bin/|config/|features/|spec/|tasks/)
-  s.required_ruby_version = '>= 2.3.0'
+  s.required_ruby_version = '>= 2.4.0'
   s.summary = 'Code smell detector for Ruby'
 
-  s.add_runtime_dependency 'codeclimate-engine-rb', '~> 0.4.0'
-  s.add_runtime_dependency 'kwalify',               '~> 0.7.0'
-  s.add_runtime_dependency 'parser',                '< 2.8', '>= 2.5.0.0', '!= 2.5.1.1'
-  s.add_runtime_dependency 'psych',                 '~> 3.1.0'
-  s.add_runtime_dependency 'rainbow',               '>= 2.0', '< 4.0'
+  s.metadata = {
+    'homepage_uri'      => 'https://github.com/troessner/reek',
+    'source_code_uri'   => 'https://github.com/troessner/reek',
+    'bug_tracker_uri'   => 'https://github.com/troessner/reek/issues',
+    'changelog_uri'     => 'https://github.com/troessner/reek/CHANGELOG.md',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/reek'
+  }
+
+  s.add_runtime_dependency 'kwalify', '~> 0.7.0'
+  s.add_runtime_dependency 'parser',  '~> 3.0.0'
+  s.add_runtime_dependency 'psych',   '~> 3.1'
+  s.add_runtime_dependency 'rainbow', '>= 2.0', '< 4.0'
 end

data/spec/performance/reek/smell_detectors/runtime_speed_spec.rb

@@ -6,10 +6,8 @@ RSpec.describe 'Runtime speed' do
 
   it 'runs on our smelly sources in less than 5 seconds' do
     expect do
-      source_directory.each_entry do |entry|
-        next if %w(. ..).include?(entry.to_s)
-
-        examiner = Reek::Examiner.new entry.to_path
+      Dir[source_directory.join('**/*.rb')].each do |entry|
+        examiner = Reek::Examiner.new Pathname.new(entry)
         examiner.smells.size
       end
     end.to perform_under(5).sec

data/spec/quality/documentation_spec.rb

@@ -4,6 +4,7 @@ require 'kramdown'
 RSpec.describe 'Documentation' do
   root = File.expand_path('../..', __dir__)
   files = Dir.glob(File.join(root, '*.md')) + Dir.glob(File.join(root, 'docs', '*.md'))
+  code_types = [:codeblock, :codespan]
 
   files.each do |file|
     describe "from #{file}" do
@@ -13,7 +14,7 @@ RSpec.describe 'Documentation' do
 
       blocks.each do |block|
         # Only consider code blocks with language 'ruby'.
-        next unless [:codeblock, :codespan].include?(block.type)
+        next unless code_types.include?(block.type)
         next unless block.attr['class'] == 'language-ruby'
 
         it "has a valid sample at #{block.options[:location] + 1}" do

data/spec/reek/ast/sexp_extensions_spec.rb

@@ -443,73 +443,55 @@ end
 
 RSpec.describe Reek::AST::SexpExtensions::CasgnNode do
   describe '#defines_module?' do
-    context 'with single assignment' do
-      it 'does not define a module' do
-        exp = sexp(:casgn, nil, :Foo)
-        expect(exp).not_to be_defines_module
-      end
+    it 'is false for single assignment' do
+      exp = sexp(:casgn, nil, :Foo)
+      expect(exp).not_to be_defines_module
     end
 
-    context 'with implicit receiver to new' do
-      it 'does not define a module' do
-        exp = sexp(:casgn, nil, :Foo, sexp(:send, nil, :new))
-        expect(exp).not_to be_defines_module
-      end
+    it 'is false for implicit receiver to new' do
+      exp = sexp(:casgn, nil, :Foo, sexp(:send, nil, :new))
+      expect(exp).not_to be_defines_module
     end
 
-    context 'with implicit receiver to new' do
-      it 'does not define a module' do
-        exp = Reek::Source::SourceCode.from('Foo = Class.new(Bar)').syntax_tree
-
-        expect(exp).to be_defines_module
-      end
+    it 'is true for explicit receiver to new' do
+      exp = Reek::Source::SourceCode.from('Foo = Class.new(Bar)').syntax_tree
+      expect(exp).to be_defines_module
     end
 
-    context 'when assigning a lambda to a constant' do
-      it 'does not define a module' do
-        exp = Reek::Source::SourceCode.from('C = ->{}').syntax_tree
-
-        expect(exp).not_to be_defines_module
-      end
+    it 'is false for assigning a lambda to a constant' do
+      exp = Reek::Source::SourceCode.from('C = ->{}').syntax_tree
+      expect(exp).not_to be_defines_module
     end
 
-    context 'when assigning a string to a constant' do
-      it 'does not define a module' do
-        exp = Reek::Source::SourceCode.from('C = "hello"').syntax_tree
-
-        expect(exp).not_to be_defines_module
-      end
+    it 'is false for assigning a string to a constant' do
+      exp = Reek::Source::SourceCode.from('C = "hello"').syntax_tree
+      expect(exp).not_to be_defines_module
     end
   end
 
   describe '#superclass' do
     it 'returns the superclass from the class definition' do
       exp = Reek::Source::SourceCode.from('Foo = Class.new(Bar)').syntax_tree
-
       expect(exp.superclass).to eq sexp(:const, nil, :Bar)
     end
 
     it 'returns nil in case of no class definition' do
       exp = Reek::Source::SourceCode.from('Foo = 23').syntax_tree
-
       expect(exp.superclass).to be_nil
     end
 
     it 'returns nil in case of no superclass' do
       exp = Reek::Source::SourceCode.from('Foo = Class.new').syntax_tree
-
       expect(exp.superclass).to be_nil
     end
 
     it 'returns nothing for a class definition using Struct.new' do
       exp = Reek::Source::SourceCode.from('Foo = Struct.new("Bar")').syntax_tree
-
       expect(exp.superclass).to be_nil
     end
 
     it 'returns nothing for a constant assigned with a bare method call' do
       exp = Reek::Source::SourceCode.from('Foo = foo("Bar")').syntax_tree
-
       expect(exp.superclass).to be_nil
     end
   end

data/spec/reek/code_comment_spec.rb

@@ -3,7 +3,7 @@ require_lib 'reek/code_comment'
 
 RSpec.describe Reek::CodeComment do
   context 'with an empty comment' do
-    let(:comment) { build(:code_comment, comment: '') }
+    let(:comment) { build_code_comment(comment: '') }
 
     it 'is not descriptive' do
       expect(comment).not_to be_descriptive
@@ -16,77 +16,63 @@ RSpec.describe Reek::CodeComment do
 
   describe '#descriptive' do
     it 'rejects an empty comment' do
-      comment = build(:code_comment, comment: '#')
+      comment = build_code_comment(comment: '#')
       expect(comment).not_to be_descriptive
     end
 
     it 'rejects a 1-word comment' do
-      comment = build(:code_comment, comment: "# alpha\n#  ")
+      comment = build_code_comment(comment: "# alpha\n#  ")
       expect(comment).not_to be_descriptive
     end
 
     it 'accepts a 2-word comment' do
-      comment = build(:code_comment, comment: '# alpha bravo  ')
+      comment = build_code_comment(comment: '# alpha bravo  ')
       expect(comment).to be_descriptive
     end
 
     it 'accepts a multi-word comment' do
-      comment = build(:code_comment, comment: "# alpha bravo \n# charlie \n   # delta ")
+      comment = build_code_comment(comment: "# alpha bravo \n# charlie \n   # delta ")
       expect(comment).to be_descriptive
     end
   end
 
   describe 'good comment config' do
     it 'parses hashed options' do
-      comment = '# :reek:DuplicateMethodCall { enabled: false }'
-      config = build(:code_comment,
-                     comment: comment).config
+      comment = '# :reek:DuplicateMethodCall { max_calls: 3 }'
+      config = build_code_comment(comment: comment).config
 
       expect(config).to include('DuplicateMethodCall')
-      expect(config['DuplicateMethodCall']).to include('enabled')
-      expect(config['DuplicateMethodCall']['enabled']).to be_falsey
-    end
-
-    it "supports hashed options with the legacy separator ':' after the smell detector" do
-      comment = '# :reek:DuplicateMethodCall: { enabled: false }'
-      config = build(:code_comment,
-                     comment: comment).config
-
-      expect(config).to include('DuplicateMethodCall')
-      expect(config['DuplicateMethodCall']).to include('enabled')
-      expect(config['DuplicateMethodCall']['enabled']).to be_falsey
+      expect(config['DuplicateMethodCall']).to have_key 'max_calls'
+      expect(config['DuplicateMethodCall']['max_calls']).to eq 3
     end
 
     it 'parses multiple hashed options' do
       comment = <<-RUBY
-        # :reek:DuplicateMethodCall { enabled: false }
+        # :reek:DuplicateMethodCall { max_calls: 3 }
         # :reek:NestedIterators { enabled: true }
       RUBY
-      config = build(:code_comment, comment: comment).config
+      config = build_code_comment(comment: comment).config
 
       expect(config).to include('DuplicateMethodCall', 'NestedIterators')
-      expect(config['DuplicateMethodCall']).to include('enabled')
-      expect(config['DuplicateMethodCall']['enabled']).to be_falsey
-      expect(config['NestedIterators']).to include('enabled')
+      expect(config['DuplicateMethodCall']['max_calls']).to eq 3
       expect(config['NestedIterators']['enabled']).to be_truthy
     end
 
     it 'parses multiple hashed options on the same line' do
       comment = <<-RUBY
-        #:reek:DuplicateMethodCall { enabled: false } and :reek:NestedIterators { enabled: true }
+        #:reek:DuplicateMethodCall { max_calls: 3 } and :reek:NestedIterators { enabled: true }
       RUBY
-      config = build(:code_comment, comment: comment).config
+      config = build_code_comment(comment: comment).config
 
       expect(config).to include('DuplicateMethodCall', 'NestedIterators')
-      expect(config['DuplicateMethodCall']).to include('enabled')
-      expect(config['DuplicateMethodCall']['enabled']).to be_falsey
+      expect(config['DuplicateMethodCall']['max_calls']).to eq 3
       expect(config['NestedIterators']).to include('enabled')
       expect(config['NestedIterators']['enabled']).to be_truthy
     end
 
     it 'parses multiple unhashed options on the same line' do
       comment = '# :reek:DuplicateMethodCall and :reek:NestedIterators'
-      config = build(:code_comment, comment: comment).config
+      config = build_code_comment(comment: comment).config
 
       expect(config).to include('DuplicateMethodCall', 'NestedIterators')
       expect(config['DuplicateMethodCall']).to include('enabled')
@@ -97,27 +83,33 @@ RSpec.describe Reek::CodeComment do
 
     it 'disables the smell if no options are specifed' do
       comment = '# :reek:DuplicateMethodCall'
-      config = build(:code_comment, comment: comment).config
+      config = build_code_comment(comment: comment).config
 
       expect(config).to include('DuplicateMethodCall')
       expect(config['DuplicateMethodCall']).to include('enabled')
       expect(config['DuplicateMethodCall']['enabled']).to be_falsey
     end
 
+    it 'does not disable the smell if options are specifed' do
+      comment = '# :reek:DuplicateMethodCall { max_calls: 3 }'
+      config = build_code_comment(comment: comment).config
+
+      expect(config['DuplicateMethodCall']).not_to include('enabled')
+    end
+
     it 'ignores smells after a space' do
-      config = build(:code_comment,
-                     comment: '# :reek: DuplicateMethodCall').config
+      config = build_code_comment(comment: '# :reek: DuplicateMethodCall').config
       expect(config).not_to include('DuplicateMethodCall')
     end
 
     it 'removes the configuration options from the comment' do
       original_comment = <<-RUBY
         # Actual
-        # :reek:DuplicateMethodCall { enabled: false }
+        # :reek:DuplicateMethodCall { max_calls: 3 }
         # :reek:NestedIterators { enabled: true }
         # comment
       RUBY
-      comment = build(:code_comment, comment: original_comment)
+      comment = build_code_comment(comment: original_comment)
 
       expect(comment.send(:sanitized_comment)).to eq('Actual comment')
     end
@@ -128,8 +120,7 @@ RSpec.describe Reek::CodeComment::CodeCommentValidator do
   context 'when the comment contains an unknown detector name' do
     it 'raises BadDetectorInCommentError' do
       expect do
-        build(:code_comment,
-              comment: '# :reek:DoesNotExist')
+        build_code_comment(comment: '# :reek:DoesNotExist')
       end.to raise_error(Reek::Errors::BadDetectorInCommentError)
     end
   end
@@ -138,18 +129,26 @@ RSpec.describe Reek::CodeComment::CodeCommentValidator do
     it 'raises GarbageDetectorConfigurationInCommentError' do
       expect do
         comment = '# :reek:UncommunicativeMethodName { thats: a: bad: config }'
-        build(:code_comment, comment: comment)
+        build_code_comment(comment: comment)
       end.to raise_error(Reek::Errors::GarbageDetectorConfigurationInCommentError)
     end
   end
 
+  context 'when the legacy comment format was used' do
+    it 'raises LegacyCommentSeparatorError' do
+      comment = '# :reek:DuplicateMethodCall:'
+      expect { build_code_comment(comment: comment) }.
+        to raise_error Reek::Errors::LegacyCommentSeparatorError
+    end
+  end
+
   describe 'validating configuration keys' do
     context 'when basic options are mispelled' do
       it 'raises BadDetectorConfigurationKeyInCommentError' do
         expect do
           # exclude -> exlude and enabled -> nabled
           comment = '# :reek:UncommunicativeMethodName { exlude: alfa, nabled: true }'
-          build(:code_comment, comment: comment)
+          build_code_comment(comment: comment)
         end.to raise_error(Reek::Errors::BadDetectorConfigurationKeyInCommentError)
       end
     end
@@ -158,7 +157,7 @@ RSpec.describe Reek::CodeComment::CodeCommentValidator do
       it 'does not raise' do
         expect do
           comment = '# :reek:UncommunicativeMethodName { exclude: alfa, enabled: true }'
-          build(:code_comment, comment: comment)
+          build_code_comment(comment: comment)
         end.not_to raise_error
       end
     end
@@ -168,7 +167,7 @@ RSpec.describe Reek::CodeComment::CodeCommentValidator do
         expect do
           # max_copies -> mx_copies and min_clump_size -> mn_clump_size
           comment = '# :reek:DataClump { mx_copies: 4, mn_clump_size: 3 }'
-          build(:code_comment, comment: comment)
+          build_code_comment(comment: comment)
         end.to raise_error(Reek::Errors::BadDetectorConfigurationKeyInCommentError)
       end
     end
@@ -177,7 +176,7 @@ RSpec.describe Reek::CodeComment::CodeCommentValidator do
       it 'does not raise' do
         expect do
           comment = '# :reek:DataClump { max_copies: 4, min_clump_size: 3 }'
-          build(:code_comment, comment: comment)
+          build_code_comment(comment: comment)
         end.not_to raise_error
       end
     end

data/spec/reek/configuration/directory_directives_spec.rb

@@ -89,6 +89,12 @@ RSpec.describe Reek::Configuration::DirectoryDirectives do
       expect(hit.to_s).to eq('bar/**/.spec/*')
     end
 
+    it 'returns the corresponding directory when source_base_dir is an absolute_path' do
+      source_base_dir = Pathname.new('foo/bar').expand_path
+      hit = directives.send :best_match_for, source_base_dir
+      expect(hit.to_s).to eq('foo/bar')
+    end
+
     it 'does not match an arbitrary directory when source_base_dir contains a character that could match the .' do
       source_base_dir = 'bar/something/aspec/direct'
       hit = directives.send :best_match_for, source_base_dir

data/spec/reek/configuration/excluded_paths_spec.rb

@@ -5,12 +5,21 @@ require_lib 'reek/configuration/excluded_paths'
 RSpec.describe Reek::Configuration::ExcludedPaths do
   describe '#add' do
     let(:exclusions) { [].extend(described_class) }
-    let(:paths) { ['smelly/sources'] }
-    let(:expected_exclude_paths) { [Pathname('smelly/sources')] }
+    let(:paths) do
+      %w(samples/directory_does_not_exist/
+         samples/source_with_non_ruby_files/
+         samples/**/ignore_me*)
+    end
+
+    let(:expected_exclude_paths) do
+      [Pathname('samples/source_with_non_ruby_files/'),
+       Pathname('samples/source_with_exclude_paths/ignore_me'),
+       Pathname('samples/source_with_exclude_paths/nested/ignore_me_as_well')]
+    end
 
     it 'adds the given paths as Pathname' do
       exclusions.add(paths)
-      expect(exclusions).to eq expected_exclude_paths
+      expect(exclusions).to match_array expected_exclude_paths
     end
   end
 end