reek 6.0.2 → 6.5.0

data/README.md

@@ -35,15 +35,15 @@
 
 ## Overview
 
-* [![Build Status](https://secure.travis-ci.org/troessner/reek.svg?branch=master)](https://travis-ci.org/troessner/reek?branch=master)
+* ![Downloads](https://img.shields.io/badge/Downloads-%3E24_million-blue)
+* ![Build Status](https://github.com/troessner/reek/actions/workflows/ruby.yml/badge.svg?branch=master)
 * [![Gem Version](https://badge.fury.io/rb/reek.svg)](https://badge.fury.io/rb/reek)
-* ![](http://img.shields.io/github/tag/troessner/reek.svg)
-* ![](http://img.shields.io/badge/license-MIT-brightgreen.svg)
+* ![Git Tag](http://img.shields.io/github/tag/troessner/reek.svg)
+* ![Licence](http://img.shields.io/badge/license-MIT-brightgreen.svg)
 * [![Inline docs](https://inch-ci.org/github/troessner/reek.png)](https://inch-ci.org/github/troessner/reek)
 * [![Code Climate](https://codeclimate.com/github/troessner/reek/badges/gpa.svg)](https://codeclimate.com/github/troessner/reek)
 * [![codebeat](https://codebeat.co/badges/42fed4ff-3e55-4aed-8ecc-409b4aa539b3)](https://codebeat.co/projects/github-com-troessner-reek)
-* ![](http://ruby-gem-downloads-badge.herokuapp.com/reek?type=total)
-* ![](http://ruby-gem-downloads-badge.herokuapp.com/reek?label=downloads-current-version)
+
 
 ## Quickstart
 
@@ -56,13 +56,13 @@ or [that one](https://troessner.svbtle.com/the-latest-and-greatest-additions-to-
 
 Install it via rubygems:
 
-```Bash
+```bash
 gem install reek
 ```
 
 and run it like this:
 
-```Bash
+```bash
 reek [options] [dir_or_source_file]*
 ```
 
@@ -70,7 +70,7 @@ reek [options] [dir_or_source_file]*
 
 Imagine a source file `demo.rb` containing:
 
-```Ruby
+```ruby
 # Smelly class
 class Smelly
   # This will reek of UncommunicativeMethodName
@@ -94,7 +94,7 @@ demo.rb -- 2 warnings:
 
 ## Supported Ruby versions
 
-Reek is officially supported for CRuby 2.4 to 2.7 and for JRuby 9.2.
+Reek is officially supported for CRuby 3.0 through 3.3 and for JRuby 9.4.
 Other Ruby implementations (like Rubinius) are not officially supported but
 should work as well.
 
@@ -111,7 +111,7 @@ language and business logic.
 That said, an example might help you get going. Have a look at this sample of a
 Ruby on Rails model (be aware that this is truncated, not working code):
 
-```Ruby
+```ruby
 class ShoppingCart < ActiveRecord::Base
   has_many :items
 
@@ -140,7 +140,7 @@ would report:
 Fixing this is pretty straightforward. Put the gross price calculation for a single item
 where it belongs, which would be the `Item` class:
 
-```Ruby
+```ruby
 class ShoppingCart < ActiveRecord::Base
   has_many :items
 
@@ -165,7 +165,7 @@ those first when you have a warning that you don't know how to deal with.
 
 There are multiple ways you can have Reek work on sources, the most common one just being
 
-```Bash
+```bash
 reek lib/
 ```
 
@@ -173,25 +173,25 @@ If you don't pass any source arguments to Reek it just takes the current working
 
 So
 
-```Bash
+```bash
 reek
 ```
 
 is the exact same thing as being explicit:
 
-```Bash
+```bash
 reek .
 ```
 
 Additionally you can pipe code to Reek like this:
 
-```Bash
+```bash
 echo "class C; def m; end; end" | reek
 ```
 
 This would print out:
 
-```Bash
+```bash
 $stdin -- 3 warnings:
   [1]:C has no descriptive comment (IrresponsibleModule)
   [1]:C has the name 'C' (UncommunicativeModuleName)
@@ -219,7 +219,7 @@ for up to date details of exactly what Reek will check in your code.
 because it is [kind of controversial](https://github.com/troessner/reek/issues/844) which means
 you have to explicitly activate it in your configuration via
 
-```Yaml
+```yaml
 UnusedPrivateMethod:
   enabled: true
 ```
@@ -228,7 +228,7 @@ UnusedPrivateMethod:
 as well that can turn out to be really unforgiving.
 As a consequence, we made it possible to disable it for non-public methods like this:
 
-```Yaml
+```yaml
 ---
 UtilityFunction:
   public_methods_only: true
@@ -240,7 +240,7 @@ UtilityFunction:
 
 For a basic overview, run
 
-```Ruby
+```ruby
 reek --help
 ```
 
@@ -328,7 +328,7 @@ directories:
 exclude_paths:
   - lib/legacy
   - lib/rake/legacy_tasks
-  - lib/smelly.rb  
+  - lib/smelly.rb
 ```
 
 As you see above, Reek's configuration consists of 3 different sections denoted by 3 different keys:
@@ -395,7 +395,7 @@ In case you need to suppress a smell warning and you can't or don't want to
 use configuration files for whatever reasons you can also use special
 source code comments like this:
 
-```Ruby
+```ruby
 # This method smells of :reek:NestedIterators
 def smelly_method foo
   foo.each {|bar| bar.each {|baz| baz.qux}}
@@ -404,14 +404,14 @@ end
 
 You can even pass in smell specific configuration settings:
 
-```Ruby
+```ruby
 # :reek:NestedIterators { max_allowed_nesting: 2 }
 def smelly_method foo
   foo.each {|bar| bar.each {|baz| baz.qux}}
 end
 ```
 
-This is an incredibly powerful feature and further explained under [Smell Suppresion](docs/Smell-Suppression.md).
+This is an incredibly powerful feature and further explained under [Smell Suppression](docs/Smell-Suppression.md).
 
 #### Debugging trouble with the configuration
 
@@ -432,7 +432,7 @@ codebase this might not be an option.
 Fortunately Reek provides a 'todo' flag which you can use to generate a configuration that will
 suppress all smell warnings for the current codebase:
 
-```Bash
+```bash
 reek --todo lib/
 ```
 
@@ -447,7 +447,7 @@ If for whatever reasons you decide to put '.reek.yml' somewhere else where
 Reek won't pick it up automatically you need to tell Reek explicitly to do so
 via:
 
-```Bash
+```bash
 reek -c whatever/.reek.yml lib/
 ```
 
@@ -461,7 +461,7 @@ and instead abort execution. It also will not take **any** other configuration f
 
 This means that when you run
 
-```Bash
+```bash
 reek -c other_configuration.reek --todo lib/
 ```
 
@@ -474,7 +474,7 @@ but keep in mind that this is not the intended use case of this feature.
 
 Besides the obvious
 
-```Bash
+```bash
 reek [options] [dir_or_source_file]*
 ```
 
@@ -514,18 +514,15 @@ Another useful Rake task is the `console` task. This will throw you right into a
 ```
 bundle exec rake console
 
-[3] pry(main)> require_relative 'lib/reek/examiner'
-=> true
-[4] pry(main)> Reek::Examiner
+irb(main):001> Reek::Examiner
 => Reek::Examiner
 ```
 
-You can also use Pry while running the tests by adding the following at the
+You can also use IRB while running the tests by adding the following at the
 point where you want to start debugging:
 
-```Ruby
-require 'pry'
-binding.pry
+```ruby
+binding.irb
 ```
 
 Have a look at our [Developer API](docs/API.md) for more inspiration.
@@ -556,20 +553,21 @@ e.g., `codeclimate analyze -e duplication`
 
 ## Output formats
 
-Reek supports 5 output formats:
+Reek supports 6 output formats:
 
 * plain text (default)
-* HTML (`--format html`)
-* YAML (`--format yaml`, see also [YAML Reports](docs/YAML-Reports.md))
-* JSON (`--format json`)
-* XML  (`--format xml`)
+* HTML   (`--format html`)
+* YAML   (`--format yaml`, see also [YAML Reports](docs/YAML-Reports.md))
+* JSON   (`--format json`)
+* XML    (`--format xml`)
+* GitHub (`--format github`)
 
 ## Working with Rails
 
 Making Reek "Rails"-friendly is fairly simple since we support directory specific configurations (`directory directives` in Reek talk).
 Just add this to your configuration file:
 
-```Yaml
+```yaml
 directories:
   "app/controllers":
     IrresponsibleModule:

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/clean'
 

data/bin/code_climate_reek

@@ -6,7 +6,8 @@
 
 require_relative '../lib/reek'
 require_relative '../lib/reek/cli/application'
-require_relative '../lib/reek/report/code_climate'
+require_relative '../lib/reek/code_climate'
+Reek::CLI::Silencer.silently { require 'parser/current' }
 
 # Map input coming from CodeClimate to Reek.
 class CodeClimateToReek
@@ -14,15 +15,16 @@ class CodeClimateToReek
   # we have to exit with a zero for both failure and success.
   ENGINE_CONFIGURATION = [
     '--failure-exit-code', '0',
-    '--success-exit-code', '0',
-    '.'
+    '--success-exit-code', '0'
   ].freeze
+  CUSTOM_CONFIG_KEY = 'config'
+  CUSTOM_CONFIG_TARGET_RUBY_VERSION_KEY = 'target_ruby_version'
 
   attr_reader :configuration_file_path, :include_paths_key, :include_paths_default
 
   def initialize(configuration_file_path: '/config.json',
                  include_paths_key: 'include_paths',
-                 include_paths_default: [])
+                 include_paths_default: ['.'])
     @configuration_file_path = configuration_file_path
     @include_paths_key       = include_paths_key
     @include_paths_default   = include_paths_default
@@ -32,6 +34,10 @@ class CodeClimateToReek
     include_paths + ENGINE_CONFIGURATION
   end
 
+  def target_ruby_version
+    config.dig(CUSTOM_CONFIG_KEY, CUSTOM_CONFIG_TARGET_RUBY_VERSION_KEY)
+  end
+
   private
 
   def configuration_file_exists?
@@ -46,11 +52,14 @@ class CodeClimateToReek
   #   ]
   # }
   def include_paths
+    config.fetch include_paths_key, include_paths_default
+  end
+
+  def config
     if configuration_file_exists?
-      config = JSON.parse File.read(configuration_file_path)
-      config.fetch include_paths_key, include_paths_default
+      JSON.parse File.read(configuration_file_path)
     else
-      include_paths_default
+      {}
     end
   end
 end
@@ -58,11 +67,50 @@ end
 # Override for ReportCommand to force the use of CodeClimateReport.
 module ReportClassOverride
   def report_class
-    Reek::Report::CodeClimateReport
+    Reek::CodeClimate::CodeClimateReport
+  end
+end
+
+# Override Reek::Source::SourceCode to use a parser version specified by the user
+module SourceCodeOverride
+  # override self.default_parser method
+  def default_parser
+    parser_class.new(Reek::AST::Builder.new).tap do |parser|
+      diagnostics = parser.diagnostics
+      diagnostics.all_errors_are_fatal = true
+      diagnostics.ignore_warnings      = true
+    end
+  end
+
+  # config.json file will look like this:
+  # {
+  #   "include_paths":[
+  #     "lib",
+  #     "spec"
+  #   ],
+  #   "config": {
+  #     "target_ruby_version": "3.1.0"
+  #   }
+  # }
+  def parser_class
+    # convert an X.Y.Z version number to an XY two digit number
+    requested_version = CodeClimateToReek.new.target_ruby_version
+    return Parser::CurrentRuby if requested_version.nil?
+
+    version_number = Gem::Version.new(requested_version).segments[0..1].join
+
+    begin
+      Reek::CLI::Silencer.silently { require "parser/ruby#{version_number}" }
+      Module.const_get("Parser::Ruby#{version_number}")
+    rescue LoadError, NameError
+      # use Parser::CurrentRuby when an invalid version number is provided
+      Parser::CurrentRuby
+    end
   end
 end
 
 Reek::CLI::Command::ReportCommand.prepend ReportClassOverride
+Reek::Source::SourceCode.singleton_class.prepend SourceCodeOverride
 
 application = Reek::CLI::Application.new(CodeClimateToReek.new.cli_arguments)
 

data/docs/yard_plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yard'
 
 # Template helper to modify processing of links in HTML generated from our
@@ -7,7 +9,7 @@ module LocalLinkHelper
   # {file: } directives.
   def resolve_links(text)
     text = text.gsub(%r{<a href="([^"]*.md)">([^<]*)</a>}, '{file:\1 \2}')
-    super text
+    super
   end
 end
 

data/lib/reek/ast/ast_node_class_map.rb

@@ -30,7 +30,7 @@ module Reek
                 SexpExtensions.const_get(const)
               ]
             end
-            Hash[assoc]
+            assoc.to_h
           end
       end
 

data/lib/reek/ast/node.rb

@@ -9,6 +9,11 @@ module Reek
     # methods to ease the transition from Sexp to AST::Node.
     #
     class Node < ::Parser::AST::Node
+      # Struct representing the rules for the search performed by each_node method.
+      NodeLookupRule = Struct.new(:target_types, :ignoring)
+
+      private_constant :NodeLookupRule
+
       def initialize(type, children = [], options = {})
         @comments = options.fetch(:comments, [])
         super
@@ -60,9 +65,10 @@ module Reek
       #
       # Returns an array with all matching nodes.
       def each_node(target_types, ignoring = [], &blk)
-        return enum_for(:each_node, target_types, ignoring) unless block_given?
+        return enum_for(:each_node, target_types, ignoring) unless blk
 
-        look_for(Array(target_types), ignoring, &blk)
+        lookup_rule = NodeLookupRule.new(Array(target_types), ignoring)
+        look_for(lookup_rule, &blk)
       end
 
       def contains_nested_node?(target_type)
@@ -108,23 +114,23 @@ module Reek
       protected
 
       # See ".each_node" for documentation.
-      def look_for(target_types, ignoring, &blk)
-        if target_types.include? type
+      def look_for(lookup_rule, &blk)
+        if lookup_rule.target_types.include?(type)
           yield self
-          return if ignoring.include?(type)
+          return if lookup_rule.ignoring.include?(type)
         end
         each_sexp do |elem|
-          elem.look_for_recurse(target_types, ignoring, &blk)
+          elem.look_for_recurse(lookup_rule, &blk)
         end
       end
 
       # See ".each_node" for documentation.
-      def look_for_recurse(target_types, ignoring, &blk)
-        yield self if target_types.include? type
-        return if ignoring.include? type
+      def look_for_recurse(lookup_rule, &blk)
+        yield self if lookup_rule.target_types.include?(type)
+        return if lookup_rule.ignoring.include?(type)
 
         each_sexp do |elem|
-          elem.look_for_recurse(target_types, ignoring, &blk)
+          elem.look_for_recurse(lookup_rule, &blk)
         end
       end
 

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

@@ -104,6 +104,26 @@ module Reek
         end
       end
       # rubocop:enable Naming/ClassAndModuleCamelCase
+
+      # Utility methods for :forward_arg nodes.
+      # rubocop:disable Naming/ClassAndModuleCamelCase
+      module Forward_ArgNode
+        include ArgNodeBase
+
+        def anonymous_splat?
+          true
+        end
+      end
+      # rubocop:enable Naming/ClassAndModuleCamelCase
+
+      # Utility methods for :kwnilarg nodes.
+      module KwnilargNode
+        include ArgNodeBase
+
+        def anonymous_splat?
+          true
+        end
+      end
     end
   end
 end

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

@@ -10,7 +10,7 @@ module Reek
         end
 
         def body_nodes(type, ignoring = [])
-          children[1..-1].compact.flat_map do |child|
+          children[1..].compact.flat_map do |child|
             child.each_node(type, ignoring | type).to_a
           end
         end

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

@@ -31,7 +31,7 @@ module Reek
 
         # @quality :reek:FeatureEnvy
         def body_nodes(type, ignoring = [])
-          children[1..-1].compact.flat_map do |child|
+          children[1..].compact.flat_map do |child|
             if ignoring.include? child.type
               []
             else

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

@@ -16,7 +16,7 @@ module Reek
         end
 
         def args
-          children[2..-1]
+          children[2..]
         end
 
         def participants
@@ -24,13 +24,10 @@ module Reek
         end
 
         def module_creation_call?
-          object_creation_call? && module_creation_receiver?
-        end
+          return true if object_creation_call? && module_creation_receiver?
+          return true if data_definition_call? && data_definition_receiver?
 
-        def module_creation_receiver?
-          receiver &&
-            receiver.type == :const &&
-            [:Class, :Struct].include?(receiver.simple_name)
+          false
         end
 
         def object_creation_call?
@@ -47,6 +44,24 @@ module Reek
         def attr_with_writable_flag?
           name == :attr && args.any? && args.last.type == :true
         end
+
+        private
+
+        def module_creation_receiver?
+          const_receiver? && [:Class, :Struct].include?(receiver.simple_name)
+        end
+
+        def data_definition_call?
+          name == :define
+        end
+
+        def data_definition_receiver?
+          const_receiver? && receiver.simple_name == :Data
+        end
+
+        def const_receiver?
+          receiver && receiver.type == :const
+        end
       end
 
       Op_AsgnNode = SendNode

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

@@ -13,7 +13,7 @@ module Reek
       #
       class TodoListCommand < BaseCommand
         HEADER = "# Auto generated by Reeks --todo flag\n"
-        EXISTING_FILE_MESSAGE = "\nExisting '#{DEFAULT_CONFIGURATION_FILE_NAME}' detected - aborting.\n"
+        EXISTING_FILE_MESSAGE = "\nExisting '#{DEFAULT_CONFIGURATION_FILE_NAME}' detected - aborting.\n".freeze
         NO_SMELLS_FOUND_MESSAGE = "\nNo smells found - nothing to do, exiting.\n"
 
         def execute
@@ -23,8 +23,8 @@ module Reek
             puts EXISTING_FILE_MESSAGE
           else
             write_to_file
-            puts "\n'#{DEFAULT_CONFIGURATION_FILE_NAME}' generated! "\
-              'You can now use this as a starting point.'
+            puts "\n'#{DEFAULT_CONFIGURATION_FILE_NAME}' generated! " \
+                 'You can now use this as a starting point.'
           end
           options.success_exit_code
         end

data/lib/reek/cli/options.rb

@@ -110,12 +110,12 @@ module Reek
         parser.on('--smell SMELL',
                   'Only look for a specific smell.',
                   'Call it like this: reek --smell MissingSafeMethod source.rb',
-                  "Check out #{DocumentationLink.build('Code Smells')} "\
+                  "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 '\
+                  '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
@@ -131,9 +131,9 @@ module Reek
       def set_alternative_formatter_options
         parser.separator "\nReport format:"
         parser.on(
-          '-f', '--format FORMAT', [:html, :text, :yaml, :json, :xml],
+          '-f', '--format FORMAT', [:html, :text, :yaml, :json, :xml, :github],
           'Report smells in the given format:',
-          '  html', '  text (default)', '  yaml', '  json', '  xml') do |opt|
+          '  html', '  text (default)', '  yaml', '  json', '  xml', '  github') do |opt|
           self.report_format = opt
         end
       end
@@ -210,12 +210,12 @@ module Reek
       def set_exit_codes
         parser.separator "\nExit codes:"
         parser.on('--success-exit-code CODE',
-                  'The exit code when no smells are found '\
+                  'The exit code when no smells are found ' \
                   "(default: #{Status::DEFAULT_SUCCESS_EXIT_CODE})") do |option|
           self.success_exit_code = Integer(option)
         end
         parser.on('--failure-exit-code CODE',
-                  'The exit code when smells are found '\
+                  'The exit code when smells are found ' \
                   "(default: #{Status::DEFAULT_FAILURE_EXIT_CODE})") do |option|
           self.failure_exit_code = Integer(option)
         end
@@ -231,8 +231,8 @@ module Reek
         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'
+          puts "\nCheck out #{DocumentationLink.build('Code Smells')} " \
+               'for a details on each detector'
           exit
         end
         parser.on_tail('-v', '--version', 'Show version') do

data/lib/reek/{report/code_climate → code_climate}/code_climate_configuration.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Reek
-  module Report
+  module CodeClimate
     # loads the smell type metadata to present in Code Climate
     module CodeClimateConfiguration
       def self.load