reek 3.3.1 → 3.4.0

data/spec/reek/report/yaml_report_spec.rb

@@ -3,18 +3,88 @@ require_relative '../../../lib/reek/examiner'
 require_relative '../../../lib/reek/report/report'
 require_relative '../../../lib/reek/report/formatter'
 
+require 'yaml'
+require 'stringio'
+
 RSpec.describe Reek::Report::YAMLReport do
-  let(:instance) { Reek::Report::YAMLReport.new }
+  let(:options) { {} }
+  let(:instance) { Reek::Report::YAMLReport.new(options) }
+  let(:examiner) { Reek::Examiner.new(source) }
 
-  context 'empty source' do
-    let(:examiner) { Reek::Examiner.new('') }
+  before do
+    instance.add_examiner examiner
+  end
 
-    before do
-      instance.add_examiner examiner
-    end
+  context 'with empty source' do
+    let(:source) { '' }
 
     it 'prints empty yaml' do
       expect { instance.show }.to output(/^--- \[\]\n.*$/).to_stdout
     end
   end
+
+  context 'with smelly source' do
+    let(:source) { 'def simple(a) a[3] end' }
+
+    it 'prints smells as yaml' do
+      out = StringIO.new
+      instance.show(out)
+      out.rewind
+      result = YAML.load(out.read)
+      expected = YAML.load <<-EOS
+---
+- context:        "simple"
+  lines:
+  - 1
+  message:        "doesn't depend on instance state (maybe move it to another class?)"
+  smell_category: "LowCohesion"
+  smell_type:     "UtilityFunction"
+  source:         "string"
+  name:           "simple"
+- context:        "simple"
+  lines:
+  - 1
+  message:        "has the parameter name 'a'"
+  smell_category: "UncommunicativeName"
+  smell_type:     "UncommunicativeParameterName"
+  source:         "string"
+  name:           "a"
+      EOS
+
+      expect(result).to eq expected
+    end
+    context 'with link formatter' do
+      let(:options) { { warning_formatter: Reek::Report::WikiLinkWarningFormatter.new } }
+
+      it 'prints documentation links' do
+        out = StringIO.new
+        instance.show(out)
+        out.rewind
+        result = YAML.load(out.read)
+        expected = YAML.load <<-EOS
+---
+- context:        "simple"
+  lines:
+  - 1
+  message:        "doesn't depend on instance state (maybe move it to another class?)"
+  smell_category: "LowCohesion"
+  smell_type:     "UtilityFunction"
+  source:         "string"
+  name:           "simple"
+  wiki_link:      "https://github.com/troessner/reek/blob/master/docs/Utility-Function.md"
+- context:        "simple"
+  lines:
+  - 1
+  message:        "has the parameter name 'a'"
+  smell_category: "UncommunicativeName"
+  smell_type:     "UncommunicativeParameterName"
+  source:         "string"
+  name:           "a"
+  wiki_link:      "https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Parameter-Name.md"
+        EOS
+
+        expect(result).to eq expected
+      end
+    end
+  end
 end

data/spec/reek/smells/attribute_spec.rb

@@ -4,7 +4,7 @@ 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) { 'dummy_source' }
+  let(:source_name) { 'source' }
 
   it_should_behave_like 'SmellDetector'
 

data/spec/reek/smells/boolean_parameter_spec.rb

@@ -67,15 +67,14 @@ RSpec.describe Reek::Smells::BooleanParameter do
 
   context 'when a smell is reported' do
     let(:detector) { build(:smell_detector, smell_type: :BooleanParameter, source: source_name) }
-    let(:source_name) { 'dummy_source' }
+    let(:source_name) { 'string' }
 
     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)
-      detector.examine(ctx)
-      smells = detector.smells_found.to_a
+      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')

data/spec/reek/smells/class_variable_spec.rb

@@ -6,7 +6,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) { 'dummy_source' }
+  let(:source_name) { 'string' }
 
   it_should_behave_like 'SmellDetector'
 

data/spec/reek/smells/control_parameter_spec.rb

@@ -4,7 +4,7 @@ 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) { 'dummy_source' }
+  let(:source_name) { 'string' }
 
   it_should_behave_like 'SmellDetector'
 

data/spec/reek/smells/data_clump_spec.rb

@@ -42,7 +42,7 @@ RSpec.shared_examples_for 'a data clump detector' do
     end
 
     it 'reports all methods' do
-      expect(smells[0].parameters[:methods]).to eq(['first', 'second', 'third'])
+      expect(smells[0].parameters[:methods]).to eq([:first, :second, :third])
     end
 
     it 'reports the declaration line numbers' do

data/spec/reek/smells/duplicate_method_call_spec.rb

@@ -7,7 +7,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) { 'dummy_source' }
+    let(:source_name) { 'string' }
 
     let(:warning) do
       src = <<-EOS

data/spec/reek/smells/feature_envy_spec.rb

@@ -3,6 +3,7 @@ require_relative '../../../lib/reek/smells/feature_envy'
 require_relative '../../../lib/reek/examiner'
 require_relative 'smell_detector_shared'
 
+# TODO: Bring specs in line with specs for other detectors
 RSpec.describe Reek::Smells::FeatureEnvy do
   context 'with no smell' do
     it 'should not report use of self' do

data/spec/reek/smells/irresponsible_module_spec.rb

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

data/spec/reek/smells/long_parameter_list_spec.rb

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

data/spec/reek/smells/long_yield_list_spec.rb

@@ -5,7 +5,7 @@ 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) { 'dummy_source' }
+  let(:source_name) { 'string' }
 
   it_should_behave_like 'SmellDetector'
 

data/spec/reek/smells/nested_iterators_spec.rb

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

data/spec/reek/smells/repeated_conditional_spec.rb

@@ -6,7 +6,7 @@ require_relative '../../../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) { 'dummy_source' }
+  let(:source_name) { 'string' }
 
   it_should_behave_like 'SmellDetector'
 

data/spec/reek/smells/smell_configuration_spec.rb

@@ -19,21 +19,21 @@ RSpec.describe Reek::Smells::SmellConfiguration do
 
     let(:smell_config) { described_class.new(base_config) }
 
-    it { expect(smell_config.merge!({})).to eq(base_config) }
-    it { expect(smell_config.merge!('enabled' => true)).to eq(base_config) }
-    it { expect(smell_config.merge!('exclude' => [])).to eq(base_config) }
-    it { expect(smell_config.merge!('accept' => ['_'])).to eq(base_config) }
+    it { expect(smell_config.merge({})).to eq(base_config) }
+    it { expect(smell_config.merge('enabled' => true)).to eq(base_config) }
+    it { expect(smell_config.merge('exclude' => [])).to eq(base_config) }
+    it { expect(smell_config.merge('accept' => ['_'])).to eq(base_config) }
     it do
-      updated = smell_config.merge!('reject' => [/^.$/, /[0-9]$/, /[A-Z]/])
+      updated = smell_config.merge('reject' => [/^.$/, /[0-9]$/, /[A-Z]/])
       expect(updated).to eq(base_config)
     end
     it do
-      updated = smell_config.merge!('accept' => ['_'], 'enabled' => true)
+      updated = smell_config.merge('accept' => ['_'], 'enabled' => true)
       expect(updated).to eq(base_config)
     end
 
     it 'should override single values' do
-      updated = smell_config.merge!('enabled' => false)
+      updated = smell_config.merge('enabled' => false)
       expect(updated).to eq('accept'  => ['_'],
                             'enabled' => false,
                             'exclude' => [],
@@ -41,7 +41,7 @@ RSpec.describe Reek::Smells::SmellConfiguration do
     end
 
     it 'should override arrays of values' do
-      updated = smell_config.merge!('reject' => [/^.$/, /[3-9]$/])
+      updated = smell_config.merge('reject' => [/^.$/, /[3-9]$/])
       expect(updated).to eq('accept'  => ['_'],
                             'enabled' => true,
                             'exclude' => [],
@@ -49,7 +49,7 @@ RSpec.describe Reek::Smells::SmellConfiguration do
     end
 
     it 'should override multiple values' do
-      updated = smell_config.merge!('accept' => [/[A-Z]$/], 'enabled' => false)
+      updated = smell_config.merge('accept' => [/[A-Z]$/], 'enabled' => false)
       expect(updated).to eq('accept'  => [/[A-Z]$/],
                             'enabled' => false,
                             'exclude' => [],

data/spec/reek/smells/smell_detector_shared.rb

@@ -1,5 +1,4 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/smell_configuration'
 
 RSpec.shared_examples_for 'SmellDetector' do
   context 'exception matching follows the context' do
@@ -17,14 +16,6 @@ RSpec.shared_examples_for 'SmellDetector' do
       expect(detector.exception?(ctx)).to eq(true)
     end
   end
-
-  context 'configuration' do
-    it 'becomes disabled when disabled' do
-      enabled_key = Reek::Smells::SmellConfiguration::ENABLED_KEY
-      detector.configure_with(enabled_key => false)
-      expect(detector).not_to be_enabled
-    end
-  end
 end
 
 RSpec.shared_examples_for 'common fields set correctly' do

data/spec/reek/smells/smell_repository_spec.rb

@@ -11,19 +11,12 @@ RSpec.describe Reek::Smells::SmellRepository do
       expect(smell_types).to include(Reek::Smells::TooManyStatements)
     end
 
-    it 'should exclude certain smell_types' do
+    it 'should exclude the smell detector base class' do
       expect(smell_types).to_not include(Reek::Smells::SmellDetector)
     end
 
     it 'should return the smell types in alphabetic order' do
       expect(smell_types).to eq(smell_types.sort_by(&:name))
     end
-
-    it "should raise an ArgumentError if smell to configure doesn't exist" do
-      repository = described_class.new
-      expect { repository.configure('SomethingNonExistant', {}) }.
-        to raise_error ArgumentError,
-                       'Unknown smell type SomethingNonExistant found in configuration'
-    end
   end
 end

data/spec/reek/smells/smell_warning_spec.rb

@@ -108,12 +108,13 @@ RSpec.describe Reek::Smells::SmellWarning do
     end
 
     context 'with all details specified' do
-      let(:detector) { Reek::Smells::FeatureEnvy.new source }
+      let(:detector) { Reek::Smells::FeatureEnvy.new }
       let(:parameters) { { 'one' => 34, 'two' => 'second' } }
       let(:smell_type) { 'FeatureEnvy' }
       let(:source) { 'a/ruby/source/file.rb' }
       let(:yaml) do
-        warning = Reek::Smells::SmellWarning.new(detector, context: context_name,
+        warning = Reek::Smells::SmellWarning.new(detector, source: source,
+                                                           context: context_name,
                                                            lines: lines,
                                                            message: message,
                                                            parameters: parameters)

data/spec/reek/smells/too_many_instance_variables_spec.rb

@@ -3,7 +3,7 @@ require_relative '../../../lib/reek/smells/too_many_instance_variables'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::TooManyInstanceVariables do
-  let(:source_name) { 'dummy_source' }
+  let(:source_name) { 'string' }
   let(:detector) do
     build(:smell_detector, smell_type: :TooManyInstanceVariables, source: source_name)
   end

data/spec/reek/smells/too_many_methods_spec.rb

@@ -3,10 +3,8 @@ require_relative '../../../lib/reek/smells/too_many_methods'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::TooManyMethods do
-  let(:detector) { described_class.new(source_name) }
-  let(:source_name) { 'dummy_name' }
-
-  before(:each) { detector.configure_with 'max_methods' => 2 }
+  let(:detector) { described_class.new('max_methods' => 2) }
+  let(:source_name) { 'string' }
 
   it_should_behave_like 'SmellDetector'
 

data/spec/reek/smells/uncommunicative_method_name_spec.rb

@@ -3,7 +3,7 @@ require_relative '../../../lib/reek/smells/uncommunicative_method_name'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::UncommunicativeMethodName do
-  let(:source_name) { 'dummy_source' }
+  let(:source_name) { 'string' }
   let(:detector) do
     build(:smell_detector, smell_type: :UncommunicativeMethodName, source: source_name)
   end

data/spec/reek/smells/uncommunicative_module_name_spec.rb

@@ -4,7 +4,7 @@ require_relative 'smell_detector_shared'
 require_relative '../../../lib/reek/context/code_context'
 
 RSpec.describe Reek::Smells::UncommunicativeModuleName do
-  let(:source_name) { 'dummy_source' }
+  let(:source_name) { 'string' }
   let(:detector) do
     build(:smell_detector, smell_type: :UncommunicativeModuleName, source: source_name)
   end
@@ -40,11 +40,28 @@ RSpec.describe Reek::Smells::UncommunicativeModuleName do
     end
   end
 
-  context 'accepting names' do
-    it 'accepts Inline::C' do
+  context 'accept patterns' do
+    let(:configuration) do
+      default_directive_for_smell = {
+        default_directive: {
+          Reek::Smells::UncommunicativeModuleName => {
+            'accept' => ['Inline::C']
+          }
+        }
+      }
+      Reek::Configuration::AppConfiguration.from_map(default_directive_for_smell)
+    end
+
+    it 'make smelly name pass' do
       src = 'module Inline::C; end'
-      ctx = Reek::Context::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
-      expect(detector.examine_context(ctx)).to be_empty
+
+      expect(src).to_not reek_of(described_class, {}, configuration)
+    end
+
+    it 'reports names with typos' do
+      src = 'module Inline::K; end'
+
+      expect(src).to reek_of(described_class, {}, configuration)
     end
   end
 

data/spec/reek/smells/uncommunicative_parameter_name_spec.rb

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

data/spec/reek/smells/uncommunicative_variable_name_spec.rb

@@ -3,7 +3,7 @@ require_relative '../../../lib/reek/smells/uncommunicative_variable_name'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::UncommunicativeVariableName do
-  let(:source_name) { 'dummy_source' }
+  let(:source_name) { 'string' }
   let(:detector) do
     build(:smell_detector, smell_type: :UncommunicativeVariableName, source: source_name)
   end

data/spec/reek/smells/utility_function_spec.rb

@@ -3,6 +3,7 @@ require_relative '../../../lib/reek/smells/utility_function'
 require_relative '../../../lib/reek/examiner'
 require_relative 'smell_detector_shared'
 
+# TODO: Bring specs in line with specs for other detectors
 RSpec.describe Reek::Smells::UtilityFunction do
   describe 'a detector' do
     let(:detector) { build(:smell_detector, smell_type: :UtilityFunction, source: source_name) }
@@ -213,4 +214,52 @@ RSpec.describe Reek::Smells::UtilityFunction do
       expect(src).not_to reek_of(:UtilityFunction)
     end
   end
+
+  describe 'disabling UtilityFunction via configuration for non-public methods' do
+    let(:configuration) do
+      default_directive = {
+        default_directive: {
+          Reek::Smells::UtilityFunction => {
+            Reek::Smells::UtilityFunction::PUBLIC_METHODS_ONLY_KEY => true
+          }
+        }
+      }
+      Reek::Configuration::AppConfiguration.from_map(default_directive)
+    end
+
+    context 'public methods' do
+      it 'should still report UtilityFunction' do
+        src = <<-EOS
+          class C
+            def m1(a) a.to_s; end
+          end
+        EOS
+        expect(src).to reek_of(:UtilityFunction, { name: 'C#m1' }, configuration)
+      end
+    end
+
+    context 'private methods' do
+      it 'should not report UtilityFunction' do
+        src = <<-EOS
+          class C
+            private
+            def m1(a) a.to_s; end
+          end
+        EOS
+        expect(src).not_to reek_of(:UtilityFunction, {}, configuration)
+      end
+    end
+
+    context 'protected methods' do
+      it 'should not report UtilityFunction' do
+        src = <<-EOS
+          class C
+            protected
+            def m1(a) a.to_s; end
+          end
+        EOS
+        expect(src).not_to reek_of(:UtilityFunction, {}, configuration)
+      end
+    end
+  end
 end