reek 5.6.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da76dfc3aa1c997bffe832e526907dcf847cb5d86e04bc7c084abe074247e5d7
-  data.tar.gz: 7abc545f4176d0f561797c092bea15f1630b824a3d3ba37b99975450eb3ec3df
+  metadata.gz: bf5a72026003b4d6b44ec51ba559efda3de62733061d6889596d8661ec24a12c
+  data.tar.gz: 142319663079b82d851245cf6aa0e3a07ea5418426d21c25171d4fae1adc8549
 SHA512:
-  metadata.gz: 7fe6f93cf2fe75c232327e1250c4e72c10c88707ce57879341f43b5a8a195ddb0282d9433e60cb19f635923edcb3fa52bbaadb187b5ee67d4b4cea7fc72ce901
-  data.tar.gz: a55abca10a6875077fda0b873667407f1dddf1840963fd6463ed918db9d9e58408fa93acf5a7e4741d9d488dede75963ad422c2150953e3d69f7af840a563dfd
+  metadata.gz: 8a626593f82fcb8307629380ca25374b73d013561a3c2b0ffb2a7b5175997632b1f2925add8fb2d7ff1fe10d3a6343ee8998d5d167d45ce09888ea59c8c2ec6e
+  data.tar.gz: f081217d15f01c31cc014ef935b359614ee412c8aa7c0fbbb22e40db0caa1dd0429b727935c02542ea1e73ca7023b15cb25d639d644e8ab3af42af33870f0de6

data/.gitignore

@@ -1,4 +1,5 @@
 pkg
+spec/examples.txt
 spec/output
 tmp
 doc

data/.rubocop.yml

@@ -9,7 +9,7 @@ AllCops:
     - 'samples/**/*'
     - 'tmp/**/*'
     - 'vendor/**/*'
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 
 # Tables are nice
 Layout/HashAlignment:

data/.simplecov

@@ -5,6 +5,7 @@ SimpleCov.start do
   add_filter 'spec/'
   add_filter 'samples/'
   coverage_dir 'tmp/coverage'
+  enable_coverage :branch
 end
 
 SimpleCov.at_exit do

data/.travis.yml

@@ -1,35 +1,36 @@
-dist: trusty
-cache: bundler
 language: ruby
+
+dist: xenial
+
+cache:
+  bundler: true
+
 bundler_args: --without debugging
-before_script:
-  # Avoid Java announcing _JAVA_OPTIONS environment variable
-  # See https://github.com/travis-ci/travis-ci/issues/8408
-  - unset _JAVA_OPTIONS
+
 script: bundle exec rake ci
+
 rvm:
-  - 2.3
   - 2.4
   - 2.5
   - 2.6
   - 2.7
-  - jruby-9.1.17.0
-  - jruby-9.2.6.0
+  - jruby-9.2
   - jruby-head
   - ruby-head
-  - rubinius-3
+
 matrix:
   allow_failures:
     - rvm: jruby-head
     - rvm: ruby-head
-    - rvm: rubinius-3
   fast_finish: true
+
 notifications:
   email:
     - timo.roessner@googlemail.com
     - matijs@matijs.net
     - chastell@chastell.net
   irc: irc.freenode.org#reek
+
 branches:
   only:
     - master

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+## 6.0.0 (2020-03-30)
+
+* (mvz) Make codeclimate-engine-rb a development dependency
+* (mvz) Drop support for Ruby 2.3
+* (mvz) Raise error when legacy code comment format is used
+* (mvz) Stop reporting NilCheck for safe navigation
+* (likeath) Properly handle "Forward all" syntax
+
 ## 5.6.0 (2020-01-20)
 
 * (mvz) Support Ruby 2.7

data/Dockerfile

@@ -22,6 +22,7 @@ WORKDIR ${app_dir}
 
 RUN gem install rake
 RUN bundle install --without debugging development
+RUN gem install codeclimate-engine-rb
 
 VOLUME ${code_dir}
 WORKDIR ${code_dir}

data/Gemfile

@@ -5,19 +5,20 @@ gemspec
 ruby RUBY_VERSION
 
 group :development do
-  gem 'aruba',               '~> 0.14.8'
-  gem 'cucumber',            '~> 3.0'
-  gem 'factory_bot',         '~> 5.0', '!= 5.1.0'
-  gem 'kramdown',            '~> 2.1'
-  gem 'kramdown-parser-gfm', '~> 1.0'
-  gem 'rake',                '~> 13.0'
-  gem 'rspec',               '~> 3.0'
-  gem 'rspec-benchmark',     '~> 0.5.0'
-  gem 'rubocop',             '~> 0.79.0'
-  gem 'rubocop-performance', '~> 1.5.0'
-  gem 'rubocop-rspec',       '~> 1.37.0'
-  gem 'simplecov',           '~> 0.17.0'
-  gem 'yard',                '~> 0.9.5'
+  gem 'aruba',                 '~> 1.0'
+  gem 'codeclimate-engine-rb', '~> 0.4.0'
+  gem 'cucumber',              '~> 3.0'
+  gem 'factory_bot',           '~> 5.0', '!= 5.1.0'
+  gem 'kramdown',              '~> 2.1'
+  gem 'kramdown-parser-gfm',   '~> 1.0'
+  gem 'rake',                  '~> 13.0'
+  gem 'rspec',                 '~> 3.0'
+  gem 'rspec-benchmark',       '~> 0.6.0'
+  gem 'rubocop',               '~> 0.80.0'
+  gem 'rubocop-performance',   '~> 1.5.0'
+  gem 'rubocop-rspec',         '~> 1.38.1'
+  gem 'simplecov',             '~> 0.18.1'
+  gem 'yard',                  '~> 0.9.5'
 
   platforms :mri do
     gem 'redcarpet', '~> 3.4'
@@ -25,8 +26,5 @@ group :development do
 end
 
 group :debugging do
-  gem 'pry'
-  platforms :mri do
-    gem 'pry-byebug'
-  end
+  gem 'pry', '~> 0.13.0'
 end

data/README.md

@@ -45,12 +45,6 @@
 * ![](http://ruby-gem-downloads-badge.herokuapp.com/reek?type=total)
 * ![](http://ruby-gem-downloads-badge.herokuapp.com/reek?label=downloads-current-version)
 
-## Reek 5 is out!
-
-Reek 5 is out and with it a bunch of breaking changes. If you're a new user you can just
-continue with the quickstart below. If you're a Reek 4 user and would like to upgrade to 5, don't
-worry, this shouldn't take you more than 10 minutes. Check out our [Upgrade Guide](docs/Reek-4-to-Reek-5-migration.md).
-
 ## Quickstart
 
 Reek is a tool that examines Ruby classes, modules and methods and reports any
@@ -100,7 +94,7 @@ demo.rb -- 2 warnings:
 
 ## Supported Ruby versions
 
-Reek is officially supported for CRuby 2.3 to 2.6 and for JRuby 9.1 and 9.2.
+Reek is officially supported for CRuby 2.4 to 2.7 and for JRuby 9.2.
 Other Ruby implementations (like Rubinius) are not officially supported but
 should work as well.
 

data/bin/code_climate_reek

@@ -6,15 +6,16 @@
 
 require_relative '../lib/reek'
 require_relative '../lib/reek/cli/application'
+require_relative '../lib/reek/report/code_climate'
 
 # Map input coming from CodeClimate to Reek.
 class CodeClimateToReek
   # Following the spec (https://github.com/codeclimate/spec/blob/master/SPEC.md)
   # we have to exit with a zero for both failure and success.
   ENGINE_CONFIGURATION = [
-    '-f', 'code_climate',
     '--failure-exit-code', '0',
-    '--success-exit-code', '0'
+    '--success-exit-code', '0',
+    '.'
   ].freeze
 
   attr_reader :configuration_file_path, :include_paths_key, :include_paths_default
@@ -54,6 +55,15 @@ class CodeClimateToReek
   end
 end
 
+# Override for ReportCommand to force the use of CodeClimateReport.
+module ReportClassOverride
+  def report_class
+    Reek::Report::CodeClimateReport
+  end
+end
+
+Reek::CLI::Command::ReportCommand.prepend ReportClassOverride
+
 application = Reek::CLI::Application.new(CodeClimateToReek.new.cli_arguments)
 
 exit application.execute

data/docs/Attribute.md

@@ -29,7 +29,7 @@ test.rb -- 1 warning:
 
 ## Support in Reek
 
-This detector it raises a warning for every public `attr_writer`,
+This detector raises a warning for every public `attr_writer`,
 `attr_accessor`, and `attr` with the writable flag set to `true`.
 
 Reek does not raise warnings for read-only attributes.

data/docs/Control-Couple.md

@@ -14,7 +14,7 @@ controlling parameter must be reflected on both sides of the call. A _Control
 Couple_ also reveals a loss of simplicity: the called method probably has more
 than one responsibility, because it includes at least two different code paths.
 
-You can find a good write-up regarding this problem [here](http://solnic.eu/2012/04/11/get-rid-of-that-code-smell-control-couple.html).
+You can find a good write-up regarding this problem [here](https://solnic.codes/2012/04/11/get-rid-of-that-code-smell-control-couple/).
 
 ## Current Support in Reek
 

data/docs/Nil-Check.md

@@ -37,7 +37,10 @@ _Nil Check_ reports use of
 * <code>.nil?</code> method
 * <code>==</code> and <code>===</code> operators when checking vs. <code>nil</code>
 * case statements that use syntax like <code>when nil</code>
-* use of the safe navigation operator like `foo&.bar`
+
+_Nil Check_ allows use of
+
+* the safe navigation operator like `foo&.bar`
 
 ## Configuration
 

data/features/command_line_interface/options.feature

@@ -43,7 +43,7 @@ Feature: Reek can be controlled using command-line options
           -c, --config FILE                Read configuration options from FILE
               --smell SMELL                Only look for a specific smell.
                                            Call it like this: reek --smell MissingSafeMethod source.rb
-                                           Check out https://github.com/troessner/reek/blob/v5.6.0/docs/Code-Smells.md for a list of smells
+                                           Check out https://github.com/troessner/reek/blob/v6.0.0/docs/Code-Smells.md for a list of smells
               --stdin-filename FILE        When passing code in via pipe, assume this filename when checking file or directory rules in the config.
 
       Generate a todo list:
@@ -56,7 +56,6 @@ Feature: Reek can be controlled using command-line options
                                              yaml
                                              json
                                              xml
-                                             code_climate
 
       Text format options:
               --[no-]color                 Use colors for the output (default: true)
@@ -120,5 +119,5 @@ Feature: Reek can be controlled using command-line options
       UnusedPrivateMethod
       UtilityFunction
 
-      Check out https://github.com/troessner/reek/blob/v5.6.0/docs/Code-Smells.md for a details on each detector
+      Check out https://github.com/troessner/reek/blob/v6.0.0/docs/Code-Smells.md for a details on each detector
       """

data/features/reports/codeclimate.feature

@@ -4,7 +4,7 @@ Feature: Report smells using Code Climate format
 
   Scenario: output is empty when there are no smells
     Given a directory called 'clean' containing two clean files
-    When I run reek --format code_climate clean
+    When I run the code climate reek runner
     Then it succeeds
     And it reports this Code Climate output:
     """
@@ -12,7 +12,7 @@ Feature: Report smells using Code Climate format
 
   Scenario: Indicate smells and print them as JSON when using files
     Given the smelly file 'smelly.rb'
-    When I run reek --format code_climate smelly.rb
+    When I run the code climate reek runner
     Then it reports this Code Climate output:
       """
       {

data/features/reports/json.feature

@@ -24,7 +24,7 @@ Feature: Report smells using simple JSON layout
               "context": "Smelly#x",
               "lines": [ 4 ],
               "message": "has the name 'x'",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.6.0/docs/Uncommunicative-Method-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v6.0.0/docs/Uncommunicative-Method-Name.md",
               "name": "x"
           },
           {
@@ -33,7 +33,7 @@ Feature: Report smells using simple JSON layout
               "context": "Smelly#x",
               "lines": [ 5 ],
               "message": "has the variable name 'y'",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.6.0/docs/Uncommunicative-Variable-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v6.0.0/docs/Uncommunicative-Variable-Name.md",
               "name": "y"
           }
       ]
@@ -53,7 +53,7 @@ Feature: Report smells using simple JSON layout
                   1
               ],
               "message": "has no descriptive comment",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.6.0/docs/Irresponsible-Module.md"
+              "documentation_link": "https://github.com/troessner/reek/blob/v6.0.0/docs/Irresponsible-Module.md"
           }
       ]
       """

data/features/reports/reports.feature

@@ -182,8 +182,8 @@ Feature: Correctly formatted reports
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.6.0/docs/Uncommunicative-Method-Name.md]
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.6.0/docs/Uncommunicative-Variable-Name.md]
+        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v6.0.0/docs/Uncommunicative-Method-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v6.0.0/docs/Uncommunicative-Variable-Name.md]
       """
 
     Examples:
@@ -209,8 +209,8 @@ Feature: Correctly formatted reports
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.6.0/docs/Uncommunicative-Method-Name.md]
-        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.6.0/docs/Uncommunicative-Variable-Name.md]
+        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v6.0.0/docs/Uncommunicative-Method-Name.md]
+        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v6.0.0/docs/Uncommunicative-Variable-Name.md]
       """
 
     Examples:

data/features/reports/yaml.feature

@@ -25,7 +25,7 @@ Feature: Report smells using simple YAML layout
         smell_type: UncommunicativeMethodName
         source: smelly.rb
         name: x
-        documentation_link: https://github.com/troessner/reek/blob/v5.6.0/docs/Uncommunicative-Method-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v6.0.0/docs/Uncommunicative-Method-Name.md
       - context: Smelly#x
         lines:
         - 5
@@ -33,7 +33,7 @@ Feature: Report smells using simple YAML layout
         smell_type: UncommunicativeVariableName
         source: smelly.rb
         name: y
-        documentation_link: https://github.com/troessner/reek/blob/v5.6.0/docs/Uncommunicative-Variable-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v6.0.0/docs/Uncommunicative-Variable-Name.md
       """
 
   Scenario: Indicate smells and print them as yaml when using STDIN
@@ -48,5 +48,5 @@ Feature: Report smells using simple YAML layout
         lines:
         - 1
         message: has no descriptive comment
-        documentation_link: https://github.com/troessner/reek/blob/v5.6.0/docs/Irresponsible-Module.md
+        documentation_link: https://github.com/troessner/reek/blob/v6.0.0/docs/Irresponsible-Module.md
       """

data/features/step_definitions/reek_steps.rb

@@ -2,6 +2,10 @@ When /^I run reek (.*)$/ do |args|
   reek(args)
 end
 
+When 'I run the code climate reek runner' do
+  run_command_and_stop 'code_climate_reek'
+end
+
 When /^I pass "([^\"]*)" to reek *(.*)$/ do |stdin, args|
   reek_with_pipe(stdin, args)
 end

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

@@ -93,6 +93,17 @@ module Reek
       module ShadowargNode
         include ArgNodeBase
       end
+
+      # Utility methods for :forward_args nodes.
+      # rubocop:disable Naming/ClassAndModuleCamelCase
+      module Forward_ArgsNode
+        include ArgNodeBase
+
+        def anonymous_splat?
+          true
+        end
+      end
+      # rubocop:enable Naming/ClassAndModuleCamelCase
     end
   end
 end

data/lib/reek/cli/options.rb

@@ -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, :code_climate],
+          '-f', '--format FORMAT', [:html, :text, :yaml, :json, :xml],
           'Report smells in the given format:',
-          '  html', '  text (default)', '  yaml', '  json', '  xml', '  code_climate') do |opt|
+          '  html', '  text (default)', '  yaml', '  json', '  xml') do |opt|
           self.report_format = opt
         end
       end

data/lib/reek/code_comment.rb

@@ -6,6 +6,7 @@ require_relative 'smell_detectors/base_detector'
 require_relative 'errors/bad_detector_in_comment_error'
 require_relative 'errors/bad_detector_configuration_key_in_comment_error'
 require_relative 'errors/garbage_detector_configuration_in_comment_error'
+require_relative 'errors/legacy_comment_separator_error'
 
 module Reek
   #
@@ -14,12 +15,10 @@ module Reek
   #
   class CodeComment
     CONFIGURATION_REGEX = /
-                          :reek: # prefix
-                          (\w+)  # smell detector e.g.: UncommunicativeVariableName
-                          (
-                            \s*
-                            (\{.*?\}) # optional details in hash style e.g.: { max_methods: 30 }
-                          )?
+                          :reek:     # prefix
+                          (\w+)      # smell detector e.g.: UncommunicativeVariableName
+                          (:?\s*)    # separator
+                          (\{.*?\})? # details in hash style e.g.: { max_methods: 30 }
                          /x.freeze
     SANITIZE_REGEX                 = /(#|\n|\s)+/.freeze # Matches '#', newlines and > 1 whitespaces.
     DISABLE_DETECTOR_CONFIGURATION = '{ enabled: false }'
@@ -38,7 +37,8 @@ module Reek
       @source            = source
       @config            = Hash.new { |hash, key| hash[key] = {} }
 
-      @original_comment.scan(CONFIGURATION_REGEX) do |detector_name, _option_string, options|
+      @original_comment.scan(CONFIGURATION_REGEX) do |detector_name, separator, options|
+        escalate_legacy_separator separator
         CodeCommentValidator.new(detector_name:    detector_name,
                                  original_comment: original_comment,
                                  line:             line,
@@ -64,6 +64,14 @@ module Reek
         strip
     end
 
+    def escalate_legacy_separator(separator)
+      return unless separator.start_with? ':'
+
+      raise Errors::LegacyCommentSeparatorError.new(original_comment: original_comment,
+                                                    source: source,
+                                                    line: line)
+    end
+
     #
     # A typical configuration via code comment looks like this:
     #
@@ -88,25 +96,22 @@ module Reek
       # @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: {})
+      def initialize(detector_name:, original_comment:, line:, source:, options:)
         @detector_name    = detector_name
         @original_comment = original_comment
         @line             = line
         @source           = source
         @options          = options
-        @detector_class   = nil # We only know this one after our first initial checks
-        @parsed_options   = nil # We only know this one after our first initial checks
       end
 
       #
       # Method can raise the following errors:
+      #   * Errors::LegacyCommentSeparatorError
       #   * Errors::BadDetectorInCommentError
       #   * Errors::GarbageDetectorConfigurationInCommentError
       #   * Errors::BadDetectorConfigurationKeyInCommentError
       # @return [undefined]
       def validate
-        escalate_bad_detector
-        escalate_bad_detector_configuration
         escalate_unknown_configuration_key
       end
 
@@ -116,22 +121,12 @@ module Reek
                   :original_comment,
                   :line,
                   :source,
-                  :options,
-                  :detector_class,
-                  :parsed_options
-
-      def escalate_bad_detector
-        return if SmellDetectors::BaseDetector.valid_detector?(detector_name)
+                  :separator,
+                  :options
 
-        raise Errors::BadDetectorInCommentError.new(detector_name: detector_name,
-                                                    original_comment: original_comment,
-                                                    source: source,
-                                                    line: line)
-      end
-
-      def escalate_bad_detector_configuration
-        @parsed_options = YAML.safe_load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION,
-                                         permitted_classes: [Regexp])
+      def parsed_options
+        @parsed_options ||= YAML.safe_load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION,
+                                           permitted_classes: [Regexp])
       rescue Psych::SyntaxError
         raise Errors::GarbageDetectorConfigurationInCommentError.new(detector_name: detector_name,
                                                                      original_comment: original_comment,
@@ -140,8 +135,6 @@ module Reek
       end
 
       def escalate_unknown_configuration_key
-        @detector_class = SmellDetectors::BaseDetector.to_detector(detector_name)
-
         return if given_keys_legit?
 
         raise Errors::BadDetectorConfigurationKeyInCommentError.new(detector_name: detector_name,
@@ -151,6 +144,20 @@ module Reek
                                                                     line: line)
       end
 
+      def detector_class
+        @detector_class ||= SmellDetectors::BaseDetector.to_detector(detector_name)
+      rescue NameError
+        raise Errors::BadDetectorInCommentError.new(detector_name: detector_name,
+                                                    original_comment: original_comment,
+                                                    source: source,
+                                                    line: line)
+      end
+
+      # @return [Boolean] comment uses legacy three-colon format
+      def legacy_format?
+        separator.start_with? ':'
+      end
+
       # @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