reek 4.7.3 → 4.8.0

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '4.7.3'.freeze
+    STRING = '4.8.0'.freeze
   end
 end

data/reek.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |s|
   s.summary = 'Code smell detector for Ruby'
 
   s.add_runtime_dependency 'codeclimate-engine-rb', '~> 0.4.0'
-  s.add_runtime_dependency 'parser',                '< 2.5', '>= 2.4.0.0'
-  s.add_runtime_dependency 'rainbow',               '~> 2.0'
+  s.add_runtime_dependency 'parser',                '< 2.6', '>= 2.5.0.0'
+  s.add_runtime_dependency 'rainbow',               '~> 3.0'
 end

data/spec/factories/factories.rb

@@ -3,18 +3,7 @@ require_relative '../../lib/reek/smell_detectors/base_detector'
 require_relative '../../lib/reek/smell_warning'
 require_relative '../../lib/reek/cli/options'
 
-FactoryGirl.define do
-  factory :method_context, class: Reek::Context::MethodContext do
-    skip_create
-    transient do
-      source 'def foo; end'
-    end
-
-    initialize_with do
-      new(nil, Reek::Source::SourceCode.from(source).syntax_tree)
-    end
-  end
-
+FactoryBot.define do
   factory :smell_detector, class: Reek::SmellDetectors::BaseDetector do
     skip_create
     transient do
@@ -33,7 +22,7 @@ FactoryGirl.define do
     source 'dummy_file'
     lines [42]
     message 'smell warning message'
-    parameters { {} }
+    parameters({})
 
     initialize_with do
       new(smell_detector,

data/spec/reek/ast/node_spec.rb

@@ -2,6 +2,92 @@ require_relative '../../spec_helper'
 require_lib 'reek/ast/node'
 
 RSpec.describe Reek::AST::Node do
+  describe '#each_node' do
+    context 'with an empty module' do
+      let(:ast) do
+        src = 'module Emptiness; end'
+        Reek::Source::SourceCode.from(src).syntax_tree
+      end
+
+      it 'yields no calls' do
+        ast.each_node(:send, []) { |exp| raise "#{exp} yielded by empty module!" }
+      end
+
+      it 'yields one module' do
+        mods = 0
+        ast.each_node(:module, []) { |_exp| mods += 1 }
+        expect(mods).to eq(1)
+      end
+
+      it "yields the module's full AST" do
+        ast.each_node(:module, []) do |exp|
+          expect(exp).to eq(sexp(:module, sexp(:const, nil, :Emptiness), nil))
+        end
+      end
+
+      it 'returns an enumerator when no block is passed' do
+        expect(ast.each_node(:if)).to be_instance_of Enumerator
+      end
+    end
+
+    context 'with a nested element' do
+      let(:ast) do
+        src = "module Loneliness; def calloo; puts('hello') end; end"
+        Reek::Source::SourceCode.from(src).syntax_tree
+      end
+
+      it 'yields no ifs' do
+        ast.each_node(:if) { |exp| raise "#{exp} yielded by empty module!" }
+      end
+
+      it 'yields one module' do
+        expect(ast.each_node(:module).to_a.length).to eq(1)
+      end
+
+      it "yields the module's full AST" do
+        ast.each_node(:module) do |exp|
+          expect(exp).to eq sexp(:module,
+                                 sexp(:const, nil, :Loneliness),
+                                 sexp(:def, :calloo,
+                                      sexp(:args),
+                                      sexp(:send, nil, :puts, sexp(:str, 'hello'))))
+        end
+      end
+
+      it 'yields one method' do
+        expect(ast.each_node(:def).to_a.length).to eq(1)
+      end
+
+      it "yields the method's full AST" do
+        ast.each_node(:def, []) { |exp| expect(exp.children.first).to eq(:calloo) }
+      end
+
+      it 'ignores the call inside the method if the traversal is pruned' do
+        expect(ast.each_node(:send, [:def]).to_a).to be_empty
+      end
+    end
+
+    it 'finds 3 ifs in a class' do
+      src = <<-EOS
+        class Scrunch
+          def first
+            return @field == :sym ? 0 : 3;
+          end
+          def second
+            if @field == :sym
+              @other += " quarts"
+            end
+          end
+          def third
+            raise 'flu!' unless @field == :sym
+          end
+        end
+      EOS
+      ast = Reek::Source::SourceCode.from(src).syntax_tree
+      expect(ast.each_node(:if).to_a.length).to eq(3)
+    end
+  end
+
   describe '#format_to_ruby' do
     it 'returns #to_s if location is not present' do
       ast = sexp(:self)
@@ -56,7 +142,7 @@ RSpec.describe Reek::AST::Node do
     end
   end
 
-  context 'hash' do
+  describe '#hash' do
     it 'hashes equal for equal sexps' do
       node1 = sexp(:def, :jim, sexp(:args), sexp(:send, sexp(:int, 4), :+, sexp(:send, nil, :fred)))
       node2 = sexp(:def, :jim, sexp(:args), sexp(:send, sexp(:int, 4), :+, sexp(:send, nil, :fred)))
@@ -77,7 +163,7 @@ RSpec.describe Reek::AST::Node do
   end
 
   describe '#line' do
-    context 'source from file' do
+    context 'with source from a file' do
       let(:file) { SAMPLES_PATH.join('smelly.rb') }
       let(:ast) { Reek::Source::SourceCode.from(file).syntax_tree }
 
@@ -86,7 +172,7 @@ RSpec.describe Reek::AST::Node do
       end
     end
 
-    context 'source from string' do
+    context 'with source from a string' do
       let(:source) { File.read(SAMPLES_PATH.join('smelly.rb')) }
       let(:ast) { Reek::Source::SourceCode.from(source).syntax_tree }
 
@@ -97,7 +183,7 @@ RSpec.describe Reek::AST::Node do
   end
 
   describe '#source' do
-    context 'source from file' do
+    context 'with source from a file' do
       let(:file) { SAMPLES_PATH.join('smelly.rb') }
       let(:ast) { Reek::Source::SourceCode.from(file).syntax_tree }
 
@@ -106,7 +192,7 @@ RSpec.describe Reek::AST::Node do
       end
     end
 
-    context 'source from string' do
+    context 'with source from a string' do
       let(:source) { File.read(SAMPLES_PATH.join('smelly.rb')) }
       let(:ast) { Reek::Source::SourceCode.from(source).syntax_tree }
 
@@ -115,4 +201,11 @@ RSpec.describe Reek::AST::Node do
       end
     end
   end
+
+  describe '#name' do
+    it 'returns #to_s if no override is present' do
+      ast = sexp(:foo)
+      expect(ast.name).to eq ast.to_s
+    end
+  end
 end

data/spec/reek/ast/reference_collector_spec.rb

@@ -2,7 +2,7 @@ require_relative '../../spec_helper'
 require_lib 'reek/ast/reference_collector'
 
 RSpec.describe Reek::AST::ReferenceCollector do
-  context 'counting refs to self' do
+  describe '#num_refs_to_self' do
     def refs_to_self(src)
       syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
       described_class.new(syntax_tree).num_refs_to_self

data/spec/reek/ast/sexp_extensions_spec.rb

@@ -107,7 +107,7 @@ RSpec.describe Reek::AST::SexpExtensions::DefNode do
     end
 
     it 'finds nodes in the body with #body_nodes' do
-      expect(node.body_nodes([:first])).to eq [sexp(:first)]
+      expect(node.body_nodes([:first]).to_a).to eq [sexp(:first)]
     end
   end
 
@@ -374,7 +374,7 @@ end
 RSpec.describe Reek::AST::SexpExtensions::LambdaNode do
   let(:node) { sexp(:lambda) }
 
-  context '#name' do
+  describe '#name' do
     it 'returns :lambda' do
       expect(node.name).to eq 'lambda'
     end

data/spec/reek/cli/application_spec.rb

@@ -32,58 +32,56 @@ RSpec.describe Reek::CLI::Application do
       expect(app.execute).to eq 'foo'
     end
 
-    context 'when no source files given' do
-      context 'and input was piped' do
-        before do
-          allow_any_instance_of(IO).to receive(:tty?).and_return(false)
-        end
+    context 'when no source files given and input was piped' do
+      before do
+        allow_any_instance_of(IO).to receive(:tty?).and_return(false)
+      end
 
-        it 'uses source form pipe' do
-          app.execute
-          expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
-            with(sources: [$stdin],
-                 configuration: Reek::Configuration::AppConfiguration,
-                 options: Reek::CLI::Options)
-        end
+      it 'uses source form pipe' do
+        app.execute
+        expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
+          with(sources: [$stdin],
+               configuration: Reek::Configuration::AppConfiguration,
+               options: Reek::CLI::Options)
+      end
+    end
+
+    context 'when no source files given and no input was piped' do
+      before do
+        allow_any_instance_of(IO).to receive(:tty?).and_return(true)
       end
 
-      context 'and input was not piped' do
+      it 'uses working directory as source' do
+        expected_sources = Reek::Source::SourceLocator.new(['.']).sources
+        app.execute
+        expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
+          with(sources: expected_sources,
+               configuration: Reek::Configuration::AppConfiguration,
+               options: Reek::CLI::Options)
+      end
+
+      context 'when source files are excluded through configuration' do
+        let(:app) { described_class.new ['--config', 'some_file.reek'] }
+
         before do
-          allow_any_instance_of(IO).to receive(:tty?).and_return(true)
+          allow(Reek::Configuration::AppConfiguration).
+            to receive(:from_path).
+            with(Pathname.new('some_file.reek')).
+            and_return configuration
         end
 
-        it 'uses working directory as source' do
-          expected_sources = Reek::Source::SourceLocator.new(['.']).sources
+        it 'uses configuration for excluded paths' do
+          expected_sources = Reek::Source::SourceLocator.
+            new(['.'], configuration: configuration).sources
+          expect(expected_sources).not_to include(path_excluded_in_configuration)
+
           app.execute
+
           expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
             with(sources: expected_sources,
-                 configuration: Reek::Configuration::AppConfiguration,
+                 configuration: configuration,
                  options: Reek::CLI::Options)
         end
-
-        context 'when source files are excluded through configuration' do
-          let(:app) { described_class.new ['--config', 'some_file.reek'] }
-
-          before do
-            allow(Reek::Configuration::AppConfiguration).
-              to receive(:from_path).
-              with(Pathname.new('some_file.reek')).
-              and_return configuration
-          end
-
-          it 'uses configuration for excluded paths' do
-            expected_sources = Reek::Source::SourceLocator.
-              new(['.'], configuration: configuration).sources
-            expect(expected_sources).not_to include(path_excluded_in_configuration)
-
-            app.execute
-
-            expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
-              with(sources: expected_sources,
-                   configuration: configuration,
-                   options: Reek::CLI::Options)
-          end
-        end
       end
     end
 

data/spec/reek/cli/command/todo_list_command_spec.rb

@@ -21,7 +21,7 @@ RSpec.describe Reek::CLI::Command::TodoListCommand do
       allow(File).to receive(:write).with(described_class::FILE_NAME, String)
     end
 
-    context 'smells found' do
+    context 'when smells are found' do
       let(:source_file) { SMELLY_FILE }
 
       it 'shows a proper message' do
@@ -44,7 +44,7 @@ RSpec.describe Reek::CLI::Command::TodoListCommand do
       end
     end
 
-    context 'no smells found' do
+    context 'when no smells re found' do
       let(:source_file) { CLEAN_FILE }
 
       it 'shows a proper message' do

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) { FactoryGirl.build(:code_comment, comment: '') }
+    let(:comment) { build(:code_comment, comment: '') }
 
     it 'is not descriptive' do
       expect(comment).not_to be_descriptive
@@ -14,33 +14,33 @@ RSpec.describe Reek::CodeComment do
     end
   end
 
-  context 'comment checks' do
+  describe '#descriptive' do
     it 'rejects an empty comment' do
-      comment = FactoryGirl.build(:code_comment, comment: '#')
+      comment = build(:code_comment, comment: '#')
       expect(comment).not_to be_descriptive
     end
 
     it 'rejects a 1-word comment' do
-      comment = FactoryGirl.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 = FactoryGirl.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 = FactoryGirl.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
 
-  context 'good comment config' do
+  describe 'good comment config' do
     it 'parses hashed options' do
       comment = '# :reek:DuplicateMethodCall { enabled: false }'
-      config = FactoryGirl.build(:code_comment,
-                                 comment: comment).config
+      config = build(:code_comment,
+                     comment: comment).config
 
       expect(config).to include('DuplicateMethodCall')
       expect(config['DuplicateMethodCall']).to include('enabled')
@@ -49,8 +49,8 @@ RSpec.describe Reek::CodeComment do
 
     it "supports hashed options with the legacy separator ':' after the smell detector" do
       comment = '# :reek:DuplicateMethodCall: { enabled: false }'
-      config = FactoryGirl.build(:code_comment,
-                                 comment: comment).config
+      config = build(:code_comment,
+                     comment: comment).config
 
       expect(config).to include('DuplicateMethodCall')
       expect(config['DuplicateMethodCall']).to include('enabled')
@@ -62,7 +62,7 @@ RSpec.describe Reek::CodeComment do
         # :reek:DuplicateMethodCall { enabled: false }
         # :reek:NestedIterators { enabled: true }
       EOF
-      config = FactoryGirl.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')
@@ -75,7 +75,7 @@ RSpec.describe Reek::CodeComment do
       comment = <<-EOF
         #:reek:DuplicateMethodCall { enabled: false } and :reek:NestedIterators { enabled: true }
       EOF
-      config = FactoryGirl.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')
@@ -86,7 +86,7 @@ RSpec.describe Reek::CodeComment do
 
     it 'parses multiple unhashed options on the same line' do
       comment = '# :reek:DuplicateMethodCall and :reek:NestedIterators'
-      config = FactoryGirl.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,7 +97,7 @@ RSpec.describe Reek::CodeComment do
 
     it 'disables the smell if no options are specifed' do
       comment = '# :reek:DuplicateMethodCall'
-      config = FactoryGirl.build(:code_comment, comment: comment).config
+      config = build(:code_comment, comment: comment).config
 
       expect(config).to include('DuplicateMethodCall')
       expect(config['DuplicateMethodCall']).to include('enabled')
@@ -105,8 +105,8 @@ RSpec.describe Reek::CodeComment do
     end
 
     it 'ignores smells after a space' do
-      config = FactoryGirl.build(:code_comment,
-                                 comment: '# :reek: DuplicateMethodCall').config
+      config = build(:code_comment,
+                     comment: '# :reek: DuplicateMethodCall').config
       expect(config).not_to include('DuplicateMethodCall')
     end
 
@@ -117,7 +117,7 @@ RSpec.describe Reek::CodeComment do
         # :reek:NestedIterators { enabled: true }
         # comment
       EOF
-      comment = FactoryGirl.build(:code_comment, comment: original_comment)
+      comment = build(:code_comment, comment: original_comment)
 
       expect(comment.send(:sanitized_comment)).to eq('Actual comment')
     end
@@ -125,66 +125,66 @@ RSpec.describe Reek::CodeComment do
 end
 
 RSpec.describe Reek::CodeComment::CodeCommentValidator do
-  context 'bad detector' do
+  context 'when the comment contains an unknown detector name' do
     it 'raises BadDetectorInCommentError' do
       expect do
-        FactoryGirl.build(:code_comment,
-                          comment: '# :reek:DoesNotExist')
+        build(:code_comment,
+              comment: '# :reek:DoesNotExist')
       end.to raise_error(Reek::Errors::BadDetectorInCommentError)
     end
   end
 
-  context 'unparsable detector configuration' do
+  context 'when the comment contains an unparsable detector configuration' do
     it 'raises GarbageDetectorConfigurationInCommentError' do
       expect do
         comment = '# :reek:UncommunicativeMethodName { thats: a: bad: config }'
-        FactoryGirl.build(:code_comment, comment: comment)
+        build(:code_comment, comment: comment)
       end.to raise_error(Reek::Errors::GarbageDetectorConfigurationInCommentError)
     end
   end
 
   describe 'validating configuration keys' do
-    context 'basic options mispelled' 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 }'
-          FactoryGirl.build(:code_comment, comment: comment)
+          build(:code_comment, comment: comment)
         end.to raise_error(Reek::Errors::BadDetectorConfigurationKeyInCommentError)
       end
     end
 
-    context 'basic options not mispelled' do
+    context 'when basic options are not mispelled' do
       it 'does not raise' do
         expect do
           comment = '# :reek:UncommunicativeMethodName { exclude: alfa, enabled: true }'
-          FactoryGirl.build(:code_comment, comment: comment)
+          build(:code_comment, comment: comment)
         end.not_to raise_error
       end
 
       it 'does not raise on regexps' do
         expect do
           comment = '# :reek:UncommunicativeMethodName { exclude: !ruby/regexp /alfa/ }'
-          FactoryGirl.build(:code_comment, comment: comment)
+          build(:code_comment, comment: comment)
         end.not_to raise_error
       end
     end
 
-    context 'unknown custom options' do
+    context 'when unknown custom options are specified' do
       it 'raises BadDetectorConfigurationKeyInCommentError' do
         expect do
           # max_copies -> mx_copies and min_clump_size -> mn_clump_size
           comment = '# :reek:DataClump { mx_copies: 4, mn_clump_size: 3 }'
-          FactoryGirl.build(:code_comment, comment: comment)
+          build(:code_comment, comment: comment)
         end.to raise_error(Reek::Errors::BadDetectorConfigurationKeyInCommentError)
       end
     end
 
-    context 'valid custom options' do
+    context 'when valid custom options are specified' do
       it 'does not raise' do
         expect do
           comment = '# :reek:DataClump { max_copies: 4, min_clump_size: 3 }'
-          FactoryGirl.build(:code_comment, comment: comment)
+          build(:code_comment, comment: comment)
         end.not_to raise_error
       end
     end