reek 3.3.1 → 3.4.0

data/features/step_definitions/sample_file_steps.rb

@@ -72,25 +72,6 @@ Given(/^a smelly file called 'smelly.rb'( in a subdirectory)?$/) do |in_subdir|
   EOS
 end
 
-Given(/^a file with smelly variable names called 'camel_case.rb'$/) do
-  write_file('camel_case.rb', <<-EOS.strip_heredoc)
-    # Class containing camelCase variable which would normally smell
-    class CamelCase
-      def initialize
-        # These next two would normally smell if it weren't for overridden config values
-        camelCaseVariable = []
-        anotherOne = 1
-
-        # this next one should still smell
-        x1 = 0
-
-        # this next one should not smell
-        should_not_smell = true
-      end
-    end
-  EOS
-end
-
 Given(/^an empty configuration file called 'empty.reek'$/) do
   write_file('empty.reek', '')
 end
@@ -118,17 +99,6 @@ Given(/^a configuration file masking some duplication smells called 'config.reek
   EOS
 end
 
-Given(/^a configuration file allowing camel case variables$/) do
-  write_file('config.reek', <<-EOS.strip_heredoc)
-    ---
-    UncommunicativeVariableName:
-      enabled: true
-      reject:
-      - !ruby/regexp /^.$/
-      - !ruby/regexp /[0-9]$/
-  EOS
-end
-
 When(/^I run "reek (.*?)" in the subdirectory$/) do |args|
   cd 'subdir'
   reek(args)
@@ -156,3 +126,28 @@ Given(/^an enabling configuration file in the subdirectory$/) do
       enabled: true
   EOS
 end
+
+Given(/^a smelly file called 'smelly.rb' with private, protected and public UtilityFunction methods$/) do
+  write_file 'smelly.rb', <<-EOS.strip_heredoc
+    # smelly class for testing purposes
+    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
+  EOS
+end
+
+Given(/^a configuration file disabling UtilityFunction for non-public methods called 'config.reek'$/) do
+  write_file('config.reek', <<-EOS.strip_heredoc)
+    ---
+    UtilityFunction:
+      public_methods_only: true
+  EOS
+end
+
+Then(/^it does not report private or protected methods$/) do
+  # Pseudo step for feature clarity.
+end

data/lib/reek/ast/ast_node_class_map.rb

@@ -6,7 +6,6 @@ module Reek
     # Maps AST node types to sublasses of ASTNode extended with the relevant
     # utility modules.
     #
-    # @api private
     class ASTNodeClassMap
       def initialize
         @klass_map = {}
@@ -15,6 +14,7 @@ module Reek
       def klass_for(type)
         klass_map[type] ||= Class.new(Node).tap do |klass|
           extension = extension_map[type]
+          # TODO: map node type to constant directly.
           klass.send :include, extension if extension
         end
       end

data/lib/reek/ast/node.rb

@@ -1,17 +1,15 @@
 require 'private_attr/everywhere'
 require_relative '../cli/silencer'
 
-Reek::CLI::Silencer.silently stderr: true, stdout: true do
+Reek::CLI::Silencer.silently do
   require 'parser'
 end
 
 module Reek
-  # @api private
   module AST
     # Base class for AST nodes extended with utility methods. Contains some
     # methods to ease the transition from Sexp to AST::Node.
     #
-    # @api private
     class Node < ::Parser::AST::Node
       attr_reader :parent
 
@@ -39,7 +37,7 @@ module Reek
       end
 
       def line
-        loc.line unless loc.nil?
+        loc && loc.line
       end
 
       # @deprecated
@@ -62,6 +60,7 @@ module Reek
       #   context.each_node(:lvar).any? { |it| it.var_name == 'something' }
       #
       # Returns an array with all matching nodes.
+      # TODO: without a block, this doesn't do what one might expect
       def each_node(target_type, ignoring = [], &blk)
         if block_given?
           look_for_type(target_type, ignoring, &blk)

data/lib/reek/ast/object_refs.rb

@@ -1,9 +1,9 @@
 require 'private_attr/everywhere'
 
 module Reek
-  # @api private
+  # Represents functionality related to an Abstract Syntax Tree.
   module AST
-    # Responsible for holding one specific object reference
+    # Responsible for holding one specific object reference.
     ObjectRef = Struct.new(:name, :line)
     #
     # Manages and counts the references out of a method to other objects.

data/lib/reek/ast/reference_collector.rb

@@ -6,7 +6,6 @@ module Reek
     # Locates references to the current object within a portion
     # of an abstract syntax tree.
     #
-    # @api private
     class ReferenceCollector
       STOP_NODES = [:class, :module, :def, :defs]
 

data/lib/reek/ast/sexp_extensions.rb

@@ -6,7 +6,6 @@ module Reek
     # Extension modules providing utility methods to ASTNode objects, depending
     # on their type.
     #
-    # @api private
     module SexpExtensions
       # Base module for utility methods for argument nodes.
       module ArgNodeBase
@@ -423,7 +422,7 @@ module Reek
         MODULE_DEFINERS = [:Class, :Struct]
 
         def defines_module?
-          return false if value.nil?
+          return false unless value
           call = case value.type
                  when :block
                    value.call

data/lib/reek/ast/sexp_formatter.rb

@@ -1,6 +1,6 @@
 require_relative '../cli/silencer'
 
-Reek::CLI::Silencer.silently stderr: true, stdout: true do
+Reek::CLI::Silencer.silently do
   require 'unparser'
 end
 
@@ -9,7 +9,6 @@ module Reek
     #
     # Formats snippets of syntax tree back into Ruby source code.
     #
-    # @api private
     class SexpFormatter
       # Formats the given sexp.
       #

data/lib/reek/cli/application.rb

@@ -9,7 +9,6 @@ module Reek
     # This is the entry point for all invocations of Reek from the
     # command line.
     #
-    # @api private
     class Application
       STATUS_SUCCESS = 0
       STATUS_ERROR   = 1

data/lib/reek/cli/command.rb

@@ -5,7 +5,6 @@ module Reek
     #
     # Base class for all commands
     #
-    # @api private
     class Command
       attr_reader :options
 

data/lib/reek/cli/input.rb

@@ -5,7 +5,6 @@ module Reek
     #
     # CLI Input utility
     #
-    # @api private
     module Input
       def sources
         if no_source_files_given?
@@ -21,6 +20,7 @@ module Reek
 
       private
 
+      # :reek:UtilityFunction
       def input_was_piped?
         !$stdin.tty?
       end
@@ -31,6 +31,7 @@ module Reek
         argv.empty?
       end
 
+      # :reek:UtilityFunction
       def working_directory_as_source
         Source::SourceLocator.new(['.']).sources
       end

data/lib/reek/cli/option_interpreter.rb

@@ -7,7 +7,6 @@ module Reek
     #
     # Interprets the options set from the command line
     #
-    # @api private
     class OptionInterpreter
       include Input
 

data/lib/reek/cli/options.rb

@@ -10,7 +10,6 @@ module Reek
     # Parses the command line
     #
     # See {file:docs/Command-Line-Options.md} for details.
-    # @api private
     class Options
       def initialize(argv = [])
         @argv    = argv
@@ -33,6 +32,7 @@ module Reek
 
       private_attr_reader :argv, :options, :parser
 
+      # :reek:UtilityFunction
       def color_support?
         $stdout.tty?
       end
@@ -72,6 +72,7 @@ module Reek
         end
       end
 
+      # :reek:TooManyStatements: { max_statements: 6 }
       def set_configuration_options
         parser.separator 'Configuration:'
         parser.on('-c', '--config FILE', 'Read configuration options from FILE') do |file|
@@ -128,6 +129,7 @@ module Reek
         end
       end
 
+      # :reek:TooManyStatements: { max_statements: 7 }
       def set_utility_options
         parser.separator "\nUtility options:"
         parser.on_tail('-h', '--help', 'Show this message') do

data/lib/reek/cli/reek_command.rb

@@ -7,7 +7,6 @@ module Reek
     # A command to collect smells from a set of sources and write them out in
     # text report format.
     #
-    # @api private
     class ReekCommand < Command
       def execute(app)
         options.sources.each do |source|

data/lib/reek/cli/silencer.rb

@@ -3,15 +3,15 @@ require 'stringio'
 module Reek
   module CLI
     # CLI silencer
-    # @api private
     module Silencer
       module_function
 
-      def silently(stderr: nil, stdout: nil)
+      # :reek:TooManyStatements: { max_statements: 7 }
+      def silently
         old_verbose = $VERBOSE
         $VERBOSE = false
-        $stderr = StringIO.new if stderr
-        $stdout = StringIO.new if stdout
+        $stderr = StringIO.new
+        $stdout = StringIO.new
         yield
       ensure
         $VERBOSE = old_verbose

data/lib/reek/cli/warning_collector.rb

@@ -6,7 +6,6 @@ module Reek
     #
     # Collects and sorts smells warnings.
     #
-    # @api private
     class WarningCollector
       def initialize
         @warnings_set = Set.new

data/lib/reek/code_comment.rb

@@ -9,36 +9,31 @@ module Reek
   # A comment header from an abstract syntax tree; found directly above
   # module, class and method definitions.
   #
-  # @api private
   class CodeComment
     CONFIG_REGEX = /:reek:(\w+)(:\s*\{.*?\})?/
 
     def initialize(text)
+      @config = Hash.new { |hash, key| hash[key] = {} }
       @text = text.gsub(CONFIG_REGEX) do
-        add_to_config($1, $2)
+        @config.merge! add_to_config($1, $2)
         ''
       end.gsub(/#/, '').gsub(/\n/, '').strip
     end
 
-    def config
-      @config ||= Hash.new { |hash, key| hash[key] = {} }
-    end
+    attr_reader :config
 
     def descriptive?
       text.split(/\s+/).length >= 2
     end
 
-    protected
+    private
 
+    # :reek:UtilityFunction
     def add_to_config(smell, options)
       options ||= ': { enabled: false }'
-      config.merge! YAML.load(smell.gsub(/(?:^|_)(.)/) { $1.upcase } + options)
-      # TODO: extend this to all configs -------------------^
-      # TODO: extend to allow configuration of whole smell class, not just subclass
+      YAML.load(smell + options)
     end
 
-    private
-
     private_attr_reader :text
   end
 end

data/lib/reek/configuration/app_configuration.rb

@@ -7,13 +7,10 @@ require_relative './directory_directives'
 require_relative './excluded_paths'
 
 module Reek
-  # @api private
   module Configuration
-    # @api private
     #
     # Reek's singleton configuration instance.
     #
-    # @api private
     class AppConfiguration
       include ConfigurationValidator
       EXCLUDE_PATHS_KEY = 'exclude_paths'

data/lib/reek/configuration/configuration_file_finder.rb

@@ -2,6 +2,7 @@ require 'pathname'
 
 module Reek
   module Configuration
+    # Raised when config file is not properly readable.
     class ConfigFileException < StandardError; end
     #
     # ConfigurationFileFinder is responsible for finding reek's configuration.
@@ -14,7 +15,6 @@ module Reek
     #
     # The order in which ConfigurationFileFinder tries to find such a
     # configuration file is exactly like above.
-    # @api private
     module ConfigurationFileFinder
       module_function
 
@@ -22,10 +22,12 @@ module Reek
         load_from_file(find(path: path))
       end
 
+      # :reek:ControlParameter
       def find(path: nil, current: Pathname.pwd, home: Pathname.new(Dir.home))
         path || find_by_dir(current) || find_by_dir(home)
       end
 
+      # :reek:NestedIterators: { max_allowed_nesting: 2 }
       def find_by_dir(start)
         start.ascend do |dir|
           files = dir.children.select(&:file?).sort
@@ -34,6 +36,7 @@ module Reek
         end
       end
 
+      # :reek:TooManyStatements: { max_statements: 6 }
       def load_from_file(path)
         return {} unless path
         begin

data/lib/reek/configuration/configuration_validator.rb

@@ -6,6 +6,7 @@ module Reek
     module ConfigurationValidator
       private
 
+      # :reek:UtilityFunction
       def smell_type?(key)
         Reek::Smells.const_get key
       rescue NameError

data/lib/reek/configuration/directory_directives.rb

@@ -26,6 +26,8 @@ module Reek
       # @param config [Hash] the configuration
       #
       # @return [self]
+      #
+      # :reek:NestedIterators: { max_allowed_nesting: 2 }
       def add(path, config)
         with_valid_directory(path) do |directory|
           self[directory] = config.each_with_object({}) do |(key, value), hash|
@@ -38,6 +40,8 @@ module Reek
 
       private
 
+      # :reek:DuplicateMethodCall: { max_calls: 2 }
+      # :reek:FeatureEnvy
       def best_match_for(source_base_dir)
         keys.
           select { |pathname| source_base_dir.to_s.match(/#{Regexp.escape(pathname.to_s)}/) }.

data/lib/reek/configuration/excluded_paths.rb

@@ -3,11 +3,12 @@ require_relative './configuration_validator'
 module Reek
   module Configuration
     #
-    # Hash extension for excluded paths.
+    # Array extension for excluded paths.
     #
     module ExcludedPaths
       include ConfigurationValidator
 
+      # :reek:NestedIterators: { max_allowed_nesting: 2 }
       def add(paths)
         paths.each do |path|
           with_valid_directory(path) { |directory| self << directory }

data/lib/reek/context/code_context.rb

@@ -2,7 +2,6 @@ require_relative '../code_comment'
 require_relative '../ast/object_refs'
 
 module Reek
-  # @api private
   module Context
     #
     # Superclass for all types of source code context. Each instance represents
@@ -10,7 +9,8 @@ module Reek
     # code element. CodeContexts form a tree in the same way the code does,
     # with each context holding a reference to a unique outer context.
     #
-    # @api private
+    # :reek:TooManyMethods: { max_methods: 19 }
+    # :reek:TooManyInstanceVariables: { max_instance_variables: 8 }
     class CodeContext
       attr_reader :exp
       attr_reader :num_statements
@@ -77,16 +77,19 @@ module Reek
         self.num_statements += num
       end
 
+      # :reek:TooManyStatements: { max_statements: 6 }
+      # :reek:FeatureEnvy
       def record_call_to(exp)
         receiver = exp.receiver
         type = receiver ? receiver.type : :self
+        line = exp.line
         case type
         when :lvar, :lvasgn
           unless exp.object_creation_call?
-            refs.record_reference_to(receiver.name, line: exp.line)
+            refs.record_reference_to(receiver.name, line: line)
           end
         when :self
-          refs.record_reference_to(:self, line: exp.line)
+          refs.record_reference_to(:self, line: line)
         end
       end
 
@@ -159,6 +162,10 @@ module Reek
         end
       end
 
+      def non_public_visibility?
+        visibility != :public
+      end
+
       protected
 
       attr_writer :num_statements, :visibility