reek 3.5.0 → 3.6.0

data/reek.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.0.0'
   s.summary = 'Code smell detector for Ruby'
 
-  s.add_runtime_dependency 'parser',       '~> 2.2.2.5'
+  s.add_runtime_dependency 'parser',       '~> 2.2', '>= 2.2.2.5'
   s.add_runtime_dependency 'private_attr', '~> 1.1'
   s.add_runtime_dependency 'rainbow',      '~> 2.0'
   s.add_runtime_dependency 'unparser',     '~> 0.2.2'

data/spec/factories/factories.rb

@@ -26,7 +26,6 @@ FactoryGirl.define do
     skip_create
     transient do
       smell_type 'FeatureEnvy'
-      source 'foo'
     end
 
     initialize_with do

data/spec/reek/ast/sexp_extensions_spec.rb

@@ -233,13 +233,6 @@ end
 
 RSpec.describe Reek::AST::SexpExtensions::LvarNode do
   let(:node) { sexp(:lvar, :foo) }
-
-  describe '#simple_name' do
-    it 'returns the lvar’s name' do
-      expect(node.simple_name).to eq(:foo)
-    end
-  end
-
   describe '#var_name' do
     it 'returns the lvar’s name' do
       expect(node.var_name).to eq(:foo)

data/spec/reek/cli/options_spec.rb

@@ -24,8 +24,7 @@ RSpec.describe Reek::CLI::Options do
 
   describe 'parse' do
     it 'raises on invalid argument in ARGV' do
-      options = described_class.new
-      options.argv = ['-z']
+      options = described_class.new ['-z']
       expect { options.parse }.to raise_error(OptionParser::InvalidOption)
     end
 

data/spec/reek/configuration/app_configuration_spec.rb

@@ -25,6 +25,26 @@ RSpec.describe Reek::Configuration::AppConfiguration do
         { Reek::Smells::UtilityFunction => { 'enabled' => false } } }
     end
 
+    let(:default_directive_value) do
+      { 'IrresponsibleModule' => { 'enabled' => false } }
+    end
+
+    let(:directory_directives_value) do
+      { 'spec/samples/three_clean_files' =>
+        { 'UtilityFunction' => { 'enabled' => false } } }
+    end
+
+    let(:exclude_paths_value) do
+      ['spec/samples/two_smelly_files',
+       'spec/samples/source_with_non_ruby_files']
+    end
+
+    let(:combined_value) do
+      directory_directives_value.
+        merge(default_directive_value).
+        merge('exclude_paths' => exclude_paths_value)
+    end
+
     describe '#from_path' do
       let(:full_configuration_path) { SAMPLES_PATH.join('configuration/full_configuration.reek') }
 
@@ -38,20 +58,6 @@ RSpec.describe Reek::Configuration::AppConfiguration do
     end
 
     describe '#from_map' do
-      let(:default_directive_value) do
-        { 'IrresponsibleModule' => { 'enabled' => false } }
-      end
-
-      let(:directory_directives_value) do
-        { 'spec/samples/three_clean_files' =>
-          { 'UtilityFunction' => { 'enabled' => false } } }
-      end
-
-      let(:exclude_paths_value) do
-        ['spec/samples/two_smelly_files',
-         'spec/samples/source_with_non_ruby_files']
-      end
-
       it 'properly sets the configuration from simple data structures' do
         config = described_class.from_map(directory_directives: directory_directives_value,
                                           default_directive: default_directive_value,
@@ -72,6 +78,16 @@ RSpec.describe Reek::Configuration::AppConfiguration do
         expect(config.send(:directory_directives)).to eq(expected_directory_directives)
       end
     end
+
+    describe '#from_hash' do
+      it 'sets the configuration a unified simple data structure' do
+        config = described_class.from_hash(combined_value)
+
+        expect(config.send(:excluded_paths)).to eq(expected_excluded_paths)
+        expect(config.send(:default_directive)).to eq(expected_default_directive)
+        expect(config.send(:directory_directives)).to eq(expected_directory_directives)
+      end
+    end
   end
 
   describe '#directive_for' do

data/spec/reek/configuration/configuration_file_finder_spec.rb

@@ -7,18 +7,19 @@ require_relative '../../spec_helper'
 
 RSpec.describe Reek::Configuration::ConfigurationFileFinder do
   describe '.find' do
-    it 'returns the path if it’s set' do
+    it 'returns any explicitely passed path' do
       path = Pathname.new 'foo/bar'
       found = described_class.find(path: path)
       expect(found).to eq(path)
     end
 
-    it 'returns the file in current dir if config_file is nil' do
-      found = described_class.find(current: SAMPLES_PATH)
-      expect(found).to eq(SAMPLES_PATH.join('exceptions.reek'))
+    it 'prefers an explicitely passed path over a file in current dir' do
+      path = Pathname.new 'foo/bar'
+      found = described_class.find(path: path, current: SAMPLES_PATH)
+      expect(found).to eq(path)
     end
 
-    it 'returns the file in current dir if options is nil' do
+    it 'returns the file in current dir if path is not set' do
       found = described_class.find(current: SAMPLES_PATH)
       expect(found).to eq(SAMPLES_PATH.join('exceptions.reek'))
     end
@@ -42,6 +43,14 @@ RSpec.describe Reek::Configuration::ConfigurationFileFinder do
       end
     end
 
+    it 'prefers the file in :current over one in :home' do
+      found = described_class.find(current: SAMPLES_PATH, home: SAMPLES_PATH.join('masked_by_dotfile'))
+      file_in_home = SAMPLES_PATH.join('masked_by_dotfile/.reek')
+      file_in_current = SAMPLES_PATH.join('exceptions.reek')
+      expect(found).not_to eq(file_in_home)
+      expect(found).to eq(file_in_current)
+    end
+
     it 'returns nil when there are no files to find' do
       skip_if_a_config_in_tempdir
       Dir.mktmpdir do |tempdir|
@@ -52,6 +61,15 @@ RSpec.describe Reek::Configuration::ConfigurationFileFinder do
       end
     end
 
+    it 'does not traverse up from :home' do
+      skip_if_a_config_in_tempdir
+      Dir.mktmpdir do |tempdir|
+        current = Pathname.new(tempdir)
+        found = described_class.find(current: current, home: SAMPLES_PATH.join('no_config_file'))
+        expect(found).to be_nil
+      end
+    end
+
     it 'works with paths that need escaping' do
       Dir.mktmpdir("ma\ngic d*r") do |tempdir|
         config = Pathname.new("#{tempdir}/ma\ngic f*le.reek")

data/spec/reek/smells/attribute_spec.rb

@@ -3,8 +3,7 @@ require_lib 'reek/smells/attribute'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::Attribute do
-  let(:detector) { build(:smell_detector, smell_type: :Attribute, source: source_name) }
-  let(:source_name) { 'source' }
+  let(:detector) { build(:smell_detector, smell_type: :Attribute) }
 
   it_should_behave_like 'SmellDetector'
 
@@ -38,6 +37,16 @@ RSpec.describe Reek::Smells::Attribute do
       expect(src).to reek_of(:Attribute, name: 'my_attr')
     end
 
+    it 'does not record writer attribute if suppressed with a preceding code comment' do
+      src = <<-EOS
+        class Klass
+          # :reek:Attribute
+          attr_writer :my_attr
+        end
+      EOS
+      expect(src).not_to reek_of(:Attribute)
+    end
+
     it 'records attr_writer attribute in a module' do
       src = <<-EOS
         module Mod

data/spec/reek/smells/boolean_parameter_spec.rb

@@ -66,21 +66,23 @@ RSpec.describe Reek::Smells::BooleanParameter do
   end
 
   context 'when a smell is reported' do
-    let(:detector) { build(:smell_detector, smell_type: :BooleanParameter, source: source_name) }
-    let(:source_name) { 'string' }
+    let(:detector) { build(:smell_detector, smell_type: :BooleanParameter) }
 
     it_should_behave_like 'SmellDetector'
 
-    it 'reports the fields correctly' do
-      src = 'def cc(arga = true) end'
-      ctx = Reek::Context::MethodContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
-      smells = detector.examine_context(ctx)
-      expect(smells.length).to eq(1)
-      expect(smells[0].smell_category).to eq(described_class.smell_category)
-      expect(smells[0].parameters[:name]).to eq('arga')
-      expect(smells[0].source).to eq(source_name)
-      expect(smells[0].smell_type).to eq(described_class.smell_type)
-      expect(smells[0].lines).to eq([1])
+    context 'when a smell is reported' do
+      let(:warning) do
+        src = 'def cc(arga = true) end'
+        ctx = Reek::Context::MethodContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
+        detector.examine_context(ctx).first
+      end
+
+      it_should_behave_like 'common fields set correctly'
+
+      it 'reports the correct values' do
+        expect(warning.parameters[:name]).to eq('arga')
+        expect(warning.lines).to eq([1])
+      end
     end
   end
 end

data/spec/reek/smells/class_variable_spec.rb

@@ -5,8 +5,7 @@ require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::ClassVariable do
   let(:class_variable) { '@@things' }
-  let(:detector) { build(:smell_detector, smell_type: :ClassVariable, source: source_name) }
-  let(:source_name) { 'string' }
+  let(:detector) { build(:smell_detector, smell_type: :ClassVariable) }
 
   it_should_behave_like 'SmellDetector'
 
@@ -78,18 +77,22 @@ RSpec.describe Reek::Smells::ClassVariable do
     end
   end
 
-  it 'reports the correct fields' do
-    src = <<-EOS
-      module Fred
-        #{class_variable} = {}
-      end
-    EOS
-    ctx = Reek::Context::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
-    warning = detector.examine_context(ctx)[0]
-    expect(warning.source).to eq(source_name)
-    expect(warning.smell_category).to eq(described_class.smell_category)
-    expect(warning.smell_type).to eq(described_class.smell_type)
-    expect(warning.parameters[:name]).to eq(class_variable)
-    expect(warning.lines).to eq([2])
+  context 'when a smell is reported' do
+    let(:warning) do
+      src = <<-EOS
+        module Fred
+          #{class_variable} = {}
+        end
+      EOS
+      ctx = Reek::Context::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
+      detector.examine_context(ctx).first
+    end
+
+    it_should_behave_like 'common fields set correctly'
+
+    it 'reports the correct values' do
+      expect(warning.parameters[:name]).to eq(class_variable)
+      expect(warning.lines).to eq([2])
+    end
   end
 end

data/spec/reek/smells/control_parameter_spec.rb

@@ -3,8 +3,7 @@ require_lib 'reek/smells/control_parameter'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::ControlParameter do
-  let(:detector) { build(:smell_detector, smell_type: :ControlParameter, source: source_name) }
-  let(:source_name) { 'string' }
+  let(:detector) { build(:smell_detector, smell_type: :ControlParameter) }
 
   it_should_behave_like 'SmellDetector'
 

data/spec/reek/smells/duplicate_method_call_spec.rb

@@ -6,8 +6,7 @@ require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::DuplicateMethodCall do
   context 'when a smell is reported' do
-    let(:detector) { build(:smell_detector, smell_type: :DuplicateMethodCall, source: source_name) }
-    let(:source_name) { 'string' }
+    let(:detector) { build(:smell_detector, smell_type: :DuplicateMethodCall) }
 
     let(:warning) do
       src = <<-EOS

data/spec/reek/smells/feature_envy_spec.rb

@@ -214,15 +214,14 @@ RSpec.describe Reek::Smells::FeatureEnvy do
 end
 
 RSpec.describe Reek::Smells::FeatureEnvy do
-  let(:detector) { build(:smell_detector, smell_type: :FeatureEnvy, source: source_name) }
-  let(:source_name) { 'string' }
+  let(:detector) { build(:smell_detector, smell_type: :FeatureEnvy) }
 
   it_should_behave_like 'SmellDetector'
 
   context 'when a smell is reported' do
     let(:receiver) { 'other' }
 
-    let(:smells) do
+    let(:warning) do
       src = <<-EOS
         def envious(other)
           #{receiver}.call
@@ -231,35 +230,15 @@ RSpec.describe Reek::Smells::FeatureEnvy do
           #{receiver}.fred
         end
       EOS
-      Reek::Examiner.new(src, ['FeatureEnvy']).smells
+      Reek::Examiner.new(src, ['FeatureEnvy']).smells.first
     end
 
-    it 'reports only that smell' do
-      expect(smells.length).to eq(1)
-    end
-
-    it 'reports the source' do
-      expect(smells[0].source).to eq(source_name)
-    end
-
-    it 'reports the smell class' do
-      expect(smells[0].smell_category).to eq(described_class.smell_category)
-    end
-
-    it 'reports the smell sub class' do
-      expect(smells[0].smell_type).to eq(described_class.smell_type)
-    end
-
-    it 'reports the envious receiver' do
-      expect(smells[0].parameters[:name]).to eq(receiver)
-    end
-
-    it 'reports the number of references' do
-      expect(smells[0].parameters[:count]).to eq(3)
-    end
+    it_should_behave_like 'common fields set correctly'
 
-    it 'reports the referring lines' do
-      expect(smells[0].lines).to eq([2, 4, 5])
+    it 'reports the correct values' do
+      expect(warning.parameters[:name]).to eq(receiver)
+      expect(warning.parameters[:count]).to eq(3)
+      expect(warning.lines).to eq([2, 4, 5])
     end
   end
 end

data/spec/reek/smells/irresponsible_module_spec.rb

@@ -184,8 +184,7 @@ RSpec.describe Reek::Smells::IrresponsibleModule do
   end
 
   context 'when a smell is reported' do
-    let(:detector) { build(:smell_detector, smell_type: :IrresponsibleModule, source: source_name) }
-    let(:source_name) { 'string' }
+    let(:detector) { build(:smell_detector, smell_type: :IrresponsibleModule) }
 
     it_should_behave_like 'SmellDetector'
   end

data/spec/reek/smells/long_parameter_list_spec.rb

@@ -74,8 +74,7 @@ RSpec.describe Reek::Smells::LongParameterList do
 end
 
 RSpec.describe Reek::Smells::LongParameterList do
-  let(:detector) { build(:smell_detector, smell_type: :LongParameterList, source: source_name) }
-  let(:source_name) { 'string' }
+  let(:detector) { build(:smell_detector, smell_type: :LongParameterList) }
 
   it_should_behave_like 'SmellDetector'
 

data/spec/reek/smells/long_yield_list_spec.rb

@@ -4,8 +4,7 @@ require_lib 'reek/smells/long_yield_list'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::LongYieldList do
-  let(:detector) { build(:smell_detector, smell_type: :LongYieldList, source: source_name) }
-  let(:source_name) { 'string' }
+  let(:detector) { build(:smell_detector, smell_type: :LongYieldList) }
 
   it_should_behave_like 'SmellDetector'
 

data/spec/reek/smells/nested_iterators_spec.rb

@@ -259,8 +259,7 @@ RSpec.describe Reek::Smells::NestedIterators do
 end
 
 RSpec.describe Reek::Smells::NestedIterators do
-  let(:detector) { build(:smell_detector, smell_type: :NestedIterators, source: source_name) }
-  let(:source_name) { 'string' }
+  let(:detector) { build(:smell_detector, smell_type: :NestedIterators) }
 
   it_should_behave_like 'SmellDetector'
 

data/spec/reek/smells/nil_check_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe Reek::Smells::NilCheck do
       end
       EOS
       ctx = Reek::Context::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
-      detector = build(:smell_detector, smell_type: :NilCheck, source: 'source_name')
+      detector = build(:smell_detector, smell_type: :NilCheck)
       smells = detector.examine_context(ctx)
       expect(smells[0].lines).to eq [2]
     end

data/spec/reek/smells/prima_donna_method_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe Reek::Smells::PrimaDonnaMethod do
   end
 
   describe 'the right smell' do
-    let(:detector) { build(:smell_detector, smell_type: :PrimaDonnaMethod, source: 'source_name') }
+    let(:detector) { build(:smell_detector, smell_type: :PrimaDonnaMethod) }
     let(:src)      { 'class C; def m!; end; end' }
     let(:ctx)      do
       Reek::Context::ModuleContext.new(nil,

data/spec/reek/smells/repeated_conditional_spec.rb

@@ -5,8 +5,7 @@ require_relative 'smell_detector_shared'
 require_lib 'reek/source/source_code'
 
 RSpec.describe Reek::Smells::RepeatedConditional do
-  let(:detector) { build(:smell_detector, smell_type: :RepeatedConditional, source: source_name) }
-  let(:source_name) { 'string' }
+  let(:detector) { build(:smell_detector, smell_type: :RepeatedConditional) }
 
   it_should_behave_like 'SmellDetector'
 

data/spec/reek/smells/smell_detector_shared.rb

@@ -20,7 +20,7 @@ end
 
 RSpec.shared_examples_for 'common fields set correctly' do
   it 'reports the source' do
-    expect(warning.source).to eq(source_name)
+    expect(warning.source).to eq('string')
   end
   it 'reports the smell class' do
     expect(warning.smell_category).to eq(detector.smell_category)

data/spec/reek/smells/smell_warning_spec.rb

@@ -66,8 +66,7 @@ RSpec.describe Reek::Smells::SmellWarning do
     context 'smells differing everywhere' do
       let(:first) do
         uncommunicative_name_detector = build(:smell_detector,
-                                              smell_type: 'UncommunicativeVariableName',
-                                              source: true)
+                                              smell_type: 'UncommunicativeVariableName')
         build(:smell_warning, smell_detector: uncommunicative_name_detector,
                               context: 'Dirty',
                               message: "has the variable name '@s'")
@@ -75,8 +74,7 @@ RSpec.describe Reek::Smells::SmellWarning do
 
       let(:second) do
         duplication_detector = build(:smell_detector,
-                                     smell_type: 'DuplicateMethodCall',
-                                     source: false)
+                                     smell_type: 'DuplicateMethodCall')
         build(:smell_warning, smell_detector: duplication_detector,
                               context: 'Dirty#a',
                               message: 'calls @s.title twice')