reek 4.7.3 → 5.0.0

data/lib/reek/smell_detectors/too_many_statements.rb

@@ -13,7 +13,7 @@ module Reek
     class TooManyStatements < BaseDetector
       # The name of the config field that sets the maximum number of
       # statements permitted in any method.
-      MAX_ALLOWED_STATEMENTS_KEY = 'max_statements'.freeze
+      MAX_ALLOWED_STATEMENTS_KEY = 'max_statements'
       DEFAULT_MAX_STATEMENTS = 5
 
       def self.default_config
@@ -31,7 +31,6 @@ module Reek
         count = context.number_of_statements
         return [] if count <= max_allowed_statements
         [smell_warning(
-          context: context,
           lines: [source_line],
           message: "has approx #{count} statements",
           parameters: { count: count })]

data/lib/reek/smell_detectors/uncommunicative_method_name.rb

@@ -20,8 +20,8 @@ module Reek
     #
     # See {file:docs/Uncommunicative-Method-Name.md} for details.
     class UncommunicativeMethodName < BaseDetector
-      REJECT_KEY = 'reject'.freeze
-      ACCEPT_KEY = 'accept'.freeze
+      REJECT_KEY = 'reject'
+      ACCEPT_KEY = 'accept'
       DEFAULT_REJECT_PATTERNS = [/^[a-z]$/, /[0-9]$/, /[A-Z]/].freeze
       DEFAULT_ACCEPT_PATTERNS = [].freeze
 
@@ -41,7 +41,6 @@ module Reek
         return [] if acceptable_name?(name)
 
         [smell_warning(
-          context: context,
           lines: [source_line],
           message: "has the name '#{name}'",
           parameters: { name: name })]

data/lib/reek/smell_detectors/uncommunicative_module_name.rb

@@ -21,13 +21,13 @@ module Reek
     class UncommunicativeModuleName < BaseDetector
       # The name of the config field that lists the regexps of
       # smelly names to be reported.
-      REJECT_KEY = 'reject'.freeze
+      REJECT_KEY = 'reject'
       DEFAULT_REJECT_PATTERNS = [/^.$/, /[0-9]$/].freeze
 
       # The name of the config field that lists the specific names that are
       # to be treated as exceptions; these names will not be reported as
       # uncommunicative.
-      ACCEPT_KEY = 'accept'.freeze
+      ACCEPT_KEY = 'accept'
       DEFAULT_ACCEPT_PATTERNS = [].freeze
 
       def self.default_config
@@ -53,7 +53,6 @@ module Reek
                                       fully_qualified_name: fully_qualified_name)
 
         [smell_warning(
-          context: context,
           lines: [source_line],
           message: "has the name '#{module_name}'",
           parameters: { name: module_name })]

data/lib/reek/smell_detectors/uncommunicative_parameter_name.rb

@@ -21,10 +21,10 @@ module Reek
     #
     # See {file:docs/Uncommunicative-Parameter-Name.md} for details.
     class UncommunicativeParameterName < BaseDetector
-      REJECT_KEY = 'reject'.freeze
+      REJECT_KEY = 'reject'
       DEFAULT_REJECT_PATTERNS = [/^.$/, /[0-9]$/, /[A-Z]/, /^_/].freeze
 
-      ACCEPT_KEY = 'accept'.freeze
+      ACCEPT_KEY = 'accept'
       DEFAULT_ACCEPT_PATTERNS = [].freeze
 
       def self.default_config
@@ -45,7 +45,6 @@ module Reek
 
         params.map(&:name).map do |name|
           smell_warning(
-            context: context,
             lines: [source_line],
             message: "has the parameter name '#{name}'",
             parameters: { name: name.to_s })

data/lib/reek/smell_detectors/uncommunicative_variable_name.rb

@@ -24,7 +24,7 @@ module Reek
     class UncommunicativeVariableName < BaseDetector
       # The name of the config field that lists the regexps of
       # smelly names to be reported.
-      REJECT_KEY = 'reject'.freeze
+      REJECT_KEY = 'reject'
       DEFAULT_REJECT_SET = [
         /^.$/, # single-character names
         /[0-9]$/,  # any name ending with a number
@@ -34,7 +34,7 @@ module Reek
       # The name of the config field that lists the specific names that are
       # to be treated as exceptions; these names will not be reported as
       # uncommunicative.
-      ACCEPT_KEY = 'accept'.freeze
+      ACCEPT_KEY = 'accept'
       DEFAULT_ACCEPT_SET = [/^_$/].freeze
 
       def self.default_config
@@ -57,7 +57,6 @@ module Reek
           uncommunicative_variable_name?(name)
         end.map do |name, lines|
           smell_warning(
-            context: context,
             lines: lines,
             message: "has the variable name '#{name}'",
             parameters: { name: name.to_s })
@@ -92,17 +91,17 @@ module Reek
       end
 
       def find_assignment_variable_names(accumulator)
-        assignment_nodes = expression.each_node(:lvasgn, [:class, :module, :defs, :def])
+        assignment_nodes = expression.each_node(:lvasgn, [:class, :module, :defs, :def]).to_a
 
         case expression.type
         when :class, :module
-          assignment_nodes += expression.each_node(:ivasgn, [:class, :module])
+          assignment_nodes += expression.each_node(:ivasgn, [:class, :module]).to_a
         end
 
         assignment_nodes.each { |asgn| accumulator[asgn.children.first].push(asgn.line) }
       end
 
-      # :reek:TooManyStatements: { max_statements: 6 }
+      # @quality :reek:TooManyStatements { max_statements: 6 }
       def find_block_argument_variable_names(accumulator)
         arg_search_exp = case expression.type
                          when :class, :module
@@ -130,7 +129,7 @@ module Reek
         end
       end
 
-      # :reek:UtilityFunction
+      # @quality :reek:UtilityFunction
       def record_variable_name(exp, symbol, accumulator)
         varname = symbol.to_s.sub(/^\*/, '')
         return if varname == ''

data/lib/reek/smell_detectors/unused_parameters.rb

@@ -19,7 +19,6 @@ module Reek
         context.unused_params.map do |param|
           name = param.name.to_s
           smell_warning(
-            context: context,
             lines: [source_line],
             message: "has unused parameter '#{name}'",
             parameters: { name: name })

data/lib/reek/smell_detectors/unused_private_method.rb

@@ -38,7 +38,6 @@ module Reek
         hits.map do |hit|
           name = hit.name
           smell_warning(
-            context: context,
             lines: [hit.line],
             message: "has the unused private instance method '#{name}'",
             parameters: { name: name.to_s })

data/lib/reek/smell_detectors/utility_function.rb

@@ -38,7 +38,7 @@ module Reek
     #
     # See {file:docs/Utility-Function.md} for details.
     class UtilityFunction < BaseDetector
-      PUBLIC_METHODS_ONLY_KEY     = 'public_methods_only'.freeze
+      PUBLIC_METHODS_ONLY_KEY     = 'public_methods_only'
       PUBLIC_METHODS_ONLY_DEFAULT = false
 
       def self.default_config
@@ -63,7 +63,6 @@ module Reek
         return [] if ignore_method?
 
         [smell_warning(
-          context: context,
           lines: [source_line],
           message: "doesn't depend on instance state (maybe move it to another class?)")]
       end
@@ -71,7 +70,7 @@ module Reek
       private
 
       def num_helper_methods
-        context.local_nodes(:send).length
+        context.local_nodes(:send).to_a.length
       end
 
       def ignore_method?

data/lib/reek/smell_detectors.rb

@@ -15,10 +15,9 @@ require_relative 'smell_detectors/manual_dispatch'
 require_relative 'smell_detectors/module_initialize'
 require_relative 'smell_detectors/nested_iterators'
 require_relative 'smell_detectors/nil_check'
-require_relative 'smell_detectors/prima_donna_method'
+require_relative 'smell_detectors/missing_safe_method'
 require_relative 'smell_detectors/repeated_conditional'
 require_relative 'smell_detectors/subclassed_from_core_class'
-require_relative 'smell_detectors/syntax'
 require_relative 'smell_detectors/too_many_instance_variables'
 require_relative 'smell_detectors/too_many_constants'
 require_relative 'smell_detectors/too_many_methods'

data/lib/reek/smell_warning.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'forwardable'
+require_relative 'documentation_link'
 
 module Reek
   #
@@ -8,7 +9,7 @@ module Reek
   #
   # @public
   #
-  # :reek:TooManyInstanceVariables: { max_instance_variables: 6 }
+  # @quality :reek:TooManyInstanceVariables { max_instance_variables: 6 }
   class SmellWarning
     include Comparable
     extend Forwardable
@@ -21,7 +22,7 @@ module Reek
     #   objects yourself. This is why the initializer is not part of the
     #   public API.
     #
-    # :reek:LongParameterList: { max_params: 6 }
+    # @quality :reek:LongParameterList { max_params: 6 }
     def initialize(smell_detector, context: '', lines:, message:,
                    source:, parameters: {})
       @smell_detector = smell_detector
@@ -55,7 +56,9 @@ module Reek
       base_hash.merge(stringified_params)
     end
 
-    alias yaml_hash to_hash
+    def yaml_hash
+      to_hash.merge('documentation_link' => explanatory_link)
+    end
 
     def base_message
       "#{smell_type}: #{context} #{message}"
@@ -65,6 +68,10 @@ module Reek
       smell_detector.class
     end
 
+    def explanatory_link
+      DocumentationLink.build(smell_type)
+    end
+
     protected
 
     def identifying_values
@@ -75,11 +82,11 @@ module Reek
 
     def base_hash
       {
-        'context'        => context,
-        'lines'          => lines,
-        'message'        => message,
-        'smell_type'     => smell_type,
-        'source'         => source
+        'context'    => context,
+        'lines'      => lines,
+        'message'    => message,
+        'smell_type' => smell_type,
+        'source'     => source
       }
     end
   end

data/lib/reek/source/source_code.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 
 require_relative '../cli/silencer'
-Reek::CLI::Silencer.silently do
-  require 'parser/ruby24'
-end
+Reek::CLI::Silencer.without_warnings { require 'parser/ruby25' }
 require_relative '../tree_dresser'
 require_relative '../ast/node'
 require_relative '../ast/builder'
-require_relative '../errors/encoding_error'
 
 # Opt in to new way of representing lambdas
 Reek::AST::Builder.emit_lambda = true
@@ -15,76 +12,83 @@ Reek::AST::Builder.emit_lambda = true
 module Reek
   module Source
     #
-    # A +Source+ object represents a chunk of Ruby source code.
+    # A +SourceCode+ object represents a chunk of Ruby source code.
     #
     class SourceCode
-      IO_IDENTIFIER     = 'STDIN'.freeze
-      STRING_IDENTIFIER = 'string'.freeze
-
-      attr_reader :origin
+      IO_IDENTIFIER     = 'STDIN'
+      STRING_IDENTIFIER = 'string'
 
       # Initializer.
       #
-      # code   - Ruby code as String
-      # origin - 'STDIN', 'string' or a filepath as String
-      # parser - the parser to use for generating AST's out of the given source
-      def initialize(code:, origin:, parser: default_parser)
+      # @param source [File|Pathname|IO|String] Ruby source code
+      # @param origin [String] Origin of the source code. Will be determined
+      #   automatically if left blank.
+      # @param parser the parser to use for generating AST's out of the given code
+      def initialize(source:, origin: nil, parser: self.class.default_parser)
         @origin = origin
-        @diagnostics = []
         @parser = parser
-        @code = code
+        @source = source
       end
 
       # Initializes an instance of SourceCode given a source.
-      # This source can come via 4 different ways:
+      # This source can come via several different ways:
       # - from Files or Pathnames 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`
+      # - from an existing SourceCode object. This is passed through unchanged
       #
-      # @param source [File|IO|String] - the given source
+      # @param source [SourceCode|File|Pathname|IO|String] the given source
+      # @param origin [String|nil]
       #
       # @return an instance of SourceCode
-      # :reek:DuplicateMethodCall: { max_calls: 2 }
-      def self.from(source)
+      def self.from(source, origin: nil)
         case source
-        when File     then new(code: source.read,           origin: source.path)
-        when IO       then new(code: source.readlines.join, origin: IO_IDENTIFIER)
-        when Pathname then new(code: source.read,           origin: source.to_s)
-        when String   then new(code: source,                origin: STRING_IDENTIFIER)
+        when self then source
+        else new(source: source, origin: origin)
         end
       end
 
-      # @return [true|false] Returns true if parsed file does not have any syntax errors.
-      def valid_syntax?
-        diagnostics.none? { |diagnostic| [:error, :fatal].include?(diagnostic.level) }
+      def syntax_tree
+        @syntax_tree ||= parse
       end
 
-      def diagnostics
-        parse_if_needed
-        @diagnostics
+      def self.default_parser
+        Parser::Ruby25.new(AST::Builder.new).tap do |parser|
+          diagnostics = parser.diagnostics
+          diagnostics.all_errors_are_fatal = true
+          diagnostics.ignore_warnings      = true
+        end
       end
 
-      def syntax_tree
-        parse_if_needed
+      def origin
+        @origin ||=
+          case source
+          when File     then source.path
+          when IO       then IO_IDENTIFIER
+          when Pathname then source.to_s
+          when String   then STRING_IDENTIFIER
+          end
       end
 
       private
 
-      def parse_if_needed
-        @syntax_tree ||= parse(@parser, @code)
+      def code
+        @code ||=
+          case source
+          when File, Pathname then source.read
+          when IO             then source.readlines.join
+          when String         then source
+          end.force_encoding(Encoding::UTF_8)
       end
 
-      attr_reader :source
+      attr_reader :parser, :source
 
-      # Parses the given source into an AST and associates the source code comments with it.
+      # Parses the given code 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 register a
-      # parse error to @diagnostics and then just continue.
-      #
-      # Given this @source:
+      # Given this @code:
       #
       #   # comment about C
       #   class C
@@ -105,41 +109,15 @@ module Reek
       # where each node is possibly adorned with our SexpExtensions (see ast/ast_node_class_map
       # and ast/sexp_extensions for details).
       #
-      # @param parser [Parser::Ruby24]
-      # @param source [String] - Ruby code
-      # @return [Anonymous subclass of Reek::AST::Node] the AST presentation
-      #         for the given source
-      # :reek:TooManyStatements { max_statements: 8 }
-      def parse(parser, source)
-        begin
-          buffer = Parser::Source::Buffer.new(origin, 1)
-          source.force_encoding(Encoding::UTF_8)
-          buffer.source = source
-        rescue EncodingError => exception
-          raise Errors::EncodingError, origin: origin, original_exception: exception
-        end
-        begin
-          ast, comments = parser.parse_with_comments(buffer)
-        rescue Parser::SyntaxError # rubocop:disable Lint/HandleExceptions
-          # All errors are in diagnostics. No need to handle exception.
-        end
+      # @return Reek::AST::Node the AST presentation for the given code
+      def parse
+        buffer = Parser::Source::Buffer.new(origin, 1)
+        buffer.source = code
+        ast, comments = parser.parse_with_comments(buffer)
 
         # 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
-
-      # :reek:TooManyStatements: { max_statements: 6 }
-      # :reek:FeatureEnvy
-      def default_parser
-        Parser::Ruby24.new(AST::Builder.new).tap do |parser|
-          diagnostics = parser.diagnostics
-          diagnostics.all_errors_are_fatal = false
-          diagnostics.ignore_warnings      = false
-          diagnostics.consumer = lambda do |diagnostic|
-            @diagnostics << diagnostic
-          end
-        end
+        comment_map = Parser::Source::Comment.associate(ast, comments)
+        TreeDresser.new.dress(ast, comment_map) || AST::Node.new(:empty)
       end
     end
   end

data/lib/reek/source/source_locator.rb

@@ -24,7 +24,7 @@ module Reek
       # Traverses all paths we initialized the SourceLocator with, finds
       # all relevant Ruby files and returns them as a list.
       #
-      # @return [Array<Pathname>] - Ruby paths found
+      # @return [Array<Pathname>] Ruby paths found
       def sources
         source_paths
       end
@@ -33,8 +33,8 @@ module Reek
 
       attr_reader :configuration, :paths, :options
 
-      # :reek:TooManyStatements: { max_statements: 7 }
-      # :reek:NestedIterators: { max_allowed_nesting: 2 }
+      # @quality :reek:TooManyStatements { max_statements: 7 }
+      # @quality :reek:NestedIterators { max_allowed_nesting: 2 }
       def source_paths
         paths.each_with_object([]) do |given_path, relevant_paths|
           unless given_path.exist?
@@ -67,12 +67,12 @@ module Reek
         configuration.path_excluded?(path)
       end
 
-      # :reek:UtilityFunction
+      # @quality :reek:UtilityFunction
       def print_no_such_file_error(path)
         warn "Error: No such file - #{path}"
       end
 
-      # :reek:UtilityFunction
+      # @quality :reek:UtilityFunction
       def hidden_directory?(path)
         path.basename.to_s.start_with? '.'
       end
@@ -81,12 +81,12 @@ module Reek
         path_excluded?(path) || hidden_directory?(path)
       end
 
-      # :reek:UtilityFunction
+      # @quality :reek:UtilityFunction
       def ruby_file?(path)
         path.extname == '.rb'
       end
 
-      # :reek:UtilityFunction
+      # @quality :reek:UtilityFunction
       def current_directory?(path)
         [Pathname.new('.'), Pathname.new('./')].include?(path)
       end

data/lib/reek/spec/should_reek.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../examiner'
-require_relative '../report/formatter'
+require_relative '../report/simple_warning_formatter'
 
 module Reek
   module Spec
@@ -23,7 +23,7 @@ module Reek
       end
 
       def failure_message_when_negated
-        rpt = Report::Formatter.format_list(examiner.smells)
+        rpt = Report::SimpleWarningFormatter.new.format_list(examiner.smells)
         "Expected no smells, but got:\n#{rpt}"
       end
 

data/lib/reek/spec/should_reek_of.rb

@@ -2,6 +2,7 @@
 
 require_relative '../examiner'
 require_relative 'smell_matcher'
+require_relative '../configuration/app_configuration'
 
 module Reek
   module Spec
@@ -14,12 +15,13 @@ module Reek
 
       attr_reader :failure_message, :failure_message_when_negated
 
-      def initialize(smell_type_or_class,
+      def initialize(smell_type,
                      smell_details = {},
                      configuration = Configuration::AppConfiguration.default)
-        @smell_type = normalize smell_type_or_class
+        @smell_type = smell_type.to_s
         @smell_details = smell_details
-        configuration.load_values(smell_type => { SmellConfiguration::ENABLED_KEY => true })
+        configuration.load_values(Configuration::AppConfiguration::DETECTORS_KEY =>
+                                    { smell_type => { SmellConfiguration::ENABLED_KEY => true } })
         @configuration = configuration
       end
 
@@ -34,7 +36,8 @@ module Reek
 
       def with_config(config_hash)
         new_configuration = Configuration::AppConfiguration.default
-        new_configuration.load_values(smell_type => config_hash)
+        new_configuration.load_values(Configuration::AppConfiguration::DETECTORS_KEY =>
+                                        { smell_type => config_hash })
         self.class.new(smell_type, smell_details, new_configuration)
       end
 
@@ -82,7 +85,7 @@ module Reek
           "#{smell_type} with smell details #{smell_details}, but it did"
       end
 
-      # :reek:FeatureEnvy
+      # @quality :reek:FeatureEnvy
       def all_relevant_smell_details_formatted
         matching_smell_types.each_with_object([]).with_index do |(smell, accumulator), index|
           accumulator << "#{index + 1}.)\n"
@@ -93,17 +96,7 @@ module Reek
       end
 
       def origin
-        examiner.description
-      end
-
-      # :reek:UtilityFunction
-      def normalize(smell_type_or_class)
-        case smell_type_or_class
-        when Class
-          smell_type_or_class.smell_type
-        else
-          smell_type_or_class.to_s
-        end
+        examiner.origin
       end
     end
   end

data/lib/reek/spec/should_reek_only_of.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../examiner'
-require_relative '../report/formatter'
+require_relative '../report/simple_warning_formatter'
 require_relative 'should_reek_of'
 require_relative 'smell_matcher'
 
@@ -24,12 +24,12 @@ module Reek
       end
 
       def failure_message
-        rpt = Report::Formatter.format_list(warnings)
-        "Expected #{examiner.description} to reek only of #{smell_type}, but got:\n#{rpt}"
+        rpt = Report::SimpleWarningFormatter.new.format_list(warnings)
+        "Expected #{examiner.origin} to reek only of #{smell_type}, but got:\n#{rpt}"
       end
 
       def failure_message_when_negated
-        "Expected #{examiner.description} not to reek only of #{smell_type}, but it did"
+        "Expected #{examiner.origin} not to reek only of #{smell_type}, but it did"
       end
 
       private

data/lib/reek/spec.rb

@@ -65,7 +65,7 @@ module Reek
     # raise an ArgumentError to give you a hint that you passed something that doesn't make
     # much sense.
     #
-    # @param smell_type [Symbol, String, Class] The "smell type" to check for.
+    # @param smell_type [Symbol, String] The "smell type" to check for.
     # @param smell_details [Hash] A hash containing "smell warning" parameters
     #
     # @example Without smell_details
@@ -84,7 +84,7 @@ module Reek
     #
     # @public
     #
-    # :reek:UtilityFunction
+    # @quality :reek:UtilityFunction
     def reek_of(smell_type,
                 smell_details = {},
                 configuration = Configuration::AppConfiguration.default)
@@ -99,11 +99,11 @@ module Reek
     #       "reek_only_of" will fail in that case.
     #   2.) "reek_only_of" doesn't support the additional smell_details hash.
     #
-    # @param smell_type [Symbol, String, Class] The "smell type" to check for.
+    # @param smell_type [Symbol, String] The "smell type" to check for.
     #
     # @public
     #
-    # :reek:UtilityFunction
+    # @quality :reek:UtilityFunction
     def reek_only_of(smell_type, configuration = Configuration::AppConfiguration.default)
       ShouldReekOnlyOf.new(smell_type, configuration)
     end
@@ -113,8 +113,8 @@ module Reek
     #
     # @public
     #
-    # :reek:UtilityFunction
-    def reek(configuration = Configuration::AppConfiguration.from_path)
+    # @quality :reek:UtilityFunction
+    def reek(configuration = Configuration::AppConfiguration.from_default_path)
       ShouldReek.new(configuration: configuration)
     end
   end

data/lib/reek/tree_dresser.rb

@@ -31,14 +31,14 @@ module Reek
     # time the nodes will contain type-dependent mixins, e.g. this:
     #   (const nil :Klazz)
     #  will be of type Reek::AST::Node with  Reek::AST::SexpExtensions::ConstNode mixed in.
-    # @param sexp [Parser::AST::Node] - the given sexp
-    # @param comment_map [Hash] - see the documentation for SourceCode#syntax_tree
-    # @param parent [Parser::AST::Node] - the parent sexp
+    #
+    # @param sexp [Parser::AST::Node] the given sexp
+    # @param comment_map [Hash] see the documentation for SourceCode#syntax_tree
     #
     # @return an instance of Reek::AST::Node with type-dependent sexp extensions mixed in.
     #
-    # :reek:FeatureEnvy
-    # :reek:TooManyStatements: { max_statements: 6 }
+    # @quality :reek:FeatureEnvy
+    # @quality :reek:TooManyStatements { max_statements: 6 }
     def dress(sexp, comment_map)
       return sexp unless sexp.is_a? ::Parser::AST::Node
       type = sexp.type

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '4.7.3'.freeze
+    STRING = '5.0.0'
   end
 end