reek 4.5.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e73dfbe510f33f5080c142589e06141d394590c4
-  data.tar.gz: c97e989ed22ab395217099122515d0b1e02ca8e2
+  metadata.gz: dcc26f0cc3bb682d6af4ccd125c9968049fa7659
+  data.tar.gz: 3f07f95ea9d5dc2d9a3228d9720aa991ac1f5232
 SHA512:
-  metadata.gz: 27c163213eee8653498e261dc44b3e6b8a1c7e9a17dfeb19bafdd914a7b7ec741168cc1f1505b71b7f8653c8eff889dbb0cbb3f953220bd46876ca4a12e310d4
-  data.tar.gz: 3884c786a8deda2eab21427011f595b0484c61075ab96beb759bbe1ecbefc92f244650a9ef045850ce261783ef397516d5cf8fd16956cbdec16ab712fe86546b
+  metadata.gz: caeb105aa52968eb387304da206083cf07394d1f378c01a6aabf040e2aa264d0016491e69dba31910fa64982cdc8bf9902b036b63639279422c93ad934a91725
+  data.tar.gz: 8af65a286c9207f04770b530865755aeeca35b4162d3db66c987b0e6d5c02438faeeee3251bef91ef5e91e4b75235ec2ae23f805a07bfc64d448e7e5066610d6

data/.codeclimate.yml

@@ -1,16 +1,21 @@
-engines:
+version: "2"
+plugins:
   rubocop:
     enabled: true
   reek:
     enabled: true
-ratings:
-  paths:
-  - lib/**/*
-exclude_paths:
-- coverage/
-- docs/
-- features/
-- logo/
-- pkg/
-- spec/
-- tmp/
+  duplication:
+    enabled: true
+    config:
+      languages:
+        ruby:
+          mass_threshold: 35
+exclude_patterns:
+  - coverage/
+  - docs/
+  - features/
+  - logo/
+  - pkg/
+  - samples/
+  - spec/
+  - tmp/

data/.rubocop.yml

@@ -6,7 +6,53 @@ AllCops:
     - 'samples/**/*'
     - 'tmp/**/*'
     - 'vendor/**/*'
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.3
+
+# Place . on the previous line
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+# Require empty lines between defs, except for one-line defs
+Layout/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+# Use active_support's strip_heredoc to indent heredocs
+Layout/IndentHeredoc:
+  EnforcedStyle: active_support
+
+# Always put the closing brace on the last line
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: same_line
+
+# Indent one level for follow-up lines
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# Indent one level for follow-up lines
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+# Assume the programmer knows how bracketed block syntax works
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+# Some of our source examples include interpolation explicitely.
+Lint/InterpolationCheck:
+  Exclude:
+    - 'spec/**/*'
+
+# We use :true and :false as AST node types.
+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:
@@ -14,9 +60,21 @@ Metrics/ClassLength:
     - lib/reek/context_builder.rb
     - lib/reek/cli/options.rb
 
+Style/SafeNavigation:
+  Exclude:
+    - lib/reek/ast/node.rb
+    - lib/reek/ast/sexp_extensions/module.rb
+
 # FIXME: Lower the method length by fixing the biggest offenders
 Metrics/MethodLength:
   Max: 15
+  Exclude:
+    - 'lib/reek/cli/options.rb'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/reek/cli/options.rb'
+    - 'lib/reek/configuration/configuration_converter.rb'
 
 # Be rather lenient with line length
 Metrics/LineLength:
@@ -26,6 +84,15 @@ Metrics/LineLength:
 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:
@@ -45,8 +112,8 @@ 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'
+    - 'spec/reek/report/location_formatter_spec.rb'
+    - 'spec/reek/report/progress_formatter_spec.rb'
 
 # FIXME: Update specs to avoid offenses
 RSpec/MultipleExpectations:
@@ -62,14 +129,10 @@ RSpec/MultipleExpectations:
 # 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'
-
-# FIXME: Update specs to avoid offenses
-RSpec/VerifiedDoubles:
-  Exclude:
-    - 'spec/reek/context/code_context_spec.rb'
-    - 'spec/reek/context/method_context_spec.rb'
-    - 'spec/reek/context/module_context_spec.rb'
+    - 'spec/reek/configuration/schema_validator_spec.rb'
+    - 'spec/reek/configuration/configuration_file_finder_spec.rb'
 
 # rubocop-rspec expects a CodeClimate namespace to go with the code_climate directory.
 RSpec/FilePath:
@@ -79,9 +142,9 @@ RSpec/FilePath:
     - 'spec/reek/report/code_climate/code_climate_formatter_spec.rb'
     - 'spec/reek/report/code_climate/code_climate_report_spec.rb'
 
-Style/AccessorMethodName:
-  Exclude:
-    - 'lib/reek/context/visibility_tracker.rb'
+# Allow and/or for control flow only
+Style/AndOr:
+  EnforcedStyle: conditionals
 
 Style/Documentation:
   Exclude:
@@ -89,14 +152,6 @@ Style/Documentation:
     - 'lib/reek/ast/sexp_extensions/super.rb'
     - 'lib/reek/ast/sexp_extensions/variables.rb'
 
-# Place . on the previous line
-Style/DotPosition:
-  EnforcedStyle: trailing
-
-# Require empty lines between defs, except for one-line defs
-Style/EmptyLineBetweenDefs:
-  AllowAdjacentOneLineDefs: true
-
 # Require comment for files in lib and bin
 Style/FrozenStringLiteralComment:
   Include:
@@ -108,22 +163,18 @@ Style/FrozenStringLiteralComment:
 Style/MultilineBlockChain:
   Enabled: false
 
-# Always put the closing brace on the last line
-Style/MultilineMethodCallBraceLayout:
-  EnforcedStyle: same_line
-
-# Indent one level for follow-up lines
-Style/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-
-# Indent one level for follow-up lines
-Style/MultilineOperationIndentation:
-  EnforcedStyle: indented
-
 # There's nothing wrong with parallel assignment
 Style/ParallelAssignment:
   Enabled: false
 
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: ()
+    '%W': ()
+    '%I': ()
+    '%w': ()
+    '%i': ()
+
 # Allow Perl-style references to regex matches
 Style/PerlBackrefs:
   Enabled: false
@@ -132,6 +183,10 @@ Style/PerlBackrefs:
 Style/SingleLineMethods:
   Enabled: false
 
+# Prefer symbols to look like symbols
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
 # Allow small arrays of words with quotes
 Style/WordArray:
   MinSize: 4

data/.simplecov

@@ -1,6 +1,7 @@
 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
 end
 
 SimpleCov.at_exit do

data/.travis.yml

@@ -1,25 +1,23 @@
 sudo: false
+dist: trusty
 cache: bundler
 language: ruby
 bundler_args: --without debugging
 script: bundle exec rake ci
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3.0
-  - rbx-2
+  - 2.3
+  - 2.4
+  - 2.5
+  - jruby-9.1.15.0
+  - jruby-head
   - ruby-head
+  - rubinius-3
 matrix:
-  include:
-    - rvm: jruby
-      env: JRUBY_OPTS='--2.0 --server -Xcompile.invokedynamic=false'
-    - rvm: jruby-head
-      env: JRUBY_OPTS='--server -Xcompile.invokedynamic=false'
   allow_failures:
-    - rvm: jruby
+    - rvm: jruby-9.1.15.0
     - rvm: jruby-head
-    - rvm: rbx-2
     - rvm: ruby-head
+    - rvm: rubinius-3
   fast_finish: true
 notifications:
   email:

data/.yardopts

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

data/CHANGELOG.md

@@ -1,15 +1,120 @@
 # Change log
 
+## 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
+
+## 4.8.0 (2018-03-05)
+
+* (pocke) Support Ruby 2.5
+* (mvz) Print original exception class in certain error messages
+* (mvz) Only include long exception message in CLI output
+* (chastell) Add official support for Ruby 2.5
+* (mvz) Do not detect ModuleInitialize for nested dynamic classes
+
+## 4.7.3 (2017-11-05)
+
+* (mvz) Handle UTF-8 files in all locales
+* (troessner) Handle encoding and other errors when parsing the source
+* (mvz) Report method source line in PrimaDonnaMethod
+* (mvz) Pick up config file in reek matcher
+* (mvz) Let REEK_SRC override set values in rake task
+
+## 4.7.2 (2017-07-24)
+
+* (mvz) Also report unused uncommunicative parameter names
+* (mvz) Track visibility correctly when using method definition visibility modifiers
+* (mvz) Handle method comments when using method definition visibility modifiers
+
+## 4.7.1 (2017-06-12)
+
+* (mvz) Improve IrresponsibleModule and fix some bugs along
+
+## 4.7.0 (2017-05-31)
+
+* (pocke) Introduce Syntax smell detector
+
+## 4.6.2 (2017-04-27)
+
+* (pocke) Prevent from breaking on a string with escape sequence incompatible with UTF-8
+* (pocke) Use Ruby 2.4 parser for parsing code
+
+## 4.6.1 (2017-04-05)
+
+* (IanWhitney) Properly handle absolute paths.
+
+## 4.6.0 (2017-04-04)
+
+* (IanWhitney) Implement `--force-exclusion` flag
+* (mvz) Raise Reek-specific error on parse errors
+
+## 4.5.6 (2017-02-17)
+
+* (mvz) Raise on errors inside of Examiner#smells instead of outputting to STDERR
+* (mvz) Update parser dependency
+
+## 4.5.5 (2017-02-05)
+
+* (mvz) Load YAML in code comments safely
+* (mvz) Combine lines for manual dispatch smells
+* (mvz) Respect exclude_paths when passing sources on the command line
+* (mvz) Ensure explicit arguments of super() are processed
+
+## 4.5.4 (2017-01-17)
+
+* (troessner) Improve documentation and fix PrimaDonnaMethod detector configuration via comment.
+
+## 4.5.3 (2016-12-05)
+
+* (jhubert) Stop reporting FeatureEnvy with super and arguments.
+
+## 4.5.2 (2016-11-06)
+
+* (troessner) Warn about multiple configuration files.
+
 ## 4.5.1 (2016-10-16)
 
 * (troessner) Validate configuration keys in code comments.
 
 ## 4.5.0 (2016-10-12)
 
-* (maxjacobson) Emit fingerprints in Code Climate reporter
-* (mvz) Disable progress for piped output
-* (mvz) Update progress formatter to match changed file location
 * (jhubert) Add progress formatters for showing progress on each file
+* (mvz) Update progress formatter to match changed file location
+* (mvz) Disable progress for piped output
+* (maxjacobson) Emit fingerprints in Code Climate reporter
 
 ## 4.4.4 (2016-09-29)
 

data/CONTRIBUTING.md

@@ -111,7 +111,7 @@ regard than if it were run in a terminal.
 
 #### Failing Cucumber Scenarios
 
-If there is a failing scenario and you can not figure out why it is failing,
+If there is a failing scenario and you cannot figure out why it is failing,
 just run the failing scenario: `bundle exec cucumber
 features/failing_scenario.feature:line`. By doing so Aruba will leave its set
 up in the `tmp/aruba` directory. You can then `cd` into this directory and run

data/Dockerfile

@@ -3,7 +3,7 @@
 # Build and run via:
 #   docker build -t codeclimate/codeclimate-reek . && docker run codeclimate/codeclimate-reek
 
-FROM codeclimate/alpine-ruby:b38
+FROM ruby:2.3.3-alpine
 
 MAINTAINER The Reek core team
 
@@ -12,17 +12,18 @@ ENV app_dir /usr/src/app
 ENV user app
 
 RUN apk --update add git
-
 ADD . ${app_dir}
 
+RUN adduser -u 9000 -D ${user}
+RUN chown -R ${user}:${user} ${app_dir}
+USER ${user}
+
 WORKDIR ${app_dir}
 
+RUN gem install rake
 RUN bundle install --without debugging development
-RUN adduser -u 9000 -D ${user}
-RUN chown -R ${user}:${user} ${app_dir}
 
 VOLUME ${code_dir}
 WORKDIR ${code_dir}
-USER ${user}
 
 CMD [ "/usr/src/app/bin/code_climate_reek" ]

data/Gemfile

@@ -2,25 +2,26 @@ source 'https://rubygems.org'
 
 gemspec
 
+ruby RUBY_VERSION
+
 group :development do
+  gem 'activesupport', '>= 4.2'
   gem 'aruba',         '~> 0.14.0'
   gem 'ataru',         '~> 0.2.0'
-  gem 'cucumber',      '~> 2.0'
-  gem 'factory_girl',  '~> 4.0'
-  gem 'mutant-rspec',  '~> 0.8.8'
-  gem 'rake',          '~> 11.1'
+  gem 'cucumber',      '~> 3.0'
+  gem 'factory_bot',   '~> 4.0'
+  gem 'rake',          '~> 12.0'
   gem 'rspec',         '~> 3.0'
-  gem 'simplecov',     '~> 0.12.0'
+  gem 'simplecov',     '~> 0.16.1'
   gem 'yard',          '~> 0.9.5'
-  gem 'activesupport', '~> 4.2'
 
   if RUBY_VERSION >= '2.3'
-    gem 'rubocop',       '~> 0.42.0'
-    gem 'rubocop-rspec', '~> 1.7'
+    gem 'rubocop',       '~> 0.57.1'
+    gem 'rubocop-rspec', '~> 1.20'
   end
 
   platforms :mri do
-    gem 'redcarpet', '~> 3.3.1'
+    gem 'redcarpet', '~> 3.4.0'
   end
 end