reek 2.0.4 → 3.0.0

data/lib/reek/smells/repeated_conditional.rb

@@ -1,5 +1,6 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative '../ast/node'
+require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -22,6 +23,8 @@ module Reek
     # +RepeatedConditional+ checks for multiple conditionals
     # testing the same value throughout a single class.
     #
+    # See {file:docs/Repeated-Conditional.md} for details.
+    # @api private
     class RepeatedConditional < SmellDetector
       # The name of the config field that sets the maximum number of
       # identical conditionals permitted within any single class.
@@ -32,7 +35,7 @@ module Reek
         'SimulatedPolymorphism'
       end
 
-      BLOCK_GIVEN_CONDITION = AST::Node.new(:send, [nil, :block_given?])
+      BLOCK_GIVEN_CONDITION = ::Parser::AST::Node.new(:send, [nil, :block_given?])
 
       def self.contexts      # :nodoc:
         [:class]
@@ -53,7 +56,7 @@ module Reek
           lines.length > @max_identical_ifs
         end.map do |key, lines|
           occurs = lines.length
-          expression = key.format_ruby
+          expression = key.format_to_ruby
           SmellWarning.new self,
                            context: ctx.full_name,
                            lines: lines,

data/lib/reek/{core → smells}/smell_configuration.rb

@@ -1,8 +1,9 @@
 module Reek
-  module Core
+  module Smells
     #
     # Represents a single set of configuration options for a smell detector
     #
+    # @api private
     class SmellConfiguration
       # The name of the config field that specifies whether a smell is
       # enabled. Set to +true+ or +false+.
@@ -45,6 +46,7 @@ module Reek
     #
     # A set of context-specific overrides for smell detectors.
     #
+    # @api private
     class Overrides
       def initialize(hash)
         @hash = hash

data/lib/reek/smells/smell_detector.rb

@@ -1,12 +1,18 @@
 require 'set'
-require 'reek/smell_warning'
-require 'reek/core/smell_configuration'
+require_relative 'smell_configuration'
 
 module Reek
   module Smells
     #
     # Shared responsibilities of all smell detectors.
     #
+    # See
+    #   - {file:docs/Basic-Smell-Options.md}
+    #   - {file:docs/Code-Smells.md}
+    #   - {file:docs/Configuration-Files.md}
+    # for details.
+    #
+    # @api private
     class SmellDetector
       attr_reader :source
 
@@ -26,7 +32,7 @@ module Reek
 
         def default_config
           {
-            Core::SmellConfiguration::ENABLED_KEY => true,
+            SmellConfiguration::ENABLED_KEY => true,
             EXCLUDE_KEY => DEFAULT_EXCLUDE_SET.dup
           }
         end
@@ -67,7 +73,7 @@ module Reek
 
       def initialize(source, config = self.class.default_config)
         @source = source
-        @config = Core::SmellConfiguration.new(config)
+        @config = SmellConfiguration.new(config)
         @smells_found = []
       end
 
@@ -94,7 +100,7 @@ module Reek
       end
 
       def enabled_for?(context)
-        enabled? && config_for(context)[Core::SmellConfiguration::ENABLED_KEY] != false
+        enabled? && config_for(context)[SmellConfiguration::ENABLED_KEY] != false
       end
 
       def exception?(context)

data/lib/reek/{core → smells}/smell_repository.rb

@@ -1,16 +1,18 @@
-require 'reek/smells'
-require 'reek/smells/smell_detector'
+require_relative '../smells'
+require_relative 'smell_detector'
+require_relative '../configuration/app_configuration'
 
 module Reek
-  module Core
+  module Smells
     #
     # Contains all the existing smells and exposes operations on them.
     #
+    # @api private
     class SmellRepository
       attr_reader :detectors
 
       def self.smell_types
-        Reek::Smells::SmellDetector.descendants
+        Reek::Smells::SmellDetector.descendants.sort_by(&:name)
       end
 
       def initialize(source_description = nil, smell_types = self.class.smell_types)
@@ -23,7 +25,9 @@ module Reek
       end
 
       def configure(klass, config)
-        @detectors[klass].configure_with(config) if @detectors[klass]
+        detector = @detectors[klass]
+        raise ArgumentError, "Unknown smell type #{klass} found in configuration" unless detector
+        detector.configure_with(config)
       end
 
       def report_on(listener)

data/lib/reek/smells/smell_warning.rb

@@ -0,0 +1,101 @@
+require 'forwardable'
+
+module Reek
+  module Smells
+    #
+    # Reports a warning that a smell has been found.
+    #
+    class SmellWarning
+      include Comparable
+      extend Forwardable
+      attr_accessor :smell_detector, :context, :lines, :message, :parameters
+      def_delegators :smell_detector, :smell_category, :smell_type, :source
+
+      def initialize(smell_detector, options = {})
+        self.smell_detector = smell_detector
+        self.context        = options.fetch(:context, '').to_s
+        self.lines          = options.fetch(:lines)
+        self.message        = options.fetch(:message)
+        self.parameters     = options.fetch(:parameters, {})
+      end
+
+      def hash
+        sort_key.hash
+      end
+
+      def <=>(other)
+        sort_key <=> other.sort_key
+      end
+
+      def eql?(other)
+        (self <=> other) == 0
+      end
+
+      # @api private
+      def matches?(klass, other_parameters = {})
+        smell_classes.include?(klass.to_s) && common_parameters_equal?(other_parameters)
+      end
+
+      # @api private
+      def report_on(listener)
+        listener.found_smell(self)
+      end
+
+      def yaml_hash(warning_formatter = nil)
+        stringified_params = Hash[parameters.map { |key, val| [key.to_s, val] }]
+        core_yaml_hash.
+          merge(stringified_params).
+          merge(wiki_link_hash(warning_formatter))
+      end
+
+      protected
+
+      def sort_key
+        [context, message, smell_category]
+      end
+
+      private
+
+      def smell_classes
+        [smell_detector.smell_category, smell_detector.smell_type]
+      end
+
+      def common_parameters_equal?(other_parameters)
+        other_parameters.keys.each do |key|
+          unless parameters.key?(key)
+            raise ArgumentError, "The parameter #{key} you want to check for doesn't exist"
+          end
+        end
+
+        # Why not check for strict parameter equality instead of just the common ones?
+        #
+        # In `self`, `parameters` might look like this:  {:name=>"@other.thing", :count=>2}
+        # Coming from specs, 'other_parameters' might look like this, e.g.:
+        # {:name=>"@other.thing"}
+        # So in this spec we are just specifying the "name" parameter but not the "count".
+        # In order to allow for this kind of leniency we just test for common parameter equality,
+        # not for a strict one.
+        parameters.values_at(*other_parameters.keys) == other_parameters.values
+      end
+
+      def core_yaml_hash
+        {
+          'context'        => context,
+          'lines'          => lines,
+          'message'        => message,
+          'smell_category' => smell_detector.smell_category,
+          'smell_type'     => smell_detector.smell_type,
+          'source'         => smell_detector.source
+        }
+      end
+
+      def wiki_link_hash(warning_formatter)
+        if warning_formatter.respond_to?(:explanatory_link)
+          { 'wiki_link' => warning_formatter.explanatory_link(smell_detector) }
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/reek/smells/too_many_instance_variables.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -10,6 +10,8 @@ module Reek
     # +TooManyInstanceVariables' reports classes having more than a
     # configurable number of instance variables.
     #
+    # See {file:docs/Too-Many-Instance-Variables.md} for details.
+    # @api private
     class TooManyInstanceVariables < SmellDetector
       # The name of the config field that sets the maximum number of instance
       # variables permitted in a class.

data/lib/reek/smells/too_many_methods.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -12,6 +12,8 @@ module Reek
     # methods, and excludes methods inherited from superclasses or included
     # modules.
     #
+    # See {file:docs/Too-Many-Methods.md} for details.
+    # @api private
     class TooManyMethods < SmellDetector
       # The name of the config field that sets the maximum number of methods
       # permitted in a class.

data/lib/reek/smells/too_many_statements.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -8,6 +8,8 @@ module Reek
     #
     # +TooManyStatements+ reports any method with more than 5 statements.
     #
+    # See {file:docs/Too-Many-Statements.md} for details.
+    # @api private
     class TooManyStatements < SmellDetector
       # The name of the config field that sets the maximum number of
       # statements permitted in any method.

data/lib/reek/smells/uncommunicative_method_name.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -16,6 +16,8 @@ module Reek
     # * 1-character names
     # * names ending with a number
     #
+    # See {file:docs/Uncommunicative-Method-Name.md} for details.
+    # @api private
     class UncommunicativeMethodName < SmellDetector
       # The name of the config field that lists the regexps of
       # smelly names to be reported.

data/lib/reek/smells/uncommunicative_module_name.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -16,6 +16,8 @@ module Reek
     # * 1-character names
     # * names ending with a number
     #
+    # See {file:docs/Uncommunicative-Module-Name.md} for details.
+    # @api private
     class UncommunicativeModuleName < SmellDetector
       # The name of the config field that lists the regexps of
       # smelly names to be reported.

data/lib/reek/smells/uncommunicative_parameter_name.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -16,6 +16,8 @@ module Reek
     # * 1-character names
     # * names ending with a number
     #
+    # See {file:docs/Uncommunicative-Parameter-Name.md} for details.
+    # @api private
     class UncommunicativeParameterName < SmellDetector
       # The name of the config field that lists the regexps of
       # smelly names to be reported.

data/lib/reek/smells/uncommunicative_variable_name.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -16,6 +16,8 @@ module Reek
     # * 1-character names
     # * names ending with a number
     #
+    # See {file:docs/Uncommunicative-Variable-Name.md} for details.
+    # @api private
     class UncommunicativeVariableName < SmellDetector
       # The name of the config field that lists the regexps of
       # smelly names to be reported.

data/lib/reek/smells/unused_parameters.rb

@@ -1,11 +1,13 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
     #
     # Methods should use their parameters.
     #
+    # See {file:docs/Unused-Parameters.md} for details.
+    # @api private
     class UnusedParameters < SmellDetector
       def self.smell_category
         'UnusedCode'

data/lib/reek/smells/utility_function.rb

@@ -1,6 +1,6 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
-require 'reek/source/reference_collector'
+require_relative '../ast/reference_collector'
+require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -32,14 +32,12 @@ module Reek
     # reified into a class, and the utility method will most
     # likely belong there.
     #
+    # If the method does refer to self, but refers to some other object more,
+    # +FeatureEnvy+ is reported instead.
+    #
+    # See {file:docs/Utility-Function.md} for details.
+    # @api private
     class UtilityFunction < SmellDetector
-      # The name of the config field that sets the maximum number of
-      # calls permitted within a helper method. Any method with more than
-      # this number of method calls on other objects will be considered a
-      # candidate Utility Function.
-      HELPER_CALLS_LIMIT_KEY = 'max_helper_calls'
-      DEFAULT_HELPER_CALLS_LIMIT = 1
-
       def self.smell_category
         'LowCohesion'
       end
@@ -48,10 +46,6 @@ module Reek
         def contexts      # :nodoc:
           [:def]
         end
-
-        def default_config
-          super.merge(HELPER_CALLS_LIMIT_KEY => DEFAULT_HELPER_CALLS_LIMIT)
-        end
       end
 
       #
@@ -60,11 +54,10 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def examine_context(method_ctx)
+        return [] if method_ctx.exp.singleton_method?
         return [] if method_ctx.num_statements == 0
-        return [] if depends_on_instance?(method_ctx.exp)
-        return [] if num_helper_methods(method_ctx) <= value(HELPER_CALLS_LIMIT_KEY,
-                                                             method_ctx,
-                                                             DEFAULT_HELPER_CALLS_LIMIT)
+        return [] if method_ctx.references_self?
+        return [] if num_helper_methods(method_ctx).zero?
 
         [SmellWarning.new(self,
                           context: method_ctx.full_name,
@@ -75,10 +68,6 @@ module Reek
 
       private
 
-      def depends_on_instance?(exp)
-        Reek::Source::ReferenceCollector.new(exp).num_refs_to_self > 0
-      end
-
       def num_helper_methods(method_ctx)
         method_ctx.local_nodes(:send).length
       end

data/lib/reek/smells.rb

@@ -1,11 +1,24 @@
-require 'require_all'
-
-require_rel 'smells'
-
-module Reek
-  #
-  # This module contains the various smell detectors.
-  #
-  module Smells
-  end
-end
+require_relative 'smells/attribute'
+require_relative 'smells/boolean_parameter'
+require_relative 'smells/class_variable'
+require_relative 'smells/control_parameter'
+require_relative 'smells/data_clump'
+require_relative 'smells/duplicate_method_call'
+require_relative 'smells/feature_envy'
+require_relative 'smells/irresponsible_module'
+require_relative 'smells/long_parameter_list'
+require_relative 'smells/long_yield_list'
+require_relative 'smells/module_initialize'
+require_relative 'smells/nested_iterators'
+require_relative 'smells/nil_check'
+require_relative 'smells/prima_donna_method'
+require_relative 'smells/repeated_conditional'
+require_relative 'smells/too_many_instance_variables'
+require_relative 'smells/too_many_methods'
+require_relative 'smells/too_many_statements'
+require_relative 'smells/uncommunicative_method_name'
+require_relative 'smells/uncommunicative_module_name'
+require_relative 'smells/uncommunicative_parameter_name'
+require_relative 'smells/uncommunicative_variable_name'
+require_relative 'smells/unused_parameters'
+require_relative 'smells/utility_function'

data/lib/reek/source/source_code.rb

@@ -1,32 +1,89 @@
-old_verbose, $VERBOSE = $VERBOSE, nil
-require 'parser/current'
-$VERBOSE = old_verbose
-require 'reek/source/tree_dresser'
-require 'reek/source/ast_node'
+require_relative '../cli/silencer'
+Reek::CLI::Silencer.silently do
+  require 'parser/ruby22'
+end
+require_relative '../tree_dresser'
+require_relative '../ast/node'
 
 module Reek
+  # @api private
   module Source
     #
     # A +Source+ object represents a chunk of Ruby source code.
     #
+    # @api private
     class SourceCode
-      attr_reader :desc
+      attr_reader :description
+
+      # Initializer.
+      #
+      # code        - ruby code as String
+      # description - in case of STDIN this is "STDIN" otherwise it's a filepath as String
+      # parser      - the parser to use for generating AST's out of the given source
+      def initialize(code, description, parser = Parser::Ruby22)
+        @source      = code
+        @description = description
+        @parser      = parser
+      end
 
-      def initialize(code, desc, parser = Parser::Ruby21)
-        @source = code
-        @desc = desc
-        @parser = parser
+      # Initializes an instance of SourceCode given a source.
+      # This source can come via 3 different ways:
+      # - from files a la `reek lib/reek/`
+      # - from IO (STDIN) a la `echo "class Foo; end" | reek`
+      # - from String via our rspec matchers a la `expect("class Foo; end").to reek`
+      #
+      # @param source [File|IO|String] - the given source
+      #
+      # @return an instance of SourceCode
+      def self.from(source)
+        case source
+        when File   then new(source.read, source.path)
+        when IO     then new(source.readlines.join, 'STDIN')
+        when String then new(source, 'string')
+        end
       end
 
+      # Parses the given source into an AST and associates the source code comments with it.
+      # This AST is then traversed by a TreeDresser which adorns the nodes in the AST
+      # with our SexpExtensions.
+      # Finally this AST is returned where each node is an anonymous subclass of Reek::AST::Node
+      #
+      # Important to note is that reek will not fail on unparseable files but rather print out
+      # a warning and then just continue.
+      #
+      # Given this @source:
+      #
+      #   # comment about C
+      #   class C
+      #     def m
+      #       puts 'nada'
+      #     end
+      #   end
+      #
+      # this method would return something that looks like
+      #
+      #   (class
+      #     (const nil :C) nil
+      #     (def :m
+      #       (args)
+      #       (send nil :puts
+      #         (str "nada"))))
+      #
+      # where each node is possibly adorned with our SexpExtensions (see ast/ast_node_class_map
+      # and ast/sexp_extensions for details).
+      #
+      #  @return [Anonymous subclass of Reek::AST::Node] the AST presentation
+      #          for the given source
       def syntax_tree
         @syntax_tree ||=
           begin
             begin
-              ast, comments = @parser.parse_with_comments(@source, @desc)
+              ast, comments = @parser.parse_with_comments(@source, @description)
             rescue Racc::ParseError, Parser::SyntaxError => error
-              $stderr.puts "#{desc}: #{error.class.name}: #{error}"
+              $stderr.puts "#{description}: #{error.class.name}: #{error}"
             end
 
+            # See https://whitequark.github.io/parser/Parser/Source/Comment/Associator.html
             comment_map = Parser::Source::Comment.associate(ast, comments) if ast
             TreeDresser.new.dress(ast, comment_map)
           end

data/lib/reek/source/source_locator.rb

@@ -1,40 +1,55 @@
-require 'reek/source/core_extras'
+require 'find'
 
 module Reek
   module Source
     #
     # Finds Ruby source files in a filesystem.
     #
+    # @api private
     class SourceLocator
+      # Initialize with the paths we want to search.
+      #
+      # paths - a list of paths as Strings
       def initialize(paths)
         @paths = paths.map { |path| path.chomp('/') }
       end
 
-      def all_sources
-        valid_paths.map { |path| File.new(path).to_reek_source }
+      # Traverses all paths we initialized the SourceLocator with, finds
+      # all relevant ruby files and returns them as a list.
+      #
+      # @return [Array<File>] - Ruby files found
+      def sources
+        source_paths.map { |pathname| File.new(pathname) }
       end
 
       private
 
-      def all_ruby_source_files(paths)
-        paths.map do |path|
-          if test 'd', path
-            all_ruby_source_files(Dir["#{path}/**/*.rb"])
-          else
-            path
+      def source_paths
+        relevant_paths = []
+        @paths.map do |given_path|
+          print_no_such_file_error(given_path) && next unless path_exists?(given_path)
+          Find.find(given_path) do |path|
+            pathname = Pathname.new(path)
+            if pathname.directory?
+              exclude_path?(pathname) ? Find.prune : next
+            else
+              relevant_paths << pathname
+            end
           end
-        end.flatten.sort
+        end
+        relevant_paths.flatten.sort
       end
 
-      def valid_paths
-        all_ruby_source_files(@paths).select do |path|
-          if test 'f', path
-            true
-          else
-            $stderr.puts "Error: No such file - #{path}"
-            false
-          end
-        end
+      def exclude_path?(pathname)
+        Configuration::AppConfiguration.exclude_paths.include? pathname.to_s
+      end
+
+      def path_exists?(path)
+        Pathname.new(path).exist?
+      end
+
+      def print_no_such_file_error(path)
+        $stderr.puts "Error: No such file - #{path}"
       end
     end
   end