reek 4.2.3 → 4.2.4

data/lib/reek/smells/too_many_constants.rb

@@ -34,7 +34,7 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def inspect(ctx)
+      def sniff(ctx)
         max_allowed_constants = value(MAX_ALLOWED_CONSTANTS_KEY, ctx)
 
         count = ctx.each_node(:casgn, IGNORED_NODES).delete_if(&:defines_module?).length

data/lib/reek/smells/too_many_instance_variables.rb

@@ -33,7 +33,7 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def inspect(ctx)
+      def sniff(ctx)
         max_allowed_ivars = value(MAX_ALLOWED_IVARS_KEY, ctx)
         count = ctx.local_nodes(:ivasgn).map { |ivasgn| ivasgn.children.first }.uniq.length
         return [] if count <= max_allowed_ivars

data/lib/reek/smells/too_many_methods.rb

@@ -35,7 +35,7 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def inspect(ctx)
+      def sniff(ctx)
         max_allowed_methods = value(MAX_ALLOWED_METHODS_KEY, ctx)
         # TODO: Only checks instance methods!
         actual = ctx.node_instance_methods.length

data/lib/reek/smells/too_many_statements.rb

@@ -27,7 +27,7 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def inspect(ctx)
+      def sniff(ctx)
         max_allowed_statements = value(MAX_ALLOWED_STATEMENTS_KEY, ctx)
         count = ctx.number_of_statements
         return [] if count <= max_allowed_statements

data/lib/reek/smells/uncommunicative_method_name.rb

@@ -36,7 +36,7 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def inspect(context)
+      def sniff(context)
         name = context.name.to_s
         return [] if acceptable_name?(name: name, context: context)
 

data/lib/reek/smells/uncommunicative_module_name.rb

@@ -45,7 +45,7 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def inspect(context)
+      def sniff(context)
         fully_qualified_name = context.full_name
         exp                  = context.exp
         module_name          = exp.simple_name

data/lib/reek/smells/uncommunicative_parameter_name.rb

@@ -38,7 +38,7 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def inspect(context)
+      def sniff(context)
         expression = context.exp
         expression.parameter_names.select do |name|
           sanitized_name = sanitize name

data/lib/reek/smells/uncommunicative_variable_name.rb

@@ -47,7 +47,7 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def inspect(ctx)
+      def sniff(ctx)
         self.reject_names = value(REJECT_KEY, ctx)
         self.accept_names = value(ACCEPT_KEY, ctx)
         variable_names(ctx.exp).select do |name, _lines|

data/lib/reek/smells/unused_parameters.rb

@@ -15,7 +15,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       # :reek:FeatureEnvy
-      def inspect(ctx)
+      def sniff(ctx)
         return [] if ctx.uses_super_with_implicit_arguments?
         ctx.unused_params.map do |param|
           name = param.name.to_s

data/lib/reek/smells/unused_private_method.rb

@@ -37,7 +37,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       # :reek:FeatureEnvy
-      def inspect(ctx)
+      def sniff(ctx)
         hits(ctx).map do |hit|
           name = hit.name
           smell_warning(

data/lib/reek/smells/utility_function.rb

@@ -58,7 +58,7 @@ module Reek
       #
       # :reek:FeatureEnvy
       # :reek:TooManyStatements: { max_statements: 6 }
-      def inspect(ctx)
+      def sniff(ctx)
         return [] if ctx.singleton_method? || ctx.module_function?
         return [] if ctx.references_self?
         return [] if num_helper_methods(ctx).zero?
@@ -67,8 +67,7 @@ module Reek
         [smell_warning(
           context: ctx,
           lines: [ctx.exp.line],
-          message: "doesn't depend on instance state (maybe move it to another class?)",
-          parameters: { name: ctx.full_name })]
+          message: "doesn't depend on instance state (maybe move it to another class?)")]
       end
 
       private

data/lib/reek/spec/should_reek_of.rb

@@ -74,11 +74,24 @@ module Reek
 
       def set_failure_messages_for_smell_details
         self.failure_message = "Expected #{origin} to reek of #{smell_type} "\
-          "(which it did) with smell details #{smell_details}, which it didn't"
+          "(which it did) with smell details #{smell_details}, which it didn't.\n"\
+          "The number of smell details I had to compare with the given one was #{matching_smell_types.count} "\
+          "and here they are:\n"\
+          "#{all_relevant_smell_details_formatted}"
         self.failure_message_when_negated = "Expected #{origin} not to reek of "\
           "#{smell_type} with smell details #{smell_details}, but it did"
       end
 
+      # :reek:FeatureEnvy
+      def all_relevant_smell_details_formatted
+        matching_smell_types.each_with_object([]).with_index do |(smell, accumulator), index|
+          accumulator << "#{index + 1}.)\n"
+          warning_as_hash = smell.smell_warning.to_hash
+          warning_as_hash.delete('smell_type')
+          accumulator << "#{warning_as_hash}\n"
+        end.join
+      end
+
       def origin
         examiner.description
       end

data/lib/reek/version.rb

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

data/samples/checkstyle.xml

@@ -0,0 +1,7 @@
+<?xml version='1.0'?>
+<checkstyle>
+  <file name='samples/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>
+</checkstyle>

data/samples/clean.rb

@@ -0,0 +1,6 @@
+# Well documented Clean class.
+class Clean
+  def hello(argument)
+    say argument
+  end
+end

data/samples/configuration/corrupt.reek

@@ -0,0 +1 @@
+Not a valid configuration file

data/samples/configuration/full_configuration.reek

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

data/{spec/samples/configuration/simple_configuration.reek → samples/configuration/full_mask.reek}

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

data/samples/configuration/non_public_modifiers_mask.reek

@@ -0,0 +1,3 @@
+---
+UtilityFunction:
+  public_methods_only: true

data/samples/configuration/partial_mask.reek

@@ -0,0 +1,3 @@
+---
+UncommunicativeMethodName:
+  enabled: false

data/samples/configuration/with_excluded_paths.reek

@@ -0,0 +1,4 @@
+---
+exclude_paths:
+  - samples/source_with_exclude_paths/ignore_me/
+  - samples/source_with_exclude_paths/nested/ignore_me_as_well

data/samples/paths.rb

@@ -0,0 +1,4 @@
+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')

data/samples/smelly.rb

@@ -0,0 +1,7 @@
+# Smelly class
+class Smelly
+  # This will reek of UncommunicativeMethodName
+  def x
+    y = 10 # This will reek of UncommunicativeVariableName
+  end
+end

data/samples/smelly_with_inline_mask.rb

@@ -0,0 +1,8 @@
+# Smelly class
+# disables :reek:UncommunicativeVariableName
+class Smelly
+  # This will reek of UncommunicativeMethodName
+  def x
+    y = 10 # This will NOT reek of UncommunicativeVariableName
+  end
+end

data/samples/smelly_with_modifiers.rb

@@ -0,0 +1,12 @@
+# Smelly class for testing purposes
+#
+# Not necessary for the feature per se but for
+# removing distracting output. :reek:UnusedPrivateMethod
+#
+class Klass
+  def public_method(arg) arg.to_s; end
+  protected
+  def protected_method(arg) arg.to_s; end
+  private
+  def private_method(arg) arg.to_s; end
+end

data/spec/reek/cli/application_spec.rb

@@ -19,7 +19,7 @@ RSpec.describe Reek::CLI::Application do
     SAMPLES_PATH.join('source_with_exclude_paths/ignore_me/uncommunicative_method_name.rb')
   end
 
-  let(:configuration) { test_configuration_for(SAMPLES_PATH.join('configuration/with_excluded_paths.reek')) }
+  let(:configuration) { test_configuration_for(CONFIG_PATH.join('with_excluded_paths.reek')) }
 
   describe '#execute' do
     let(:command) { double 'reek_command' }

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

@@ -10,9 +10,6 @@ RSpec.describe Reek::CLI::Command::ReportCommand do
     let(:configuration) { double 'configuration' }
     let(:sources) { [source_file] }
 
-    let(:clean_file) { Pathname.glob("#{SAMPLES_PATH}/three_clean_files/*.rb").first }
-    let(:smelly_file) { Pathname.glob("#{SAMPLES_PATH}/two_smelly_files/*.rb").first }
-
     let(:command) do
       described_class.new(options: options,
                           sources: sources,
@@ -24,7 +21,7 @@ RSpec.describe Reek::CLI::Command::ReportCommand do
     end
 
     context 'when no smells are found' do
-      let(:source_file) { clean_file }
+      let(:source_file) { CLEAN_FILE }
 
       it 'returns a success code' do
         result = command.execute
@@ -33,7 +30,7 @@ RSpec.describe Reek::CLI::Command::ReportCommand do
     end
 
     context 'when smells are found' do
-      let(:source_file) { smelly_file }
+      let(:source_file) { SMELLY_FILE }
 
       it 'returns a failure code' do
         result = Reek::CLI::Silencer.silently do

data/spec/reek/configuration/app_configuration_spec.rb

@@ -11,11 +11,13 @@ RSpec.describe Reek::Configuration::AppConfiguration do
       [SAMPLES_PATH.join('two_smelly_files'),
        SAMPLES_PATH.join('source_with_non_ruby_files')]
     end
+
     let(:expected_default_directive) do
       { Reek::Smells::IrresponsibleModule => { 'enabled' => false } }
     end
+
     let(:expected_directory_directives) do
-      { Pathname.new('spec/samples/three_clean_files') =>
+      { SAMPLES_PATH.join('three_clean_files') =>
         { Reek::Smells::UtilityFunction => { 'enabled' => false } } }
     end
 
@@ -24,13 +26,13 @@ RSpec.describe Reek::Configuration::AppConfiguration do
     end
 
     let(:directory_directives_value) do
-      { 'spec/samples/three_clean_files' =>
+      { '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']
+      ['samples/two_smelly_files',
+       'samples/source_with_non_ruby_files']
     end
 
     let(:combined_value) do
@@ -40,7 +42,7 @@ RSpec.describe Reek::Configuration::AppConfiguration do
     end
 
     describe '#from_path' do
-      let(:full_configuration_path) { SAMPLES_PATH.join('configuration/full_configuration.reek') }
+      let(:full_configuration_path) { CONFIG_PATH.join('full_configuration.reek') }
 
       it 'properly loads configuration and processes it' do
         config = described_class.from_path full_configuration_path
@@ -74,14 +76,14 @@ RSpec.describe Reek::Configuration::AppConfiguration do
 
   describe '#directive_for' do
     context 'multiple directory directives and no default directive present' do
-      let(:source_via) { 'spec/samples/three_clean_files/dummy.rb' }
+      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(:directory_directives) do
         {
-          'spec/samples/two_smelly_files' => baz_config,
-          'spec/samples/three_clean_files' => bang_config
+          'samples/two_smelly_files' => baz_config,
+          'samples/three_clean_files' => bang_config
         }
       end
 

data/spec/reek/configuration/configuration_file_finder_spec.rb

@@ -25,47 +25,57 @@ RSpec.describe Reek::Configuration::ConfigurationFileFinder do
     end
 
     it 'returns the file in a parent dir if none in current dir' do
-      found = described_class.find(current: SAMPLES_PATH.join('no_config_file'))
-      expect(found).to eq(SAMPLES_PATH.join('exceptions.reek'))
+      Dir.mktmpdir(nil, SAMPLES_PATH) do |tempdir|
+        found = described_class.find(current: Pathname.new(tempdir))
+        expect(found).to eq(SAMPLES_PATH.join('exceptions.reek'))
+      end
     end
 
     it 'returns the file even if it’s just ‘.reek’' do
-      found = described_class.find(current: SAMPLES_PATH.join('masked_by_dotfile'))
-      expect(found).to eq(SAMPLES_PATH.join('masked_by_dotfile/.reek'))
+      found = described_class.find(current: CONFIG_PATH)
+      expect(found).to eq(CONFIG_PATH.join('.reek'))
     end
 
     it 'returns the file in home if traversing from the current dir fails' do
       skip_if_a_config_in_tempdir
-      Dir.mktmpdir do |tempdir|
-        current = Pathname.new(tempdir)
-        found = described_class.find(current: current, home: SAMPLES_PATH)
+
+      Dir.mktmpdir(nil, SAMPLES_PATH) do |tempdir|
+        found = described_class.find(current: Pathname.new(tempdir))
         expect(found).to eq(SAMPLES_PATH.join('exceptions.reek'))
       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')
+      found = described_class.find(current: SAMPLES_PATH, home: CONFIG_PATH)
       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|
         current = Pathname.new(tempdir)
-        home    = Pathname.new(tempdir)
+        home = Pathname.new(tempdir)
+
         found = described_class.find(current: current, home: home)
+
         expect(found).to be_nil
       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'))
+        dir = Pathname.new(tempdir)
+        subdir = dir.join('subdir')
+
+        FileUtils.mkdir(subdir)
+
+        found = described_class.find(current: subdir, home: dir)
+
         expect(found).to be_nil
       end
     end
@@ -82,9 +92,6 @@ RSpec.describe Reek::Configuration::ConfigurationFileFinder do
     end
 
     describe '.load_from_file' do
-      let(:sample_configuration_path) do
-        SAMPLES_PATH.join('configuration/simple_configuration.reek')
-      end
       let(:sample_configuration_loaded) do
         {
           'UncommunicativeVariableName' => { 'enabled' => false },
@@ -93,7 +100,7 @@ RSpec.describe Reek::Configuration::ConfigurationFileFinder do
       end
 
       it 'loads the configuration from given file' do
-        configuration = described_class.load_from_file(sample_configuration_path)
+        configuration = described_class.load_from_file(CONFIG_PATH.join('full_mask.reek'))
         expect(configuration).to eq(sample_configuration_loaded)
       end
     end