reek 5.4.0 → 6.0.1

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/context_builder_spec.rb

@@ -3,42 +3,126 @@ require_lib 'reek/context_builder'
 
 RSpec.describe Reek::ContextBuilder do
   describe '#context_tree' do
-    let(:walker) do
-      code = 'class Car; def drive; end; end'
-      described_class.new(syntax_tree(code))
+    context 'with some simple example code' do
+      let(:walker) do
+        code = 'class Car; def drive; end; end'
+        described_class.new(syntax_tree(code))
+      end
+      let(:context_tree) { walker.context_tree }
+      let(:module_context) { context_tree.children.first }
+      let(:method_context) { module_context.children.first }
+
+      describe 'the starting node' do
+        it 'is a root node' do
+          expect(context_tree.type).to eq(:root)
+          expect(context_tree).to be_a(Reek::Context::RootContext)
+        end
+
+        it 'has one module_context child' do
+          aggregate_failures do
+            expect(context_tree.children.count).to eq 1
+            expect(module_context).to be_a(Reek::Context::ModuleContext)
+          end
+        end
+      end
+
+      describe 'the module node' do
+        it 'has one method_context child' do
+          aggregate_failures do
+            expect(method_context).to be_a(Reek::Context::MethodContext)
+            expect(module_context.children.size).to eq(1)
+          end
+        end
+
+        it 'holds a reference to the parent context' do
+          expect(method_context.parent).to eq(module_context)
+        end
+      end
     end
-    let(:context_tree) { walker.context_tree }
-    let(:module_context) { context_tree.children.first }
-    let(:method_context) { module_context.children.first }
 
-    it 'starts with a root node' do
-      expect(context_tree.type).to eq(:root)
-      expect(context_tree).to be_a(Reek::Context::RootContext)
+    it 'creates the proper context for all kinds of singleton methods' do
+      src = <<-RUBY
+        class Car
+          def self.start; end
+
+          class << self
+            def drive; end
+          end
+        end
+      RUBY
+
+      syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
+      context_tree = described_class.new(syntax_tree).context_tree
+
+      class_node = context_tree.children.first
+      start_method = class_node.children.first
+      drive_method = class_node.children.last
+
+      expect(start_method).to be_instance_of Reek::Context::SingletonMethodContext
+      expect(drive_method).to be_instance_of Reek::Context::SingletonMethodContext
     end
 
-    it 'has one child' do
-      expect(context_tree.children.size).to eq(1)
+    it 'returns something sensible for nested metaclasses' do
+      src = <<-RUBY
+        class Foo
+          class << self
+            class << self
+              def bar; end
+            end
+          end
+        end
+      RUBY
+
+      syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
+      context_tree = described_class.new(syntax_tree).context_tree
+
+      class_context = context_tree.children.first
+      method_context = class_context.children.first
+
+      expect(method_context).to be_instance_of Reek::Context::SingletonMethodContext
+      expect(method_context.parent).to eq class_context
     end
 
-    describe 'the root node' do
-      it 'has one module_context' do
-        expect(module_context).to be_a(Reek::Context::ModuleContext)
-      end
+    it 'returns something sensible for nested method definitions' do
+      src = <<-RUBY
+        class Foo
+          def foo
+            def bar
+            end
+          end
+        end
+      RUBY
 
-      it 'holds a reference to the parent context' do
-        expect(module_context.parent).to eq(context_tree)
-      end
+      syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
+      context_tree = described_class.new(syntax_tree).context_tree
+
+      class_context = context_tree.children.first
+      foo_context = class_context.children.first
+
+      bar_context = foo_context.children.first
+      expect(bar_context).to be_instance_of Reek::Context::MethodContext
+      expect(bar_context.parent).to eq foo_context
     end
 
-    describe 'the module node' do
-      it 'has one method_context' do
-        expect(method_context).to be_a(Reek::Context::MethodContext)
-        expect(module_context.children.size).to eq(1)
-      end
+    it 'returns something sensible for method definitions nested in singleton methods' do
+      src = <<-RUBY
+        class Foo
+          def self.foo
+            def bar
+            end
+          end
+        end
+      RUBY
 
-      it 'holds a reference to the parent context' do
-        expect(method_context.parent).to eq(module_context)
-      end
+      syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
+      context_tree = described_class.new(syntax_tree).context_tree
+
+      class_context = context_tree.children.first
+      foo_context = class_context.children.first
+
+      bar_context = foo_context.children.first
+      expect(bar_context).to be_instance_of Reek::Context::SingletonMethodContext
+      expect(bar_context.parent).to eq foo_context
     end
   end
 
@@ -370,91 +454,4 @@ RSpec.describe Reek::ContextBuilder do
       expect(nested_baz_context.visibility).to eq :public
     end
   end
-
-  describe '#context_tree' do
-    it 'creates the proper context for all kinds of singleton methods' do
-      src = <<-RUBY
-        class Car
-          def self.start; end
-
-          class << self
-            def drive; end
-          end
-        end
-      RUBY
-
-      syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
-      context_tree = described_class.new(syntax_tree).context_tree
-
-      class_node = context_tree.children.first
-      start_method = class_node.children.first
-      drive_method = class_node.children.last
-
-      expect(start_method).to be_instance_of Reek::Context::SingletonMethodContext
-      expect(drive_method).to be_instance_of Reek::Context::SingletonMethodContext
-    end
-
-    it 'returns something sensible for nested metaclasses' do
-      src = <<-RUBY
-        class Foo
-          class << self
-            class << self
-              def bar; end
-            end
-          end
-        end
-      RUBY
-
-      syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
-      context_tree = described_class.new(syntax_tree).context_tree
-
-      class_context = context_tree.children.first
-      method_context = class_context.children.first
-
-      expect(method_context).to be_instance_of Reek::Context::SingletonMethodContext
-      expect(method_context.parent).to eq class_context
-    end
-
-    it 'returns something sensible for nested method definitions' do
-      src = <<-RUBY
-        class Foo
-          def foo
-            def bar
-            end
-          end
-        end
-      RUBY
-
-      syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
-      context_tree = described_class.new(syntax_tree).context_tree
-
-      class_context = context_tree.children.first
-      foo_context = class_context.children.first
-
-      bar_context = foo_context.children.first
-      expect(bar_context).to be_instance_of Reek::Context::MethodContext
-      expect(bar_context.parent).to eq foo_context
-    end
-
-    it 'returns something sensible for method definitions nested in singleton methods' do
-      src = <<-RUBY
-        class Foo
-          def self.foo
-            def bar
-            end
-          end
-        end
-      RUBY
-
-      syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
-      context_tree = described_class.new(syntax_tree).context_tree
-
-      class_context = context_tree.children.first
-      foo_context = class_context.children.first
-
-      bar_context = foo_context.children.first
-      expect(bar_context).to be_instance_of Reek::Context::SingletonMethodContext
-      expect(bar_context.parent).to eq foo_context
-    end
-  end
 end

data/spec/reek/examiner_spec.rb

@@ -6,6 +6,7 @@ RSpec.shared_examples_for 'no smells found' do
   it 'is not smelly' do
     expect(examiner).not_to be_smelly
   end
+
   it 'finds no smells' do
     expect(examiner.smells.length).to eq(0)
   end

data/spec/reek/report/code_climate/code_climate_configuration_spec.rb

@@ -3,9 +3,7 @@ require_lib 'reek/report/code_climate/code_climate_configuration'
 
 RSpec.describe Reek::Report::CodeClimateConfiguration do
   yml = described_class.load
-  smell_types = Reek::SmellDetectors::BaseDetector.descendants.map do |descendant|
-    descendant.name.demodulize
-  end
+  smell_types = Reek::SmellDetectors::BaseDetector.descendants.map(&:smell_type)
 
   smell_types.each do |name|
     config = yml.fetch(name)

data/spec/reek/report/code_climate/code_climate_fingerprint_spec.rb

@@ -8,12 +8,12 @@ RSpec.describe Reek::Report::CodeClimateFingerprint do
     context 'when fingerprinting a warning with no parameters' do
       let(:expected_fingerprint) { 'e68badd29db51c92363a7c6a2438d722' }
       let(:warning) do
-        build(:smell_warning,
-              smell_detector: Reek::SmellDetectors::UtilityFunction.new,
-              context:        'alfa',
-              message:        "doesn't depend on instance state (maybe move it to another class?)",
-              lines:          lines,
-              source:         'a/ruby/source/file.rb')
+        Reek::SmellWarning.new(
+          'UtilityFunction',
+          context:    'alfa',
+          message:    "doesn't depend on instance state (maybe move it to another class?)",
+          lines:      lines,
+          source:     'a/ruby/source/file.rb')
       end
 
       context 'with code at a specific location' do
@@ -35,12 +35,12 @@ RSpec.describe Reek::Report::CodeClimateFingerprint do
 
     context 'when the fingerprint should not be computed' do
       let(:warning) do
-        build(:smell_warning,
-              smell_detector: Reek::SmellDetectors::ManualDispatch.new,
-              context:        'Alfa#bravo',
-              message:        'manually dispatches method call',
-              lines:          [4],
-              source:         'a/ruby/source/file.rb')
+        Reek::SmellWarning.new(
+          'ManualDispatch',
+          context:    'Alfa#bravo',
+          message:    'manually dispatches method call',
+          lines:      [4],
+          source:     'a/ruby/source/file.rb')
       end
 
       it 'returns nil' do
@@ -50,13 +50,13 @@ RSpec.describe Reek::Report::CodeClimateFingerprint do
 
     context 'when the smell warning has only identifying parameters' do
       let(:warning) do
-        build(:smell_warning,
-              smell_detector: Reek::SmellDetectors::ClassVariable.new,
-              context:        'Alfa',
-              message:        "declares the class variable '@@#{name}'",
-              lines:          [4],
-              parameters:     { name: "@@#{name}" },
-              source:         'a/ruby/source/file.rb')
+        Reek::SmellWarning.new(
+          'ClassVariable',
+          context:    'Alfa',
+          message:    "declares the class variable '@@#{name}'",
+          lines:      [4],
+          parameters: { name: "@@#{name}" },
+          source:     'a/ruby/source/file.rb')
       end
 
       context 'when the name is one thing' do
@@ -80,13 +80,13 @@ RSpec.describe Reek::Report::CodeClimateFingerprint do
 
     context 'when the smell warning has identifying and non-identifying parameters' do
       let(:warning) do
-        build(:smell_warning,
-              smell_detector: Reek::SmellDetectors::DuplicateMethodCall.new,
-              context:        "Alfa##{name}",
-              message:        "calls '#{name}' #{count} times",
-              lines:          lines,
-              parameters:     { name: "@@#{name}", count: count },
-              source:         'a/ruby/source/file.rb')
+        Reek::SmellWarning.new(
+          'DuplicateMethodCall',
+          context:    "Alfa##{name}",
+          message:    "calls '#{name}' #{count} times",
+          lines:      lines,
+          parameters: { name: "@@#{name}", count: count },
+          source:     'a/ruby/source/file.rb')
       end
 
       context 'when the parameters are provided' do

data/spec/reek/report/code_climate/code_climate_formatter_spec.rb

@@ -4,12 +4,12 @@ require_lib 'reek/report/code_climate/code_climate_formatter'
 RSpec.describe Reek::Report::CodeClimateFormatter do
   describe '#render' do
     let(:warning) do
-      build(:smell_warning,
-            smell_detector: Reek::SmellDetectors::UtilityFunction.new,
-            context:        'context foo',
-            message:        'message bar',
-            lines:          [1, 2],
-            source:         'a/ruby/source/file.rb')
+      Reek::SmellWarning.new(
+        'UtilityFunction',
+        context:    'context foo',
+          message:    'message bar',
+          lines:      [1, 2],
+          source:     'a/ruby/source/file.rb')
     end
     let(:rendered) { described_class.new(warning).render }
     let(:json) { JSON.parse rendered.chop }

data/spec/reek/report/code_climate/code_climate_report_spec.rb

@@ -7,7 +7,7 @@ require 'stringio'
 
 RSpec.describe Reek::Report::CodeClimateReport do
   let(:options) { {} }
-  let(:instance) { described_class.new(options) }
+  let(:instance) { described_class.new(**options) }
   let(:examiner) { Reek::Examiner.new(source) }
 
   before do

data/spec/reek/report/json_report_spec.rb

@@ -7,7 +7,7 @@ require 'stringio'
 
 RSpec.describe Reek::Report::JSONReport do
   let(:options) { {} }
-  let(:instance) { described_class.new(options) }
+  let(:instance) { described_class.new(**options) }
   let(:examiner) { Reek::Examiner.new(source) }
 
   before do

data/spec/reek/report/location_formatter_spec.rb

@@ -2,7 +2,7 @@ require_relative '../../spec_helper'
 require_lib 'reek/report/location_formatter'
 
 RSpec.describe Reek::Report::BlankLocationFormatter do
-  let(:warning) { build(:smell_warning, lines: [11, 9, 250, 100]) }
+  let(:warning) { build_smell_warning(lines: [11, 9, 250, 100]) }
 
   describe '.format' do
     it 'returns a blank String regardless of the warning' do
@@ -12,7 +12,7 @@ RSpec.describe Reek::Report::BlankLocationFormatter do
 end
 
 RSpec.describe Reek::Report::DefaultLocationFormatter do
-  let(:warning) { build(:smell_warning, lines: [11, 9, 250, 100]) }
+  let(:warning) { build_smell_warning(lines: [11, 9, 250, 100]) }
 
   describe '.format' do
     it 'returns a prefix with sorted line numbers' do
@@ -22,7 +22,7 @@ RSpec.describe Reek::Report::DefaultLocationFormatter do
 end
 
 RSpec.describe Reek::Report::SingleLineLocationFormatter do
-  let(:warning) { build(:smell_warning, lines: [11, 9, 250, 100]) }
+  let(:warning) { build_smell_warning(lines: [11, 9, 250, 100]) }
 
   describe '.format' do
     it 'returns the first line where the smell was found' do

data/spec/reek/report/text_report_spec.rb

@@ -6,13 +6,7 @@ require_lib 'reek/report/simple_warning_formatter'
 require 'rainbow'
 
 RSpec.describe Reek::Report::TextReport do
-  let(:report_options) do
-    {
-      warning_formatter: Reek::Report::SimpleWarningFormatter.new,
-      heading_formatter: Reek::Report::QuietHeadingFormatter
-    }
-  end
-  let(:instance) { described_class.new report_options }
+  let(:instance) { described_class.new }
 
   context 'with a single empty source' do
     before do

data/spec/reek/report/yaml_report_spec.rb

@@ -7,7 +7,7 @@ require 'stringio'
 
 RSpec.describe Reek::Report::YAMLReport do
   let(:options) { {} }
-  let(:instance) { described_class.new(options) }
+  let(:instance) { described_class.new(**options) }
   let(:examiner) { Reek::Examiner.new(source) }
 
   before do

data/spec/reek/smell_configuration_spec.rb

@@ -18,10 +18,12 @@ RSpec.describe Reek::SmellConfiguration do
     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]/])
       expect(updated).to eq(base_config)
     end
+
     it do
       updated = smell_config.merge('accept' => ['_'], 'enabled' => true)
       expect(updated).to eq(base_config)