reek 4.7.3 → 5.0.0

data/reek.gemspec

@@ -5,7 +5,6 @@ Gem::Specification.new do |s|
   s.version = Reek::Version::STRING
 
   s.authors = ['Kevin Rutherford', 'Timo Roessner', 'Matijs van Zuijlen', 'Piotr Szotkowski']
-  s.default_executable = 'reek'
   s.description =
     'Reek is a tool that examines Ruby classes, modules and methods and reports ' \
     'any code smells it finds.'
@@ -15,12 +14,13 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ['CHANGELOG.md', 'License.txt']
   s.files = `git ls-files -z`.split("\0")
   s.executables = s.files.grep(%r{^bin/}).map { |path| File.basename(path) }
-  s.homepage = 'https://github.com/troessner/reek/wiki'
+  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.1.0'
+  s.required_ruby_version = '>= 2.3.0'
   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 'kwalify',               '~> 0.7.0'
+  s.add_runtime_dependency 'parser',                '< 2.6', '>= 2.5.0.0'
+  s.add_runtime_dependency 'rainbow',               '>= 2.0', '< 4.0'
 end

data/samples/checkstyle.xml

@@ -1,6 +1,6 @@
 <?xml version='1.0'?>
 <checkstyle>
-  <file name='samples/smelly.rb'>
+  <file name='samples/smelly_source/smelly.rb'>
     <error column='0' line='4' message='has the name &apos;x&apos;' severity='warning' source='UncommunicativeMethodName'/>
     <error column='0' line='5' message='has the variable name &apos;y&apos;' severity='warning' source='UncommunicativeVariableName'/>
   </file>

data/samples/configuration/accepts_rejects_and_excludes_for_detectors.reek.yml

@@ -0,0 +1,29 @@
+---
+detectors:
+  UnusedPrivateMethod:
+    exclude:
+      - "/exclude regexp/"
+  UncommunicativeMethodName:
+    reject:
+      - "reject name"
+    accept:
+      - "accept name"
+  UncommunicativeModuleName:
+    reject:
+      - "reject name 1"
+      - "reject name 2"
+    accept:
+      - "accept name 1"
+      - "accept name 2"
+  UncommunicativeParameterName:
+    reject:
+      - "reject name"
+      - "/reject regexp/"
+    accept:
+      - "accept name"
+      - "/accept regexp/"
+  UncommunicativeVariableName:
+    reject:
+      - "/^reject regexp$/"
+    accept:
+      - "/accept(.*)regexp/"

data/samples/configuration/accepts_rejects_and_excludes_for_directory_directives.reek.yml

@@ -0,0 +1,30 @@
+---
+directories:
+  "app/controllers":
+    UnusedPrivateMethod:
+      exclude:
+        - "/exclude regexp/"
+    UncommunicativeMethodName:
+      reject:
+        - "reject name"
+      accept:
+        - "accept name"
+    UncommunicativeModuleName:
+      reject:
+        - "reject name 1"
+        - "reject name 2"
+      accept:
+        - "accept name 1"
+        - "accept name 2"
+    UncommunicativeParameterName:
+      reject:
+        - "reject name"
+        - "/reject regexp/"
+      accept:
+        - "accept name"
+        - "/accept regexp/"
+    UncommunicativeVariableName:
+      reject:
+        - "/^reject regexp$/"
+      accept:
+        - "/accept(.*)regexp/"

data/samples/configuration/full_configuration.reek

@@ -1,9 +1,13 @@
 ---
-IrresponsibleModule:
-  enabled: false
-"samples/three_clean_files/":
-  UtilityFunction:
+detectors:
+  IrresponsibleModule:
     enabled: false
+
+directories:
+  "samples/three_clean_files/":
+    UtilityFunction:
+      enabled: false
+
 exclude_paths:
   - "samples/two_smelly_files/"
   - "samples/source_with_non_ruby_files/"

data/samples/configuration/full_mask.reek

@@ -1,5 +1,6 @@
 ---
-UncommunicativeMethodName:
-  enabled: false
-UncommunicativeVariableName:
-  enabled: false
+detectors:
+  UncommunicativeMethodName:
+    enabled: false
+  UncommunicativeVariableName:
+    enabled: false

data/samples/configuration/partial_mask.reek

@@ -1,3 +1,4 @@
 ---
-UncommunicativeMethodName:
-  enabled: false
+detectors:
+  UncommunicativeMethodName:
+    enabled: false

data/samples/configuration/regular_configuration/.reek.yml

@@ -0,0 +1,4 @@
+---
+UncommunicativeVariableName:
+  accept:
+  - md5

data/samples/paths.rb

@@ -1,4 +1,5 @@
-SAMPLES_PATH = Pathname.new(__dir__).relative_path_from(Pathname.pwd)
-CONFIG_PATH = SAMPLES_PATH.join('configuration')
-CLEAN_FILE = SAMPLES_PATH.join('clean.rb')
-SMELLY_FILE = SAMPLES_PATH.join('smelly.rb')
+SAMPLES_DIR = Pathname.new(__dir__).relative_path_from(Pathname.pwd)
+CONFIGURATION_DIR = SAMPLES_DIR.join('configuration')
+CLEAN_FILE = SAMPLES_DIR.join('clean_source').join('clean.rb')
+SMELLY_FILE = SAMPLES_DIR.join('smelly_source').join('smelly.rb')
+

data/samples/source_with_hidden_directories/.hidden/hidden.rb

@@ -0,0 +1 @@
+

data/samples/source_with_hidden_directories/not_hidden.rb

@@ -0,0 +1 @@
+

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,8 +163,8 @@ RSpec.describe Reek::AST::Node do
   end
 
   describe '#line' do
-    context 'source from file' do
-      let(:file) { SAMPLES_PATH.join('smelly.rb') }
+    context 'with source from a file' do
+      let(:file) { SMELLY_FILE }
       let(:ast) { Reek::Source::SourceCode.from(file).syntax_tree }
 
       it 'returns the right line number' do
@@ -86,8 +172,8 @@ RSpec.describe Reek::AST::Node do
       end
     end
 
-    context 'source from string' do
-      let(:source) { File.read(SAMPLES_PATH.join('smelly.rb')) }
+    context 'with source from a string' do
+      let(:source) { File.read(SMELLY_FILE) }
       let(:ast) { Reek::Source::SourceCode.from(source).syntax_tree }
 
       it 'returns the right line number' do
@@ -97,17 +183,17 @@ RSpec.describe Reek::AST::Node do
   end
 
   describe '#source' do
-    context 'source from file' do
-      let(:file) { SAMPLES_PATH.join('smelly.rb') }
+    context 'with source from a file' do
+      let(:file) { SMELLY_FILE }
       let(:ast) { Reek::Source::SourceCode.from(file).syntax_tree }
 
       it 'returns the file name' do
-        expect(ast.source).to eq(SAMPLES_PATH.join('smelly.rb').to_s)
+        expect(ast.source).to eq(SMELLY_FILE.to_s)
       end
     end
 
-    context 'source from string' do
-      let(:source) { File.read(SAMPLES_PATH.join('smelly.rb')) }
+    context 'with source from a string' do
+      let(:source) { File.read SMELLY_FILE }
       let(:ast) { Reek::Source::SourceCode.from(source).syntax_tree }
 
       it 'returns "string"' do
@@ -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

@@ -17,9 +17,9 @@ RSpec.describe Reek::CLI::Application do
 
   describe '#execute' do
     let(:path_excluded_in_configuration) do
-      SAMPLES_PATH.join('source_with_exclude_paths/ignore_me/uncommunicative_method_name.rb')
+      SAMPLES_DIR.join('source_with_exclude_paths/ignore_me/uncommunicative_method_name.rb')
     end
-    let(:configuration) { test_configuration_for(CONFIG_PATH.join('with_excluded_paths.reek')) }
+    let(:configuration) { test_configuration_for(CONFIGURATION_DIR.join('with_excluded_paths.reek')) }
     let(:command) { instance_double 'Reek::CLI::Command::ReportCommand' }
     let(:app) { described_class.new [] }
 
@@ -32,57 +32,69 @@ 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 from pipe' do
+        expected_sources = a_collection_containing_exactly(have_attributes(origin: 'STDIN'))
+        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 'and input was not piped' do
-        before do
-          allow_any_instance_of(IO).to receive(:tty?).and_return(true)
-        end
+      context 'when a stdin filename is provided' do
+        let(:app) { described_class.new ['--stdin-filename', 'foo.rb'] }
 
-        it 'uses working directory as source' do
-          expected_sources = Reek::Source::SourceLocator.new(['.']).sources
+        it 'assumes that filename' do
+          expected_sources = a_collection_containing_exactly(have_attributes(origin: 'foo.rb'))
           app.execute
           expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
             with(sources: expected_sources,
                  configuration: Reek::Configuration::AppConfiguration,
                  options: Reek::CLI::Options)
         end
+      end
+    end
 
-        context 'when source files are excluded through configuration' do
-          let(:app) { described_class.new ['--config', 'some_file.reek'] }
+    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
 
-          before do
-            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
+        app.execute
+        expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
+          with(sources: expected_sources,
+               configuration: Reek::Configuration::AppConfiguration,
+               options: Reek::CLI::Options)
+      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)
+      context 'when source files are excluded through configuration' do
+        let(:app) { described_class.new ['--config', 'some_file.reek'] }
 
-            app.execute
+        before do
+          allow(Reek::Configuration::AppConfiguration).
+            to receive(:from_path).
+            with(Pathname.new('some_file.reek')).
+            and_return configuration
+        end
 
-            expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
-              with(sources: expected_sources,
-                   configuration: configuration,
-                   options: Reek::CLI::Options)
-          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

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

@@ -1,6 +1,7 @@
 require_relative '../../../spec_helper'
 require_lib 'reek/cli/command/todo_list_command'
 require_lib 'reek/cli/options'
+require_lib 'reek/configuration/app_configuration'
 
 RSpec.describe Reek::CLI::Command::TodoListCommand do
   let(:nil_check) { build :smell_detector, smell_type: :NilCheck }
@@ -21,7 +22,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
@@ -37,14 +38,15 @@ RSpec.describe Reek::CLI::Command::TodoListCommand do
       it 'writes a todo file with exclusions for each smell' do
         Reek::CLI::Silencer.silently { command.execute }
         expected_yaml = {
-          'UncommunicativeMethodName' => { 'exclude' => ['Smelly#x'] },
-          'UncommunicativeVariableName' => { 'exclude' => ['Smelly#x'] }
+          Reek::Configuration::AppConfiguration::DETECTORS_KEY =>
+          { 'UncommunicativeMethodName' => { 'exclude' => ['Smelly#x'] },
+            'UncommunicativeVariableName' => { 'exclude' => ['Smelly#x'] } }
         }.to_yaml
         expect(File).to have_received(:write).with(described_class::FILE_NAME, expected_yaml)
       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/cli/silencer_spec.rb

@@ -0,0 +1,28 @@
+require_relative '../../spec_helper'
+require_lib 'reek/cli/silencer'
+
+RSpec.describe Reek::CLI::Silencer do
+  describe '.silently' do
+    it 'blocks output from the block on $stdout' do
+      expect { described_class.silently { puts 'Hi!' } }.not_to output.to_stdout
+    end
+
+    it 'blocks output from the block on $stderr' do
+      expect { described_class.silently { warn 'Hi!' } }.not_to output.to_stderr
+    end
+
+    it 'restores output on $stdout after the block' do
+      expect do
+        described_class.silently { puts 'Hi!' }
+        puts 'there!'
+      end.to output("there!\n").to_stdout
+    end
+
+    it 'restores output on $stderr after the block' do
+      expect do
+        described_class.silently { warn 'Hi!' }
+        warn 'there!'
+      end.to output("there!\n").to_stderr
+    end
+  end
+end