reek 3.5.0 → 3.6.0

data/docs/Attribute.md

@@ -18,7 +18,7 @@ class Klass
 end
 ```
 
-`reek` would emit the following warning:
+Reek would emit the following warning:
 
 ```
 reek test.rb

data/docs/Basic-Smell-Options.md

@@ -9,7 +9,8 @@ Every smell detector in Reek offers at least the following configuration options
 | `enabled` |  Boolean | Determines whether the smell detector is active. Defaults to `true` |
 | `exclude` | an array of strings or regular expressions | Ignores any context whose full description (see <strong>%c</strong> in [Command-Line Options](Command-Line-Options.md)) matches any element of this array. |
 
-The file `config/defaults.reek` (shipped with the Reek gem) lists any default exclusions for each smell.
+The file `defaults.reek` (shipped with the Reek gem) lists any default
+exclusions for each smell.
 
 ## Examples
 

data/docs/Boolean-Parameter.md

@@ -24,7 +24,7 @@ class Dummy
 end
 ```
 
-`reek` would emit the following warning:
+Reek would emit the following warning:
 
 ```
 test.rb -- 3 warnings:

data/docs/Class-Variable.md

@@ -16,10 +16,10 @@ class Dummy
 end
 ```
 
-`reek` would emit the following warning:
+Reek would emit the following warning:
 
 ```
-reek test.rb 
+reek test.rb
 
 test.rb -- 1 warning:
   [2]:Dummy declares the class variable @@class_variable (ClassVariable)

data/docs/Command-Line-Options.md

@@ -2,7 +2,7 @@
 
 ## Introduction
 
-reek follows standard Unix convention for passing arguments.
+`reek` follows standard Unix convention for passing arguments.
 
 Check out
 
@@ -74,7 +74,7 @@ This mode can be enabled via the "-U" or "--ultra-verbose" 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 
+reek -U test.rb
 ```
 ```
 test.rb -- 1 warning:

data/docs/Control-Couple.md

@@ -10,13 +10,13 @@ Control Coupling reduces the code's flexibility by creating a dependency between
 
 You can find a good write-up regarding this problem [here](http://solnic.eu/2012/04/11/get-rid-of-that-code-smell-control-couple.html).
 
-## Current Support in reek
+## Current Support in Reek
 
-`reek` warns about control coupling when:
+Reek warns about control coupling when:
 
 * [Control-Parameter](Control-Parameter.md) - a method parameter or block parameter is the tested value in a conditional statement (as in the example below); or
 * [Boolean-Parameter](Boolean-Parameter.md) - a method parameter is defaulted to `true` or `false`.
 
 ## Configuration
 
-Control Couple supports the [Basic Smell Options](Basic-Smell-Options.md).
+Control Couple supports the [Basic Smell Options](Basic-Smell-Options.md).

data/docs/Control-Parameter.md

@@ -20,9 +20,9 @@ end
 
 Fixing those problems is out of the scope of this document but an easy solution could be to remove the "write" method alltogether and to move the calls to "write_quoted" / "write_unquoted" in the initial caller of "write".
 
-## Current Support in reek
+## Current Support in Reek
 
-`reek` warns about control coupling when a method parameter or block parameter is the tested value in a conditional statement.
+Reek warns about control coupling when a method parameter or block parameter is the tested value in a conditional statement.
 
 ## Configuration
 

data/docs/Data-Clump.md

@@ -18,7 +18,7 @@ class Dummy
 end
 ```
 
-`reek` would emit the following warning:
+Reek would emit the following warning:
 
 ```
 test.rb -- 1 warning:
@@ -31,7 +31,7 @@ A possible way to fix this problem (quoting from [Martin Fowler](http://martinfo
 
 ## 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.
+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
 

data/docs/Duplicate-Method-Call.md

@@ -3,7 +3,7 @@
 ## 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.
-`reek` implements a check for _Duplicate Method Call_.
+Reek implements a check for _Duplicate Method Call_.
 
 ## Example
 
@@ -36,9 +36,9 @@ end
 
 The approach you take will depend on balancing other factors in your code.
 
-## Current support in reek
+## 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/).
+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/).
 
 ## Configuration
 
@@ -46,4 +46,4 @@ Reek's Duplication detector currently offers the [Basic Smell Options](Basic-Sme
 
 Option | Value | Effect
 -------|-------|-------
-`max_calls` |  integer | The maximum number of duplicate calls allowed within a method. Defaults to 1.
+`max_calls` |  integer | The maximum number of duplicate calls allowed within a method. Defaults to 1.

data/docs/Feature-Envy.md

@@ -12,7 +12,7 @@ _Feature Envy_ often arises because it must manipulate other objects (usually it
 
 ## Example
 
-Running reek on:
+Running Reek on:
 
 ```Ruby
 class Warehouse
@@ -36,7 +36,7 @@ since this:
 
 belongs to the Item class, not the Warehouse.
 
-## Current Support in reek
+## Current Support in Reek
 
 _Feature Envy_ reports any method that refers to self less often than it refers to (ie. send messages to) some other object.
 

data/docs/How-reek-works-internally.md

@@ -1,4 +1,4 @@
-# How reek works internally
+# How Reek works internally
 
 
 ## The big picture
@@ -58,7 +58,7 @@
 
 ## A closer look at how an Examiner works
 
-The core foundation of reek and its API is the Examiner.
+The core foundation of Reek and its API is the Examiner.
 As you can see above, the Examiner is run for every source it gets passed and then runs the configured SmellDetectors.
 The overall workflow is like this:
 

data/docs/Irresponsible-Module.md

@@ -14,7 +14,7 @@ class Dummy
 end
 ```
 
-`reek` would emit the following warning:
+Reek would emit the following warning:
 
 ```
 test.rb -- 1 warning:
@@ -30,7 +30,7 @@ class Dummy
 end
 ```
 
-## Current Support in reek
+## Current Support in Reek
 
 `Irresponsible Module` currently checks classes, but not modules.
 

data/docs/Large-Class.md

@@ -10,11 +10,11 @@ A `Large Class` is a class or module that has a large number of instance variabl
 
 ##  Configuration
 
-`reek`'s Large Class detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus:
+Reek's Large Class detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus:
 
 | Option         | Value       | Effect  |
 | ---------------|-------------|---------|
 | max_methods |  integer | The maximum number of methods allowed in a class before a warning is issued. Defaults to 25. |
 | max_instance_variables |  integer | The maximum number of instance variables allowed in a class before a warning is issued. Defaults to 9. |
 
-The `Large Class` detector is enabled whenever `reek` is asked to check an instance of `Class` or `Module`.
+The `Large Class` detector is enabled whenever Reek is asked to check an instance of `Class` or `Module`.

data/docs/Long-Parameter-List.md

@@ -16,7 +16,7 @@ class Dummy
 end
 ```
 
-`reek` would report the following warning:
+Reek would report the following warning:
 
 ```
 test.rb -- 1 warning:

data/docs/Long-Yield-List.md

@@ -14,7 +14,7 @@ class Dummy
 end
 ```
 
-`reek` would report the following warning:
+Reek would report the following warning:
 
 ```
 test.rb -- 1 warning:
@@ -33,4 +33,4 @@ Reek's Long Parameter List detector supports the [Basic Smell Options](Basic-Sme
 
 | Option         | Value       | Effect  |
 | ---------------|-------------|---------|
-| max_params |  integer | The maximum number of parameters allowed in a method or block before a warning is issued. Defaults to 3. |
+| max_params |  integer | The maximum number of parameters allowed in a method or block before a warning is issued. Defaults to 3. |

data/docs/Module-Initialize.md

@@ -53,10 +53,10 @@ class B < A
 end
 ```
 
-## Current Support in reek
+## Current Support in Reek
 
-`reek` warns about module initialize when an instance method named `initialize` is present in a module.
+Reek warns about module initialize when an instance method named `initialize` is present in a module.
 
 ## Configuration
 
-Module Initialize supports the [Basic Smell Options](Basic-Smell-Options.md).
+Module Initialize supports the [Basic Smell Options](Basic-Smell-Options.md).

data/docs/Nested-Iterators.md

@@ -22,7 +22,7 @@ class Duck
 end
 ```
 
-`reek` would report the following warning:
+Reek would report the following warning:
 
 ```
 test.rb -- 1 warning:

data/docs/Nil-Check.md

@@ -19,7 +19,7 @@ class Klass
 end
 ```
 
-`reek` would emit the following warning:
+Reek would emit the following warning:
 
 ```
 test.rb -- 1 warning:
@@ -36,4 +36,4 @@ test.rb -- 1 warning:
 
 ## Configuration
 
-`Nil Check` offers the [Basic Smell Options](Basic-Smell-Options.md).
+`Nil Check` offers the [Basic Smell Options](Basic-Smell-Options.md).

data/docs/Prima-Donna-Method.md

@@ -24,9 +24,9 @@ class C
 end
 ```
 
-`reek` would report `bar!` as `prima donna method` smell but not `foo!`.
+Reek would report `bar!` as `prima donna method` smell but not `foo!`.
 
-`reek` reports this smell only in a class context, not in a module context in order to allow perfectly legit code like this:
+Reek reports this smell only in a class context, not in a module context in order to allow perfectly legit code like this:
 
 
 ```Ruby
@@ -46,8 +46,8 @@ class Daughter < Parent
 end
 ```
 
-In this example, `reek` would not report the `prima donna method` smell for the method `foo` of the `Dangerous` module.
+In this example, Reek would not report the `prima donna method` smell for the method `foo` of the `Dangerous` module.
 
 ## Configuration
 
-`Prima Donna Method` offers the [Basic Smell Options](Basic-Smell-Options.md).
+`Prima Donna Method` offers the [Basic Smell Options](Basic-Smell-Options.md).

data/docs/RSpec-matchers.md

@@ -2,7 +2,7 @@
 
 ## Introduction
 
-`reek` offers matchers for RSpec you can easily include into your project.
+Reek offers matchers for RSpec you can easily include into your project.
 
 There are 3 matchers available:
 
@@ -27,7 +27,7 @@ require 'reek/spec'
 require 'rspec'
 
 RSpec.describe 'Reek Integration' do
-  it 'works with reek' do
+  it 'works with Reek' do
     smelly_class = 'class C; def m; end; end'
     expect(smelly_class).not_to reek
   end
@@ -45,7 +45,7 @@ would give you:
 ```
 Failures:
 
-  1) Reek Integration works with reek
+  1) Reek Integration works with Reek
      Failure/Error: expect(smelly_class).not_to reek
        Expected no smells, but got:
          C has no descriptive comment (IrresponsibleModule)
@@ -58,7 +58,7 @@ Finished in 0.00284 seconds (files took 0.28815 seconds to load)
 
 Failed examples:
 
-rspec ./reek-integration-spec.rb:6 # Reek Integration works with reek
+rspec ./reek-integration-spec.rb:6 # Reek Integration works with Reek
 ```
 
 ## The matchers explained
@@ -76,7 +76,7 @@ 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".
+in Reek but it could also be "Duplication" which is a "smell categgory".
 
 In theory you could pass many different types of input here:
 - `:UtilityFunction`
@@ -95,7 +95,7 @@ check for as well e.g. "name" or "count" (see the examples below). The
 parameters you can check for are depending on the smell you are checking for.
 For instance "count" doesn't make sense everywhere whereas "name" does in most
 cases. If you pass in a parameter that doesn't exist (e.g. you make a typo like
-"namme") reek will raise an ArgumentError to give you a hint that you passed
+"namme") Reek will raise an ArgumentError to give you a hint that you passed
 something that doesn't make much sense.
 
 So in a nutshell `reek_of` takes the following two arguments:
@@ -129,7 +129,7 @@ With smell_details:
 
 See the documentaton for `reek_of`.
 
-**Notable differences to reek_of:**
+**Notable differences to `reek_of`:**
 
 1. `reek_of` doesn't mind if there are other smells of a different category.
    "reek_only_of" will fail in that case.

data/docs/Rake-Task.md

@@ -2,7 +2,7 @@
 
 ## Introduction
 
-`reek`  provides a Rake task that runs `reek` on a set of source files. In its most simple form you just include something like that in your Rakefile:
+Reek provides a Rake task that runs Reek on a set of source files. In its most simple form you just include something like that in your Rakefile:
 
 ```Ruby
 require 'reek/rake/task'
@@ -55,4 +55,4 @@ An example rake call using environment variables could look like this:
 REEK_CFG="config/custom.reek" REEK_OPTS="-s" rake reek
 ```
 
-See also: [Reek-Driven-Development](Reek-Driven-Development.md)
+See also: [Reek-Driven-Development](Reek-Driven-Development.md)

data/docs/Reek-Driven-Development.md

@@ -2,7 +2,7 @@
 
 ## rake
 
-One way to drive quality into your code from the very beginning of a project is to run `reek` as a part of your testing process. For example, you could do that by adding a [Rake Task](Rake-Task.md) to your rakefile, which will make it easy to run `reek` on all your source files whenever you need to.
+One way to drive quality into your code from the very beginning of a project is to run Reek as a part of your testing process. For example, you could do that by adding a [Rake Task](Rake-Task.md) to your rakefile, which will make it easy to run Reek on all your source files whenever you need to.
 
 ```Ruby
 require 'reek/rake/task'
@@ -14,11 +14,11 @@ Reek::Rake::Task.new do |t|
 end
 ```
 
-Now the command `reek` will run `reek` on your source code (and in this case, it fails if it finds any smells). For more detailed information about `reek`'s integration with Rake, see [Rake Task](Rake-Task.md) in this wiki.
+Now the command `reek` will run Reek on your source code (and in this case, it fails if it finds any smells). For more detailed information about Reek's integration with Rake, see [Rake Task](Rake-Task.md) in this wiki.
 
 ## reek/spec
 
-But there's another way; a much more effective "Reek-driven" approach: add `reek` expectations directly into your Rspec specs. Here's an example taken directly from `reek`'s own source code:
+But there's another way; a much more effective "Reek-driven" approach: add Reek expectations directly into your Rspec specs. Here's an example taken directly from Reek's own source code:
 
 ```Ruby
 it 'contains no code smells' do
@@ -26,7 +26,7 @@ it 'contains no code smells' do
 end
 ```
 
-By requiring "reek/spec":http://reek.rubyforge.org/rdoc/classes/Reek/Spec.html you gain access to the `reek` matcher, which returns true if and only if `reek` finds smells in your code. And if the test fails, the matcher produces an error message that includes details of all the smells it found.
+By requiring "reek/spec":http://reek.rubyforge.org/rdoc/classes/Reek/Spec.html you gain access to the `reek` matcher, which returns true if and only if Reek finds smells in your code. And if the test fails, the matcher produces an error message that includes details of all the smells it found.
 
 ## assert
 

data/docs/Repeated-Conditional.md

@@ -26,7 +26,7 @@ class RepeatedConditionals
 end
 ```
 
-`reek` would emit the following warning:
+Reek would emit the following warning:
 
 ```
 test.rb -- 4 warnings:
@@ -37,7 +37,7 @@ If you get this warning then you are probably not using the right abstraction or
 
 ## Configuration
 
-`reek`'s `Repeated Conditional` detector offers the [Basic Smell Options](Basic-Smell-Options.md), plus:
+Reek's `Repeated Conditional` detector offers the [Basic Smell Options](Basic-Smell-Options.md), plus:
 
 | Option         | Value       | Effect  |
 | ---------------|-------------|---------|

data/docs/Simulated-Polymorphism.md

@@ -11,6 +11,6 @@ Simulated Polymorphism occurs when
 
 Conditional code is hard to read and understand, because the reader must hold more state in his head. When the same value is tested in multiple places throughout an application, any change to the set of possible values will require many methods and classes to change. Tests for the type of an object may indicate that the abstraction represented by that type is not completely defined (or understood).
 
-## Current Support in reek
+## Current Support in Reek
 
-`reek` checks for [Repeated Conditional](Repeated-Conditional.md)  and for [Nil Check](Nil-Check.md).
+Reek checks for [Repeated Conditional](Repeated-Conditional.md)  and for [Nil Check](Nil-Check.md).

data/docs/Smell-Suppression.md

@@ -1,12 +1,12 @@
 ## Introduction
 
-In some cases, it might be necessary to suppress one or more of `reek`'s smell
+In some cases, it might be necessary to suppress one or more of Reek's smell
 warnings for a particular method or class.
 
 Possible reasons for this could be:
 
 * The code is outside of your control and you can't fix it
-* `reek` is not the police. You might have legit reasons why your source code
+* Reek is not the police. You might have legit reasons why your source code
   is good as it is.
 
 ## How to disable smell detection
@@ -93,4 +93,4 @@ end
 ```
 
 To see what smell detector takes what special configuration just check out the
-dedicated documentation for this smell detector.
+dedicated documentation for this smell detector.