reek 4.8.2 → 5.0.0

data/lib/reek/source/source_code.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../cli/silencer'
-Reek::CLI::Silencer.silently do
-  require 'parser/ruby25'
-end
+Reek::CLI::Silencer.without_warnings { require 'parser/ruby25' }
 require_relative '../tree_dresser'
 require_relative '../ast/node'
 require_relative '../ast/builder'
@@ -14,94 +12,82 @@ 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
-      # Consume and store parser diagnostics
-      class DiagnosticsConsumer
-        def initialize
-          @diagnostics = []
-        end
-
-        def call(item)
-          @diagnostics << item
-        end
-
-        def result
-          @diagnostics
-        end
-      end
-
-      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 code
-      def initialize(code:, origin:, parser: self.class.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
         @parser = parser
-        code.force_encoding(Encoding::UTF_8)
-        @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
 
-      def diagnostics
-        parse_result.last
-      end
-
       def syntax_tree
-        parse_result.first
+        @syntax_tree ||= parse
       end
 
       def self.default_parser
         Parser::Ruby25.new(AST::Builder.new).tap do |parser|
           diagnostics = parser.diagnostics
-          diagnostics.all_errors_are_fatal = false
-          diagnostics.ignore_warnings      = false
-          diagnostics.consumer = DiagnosticsConsumer.new
+          diagnostics.all_errors_are_fatal = true
+          diagnostics.ignore_warnings      = true
         end
       end
 
+      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_result
-        @parse_result ||= parse
+      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 :code
-      attr_reader :parser
+      attr_reader :parser, :source
 
       # 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 @code:
       #
       #   # comment about C
@@ -123,8 +109,7 @@ module Reek
       # 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, Array] the AST presentation
-      #         for the given code, List of diagnostics messages
+      # @return Reek::AST::Node the AST presentation for the given code
       def parse
         buffer = Parser::Source::Buffer.new(origin, 1)
         buffer.source = code
@@ -132,7 +117,7 @@ module Reek
 
         # See https://whitequark.github.io/parser/Parser/Source/Comment/Associator.html
         comment_map = Parser::Source::Comment.associate(ast, comments)
-        [TreeDresser.new.dress(ast, comment_map), parser.diagnostics.consumer.result]
+        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.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/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/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.8.2'.freeze
+    STRING = '5.0.0'
   end
 end

data/reek.gemspec

@@ -5,7 +5,6 @@ Gem::Specification.new do |s|
   s.version = Reek::Version::STRING
 
   s.authors = ['Kevin Rutherford', 'Timo Roessner', 'Matijs van Zuijlen', 'Piotr Szotkowski']
-  s.default_executable = 'reek'
   s.description =
     'Reek is a tool that examines Ruby classes, modules and methods and reports ' \
     'any code smells it finds.'
@@ -15,12 +14,13 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ['CHANGELOG.md', 'License.txt']
   s.files = `git ls-files -z`.split("\0")
   s.executables = s.files.grep(%r{^bin/}).map { |path| File.basename(path) }
-  s.homepage = 'https://github.com/troessner/reek/wiki'
+  s.homepage = 'https://github.com/troessner/reek'
   s.rdoc_options = %w(--main README.md -x assets/|bin/|config/|features/|spec/|tasks/)
-  s.required_ruby_version = '>= 2.1.0'
+  s.required_ruby_version = '>= 2.3.0'
   s.summary = 'Code smell detector for Ruby'
 
   s.add_runtime_dependency 'codeclimate-engine-rb', '~> 0.4.0'
+  s.add_runtime_dependency 'kwalify',               '~> 0.7.0'
   s.add_runtime_dependency 'parser',                '< 2.6', '>= 2.5.0.0'
   s.add_runtime_dependency 'rainbow',               '>= 2.0', '< 4.0'
 end

data/samples/checkstyle.xml

@@ -1,6 +1,6 @@
 <?xml version='1.0'?>
 <checkstyle>
-  <file name='samples/smelly.rb'>
+  <file name='samples/smelly_source/smelly.rb'>
     <error column='0' line='4' message='has the name &apos;x&apos;' severity='warning' source='UncommunicativeMethodName'/>
     <error column='0' line='5' message='has the variable name &apos;y&apos;' severity='warning' source='UncommunicativeVariableName'/>
   </file>

data/samples/configuration/accepts_rejects_and_excludes_for_detectors.reek.yml

@@ -0,0 +1,29 @@
+---
+detectors:
+  UnusedPrivateMethod:
+    exclude:
+      - "/exclude regexp/"
+  UncommunicativeMethodName:
+    reject:
+      - "reject name"
+    accept:
+      - "accept name"
+  UncommunicativeModuleName:
+    reject:
+      - "reject name 1"
+      - "reject name 2"
+    accept:
+      - "accept name 1"
+      - "accept name 2"
+  UncommunicativeParameterName:
+    reject:
+      - "reject name"
+      - "/reject regexp/"
+    accept:
+      - "accept name"
+      - "/accept regexp/"
+  UncommunicativeVariableName:
+    reject:
+      - "/^reject regexp$/"
+    accept:
+      - "/accept(.*)regexp/"