reek 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 777f1ba21321886d04fe6cb9be80e175250f8490
-  data.tar.gz: 574babd716780ea8013ceb2b485dda1e3eaa521d
+  metadata.gz: 4dcff37dc4ddba77bf578314779a49fab1fcd0e7
+  data.tar.gz: d3a82f168438222a7a5bbab73a491b877cbd8144
 SHA512:
-  metadata.gz: 4d5a1ea491b81408ae7c6ee5dc8699b21e7df7ecdfa888d3826556acb677dabf6a2a145677c89e783f5aaaf58b914ab3138ce444e393a19e476e3c6940ff6bbe
-  data.tar.gz: cd1ab7b709b02c9d2756fc716aee8418295bebf48757fdaff1dab3fca689bb84a8d5b359fc6026e4f3d8450d80128b36e00ba12138f904596a9752ad200f69e4
+  metadata.gz: ccc8992f22bda5b7be9d68ee269fb454db74f179dd2ebe05c42d78b4b0c779af0202e511f43c337507187e411c03be58ab740a8383b79844c04f64d11c4e7ffc
+  data.tar.gz: b11c75c4d4ebf103cb97355b3688049ba275165783fba752b5c9cefe5c94cbeaa6f2a38dd0b1c5f6ab2faf0368c4e7548da42b56685acbf1f7f71a7cf9b8cf1d

data/.rubocop.yml

@@ -53,3 +53,9 @@ Style/MultilineBlockChain:
 # Allow Perl-style references to regex matches
 Style/PerlBackrefs:
   Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - 'lib/reek/ast/sexp_extensions/send.rb'
+    - 'lib/reek/ast/sexp_extensions/super.rb'
+    - 'lib/reek/ast/sexp_extensions/variables.rb'

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+## 3.6 (2015-10-30)
+
+* (mvz) Make Attribute respect suppressing comments
+* (chastell) Adjust parser dependency to allow versions 2.2.3+ (and even 2.3+)
+* (tansaku + mvz) Allow matches in reek_of for message, lines, context and source.
+* (mvz) Deprecate AppConfiguration.from_map in favor of AppConfiguration.from_hash.
+
 ## 3.5.0 (2015-09-28)
 
 * (troessner) Ignore iterators without block arguments for NestedIterators
@@ -66,7 +73,7 @@
 
 ## 3.0.1 (2015-07-03)
 
-* (troessner) Fix reek descending into hidden directories
+* (troessner) Fix Reek descending into hidden directories
 
 ## 3.0.0 (2015-06-30)
 
@@ -88,7 +95,7 @@
 
 ## 2.1.0 (2015-04-17)
 
-* (mvz) Ensure require 'reek' is enough to use reek's classes
+* (mvz) Ensure require 'reek' is enough to use Reek's classes
 * (mvz) Pick config file that comes first alphabetically
 * (mvz) Separate FeatureEnvy and UtilityFunction
 
@@ -137,17 +144,17 @@
 ## 1.6.0 (2014-12-27)
 
 * (troessner) Revise configuration handling:
-  Now there are 3 ways of passing reek a configuration file:
+  Now there are 3 ways of passing Reek a configuration file:
   - Using the cli "-c" switch
   - Having a file ending with .reek either in your current working directory or in a parent directory (more on that later)
   - 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
+  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. As soon as reek detects a
-  configuration file it stops searching immediately, meaning that from reek's
+  directory. And 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.
 * (chastell) Add keyword arguments support after switching to 'parser'
@@ -177,7 +184,7 @@
 
 ## 1.3.7 (2014-03-25)
 
-* (gilles-leblanc) Add color to reek's output
+* (gilles-leblanc) Add color to Reek's output
 * (mvz) Ignore unused parameters if method calls super in nested context
 * (mvz) Only mark parameters uncommunicative if used
 
@@ -227,7 +234,7 @@
 
 ## 1.2.12 (2012-06-09)
 
-* (mvz) Use ripper_ruby_parser on Ruby 1.9.3 and up (thus making reek able
+* (mvz) Use ripper_ruby_parser on Ruby 1.9.3 and up (thus making Reek able
         to parse the new 1.9 hash syntax).
 
 ## 1.2.11 (2012-06-08)
@@ -446,10 +453,10 @@ See http://wiki.github.com/kevinrutherford/reek for details
 
 ### Minor enhancements
 * New smell: first naive checks for Control Couple
-* reek now only checks sources passed on the command line
+* Reek now only checks sources passed on the command line
 * Code snippets can be supplied on the commandline
 * Added headings and warnings count when smells in multiple files
-* Added Reek::RakeTask to run reek from rakefiles
+* Added Reek::RakeTask to run Reek from rakefiles
 
 ### Fixes
 * Fixed: Returns exit status 2 when smells are reported
@@ -475,7 +482,7 @@ See http://wiki.github.com/kevinrutherford/reek for details
 
 * Tweaks:
   * Now works from the source code, instead of requiring each named file
-  * Added integration tests that run reek on a couple of gems
+  * Added integration tests that run Reek on a couple of gems
 
 ## 0.2.0 2008-09-10
 

data/CONTRIBUTING.md

@@ -1,6 +1,6 @@
-# Contributing to reek
+# Contributing to Reek
 
-We welcome any and all contributions 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
@@ -22,8 +22,8 @@ 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
+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.
@@ -33,7 +33,7 @@ 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
+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:
 
@@ -45,7 +45,7 @@ bundle
 bundle exec rake
 ```
 
-Once you’re sure your copy of reek works create your own feature branch from our "master" branch:
+Once you’re sure your copy of Reek works create your own feature branch from our "master" branch:
 
 ```
 git checkout -b your_feature_or_fix_name
@@ -84,7 +84,7 @@ 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.
+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.

data/README.md

@@ -1,16 +1,18 @@
-# `reek`: code smell detection for Ruby
+![reek logo](logo/reek.text.png)
+
+# Code smell detector for Ruby
 
 ## Overview
 
 
-[![Build Status](https://secure.travis-ci.org/troessner/reek.png?branch=master)](https://travis-ci.org/troessner/reek?branch=master)
+[![Build Status](https://secure.travis-ci.org/troessner/reek.svg?branch=master)](https://travis-ci.org/troessner/reek?branch=master)
 [![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
+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:
 
@@ -39,7 +41,7 @@ class Dirty
 end
 ```
 
-`reek` will report the following code smells in this file:
+Reek will report the following code smells in this file:
 
 ```
 $ reek demo.rb
@@ -54,6 +56,65 @@ demo.rb -- 8 warnings:
   [3]:Dirty#awful has unused parameter 'y' (UnusedParameters)
 ```
 
+## Fixing Smell Warnings
+
+Reek focuses on high-level code smells, so we can't tell you how to fix warnings in
+a generic fashion; this is and will always be completely dependent on your domain
+language and bussiness logic.
+
+That said, an example might help you get going. Have a look at this sample of a
+Ruby on Rails model (be aware that this is truncated, not working code):
+
+```Ruby
+class ShoppingCart < ActiveRecord::Base
+  has_many :items
+
+  def gross_price
+    items.sum { |item| item.net + item.tax }
+  end
+end
+
+class Item < ActiveRecord::Base
+  belongs_to :shopping_cart
+end
+```
+
+Running `reek` on this file like this:
+
+```
+reek app/models/shopping_cart.rb
+```
+
+would report:
+
+```
+  [5, 5]:ShoppingCart#gross_price refers to item more than self (FeatureEnvy)
+```
+
+Fixing this is pretty straightforward. Put the gross price calculation for a single item
+where it belongs, which would be the `Item` class:
+
+```Ruby
+class ShoppingCart < ActiveRecord::Base
+  has_many :items
+
+  def gross_price
+    items.sum { |item| item.gross_price }
+  end
+end
+
+class Item < ActiveRecord::Base
+  belongs_to :shopping_cart
+
+  def gross_price
+    net + tax
+  end
+end
+```
+
+The [Code Smells](docs/Code-Smells.md) docs may give you further hints - be sure to check out
+those first when you have a warning that you don't know how to deal with.
+
 ## Sources
 
 There are multiple ways you can have `reek` work on sources, the most common one just being
@@ -93,7 +154,7 @@ $stdin -- 3 warnings:
 
 ## Code smells
 
-`reek` currently includes checks for some aspects of
+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),
@@ -104,7 +165,7 @@ $stdin -- 3 warnings:
 [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.
+for up to date details of exactly what Reek will check in your code.
 
 ## Configuration
 
@@ -122,7 +183,7 @@ 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.
+Configuring Reek via a configuration file is by far the most powerful way.
 
 There are three ways of passing `reek` a configuration file:
 
@@ -130,21 +191,21 @@ There are three ways of passing `reek` a configuration file:
 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
+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
+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
 
-We put a lot of effort into making `reek`'s configuration as self explanatory as possible so the
+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):
 
@@ -157,8 +218,8 @@ example (e.g. `config.reek` in your project directory):
 IrresponsibleModule:
   enabled: false
 
-# You can use filters to silence reek warnings.
-# Either because you simply disagree with reek (we are not the police) or
+# 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:
@@ -167,7 +228,7 @@ NestedIterators:
 
 # 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 we set in config/defaults.reek.
+# with the defaults as documented in defaults.reek.
 DataClump:
   max_copies: 3
   min_clump_size: 3
@@ -192,7 +253,7 @@ exclude_paths:
   - lib/rake/legacy_tasks
 ```
 
-Note you do not need a configuration file at all. If you're fine with all the [defaults](config/defaults.reek) we set you can skip this completely.
+Note 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.
 
 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
@@ -200,7 +261,7 @@ types offer a configuration that goes beyond that of the basic smell options, fo
 [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 `config/default.reek` file in this repository](config/defaults.reek).
+configurations you can also check out [the `default.reek` file in this repository](defaults.reek).
 
 ### Source code comments
 
@@ -234,13 +295,13 @@ 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](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)
+* 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:
 
@@ -264,7 +325,7 @@ bundle exec rake
 ```
 
 From then on you should check out:
-* [How reek works internally](docs/How-reek-works-internally.md)
+* [How Reek works internally](docs/How-reek-works-internally.md)
 * [the contributing guide](CONTRIBUTING.md)
 
 
@@ -285,7 +346,7 @@ If you don't feel like getting your hands dirty with code there are still other
 
 ## Working with Rails
 
-Making `reek` "Rails"-friendly is fairly simple since we support directory specific configurations (`directory directives` in `reek` talk).
+Making Reek "Rails"-friendly is fairly simple since we support directory specific configurations (`directory directives` in Reek talk).
 Just add this to your configuration file:
 
 ```Yaml
@@ -301,7 +362,7 @@ Just add this to your configuration file:
     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.
+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.
 
 ## Integrations
 
@@ -314,9 +375,9 @@ Be careful though, `reek` does not merge your configuration entries, so if you a
 ### Projects that use or support us
 
 * [overcommit](https://github.com/brigade/overcommit) - a Git commit hook manager with support for
-  `reek`
+  Reek
 * [ruby-critic](https://github.com/whitesmith/rubycritic) - gem that wraps around static analysis gems such as `reek`, [flay](https://github.com/seattlerb/flay) and [flog](https://github.com/seattlerb/flog)
-* [pronto-reek](https://github.com/mmozuras/pronto-reek) - `reek` integration for [pronto](https://github.com/mmozuras/pronto)
+* [pronto-reek](https://github.com/mmozuras/pronto-reek) - Reek integration for [pronto](https://github.com/mmozuras/pronto)
 
 ### Misc
 
@@ -337,13 +398,15 @@ report
 
 ## Contributors
 
-The `reek` core team consists of:
+The Reek core team consists of:
 
 * [Matijs van Zuijlen](https://github.com/mvz)
 * [Piotr Szotkowski](https://github.com/chastell)
 * [Timo Rößner](https://github.com/troessner)
 
-The original author of `reek` is [Kevin Rutherford](https://github.com/kevinrutherford).
+The original author of Reek is [Kevin Rutherford](https://github.com/kevinrutherford).
+
+The author of Reek’s logo is [Sonja Heinen](http://yippee.io).
 
 Notable contributions came from:
 

data/ataru_setup.rb

@@ -0,0 +1,13 @@
+require 'reek'
+require 'reek/smells'
+
+# Ataru setup module.
+module Setup
+  def setup
+    # Run before every snippet.
+  end
+
+  def teardown
+    # Run after every snippet.
+  end
+end

data/docs/API.md

@@ -1,4 +1,4 @@
-# Using `reek` inside your Ruby application
+# Using Reek inside your Ruby application
 
 ## Installation
 
@@ -52,7 +52,7 @@ Note that `Reek::Examiner.new` can take `source` as `String`, `Pathname`, `File`
 
 ## Choosing your output format
 
-Besides normal text output, `reek` can generate output in YAML,
+Besides normal text output, Reek can generate output in YAML,
 JSON, HTML and XML by using the following Report types:
 
 ```
@@ -73,44 +73,25 @@ IrresponsibleModule:
   enabled: false
 ```
 
+Reek will load this file automatically by default. If you want to load the
+configuration explicitely, you can use one of the methods below.
+
 You can now use either
 
 ```Ruby
 Reek::Configuration::AppConfiguration.from_path Pathname.new('config.reek')
 ```
 
-but you can also pass a hash via `Reek::Configuration::AppConfiguration.from_map`.
-
-This hash can have the following 3 keys:
-
-1.) directory_directives [Hash] for instance:
-
-```Ruby
-  { Pathname("spec/samples/three_clean_files/") =>
-    { Reek::Smells::UtilityFunction => { "enabled" => false } } }
-```
-
-2.) default_directive [Hash] for instance:
-
-```Ruby
-  { Reek::Smells::IrresponsibleModule => { "enabled" => false } }
-```
-
-3.) excluded_paths [Array] for instance:
+but you can also pass a hash with the contents of the `config.reek` YAML file
+to `Reek::Configuration::AppConfiguration.from_hash`.
 
-```Ruby
-  [ Pathname('spec/samples/two_smelly_files') ]
-```
-
-Given the example above you should load that as "default directive" which means that it will
-be the default configuration for smell types for which there is
-no "directory directive" (so a directory-specific configuration):
+Given the example above you would load that as follows:
 
 ```Ruby
 require 'reek'
 
-default_directive = { Reek::Smells::IrresponsibleModule => { 'enabled' => false } }
-configuration = Reek::Configuration::AppConfiguration.from_map default_directive: default_directive
+config_hash = { 'IrresponsibleModule' => { 'enabled' => false } }
+configuration = Reek::Configuration::AppConfiguration.from_hash config_hash
 
 source = <<-EOS
   class Dirty
@@ -126,8 +107,8 @@ reporter.add_examiner examiner; nil
 reporter.show
 ```
 
-This would now only report the `UncommunicativeParameterName` but not the `IrresponsibleModule`
-for the `Dirty` class:
+This would now only report `UncommunicativeParameterName` but not
+`IrresponsibleModule` for the `Dirty` class:
 
 ```
 string -- 2 warnings:
@@ -135,6 +116,26 @@ string -- 2 warnings:
   Dirty#call_me has the parameter name 'b' (UncommunicativeParameterName)
 ```
 
+Instead of the smell detector names you can also use the full detector class in
+your configuration hash, for example:
+
+```ruby
+config_hash = { Reek::Smells::IrresponsibleModule => { 'enabled' => false } }
+```
+
+Of course, directory specific configuration and excluded paths are supported as
+well:
+
+```
+config_hash = {
+  'IrresponsibleModule' => { 'enabled' => false }
+  'spec/samples/three_clean_files/' =>
+    { 'UtilityFunction' => { "enabled" => false } }
+  'exclude_paths' =>
+    [ 'spec/samples/two_smelly_files' ]
+}
+```
+
 ## Accessing the smell warnings directly
 
 You can also access the smells detected by an examiner directly: