reek 4.6.0 → 5.0.0

data/lib/reek/ast/sexp_extensions/send.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions
@@ -22,10 +23,6 @@ module Reek
           ([receiver] + args).compact
         end
 
-        def arg_names
-          args.map { |arg| arg.children.first }
-        end
-
         def module_creation_call?
           object_creation_call? && module_creation_receiver?
         end

data/lib/reek/ast/sexp_extensions/super.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions

data/lib/reek/ast/sexp_extensions/symbols.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions

data/lib/reek/ast/sexp_extensions/variables.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions

data/lib/reek/ast/sexp_extensions/when.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions

data/lib/reek/ast/sexp_extensions/yield.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions

data/lib/reek/ast/sexp_extensions.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
+
 require_relative 'reference_collector'
 
 require_relative 'sexp_extensions/arguments'
 require_relative 'sexp_extensions/attribute_assignments'
+require_relative 'sexp_extensions/begin'
 require_relative 'sexp_extensions/block'
 require_relative 'sexp_extensions/case'
 require_relative 'sexp_extensions/constant'

data/lib/reek/cli/application.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
+
 require_relative 'options'
 require_relative 'status'
 require_relative '../configuration/app_configuration'
 require_relative '../source/source_locator'
 require_relative 'command/report_command'
 require_relative 'command/todo_list_command'
+require_relative '../errors/config_file_error'
 
 module Reek
   module CLI
@@ -41,7 +43,7 @@ module Reek
 
       def configure_app_configuration(config_file)
         Configuration::AppConfiguration.from_path(config_file)
-      rescue Reek::Configuration::ConfigFileException => error
+      rescue Errors::ConfigFileError => error
         warn "Error: #{error}"
         exit Status::DEFAULT_ERROR_EXIT_CODE
       end
@@ -67,7 +69,7 @@ module Reek
         options.argv
       end
 
-      # :reek:UtilityFunction
+      # @quality :reek:UtilityFunction
       def input_was_piped?
         !$stdin.tty?
       end
@@ -87,7 +89,7 @@ module Reek
       end
 
       def source_from_pipe
-        [$stdin]
+        [Source::SourceCode.from($stdin, origin: options.stdin_filename)]
       end
 
       def disable_progress_output_unless_verbose

data/lib/reek/cli/command/base_command.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module CLI
     module Command

data/lib/reek/cli/command/report_command.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'base_command'
 require_relative '../../examiner'
 require_relative '../../logging_error_handler'
@@ -37,7 +38,6 @@ module Reek
           @reporter ||=
             report_class.new(
               warning_formatter: warning_formatter,
-              report_formatter: Report::Formatter,
               sort_by_issue_count: sort_by_issue_count,
               heading_formatter: heading_formatter,
               progress_formatter: progress_formatter.new(sources.length))
@@ -52,7 +52,7 @@ module Reek
         end
 
         def warning_formatter_class
-          Report.warning_formatter_class(options.show_links ? :wiki_links : :simple)
+          Report.warning_formatter_class(options.show_links ? :documentation_links : :simple)
         end
 
         def location_formatter

data/lib/reek/cli/command/todo_list_command.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
+
 require_relative 'base_command'
 require_relative '../../examiner'
+require_relative '../../configuration/app_configuration'
 
 module Reek
   module CLI
@@ -10,15 +12,15 @@ module Reek
       # file that can serve as a todo list.
       #
       class TodoListCommand < BaseCommand
-        FILE_NAME = '.todo.reek'.freeze
+        FILE_NAME = '.todo.reek'
 
         def execute
-          smells = scan_for_smells
           if smells.empty?
             puts "\n'.todo.reek' not generated because "\
                     'there were no smells found!'
           else
-            File.write FILE_NAME, groups_for(smells).to_yaml
+            File.write FILE_NAME,
+                       { Configuration::AppConfiguration::DETECTORS_KEY => groups }.to_yaml
             puts "\n'.todo.reek' generated! You can now use "\
                     'this as a starting point for your configuration.'
           end
@@ -27,14 +29,13 @@ module Reek
 
         private
 
-        def scan_for_smells
-          sources.map do |source|
-            Examiner.new(source,
-                         filter_by_smells: smell_names)
+        def smells
+          @smells ||= sources.map do |source|
+            Examiner.new(source, filter_by_smells: smell_names)
           end.map(&:smells).flatten
         end
 
-        def groups_for(smells)
+        def groups
           @groups ||=
             begin
               todos = smells.group_by(&:smell_class).map do |smell_class, smells_for_class|

data/lib/reek/cli/options.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
+
 require 'optparse'
 require 'rainbow'
 require_relative '../version'
 require_relative 'status'
+require_relative '../detector_repository'
+require_relative '../documentation_link'
 
 module Reek
   module CLI
@@ -11,9 +14,9 @@ module Reek
     #
     # See {file:docs/Command-Line-Options.md} for details.
     #
-    # :reek:TooManyInstanceVariables: { max_instance_variables: 12 }
-    # :reek:TooManyMethods: { max_methods: 18 }
-    # :reek:Attribute: { enabled: false }
+    # @quality :reek:TooManyInstanceVariables { max_instance_variables: 12 }
+    # @quality :reek:TooManyMethods { max_methods: 18 }
+    # @quality :reek:Attribute { enabled: false }
     #
     class Options
       attr_reader :argv, :parser, :smells_to_detect
@@ -25,6 +28,7 @@ module Reek
                     :show_empty,
                     :show_links,
                     :sorting,
+                    :stdin_filename,
                     :success_exit_code,
                     :failure_exit_code,
                     :generate_todo_list,
@@ -63,12 +67,12 @@ module Reek
       # processing by a machine, but will be viewed by a human. This means
       # features like coloring can be safely enabled by default.
       #
-      # :reek:UtilityFunction
+      # @quality :reek:UtilityFunction
       def tty_output?
         $stdout.tty?
       end
 
-      # :reek:TooManyStatements: { max_statements: 7 }
+      # @quality :reek:TooManyStatements { max_statements: 7 }
       def set_up_parser
         set_banner
         set_configuration_options
@@ -81,7 +85,7 @@ module Reek
 
       def set_banner
         program_name = parser.program_name
-        parser.banner = <<-EOB.gsub(/^[ ]+/, '')
+        parser.banner = <<-BANNER.gsub(/^[ ]+/, '')
           Usage: #{program_name} [options] [files]
 
           Examples:
@@ -90,12 +94,12 @@ module Reek
           #{program_name} -s lib
           cat my_class.rb | #{program_name}
 
-          See https://wiki.github.com/troessner/reek for detailed help.
+          See https://github.com/troessner/reek for detailed help.
 
-        EOB
+        BANNER
       end
 
-      # :reek:TooManyStatements: { max_statements: 6 }
+      # @quality :reek:TooManyStatements { max_statements: 7 }
       def set_configuration_options
         parser.separator 'Configuration:'
         parser.on('-c', '--config FILE', 'Read configuration options from FILE') do |file|
@@ -103,11 +107,16 @@ module Reek
         end
         parser.on('--smell SMELL',
                   'Only look for a specific smell.',
-                  'Call it like this: reek --smell PrimaDonnaMethod source.rb',
-                  'Check out https://github.com/troessner/reek/blob/master/docs/Code-Smells.md '\
+                  'Call it like this: reek --smell MissingSafeMethod source.rb',
+                  "Check out #{DocumentationLink.build('Code Smells')} "\
                   'for a list of smells') do |smell|
           smells_to_detect << smell
         end
+        parser.on('--stdin-filename FILE',
+                  'When passing code in via pipe, assume this filename when '\
+                  'checking file or directory rules in the config.') do |file|
+          self.stdin_filename = file
+        end
       end
 
       def set_generate_todo_list_options
@@ -127,7 +136,7 @@ module Reek
         end
       end
 
-      # :reek:TooManyStatements: { max_statements: 7 }
+      # @quality :reek:TooManyStatements { max_statements: 7 }
       def set_report_formatting_options
         parser.separator "\nText format options:"
         set_up_color_option
@@ -149,8 +158,8 @@ module Reek
                   'Show headings for smell-free source files (default: false)') do |show_empty|
           self.show_empty = show_empty
         end
-        parser.on('-U', '--[no-]wiki-links',
-                  'Show link to related wiki page for each smell (default: true)') do |show_links|
+        parser.on('-U', '--[no-]documentation',
+                  'Show link to related documentation page for each smell (default: true)') do |show_links|
           self.show_links = show_links
         end
       end
@@ -190,7 +199,7 @@ module Reek
         end
       end
 
-      # :reek:DuplicateMethodCall: { max_calls: 2 }
+      # @quality :reek:DuplicateMethodCall { max_calls: 2 }
       def set_exit_codes
         parser.separator "\nExit codes:"
         parser.on('--success-exit-code CODE',
@@ -205,13 +214,20 @@ module Reek
         end
       end
 
-      # :reek:TooManyStatements: { max_statements: 7 }
+      # @quality :reek:TooManyStatements { max_statements: 12 }
       def set_utility_options
         parser.separator "\nUtility options:"
         parser.on_tail('-h', '--help', 'Show this message') do
           puts parser
           exit
         end
+        parser.on_tail('-l', '--list', 'List all available smell detectors') do
+          puts "All available smell detectors:\n\n"
+          puts DetectorRepository.available_detector_names
+          puts "\nCheck out #{DocumentationLink.build('Code Smells')} "\
+                  'for a details on each detector'
+          exit
+        end
         parser.on_tail('-v', '--version', 'Show version') do
           puts "#{parser.program_name} #{Reek::Version::STRING}\n"
           exit

data/lib/reek/cli/silencer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'stringio'
 
 module Reek
@@ -7,17 +8,28 @@ module Reek
     module Silencer
       module_function
 
-      # :reek:TooManyStatements: { max_statements: 7 }
+      # @quality :reek:TooManyStatements { max_statements: 9 }
       def silently
         old_verbose = $VERBOSE
+        old_stderr = $stderr
+        old_stdout = $stdout
+
         $VERBOSE = false
         $stderr = StringIO.new
         $stdout = StringIO.new
         yield
       ensure
         $VERBOSE = old_verbose
-        $stderr = STDERR
-        $stdout = STDOUT
+        $stderr = old_stderr
+        $stdout = old_stdout
+      end
+
+      def without_warnings
+        old_verbose = $VERBOSE
+        $VERBOSE = false
+        yield
+      ensure
+        $VERBOSE = old_verbose
       end
     end
   end

data/lib/reek/cli/status.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module CLI
     module Status

data/lib/reek/code_comment.rb

@@ -17,22 +17,20 @@ module Reek
                           :reek: # prefix
                           (\w+)  # smell detector e.g.: UncommunicativeVariableName
                           (
-                            :? # legacy separator
                             \s*
                             (\{.*?\}) # optional details in hash style e.g.: { max_methods: 30 }
                           )?
                          /x
     SANITIZE_REGEX                 = /(#|\n|\s)+/ # Matches '#', newlines and > 1 whitespaces.
-    DISABLE_DETECTOR_CONFIGURATION = '{ enabled: false }'.freeze
+    DISABLE_DETECTOR_CONFIGURATION = '{ enabled: false }'
     MINIMUM_CONTENT_LENGTH         = 2
-    LEGACY_SEPARATOR               = ':'.freeze
 
     attr_reader :config
 
     #
-    # @param comment [String] - the original comment as found in the source code
-    # @param line [Integer] - start of the expression the comment belongs to
-    # @param source [String] - Path to source file or "string"
+    # @param comment [String] the original comment as found in the source code
+    # @param line [Integer] start of the expression the comment belongs to
+    # @param source [String] Path to source file or "string"
     #
     def initialize(comment:, line: nil, source: nil)
       @original_comment  = comment
@@ -80,15 +78,15 @@ module Reek
     # This class validates [1], [2] and [3] at the moment but will also validate
     # [4] in the future.
     #
-    # :reek:TooManyInstanceVariables: { max_instance_variables: 7 }
+    # @quality :reek:TooManyInstanceVariables { max_instance_variables: 7 }
     class CodeCommentValidator
       #
-      # @param detector_name [String] - the detector class that was parsed out of the original
+      # @param detector_name [String] the detector class that was parsed out of the original
       #   comment, e.g. "DuplicateMethodCall" or "UnknownSmellDetector"
-      # @param original_comment [String] - the original comment as found in the source code
-      # @param line [Integer] - start of the expression the comment belongs to
-      # @param source [String] - path to source file or "string"
-      # @param options [String] - the configuration options as String for the detector that were
+      # @param original_comment [String] the original comment as found in the source code
+      # @param line [Integer] start of the expression the comment belongs to
+      # @param source [String] path to source file or "string"
+      # @param options [String] the configuration options as String for the detector that were
       #   extracted from the original comment
       def initialize(detector_name:, original_comment:, line:, source:, options: {})
         @detector_name    = detector_name
@@ -151,24 +149,24 @@ module Reek
                                                                  line: line
       end
 
-      # @return [Boolean] - all keys in code comment are applicable to the detector in question
+      # @return [Boolean] all keys in code comment are applicable to the detector in question
       def given_keys_legit?
         given_configuration_keys.subset? valid_detector_keys
       end
 
-      # @return [Set] - the configuration keys that are found in the code comment
+      # @return [Set] the configuration keys that are found in the code comment
       def given_configuration_keys
         parsed_options.keys.map(&:to_sym).to_set
       end
 
-      # @return [String] - all keys from the code comment that look bad
+      # @return [String] all keys from the code comment that look bad
       def configuration_keys_difference
         given_configuration_keys.difference(valid_detector_keys).
           to_a.map { |key| "'#{key}'" }.
           join(', ')
       end
 
-      # @return [Set] - all keys that are legit for the given detector
+      # @return [Set] all keys that are legit for the given detector
       def valid_detector_keys
         detector_class.configuration_keys
       end

data/lib/reek/configuration/app_configuration.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'pathname'
 require_relative './configuration_file_finder'
 require_relative './configuration_validator'
@@ -14,19 +15,30 @@ module Reek
     # @public
     class AppConfiguration
       include ConfigurationValidator
-      EXCLUDE_PATHS_KEY = 'exclude_paths'.freeze
+      EXCLUDE_PATHS_KEY = 'exclude_paths'
+      DIRECTORIES_KEY = 'directories'
+      DETECTORS_KEY = 'detectors'
 
-      # Instantiate a configuration via given path.
+      # Instantiate a configuration via the given path.
       #
-      # @param path [Pathname] the path to the config file
+      # @param path [Pathname] the path to the config file.
       #
       # @return [AppConfiguration]
       #
       # @public
-      def self.from_path(path = nil)
-        allocate.tap do |instance|
-          instance.instance_eval { find_and_load(path: path) }
-        end
+      def self.from_path(path)
+        values = ConfigurationFileFinder.find_and_load(path: path)
+        new(values: values)
+      end
+
+      # Instantiate a configuration via the default path.
+      #
+      # @return [AppConfiguration]
+      #
+      # @public
+      def self.from_default_path
+        values = ConfigurationFileFinder.find_and_load(path: nil)
+        new(values: values)
       end
 
       # Instantiate a configuration by passing everything in.
@@ -38,21 +50,17 @@ module Reek
       # @return [AppConfiguration]
       #
       # @public
-      def self.from_hash(hash = {})
-        allocate.tap do |instance|
-          instance.instance_eval do
-            load_values hash
-          end
-        end
+      def self.from_hash(hash)
+        new(values: hash)
       end
 
       def self.default
-        new
+        new(values: {})
       end
 
       # Returns the directive for a given directory.
       #
-      # @param source_via [String] - the source of the code inspected
+      # @param source_via [String] the source of the code inspected
       #
       # @return [Hash] the directory directive for the source with the default directive
       #                reverse-merged into it.
@@ -62,21 +70,25 @@ module Reek
       end
 
       def path_excluded?(path)
-        excluded_paths.include?(path)
+        excluded_paths.map(&:expand_path).include?(path.expand_path)
       end
 
-      def load_values(configuration_hash)
-        configuration_hash.each do |key, value|
+      def load_values(values)
+        values.each do |key, value|
           if key == EXCLUDE_PATHS_KEY
             excluded_paths.add value
-          elsif smell_type?(key)
-            default_directive.add key, value
-          else
-            directory_directives.add key, value
+          elsif key == DIRECTORIES_KEY
+            directory_directives.add value
+          elsif key == DETECTORS_KEY
+            default_directive.add value
           end
         end
       end
 
+      def initialize(values: {})
+        load_values(values)
+      end
+
       private
 
       attr_writer :directory_directives, :default_directive, :excluded_paths
@@ -92,12 +104,6 @@ module Reek
       def excluded_paths
         @excluded_paths ||= [].extend(ExcludedPaths)
       end
-
-      def find_and_load(path: nil)
-        configuration_hash = ConfigurationFileFinder.find_and_load(path: path)
-
-        load_values(configuration_hash)
-      end
     end
   end
 end

data/lib/reek/configuration/configuration_converter.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require_relative './configuration_validator'
+
+module Reek
+  module Configuration
+    # Responsible for converting marked strings coming from the outside world
+    # into proper regexes.
+    class ConfigurationConverter
+      REGEXABLE_ATTRIBUTES = %w(accept reject exclude).freeze
+      include ConfigurationValidator
+      attr_reader :configuration
+
+      # @param configuration [Hash] e.g.
+      #
+      #   detectors => {
+      #     "UnusedPrivateMethod" => {"exclude"=>["/exclude regexp/"]},
+      #     "UncommunicativeMethodName"=>{"reject"=>["reject name"], "accept"=>["accept name"]
+      #   },
+      #   directories => {
+      #     "app/controllers" => {
+      #       "UnusedPrivateMethod" => {"exclude"=>["/exclude regexp/"]},
+      #       "UncommunicativeMethodName"=>{"reject"=>["reject name"], "accept"=>["accept name"]}
+      #     }
+      #   }
+      def initialize(configuration)
+        @configuration = configuration
+      end
+
+      # Converts all marked strings across the whole configuration to regexes.
+      # @return [Hash]
+      #
+      def convert
+        strings_to_regexes_for_detectors
+        strings_to_regexes_for_directories
+
+        configuration
+      end
+
+      private
+
+      # @param value [String] String that is potentially marked as regex, e.g. "/foobar/".
+      # @return [Bool] if the string in question is marked as regex.
+      #
+      # @quality :reek:UtilityFunction
+      def marked_as_regex?(value)
+        value.start_with?('/') && value.end_with?('/')
+      end
+
+      # @param value [value] String that is potentially marked as regex, e.g. "/foobar/".
+      # @return [Regexp] e.g. /foobar/.
+      #
+      def to_regex(value)
+        marked_as_regex?(value) ? Regexp.new(value[1..-2]) : value
+      end
+
+      # @param detector_configuration [Hash] e.g.
+      #   { "UnusedPrivateMethod" => {"exclude"=>["/exclude regexp/"] }
+      # @return [Array] all the attributes from the detector configuration that potentially contain regexes.
+      #   Using this example above this would just be "exclude".
+      #
+      # @quality :reek:UtilityFunction
+      def convertible_attributes(detector_configuration)
+        detector_configuration.keys & REGEXABLE_ATTRIBUTES
+      end
+
+      # Iterates over our detector configuration and converts all marked strings into regexes.
+      # @return nil
+      #
+      # @quality :reek:DuplicateMethodCall { max_calls: 3 }
+      # @quality :reek:NestedIterators { max_allowed_nesting: 3 }
+      # @quality :reek:TooManyStatements { max_statements: 6 }
+      def strings_to_regexes_for_detectors
+        return unless configuration[AppConfiguration::DETECTORS_KEY]
+
+        configuration[AppConfiguration::DETECTORS_KEY].tap do |detectors|
+          detectors.keys.each do |detector|
+            convertible_attributes(detectors[detector]).each do |attribute|
+              detectors[detector][attribute] = detectors[detector][attribute].map do |item|
+                to_regex item
+              end
+            end
+          end
+        end
+      end
+
+      # Iterates over our directory configuration and converts all marked strings into regexes.
+      # @return nil
+      #
+      # @quality :reek:DuplicateMethodCall { max_calls: 3 }
+      # @quality :reek:NestedIterators { max_allowed_nesting: 4 }
+      # @quality :reek:TooManyStatements { max_statements: 7 }
+      def strings_to_regexes_for_directories
+        return unless configuration[AppConfiguration::DIRECTORIES_KEY]
+
+        configuration[AppConfiguration::DIRECTORIES_KEY].tap do |directories|
+          directories.keys.each do |directory|
+            directories[directory].each do |detector, configuration|
+              convertible_attributes(configuration).each do |attribute|
+                directories[directory][detector][attribute] = directories[directory][detector][attribute].map do |item|
+                  to_regex item
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end