reek 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e3eceb35601fc0869c63c3b45034947d62e803a
-  data.tar.gz: bfafa8489c105d8cd9681dcd1ba640f501abf928
+  metadata.gz: afd9361841a4f7ae194b659bbc70c06e4bef20f2
+  data.tar.gz: 52e321f176aca45a3c424aff60749ad3bc11f695
 SHA512:
-  metadata.gz: f2474b97d54de8ed1b7aa7424a706d18e0f2812b2ac9e7959be70f6b301c8a643968f7cffeff6a83a98b3f65a6aae144a9e743bfca82e6bd4832cfb226b11520
-  data.tar.gz: e4cc1838cbefcd6cdd85f3675f64476ffb1a37ec26e541778f742855cae709ae63199e1069dca2d224eb87b00090496cf344eaef2d5e1cff74467bf25ffeb8a4
+  metadata.gz: 87df16e382177e9a3a2f0f6465fb3eaed25ccebf274f9ebb8f3918ba81a860f93895a780c48ee12ddcae529ac544dda89715e132880ddbeee5b001a165c38003
+  data.tar.gz: 82b2b6aa9cde0da91999aff5ddcf8f2b6a7096b1766294023ddc3c58b0162f3e5bb27cdc653d8d0a2521f844c5580f2459d0ea2b6d66df7c31b4d7f29ab50f87

data/.rubocop.yml

@@ -4,18 +4,15 @@ AllCops:
     - 'tmp/**/*'
     - 'vendor/**/*'
 
-# FIXME: Lower the ABC size by fixing the biggest offenders
-Metrics/AbcSize:
-  Max: 25
-
 # FIXME: Make the class shorter
 Metrics/ClassLength:
   Exclude:
     - lib/reek/core/tree_walker.rb
+    - lib/reek/cli/options.rb
 
 # FIXME: Lower the method length by fixing the biggest offenders
 Metrics/MethodLength:
-  Max: 46
+  Max: 15
 
 # Be a little more lenient with line length
 Metrics/LineLength:
@@ -33,10 +30,6 @@ Style/SingleLineMethods:
 Style/SignalException:
   EnforcedStyle: only_raise
 
-# Allow multiple Hash parameters to look similar
-Style/BracesAroundHashParameters:
-  EnforcedStyle: context_dependent
-
 # Place . on the previous line
 Style/DotPosition:
   EnforcedStyle: trailing
@@ -45,14 +38,6 @@ Style/DotPosition:
 Style/EmptyLineBetweenDefs:
   AllowAdjacentOneLineDefs: true
 
-# Enforce GaurdClause if there are 2 or more lines in the body
-Style/GuardClause:
-  MinBodyLength: 2
-
-# Allow s()
-Style/MethodCallParentheses:
-  Enabled: false
-
 # Allow multiline block chains
 Style/MultilineBlockChain:
   Enabled: false
@@ -60,7 +45,3 @@ Style/MultilineBlockChain:
 # Allow Perl-style references to regex matches
 Style/PerlBackrefs:
   Enabled: false
-
-# Only register TrivialAccessors offenses when the name matches
-Style/TrivialAccessors:
-  ExactNameMatch: true

data/.travis.yml

@@ -16,6 +16,7 @@ matrix:
   allow_failures:
     - rvm: jruby-head
     - rvm: ruby-head
+  fast_finish: true
 notifications:
   recipients:
     - timo.roessner@googlemail.com

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,9 @@
+== 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

data/CONTRIBUTING.md

@@ -46,13 +46,18 @@ bundle exec rake
 ```
 
 Once you’re sure your copy of reek works (and that there are no
-failing tests on master…) create your own branch and start hacking:
+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
 ```
 
-Add new tests which make sure that your new feature works or
+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).
 
@@ -100,7 +105,7 @@ If there were any fixes to your pull request we’ll ask you to
 all of the commits into one:
 
 ```
-git rebase -i master
+git rebase -i develop
 # squash squash squash
 git push -f origin
 ```

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,20 +26,20 @@ 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 * x}}
+    @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
@@ -68,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
@@ -91,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
 
@@ -103,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:
 
@@ -133,12 +162,14 @@ 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
@@ -146,7 +177,9 @@ DataClump:
 
 ### 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
@@ -155,7 +188,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
@@ -166,21 +199,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-matchers)
-* 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
@@ -189,27 +222,39 @@ 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
 
@@ -220,15 +265,22 @@ If you don't feel like getting your hands dirty with code there are still other
 * [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)
+
+### Miscellaneous
+
+* [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/config/defaults.reek

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

data/docs/API.md

@@ -0,0 +1,50 @@
+# API
+
+## Using `reek` inside your Ruby application
+
+`reek` can be used inside another Ruby project.
+
+```bash
+gem install reek
+```
+
+You can use reek inside your Ruby file `check_dirty.rb`
+
+```ruby
+require 'reek'
+require 'reek/source/source_code'
+require 'reek/cli/report/report'
+require 'reek/core/examiner'
+
+source =<<END
+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 * x } }
+    puts @screen.contents
+    fail
+  end
+end
+END
+
+source_code = Reek::Source::SourceCode.from(source)
+reporter = Reek::CLI::Report::TextReport.new
+reporter.add_examiner Reek::Core::Examiner.new(source_code)
+puts reporter.show
+```
+
+This will show the list of errors in variable `source`.
+
+`reek` can take `source` as `String`, `File` or `IO`.
+
+Also, besides normal text output, `reek` can also generate output in YAML,
+JSON, HTML and XML by using the following Report types:
+
+```
+TextReport
+YAMLReport
+JSONReport
+HTMLReport
+XMLReport
+```