reek 2.2.1 → 3.0.0

data/lib/reek/smells/module_initialize.rb

@@ -1,4 +1,5 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -7,7 +8,8 @@ module Reek
     # hard to tell initialization order and parameters so having 'initialize'
     # in a module is usually a bad idea
     #
-    # See docs/Module-Initialize for details.
+    # See {file:docs/Module-Initialize.md} for details.
+    # @api private
     class ModuleInitialize < SmellDetector
       def self.contexts # :nodoc:
         [:module]

data/lib/reek/smells/nested_iterators.rb

@@ -1,4 +1,5 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -7,7 +8,8 @@ module Reek
     #
     # +NestedIterators+ reports failing methods only once.
     #
-    # See docs/Nested-Iterators for details.
+    # See {file:docs/Nested-Iterators.md} for details.
+    # @api private
     class NestedIterators < SmellDetector
       # The name of the config field that sets the maximum depth
       # of nested iterators to be permitted within any single method.

data/lib/reek/smells/nil_check.rb

@@ -1,11 +1,13 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
     # Checking for nil is a special kind of type check, and therefore a case of
     # SimulatedPolymorphism.
     #
-    # See docs/Nil-Check for details.
+    # See {file:docs/Nil-Check.md} for details.
+    # @api private
     class NilCheck < SmellDetector
       def self.smell_category
         'SimulatedPolymorphism'

data/lib/reek/smells/prima_donna_method.rb

@@ -1,4 +1,5 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -21,7 +22,8 @@ module Reek
     #
     # Such a method is called PrimaDonnaMethod and is reported as a smell.
     #
-    # See docs/Prima-Donna-Method for details.
+    # See {file:docs/Prima-Donna-Method.md} for details.
+    # @api private
     class PrimaDonnaMethod < SmellDetector
       def self.contexts # :nodoc:
         [:class]

data/lib/reek/smells/repeated_conditional.rb

@@ -1,5 +1,6 @@
+require_relative '../ast/node'
 require_relative 'smell_detector'
-require_relative '../core/ast_node'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -22,7 +23,8 @@ module Reek
     # +RepeatedConditional+ checks for multiple conditionals
     # testing the same value throughout a single class.
     #
-    # See docs/Repeated-Conditional for details.
+    # 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.
@@ -33,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]

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,5 +1,5 @@
 require 'set'
-require_relative '../core/smell_configuration'
+require_relative 'smell_configuration'
 
 module Reek
   module Smells
@@ -7,10 +7,12 @@ module Reek
     # Shared responsibilities of all smell detectors.
     #
     # See
-    #   - docs/Basic-Smell-Options
-    #   - docs/Code-Smells
-    #   - docs/Configuration-Files
+    #   - {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
 
@@ -30,7 +32,7 @@ module Reek
 
         def default_config
           {
-            Core::SmellConfiguration::ENABLED_KEY => true,
+            SmellConfiguration::ENABLED_KEY => true,
             EXCLUDE_KEY => DEFAULT_EXCLUDE_SET.dup
           }
         end
@@ -71,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
 
@@ -98,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,12 +1,13 @@
 require_relative '../smells'
-require_relative '../smells/smell_detector'
+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
 

data/lib/reek/smells/smell_warning.rb

@@ -19,10 +19,6 @@ module Reek
         self.parameters     = options.fetch(:parameters, {})
       end
 
-      def smell_classes
-        [smell_detector.smell_category, smell_detector.smell_type]
-      end
-
       def hash
         sort_key.hash
       end
@@ -35,10 +31,12 @@ module Reek
         (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
@@ -58,6 +56,10 @@ module Reek
 
       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)

data/lib/reek/smells/too_many_instance_variables.rb

@@ -1,4 +1,5 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -9,7 +10,8 @@ module Reek
     # +TooManyInstanceVariables' reports classes having more than a
     # configurable number of instance variables.
     #
-    # See docs/Too-Many-Instance-Variables for details.
+    # 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,4 +1,5 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -11,7 +12,8 @@ module Reek
     # methods, and excludes methods inherited from superclasses or included
     # modules.
     #
-    # See docs/Too-Many-Methods for details.
+    # 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,4 +1,5 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -7,7 +8,8 @@ module Reek
     #
     # +TooManyStatements+ reports any method with more than 5 statements.
     #
-    # See docs/Too-Many-Statements for details.
+    # 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,4 +1,5 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -15,7 +16,8 @@ module Reek
     # * 1-character names
     # * names ending with a number
     #
-    # See docs/Uncommunicative-Method-Name for details.
+    # 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,4 +1,5 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -15,7 +16,8 @@ module Reek
     # * 1-character names
     # * names ending with a number
     #
-    # See docs/Uncommunicative-Module-Name for details.
+    # 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,4 +1,5 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -15,7 +16,8 @@ module Reek
     # * 1-character names
     # * names ending with a number
     #
-    # See docs/Uncommunicative-Parameter-Name for details.
+    # 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,4 +1,5 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -15,7 +16,8 @@ module Reek
     # * 1-character names
     # * names ending with a number
     #
-    # See docs/Uncommunicative-Variable-Name for details.
+    # 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_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
     #
     # Methods should use their parameters.
     #
-    # See docs/Unused-Parameters for details.
+    # 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,5 +1,6 @@
+require_relative '../ast/reference_collector'
 require_relative 'smell_detector'
-require_relative '../core/reference_collector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -34,7 +35,8 @@ module Reek
     # If the method does refer to self, but refers to some other object more,
     # +FeatureEnvy+ is reported instead.
     #
-    # See docs/Utility-Function for details.
+    # See {file:docs/Utility-Function.md} for details.
+    # @api private
     class UtilityFunction < SmellDetector
       def self.smell_category
         'LowCohesion'
@@ -52,6 +54,7 @@ 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 method_ctx.references_self?
         return [] if num_helper_methods(method_ctx).zero?

data/lib/reek/source/source_code.rb

@@ -1,15 +1,17 @@
 require_relative '../cli/silencer'
 Reek::CLI::Silencer.silently do
-  require 'parser/current'
+  require 'parser/ruby22'
 end
-require_relative '../core/tree_dresser'
-require_relative '../core/ast_node'
+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 :description
 
@@ -18,7 +20,7 @@ module Reek
       # 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::Ruby21)
+      def initialize(code, description, parser = Parser::Ruby22)
         @source      = code
         @description = description
         @parser      = parser
@@ -30,9 +32,9 @@ module 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`
       #
-      # source - One of File|IO|String
+      # @param source [File|IO|String] - the given source
       #
-      # Returns an instance of SourceCode
+      # @return an instance of SourceCode
       def self.from(source)
         case source
         when File   then new(source.read, source.path)
@@ -41,9 +43,37 @@ module Reek
         end
       end
 
-      # Parses the given source into an AST.
+      # 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
       #
-      #  @return [Reek::Core::ASTNode] the AST presentation of the given source
+      # 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
@@ -53,8 +83,9 @@ module Reek
               $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
-            Core::TreeDresser.new.dress(ast, comment_map)
+            TreeDresser.new.dress(ast, comment_map)
           end
       end
     end