reek 5.4.0 → 6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c7a7193dd76b11cd88c3e3f031784a0bb54f3bcaa35a4e3b430dd550749facc
-  data.tar.gz: 0d2f96071b27301ebbd2b3ff82b8e1fbbde2aaf647125e3903d017074c4d061b
+  metadata.gz: 107593e309020bb2745d630599f8bf33bde2c9f708877895465cd12360267f82
+  data.tar.gz: 61290a2608c069e4c5977720e5a1d99fe8d4e716dfaa8503c0491b226790a8a7
 SHA512:
-  metadata.gz: cc75695b17d58bf820bf6b874e747c3a7f81c43b0e8c80a33144118b1dbbbb0e0cd294ae386026937ee0799d0a7fa7cd12c65470bfd217faaa9c66dcbd22a03c
-  data.tar.gz: cb9bfef6dd9f799c2f2733b020952909010f489b1cf621d64828a2982cc64ea912211a7bf0f9e21fc1246ce4068edb5bb1571acdd16445df6ddebca2c3c9a84b
+  metadata.gz: '09025ee922070bcb0c415f82fd5591e6658610a661ae4fc24abb472f16df6c3ed222fcfd84f81500a1951cadfabfb33b5c9414e26164f67cc140699774a9d2e7'
+  data.tar.gz: 7b9af8e1a09c5722fbedd946389411dee5aa7a5b98f03f48330a9d7f76d4c126bf170fff94955af6abe7a3a6c2e4b1b046c1fd1b8e304ee678a0fbecb52919f1

data/.gitignore

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

data/.rubocop.yml

@@ -2,16 +2,17 @@ inherit_from: .rubocop_todo.yml
 
 require:
   - rubocop-rspec
+  - rubocop-performance
 
 AllCops:
   Exclude:
     - 'samples/**/*'
     - 'tmp/**/*'
     - 'vendor/**/*'
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 
 # Tables are nice
-Layout/AlignHash:
+Layout/HashAlignment:
   EnforcedColonStyle: table
   EnforcedHashRocketStyle: table
   EnforcedLastArgumentHashStyle: ignore_implicit
@@ -24,6 +25,10 @@ Layout/DotPosition:
 Layout/EmptyLineBetweenDefs:
   AllowAdjacentOneLineDefs: true
 
+# Be rather lenient with line length
+Layout/LineLength:
+  Max: 120
+
 # Always put the closing brace on the last line
 Layout/MultilineMethodCallBraceLayout:
   EnforcedStyle: same_line
@@ -54,10 +59,6 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
 
-# Be rather lenient with line length
-Metrics/LineLength:
-  Max: 120
-
 # Keyword arguments make long parameter lists readable
 Metrics/ParameterLists:
   CountKeywordArgs: false
@@ -129,3 +130,23 @@ Style/WordArray:
 Metrics/ClassLength:
   Exclude:
     - 'lib/reek/cli/options.rb'
+
+# Activate new cops from RuboCop 0.80 - 0.83
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-11-04 12:41:28 +0100 using RuboCop version 0.60.0.
+# on 2019-12-22 13:19:30 +0100 using RuboCop version 0.78.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -15,7 +15,7 @@ Metrics/AbcSize:
 Metrics/ClassLength:
   Max: 161
 
-# Offense count: 13
+# Offense count: 14
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
   Max: 16
@@ -55,8 +55,8 @@ RSpec/NestedGroups:
 
 # Offense count: 2
 # Cop supports --auto-correct.
-# Configuration parameters: ConvertCodeThatCanStartToReturnNil, Whitelist.
-# Whitelist: present?, blank?, presence, try, try!
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods.
+# AllowedMethods: present?, blank?, presence, try, try!
 Style/SafeNavigation:
   Exclude:
     - 'lib/reek/ast/node.rb'

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,34 +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
-  - jruby-9.1.17.0
-  - jruby-9.2.6.0
+  - 2.7
+  - 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,6 +1,32 @@
 # Change log
 
-## Unreleased
+## 6.0.1 (2020-05-26)
+
+* (Maxim Pertsov) Handle absolute paths for directories correctly
+
+## 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
+* (mvz) Loosen parser dependency to allow version 2.7.x
+
+## 5.5.0 (2019-11-13)
+
+* (mvz) Use the Parser class matching current ruby for parsing, instead of
+  always picking version 2.6.
+
+## 5.4.1 (2019-11-12)
+
+* (Filipe Esperandio) Bump base Docker image to a more recent ruby version
+* (Fernando Contreras) Add quotes inside directory configuration example in
+  README
 
 ## 5.4.0 (2019-04-24)
 

data/Dockerfile

@@ -3,7 +3,7 @@
 # Build and run via:
 #   docker build -t codeclimate/codeclimate-reek . && docker run codeclimate/codeclimate-reek
 
-FROM ruby:2.3.3-alpine
+FROM ruby:2.6.0-alpine
 
 MAINTAINER The Reek core team
 
@@ -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,27 +5,25 @@ gemspec
 ruby RUBY_VERSION
 
 group :development do
-  gem 'aruba',               '~> 0.14.8'
-  gem 'cucumber',            '~> 3.0'
-  gem 'factory_bot',         '~> 5.0'
-  gem 'kramdown',            '~> 2.1'
-  gem 'kramdown-parser-gfm', '~> 1.0'
-  gem 'rake',                '~> 12.0'
-  gem 'rspec',               '~> 3.0'
-  gem 'rspec-benchmark',     '~> 0.5.0'
-  gem 'rubocop',             '~> 0.67.2'
-  gem 'rubocop-rspec',       '~> 1.32.0'
-  gem 'simplecov',           '~> 0.16.1'
-  gem 'yard',                '~> 0.9.5'
+  gem 'aruba',                 '~> 1.0'
+  gem 'codeclimate-engine-rb', '~> 0.4.0'
+  gem 'cucumber',              '~> 3.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.83.0'
+  gem 'rubocop-performance',   '~> 1.5.0'
+  gem 'rubocop-rspec',         '~> 1.39.0'
+  gem 'simplecov',             '~> 0.18.1'
+  gem 'yard',                  '~> 0.9.5'
 
   platforms :mri do
-    gem 'redcarpet', '~> 3.4.0'
+    gem 'redcarpet', '~> 3.4'
   end
 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,10 +94,14 @@ 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.
 
+Note that, on each Ruby version, Reek will use the parser for that version of
+Ruby. So, you should always run Reek using one of your project's target Ruby
+versions.
+
 ## Fixing Smell Warnings
 
 Reek focuses on high-level code smells, so we can't tell you how to fix warnings in
@@ -288,7 +286,7 @@ detectors:
   # You can disable smells completely
   IrresponsibleModule:
     enabled: false
-  
+
   # You can use filters to silence Reek warnings.
   # Either because you simply disagree with Reek (we are not the police) or
   # because you want to fix this at a later point in time.
@@ -296,7 +294,7 @@ detectors:
     exclude:
       - "MyWorker#self.class_method" # should be refactored
       - "AnotherWorker#instance_method" # should be refactored as well
-  
+
   # A lot of smells allow fine tuning their configuration. You can look up all available options
   # in the corresponding smell documentation in /docs. In most cases you probably can just go
   # with the defaults as documented in defaults.reek.yml.
@@ -317,7 +315,7 @@ directories:
   "web_app/app/controllers":
     NestedIterators:
       enabled: false
-  "web_app/app/helpers**:
+  "web_app/app/helpers**":
     UtilityFunction:
       enabled: false
   "web_app/lib/**/test/**":
@@ -351,9 +349,14 @@ This configuration for instance:
 detectors:
   IrresponsibleModule:
     enabled: false
-  
+
   TooManyStatements:
     max_statements: 5
+
+directories:
+  "app/controllers":
+    TooManyStatements:
+      max_statements: 10
 ```
 
 translates to:
@@ -609,6 +612,7 @@ Be careful though, Reek does not merge your configuration entries, so if you alr
   Reek
 * [ruby-critic](https://github.com/whitesmith/rubycritic) - gem that wraps around static analysis gems such as Reek, [flay](https://github.com/seattlerb/flay) and [flog](https://github.com/seattlerb/flog)
 * [pronto-reek](https://github.com/mmozuras/pronto-reek) - Reek integration for [pronto](https://github.com/mmozuras/pronto)
+* [action-reek](https://github.com/reviewdog/action-reek) - GitHub Action to run reek with [reviewdog](https://github.com/reviewdog/reviewdog) 🐶
 
 ### Misc
 

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.4.0/docs/Code-Smells.md for a list of smells
+                                           Check out https://github.com/troessner/reek/blob/v6.0.1/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.4.0/docs/Code-Smells.md for a details on each detector
+      Check out https://github.com/troessner/reek/blob/v6.0.1/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:
       """
       {