reek 4.8.1 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d66c9a36e561c26a8a5cd27af9780ded54de1fdfe9b00b289701027403330b3
-  data.tar.gz: 592050ff0e9af5744467c2299cb085246059fbdc96358dbadbad68a0f2e36763
+  metadata.gz: da76dfc3aa1c997bffe832e526907dcf847cb5d86e04bc7c084abe074247e5d7
+  data.tar.gz: 7abc545f4176d0f561797c092bea15f1630b824a3d3ba37b99975450eb3ec3df
 SHA512:
-  metadata.gz: 431ee00e3a0021baa1c752d0a2393b84bdf873d7be702c428f57b1b538ff9dceb11957551674be4031ddd26d9ddb7aa9a01a00b84aa53cd1650f76f045243370
-  data.tar.gz: 58c93de891eec497652eda081101a7b77a93eee296c4824b379beb4982de4064c9488d67fa9dd9fe2cfe822f428be305befd65a80b77fe5ec3eb2a4d428a3b5a
+  metadata.gz: 7fe6f93cf2fe75c232327e1250c4e72c10c88707ce57879341f43b5a8a195ddb0282d9433e60cb19f635923edcb3fa52bbaadb187b5ee67d4b4cea7fc72ce901
+  data.tar.gz: a55abca10a6875077fda0b873667407f1dddf1840963fd6463ed918db9d9e58408fa93acf5a7e4741d9d488dede75963ad422c2150953e3d69f7af840a563dfd

data/.rubocop.yml

@@ -1,12 +1,21 @@
+inherit_from: .rubocop_todo.yml
+
 require:
   - rubocop-rspec
+  - rubocop-performance
 
 AllCops:
   Exclude:
     - 'samples/**/*'
     - 'tmp/**/*'
     - 'vendor/**/*'
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.3
+
+# Tables are nice
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+  EnforcedLastArgumentHashStyle: ignore_implicit
 
 # Place . on the previous line
 Layout/DotPosition:
@@ -16,9 +25,9 @@ Layout/DotPosition:
 Layout/EmptyLineBetweenDefs:
   AllowAdjacentOneLineDefs: true
 
-# Use active_support's strip_heredoc to indent heredocs
-Layout/IndentHeredoc:
-  EnforcedStyle: active_support
+# Be rather lenient with line length
+Layout/LineLength:
+  Max: 120
 
 # Always put the closing brace on the last line
 Layout/MultilineMethodCallBraceLayout:
@@ -45,81 +54,28 @@ Lint/InterpolationCheck:
 Lint/BooleanSymbol:
   Enabled: false
 
-Lint/HandleExceptions:
-  Exclude:
-    - 'spec/reek/configuration/configuration_file_finder_spec.rb'
-
 # Spec blocks can be any size
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
 
-# FIXME: Make the class shorter
-Metrics/ClassLength:
-  Exclude:
-    - lib/reek/context_builder.rb
-    - lib/reek/cli/options.rb
-
-# FIXME: Lower the method length by fixing the biggest offenders
-Metrics/MethodLength:
-  Max: 15
-
-# Be rather lenient with line length
-Metrics/LineLength:
-  Max: 120
-
 # Keyword arguments make long parameter lists readable
 Metrics/ParameterLists:
   CountKeywordArgs: false
 
-Naming/AccessorMethodName:
-  Exclude:
-    - 'lib/reek/context/visibility_tracker.rb'
-
-# EOS is a fine name to use in our specs
-Naming/HeredocDelimiterNaming:
-  Exclude:
-    - 'spec/**/*'
-
-# FIXME: Update specs to avoid offenses
-RSpec/AnyInstance:
-  Exclude:
-    - 'spec/reek/cli/application_spec.rb'
+Naming/RescuedExceptionsVariableName:
+  PreferredName: error
 
-# This file does not test a class
+# These files do not test classes or modules
 RSpec/DescribeClass:
   Exclude:
-    - 'spec/quality/reek_source_spec.rb'
+    - 'spec/quality/*_spec.rb'
+    - 'spec/performance/reek/smell_detectors/runtime_speed_spec.rb'
 
 # Our examples are large because we have source literals in them
 RSpec/ExampleLength:
   Enabled: false
 
-# FIXME: Split up files to avoid offenses
-RSpec/MultipleDescribes:
-  Exclude:
-    - 'spec/reek/ast/sexp_extensions_spec.rb'
-    - 'spec/reek/code_comment_spec.rb'
-    - 'spec/reek/report/formatter/location_formatter_spec.rb'
-    - 'spec/reek/report/formatter/progress_formatter_spec.rb'
-
-# FIXME: Update specs to avoid offenses
-RSpec/MultipleExpectations:
-  Exclude:
-    - 'spec/reek/cli/application_spec.rb'
-    - 'spec/reek/code_comment_spec.rb'
-    - 'spec/reek/configuration/app_configuration_spec.rb'
-    - 'spec/reek/context/module_context_spec.rb'
-    - 'spec/reek/context_builder_spec.rb'
-    - 'spec/reek/examiner_spec.rb'
-    - 'spec/reek/spec/should_reek_of_spec.rb'
-
-# FIXME: Update specs to avoid offenses
-RSpec/NestedGroups:
-  Exclude:
-    - 'spec/reek/report/code_climate/code_climate_fingerprint_spec.rb'
-    - 'spec/reek/cli/application_spec.rb'
-
 # rubocop-rspec expects a CodeClimate namespace to go with the code_climate directory.
 RSpec/FilePath:
   Exclude:
@@ -132,12 +88,6 @@ RSpec/FilePath:
 Style/AndOr:
   EnforcedStyle: conditionals
 
-Style/Documentation:
-  Exclude:
-    - 'lib/reek/ast/sexp_extensions/send.rb'
-    - 'lib/reek/ast/sexp_extensions/super.rb'
-    - 'lib/reek/ast/sexp_extensions/variables.rb'
-
 # Require comment for files in lib and bin
 Style/FrozenStringLiteralComment:
   Include:
@@ -176,3 +126,7 @@ Style/SymbolArray:
 # Allow small arrays of words with quotes
 Style/WordArray:
   MinSize: 4
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/reek/cli/options.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,63 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# 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
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 21
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 161
+
+# Offense count: 14
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 16
+
+# Offense count: 2
+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:
+    - 'spec/reek/ast/sexp_extensions_spec.rb'
+    - 'spec/reek/code_comment_spec.rb'
+    - 'spec/reek/report/location_formatter_spec.rb'
+    - 'spec/reek/report/progress_formatter_spec.rb'
+
+# Offense count: 32
+# Configuration parameters: AggregateFailuresByDefault.
+RSpec/MultipleExpectations:
+  Max: 5
+
+# Offense count: 25
+RSpec/NestedGroups:
+  Max: 5
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods.
+# AllowedMethods: present?, blank?, presence, try, try!
+Style/SafeNavigation:
+  Exclude:
+    - 'lib/reek/ast/node.rb'
+    - 'lib/reek/ast/sexp_extensions/module.rb'

data/.simplecov

@@ -1,10 +1,16 @@
 SimpleCov.start do
   track_files 'lib/**/*.rb'
   add_filter 'lib/reek/version.rb' # version.rb is loaded too early to test
+  add_filter 'lib/reek/cli/options.rb' # tested mostly via integration tests
+  add_filter 'spec/'
+  add_filter 'samples/'
+  coverage_dir 'tmp/coverage'
 end
 
 SimpleCov.at_exit do
   SimpleCov.result.format!
-  SimpleCov.minimum_coverage 98.9
-  SimpleCov.minimum_coverage_by_file 81.4
+  unless RUBY_ENGINE == 'jruby'
+    SimpleCov.minimum_coverage 98.88
+    SimpleCov.minimum_coverage_by_file 81.4
+  end
 end

data/.travis.yml

@@ -1,25 +1,25 @@
-sudo: false
 dist: trusty
 cache: bundler
 language: ruby
-before_install:
-  - gem update --system
-  - gem install bundler
 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.1
-  - 2.2
   - 2.3
   - 2.4
   - 2.5
-  - jruby-9.1.15.0
+  - 2.6
+  - 2.7
+  - jruby-9.1.17.0
+  - jruby-9.2.6.0
   - jruby-head
   - ruby-head
   - rubinius-3
 matrix:
   allow_failures:
-    - rvm: jruby-9.1.15.0
     - rvm: jruby-head
     - rvm: ruby-head
     - rvm: rubinius-3

data/.yardopts

@@ -1,4 +1,4 @@
---no-private
+--private
 --readme README.md
 --load ./docs/yard_plugin.rb
 -

data/CHANGELOG.md

@@ -1,5 +1,89 @@
 # Change log
 
+## 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)
+
+* (Philippe Bernery) Enable regex for directory directives.
+
+## 5.3.2 (2019-03-22)
+
+* (troessner) Use Parser26.
+
+## 5.3.1 (2019-02-08)
+
+* (Al Snow) Upgrade parser dependency
+
+## 5.3.0 (2018-12-28)
+
+* (mvz) Add support for Ruby 2.6.
+* (mvz) Add support for JRuby 9.1 and 9.2
+
+## 5.2.0 (2018-10-13)
+
+* (troessner) Enable exclusion of single files.
+
+## 5.1.0 (2018-09-22)
+
+* (troessner) Simplify todo list feature.
+* (troessner) Show configuration path.
+
+## 5.0.2 (2018-07-10)
+
+* (mvz) Parser 2.5.1.1 seems broken. Disallow it.
+* (mvz) Improve control parameter recursion performance.
+
+## 5.0.1 (2018-07-03)
+
+* (troessner) Fix uninitialized constant error
+
+## 5.0.0 (2018-06-18)
+
+*Breaking changes:* 
+
+* (David Fisher) Change PrimaDonnaMethod to MissingSafeMethod
+* (mvz) Always include documentation in JSON and YAML
+* (mvz) Remove Syntax smell detector
+* (mvz) Remove deprecated Examiner#description (in favor of Examiner#origin)
+* (mvz) Allow only detector names in configuration hash
+* (mvz) Do not accept a class as parameter for reek_of
+* (mvz) Allow only .reek.yml instead of any file name ending in .reek
+* (troessner) Validate our configuration by using a schema
+* (troessner) Scope detectors in the configuration under `detectors`
+* (troessner) Move directory directives under a special key
+* (troessner) Use strings not regexes in our configuration file
+* (troessner) Replace `wiki-links` flag with `documentation` flag
+* (troessner) Add yml extension to Reeks configuration file
+* (troessner) Drop legacy code comment separator
+* (troessner) Drop Ruby 2.2 support
+* (troessner) Drop Ruby 2.1 support
+
+*Non breaking changes:*
+
+* (Paul Sadauskas) Add support for --stdin-filename
+* (mvz) Generate versioned documentation links
+* (mvz) Bugfix: Only report FeatureEnvy for instance methods
+* (troessner) List all smells
+
+## 4.8.2 (2018-06-26)
+
+* (mvz) Only report FeatureEnvy for instance methods
+* (mvz) Generate versioned documentation links
+
 ## 4.8.1 (2018-04-12)
 
 * (mvz) Loosen dependency on rainbow

data/CONTRIBUTING.md

@@ -89,6 +89,14 @@ class Alfa
 end
 ```
 
+We also aim to make our specs as self-reliant as possible. They should not rely on external sample
+or configuration files since that makes it very hard to reason about them and introduces a tight coupling
+which makes refactoring more difficult.
+Unfortunately our current specs are a bit misleading in this regard since they are often doing the
+opposite, relying on external sample and configuration files (indicated by using
+some of the constants defined in `samples/paths.rb`).
+Our goal is to reverse this development.
+
 ### Cucumber Features
 
 Reek uses [Cucumber](https://cucumber.io/) with
@@ -182,3 +190,20 @@ We are following [semantic versioning](http://semver.org/).
 If you're working on a change that is breaking backwards-compatibility
 just go ahead with your pull request like normal. We'll discuss this then in
 the pull request and help you to point your pull request to the right branch.
+
+### Releasing Reek
+
+In this example we assume the current version is 5.3.1 and you want to update to 5.3.2.
+
+* Create a branch with a name like "prepare-v.5.3.2"
+* Update the version in `lib/reek/version.rb`
+* List all relevant changes in `CHANGELOG.md`
+* Update the version number in our cucumber features, otherwise the build will fail. You can do this quite easily via
+  ```Bash
+  find features/ -type f -exec sed -i '' 's/v5.3.1/v5.3.2/g' {} +
+  ```
+* Push the branch, create a pull request, have it reviewed and merged
+* Pull the latest master and then do a
+  ```Bash
+  bundle exec rake release
+  ```

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
 

data/Gemfile

@@ -5,32 +5,28 @@ gemspec
 ruby RUBY_VERSION
 
 group :development do
-  gem 'activesupport', '>= 4.2'
-  gem 'aruba',         '~> 0.14.0'
-  gem 'ataru',         '~> 0.2.0'
-  gem 'cucumber',      '~> 3.0'
-  gem 'factory_bot',   '~> 4.0'
-  gem 'rake',          '~> 12.0'
-  gem 'rspec',         '~> 3.0'
-  gem 'simplecov',     '~> 0.16.1'
-  gem 'yard',          '~> 0.9.5'
-
-  if RUBY_VERSION >= '2.3'
-    gem 'rubocop',       '~> 0.53.0'
-    gem 'rubocop-rspec', '~> 1.20'
-  end
+  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'
 
   platforms :mri do
-    gem 'redcarpet', '~> 3.4.0'
+    gem 'redcarpet', '~> 3.4'
   end
 end
 
 group :debugging do
-  # Fixing https://github.com/guard/guard/wiki/Add-Readline-support-to-Ruby-on-Mac-OS-X#option-4-using-a-pure-ruby-readline-implementation
   gem 'pry'
-  gem 'rb-readline', '~> 0.5.3'
   platforms :mri do
     gem 'pry-byebug'
-    gem 'pry-stack_explorer'
   end
 end