reek 5.4.1 → 6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cc4e5c07f939e121b14b1b9250411d0e83fce7e936271328731500cf8a93a8e
-  data.tar.gz: 167f4022f6d3120e9dffb9eb3828f756755790c13c1e70c09f46a20dd1dc23c7
+  metadata.gz: 83760bf0344db6b8f65cd5bbb6e57f90ee4e1b54c10edb3920821a517e6649cd
+  data.tar.gz: 258214d9022fda0ecbe287c4313719472c30f056c1ff6ffd4f7ff023b255b199
 SHA512:
-  metadata.gz: 540da16a41f3939e187389759bfb9893e56f0cdf9f9dee01b09e924ba412c6f42210584b07613122dfbaed26f75991ac2b411a7db78227e175b2aae2dc289db0
-  data.tar.gz: a354ce529e870797c32b2608f1e05facfbdeb52f8e4fe9de5280b42b769dd2ddbe740a0c374f2cbdc1cc32d5254eb51037861c9149cc4ef427545ea626137ea1
+  metadata.gz: 56c12a16cc200dd475d84a543fd9edf2ce888f550a5d4d22cbe813c3439ed0915263340d7c02654417666bcd728ee5e9ba976670cae46098293b58595589f36c
+  data.tar.gz: 0f012f16ec237bdece4f797ea2977c0db5fa083df32ac86ce57b14911777eec0d832aff8e861df67c5cc80b847b0c3caf801a157b759724cc9f858ae4236ace9

data/.gitignore

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

data/.rubocop.yml

@@ -9,10 +9,11 @@ AllCops:
     - 'samples/**/*'
     - 'tmp/**/*'
     - 'vendor/**/*'
-  TargetRubyVersion: 2.3
+  NewCops: enable
+  TargetRubyVersion: 2.4
 
 # Tables are nice
-Layout/AlignHash:
+Layout/HashAlignment:
   EnforcedColonStyle: table
   EnforcedHashRocketStyle: table
   EnforcedLastArgumentHashStyle: ignore_implicit
@@ -25,6 +26,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
@@ -53,12 +58,9 @@ Lint/BooleanSymbol:
 # Spec blocks can be any size
 Metrics/BlockLength:
   Exclude:
+    - '**/*.gemspec'
     - 'spec/**/*'
 
-# Be rather lenient with line length
-Metrics/LineLength:
-  Max: 120
-
 # Keyword arguments make long parameter lists readable
 Metrics/ParameterLists:
   CountKeywordArgs: false

data/.rubocop_todo.yml

@@ -1,22 +1,34 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-11-04 12:41:28 +0100 using RuboCop version 0.60.0.
+# on 2020-08-19 19:02:50 UTC using RuboCop version 0.89.1.
 # 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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
+# Offense count: 2
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/reek/rake/task.rb'
+    - 'lib/reek/smell_detectors/base_detector.rb'
+
+# Offense count: 2
+Lint/UnreachableLoop:
+  Exclude:
+    - 'spec/reek/ast/node_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
   Max: 21
 
 # Offense count: 1
-# Configuration parameters: CountComments.
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
   Max: 161
 
 # Offense count: 13
-# Configuration parameters: CountComments, ExcludedMethods.
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
 Metrics/MethodLength:
   Max: 16
 
@@ -25,17 +37,6 @@ RSpec/AnyInstance:
   Exclude:
     - 'spec/reek/cli/application_spec.rb'
 
-# Offense count: 1
-# Configuration parameters: CustomIncludeMethods.
-RSpec/EmptyExampleGroup:
-  Exclude:
-    - 'spec/factories/factories.rb'
-
-# Offense count: 1
-RSpec/MissingExampleGroupArgument:
-  Exclude:
-    - 'spec/factories/factories.rb'
-
 # Offense count: 4
 RSpec/MultipleDescribes:
   Exclude:
@@ -44,19 +45,23 @@ RSpec/MultipleDescribes:
     - 'spec/reek/report/location_formatter_spec.rb'
     - 'spec/reek/report/progress_formatter_spec.rb'
 
-# Offense count: 32
-# Configuration parameters: AggregateFailuresByDefault.
+# Offense count: 30
 RSpec/MultipleExpectations:
   Max: 5
 
-# Offense count: 25
+# Offense count: 16
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 9
+
+# Offense count: 27
 RSpec/NestedGroups:
   Max: 5
 
 # 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,40 @@
-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
+
+env:
+  global:
+    - JRUBY_OPTS="--dev"

data/CHANGELOG.md

@@ -1,11 +1,39 @@
 # Change log
 
-## Unreleased
+## 6.0.2 (2020-10-17)
+
+* (mvz) Loosen dependency on psych. This should resolve installation problems on
+  mingw32
+* (Cesario Uy) Fix typo in docs for "Boolean Parameter" smell
+* (mvz) Set link metadata in gemspec
+
+## 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 image to a more recent ruby version
-* (Fernando Contreras) Add quotes inside directory configuration
+* (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

@@ -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,19 @@ 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.75.0'
-  gem 'rubocop-performance', '~> 1.5.0'
-  gem 'rubocop-rspec',       '~> 1.36.0'
-  gem 'simplecov',           '~> 0.17.0'
-  gem 'yard',                '~> 0.9.5'
+  gem 'aruba',                 '~> 1.0'
+  gem 'codeclimate-engine-rb', '~> 0.4.0'
+  gem 'cucumber',              ['>= 4.0', '< 6.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.93.0'
+  gem 'rubocop-performance',   '~> 1.8.0'
+  gem 'rubocop-rspec',         '~> 1.43.1'
+  gem 'simplecov',             ['>= 0.18.0', '< 0.20.0']
+  gem 'yard',                  '~> 0.9.5'
 
   platforms :mri do
     gem 'redcarpet', '~> 3.4'
@@ -25,8 +25,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,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.
@@ -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:
@@ -370,7 +373,7 @@ are documented in the corresponding smell type /docs page (if you want to get a
 configurations you can also check out [the `defaults.reek.yml` file in this repository](docs/defaults.reek.yml).
 
 Note that you do not need a configuration file at all.
-If you're fine with all the [defaults.reek.yml](docs/defaults.reek.yml) we set you can skip this completely.
+If you're fine with all the [defaults](docs/defaults.reek.yml) we set you can skip this completely.
 
 Don't worry about introducing a mistake in your configuration file that might go unnoticed - Reek uses a
 schema to validate your configuration against on start up and will faily loudly in case you
@@ -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/Boolean-Parameter.md

@@ -38,7 +38,7 @@ Note that both smells are reported, _Boolean Parameter_ and _Control Parameter_.
 
 ## Getting rid of the smell
 
-This is highly dependant on your exact architecture, but looking at the example above what you could do is:
+This is highly dependent on your exact architecture, but looking at the example above what you could do is:
 
 * Move everything in the `if` branch into a separate method
 * Move everything in the `else` branch into a separate method

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