reek 4.8.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 8688a1d76cc81f34b630798bdd47068e760e4a397548747194edb5e6bb42d255
-  data.tar.gz: 850489fdbab5642d489eebae9427c5028dff6093f29551f322a44201ace1142e
+SHA1:
+  metadata.gz: dcc26f0cc3bb682d6af4ccd125c9968049fa7659
+  data.tar.gz: 3f07f95ea9d5dc2d9a3228d9720aa991ac1f5232
 SHA512:
-  metadata.gz: 8dd0a801d1ea96549e942b90d1a8552786a0b6b4d9ef1febaec2abdeb77bc747ece35d31b3ca4cf97108a268e6b2edabb4e02959c2aed72cd3d4469d5d078b4d
-  data.tar.gz: 2d8f97017347131099c498b3dd744459bd0e7e729c29e4c274f4ed8cc5487b520402787c1ae7cc88d276597117a7ee1521cc496998ec7f805a644e0929b12bc8
+  metadata.gz: caeb105aa52968eb387304da206083cf07394d1f378c01a6aabf040e2aa264d0016491e69dba31910fa64982cdc8bf9902b036b63639279422c93ad934a91725
+  data.tar.gz: 8af65a286c9207f04770b530865755aeeca35b4162d3db66c987b0e6d5c02438faeeee3251bef91ef5e91e4b75235ec2ae23f805a07bfc64d448e7e5066610d6

data/.rubocop.yml

@@ -6,7 +6,7 @@ AllCops:
     - 'samples/**/*'
     - 'tmp/**/*'
     - 'vendor/**/*'
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.3
 
 # Place . on the previous line
 Layout/DotPosition:
@@ -60,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:
@@ -100,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:
@@ -119,6 +131,8 @@ RSpec/NestedGroups:
   Exclude:
     - 'spec/reek/report/code_climate/code_climate_fingerprint_spec.rb'
     - 'spec/reek/cli/application_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:

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

@@ -2,14 +2,9 @@ sudo: false
 dist: trusty
 cache: bundler
 language: ruby
-before_install:
-  - gem update --system
-  - gem install bundler
 bundler_args: --without debugging
 script: bundle exec rake ci
 rvm:
-  - 2.1
-  - 2.2
   - 2.3
   - 2.4
   - 2.5

data/.yardopts

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

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # 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

data/Gemfile

@@ -16,7 +16,7 @@ group :development do
   gem 'yard',          '~> 0.9.5'
 
   if RUBY_VERSION >= '2.3'
-    gem 'rubocop',       '~> 0.53.0'
+    gem 'rubocop',       '~> 0.57.1'
     gem 'rubocop-rspec', '~> 1.20'
   end
 

data/README.md

@@ -39,13 +39,18 @@
 * [![Gem Version](https://badge.fury.io/rb/reek.svg)](https://badge.fury.io/rb/reek)
 * ![](http://img.shields.io/github/tag/troessner/reek.svg)
 * ![](http://img.shields.io/badge/license-MIT-brightgreen.svg)
-* [![Dependency Status](https://gemnasium.com/badges/github.com/troessner/reek.svg)](https://gemnasium.com/github.com/troessner/reek)
 * [![Inline docs](https://inch-ci.org/github/troessner/reek.png)](https://inch-ci.org/github/troessner/reek)
 * [![Code Climate](https://codeclimate.com/github/troessner/reek/badges/gpa.svg)](https://codeclimate.com/github/troessner/reek)
 * [![codebeat](https://codebeat.co/badges/42fed4ff-3e55-4aed-8ecc-409b4aa539b3)](https://codebeat.co/projects/github-com-troessner-reek)
 * ![](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
@@ -84,7 +89,7 @@ end
 Reek will report the following code smells in this file:
 
 ```
-$ reek --no-wiki-links demo.rb
+$ reek --no-documentation demo.rb
 Inspecting 1 file(s):
 S
 
@@ -97,8 +102,6 @@ demo.rb -- 2 warnings:
 
 Reek is officially supported for the following CRuby versions:
 
-  - 2.1
-  - 2.2
   - 2.3
   - 2.4
   - 2.5
@@ -254,12 +257,13 @@ For a summary of those CLI options see [Command-Line Options](docs/Command-Line-
 #### Configuration loading
 
 Configuring Reek via a configuration file is by far the most powerful way.
+Reek expects this filename to be `.reek.yml` but you can override this via the CLI `-c` switch (see below).
 
-There are three ways of passing Reek a configuration file:
+There are three ways of passing Reek the configuration file:
 
 1. Using the CLI `-c` switch (see [_Command-line interface_](#command-line-interface) above)
-2. Having a file ending with `.reek` either in your current working directory or in a parent directory (more on that later)
-3. Having a file ending with `.reek` in your home directory
+2. Having the configuration file either in your current working directory or in a parent directory (more on that later)
+3. Having the configuration file in your home directory
 
 The order in which Reek tries to find such a configuration
 file is exactly the above: first it checks if we have given
@@ -277,43 +281,46 @@ of how many `*.reek` files you might have on your filesystem.
 
 We put a lot of effort into making Reek's configuration as self explanatory as possible so the
 best way to understand it is by looking at a simple
-example (e.g. `config.reek` in your project directory):
+example (e.g. `.reek.yml` in your project directory):
 
 ```yaml
 ---
 
 ### Generic smell configuration
 
-# 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.
-NestedIterators:
-  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.
-DataClump:
-  max_copies: 3
-  min_clump_size: 3
+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.
+  NestedIterators:
+    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.
+  DataClump:
+    max_copies: 3
+    min_clump_size: 3
 
 ### Directory specific configuration
 
 # You can configure smells on a per-directory base.
 # E.g. the classic Rails case: controllers smell of NestedIterators (see /docs/Nested-Iterators.md) and
 # helpers smell of UtilityFunction (see docs/Utility-Function.md)
-"web_app/app/controllers":
-  NestedIterators:
-    enabled: false
-"web_app/app/helpers":
-  UtilityFunction:
-    enabled: false
+# Note that we only allow configuration on a directory level, not a file level, so all paths have to point to directories.
+directories:
+  "web_app/app/controllers":
+    NestedIterators:
+      enabled: false
+  "web_app/app/helpers":
+    UtilityFunction:
+      enabled: false
 
 ### Excluding directories
 
@@ -323,6 +330,14 @@ exclude_paths:
   - lib/rake/legacy_tasks
 ```
 
+As you see above, Reek's configuration consists of 3 different sections denoted by 3 different keys:
+
+* detectors
+* directories
+* exclude_paths
+
+Whatever you add to your configuration should be scoped under one of those keys.
+
 If you have a directory directive for which a default directive exists, the more specific
 one (which is the directory directive) will take precedence.
 
@@ -330,15 +345,12 @@ This configuration for instance:
 
 ```yaml
 ---
-IrresponsibleModule:
-  enabled: false
-
-TooManyStatements:
-  max_statements: 5
-
-"app/controllers":
+detectors:
+  IrresponsibleModule:
+    enabled: false
+  
   TooManyStatements:
-    max_statements: 10
+    max_statements: 5
 ```
 
 translates to:
@@ -347,16 +359,53 @@ translates to:
 * TooManyStatements#max_statements is 10 in "app/controllers"
 * TooManyStatements#max_statements is 5 everywhere else
 
-For more details please check out the [Basic Smell Options](docs/Basic-Smell-Options.md)
-which are supported by every smell type. As you can see above, certain smell
-types offer a configuration that goes beyond that of the basic smell options, for instance
+Every smell detector supports our [Basic Smell Options](docs/Basic-Smell-Options.md). As you can see above,
+certain smell types offer a configuration that goes beyond that of the basic smell options, for instance
 [Data Clump](docs/Data-Clump.md).
 All options that go beyond the [Basic Smell Options](docs/Basic-Smell-Options.md)
 are documented in the corresponding smell type /docs page (if you want to get a quick overview over all possible
-configurations you can also check out [the `default.reek` file in this repository](defaults.reek).
+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](defaults.reek) we set you can skip this completely.
+If you're fine with all the [defaults.reek.yml](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
+misspelled an option or used the wrong data type for a value like this:
+
+```
+Error: We found some problems with your configuration file: [/detectors/DetectorWithTypo] key 'DetectorWithTypo:' is undefined.
+```
+
+Reek takes one configuration file and one configuration file only with `.reek.yml` being the default name.
+
+In case you have to have one or more configuration files in the directory (e.g. you're
+toying around with different, mutually exclusive settings) you need to tell Reek
+explicitly which file to use via `reek -c config.reek`.
+
+### Source code comments
+
+In case you need to suppress a smell warning and you can't or don't want to
+use configuration files for whatever reasons you can also use special
+source code comments like this:
+
+```Ruby
+# This method smells of :reek:NestedIterators
+def smelly_method foo
+  foo.each {|bar| bar.each {|baz| baz.qux}}
+end
+```
+
+You can even pass in smell specific configuration settings:
+
+```Ruby
+# :reek:NestedIterators { max_allowed_nesting: 2 }
+def smelly_method foo
+  foo.each {|bar| bar.each {|baz| baz.qux}}
+end
+```
+
+This is an incredibly powerful feature and further explained under [Smell Suppresion](docs/Smell-Suppression.md).
 
 ### Generating a 'todo' list
 
@@ -404,42 +453,6 @@ reek -c other_configuration.reek --todo lib/
 `other_configuration.reek` will simply be ignored (as outlined before, Reek
 is supposed to have one configuration file and one file only).
 
-### Beware of multiple configuration files
-
-Reek takes one configuration file and one configuration file only.
-
-If you have more than one configuration file in the same directory Reek
-will not know what configuration file to use. If this happens Reek will
-print a warning on STDERR and exit with the failure exit status 1.
-
-In case you have to have one or more configuration files in the directory (e.g. you're
-toying around with different, mutually exclusive settings) you need to tell Reek
-explicitly which file to use via `reek -c config.reek`.
-
-### Source code comments
-
-In case you need to suppress a smell warning and you can't or don't want to
-use configuration files for whatever reasons you can also use special
-source code comments like this:
-
-```Ruby
-# This method smells of :reek:NestedIterators
-def smelly_method foo
-  foo.each {|bar| bar.each {|baz| baz.qux}}
-end
-```
-
-You can even pass in smell specific configuration settings:
-
-```Ruby
-# :reek:NestedIterators { max_allowed_nesting: 2 }
-def smelly_method foo
-  foo.each {|bar| bar.each {|baz| baz.qux}}
-end
-```
-
-This is an incredible powerful feature and further explained under [Smell Suppresion](docs/Smell-Suppression.md).
-
 ## Usage
 
 Besides the obvious
@@ -559,23 +572,24 @@ Making Reek "Rails"-friendly is fairly simple since we support directory specifi
 Just add this to your configuration file:
 
 ```Yaml
-"app/controllers":
-  IrresponsibleModule:
-    enabled: false
-  NestedIterators:
-    max_allowed_nesting: 2
-  UnusedPrivateMethod:
-    enabled: false
-  InstanceVariableAssumption:
-    enabled: false
-"app/helpers":
-  IrresponsibleModule:
-    enabled: false
-  UtilityFunction:
-    enabled: false
-"app/mailers":
-  InstanceVariableAssumption:
-    enabled: false
+directories:
+  "app/controllers":
+    IrresponsibleModule:
+      enabled: false
+    NestedIterators:
+      max_allowed_nesting: 2
+    UnusedPrivateMethod:
+      enabled: false
+    InstanceVariableAssumption:
+      enabled: false
+  "app/helpers":
+    IrresponsibleModule:
+      enabled: false
+    UtilityFunction:
+      enabled: false
+  "app/mailers":
+    InstanceVariableAssumption:
+      enabled: false
 ```
 
 Be careful though, Reek does not merge your configuration entries, so if you already have a directory directive for "app/controllers" or "app/helpers" you need to update those directives instead of copying the above YAML sample into your configuration file.
@@ -588,6 +602,7 @@ Be careful though, Reek does not merge your configuration entries, so if you alr
 * [TextMate Bundle](https://github.com/peeyush1234/reek.tmbundle)
 * [Atom plugin](https://atom.io/packages/linter-reek)
 * [SublimeLinter plugin](https://packagecontrol.io/packages/SublimeLinter-contrib-reek)
+* [VS Code plugin](https://github.com/rubyide/vscode-ruby)
 * [Emacs plugin](https://github.com/hanmoi-choi/reek-emacs)
 
 ### Projects that use or support us