reek 4.4.2 → 4.5.0

data/lib/reek/{smells → smell_detectors}/unused_parameters.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # Methods should use their parameters.
     #
     # See {file:docs/Unused-Parameters.md} for details.
-    class UnusedParameters < SmellDetector
+    class UnusedParameters < BaseDetector
       #
       # Checks whether the given method has any unused parameters.
       #

data/lib/reek/{smells → smell_detectors}/unused_private_method.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 require_relative '../context/method_context'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # Classes should use their private methods. Otherwise this is dead
     # code which is confusing and bad for maintenance.
     #
     # See {file:docs/Unused-Private-Method.md} for details.
     #
-    class UnusedPrivateMethod < SmellDetector
+    class UnusedPrivateMethod < BaseDetector
       def self.default_config
         super.merge(SmellConfiguration::ENABLED_KEY => false)
       end

data/lib/reek/{smells → smell_detectors}/utility_function.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 require_relative '../ast/reference_collector'
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # A Utility Function is any instance method that has no
     # dependency on the state of the instance.
@@ -37,7 +37,7 @@ module Reek
     # +FeatureEnvy+ is reported instead.
     #
     # See {file:docs/Utility-Function.md} for details.
-    class UtilityFunction < SmellDetector
+    class UtilityFunction < BaseDetector
       PUBLIC_METHODS_ONLY_KEY     = 'public_methods_only'.freeze
       PUBLIC_METHODS_ONLY_DEFAULT = false
 

data/lib/reek/spec/should_reek_of.rb

@@ -25,7 +25,7 @@ module Reek
                      configuration = Configuration::AppConfiguration.default)
         @smell_type = normalize smell_type_or_class
         @smell_details = smell_details
-        configuration.load_values(smell_type => { Smells::SmellConfiguration::ENABLED_KEY => true })
+        configuration.load_values(smell_type => { SmellDetectors::SmellConfiguration::ENABLED_KEY => true })
         @configuration = configuration
       end
 

data/lib/reek/version.rb

@@ -7,6 +7,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '4.4.2'.freeze
+    STRING = '4.5.0'.freeze
   end
 end

data/reek.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.1.0'
   s.summary = 'Code smell detector for Ruby'
 
-  s.add_runtime_dependency 'codeclimate-engine-rb', '~> 0.3.1'
+  s.add_runtime_dependency 'codeclimate-engine-rb', '~> 0.4.0'
   s.add_runtime_dependency 'parser',                '~> 2.3.1', '>= 2.3.1.2'
   s.add_runtime_dependency 'rainbow',               '~> 2.0'
 end

data/spec/factories/factories.rb

@@ -1,6 +1,6 @@
-require_relative '../../lib/reek/smells'
-require_relative '../../lib/reek/smells/smell_detector'
-require_relative '../../lib/reek/smells/smell_warning'
+require_relative '../../lib/reek/smell_detectors'
+require_relative '../../lib/reek/smell_detectors/base_detector'
+require_relative '../../lib/reek/smell_detectors/smell_warning'
 require_relative '../../lib/reek/cli/options'
 
 FactoryGirl.define do
@@ -23,18 +23,18 @@ FactoryGirl.define do
     end
   end
 
-  factory :smell_detector, class: Reek::Smells::SmellDetector do
+  factory :smell_detector, class: Reek::SmellDetectors::BaseDetector do
     skip_create
     transient do
       smell_type 'FeatureEnvy'
     end
 
     initialize_with do
-      ::Reek::Smells.const_get(smell_type).new
+      ::Reek::SmellDetectors.const_get(smell_type).new
     end
   end
 
-  factory :smell_warning, class: Reek::Smells::SmellWarning do
+  factory :smell_warning, class: Reek::SmellDetectors::SmellWarning do
     skip_create
     smell_detector
     context 'self'

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

@@ -23,7 +23,9 @@ RSpec.describe Reek::CLI::Command::ReportCommand do
       let(:source_file) { CLEAN_FILE }
 
       it 'returns a success code' do
-        result = command.execute
+        result = Reek::CLI::Silencer.silently do
+          command.execute
+        end
         expect(result).to eq Reek::CLI::Options::DEFAULT_SUCCESS_EXIT_CODE
       end
     end

data/spec/reek/cli/options_spec.rb

@@ -14,13 +14,23 @@ RSpec.describe Reek::CLI::Options do
     end
 
     it 'enables colors when stdout is a TTY' do
+      allow($stdout).to receive_messages(tty?: true)
+      expect(options.colored).to be true
+    end
+
+    it 'does not enable colors when stdout is not a TTY' do
       allow($stdout).to receive_messages(tty?: false)
       expect(options.colored).to be false
     end
 
-    it 'does not enable colors when stdout is not a TTY' do
+    it 'enables progress when stdout is a TTY' do
       allow($stdout).to receive_messages(tty?: true)
-      expect(options.colored).to be true
+      expect(options.progress_format).to eq :dots
+    end
+
+    it 'does not enable progress when stdout is not a TTY' do
+      allow($stdout).to receive_messages(tty?: false)
+      expect(options.progress_format).to eq :quiet
     end
   end
 

data/spec/reek/code_comment_spec.rb

@@ -1,6 +1,5 @@
 require_relative '../spec_helper'
 require_lib 'reek/code_comment'
-require_lib 'reek/errors'
 
 RSpec.describe Reek::CodeComment do
   context 'with an empty comment' do
@@ -123,11 +122,24 @@ RSpec.describe Reek::CodeComment do
       expect(comment.send(:sanitized_comment)).to eq('Actual comment')
     end
   end
+end
 
-  it 'raises BadConfigurationError on bad comment config' do
-    expect do
-      FactoryGirl.build(:code_comment,
-                        comment: '# :reek:DoesNotExist')
-    end.to raise_error(Reek::BadDetectorInCommentError)
+RSpec.describe Reek::CodeComment::CodeCommentValidator do
+  context 'bad detector' do
+    it 'raises BadDetectorInCommentError' do
+      expect do
+        FactoryGirl.build(:code_comment,
+                          comment: '# :reek:DoesNotExist')
+      end.to raise_error(Reek::Errors::BadDetectorInCommentError)
+    end
+  end
+
+  context 'unparsable detector configuration' do
+    it 'raises GarbageDetectorConfigurationInCommentError' do
+      expect do
+        comment = '# :reek:UncommunicativeMethodName { thats: a: bad: config }'
+        FactoryGirl.build(:code_comment, comment: comment)
+      end.to raise_error(Reek::Errors::GarbageDetectorConfigurationInCommentError)
+    end
   end
 end

data/spec/reek/configuration/app_configuration_spec.rb

@@ -13,12 +13,12 @@ RSpec.describe Reek::Configuration::AppConfiguration do
     end
 
     let(:expected_default_directive) do
-      { Reek::Smells::IrresponsibleModule => { 'enabled' => false } }
+      { Reek::SmellDetectors::IrresponsibleModule => { 'enabled' => false } }
     end
 
     let(:expected_directory_directives) do
       { SAMPLES_PATH.join('three_clean_files') =>
-        { Reek::Smells::UtilityFunction => { 'enabled' => false } } }
+        { Reek::SmellDetectors::UtilityFunction => { 'enabled' => false } } }
     end
 
     let(:default_directive_value) do
@@ -77,8 +77,8 @@ RSpec.describe Reek::Configuration::AppConfiguration do
   describe '#directive_for' do
     context 'multiple directory directives and no default directive present' do
       let(:source_via) { 'samples/three_clean_files/dummy.rb' }
-      let(:baz_config)  { { Reek::Smells::IrresponsibleModule => { enabled: false } } }
-      let(:bang_config) { { Reek::Smells::Attribute => { enabled: true } } }
+      let(:baz_config)  { { Reek::SmellDetectors::IrresponsibleModule => { enabled: false } } }
+      let(:bang_config) { { Reek::SmellDetectors::Attribute => { enabled: true } } }
 
       let(:directory_directives) do
         {
@@ -95,12 +95,12 @@ RSpec.describe Reek::Configuration::AppConfiguration do
 
     context 'directory directive and default directive present' do
       let(:directory) { 'spec/samples/two_smelly_files/' }
-      let(:directory_config) { { Reek::Smells::TooManyStatements => { max_statements: 8 } } }
+      let(:directory_config) { { Reek::SmellDetectors::TooManyStatements => { max_statements: 8 } } }
       let(:directory_directives) { { directory => directory_config } }
       let(:default_directive) do
         {
-          Reek::Smells::IrresponsibleModule => { enabled: false },
-          Reek::Smells::TooManyStatements => { max_statements: 15 }
+          Reek::SmellDetectors::IrresponsibleModule => { enabled: false },
+          Reek::SmellDetectors::TooManyStatements => { max_statements: 15 }
         }
       end
       let(:source_via) { "#{directory}/dummy.rb" }
@@ -110,16 +110,16 @@ RSpec.describe Reek::Configuration::AppConfiguration do
         configuration = described_class.from_hash configuration_as_hash
         actual = configuration.directive_for(source_via)
 
-        expect(actual[Reek::Smells::IrresponsibleModule]).to be_truthy
-        expect(actual[Reek::Smells::TooManyStatements]).to be_truthy
-        expect(actual[Reek::Smells::TooManyStatements][:max_statements]).to eq(8)
+        expect(actual[Reek::SmellDetectors::IrresponsibleModule]).to be_truthy
+        expect(actual[Reek::SmellDetectors::TooManyStatements]).to be_truthy
+        expect(actual[Reek::SmellDetectors::TooManyStatements][:max_statements]).to eq(8)
       end
     end
 
     context 'no directory directive but a default directive present' do
       let(:source_via) { 'spec/samples/three_clean_files/dummy.rb' }
-      let(:default_directive) { { Reek::Smells::IrresponsibleModule => { enabled: false } } }
-      let(:attribute_config) { { Reek::Smells::Attribute => { enabled: false } } }
+      let(:default_directive) { { Reek::SmellDetectors::IrresponsibleModule => { enabled: false } } }
+      let(:attribute_config) { { Reek::SmellDetectors::Attribute => { enabled: false } } }
       let(:directory_directives) do
         { 'spec/samples/two_smelly_files' => attribute_config }
       end

data/spec/reek/configuration/default_directive_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe Reek::Configuration::DefaultDirective do
 
     it 'adds a smell configuration' do
       directives.add :UncommunicativeVariableName, enabled: false
-      expect(directives).to eq(Reek::Smells::UncommunicativeVariableName => { enabled: false })
+      expect(directives).to eq(Reek::SmellDetectors::UncommunicativeVariableName => { enabled: false })
     end
   end
 end

data/spec/reek/configuration/directory_directives_spec.rb

@@ -3,8 +3,8 @@ require_lib 'reek/configuration/directory_directives'
 
 RSpec.describe Reek::Configuration::DirectoryDirectives do
   describe '#directive_for' do
-    let(:baz_config)  { { Reek::Smells::IrresponsibleModule => { enabled: false } } }
-    let(:bang_config) { { Reek::Smells::Attribute => { enabled: true } } }
+    let(:baz_config)  { { Reek::SmellDetectors::IrresponsibleModule => { enabled: false } } }
+    let(:bang_config) { { Reek::SmellDetectors::Attribute => { enabled: true } } }
     let(:directives) do
       {
         Pathname.new('foo/bar/baz')  => baz_config,

data/spec/reek/examiner_spec.rb

@@ -87,7 +87,7 @@ RSpec.describe Reek::Examiner do
       examiner = described_class.new code, filter_by_smells: ['DuplicateMethodCall']
 
       smell = examiner.smells.first
-      expect(smell).to be_a(Reek::Smells::SmellWarning)
+      expect(smell).to be_a(Reek::SmellDetectors::SmellWarning)
       expect(smell.message).to eq("calls 'bar.call_me()' 2 times")
     end
 
@@ -111,13 +111,13 @@ RSpec.describe Reek::Examiner do
       let(:source) { 'class C; def does_crash_reek; end; end' }
 
       let(:examiner) do
-        smell_repository = instance_double 'Reek::Smells::SmellRepository'
-        allow(smell_repository).to receive(:examine) do
+        detector_repository = instance_double 'Reek::SmellDetectors::DetectorRepository'
+        allow(detector_repository).to receive(:examine) do
           raise ArgumentError, 'Looks like bad source'
         end
-        class_double('Reek::Smells::SmellRepository').as_stubbed_const
-        allow(Reek::Smells::SmellRepository).to receive(:eligible_smell_types)
-        allow(Reek::Smells::SmellRepository).to receive(:new).and_return smell_repository
+        class_double('Reek::SmellDetectors::DetectorRepository').as_stubbed_const
+        allow(Reek::SmellDetectors::DetectorRepository).to receive(:eligible_smell_types)
+        allow(Reek::SmellDetectors::DetectorRepository).to receive(:new).and_return detector_repository
 
         described_class.new source
       end
@@ -128,46 +128,74 @@ RSpec.describe Reek::Examiner do
         end
       end
 
-      it 'outputs the origin to STDERR' do
+      it 'prints the origin' do
         origin = 'string'
         expect { examiner.smells }.to output(/#{origin}/).to_stderr
       end
 
-      it 'explains what to do to STDERR' do
-        explanation = 'It would be great if you could report this back to the Reek team'
+      it 'explains what to do' do
+        explanation = 'Please double check your Reek configuration'
         expect { examiner.smells }.to output(/#{explanation}/).to_stderr
       end
 
-      it 'outputs the original exception to STDERR' do
-        original = '#<ArgumentError: Looks like bad source>'
+      it 'contains a message' do
+        original = 'Looks like bad source'
         expect { examiner.smells }.to output(/#{original}/).to_stderr
       end
     end
   end
 
   describe 'bad comment config' do
-    let(:source) do
-      <<-EOS
-        # :reek:DoesNotExist
-        def alfa; end
-      EOS
-    end
+    context 'unknown smell detector' do
+      let(:source) do
+        <<-EOS
+          # :reek:DoesNotExist
+          def alfa; end
+        EOS
+      end
 
-    it 'prints out a proper message' do
-      expected_output = "You are trying to configure an unknown smell detector 'DoesNotExist'"
+      it 'prints out a proper message' do
+        expected_output = "You are trying to configure an unknown smell detector 'DoesNotExist'"
 
-      expect do
-        described_class.new(source).smells
-      end.to output(/#{expected_output}/).to_stderr
+        expect do
+          described_class.new(source).smells
+        end.to output(/#{expected_output}/).to_stderr
+      end
+
+      it 'prints out a line and a source' do
+        expected_output = "The source is 'string' and the comment belongs "\
+                          'to the expression starting in line 2.'
+
+        expect do
+          described_class.new(source).smells
+        end.to output(/#{expected_output}/).to_stderr
+      end
     end
 
-    it 'prints out a line and a source' do
-      expected_output = "The source is 'string' and the comment belongs "\
-                        'to the expression starting in line 2.'
+    context 'garbage in detector config' do
+      let(:source) do
+        <<-EOS
+          # :reek:UncommunicativeMethodName { thats: a: bad: config }
+          def alfa; end
+        EOS
+      end
+
+      it 'prints out a proper message' do
+        expected_output = "Error: You are trying to configure the smell detector 'UncommunicativeMethodName'"
 
-      expect do
-        described_class.new(source).smells
-      end.to output(/#{expected_output}/).to_stderr
+        expect do
+          described_class.new(source).smells
+        end.to output(/#{expected_output}/).to_stderr
+      end
+
+      it 'prints out a line and a source' do
+        expected_output = "The source is 'string' and "\
+                          'the comment belongs to the expression starting in line 2'
+
+        expect do
+          described_class.new(source).smells
+        end.to output(/#{expected_output}/).to_stderr
+      end
     end
   end
 end

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

@@ -0,0 +1,122 @@
+require_relative '../../../spec_helper'
+require_lib 'reek/report/code_climate/code_climate_fingerprint'
+
+RSpec.describe Reek::Report::CodeClimateFingerprint do
+  describe '#compute' do
+    let(:computed) { described_class.new(warning).compute }
+
+    shared_examples_for 'computes a fingerprint with no parameters' do
+      let(:expected_fingerprint) { 'e68badd29db51c92363a7c6a2438d722' }
+      let(:warning) do
+        FactoryGirl.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')
+      end
+
+      it 'it computes the fingerprint' do
+        expect(computed).to eq expected_fingerprint
+      end
+    end
+
+    context 'with code at a specific location' do
+      let(:lines) { [1] }
+      it_should_behave_like 'computes a fingerprint with no parameters'
+    end
+
+    context 'with code at a different location' do
+      let(:lines) { [5] }
+      it_should_behave_like 'computes a fingerprint with no parameters'
+    end
+
+    context 'when the fingerprint should not be computed' do
+      let(:warning) do
+        FactoryGirl.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')
+      end
+
+      it 'it returns nil' do
+        expect(computed).to be_nil
+      end
+    end
+
+    shared_examples_for 'computes a fingerprint with identifying parameters' do
+      let(:warning) do
+        FactoryGirl.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')
+      end
+
+      it 'computes the fingerprint' do
+        expect(computed).to eq expected_fingerprint
+      end
+    end
+
+    context 'when the name is one thing it has one fingerprint' do
+      let(:name) { 'bravo' }
+      let(:expected_fingerprint) { '9c3fd378178118a67e9509f87cae24f9' }
+
+      it_should_behave_like 'computes a fingerprint with identifying parameters'
+    end
+
+    context 'when the name is another thing it has another fingerprint' do
+      let(:name) { 'echo' }
+      let(:expected_fingerprint) { 'd2a6d2703ce04cca65e7300b7de4b89f' }
+
+      it_should_behave_like 'computes a fingerprint with identifying parameters'
+    end
+
+    shared_examples_for 'computes a fingerprint with identifying and non-identifying parameters' do
+      let(:warning) do
+        FactoryGirl.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')
+      end
+
+      it 'computes the fingerprint' do
+        expect(computed).to eq expected_fingerprint
+      end
+    end
+
+    context 'when the parameters are provided' do
+      let(:name) { 'bravo' }
+      let(:count) { 5 }
+      let(:lines) { [1, 7, 10, 13, 15] }
+      let(:expected_fingerprint) { '238733f4f51ba5473dcbe94a43ec5400' }
+
+      it_should_behave_like 'computes a fingerprint with identifying and non-identifying parameters'
+    end
+
+    context 'when the non-identifying parameters change, it computes the same fingerprint' do
+      let(:name) { 'bravo' }
+      let(:count) { 9 }
+      let(:lines) { [1, 7, 10, 13, 15, 17, 19, 20, 25] }
+      let(:expected_fingerprint) { '238733f4f51ba5473dcbe94a43ec5400' }
+
+      it_should_behave_like 'computes a fingerprint with identifying and non-identifying parameters'
+    end
+
+    context 'but when the identifying parameters change, it computes a different fingerprint' do
+      let(:name) { 'echo' }
+      let(:count) { 5 }
+      let(:lines) { [1, 7, 10, 13, 15] }
+      let(:expected_fingerprint) { 'e0c35e9223cc19bdb9a04fb3e60573e1' }
+
+      it_should_behave_like 'computes a fingerprint with identifying and non-identifying parameters'
+    end
+  end
+end