reek 6.0.2 → 6.2.0

data/lib/reek/errors/syntax_error.rb

@@ -31,7 +31,7 @@ module Reek
       MESSAGE
 
       def initialize(origin:)
-        super format(TEMPLATE, source: origin)
+        super(format(TEMPLATE, source: origin))
       end
 
       def long_message

data/lib/reek/rake/task.rb

@@ -69,15 +69,15 @@ module Reek
 
       # @public
       def initialize(name = :reek)
-        @config_file   = ENV['REEK_CFG']
+        @config_file   = ENV.fetch('REEK_CFG', nil)
         @name          = name
-        @reek_opts     = ENV['REEK_OPTS'] || ''
+        @reek_opts     = ENV.fetch('REEK_OPTS', '')
         @fail_on_error = true
         @verbose       = false
 
         yield self if block_given?
 
-        if (reek_src = ENV['REEK_SRC'])
+        if (reek_src = ENV.fetch('REEK_SRC', nil))
           @source_files = FileList[reek_src]
         end
         @source_files ||= FileList['lib/**/*.rb']
@@ -87,8 +87,8 @@ module Reek
       # @public
       def source_files=(files)
         unless files.is_a?(String) || files.is_a?(FileList)
-          raise ArgumentError, 'File list should be a FileList or a String that can contain'\
-            " a glob pattern, e.g. '{app,lib,spec}/**/*.rb'"
+          raise ArgumentError, 'File list should be a FileList or a String that can contain ' \
+                               "a glob pattern, e.g. '{app,lib,spec}/**/*.rb'"
         end
         @source_files = FileList[files]
       end

data/lib/reek/smell_detectors/base_detector.rb

@@ -90,7 +90,7 @@ module Reek
 
       class << self
         def smell_type
-          @smell_type ||= name.split(/::/).last
+          @smell_type ||= name.split('::').last
         end
 
         def contexts

data/lib/reek/smell_detectors/class_variable.rb

@@ -25,8 +25,8 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
-        class_variables_in_context.map do |variable, occurences|
-          lines = occurences.map(&:line)
+        class_variables_in_context.map do |variable, occurrences|
+          lines = occurrences.map(&:line)
           smell_warning(
             lines: lines,
             message: "declares the class variable '#{variable}'",

data/lib/reek/smell_detectors/control_parameter_helpers/candidate.rb

@@ -9,20 +9,20 @@ module Reek
       class Candidate
         #
         # @param parameter [Symbol] the parameter name
-        # @param occurences [Array<Reek::AST::Node>] the occurences of the ControlParameter smell
+        # @param occurrences [Array<Reek::AST::Node>] the occurrences of the ControlParameter smell
         #   e.g. [s(:lvar, :bravo), s(:lvar, :bravo)]
         #
-        def initialize(parameter, occurences)
+        def initialize(parameter, occurrences)
           @parameter = parameter
-          @occurences = occurences
+          @occurrences = occurrences
         end
 
         def smells?
-          occurences.any?
+          occurrences.any?
         end
 
         def lines
-          occurences.map(&:line)
+          occurrences.map(&:line)
         end
 
         def name
@@ -31,7 +31,7 @@ module Reek
 
         private
 
-        attr_reader :occurences, :parameter
+        attr_reader :occurrences, :parameter
       end
     end
   end

data/lib/reek/smell_detectors/control_parameter_helpers/control_parameter_finder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './call_in_condition_finder'
+require_relative 'call_in_condition_finder'
 require_relative '../../ast/node'
 
 module Reek

data/lib/reek/smell_detectors/duplicate_method_call.rb

@@ -67,11 +67,11 @@ module Reek
       class FoundCall
         def initialize(call_node)
           @call_node = call_node
-          @occurences = []
+          @occurrences = []
         end
 
         def record(occurence)
-          occurences.push occurence
+          occurrences.push occurence
         end
 
         def call
@@ -79,16 +79,16 @@ module Reek
         end
 
         def occurs
-          occurences.length
+          occurrences.length
         end
 
         def lines
-          occurences.map(&:line)
+          occurrences.map(&:line)
         end
 
         private
 
-        attr_reader :call_node, :occurences
+        attr_reader :call_node, :occurrences
       end
 
       private_constant :FoundCall

data/lib/reek/smell_detectors/instance_variable_assumption.rb

@@ -20,7 +20,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
-        assumptions = (variables_from_context - variables_from_initialize).uniq
+        assumptions = (variables_from_context - variables_from_initializers).uniq
 
         assumptions.map do |assumption|
           build_smell_warning(assumption)
@@ -42,14 +42,14 @@ module Reek
           parameters: { assumption: assumption.to_s })
       end
 
-      def variables_from_initialize
-        initialize_exp = method_expressions.detect do |method|
-          method.name == :initialize
-        end
-
-        return [] unless initialize_exp
+      def variables_from_initializers
+        variables_from_initialize.map do |method|
+          method.each_node(:ivasgn).map(&:name)
+        end.flatten
+      end
 
-        initialize_exp.each_node(:ivasgn).map(&:name)
+      def variables_from_initialize
+        method_expressions.select { |method| method.name == :initialize }
       end
 
       def variables_from_context

data/lib/reek/smell_detectors/nested_iterators.rb

@@ -26,7 +26,7 @@ module Reek
       # The name of the config field that sets the names of any
       # methods for which nesting should not be considered
       IGNORE_ITERATORS_KEY = 'ignore_iterators'
-      DEFAULT_IGNORE_ITERATORS = ['tap'].freeze
+      DEFAULT_IGNORE_ITERATORS = ['tap', 'Tempfile.create'].freeze
 
       def self.default_config
         super.merge(
@@ -128,8 +128,9 @@ module Reek
 
       # @quality :reek:FeatureEnvy
       def ignored_iterator?(exp)
-        ignore_iterators.any? { |pattern| /#{pattern}/ =~ exp.call.name } ||
-          exp.without_block_arguments?
+        ignore_iterators.any? do |pattern|
+          /#{pattern}/ =~ exp.call.format_to_ruby
+        end || exp.without_block_arguments?
       end
     end
   end

data/lib/reek/smell_detectors/unused_private_method.rb

@@ -50,9 +50,9 @@ module Reek
       # @return [Array<Hit>]
       #
       def hits
-        unused_private_methods.map do |defined_method|
+        unused_private_methods.filter_map do |defined_method|
           Hit.new(defined_method) unless ignore_method?(defined_method)
-        end.compact
+        end
       end
 
       #
@@ -61,6 +61,7 @@ module Reek
       def unused_private_methods
         defined_private_methods = context.defined_instance_methods(visibility: :private)
         called_method_names     = context.instance_method_calls.map(&:name)
+        called_method_names.concat(context.instance_method_names_via_to_call)
 
         defined_private_methods.reject do |defined_method|
           called_method_names.include?(defined_method.name)

data/lib/reek/smell_warning.rb

@@ -59,7 +59,7 @@ module Reek
 
     # @public
     def to_hash
-      stringified_params = Hash[parameters.map { |key, val| [key.to_s, val] }]
+      stringified_params = parameters.transform_keys(&:to_s)
       base_hash.merge(stringified_params)
     end
 

data/lib/reek/source/source_locator.rb

@@ -62,10 +62,8 @@ module Reek
 
             false
           end
-        elsif path_excluded?(path)
-          true
         else
-          false
+          path_excluded?(path)
         end
       end
 

data/lib/reek/spec/should_reek_of.rb

@@ -69,19 +69,21 @@ module Reek
       end
 
       def set_failure_messages_for_smell_type
-        self.failure_message = "Expected #{origin} to reek of #{smell_type}, "\
-          'but it didn\'t'
-        self.failure_message_when_negated = "Expected #{origin} not to reek "\
-          "of #{smell_type}, but it did"
+        self.failure_message = "Expected #{origin} to reek of #{smell_type}, " \
+                               'but it didn\'t'
+        self.failure_message_when_negated = "Expected #{origin} not to reek " \
+                                            "of #{smell_type}, but it did"
       end
 
       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.\n"\
-          "The number of smell details I had to compare with the given one was #{matching_smell_types.count} "\
-          "and here they are:\n"\
+        self.failure_message =
+          "Expected #{origin} to reek of #{smell_type} " \
+          "(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 "\
+        self.failure_message_when_negated =
+          "Expected #{origin} not to reek of " \
           "#{smell_type} with smell details #{smell_details}, but it did"
       end
 

data/lib/reek/spec.rb

@@ -92,7 +92,7 @@ module Reek
     end
 
     #
-    # See the documentaton for "reek_of".
+    # See the documentation for "reek_of".
     #
     # Notable differences to reek_of:
     #   1.) "reek_of" doesn't mind if there are other smells of a different type.

data/lib/reek/version.rb

@@ -3,11 +3,11 @@
 # @public
 module Reek
   #
-  # This module holds the Reek version informations
+  # This module holds the Reek version information
   #
   # @public
   module Version
     # @public
-    STRING = '6.0.2'
+    STRING = '6.2.0'
   end
 end

data/reek.gemspec

@@ -1,34 +1,38 @@
-require File.join(File.dirname(__FILE__), 'lib/reek/version')
+require_relative 'lib/reek/version'
 
-Gem::Specification.new do |s|
-  s.name = 'reek'
-  s.version = Reek::Version::STRING
+Gem::Specification.new do |spec|
+  spec.name = 'reek'
+  spec.version = Reek::Version::STRING
+  spec.authors = ['Kevin Rutherford', 'Timo Roessner', 'Matijs van Zuijlen', 'Piotr Szotkowski']
+  spec.email = ['timo.roessner@googlemail.com']
 
-  s.authors = ['Kevin Rutherford', 'Timo Roessner', 'Matijs van Zuijlen', 'Piotr Szotkowski']
-  s.description =
+  spec.summary = 'Code smell detector for Ruby'
+  spec.description =
     'Reek is a tool that examines Ruby classes, modules and methods and reports ' \
     'any code smells it finds.'
+  spec.homepage = 'https://github.com/troessner/reek'
+  spec.license = 'MIT'
 
-  s.license = 'MIT'
-  s.email = ['timo.roessner@googlemail.com']
-  s.extra_rdoc_files = ['CHANGELOG.md', 'License.txt']
-  s.files = `git ls-files -z`.split("\0")
-  s.executables = s.files.grep(%r{^bin/}).map { |path| File.basename(path) }
-  s.homepage = 'https://github.com/troessner/reek'
-  s.rdoc_options = %w(--main README.md -x assets/|bin/|config/|features/|spec/|tasks/)
-  s.required_ruby_version = '>= 2.4.0'
-  s.summary = 'Code smell detector for Ruby'
+  spec.extra_rdoc_files = ['CHANGELOG.md', 'License.txt']
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|samples|docs|tasks)/}) }
+  end
 
-  s.metadata = {
-    'homepage_uri'      => 'https://github.com/troessner/reek',
-    'source_code_uri'   => 'https://github.com/troessner/reek',
-    'bug_tracker_uri'   => 'https://github.com/troessner/reek/issues',
-    'changelog_uri'     => 'https://github.com/troessner/reek/CHANGELOG.md',
-    'documentation_uri' => 'https://www.rubydoc.info/gems/reek'
+  spec.executables = spec.files.grep(%r{^bin/}).map { |path| File.basename(path) }
+  spec.rdoc_options = %w(--main README.md -x assets/|bin/|config/|features/|spec/|tasks/)
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata = {
+    'homepage_uri'          => 'https://github.com/troessner/reek',
+    'source_code_uri'       => 'https://github.com/troessner/reek',
+    'bug_tracker_uri'       => 'https://github.com/troessner/reek/issues',
+    'changelog_uri'         => 'https://github.com/troessner/reek/CHANGELOG.md',
+    'documentation_uri'     => 'https://www.rubydoc.info/gems/reek',
+    'rubygems_mfa_required' => 'true'
   }
 
-  s.add_runtime_dependency 'kwalify', '~> 0.7.0'
-  s.add_runtime_dependency 'parser',  '< 2.8', '>= 2.5.0.0', '!= 2.5.1.1'
-  s.add_runtime_dependency 'psych',   '~> 3.1'
-  s.add_runtime_dependency 'rainbow', '>= 2.0', '< 4.0'
+  spec.add_runtime_dependency 'dry-schema', '~> 1.13.0'
+  spec.add_runtime_dependency 'parser',  '~> 3.2.0'
+  spec.add_runtime_dependency 'rainbow', '>= 2.0', '< 4.0'
+  spec.add_runtime_dependency 'rexml',   '~> 3.1'
 end