reek 2.0.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8af5e0348f9f24426352d7790b0c3b4574b7128b
-  data.tar.gz: 42b3c7339cae9caebbcab1ab5a6386b21165ae6a
+  metadata.gz: da371c20978d5a436025bc2ecddc2df4582a9c7e
+  data.tar.gz: 8aa3729d6814cba34e69ff9e1696ce93450221c6
 SHA512:
-  metadata.gz: c33ef48a39ed8a20ba2a5e4b1973851004f668d4b1878805ce0a245743cd5bbba0c64c4a96747200762b273eae7762433c0509376552620ebd490fa0c2203f9f
-  data.tar.gz: f682a7ae37aa0787e5dd6215e03ee5340b121e0bc7532f8c0275b6c8274ffccd6345a3a61d7b51e3beb80baa53bb47fdfceaac6422802057741de0d45e7d1d36
+  metadata.gz: d15340c5aa637820c280d28008579ecc97f9de7a56bf74e47f6f217a9f593d3a1416dfa6757b4beb3900032c505eed91aa8fa21de94374ac1e2d1537706cbabb
+  data.tar.gz: c49a1ae86f1265e493f6e5eff700e2d02c2849358a49db20d87d9c52498138da0ca38fd7bd83cb90d0c16cb7b19789aa43422b052910b145ac611d9421bc6bf8

data/.gitignore

@@ -0,0 +1,13 @@
+pkg
+spec/output
+tmp
+doc
+.yardoc
+.bundle
+.rspec
+.rbx
+Gemfile.lock
+*.swp
+tags
+.pryrc
+.tags*

data/.rubocop.yml

@@ -0,0 +1,47 @@
+AllCops:
+  Exclude:
+    - 'spec/samples/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+
+# FIXME: Make the class shorter
+Metrics/ClassLength:
+  Exclude:
+    - lib/reek/tree_walker.rb
+    - lib/reek/cli/options.rb
+
+# FIXME: Lower the method length by fixing the biggest offenders
+Metrics/MethodLength:
+  Max: 15
+
+# Be a little more lenient with line length
+Metrics/LineLength:
+  Max: 100
+
+# Allow small arrays of words with quotes
+Style/WordArray:
+  MinSize: 3
+
+# Allow single-line method definitions
+Style/SingleLineMethods:
+  Enabled: false
+
+# Always use raise to signal exceptions
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Place . on the previous line
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+# Require empty lines between defs, except for one-line defs
+Style/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+# Allow multiline block chains
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Allow Perl-style references to regex matches
+Style/PerlBackrefs:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,31 @@
+sudo: false
+cache: bundler
+language: ruby
+bundler_args: --without local_development
+script:
+- bundle exec rake
+- bundle exec ataru check
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - rbx-2
+  - ruby-head
+matrix:
+  include:
+    - rvm: jruby-19mode
+      env: JRUBY_OPTS='--server -Xcompile.invokedynamic=false'
+    - rvm: jruby-head
+      env: JRUBY_OPTS='--server -Xcompile.invokedynamic=false'
+  allow_failures:
+    - rvm: jruby-head
+      env: JRUBY_OPTS='--server -Xcompile.invokedynamic=false'
+    - rvm: ruby-head
+  fast_finish: true
+notifications:
+  recipients:
+    - timo.roessner@googlemail.com
+    - matijs@matijs.net
+    - emil.rehnberg@gmail.com
+    - chastell@chastell.net
+  irc: "irc.freenode.org#reek"

data/.yardopts

@@ -1,10 +1,7 @@
 --no-private
 --readme README.md
-lib/reek.rb
-lib/reek/*.rb
-lib/reek/smells/*.rb
-lib/reek/source/*.rb
-lib/reek/spec/*.rb
-lib/reek/rake/*.rb
+--load ./docs/yard_plugin.rb
 -
 *.txt
+*.md
+docs/*.md

data/CHANGELOG

@@ -1,3 +1,27 @@
+== 3.0.0
+
+* (troessner) Make directories excludable via configuration.
+* (mvz) Define and document public API
+* (troessner) Recognize methods defined with class << self syntax as singleton methods.
+* (troessner)  Use ruby22 instead of ruby21 for parsing.
+* (nTraum) Drop support for Ruby 1.9
+
+== 2.2.1
+
+* (mvz) Support methods using array decomposition arguments
+
+== 2.2.0
+
+* (sauliusgrigaitis) Add support for XML reports
+* (beanieboi) Don’t track private methods in the Attributes smell
+* (Sebastian Boehm) Do not enable colorization if stdout is not a TTY
+
+== 2.1.0
+
+* (mvz) Ensure require 'reek' is enough to use reek's classes
+* (mvz) Pick config file that comes first alphabetically
+* (mvz) Separate FeatureEnvy and UtilityFunction
+
 == 2.0.4
 
 * (chastell)  Recognise .reek as a valid configuration file

data/CONTRIBUTING.md

@@ -0,0 +1,111 @@
+# Contributing to reek
+
+We welcome any and all contributions to reek!
+
+If what you’re proposing requires significant work discuss it beforehand
+as an issue – it’s much easier for us to guide you towards a good
+solution and less frustrating for you than doing a lot of work
+only to find us suggesting large parts should be rewritten.
+
+Don’t hesitate to offer trivial fixes (spelling, better naming
+ideas, etc.) – we’ll let you know if you’re overdoing it. :)
+
+
+
+## Reporting Issues
+
+Search [all existing (open _and_ closed)
+issues](https://github.com/troessner/reek/issues?q=is%3Aissue)
+for a possible previous report; comment there if the issue is not
+actually resolved properly or you have any additional information.
+
+Include the steps to reproduce the issue,
+the expected outcome and the actual outcome.
+
+Include as much information as possible: the exact reek
+invocation that you use, reek’s config and version, Ruby
+version, Ruby platform (MRI, JRuby, etc.), operating system.
+
+Try to provide a minimal example that reproduces the issue.
+Extra kudos if you can write it as a failing test. :)
+
+
+
+## Setup and Pull Request Basics
+
+Fork reek, then clone it, make sure you have
+[Bundler](http://bundler.io) installed, install dependencies
+and make sure all of the existing tests pass:
+
+```
+git clone git@github.com:…username…/reek.git
+cd reek
+gem install bundler
+bundle
+bundle exec rake
+```
+
+Once you’re sure your copy of reek works (and that there are no
+failing tests on the "develop" branch) create your own branch from our "develop" branch.
+
+We are using the popular [gitflow branch model](http://nvie.com/posts/a-successful-git-branching-model/) and
+require contributions to follow to this model as well.
+This probably sounds more complicated than it is, for you this just means that you should branch off
+of our "develop" branch for your pull request, not master (which is the default already):
+
+```
+git checkout -b your_feature_or_fix_name
+```
+
+Then start hacking and add new tests which make sure that your new feature works or
+demonstrate that your fix was needed; please also [write good commit
+messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+Once you’re happy with your feature / fix – or want to
+share it as a work-in-progress and request comments – once
+again make sure all of the tests pass. This will also run
+[RuboCop](https://github.com/bbatsov/rubocop) – fix any
+offences RuboCop finds (or discuss them in the pull request):
+
+```
+bundle exec rake
+```
+
+Once your code is ready for review push it to your repository:
+
+```
+git push -u origin
+```
+
+Then go to your GitHub fork and [make a pull
+request](https://help.github.com/articles/creating-a-pull-request/)
+to the original repository.
+
+
+
+## Review and Fixes
+
+Try to gauge and let us know in the pull request whether what
+you propose is a backward-compatible bugfix and should go into the
+next patch release, is a backward-compatible feature and should go
+into the next minor release, or has to break backward-compatibility
+and so needs to wait for the next major release of reek.
+
+Once your PR is open someone will review it, discuss the details (if
+needed) and either merge right away or ask for some further fixes.
+
+GitHub doesn’t have a good way to amend pull requests from external
+repositories. In cases where it’s easier to make a direct fix
+to your pull request (rather than describing it in the comments)
+we’ll either open a separate pull request to the branch in your
+repository or ask you to give us commit access to your repository.
+
+If there were any fixes to your pull request we’ll ask you to
+[squash](http://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Squashing-Commits)
+all of the commits into one:
+
+```
+git rebase -i develop
+# squash squash squash
+git push -f origin
+```

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# The gem's dependencies are specified in the gemspec
+gemspec
+
+group :local_development do
+  gem 'pry'
+  gem 'yard', '~> 0.8.7'
+
+  platforms :mri do
+    gem 'pry-byebug'
+    gem 'pry-stack_explorer'
+
+    gem 'redcarpet', '~> 3.3.1'
+  end
+end

data/README.md

@@ -1,16 +1,18 @@
-# Reek -- code smell detection for Ruby
+# `reek`: code smell detection for Ruby
 
 ## Overview
 
 
 [![Build Status](https://secure.travis-ci.org/troessner/reek.png?branch=master)](https://travis-ci.org/troessner/reek?branch=master)
-[![Gem Version](https://badge.fury.io/rb/reek.png)](https://badge.fury.io/rb/reek)
+[![Gem Version](https://badge.fury.io/rb/reek.svg)](https://badge.fury.io/rb/reek)
 [![Dependency Status](https://gemnasium.com/troessner/reek.png)](https://gemnasium.com/troessner/reek)
 [![Inline docs](https://inch-ci.org/github/troessner/reek.png)](https://inch-ci.org/github/troessner/reek)
 
 ## Quickstart
 
-`reek` is a tool that examines Ruby classes, modules and methods and reports any [Code Smells](https://github.com/troessner/reek/wiki/Code-Smells) it finds. Install it like this:
+`reek` is a tool that examines Ruby classes, modules and methods and reports any
+[Code Smells](docs/Code-Smells.md) it finds.
+Install it like this:
 
 ```Bash
 gem install reek
@@ -24,34 +26,32 @@ reek [options] [dir_or_source_file]*
 
 ## Example
 
-Imagine a source file <tt>demo.rb</tt> containing:
+Imagine a source file `demo.rb` containing:
 
 ```Ruby
 class Dirty
   # This method smells of :reek:NestedIterators but ignores them
   def awful(x, y, offset = 0, log = false)
     puts @screen.title
-    @screen = widgets.map {|w| w.each {|key| key += 3}}
+    @screen = widgets.map { |w| w.each { |key| key += 3 * x } }
     puts @screen.contents
   end
 end
 ```
 
-Reek will report the following code smells in this file:
+`reek` will report the following code smells in this file:
 
 ```
 $ reek demo.rb
-spec/samples/demo/demo.rb -- 6 warnings:
-  Dirty has no descriptive comment (IrresponsibleModule)
-  Dirty#awful has 4 parameters (LongParameterList)
-  Dirty#awful has boolean parameter 'log' (ControlCouple)
-  Dirty#awful has the parameter name 'x' (UncommunicativeName)
-  Dirty#awful has the parameter name 'y' (UncommunicativeName)
-  Dirty#awful has the variable name 'w' (UncommunicativeName)
-  Dirty#awful has unused parameter 'log' (UnusedParameters)
-  Dirty#awful has unused parameter 'offset' (UnusedParameters)
-  Dirty#awful has unused parameter 'x' (UnusedParameters)
-  Dirty#awful has unused parameter 'y' (UnusedParameters)
+demo.rb -- 8 warnings:
+  [1]:Dirty has no descriptive comment (IrresponsibleModule)
+  [3]:Dirty#awful has 4 parameters (LongParameterList)
+  [3]:Dirty#awful has boolean parameter 'log' (BooleanParameter)
+  [3]:Dirty#awful has the parameter name 'x' (UncommunicativeParameterName)
+  [5]:Dirty#awful has the variable name 'w' (UncommunicativeVariableName)
+  [3]:Dirty#awful has unused parameter 'log' (UnusedParameters)
+  [3]:Dirty#awful has unused parameter 'offset' (UnusedParameters)
+  [3]:Dirty#awful has unused parameter 'y' (UnusedParameters)
 ```
 
 ## Sources
@@ -70,13 +70,13 @@ So
 reek
 ```
 
-is the exact same thing like being explicit:
+is the exact same thing as being explicit:
 
 ```Bash
 reek .
 ```
 
-Additionally can you pipe code to reek like this:
+Additionally you can pipe code to `reek` like this:
 
 ```Bash
 echo "class C; def m; end; end" | reek
@@ -93,11 +93,22 @@ $stdin -- 3 warnings:
 
 ## Code smells
 
-`reek` currently includes checks for some aspects of [Control Couple](https://github.com/troessner/reek/wiki/Control-Couple), [Data Clump](https://github.com/troessner/reek/wiki/Data-Clump), [Feature Envy](https://github.com/troessner/reek/wiki/Feature-Envy), [Large Class](https://github.com/troessner/reek/wiki/Large-Class), [Long Parameter List](https://github.com/troessner/reek/wiki/Long-Parameter-List), [Simulated Polymorphism](https://github.com/troessner/reek/wiki/Simulated-Polymorphism), [Too Many Statements](https://github.com/troessner/reek/wiki/Too-Many-Statements), [Uncommunicative Name](https://github.com/troessner/reek/wiki/Uncommunicative-Name), [Unused Parameters](https://github.com/troessner/reek/wiki/Unused-Parameters) and more. See the [Code Smells](https://github.com/troessner/reek/wiki/Code-Smells) for up to date details of exactly what `reek` will check in your code.
+`reek` currently includes checks for some aspects of
+[Control Couple](docs/Control-Couple.md),
+[Data Clump](docs/Data-Clump.md),
+[Feature Envy](docs/Feature-Envy.md),
+[Large Class](docs/Large-Class.md),
+[Long Parameter List](docs/Long-Parameter-List.md),
+[Simulated Polymorphism](docs/Simulated-Polymorphism.md),
+[Too Many Statements](docs/Too-Many-Statements.md),
+[Uncommunicative Name](docs/Uncommunicative-Name.md),
+[Unused Parameters](docs/Unused-Parameters.md)
+and more. See the [Code Smells](docs/Code-Smells.md)
+for up to date details of exactly what `reek` will check in your code.
 
 ## Configuration
 
-### Command line interface
+### Command-line interface
 
 For a basic overview, run
 
@@ -105,29 +116,45 @@ For a basic overview, run
 reek --help
 ```
 
-For a summary of those CLI options see [Command-Line Options](https://github.com/troessner/reek/wiki/Command-Line-Options).
+For a summary of those CLI options see [Command-Line Options](docs/Command-Line-Options.md).
 
-### Configuration files
+### Configuration file
 
 #### Configuration loading
 
-Configuring `reek` via configuration file is by far the most powerful way.
+Configuring `reek` via a configuration file is by far the most powerful way.
 
-There are 3 ways of passing `reek` a configuration file:
+There are three ways of passing `reek` a configuration file:
 
-1. Using the cli "-c" switch (see "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
+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
 
-The order in which `reek` tries to find such a configuration file is exactly like above: First `reek` checks if we have given it a configuration file explicitly via CLI. Then it checks the current working directory for a file and if it can't find one, it traverses up the directories until it hits the root directory. And lastly, it checks 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
+it a configuration file explicitly via CLI; then it checks
+the current working directory for a file and if it can't
+find one, it traverses up the directories until it hits the
+root directory; lastly, it checks your home directory.
 
-As soon as `reek` detects a configuration file it stops searching immediately, meaning that from `reek`'s point of view there exists one configuration file and one configuration only regardless of how many ".reek" files you might have on your filesystem.
+As soon as `reek` detects a configuration file it stops searching
+immediately, meaning that from `reek`'s point of view there exists
+exactly one configuration file and one configuration, regardless
+of how many `*.reek` files you might have on your filesystem.
 
 #### Configuration options
 
-The first thing you probably want to check out are the [Basic Smell Options](https://github.com/troessner/reek/wiki/Basic-Smell-Options) which are supported by every smell type.
-Certain smell types offer a configuration that goes beyond that of the basic smell options - for instance [Data Clump](https://github.com/troessner/reek/wiki/Data-Clump).
-All options that go beyond the [Basic Smell Options](https://github.com/troessner/reek/wiki/Basic-Smell-Options) should be documented in the corresponding smell type wiki page but if you want to get a quick and full overview over all possible configurations you can always check out [the default.reek file in this repository](https://github.com/troessner/reek/blob/master/config/defaults.reek).
+The first thing you probably want to check out are the
+[Basic Smell Options](docs/Basic-Smell-Options.md)
+which are supported by every smell type. 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)
+should be documented in the corresponding smell type wiki page,
+but if you want to get a quick and full overview over all possible
+configurations you can always check out [the `config/default.reek`
+file in this repository](config/defaults.reek).
 
 Here's an excerpt of a `reek` configuration file from a commercial project:
 
@@ -135,20 +162,30 @@ Here's an excerpt of a `reek` configuration file from a commercial project:
 ---
 IrresponsibleModule:
   enabled: false
+
 NestedIterators:
   exclude:
     - "ActiveModelErrorAdder#self.run" # should be refactored
     - "BookingRequests::Transfer#remote_validation"
     - "BookingRequestsController#vehicle_options" # respond_to block
     - "Content::Base#self.expose_fields" # unavoidable due to metaprogramming
+
 DataClump:
   max_copies: 3
   min_clump_size: 3
+
+exclude_paths:
+  - app/views
+  - app/controllers
 ```
 
+Additionally to the smell configuration you can exclude whole directories from scans using `exclude_paths` as you can see at the end of the configuration above.
+
 ### Source code comments
 
-`reek` is not the police. 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 source code comments like this:
+`reek` is not the police. 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 source code comments like this:
 
 ```Ruby
 # This method smells of :reek:NestedIterators
@@ -157,7 +194,7 @@ def smelly_method foo
 end
 ```
 
-This is further explained [here](https://github.com/troessner/reek/wiki/Smell-Suppression)
+This is further explained under [Smell Suppresion](docs/Smell-Suppression.md).
 
 
 ## Integration
@@ -168,21 +205,21 @@ Besides the obvious
 reek [options] [dir_or_source_file]*
 ```
 
-there are quite a few other ways how to use reek in your projects:
+there are quite a few other ways how to use `reek` in your projects:
 
-* Use `reek`'s [Rake Task](https://github.com/troessner/reek/wiki/Rake-Task) to automate detecting code smells
-* Add `reek`'s custom matcher to your [RSpec examples](https://github.com/troessner/reek/wiki/RSpec-Integration)
-* Include `reek` using the [Developer API](https://github.com/troessner/reek/wiki/Developer-Api)
+* Use `reek`'s [Rake task](docs/Rake-Task.md) to automate detecting code smells
+* Add `reek`'s custom matcher to your [RSpec examples](docs/RSpec-matchers.md)
+* Include `reek` using the [Developer API](docs/API.md)
 
-## Developing reek / Contributing
+## Developing `reek` / Contributing
 
-The first thing you want to do after checking out the source code is to run bundler
+The first thing you want to do after checking out the source code is to run Bundler:
 
 ```
 bundle install
 ```
 
-and then to run the tests:
+and then run the tests:
 
 ```bash
 bundle exec rspec spec/your/file_spec.rb            # Runs all tests in spec/your/file_spec.rb
@@ -191,49 +228,65 @@ bundle exec cucumber features/your_file.feature     # Runs all scenarios in your
 bundle exec cucumber features/your_file.feature:23  # Runs scenario at line 23
 ```
 
-Or just run the whole test suite by running
+Or just run the whole test suite:
 
 ```
 bundle exec rake
 ```
 
-From then on continue by following the establish [pull request workflow](https://help.github.com/articles/using-pull-requests/).
+From then on you should check out:
+* [How reek works internally](docs/How-reek-works-internally.md)
+* [the contributing guide](CONTRIBUTING.md)
+
 
 If you don't feel like getting your hands dirty with code there are still other ways you can help us:
 
-* Work on the [wiki](https://github.com/troessner/reek/wiki)
-* Open up an [issue](https://github.com/troessner/reek/issues) and report bugs or suggest other improvements
+* Open up an [issue](https://github.com/troessner/reek/issues) and report bugs
+* Suggest other improvements like additional smells for instance
 
 ## Output formats
 
-`reek` supports 3 output formats:
+`reek` supports 5 output formats:
 
 * plain text (default)
-* html (`--format html`)
-* yaml (`--format yaml`)
-* json (`--format json`)
+* HTML (`--format html`)
+* YAML (`--format yaml`, see also [YAML Reports](docs/YAML-Reports.md))
+* JSON (`--format json`)
+* XML  (`--format xml`)
+
+## Working with Rails
+
+With current versions of `reek` it's best to examine only your `app/models` folder, because `reek` raises false positives against views and controllers.
+
+For example, `params` is a kind of DTO (data transfer object) close to the system boundary, and so its characteristics should be different than regular code. But Reek doesn't know that (yet); `reek` thinks that all those `params[:something]` calls are a problem, and reports them as smells.
+
+We plan to improve Reek in the near future so that it plays better with Rails. For now though, your best bet is to restrict it to looking at `app/models` and `lib`.
 
 ## Additional resources
 
 ### Tools
 
-There's a vim plugin for `reek`:
-[https://github.com/rainerborene/vim-reek](https://github.com/rainerborene/vim-reek)
+* [Vim plugin for `reek`](https://github.com/rainerborene/vim-reek)
+* [TextMate Bundle for `reek`](https://github.com/peeyush1234/reek.tmbundle)
+* [Colorful output for `reek`](https://github.com/joenas/preek)
+  (also with [Guard::Preek](https://github.com/joenas/guard-preek))
+* [Atom plugin for `reek`](https://atom.io/packages/linter-reek)
+* [overcommit, a Git commit hook manager with support for
+  `reek`](https://github.com/brigade/overcommit)
 
-TextMate Bundle for `reek`:
-[https://github.com/peeyush1234/reek.tmbundle](https://github.com/peeyush1234/reek.tmbundle)
+### Miscellaneous
 
-Colorful output for `reek`: [Preek](https://github.com/joenas/preek) (also with
-[Guard::Preek](https://github.com/joenas/guard-preek))
+* [Reek Driven Development](docs/Reek-Driven-Development.md)
+* [Versioning policy](docs/Versioning-Policy.md)
 
-### Find out more:
+### More information
 
 * [Stack Overflow](https://stackoverflow.com/questions/tagged/reek)
-* [RDoc](http://rdoc.info/projects/troessner/reek)
+* [RubyDoc.info](http://www.rubydoc.info/gems/reek)
 
 ## Contributors
 
-A non exhaustive list:
+A non-exhaustive list:
 
 * Kevin Rutherford
 * Matijs van Zuijlen

data/bin/reek

@@ -6,6 +6,6 @@
 # Author: Kevin Rutherford
 #
 
-require 'reek/cli/application'
+require_relative '../lib/reek/cli/application'
 
-exit Reek::Cli::Application.new(ARGV).execute
+exit Reek::CLI::Application.new(ARGV).execute

data/config/cucumber.yml

@@ -0,0 +1,3 @@
+default: --tags ~@wip -fprogress -r features features
+wip: -fpretty --tags @wip --wip features
+

data/config/defaults.reek

@@ -109,4 +109,3 @@ UnusedParameters:
 UtilityFunction:
   enabled: true
   exclude: []
-  max_helper_calls: 1