reek 4.0.1 → 4.0.2

data/docs/Reek-Driven-Development.md

@@ -22,7 +22,9 @@ But there's another way; a much more effective "Reek-driven" approach: add Reek
 
 ```Ruby
 it 'contains no code smells' do
-  Dir['lib/**/*.rb'].should_not reek
+  Pathname.glob('lib/**/*.rb').each do |file|
+    expect(file).not_to reek
+  end
 end
 ```
 

data/docs/Repeated-Conditional.md

@@ -2,7 +2,10 @@
 
 ## Introduction
 
-`Repeated Conditional` is a special case of [Simulated Polymorphism](Simulated-Polymorphism.md). Basically it means you are checking the same value throughout a single class and take decisions based on this.
+_Repeated Conditional_ is a case of
+[Simulated Polymorphism](Simulated-Polymorphism.md). Basically it means you are
+checking the same value throughout a single class and take decisions based on
+this.
 
 ## Example
 
@@ -37,7 +40,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/Too-Many-Instance-Variables.md

@@ -1,6 +1,6 @@
 ## Introduction
 
-`Too Many Instance Variables` is a special case of `LargeClass`. 
+_Too Many Instance Variables_ is a case of [Large Class](Large-Class.md).
 
 ## Example
 
@@ -14,7 +14,7 @@ TooManyInstanceVariables:
 and this code:
 
 ```Ruby
-class TooManyInstanceVariables
+class Smelly
   def initialize
     @arg_1 = :dummy
     @arg_2 = :dummy
@@ -28,7 +28,7 @@ Reek would emit the following warning:
 
 ```
 test.rb -- 5 warnings:
-  [1]:TooManyInstanceVariables has at least 4 instance variables (TooManyInstanceVariables)
+  [1]:TooManyInstanceVariables: Smelly has at least 4 instance variables
 ```
 ## Current Support in Reek
 
@@ -36,8 +36,8 @@ Reek only counts the instance variables you use explicitly like in the example a
 
 ## Configuration
 
-Reek's `Too Many Instance Variables` detector offers the [Basic Smell Options](Basic-Smell-Options.md), plus:
+Reek's _Too Many Instance Variables_ detector offers the [Basic Smell Options](Basic-Smell-Options.md), plus:
 
-| Option         | Value       | Effect  |
-| ---------------|-------------|---------|
-| max_instance_variables     | integer | The maximum number of instance variables that are permitted. Defaults to 4 |
+| Option                   | Value   | Effect  |
+| -------------------------|---------|---------|
+| `max_instance_variables` | integer | The maximum number of instance variables that are permitted. Defaults to 4 |

data/docs/Too-Many-Methods.md

@@ -1,6 +1,6 @@
 ## Introduction
 
-`Too Many Methods` is a special case of `LargeClass`. 
+_Too Many Methods_ is a case of [Large Class](Large-Class.md).
 
 ## Example
 
@@ -14,7 +14,7 @@ TooManyMethods:
 and this code:
 
 ```Ruby
-class TooManyMethods
+class Smelly
   def one; end
   def two; end
   def three; end
@@ -26,14 +26,15 @@ Reek would emit the following warning:
 
 ```
 test.rb -- 1 warning:
-  [1]:TooManyMethods has at least 4 methods (TooManyMethods)
+  [1]:TooManyMethods: Smelly has at least 4 methods
 ```
 ## Current Support in Reek
 
-Reek counts all the methods it can find in a `class` - instance *and* class methods. So given `max_methods` from above is 4, this:
+Reek counts all the methods it can find in a class — instance *and* class
+methods. So given `max_methods` from above is 4, this:
 
 ```Ruby
-class TooManyMethods
+class Smelly
   class << self
     def one; end
     def two; end
@@ -48,8 +49,8 @@ would cause Reek to emit the same warning as in the example above.
 
 ## Configuration
 
-Reek's `Too Many Methods` detector offers the [Basic Smell Options](Basic-Smell-Options.md), plus:
+Reek's _Too Many Methods_ detector offers the [Basic Smell Options](Basic-Smell-Options.md), plus:
 
-| Option         | Value       | Effect  |
-| ---------------|-------------|---------|
-| max_methods     | integer | The maximum number of methods that are permitted. Defaults to 15 |
+| Option        | Value   | Effect  |
+| --------------|---------|---------|
+| `max_methods` | integer | The maximum number of methods that are permitted. Defaults to 15 |

data/docs/Too-Many-Statements.md

@@ -2,11 +2,15 @@
 
 ## Introduction
 
-A method with `Too Many Statements` is any method that has a large number of lines.
+A method with _Too Many Statements_ is any method that has a large number of lines.
 
 ## Current Support in Reek
 
-`Too Many Statements` warns about any method that has more than 5 statements. Reek's smell detector for `Too Many Statements` counts +1 for every simple statement in a method and +1 for every statement within a control structure (`if`, `else`, `case`, `when`, `for`, `while`, `until`, `begin`, `rescue`) but it doesn't count the control structure itself.
+_Too Many Statements_ warns about any method that has more than 5 statements.
+Reek's smell detector for _Too Many Statements_ counts +1 for every simple
+statement in a method and +1 for every statement within a control structure
+(`if`, `else`, `case`, `when`, `for`, `while`, `until`, `begin`, `rescue`) but
+it doesn't count the control structure itself.
 
 So the following method would score +6 in Reek's statement-counting algorithm:
 
@@ -30,13 +34,13 @@ end
 
 ## Configuration
 
-Reek's `Too Many Statements` detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus:
+Reek's _Too Many Statements_ detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus:
 
 | Option         | Value       | Effect  |
 | ---------------|-------------|---------|
 | `max_statements` |  integer | The maximum number of statements allowed in a method before a warning is issued. Defaults to 5. |
 
-`Too Many Statements`'s default configuration is:
+_Too Many Statements_'s default configuration is:
 
 ```yaml
 ---

data/docs/Uncommunicative-Method-Name.md

@@ -2,21 +2,22 @@
 
 ## Introduction
 
-An `Uncommunicative Method Name` is a method name that doesn't communicate its intent well enough.
-
-Poor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.
+An _Uncommunicative Method Name_ is a method name that doesn't communicate its
+intent well enough. This code smell is a case of
+[Uncommunicative Name](Uncommunicative-Name.md).
 
 ## Current Support in Reek
 
-`Uncommunicative Method Name` checks for:
+_Uncommunicative Method Name_ checks for:
 
-* 1-character names
+* single-character names
 * any name ending with a number
-* camelCaseVariableNames
+* camelCaseMethodNames
 
 ## Configuration
 
-Reek's Uncommunicative Method Name detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus:
+Reek's _Uncommunicative Method Name_ detector supports the
+[Basic Smell Options](Basic-Smell-Options.md), plus:
 
 | Option         | Value       | Effect  |
 | ---------------|-------------|---------|

data/docs/Uncommunicative-Module-Name.md

@@ -2,25 +2,25 @@
 
 ## Introduction
 
-An `Uncommunicative Module Name` is a module name that doesn't communicate its intent well enough.
-
-Poor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.
+An _Uncommunicative Module Name_ is a module name that doesn't communicate its
+intent well enough. This code smell is a case of
+[Uncommunicative Name](Uncommunicative-Name.md).
 
 ## Current Support in Reek
 
-`Uncommunicative Module Name` checks for:
+_Uncommunicative Module Name_ checks for:
 
-* 1-character names
+* single-character names
 * any name ending with a number
 
 ## Configuration
 
-Reek's `Uncommunicative Module Name` detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus:
+Reek's _Uncommunicative Module Name_ detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus:
 
 | Option         | Value       | Effect  |
 | ---------------|-------------|---------|
-| `reject` | array of regular expressions or strings | The set of patterns / names that Reek uses to check for bad names. Defaults to `[/^.$/, /[0-9]$/]`. |
-| `accept` | array of regular expressions or strings | The set of patterns / names that Reek will accept (and not report) even if they match one of the `reject` expressions. Empty by default.|
+| `reject` | array of regular expressions or strings | The set of patterns or names that Reek uses to check for bad names. Defaults to `[/^.$/, /[0-9]$/]`. |
+| `accept` | array of regular expressions or strings | The set of patterns or names that Reek will accept (and not report) even if they match one of the `reject` expressions. Empty by default.|
 
 An example configuration could look like this:
 

data/docs/Uncommunicative-Name.md

@@ -2,13 +2,15 @@
 
 ## Introduction
 
-An `Uncommunicative Name` is a name that doesn't communicate its intent well enough.
+An _Uncommunicative Name_ is a name that doesn't communicate its intent well enough.
 
-Poor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.
+Poor names make it hard for the reader to build a mental picture of what's
+going on in the code. They can also be mis-interpreted; and they hurt the flow
+of reading, because the reader must slow down to interpret the names.
 
 ## Current Support in Reek
 
-Reek offers four related checks:
+Reek offers four checks in this category:
 
 * [Uncommunicative Method Name](Uncommunicative-Method-Name.md)
 * [Uncommunicative Module Name](Uncommunicative-Module-Name.md)

data/docs/Uncommunicative-Parameter-Name.md

@@ -2,24 +2,24 @@
 
 ## Introduction
 
-An `Uncommunicative Parameter Name` is a parameter name that doesn't communicate its intent well enough.
-
-Poor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.
+An _Uncommunicative Parameter Name_ is a parameter name that doesn't
+communicate its intent well enough. This code smell is a case of
+[Uncommunicative Name](Uncommunicative-Name.md).
 
 ## Current Support in Reek
 
-`Uncommunicative Parameter Name` checks for:
+_Uncommunicative Parameter Name_ checks for:
 
-* 1-character names
+* single-character names
 * any name ending with a number
-* camelCaseVariableNames
+* camelCaseParameterNames
 
 ## Configuration
 
-Reek's Uncommunicative Parameter Name detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus:
+Reek's _Uncommunicative Parameter Name_ detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus:
 
-| Option         | Value       | Effect  |
-| ---------------|-------------|---------|
+| Option   | Value       | Effect  |
+| ---------|-------------|---------|
 | `reject` | array of regular expressions or strings | The set of patterns / names that Reek uses to check for bad names. Defaults to `[/^.$/, /[0-9]$/, /[A-Z]/, /^_/]. |
 | `accept` | array of regular expressions or strings | The set of patterns / names that Reek will accept (and not report) even if they match one of the `reject` expressions. |
 

data/docs/Uncommunicative-Variable-Name.md

@@ -2,23 +2,24 @@
 
 ## Introduction
 
-An `Uncommunicative Variable Name` is a variable name that doesn't communicate its intent well enough.
-
-Poor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.
+An _Uncommunicative Variable Name_ is a variable name that doesn't communicate
+its intent well enough. This code smell is a case of
+[Uncommunicative Name](Uncommunicative-Name.md).
 
 ## Current Support in Reek
 
-`Uncommunicative Variable Name` checks for:
+_Uncommunicative Variable Name_ checks for:
 
-* 1-character names
+* single-character names
 * any name ending with a number
 * camelCaseVariableNames
 
 ## Configuration
 
-Reek's `Uncommunicative Variable Name` detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus:
+Reek's _Uncommunicative Variable Name_ detector supports the
+[Basic Smell Options](Basic-Smell-Options.md), plus:
 
 | Option         | Value       | Effect  |
 | ---------------|-------------|---------|
 | `reject` | array of regular expressions | The set of regular expressions that Reek uses to check for bad names. Defaults to `[/^.$/, /[0-9]$/, /[A-Z]/]`. |
-| `accept` | array of strings or regular expressions | Name that will be accepted (not reported) even if they match one of the `reject` expressions. Defaults to @['_']@.|
+| `accept` | array of strings or regular expressions | Name that will be accepted (not reported) even if they match one of the `reject` expressions. Defaults to `['_']`.|

data/docs/Unused-Parameters.md

@@ -1,8 +1,9 @@
 ## Introduction
 
-`Unused Parameter` refers to methods with parameters that are unused in scope of the method.
+_Unused Parameter_ refers to methods with parameters that are unused in scope of the method.
 
-Having unused parameters in a method is code smell because leaving dead code in a method can never improve the method and it makes the code confusing to read. 
+Having unused parameters in a method is code smell because leaving dead code in
+a method can never improve the method and it makes the code confusing to read.
 
 ## Example
 
@@ -19,9 +20,9 @@ end
 Reek would emit the following warning:
 
 ```
-[2]:Klass#unused_parameters has unused parameter 'z' (UnusedParameters)
+[2]:UnusedParameters: Klass#unused_parameters has unused parameter 'z'
 ```
 
 ## Configuration
 
-`Unused Parameter` offers the [Basic Smell Options](Basic-Smell-Options.md).
+_Unused Parameter_ offers the [Basic Smell Options](Basic-Smell-Options.md).

data/docs/Unused-Private-Method.md

@@ -3,7 +3,7 @@
 Classes should use their private methods. Otherwise this is dead
 code which is confusing and bad for maintenance.
 
-The `Unused Private Method` detector reports unused private instance
+The _Unused Private Method_ detector reports unused private instance
 methods and instance methods only - class methods are ignored.
 
 ## Example
@@ -28,13 +28,13 @@ Reek would emit the following warning:
 
 ## Configuration
 
-`Unused Private Method` offers the [Basic Smell Options](Basic-Smell-Options.md).
+_Unused Private Method_ offers the [Basic Smell Options](Basic-Smell-Options.md).
 
 Private methods that are called via dynamic dispatch
 will trigger a false alarm since detecting something like this is far out of
 scope for Reek. In this case you can disable this detector via the `exclude`
 configuration option (which is part of the [Basic Smell Options](Basic-Smell-Options.md))
-for instance like this (an example from `Reek's` own codebase):
+for instance like this (an example from Reek's own codebase):
 
 ```Ruby
 # :reek:UnusedPrivateMethod: { exclude: [ !ruby/regexp /process_/ ] }

data/docs/Utility-Function.md

@@ -43,9 +43,9 @@ _[Feature Envy](Feature-Envy.md)_ is only triggered if there are some references
 
 Reek's _Utility Function_ detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus:
 
-| Option         | Value       | Effect  |
-| ---------------|-------------|---------|
-| public_methods_only | Boolean | Disable this smell detector for non-public methods (which means "private" and "protected") |
+| Option                | Value       | Effect  |
+| ----------------------|-------------|---------|
+| `public_methods_only` | Boolean | Disable this smell detector for non-public methods (which means "private" and "protected") |
 
 A sample configuration file would look like this:
 

data/lib/reek/ast/object_refs.rb

@@ -13,10 +13,10 @@ module Reek
     #   end
     #
     # would make "@refs" below look like this after the TreeWalker has done his job:
-    # {
-    #   :self=>[2, 3], # `bar.call_me` and `bar.maybe` count as refs to `self` in line 2 and 3
-    #   :thing=>[3]    # `thing.wat` in `bar.maybe()` counts as one reference to `thing`
-    # }
+    #   {
+    #     :self=>[2, 3], # `bar.call_me` and `bar.maybe` count as refs to `self` in line 2 and 3
+    #     :thing=>[3]    # `thing.wat` in `bar.maybe()` counts as one reference to `thing`
+    #   }
     #
     class ObjectRefs
       def initialize

data/lib/reek/cli/application.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require_relative 'options'
-require_relative 'option_interpreter'
 require_relative '../configuration/app_configuration'
+require_relative '../source/source_locator'
 require_relative 'command/report_command'
 require_relative 'command/todo_list_command'
 
@@ -13,18 +13,19 @@ module Reek
     # command line.
     #
     class Application
-      include Input
       attr_reader :configuration
 
       def initialize(argv)
         @options = configure_options(argv)
         @status = options.success_exit_code
         @configuration = configure_app_configuration(options.config_file)
-        @command = command_class.new(OptionInterpreter.new(options), sources: sources)
+        @command = command_class.new(options: options,
+                                     sources: sources,
+                                     configuration: configuration)
       end
 
       def execute
-        command.execute self
+        command.execute
       end
 
       private
@@ -50,9 +51,44 @@ module Reek
         options.generate_todo_list ? Command::TodoListCommand : Command::ReportCommand
       end
 
+      def sources
+        if no_source_files_given?
+          if input_was_piped?
+            source_from_pipe
+          else
+            working_directory_as_source
+          end
+        else
+          sources_from_argv
+        end
+      end
+
       def argv
         options.argv
       end
+
+      # :reek:UtilityFunction
+      def input_was_piped?
+        !$stdin.tty?
+      end
+
+      def no_source_files_given?
+        # At this point we have deleted all options from argv. The only remaining entries
+        # are paths to the source files. If argv is empty, this means that no files were given.
+        argv.empty?
+      end
+
+      def working_directory_as_source
+        Source::SourceLocator.new(['.'], configuration: configuration).sources
+      end
+
+      def sources_from_argv
+        Source::SourceLocator.new(argv).sources
+      end
+
+      def source_from_pipe
+        [$stdin]
+      end
     end
   end
 end