reek 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f44c19009380c9dff7c4d8ef4dcdbe6f788d46b2
-  data.tar.gz: b9cfe47dc250a613611f414463a6dbca748690c8
+  metadata.gz: 5c827e3718e3a4f1524fdaf0d6c28df6e86b671b
+  data.tar.gz: 9755661abe970fb1499ee2b9de2f6d701b8c8ee2
 SHA512:
-  metadata.gz: 221c0dbe79b6a6758a30ded23285fd715634843c3ac9bb0b9883aef9a0ebffcf84531dc6e492f091b2fa11cb7087470c96632aa45b53704da831a0a64feb7c1a
-  data.tar.gz: 51c17f02b1aa2c8ff8cf701ba7bc9d98c058a9c4e62fc2b6f246fd43f3be17ed12b6cc58ccb247f99527f909db50c5b4ab7085b08392a4b2c9e26137c8081bb2
+  metadata.gz: 77122032bb96bbd32994195c9745acc214ecfbfff7963348aff01239402deefb74032883eed3762df8eda34c6054447a5ca076dfe707a9a1460a5c14bc85ddf7
+  data.tar.gz: e86a819d479502f6f091c6d6f8b7d1b6c1aae20779131a3e6e62445eb048db3f1f0e1226b59a0b11ca82e9f3c4471578ce4c71c19d0a1fdff96b51f8f5e7d752

data/.rubocop.yml

@@ -8,6 +8,15 @@ AllCops:
     - 'vendor/**/*'
   TargetRubyVersion: 2.1
 
+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:
@@ -64,16 +73,10 @@ RSpec/NestedGroups:
   Exclude:
     - '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'
-
 # rubocop-rspec expects a CodeClimate namespace to go with the code_climate directory.
 RSpec/FilePath:
   Exclude:
+    - 'spec/reek/report/code_climate/code_climate_configuration_spec.rb'
     - 'spec/reek/report/code_climate/code_climate_fingerprint_spec.rb'
     - 'spec/reek/report/code_climate/code_climate_formatter_spec.rb'
     - 'spec/reek/report/code_climate/code_climate_report_spec.rb'

data/.travis.yml

@@ -1,4 +1,5 @@
 sudo: false
+dist: trusty
 cache: bundler
 language: ruby
 bundler_args: --without debugging
@@ -6,21 +7,24 @@ script: bundle exec rake ci
 rvm:
   - 2.1
   - 2.2
-  - 2.3.0
-  - rbx-2
+  - 2.3
+  - 2.4
+  - jruby-9.1.7.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.7.0
     - rvm: jruby-head
-    - rvm: rbx-2
     - rvm: ruby-head
+    - rvm: rubinius-3
   fast_finish: true
+before_install:
+  - rvm use @global
+  - gem uninstall bundler -x
+  - gem install bundler --version=1.13.7
+  - bundler --version
 notifications:
   email:
     - timo.roessner@googlemail.com

data/CHANGELOG.md

@@ -1,11 +1,44 @@
 # Change log
 
+## 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/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 'rake',          '~> 12.0'
   gem 'rspec',         '~> 3.0'
-  gem 'simplecov',     '~> 0.12.0'
+  gem 'simplecov',     '~> 0.14.0'
   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.47.1'
+    gem 'rubocop-rspec', '~> 1.13.0'
   end
 
   platforms :mri do
-    gem 'redcarpet', '~> 3.3.1'
+    gem 'redcarpet', '~> 3.4.0'
   end
 end
 

data/README.md

@@ -16,8 +16,9 @@
   - [Configuration file](#configuration-file)
     - [Configuration loading](#configuration-loading)
     - [Configuration options](#configuration-options)
-  - [Source code comments](#source-code-comments)
   - [Generating a 'todo' list](#generating-a-todo-list)
+  - [Beware of multiple configuration files](#beware-of-multiple-configuration-files)
+  - [Source code comments](#source-code-comments)
 - [Usage](#usage)
 - [Developing Reek / Contributing](#developing-reek--contributing)
 - [Output formats](#output-formats)
@@ -355,30 +356,6 @@ configurations you can also check out [the `default.reek` file in this repositor
 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.
 
-### 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).
-
 ### Generating a 'todo' list
 
 Integrating tools like Reek into an existing larger codebase can be daunting when you have to fix
@@ -425,6 +402,42 @@ 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
@@ -462,7 +475,7 @@ Or just run the whole test suite:
 bundle exec rake
 ```
 
-This will run the tests (RSpec and Cucumber), RuboCop and Reek itself.
+This will run the RSpec tests, RuboCop and Reek itself.
 
 You can also run:
 
@@ -470,7 +483,9 @@ You can also run:
 bundle exec rake ci
 ```
 
-This will run everything the default task runs and also [Ataru](https://github.com/CodePadawans/ataru) and [Mutant](https://github.com/mbj/mutant). This is the task that we run on Travis as well and that determines if your pull request is green or red.
+This will run everything the default task runs and also
+our Cucumber features and [Ataru](https://github.com/CodePadawans/ataru). This is the task that we run on
+Travis as well and that determines if your pull request is green or red.
 
 Another useful Rake task is the `console` task. This will throw you right into an environment where you can play around with Reeks modules and classes:
 
@@ -542,6 +557,9 @@ Just add this to your configuration file:
     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.

data/docs/How-To-Write-New-Detectors.md

@@ -9,19 +9,19 @@ it covers and the overall rationale behind it.
 
 ### Structure
 
-All smell detectors reside in `lib/reek/smells` and have the following base structure:
+All smell detectors reside in `lib/reek/smell_detectors` and have the following base structure:
 
 ```Ruby
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # Here goes your introduction for this detector.
     #
     # See {file:docs/Your-Detector.md} for details.
-    class YourDetector < SmellDetector
+    class YourDetector < BaseDetector
       def self.contexts
         [:class] # In case you're operating on class contexts only - just an example.
       end
@@ -37,7 +37,7 @@ module Reek
         # This can just be a method but it can also be a more sophisticated set up.
         # Check out other smell detectors to get a feeling for what to do here.
         found_smells(ctx).map do |smell|
-          # "smell_warning" is defined in SmellDetector and should be used by you
+          # "smell_warning" is defined in BaseDetector and should be used by you
           # to construct smell warnings
           smell_warning(
             context: ctx,
@@ -59,7 +59,7 @@ module Reek
 end
 ```
 
-For your detector to be properly loaded you need to require it in `lib/reek/smells.rb` as well.
+For your detector to be properly loaded you need to require it in `lib/reek/smell_detectors.rb` as well.
 
 ### defaults.reek
 

data/docs/Irresponsible-Module.md

@@ -2,7 +2,14 @@
 
 ## Introduction
 
-Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.
+Classes and modules are the units of reuse and release. It is therefore
+considered good practice to annotate every class and module with a brief
+comment outlining its responsibilities.
+
+For further guideline on how to write good documentation in Ruby, see these
+links:
+- [Rails API documentation guidelines](http://edgeguides.rubyonrails.org/api_documentation_guidelines.html)
+- [Comments tell you why](https://blog.codinghorror.com/code-tells-you-how-comments-tell-you-why/)
 
 ## Example
 

data/docs/Nil-Check.md

@@ -17,7 +17,7 @@ Given
 class Klass
   def nil_checker(argument)
     if argument.nil?
-      puts "argument isn't nil!"
+      puts "argument is nil!"
     end
   end
 end

data/docs/Prima-Donna-Method.md

@@ -61,3 +61,30 @@ method `foo` of the `Dangerous` module.
 ## Configuration
 
 _Prima Donna Method_ offers the [Basic Smell Options](Basic-Smell-Options.md).
+
+## Example configuration via source comment
+
+Imagine code like this:
+
+```Ruby
+class Alfa
+  def bravo!
+  end
+end
+```
+
+This would report:
+
+>>
+ruby.rb -- 1 warning:
+  [1]:PrimaDonnaMethod: Alfa has prima donna method 'bravo!'
+
+If you want to suppress this warning you can do this via source comment like this:
+
+```Ruby
+# :reek:PrimaDonnaMethod: { exclude: [ bravo! ] }
+class Alfa
+  def bravo!
+  end
+end
+```

data/docs/RSpec-matchers.md

@@ -74,15 +74,10 @@ See the "Quickstart" example from above.
 Checks the target source code for instances of "smell type"
 and returns true only if it can find one of them that matches.
 
-Remember that this includes our "smell types" as well. So it could be the
-"smell type" UtilityFunction, which is represented as a concrete class
-in Reek but it could also be "Duplication" which is a "smell categgory".
+You can pass the smell type you want to check for as String or as Symbol:
 
-You could pass many different types of input here:
 - `:UtilityFunction`
 - `"UtilityFunction"`
-- `Reek::Smells::UtilityFunction` (the right way if you really want to pass a
-  class)
 
 It is recommended to pass this as a symbol like `:UtilityFunction`. However we
 don't enforce this.
@@ -106,20 +101,20 @@ So in a nutshell `reek_of` takes the following two arguments:
 
 ```Ruby
   reek_of(:FeatureEnvy)
-  reek_of(Reek::Smells::UtilityFunction)
+  reek_of(:UtilityFunction)
 ```
 
 With smell_details:
 
 ```Ruby
-  reek_of(UncommunicativeParameterName, name: 'x2')
-  reek_of(DataClump, count: 3)
+  reek_of(:UncommunicativeParameterName, name: 'x2')
+  reek_of(:DataClump, count: 3)
 ```
 
 **Examples from a real spec**
 
 ```Ruby
-  expect(src).to reek_of(Reek::Smells::DuplicateMethodCall, name: '@other.thing')
+  expect(src).to reek_of(:DuplicateMethodCall, name: '@other.thing')
 ```
 
 ### reek_only_of

data/docs/Unused-Private-Method.md

@@ -48,6 +48,33 @@ end
 Note that disabling this detector via comment works on a class scope, not
 a method scope (like you can see above).
 
+Another simple example would be:
+
+```Ruby
+class Alfa
+  private
+  def bravo
+  end
+end
+```
+
+This would report:
+
+>>
+ruby.rb -- 1 warning:
+  [3]:UnusedPrivateMethod: Alfa has the unused private instance method 'bravo'
+
+If you want to suppress this warning you can do this via source comment like this:
+
+```Ruby
+# :reek:UnusedPrivateMethod: { exclude: bravo }
+class Alfa
+  private
+  def bravo
+  end
+end
+```
+
 ## Known limitations
 
 * Method calls via dynamic dispatch (e.g. via `send`) is something Reek (or any other

data/docs/templates/default/docstring/setup.rb

@@ -10,14 +10,7 @@ end
 
 def api_marker
   return if object.type == :root
-  case api_text
-  when 'public'
-    # erb(:public_api_marker)
-  when 'private'
-    # Let section 'private' handle this.
-  else
-    erb(:private)
-  end
+  erb(:private) unless ['public', 'private'].include? api_text
 end
 
 private

data/features/command_line_interface/options.feature

@@ -41,7 +41,9 @@ Feature: Reek can be controlled using command-line options
 
       Configuration:
           -c, --config FILE                Read configuration options from FILE
-              --smell SMELL                Detect smell SMELL (default: all enabled smells)
+              --smell SMELL                Only look for a specific smell.
+                                           Call it like this: reek --smell PrimaDonnaMethod source.rb
+                                           Check out https://github.com/troessner/reek/blob/master/docs/Code-Smells.md for a list of smells
 
       Generate a todo list:
           -t, --todo                       Generate a todo list
@@ -65,6 +67,8 @@ Feature: Reek can be controlled using command-line options
               --sort-by SORTING            Sort reported files by the given criterium:
                                              smelliness ("smelliest" files first)
                                              none (default - output in processing order)
+              --force-exclusion            Force excluding files specified in the configuration `exclude_paths`
+                                             even if they are explicitly passed as arguments
 
      Exit codes:
               --success-exit-code CODE     The exit code when no smells are found (default: 0)

data/features/command_line_interface/stdin.feature

@@ -35,5 +35,5 @@ Feature: Reek reads from $stdin when no files are given
   Scenario: syntax error causes the source to be ignored
     When I pass "= invalid syntax =" to reek
     Then it reports a parsing error
-    Then it succeeds
+    And the exit status indicates an error
     And it reports nothing

data/features/configuration_files/exclude_paths_directives.feature

@@ -0,0 +1,43 @@
+Feature: Exclude paths directives
+  In order to avoid Reek wasting time on files that cannot be fixed
+  As a user
+  I want to be able to exclude specific paths from being checked
+
+  Scenario: Exclude some paths
+    Given a file named "bad_files_live_here/smelly.rb" with:
+      """
+      # A smelly example class
+      class Smelly
+        def alfa(bravo); end
+      end
+      """
+    When I run `reek .`
+    Then the exit status indicates smells
+    Given a file named "config.reek" with:
+      """
+      ---
+      exclude_paths:
+        - bad_files_live_here
+      """
+    When I run `reek -c config.reek .`
+    Then it succeeds
+    And it reports nothing
+  Scenario: Using a file name within an excluded directory
+    Given a file named "bad_files_live_here/smelly.rb" with:
+      """
+      # A smelly example class
+      class Smelly
+        def alfa(bravo); end
+      end
+      """
+    And a file named "config.reek" with:
+      """
+      ---
+      exclude_paths:
+        - bad_files_live_here
+      """
+    When I run `reek -c config.reek bad_files_live_here/smelly.rb`
+    Then the exit status indicates smells
+    When I run `reek -c config.reek --force-exclusion bad_files_live_here/smelly.rb`
+    Then it succeeds
+    And it reports nothing

data/features/configuration_files/warn_about_multiple_configuration_files.feature

@@ -0,0 +1,44 @@
+Feature: Warn on multiple configuration files
+  Reek is designed for one configuration file and for one configuration file only.
+  We should make this clear to the user by warning him when we detect multiple
+  configuration files and then exiting the program.
+
+  Scenario: Warn on more than one configuration file
+    Given the smelly file 'smelly.rb'
+    And a file named "config.reek" with:
+      """
+      ---
+      UncommunicativeMethodName:
+        enabled: false
+      """
+    And a file named ".todo.reek" with:
+      """
+      ---
+      UtilityFunction:
+        enabled: false
+      """
+    When I run reek smelly.rb
+    Then it reports the error "Error: Found multiple configuration files '.todo.reek', 'config.reek'"
+    And it reports the error "Reek supports only one configuration file. You have 2 options now:"
+    And it reports the error "1) Remove all offending files"
+    And it reports the error "2) Be specific about which one you want to load via the -c switch"
+    And the exit status indicates an error
+
+  Scenario: Do not warn on more than one when we explicitly specify one configuration file
+    Given the smelly file 'smelly.rb'
+    And a file named "config.reek" with:
+      """
+      ---
+      UncommunicativeMethodName:
+        enabled: false
+      """
+    And a file named ".todo.reek" with:
+      """
+      ---
+      UtilityFunction:
+        enabled: false
+      """
+    When I run reek -c config.reek smelly.rb
+    Then the exit status indicates smells
+    And it reports no errors
+

data/features/configuration_via_source_comments/erroneous_source_comments.feature

@@ -51,3 +51,18 @@ Feature: Erroneous source comments are handled properly
     And it reports the error "Unfortunately we can not parse the configuration you have given."
     And it reports the error "The source is 'bad_comment.rb'"
     And it reports the error "the comment belongs to the expression starting in line 3"
+
+  Scenario: Bad configuration key
+    Given a file named "bad_comment.rb" with:
+      """
+      # Test class
+      # exclude -> elude and accept -> accipt are bad keys
+      # :reek:UncommunicativeMethodName { elude: 'foo', accipt: 'bar' }
+      def x
+      end
+      """
+    When I run reek bad_comment.rb
+    Then it reports the error "Error: You are trying to configure the smell detector 'UncommunicativeMethodName'"
+    And it reports the error "in one of your source code comments with the unknown option 'elude', 'accipt'"
+    And it reports the error "The source is 'bad_comment.rb'"
+    And it reports the error "the comment belongs to the expression starting in line 4"