reek 6.0.2 → 6.1.0

data/docs/Basic-Smell-Options.md

@@ -1,85 +0,0 @@
-# Basic Smell Options
-
-## Introduction
-
-Every smell detector in Reek offers at least the following configuration options:
-
-| Option         | Value       | Effect  |
-| ---------------|-------------|---------|
-| `enabled` |  Boolean | Determines whether the smell detector is active. Defaults to `true` |
-| `exclude` | an array of strings that will be converted into regular expressions | Ignores any context whose full description matches any element of this array. |
-
-The file `docs/defaults.reek.yml` (shipped with the Reek gem) lists any default
-exclusions for each smell.
-
-## Examples
-
-**An easy one:**
-
-To stop Reek reporting smells in any method called `write` you might create a configuration file containing this:
-
-```yaml
-DuplicateMethodCall:
-  exclude:
-  - write
-```
-
-Internally Reek will convert this to the Regexp /write/.
-
-**A more sophisticated one:**
-
-```yaml
-FeatureEnvy:
-  exclude:
-    - "MyModel#do_things"
-    - "MyHelper"
-    - "ApplicationController#respond"
-```
-
-This would not report FeatureEnvy for the instance method `MyModel#do_things`, the whole module `MyHelper` and the `respond` instance method of `ApplicationController`
-
-## Advanced configuration
-
-Sometimes just strings are not enough for configuration. E.g. consider this code sample:
-
-```Ruby
-class Klass
-  def foo1; end
-  def foo1bar; end
-end
-```
-Both "Klass#foo1" and "Klass#foo1bar" will smell of UncommunicativeMethodName. Now let's assume
-you are ok with "Klass#foo1" but not "Klass#foo1bar".
-Just having this configuration 
-
-```yaml
-UncommunicativeMethodName:
-  exclude:
-    - "Klass#foo1"
-```
-
-wouldn't work because now "Klass#foo1bar" wouldn't smell as well.
-
-For this reason Reek has a special syntax that allows you to use regexes by using a forward slash at the beginning and the end of the string.
-Everything within the forward slashes will be loaded as a regex.
-
-A possible configuration that hat excludes "Klass#foo1" from this scan but not "Klass#foo1bar" could look like this:
-
-```yaml
-UncommunicativeMethodName:
-  exclude:
-    - "/Klass#foo1$/"
-```
-
-## Reek 4
-
-In Reek 4 you could also pass regexes to `exclude`, meaning this was perfectly valid as well:
-
-```yaml
-DuplicateMethodCall:
-  exclude:
-    - !ruby/regexp /write/
-```
-
-Support for this has been scrapped with Reek 5 to make the Reek configuration more yaml standard compliant.
-You can still pass in regexes, you just have to wrap them into a string. Please see "Advanced configuration" above.

data/docs/Boolean-Parameter.md

@@ -1,54 +0,0 @@
-# Boolean Parameter
-
-## Introduction
-
-_Boolean Parameter_ is a case of [Control Couple](Control-Couple.md), where a
-method parameter is defaulted to true or false. A _Boolean Parameter_
-effectively permits a method's caller to decide which execution path to take.
-This is a case of bad cohesion. You're creating a dependency between methods
-that is not really necessary, thus increasing coupling.
-
-## Example
-
-Given
-
-```Ruby
-class Dummy
-  def hit_the_switch(switch = true)
-    if switch
-      puts 'Hitting the switch'
-      # do other things...
-    else
-      puts 'Not hitting the switch'
-      # do other things...
-    end
-  end
-end
-```
-
-Reek would emit the following warning:
-
-```
-test.rb -- 3 warnings:
-  [1]:Dummy#hit_the_switch has boolean parameter 'switch' (BooleanParameter)
-  [2]:Dummy#hit_the_switch is controlled by argument switch (ControlParameter)
-```
-
-Note that both smells are reported, _Boolean Parameter_ and _Control Parameter_.
-
-## Getting rid of the smell
-
-This is highly dependent on your exact architecture, but looking at the example above what you could do is:
-
-* Move everything in the `if` branch into a separate method
-* Move everything in the `else` branch into a separate method
-* Get rid of the `hit_the_switch` method alltogether
-* Make the decision what method to call in the initial caller of `hit_the_switch`
-
-## Current support in Reek
-
-Reek can only detect a _Boolean Parameter_ when it has a default initializer like in the example above.
-
-## Configuration
-
-_Boolean Parameter_ supports the [Basic Smell Options](Basic-Smell-Options.md).

data/docs/Class-Variable.md

@@ -1,40 +0,0 @@
-# Class Variable
-
-## Introduction
-
-Class variables form part of the global runtime state, and as such make it easy for one part of the system to accidentally or inadvertently depend on another part of the system. So the system becomes more prone to problems where changing something over here breaks something over there. In particular, class variables can make it hard to set up tests (because the context of the test includes all global state).
-
-For a detailed explanation, check out [this article](http://4thmouse.com/index.php/2011/03/20/why-class-variables-in-ruby-are-a-bad-idea/).
-
-## Example
-
-Given
-
-```Ruby
-class Dummy
-  @@class_variable = :whatever
-end
-```
-
-Reek would emit the following warning:
-
-```
-reek test.rb
-
-test.rb -- 1 warning:
-  [2]:Dummy declares the class variable @@class_variable (ClassVariable)
-```
-
-## Getting rid of the smell
-
-You can use class-instance variable to mitigate the problem (as also suggested in the linked article above):
-
-```Ruby
-class Dummy
-  @class_variable = :whatever
-end
-```
-
-##  Configuration
-
-_Class Variable_ supports the [Basic Smell Options](Basic-Smell-Options.md).

data/docs/Code-Smells.md

@@ -1,39 +0,0 @@
-# Code Smells
-
-Smells are indicators of where your code might be hard to read, maintain or evolve, rather than things that are specifically _wrong_. Naturally this means that Reek is looking towards your code's future (and that can make its reports seem somewhat subjective, of course).
-
-Reek currently includes checks for the following smells:
-
-* [Attribute](Attribute.md)
-* [Class Variable](Class-Variable.md)
-* [Control Couple](Control-Couple.md), including
-  * [Boolean Parameter](Boolean-Parameter.md)
-  * [Control Parameter](Control-Parameter.md)
-* [Data Clump](Data-Clump.md)
-* [Duplicate Method Call](Duplicate-Method-Call.md)
-* [Instance Variable Assumption](Instance-Variable-Assumption.md)
-* [Irresponsible Module](Irresponsible-Module.md)
-* [Large Class](Large-Class.md), including
-  * [Too Many Constants](Too-Many-Constants.md)
-  * [Too Many Instance Variables](Too-Many-Instance-Variables.md)
-  * [Too Many Methods](Too-Many-Methods.md)
-* [Long Parameter List](Long-Parameter-List.md), and its special case [Long Yield List](Long-Yield-List.md)
-* Low Cohesion, including
-  * [Feature Envy](Feature-Envy.md)
-  * [Utility Function](Utility-Function.md)
-* [Module Initialize](Module-Initialize.md)
-* [Nested Iterators](Nested-Iterators.md)
-* [Missing Safe Method](Missing-Safe-Method.md), formerly known as Prima Donna Method
-* [Simulated Polymorphism](Simulated-Polymorphism.md), including
-  * [Manual Dispatch](Manual-Dispatch.md)
-  * [Nil Check](Nil-Check.md)
-  * [Repeated Conditional](Repeated-Conditional.md)
-* [Subclassed From Core Class](Subclassed-From-Core-Class.md)
-* [Too Many Statements](Too-Many-Statements.md)
-* [Uncommunicative Name](Uncommunicative-Name.md), including
-  * [Uncommunicative Method Name](Uncommunicative-Method-Name.md)
-  * [Uncommunicative Module Name](Uncommunicative-Module-Name.md)
-  * [Uncommunicative Parameter Name](Uncommunicative-Parameter-Name.md)
-  * [Uncommunicative Variable Name](Uncommunicative-Variable-Name.md)
-* [Unused Parameters](Unused-Parameters.md)
-* [Unused Private Method](Unused-Private-Method.md)

data/docs/Command-Line-Options.md

@@ -1,119 +0,0 @@
-# Command Line Options
-
-## Introduction
-
-Reek follows standard Unix convention for passing arguments.
-
-Check out
-
-```Bash
-reek -h
-```
-
-for details.
-
-## Telling Reek to use a specific configuration file
-
-In case your configuration file is not in the standard location (that would be your project directory or
-whatever directory you're running Reek from) you can specify a configuration file with the `-c` option
-like this:
-
-```Bash
-reek -c /somewhere/on/your/filesystem/reek_config.yml lib/
-```
-
-## Telling Reek Which Code to Check
-
-Probably the most standard use case would be to check all Ruby files in the lib directory:
-
-```Bash
-reek lib/*.rb
-```
-
-In general, if any command-line argument is a directory, Reek searches that directory and all sub-directories for Ruby source files. Thus
-
-```Bash
-reek lib
-```
-
-would be equivalent to
-
-```Bash
-reek lib/**/*.rb
-```
-
-Occasionally you may want to quickly check a code snippet without going to the trouble of creating a file to hold it. You can pass the snippet directly to Reek's standard input:
-
-```Bash
-echo "def x() true end" | reek
-```
-
-To just check all Ruby files in the current directory, you can simply run it
-with no parameters:
-
-```Bash
-reek
-```
-
-## Telling Reek Which Smells to Detect
-
-You can tell Reek to only check particular smells by using the `--smell`
-option and passing in the smell name.
-
-For example, to only check for [Utility Function](Utility-Function.md), you
-would use:
-
-```Bash
-reek --smell UtilityFunction
-```
-
-You can select several smells by repeating the `--smell` option like so:
-
-```Bash
-reek --smell UtilityFunction --smell UncommunicativeMethodName
-```
-
-## Output options
-
-### Output smell's line number
-
-By passing in a "-n" flag to the _reek_ command, the output will suppress the line numbers:
-
-```Bash
-$ reek -n mess.rb
-```
-
-```
-mess.rb -- 2 warnings:
-  x doesn't depend on instance state (UtilityFunction)
-  x has the name 'x' (UncommunicativeMethodName)
-```
-
-Otherwise line numbers will be shown as default at the beginning of each warning in square brackets:
-
-```Bash
-$ reek mess.rb
-```
-
-```
-mess.rb -- 2 warnings:
-  [2]:x doesn't depend on instance state (UtilityFunction)
-  [2]:x has the name 'x' (UncommunicativeMethodName)
-```
-
-### Enable the verbose mode
-
-_reek_ has a verbose mode which you might find helpful as a beginner. "verbose" just means that behind each warning a helpful link will be displayed which leads directly to the corresponding _reek_ documentation page.
-This mode can be enabled via the "-U" or "--documentation" flag.
-
-So for instance, if your test file would smell of _ClassVariable_, this is what the _reek_ output would look like:
-
-```Bash
-reek -U test.rb
-```
-```
-test.rb -- 1 warning:
-  [2]:Dummy declares the class variable @@class_variable (ClassVariable) [https://github.com/troessner/reek/blob/master/docs/Class-Variable.md]
-```
-
-Note the link at the end.

data/docs/Control-Couple.md

@@ -1,26 +0,0 @@
-# Control Couple
-
-## Introduction
-
-Control coupling occurs when a method or block checks the value of a parameter
-in order to decide which execution path to take. The offending parameter is
-often called a _Control Couple_.
-
-Control Coupling is a kind of duplication, because the calling method already knows which path should be taken.
-
-Control Coupling reduces the code's flexibility by creating a dependency
-between the caller and callee: any change to the possible values of the
-controlling parameter must be reflected on both sides of the call. A _Control
-Couple_ also reveals a loss of simplicity: the called method probably has more
-than one responsibility, because it includes at least two different code paths.
-
-You can find a good write-up regarding this problem [here](https://solnic.codes/2012/04/11/get-rid-of-that-code-smell-control-couple/).
-
-## Current Support in Reek
-
-Reek performs the following checks that fall in this category:
-
-* [Control-Parameter](Control-Parameter.md) - a method parameter or block
-  parameter is the tested value in a conditional statement
-* [Boolean-Parameter](Boolean-Parameter.md) - a method parameter is defaulted
-  to `true` or `false`.

data/docs/Control-Parameter.md

@@ -1,32 +0,0 @@
-# Control Parameter
-
-## Introduction
-
-_Control Parameter_ is a case of [Control Couple](Control-Couple.md).
-
-## Example
-
-A simple example would be the `quoted` parameter in the following method:
-
-```Ruby
-def write(quoted)
-  if quoted
-    write_quoted @value
-  else
-    write_unquoted @value
-  end
-end
-```
-
-Fixing those problems is out of the scope of this document but an easy solution
-could be to remove the `write` method altogether and to move the calls to
-`write_quoted` and `write_unquoted` to the caller of `write`.
-
-## Current Support in Reek
-
-Reek warns about _Control Parameter_ when a method parameter or block parameter is
-the tested value in a conditional statement.
-
-## Configuration
-
-_Control Parameter_ supports the [Basic Smell Options](Basic-Smell-Options.md).

data/docs/Data-Clump.md

@@ -1,46 +0,0 @@
-# Data Clump
-
-## Introduction
-
-In general, a _Data Clump_ occurs when the same two or three items frequently
-appear together in classes and parameter lists, or when a group of instance
-variable names start or end with similar substrings.
-
-The recurrence of the items often means there is duplicate code spread around to handle them. There may be an abstraction missing from the code, making the system harder to understand.
-
-## Example
-
-Given
-
-```Ruby
-class Dummy
-  def x(y1,y2); end
-  def y(y1,y2); end
-  def z(y1,y2); end
-end
-```
-
-Reek would emit the following warning:
-
-```
-test.rb -- 1 warning:
-  [2, 3, 4]:Dummy takes parameters [y1, y2] to 3 methods (DataClump)
-```
-
-A possible way to fix this problem (quoting from [Martin Fowler](http://martinfowler.com/bliki/DataClump.html)):
-
-> The first step is to replace data clumps with objects and use the objects whenever you see them. An immediate benefit is that you'll shrink some parameter lists. The interesting stuff happens as you begin to look for behavior to move into the new objects.
-
-## Current Support in Reek
-
-Reek looks for a group of two or more parameters with the same names that are expected by three or more methods of a class.
-
-## Configuration
-
-Reek's _Data Clump_ detector offers the [Basic Smell Options](Basic-Smell-Options.md), plus:
-
-| Option           | Value       | Effect  |
-| -----------------|-------------|---------|
-| `max_copies`     | integer | The maximum number of methods that are permitted to take the same group of parameters. Defaults to 2. |
-| `min_clump_size` | integer | The smallest number of parameters that can be reported as a clump. Defaults to 2. |
-

data/docs/Duplicate-Method-Call.md

@@ -1,264 +0,0 @@
-# Duplicate Method Call
-
-## Introduction
-
-Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.
-
-Let's look at an example that is quite common in the Rails world:
-
-```Ruby
-def not_production?
-  Rails.env.development? || Rails.env.test?
-end  
-```
-
-While this duplicate usage of `Rails.env` might seem innocuous there are 2 problems with it:
-
-1.) Efficiency
-
-```Ruby
-Rails.env.development? || Rails.env.test?
-```
-
-is not as efficient as it could be. If the call to `env` is not memoized your basically paying twice in terms of computation for something that you should only pay once.
-
-Here
-
-```Ruby
-Rails.env.development? || Rails.env.test?
-```
-
-you have 4 method calls while here:
-
-```Ruby
-env = Rails.env
-env.development? || env.test?
-```
-
-you have one assignment (which is very cheap in terms of computation) and 3 method calls.
-The difference might not be much here but just imagine you're writing a high performance app or you doing some expensive database calls in each method call.
-
-It doesn't really matter though if the efficiency difference is significant. This is a matter of principle - we believe that being efficient is one of the vital traits of good software.
-
-2.) Maintainability
-
-The second point is a bit more subtle. This
-
-```Ruby
-env = Rails.env
-env.development? || env.test?
-```
-
-is a lot more intention revealing than 
-
-```Ruby
-Rails.env.development? || Rails.env.test?
-```
-
-Here
-
-```Ruby
-env = Rails.env
-env.development? || env.test?
-```
-
-I'm very clear on what I do: I get the environment and then I run some checks on it.
-
-Here
-
-```Ruby
-Rails.env.development? || Rails.env.test?
-```
-
-I'm not very clear on what I do and it requires quite more mental effort: Ok, so I'm talking to Rails, getting the environment and then running a check on it ...or .....oh, I get the same Rails constant again, get the same environment and run another check on it.
-
-## Example
-
-Here's a very much simplified and contrived example. The following method will report a warning:
-
-```Ruby
-def double_thing
-  @other.thing + @other.thing
-end
-```
-
-One quick approach to silence Reek would be to refactor the code thus:
-
-```Ruby
-def double_thing
-  thing = @other.thing
-  thing + thing
-end
-```
-
-A slightly different approach would be to replace all calls in `double_thing` by calls to `thing`:
-
-```Ruby
-class Other
-  def double_thing
-    thing + thing
-  end
-
-  def thing
-    @other.thing
-  end
-end
-```
-
-The approach you take will depend on balancing other factors in your code.
-
-## Current support in Reek
-
-Reek's Duplicate Method Call detector checks for repeated identical method calls within
-any one method definition. This is intended to complement the checks performed by tools
-such as [Flay](http://ruby.sadi.st/Flay.html) and [Simian](http://www.redhillconsulting.com.au/products/simian/).
-
-## Edge cases
-
-Be aware that there are some edge cases like this code:
-
-```Ruby
-class Foo
-  def bar(switch)
-    case switch
-    when :a
-      ->(arg) { arg.call_me(:maybe); do_something }
-    when :b
-      ->(arg) { arg.call_me(:maybe); do_something_else }
-    when :c
-      ->(arg) { arg.call_me(:maybe); do_something_different }
-    end
-  end
-end
-```
-
-Reek cannot reliably detect that each call's receiver is a different arg and will report:
-
-```
-[5, 7, 9]:DuplicateMethodCall: Foo#bar calls 'arg.call_me(:maybe)' 3 times
-```
-  
-If you're running into this problem you can disable this smell detector for this method either via
-configuration:
-
-```Yaml
----
-DuplicateMethodCall:
-  exclude:
-    - 'Foo#bar'
-```
-
-or via source code comment:
-
-```Ruby
-class Foo
-  # :reek:DuplicateMethodCall
-  def bar(switch)
-    # ....
-  end
-end
-```
-
-## Configuration
-
-Reek's Duplicate Method Call detector currently offers the [Basic Smell Options](Basic-Smell-Options.md), plus:
-
-Option | Value | Effect
--------|-------|-------
-`max_calls` |  integer | The maximum number of duplicate calls allowed within a method. Defaults to 1.
-`allow_calls` | an array of strings or regular expressions | Ignores any context who matches it |
-
-## Example configuration
-
-### Adjusting `max_calls`
-
-Imagine code like this:
-
-```Ruby
-class Alfa
-  def bravo
-    charlie.delta
-    charlie.delta
-  end
-end
-```
-
-This would report:
-
->>
-src.rb -- 1 warning:
-  [4, 5]:DuplicateMethodCall: Alfa#bravo calls 'charlie.delta' 2 times
-
-If you want to allow those double calls here you can disable it in 2 different ways:
-
-1.) Via source code comment:
-
-```Ruby
-class Alfa
-  # :reek:DuplicateMethodCall { max_calls: 2 }
-  def bravo
-    charlie.delta
-    charlie.delta
-  end
-end
-```
-
-2.) Via configuration file:
-
-```Yaml
-DuplicateMethodCall:
-  max_calls: 2
-```
-
-Note though that the latter way will set `max_calls` to 2 for all instances
-of the smell detector which might not be what you want - in this case
-you'll have to use source code comments.
-
-### Adjusting `allow_calls`
-
-Imagine code like this:
-
-```Ruby
-class Alfa
-  def bravo
-    charlie.delta
-    charlie.delta
-    echo.foxtrot
-    echo.foxtrot
-  end
-end
-```
-
-This would report:
-
->>
-src.rb -- 2 warnings:
-  [4, 5]:DuplicateMethodCall: Alfa#bravo calls charlie.delta 2 times
-  [6, 7]:DuplicateMethodCall: Alfa#bravo calls echo.foxtrot 2 times
-
-So let's say you're ok with the `echo.foxtrot` calls you can stop reporting them like this:
-
-1.) Via source code comment:
-
-```Ruby
-class Alfa
-  # :reek:DuplicateMethodCall { allow_calls: ['echo.foxtrot'] }
-  def bravo
-    charlie.delta
-    charlie.delta
-    echo.foxtrot
-    echo.foxtrot
-  end
-end
-```
-
-2.) Via configuration file:
-
-```Yaml
-DuplicateMethodCall:
-  allow_calls:
-  - 'echo.foxtrot'
-```
-
-Note though that the latter way will allow those calls across your source code which might not be what you want.
-In this case you'll have to use source code comments.