reek 4.7.1 → 5.0.0

data/lib/reek/context_builder.rb

@@ -20,8 +20,9 @@ module Reek
   # counting. Ideally `ContextBuilder` would only build up the context tree and leave the
   # statement and reference counting to the contexts.
   #
-  # :reek:TooManyMethods: { max_methods: 31 }
-  # :reek:UnusedPrivateMethod: { exclude: [ !ruby/regexp /process_/ ] }
+  # @quality :reek:TooManyMethods { max_methods: 31 }
+  # @quality :reek:UnusedPrivateMethod { exclude: [ !ruby/regexp /process_/ ] }
+  # @quality :reek:DataClump
   class ContextBuilder
     attr_reader :context_tree
 
@@ -58,10 +59,10 @@ module Reek
     # RootContext -> children: 1 ModuleContext -> children: 1 MethodContext
     #
     # @return [Reek::Context::RootContext] tree of nested contexts
-    def build(exp)
+    def build(exp, parent_exp = nil)
       context_processor = "process_#{exp.type}"
       if context_processor_exists?(context_processor)
-        send(context_processor, exp)
+        send(context_processor, exp, parent_exp)
       else
         process exp
       end
@@ -71,12 +72,12 @@ module Reek
     # Handles every node for which we have no context_processor.
     #
     def process(exp)
-      exp.children.grep(AST::Node).each(&method(:build))
+      exp.children.grep(AST::Node).each { |child| build(child, exp) }
     end
 
     # Handles `module` and `class` nodes.
     #
-    def process_module(exp)
+    def process_module(exp, _parent)
       inside_new_context(Context::ModuleContext, exp) do
         process(exp)
       end
@@ -91,7 +92,7 @@ module Reek
     #   class << self
     #   end
     #
-    def process_sclass(exp)
+    def process_sclass(exp, _parent)
       inside_new_context(Context::GhostContext, exp) do
         process(exp)
       end
@@ -103,9 +104,9 @@ module Reek
     #
     #   Foo = Class.new Bar
     #
-    def process_casgn(exp)
+    def process_casgn(exp, parent)
       if exp.defines_module?
-        process_module(exp)
+        process_module(exp, parent)
       else
         process(exp)
       end
@@ -119,8 +120,8 @@ module Reek
     #
     # Given the above example we would count 2 statements overall.
     #
-    def process_def(exp)
-      inside_new_context(current_context.method_context_class, exp) do
+    def process_def(exp, parent)
+      inside_new_context(current_context.method_context_class, exp, parent) do
         increase_statement_count_by(exp.body)
         process(exp)
       end
@@ -134,8 +135,8 @@ module Reek
     #
     # Given the above example we would count 2 statements overall.
     #
-    def process_defs(exp)
-      inside_new_context(Context::SingletonMethodContext, exp) do
+    def process_defs(exp, parent)
+      inside_new_context(Context::SingletonMethodContext, exp, parent) do
         increase_statement_count_by(exp.body)
         process(exp)
       end
@@ -151,14 +152,14 @@ module Reek
     # we also record to what the method call is referring to
     # which we later use for smell detectors like FeatureEnvy.
     #
-    def process_send(exp)
+    def process_send(exp, _parent)
+      process(exp)
       case current_context
       when Context::ModuleContext
         handle_send_for_modules exp
       when Context::MethodContext
         handle_send_for_methods exp
       end
-      process(exp)
     end
 
     # Handles `op_asgn` nodes a.k.a. Ruby's assignment operators.
@@ -173,7 +174,7 @@ module Reek
     #
     # We record one reference to `x` given the example above.
     #
-    def process_op_asgn(exp)
+    def process_op_asgn(exp, _parent)
       current_context.record_call_to(exp)
       process(exp)
     end
@@ -192,7 +193,7 @@ module Reek
     #
     # We record one reference to `self`.
     #
-    def process_ivar(exp)
+    def process_ivar(exp, _parent)
       current_context.record_use_of_self
       process(exp)
     end
@@ -205,7 +206,7 @@ module Reek
     #
     #   def self.foo; end
     #
-    def process_self(_)
+    def process_self(_exp, _parent)
       current_context.record_use_of_self
     end
 
@@ -225,7 +226,7 @@ module Reek
     #
     # We record one reference to `self`.
     #
-    def process_zsuper(_)
+    def process_zsuper(_exp, _parent)
       current_context.record_use_of_self
     end
 
@@ -249,7 +250,7 @@ module Reek
     #
     # We record one reference to `self`.
     #
-    def process_super(exp)
+    def process_super(exp, _parent)
       current_context.record_use_of_self
       process(exp)
     end
@@ -262,7 +263,7 @@ module Reek
     #
     # Counts non-empty blocks as one statement.
     #
-    def process_block(exp)
+    def process_block(exp, _parent)
       increase_statement_count_by(exp.block)
       process(exp)
     end
@@ -282,7 +283,7 @@ module Reek
     # At the end we subtract one statement because the surrounding context was already counted
     # as one (e.g. via `process_def`).
     #
-    def process_begin(exp)
+    def process_begin(exp, _parent)
       increase_statement_count_by(exp.children)
       decrease_statement_count
       process(exp)
@@ -308,7 +309,7 @@ module Reek
     # `children[1]` refers to the `if` body (so `puts 'bingo'` from above) and
     # `children[2]` to the `else` body (so `3` from above), which might be nil.
     #
-    def process_if(exp)
+    def process_if(exp, _parent)
       children = exp.children
       increase_statement_count_by(children[1])
       increase_statement_count_by(children[2])
@@ -331,7 +332,7 @@ module Reek
     #
     # `children[1]` below refers to the `while` body (so `puts 'bingo'` from above)
     #
-    def process_while(exp)
+    def process_while(exp, _parent)
       increase_statement_count_by(exp.children[1])
       decrease_statement_count
       process(exp)
@@ -354,7 +355,7 @@ module Reek
     #
     # `children[2]` below refers to the `while` body (so `puts i` from above)
     #
-    def process_for(exp)
+    def process_for(exp, _parent)
       increase_statement_count_by(exp.children[2])
       decrease_statement_count
       process(exp)
@@ -384,7 +385,7 @@ module Reek
     # `exp` would be the whole method body wrapped under a `rescue` node.
     # See `process_resbody` for additional reference.
     #
-    def process_rescue(exp)
+    def process_rescue(exp, _parent)
       increase_statement_count_by(exp.children.first)
       decrease_statement_count
       process(exp)
@@ -412,7 +413,7 @@ module Reek
     # `exp` would be the whole `rescue` body.
     # See `process_rescue` for additional reference.
     #
-    def process_resbody(exp)
+    def process_resbody(exp, _parent)
       increase_statement_count_by(exp.children[1..-1].compact)
       process(exp)
     end
@@ -434,7 +435,7 @@ module Reek
     # At the end we subtract one statement because the surrounding context was already counted
     # as one (e.g. via `process_def`).
     #
-    def process_case(exp)
+    def process_case(exp, _parent)
       increase_statement_count_by(exp.else_body)
       decrease_statement_count
       process(exp)
@@ -460,7 +461,7 @@ module Reek
     #
     # Counts the `when` body.
     #
-    def process_when(exp)
+    def process_when(exp, _parent)
       increase_statement_count_by(exp.body)
       process(exp)
     end
@@ -469,7 +470,7 @@ module Reek
       self.class.private_method_defined?(name)
     end
 
-    # :reek:ControlParameter
+    # @quality :reek:ControlParameter
     def increase_statement_count_by(sexp)
       current_context.statement_counter.increase_by sexp
     end
@@ -481,37 +482,35 @@ module Reek
     # Stores a reference to the current context, creates a nested new one,
     # yields to the given block and then restores the previous context.
     #
-    # @param klass [Context::*Context] - context class
-    # @param exp - current expression
+    # @param klass [Context::*Context] context class
+    # @param args arguments for the class initializer
     # @yield block
     #
-    def inside_new_context(klass, exp)
-      new_context = append_new_context(klass, exp)
+    def inside_new_context(klass, *args)
+      new_context = append_new_context(klass, *args)
 
       orig, self.current_context = current_context, new_context
       yield
       self.current_context = orig
     end
 
-    # Append a new child context to the current context but does not change the
-    # current context.
+    # Appends a new child context to the current context but does not change
+    # the current context.
     #
-    # @param klass [Context::*Context] - context class
-    # @param args - arguments for the class initializer
+    # @param klass [Context::*Context] context class
+    # @param args arguments for the class initializer
     #
-    # @return [Context::*Context] - the context that was appended
+    # @return [Context::*Context] the context that was appended
     #
     def append_new_context(klass, *args)
-      klass.new(current_context, *args).tap do |new_context|
+      klass.new(*args).tap do |new_context|
         new_context.register_with_parent(current_context)
       end
     end
 
     def handle_send_for_modules(exp)
-      method_name = exp.name
-      arg_names = exp.arg_names
-      current_context.track_visibility(method_name, arg_names)
-      current_context.track_singleton_visibility(method_name, arg_names)
+      arg_names = exp.args.map { |arg| arg.children.first }
+      current_context.track_visibility(exp.name, arg_names)
       register_attributes(exp)
     end
 

data/lib/reek/detector_repository.rb

@@ -35,31 +35,31 @@ module Reek
                    configuration: {})
       @configuration = configuration
       @smell_types   = smell_types
-      @detectors     = smell_types.map { |klass| klass.new configuration_for(klass) }
     end
 
     def examine(context)
-      smell_detectors_for(context.type).flat_map do |detector|
-        detector.run_for(context)
+      smell_detectors_for(context.type).flat_map do |klass|
+        detector = klass.new configuration: configuration_for(klass), context: context
+        detector.run
       end
     end
 
+    # @return [Array<String>] The names of all known SmellDetectors
+    #         e.g. ["BooleanParameter", "ClassVariable"].
+    def self.available_detector_names
+      smell_types.map(&:smell_type)
+    end
+
     private
 
-    attr_reader :configuration, :smell_types, :detectors
+    attr_reader :configuration, :smell_types
 
     def configuration_for(klass)
       configuration.fetch klass, {}
     end
 
     def smell_detectors_for(type)
-      enabled_detectors.select do |detector|
-        detector.contexts.include? type
-      end
-    end
-
-    def enabled_detectors
-      detectors.select { |detector| detector.config.enabled? }
+      smell_types.select { |detector| detector.contexts.include? type }
     end
   end
 end

data/lib/reek/documentation_link.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Reek
+  # Generate versioned links to our documentation
+  module DocumentationLink
+    HELP_LINK_TEMPLATE = 'https://github.com/troessner/reek/blob/v%<version>s/docs/%<item>s.md'
+
+    module_function
+
+    # Build link to the documentation about the given subject for the current
+    # version of Reek. The subject can be either a smell type like
+    # 'FeatureEnvy' or a general subject like 'Rake Task'.
+    #
+    # @param subject [String]
+    # @return [String] the full URL for the relevant documentation
+    def build(subject)
+      Kernel.format(HELP_LINK_TEMPLATE, version: Version::STRING, item: name_to_param(subject))
+    end
+
+    # Convert the given subject name to a form that is acceptable in a URL.
+    def name_to_param(name)
+      # Splits the subject on the start of capitalized words, optionally
+      # preceded by a space. The space is discarded, the start of the word is
+      # not.
+      name.split(/ *(?=[A-Z][a-z])/).join('-')
+    end
+  end
+end

data/lib/reek/errors/bad_detector_configuration_key_in_comment_error.rb

@@ -1,36 +1,37 @@
 # frozen_string_literal: true
 
 require_relative 'base_error'
+require_relative '../documentation_link'
 
 module Reek
   module Errors
     # Gets raised when trying to configure a detector with an option
     # which is unknown to it.
     class BadDetectorConfigurationKeyInCommentError < BaseError
-      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-EOS.freeze
+      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-MESSAGE
 
-        Error: You are trying to configure the smell detector '%s'
-        in one of your source code comments with the unknown option %s.
-        The source is '%s' and the comment belongs to the expression starting in line %d.
+        Error: You are trying to configure the smell detector '%<detector>s'
+        in one of your source code comments with the unknown option %<option>s.
+        The source is '%<source>s' and the comment belongs to the expression starting in line %<line>d.
         Here's the original comment:
 
-        %s
+        %<comment>s
 
         Please see the Reek docs for:
-          * how to configure Reek via source code comments: https://github.com/troessner/reek/blob/master/docs/Smell-Suppression.md
-          * what basic options are available: https://github.com/troessner/reek/blob/master/docs/Basic-Smell-Options.md
+          * how to configure Reek via source code comments: #{DocumentationLink.build('Smell Suppression')}
+          * what basic options are available: #{DocumentationLink.build('Basic Smell Options')}
           * what custom options are available by checking the detector specific documentation in /docs
         Update the offensive comment (or remove it if no longer applicable) and re-run Reek.
 
-      EOS
+      MESSAGE
 
       def initialize(detector_name:, offensive_keys:, source:, line:, original_comment:)
         message = format(UNKNOWN_SMELL_DETECTOR_MESSAGE,
-                         detector_name,
-                         offensive_keys,
-                         source,
-                         line,
-                         original_comment)
+                         detector: detector_name,
+                         option: offensive_keys,
+                         source: source,
+                         line: line,
+                         comment: original_comment)
         super message
       end
     end

data/lib/reek/errors/bad_detector_in_comment_error.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base_error'
+require_relative '../documentation_link'
 
 module Reek
   module Errors
@@ -8,28 +9,28 @@ module Reek
     # This might happen for multiple reasons. The users might have a typo in
     # his comment or he might use a detector that does not exist anymore.
     class BadDetectorInCommentError < BaseError
-      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-EOS.freeze
+      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-MESSAGE
 
-        Error: You are trying to configure an unknown smell detector '%s' in one
+        Error: You are trying to configure an unknown smell detector '%<detector>s' in one
         of your source code comments.
-        The source is '%s' and the comment belongs to the expression starting in line %d.
+        The source is '%<source>s' and the comment belongs to the expression starting in line %<line>d.
         Here's the original comment:
 
-        %s
+        %<comment>s
 
         Please see the Reek docs for:
-          * how to configure Reek via source code comments: https://github.com/troessner/reek/blob/master/docs/Smell-Suppression.md
-          * what smell detectors are available: https://github.com/troessner/reek/blob/master/docs/Code-Smells.md
+          * how to configure Reek via source code comments: #{DocumentationLink.build('Smell Suppression')}
+          * what smell detectors are available: #{DocumentationLink.build('Code Smells')}
         Update the offensive comment (or remove it if no longer applicable) and re-run Reek.
 
-      EOS
+      MESSAGE
 
       def initialize(detector_name:, source:, line:, original_comment:)
         message = format(UNKNOWN_SMELL_DETECTOR_MESSAGE,
-                         detector_name,
-                         source,
-                         line,
-                         original_comment)
+                         detector: detector_name,
+                         source: source,
+                         line: line,
+                         comment: original_comment)
         super message
       end
     end

data/lib/reek/errors/base_error.rb

@@ -4,6 +4,9 @@ module Reek
   module Errors
     # Base class for all runtime Reek errors
     class BaseError < ::RuntimeError
+      def long_message
+        message
+      end
     end
   end
 end

data/lib/reek/errors/config_file_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+
+module Reek
+  module Errors
+    # Gets raised when Reek is unable to process the source due to bad config file
+    class ConfigFileError < BaseError
+    end
+  end
+end

data/lib/reek/errors/encoding_error.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+
+module Reek
+  module Errors
+    # Gets raised when Reek is unable to process the source due to an EncodingError
+    class EncodingError < BaseError
+      TEMPLATE = "Source '%<source>s' cannot be processed by Reek due to an encoding error in the source file."
+
+      LONG_TEMPLATE = <<-MESSAGE
+        !!!
+        %<message>s
+
+        This is a problem that is outside of Reek's scope and should be fixed by you, the
+        user, in order for Reek being able to continue.
+        Check out this article for an idea on how to get started:
+        https://www.justinweiss.com/articles/3-steps-to-fix-encoding-problems-in-ruby/
+
+        Exception message:
+
+        %<exception>s
+
+        Original backtrace:
+
+        %<original>s
+
+        !!!
+      MESSAGE
+
+      def initialize(origin:)
+        super format(TEMPLATE, source: origin)
+      end
+
+      def long_message
+        format(LONG_TEMPLATE,
+               message: message,
+               exception: cause.inspect,
+               original: cause.backtrace.join("\n\t"))
+      end
+    end
+  end
+end

data/lib/reek/errors/garbage_detector_configuration_in_comment_error.rb

@@ -1,34 +1,35 @@
 # frozen_string_literal: true
 
 require_relative 'base_error'
+require_relative '../documentation_link'
 
 module Reek
   module Errors
     # Gets raised when trying to use a configuration for a detector
     # that can't be parsed into a hash.
     class GarbageDetectorConfigurationInCommentError < BaseError
-      BAD_DETECTOR_CONFIGURATION_MESSAGE = <<-EOS.freeze
+      BAD_DETECTOR_CONFIGURATION_MESSAGE = <<-MESSAGE
 
-        Error: You are trying to configure the smell detector '%s'.
-        Unfortunately we can not parse the configuration you have given.
-        The source is '%s' and the comment belongs to the expression starting in line %d.
+        Error: You are trying to configure the smell detector '%<detector>s'.
+        Unfortunately we cannot parse the configuration you have given.
+        The source is '%<source>s' and the comment belongs to the expression starting in line %<line>d.
         Here's the original comment:
 
-        %s
+        %<comment>s
 
         Please see the Reek docs for:
-          * how to configure Reek via source code comments: https://github.com/troessner/reek/blob/master/docs/Smell-Suppression.md
-          * what smell detectors are available: https://github.com/troessner/reek/blob/master/docs/Code-Smells.md
+          * how to configure Reek via source code comments: #{DocumentationLink.build('Smell Suppression')}
+          * what smell detectors are available: #{DocumentationLink.build('Code Smells')}
         Update the offensive comment (or remove it if no longer applicable) and re-run Reek.
 
-      EOS
+      MESSAGE
 
       def initialize(detector_name:, source:, line:, original_comment:)
         message = format(BAD_DETECTOR_CONFIGURATION_MESSAGE,
-                         detector_name,
-                         source,
-                         line,
-                         original_comment)
+                         detector: detector_name,
+                         source: source,
+                         line: line,
+                         comment: original_comment)
         super message
       end
     end

data/lib/reek/errors/incomprehensible_source_error.rb

@@ -6,42 +6,40 @@ module Reek
   module Errors
     # Gets raised when Reek is unable to process the source
     class IncomprehensibleSourceError < BaseError
-      INCOMPREHENSIBLE_SOURCE_TEMPLATE = <<-EOS.freeze
-        !!!
-        Source %s can not be processed by Reek.
+      TEMPLATE = 'Source %<source>s cannot be processed by Reek.'
 
-        This is most likely either a bug in your Reek configuration (config file or
-        source code comments) or a Reek bug.
+      LONG_TEMPLATE = <<-MESSAGE
+        !!!
+        %<message>s
 
-        Please double check your Reek configuration taking the original exception
-        below into account -  you might have misspelled a smell detector for instance.
-        (In the future Reek will handle configuration errors more gracefully, something
-        we are working on already).
+        This is most likely a Reek bug.
 
-        If you feel that this is not a problem with your Reek configuration but with
-        Reek itself it would be great if you could report this back to the Reek
-        team by opening up a corresponding issue at https://github.com/troessner/reek/issues.
+        It would be great if you could report this back to the Reek team by opening a
+        corresponding issue at https://github.com/troessner/reek/issues.
 
-        Please make sure to include the source in question, the Reek version
-        and the original exception below.
+        Please make sure to include the source in question, the Reek version and the
+        original exception below.
 
         Exception message:
 
-        %s
+        %<exception>s
 
         Original exception:
 
-        %s
+        %<original>s
 
         !!!
-      EOS
-
-      def initialize(origin:, original_exception:)
-        message = format(INCOMPREHENSIBLE_SOURCE_TEMPLATE,
-                         origin,
-                         original_exception.message,
-                         original_exception.backtrace.join("\n\t"))
-        super message
+      MESSAGE
+
+      def initialize(origin:)
+        super format(TEMPLATE, source: origin)
+      end
+
+      def long_message
+        format(LONG_TEMPLATE,
+               message: message,
+               exception: cause.inspect,
+               original: cause.backtrace.join("\n\t"))
       end
     end
   end

data/lib/reek/errors/syntax_error.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+
+module Reek
+  module Errors
+    # Gets raised when Reek is unable to process the source due to a SyntaxError
+    class SyntaxError < BaseError
+      TEMPLATE = "Source '%<source>s' cannot be processed by Reek due to a syntax error in the source file."
+
+      LONG_TEMPLATE = <<-MESSAGE
+        !!!
+        %<message>s
+
+        This is a problem that is outside of Reek's scope and should be fixed by you, the
+        user, in order for Reek being able to continue.
+
+        Exception message:
+
+        %<exception>s
+
+        Original backtrace:
+
+        %<original>s
+
+        !!!
+      MESSAGE
+
+      def initialize(origin:)
+        super format(TEMPLATE, source: origin)
+      end
+
+      def long_message
+        format(LONG_TEMPLATE,
+               message: message,
+               exception: cause.inspect,
+               original: cause.backtrace.join("\n\t"))
+      end
+    end
+  end
+end