reek 4.7.3 → 5.0.0

data/features/configuration_files/accept_setting.feature

@@ -3,20 +3,25 @@ Feature: `accept` configuration setting
   As a user
   I want to be able to accept specific patterns and names to exclude them from reporting
 
-  Scenario: Accept names as list and as single item
+  Scenario: Accept names
     Given a file named "config.reek" with:
       """
       ---
-      UncommunicativeMethodName:
-        accept:
-          - m1
-          - m2
-      UncommunicativeParameterName:
-        accept:
-          - a1
-          - a2
-      UncommunicativeModuleName:
-        accept: C1
+      detectors:
+        UncommunicativeMethodName:
+          accept:
+            - m1
+            - m2
+        UncommunicativeParameterName:
+          accept:
+            - a1
+            - a2
+        UncommunicativeModuleName:
+          accept:
+            - C1
+        UncommunicativeVariableName:
+          accept:
+            - var1
       """
     And a file named "smelly.rb" with:
       """
@@ -28,28 +33,37 @@ Feature: `accept` configuration setting
         def m2(a2); a2; end
         # Should report UncommunicativeMethodName and UncommunicativeParameterName
         def m3(a3); a3; end
+        var1 = 2 #  Should not report UncommunicativeVariableName
+        myvar1 = 2 # Should not report UncommunicativeVariableName
+        var2 = 2 #  Should report UncommunicativeVariableName
       end
       """
-    When I run `reek -c config.reek smelly.rb`
+    When I run reek -c config.reek smelly.rb
     Then it reports:
     """
-    smelly.rb -- 2 warnings:
-      [8]:UncommunicativeMethodName: C1#m3 has the name 'm3' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
-      [8]:UncommunicativeParameterName: C1#m3 has the parameter name 'a3' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Parameter-Name.md]
+    smelly.rb -- 3 warnings:
+      [8]:UncommunicativeMethodName: C1#m3 has the name 'm3'
+      [8]:UncommunicativeParameterName: C1#m3 has the parameter name 'a3'
+      [11]:UncommunicativeVariableName: C1 has the variable name 'var2'
     """
 
-  Scenario: Accept regexes as list and as single item
+  Scenario: Accept regexes
     Given a file named "config.reek" with:
       """
       ---
-      UncommunicativeMethodName:
-        accept:
-          - !ruby/regexp /oobar/
-      UncommunicativeParameterName:
-        accept:
-          - !ruby/regexp /ola/
-      UncommunicativeModuleName:
-        accept: !ruby/regexp /lassy/
+      detectors:
+        UncommunicativeMethodName:
+          accept:
+            - /oobar/
+        UncommunicativeParameterName:
+          accept:
+            - /ola/
+        UncommunicativeModuleName:
+          accept:
+            - /lassy/
+        UncommunicativeVariableName:
+          accept:
+            - /^var1/
       """
     And a file named "smelly.rb" with:
       """
@@ -59,12 +73,15 @@ Feature: `accept` configuration setting
         def foobar1(hola1); hola1; end
         # Should report UncommunicativeMethodName and UncommunicativeParameterName
         def m2(a2); a2; end
+        var1 = 2 #  Should not report UncommunicativeVariableName
+        myvar1 = 2 # Should report UncommunicativeVariableName
       end
       """
-    When I run `reek -c config.reek smelly.rb`
+    When I run reek -c config.reek smelly.rb
     Then it reports:
     """
-    smelly.rb -- 2 warnings:
-      [6]:UncommunicativeMethodName: Classy1#m2 has the name 'm2' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
-      [6]:UncommunicativeParameterName: Classy1#m2 has the parameter name 'a2' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Parameter-Name.md]
+    smelly.rb -- 3 warnings:
+      [6]:UncommunicativeMethodName: Classy1#m2 has the name 'm2'
+      [6]:UncommunicativeParameterName: Classy1#m2 has the parameter name 'a2'
+      [8]:UncommunicativeVariableName: Classy1 has the variable name 'myvar1'
     """

data/features/configuration_files/directory_specific_directives.feature

@@ -8,16 +8,17 @@ Feature: Directory directives
     Given a file named "web_app/config.reek" with:
       """
       ---
-      "web_app/app/controllers":
-        IrresponsibleModule:
-          enabled: false
-        NestedIterators:
-          enabled: false
-      "web_app/app/helpers":
-        IrresponsibleModule:
-          enabled: false
-        UtilityFunction:
-          enabled: false
+      directories:
+        "web_app/app/controllers":
+          IrresponsibleModule:
+            enabled: false
+          NestedIterators:
+            enabled: false
+        "web_app/app/helpers":
+          IrresponsibleModule:
+            enabled: false
+          UtilityFunction:
+            enabled: false
       """
     And a file named "web_app/app/controllers/users_controller.rb" with:
       """
@@ -46,14 +47,14 @@ Feature: Directory directives
         end
       end
       """
-    When I run `reek -c web_app/config.reek web_app/`
+    When I run reek -c web_app/config.reek web_app/
     Then it reports:
     """
     web_app/app/controllers/users_controller.rb -- 1 warning:
-      [1]:InstanceVariableAssumption: UsersController assumes too much for instance variable '@user' [https://github.com/troessner/reek/blob/master/docs/Instance-Variable-Assumption.md]
+      [1]:InstanceVariableAssumption: UsersController assumes too much for instance variable '@user'
     web_app/app/models/user.rb -- 2 warnings:
-      [1]:IrresponsibleModule: User has no descriptive comment [https://github.com/troessner/reek/blob/master/docs/Irresponsible-Module.md]
-      [2]:UnusedParameters: User#logged_in_with_role has unused parameter 'role' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
+      [1]:IrresponsibleModule: User has no descriptive comment
+      [2]:UnusedParameters: User#logged_in_with_role has unused parameter 'role'
     3 total warnings
     """
 
@@ -61,9 +62,10 @@ Feature: Directory directives
     Given a file named "web_app/config.reek" with:
       """
       ---
-      "controllers/":
-        IrresponsibleModule:
-          enabled: false
+      directories:
+        "controllers/":
+          IrresponsibleModule:
+            enabled: false
       """
     And a file named "controllers/users_controller.rb" with:
       """
@@ -72,24 +74,25 @@ Feature: Directory directives
         end
       end
       """
-    When I run `reek -c web_app/config.reek controllers`
+    When I run reek -c web_app/config.reek controllers
     Then it reports nothing
 
   Scenario: Partially mask smells in different directories
     Given a file named "web_app/config.reek" with:
       """
       ---
-      "web_app/app/controllers":
-        IrresponsibleModule:
-          enabled: true
-      "web_app/app/helpers":
-        IrresponsibleModule:
-          enabled: false
-        UtilityFunction:
-          enabled: false
-      "web_app/app/models":
-        IrresponsibleModule:
-          enabled: false
+      directories:
+        "web_app/app/controllers":
+          IrresponsibleModule:
+            enabled: true
+        "web_app/app/helpers":
+          IrresponsibleModule:
+            enabled: false
+          UtilityFunction:
+            enabled: false
+        "web_app/app/models":
+          IrresponsibleModule:
+            enabled: false
       """
     And a file named "web_app/app/controllers/users_controller.rb" with:
       """
@@ -117,15 +120,15 @@ Feature: Directory directives
         end
       end
       """
-    When I run `reek -c web_app/config.reek web_app/`
+    When I run reek -c web_app/config.reek web_app/
     Then it reports:
     """
     web_app/app/controllers/users_controller.rb -- 3 warnings:
-      [1]:InstanceVariableAssumption: UsersController assumes too much for instance variable '@user' [https://github.com/troessner/reek/blob/master/docs/Instance-Variable-Assumption.md]
-      [1]:IrresponsibleModule: UsersController has no descriptive comment [https://github.com/troessner/reek/blob/master/docs/Irresponsible-Module.md]
-      [4]:NestedIterators: UsersController#show contains iterators nested 2 deep [https://github.com/troessner/reek/blob/master/docs/Nested-Iterators.md]
+      [1]:InstanceVariableAssumption: UsersController assumes too much for instance variable '@user'
+      [1]:IrresponsibleModule: UsersController has no descriptive comment
+      [4]:NestedIterators: UsersController#show contains iterators nested 2 deep
     web_app/app/models/user.rb -- 1 warning:
-      [2]:UnusedParameters: User#logged_in_with_role has unused parameter 'role' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
+      [2]:UnusedParameters: User#logged_in_with_role has unused parameter 'role'
     4 total warnings
     """
 
@@ -133,15 +136,17 @@ Feature: Directory directives
     Given a file named "config.reek" with:
       """
       ---
-      "web_app/app/controllers":
+      directories:
+        "web_app/app/controllers":
+          IrresponsibleModule:
+            enabled: true
+          NestedIterators:
+            enabled: false
+      detectors:
         IrresponsibleModule:
-          enabled: true
-        NestedIterators:
           enabled: false
-      IrresponsibleModule:
-        enabled: false
-      NestedIterators:
-        enabled: true
+        NestedIterators:
+          enabled: true
       """
     And a file named "web_app/app/controllers/users_controller.rb" with:
       """
@@ -163,15 +168,15 @@ Feature: Directory directives
         end
       end
       """
-    When I run `reek -c config.reek other/ web_app/`
+    When I run reek -c config.reek other/ web_app/
     Then it reports:
     """
     other/projects_controller.rb -- 2 warnings:
-      [1]:InstanceVariableAssumption: ProjectController assumes too much for instance variable '@project' [https://github.com/troessner/reek/blob/master/docs/Instance-Variable-Assumption.md]
-      [4]:NestedIterators: ProjectController#show contains iterators nested 2 deep [https://github.com/troessner/reek/blob/master/docs/Nested-Iterators.md]
+      [1]:InstanceVariableAssumption: ProjectController assumes too much for instance variable '@project'
+      [4]:NestedIterators: ProjectController#show contains iterators nested 2 deep
     web_app/app/controllers/users_controller.rb -- 2 warnings:
-      [1]:InstanceVariableAssumption: UsersController assumes too much for instance variable '@user' [https://github.com/troessner/reek/blob/master/docs/Instance-Variable-Assumption.md]
-      [1]:IrresponsibleModule: UsersController has no descriptive comment [https://github.com/troessner/reek/blob/master/docs/Irresponsible-Module.md]
+      [1]:InstanceVariableAssumption: UsersController assumes too much for instance variable '@user'
+      [1]:IrresponsibleModule: UsersController has no descriptive comment
     4 total warnings
     """
 
@@ -179,10 +184,11 @@ Feature: Directory directives
     Given a file named "config.reek" with:
       """
       ---
-      "dummy_directory":
-        # Typo: Should be NestedIterators
-        IteratorsNested:
-          enabled: false
+      directories:
+        "dummy_directory":
+          # Typo: Should be NestedIterators
+          IteratorsNested:
+            enabled: false
       """
     And a file named "dummy_directory/dummy.rb" with:
       """
@@ -190,34 +196,32 @@ Feature: Directory directives
       end
       """
 
-    When I run `reek -c config.reek dummy_directory/`
+    When I run reek -c config.reek dummy_directory/
     Then the exit status indicates an error
     And stderr reports:
     """
-    You are trying to configure smell type IteratorsNested but we can't find one with that name.
-    Please make sure you spelled it right. (See 'defaults.reek' in the Reek
-    repository for a list of all available smell types.)
-
+    Error: We found some problems with your configuration file: [/directories/dummy_directory/IteratorsNested] key 'IteratorsNested:' is undefined.
     """
 
   Scenario: Abort on file as directory directive
     Given a file named "config.reek" with:
       """
       ---
-      "dummy_directory/dummy.rb":
-        NestedIterators:
-          enabled: false
+      directories:
+        "dummy_directory/dummy.rb":
+          NestedIterators:
+            enabled: false
       """
     And a file named "dummy_directory/dummy.rb" with:
       """
       class Dummy
       end
       """
-    When I run `reek -c config.reek dummy_directory/`
+    When I run reek -c config.reek dummy_directory/
     Then the exit status indicates an error
     And stderr reports:
     """
-    Configuration error: `dummy_directory/dummy.rb` is supposed to be a directory but is a file
+    Error: `dummy_directory/dummy.rb` is supposed to be a directory but is a file
 
     """
 
@@ -225,16 +229,17 @@ Feature: Directory directives
     Given a file named "config.reek" with:
       """
       ---
-      "foo/bar/baz":
-        IrresponsibleModule:
-          enabled: false
-        NestedIterators:
-          enabled: true
-      "foo/bar":
-        IrresponsibleModule:
-          enabled: true
-        NestedIterators:
-          enabled: false
+      directories:
+        "foo/bar/baz":
+          IrresponsibleModule:
+            enabled: false
+          NestedIterators:
+            enabled: true
+        "foo/bar":
+          IrresponsibleModule:
+            enabled: true
+          NestedIterators:
+            enabled: false
       """
     And a file named "foo/bar/baz/klass.rb" with:
       """
@@ -258,12 +263,12 @@ Feature: Directory directives
         end
       end
       """
-    When I run `reek -c config.reek foo/`
+    When I run reek -c config.reek foo/
     Then it reports:
     """
     foo/bar/baz/klass.rb -- 1 warning:
-      [4]:NestedIterators: Klass#meth contains iterators nested 2 deep [https://github.com/troessner/reek/blob/master/docs/Nested-Iterators.md]
+      [4]:NestedIterators: Klass#meth contains iterators nested 2 deep
     foo/bar/klazz.rb -- 1 warning:
-      [1]:IrresponsibleModule: Klazz has no descriptive comment [https://github.com/troessner/reek/blob/master/docs/Irresponsible-Module.md]
+      [1]:IrresponsibleModule: Klazz has no descriptive comment
     2 total warnings
     """

data/features/configuration_files/exclude_directives.feature

@@ -7,13 +7,14 @@ Feature: Exclude directives
     Given a file named "config.reek" with:
       """
       ---
-      UncommunicativeMethodName:
-        exclude:
-          - "Smelly#x"
-      UnusedPrivateMethod:
-        enabled: true
-        exclude:
-          - "Smelly#foobar"
+      detectors:
+        UncommunicativeMethodName:
+          exclude:
+            - "Smelly#x"
+        UnusedPrivateMethod:
+          enabled: true
+          exclude:
+            - "Smelly#foobar"
       """
     And a file named "smelly.rb" with:
       """
@@ -25,10 +26,10 @@ Feature: Exclude directives
         def foobar; end   # Should not report UnusedPrivateMethod
       end
       """
-    When I run `reek -c config.reek smelly.rb`
+    When I run reek -c config.reek smelly.rb
     Then it reports:
     """
     smelly.rb -- 2 warnings:
-      [1]:IrresponsibleModule: Smelly has no descriptive comment [https://github.com/troessner/reek/blob/master/docs/Irresponsible-Module.md]
-      [3]:UnusedParameters: Smelly#foo has unused parameter 'arg' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
+      [1]:IrresponsibleModule: Smelly has no descriptive comment
+      [3]:UnusedParameters: Smelly#foo has unused parameter 'arg'
     """

data/features/configuration_files/exclude_paths_directives.feature

@@ -11,7 +11,7 @@ Feature: Exclude paths directives
         def alfa(bravo); end
       end
       """
-    When I run `reek .`
+    When I run reek .
     Then the exit status indicates smells
     Given a file named "config.reek" with:
       """
@@ -19,7 +19,7 @@ Feature: Exclude paths directives
       exclude_paths:
         - bad_files_live_here
       """
-    When I run `reek -c config.reek .`
+    When I run reek -c config.reek .
     Then it succeeds
     And it reports nothing
   Scenario: Using a file name within an excluded directory
@@ -36,8 +36,8 @@ Feature: Exclude paths directives
       exclude_paths:
         - bad_files_live_here
       """
-    When I run `reek -c config.reek bad_files_live_here/smelly.rb`
+    When I run reek -c config.reek bad_files_live_here/smelly.rb
     Then the exit status indicates smells
-    When I run `reek -c config.reek --force-exclusion bad_files_live_here/smelly.rb`
+    When I run reek -c config.reek --force-exclusion bad_files_live_here/smelly.rb
     Then it succeeds
     And it reports nothing

data/features/configuration_files/masking_smells.feature

@@ -7,7 +7,10 @@ Feature: Masking smells using config files
     Given the smelly file 'smelly.rb'
     And a configuration file 'corrupt.reek'
     When I run reek -c corrupt.reek smelly.rb
-    Then it reports the error 'Error: Invalid configuration file "corrupt.reek" -- Not a hash'
+    And stderr reports:
+    """
+    Error: We found some problems with your configuration file: [/] 'Not a valid configuration file': not a mapping.
+    """
     And the exit status indicates an error
     And it reports nothing
 
@@ -30,11 +33,21 @@ Feature: Masking smells using config files
     And it reports:
       """
       smelly.rb -- 1 warning:
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
       """
 
   Scenario: provide extra masking inline in comments
-    Given the smelly file 'smelly_with_inline_mask.rb'
+    Given a file named "smelly_with_inline_mask.rb" with:
+      """
+      # Smelly class
+      # disables :reek:UncommunicativeVariableName
+      class Smelly
+        # This will reek of UncommunicativeMethodName
+        def x
+          y = 10 # This will NOT reek of UncommunicativeVariableName
+        end
+      end
+      """
     And a configuration file 'partial_mask.reek'
     When I run reek -c partial_mask.reek smelly_with_inline_mask.rb
     Then it succeeds
@@ -48,18 +61,34 @@ Feature: Masking smells using config files
     And it reports:
     """
     smelly.rb -- 2 warnings:
-      [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
-      [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
+      [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
+      [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
     """
 
   Scenario: Disable UtilityFunction for non-public methods
-    Given the smelly file 'smelly_with_modifiers.rb'
-    And a configuration file 'non_public_modifiers_mask.reek'
-    When I run reek -c non_public_modifiers_mask.reek smelly_with_modifiers.rb
+    Given a file named "smelly_with_modifiers.rb" with:
+      """
+      # Smelly class for testing purposes
+      class Klass
+        def public_method(arg) arg.to_s; end
+        protected
+        def protected_method(arg) arg.to_s; end
+        private
+        def private_method(arg) arg.to_s; end
+      end
+      """
+    And a file named "non_public_modifiers_mask.reek.yml" with:
+      """
+      ---
+      detectors:
+        UtilityFunction:
+          public_methods_only: true
+      """
+    When I run reek -c non_public_modifiers_mask.reek.yml smelly_with_modifiers.rb
     Then the exit status indicates smells
     And it reports:
       """
       smelly_with_modifiers.rb -- 1 warning:
-        [7]:UtilityFunction: Klass#public_method doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
+        [3]:UtilityFunction: Klass#public_method doesn't depend on instance state (maybe move it to another class?)
       """
     But it does not report private or protected methods

data/features/configuration_files/mix_accept_reject_setting.feature

@@ -7,13 +7,14 @@ Feature: Mix `accept` and `reject` configuration settings
     Given a file named "config.reek" with:
       """
       ---
-      UncommunicativeMethodName:
-        accept:
-          - !ruby/regexp /x/
-          - meth1
-        reject:
-          - !ruby/regexp /helper/
-          - foobar
+      detectors:
+        UncommunicativeMethodName:
+          accept:
+            - x
+            - meth1
+          reject:
+            - helper
+            - foobar
       """
     And a file named "smelly.rb" with:
       """
@@ -22,26 +23,27 @@ Feature: Mix `accept` and `reject` configuration settings
       def foobar; end # Should be reported
       def awesome_helper; end # Should be reported
       """
-    When I run `reek -c config.reek smelly.rb`
+    When I run reek -c config.reek smelly.rb
     Then it reports:
     """
     smelly.rb -- 2 warnings:
-      [4]:UncommunicativeMethodName: awesome_helper has the name 'awesome_helper' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
-      [3]:UncommunicativeMethodName: foobar has the name 'foobar' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
+      [4]:UncommunicativeMethodName: awesome_helper has the name 'awesome_helper'
+      [3]:UncommunicativeMethodName: foobar has the name 'foobar'
     """
 
   Scenario: UncommunicativeModuleName
     Given a file named "config.reek" with:
       """
       ---
-      IrresponsibleModule:
-        enabled: false
-      UncommunicativeModuleName:
-        accept:
-          - !ruby/regexp /lassy/
-          - M
-        reject:
-          - !ruby/regexp /Helper/
+      detectors:
+        IrresponsibleModule:
+          enabled: false
+        UncommunicativeModuleName:
+          accept:
+            - lassy
+            - M
+          reject:
+            - Helper
       """
     And a file named "smelly.rb" with:
       """
@@ -49,23 +51,24 @@ Feature: Mix `accept` and `reject` configuration settings
       class M; end # Should not be reported
       class BaseHelper; end # Should be reported
       """
-    When I run `reek -c config.reek smelly.rb`
+    When I run reek -c config.reek smelly.rb
     Then it reports:
     """
     smelly.rb -- 1 warning:
-      [3]:UncommunicativeModuleName: BaseHelper has the name 'BaseHelper' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Module-Name.md]
+      [3]:UncommunicativeModuleName: BaseHelper has the name 'BaseHelper'
     """
 
   Scenario: UncommunicativeParameterName
     Given a file named "config.reek" with:
       """
       ---
-      UncommunicativeParameterName:
-        accept:
-          - !ruby/regexp /x/
-          - arg1
-        reject:
-          - !ruby/regexp /foobar/
+      detectors:
+        UncommunicativeParameterName:
+          accept:
+            - x
+            - arg1
+          reject:
+            - foobar
       """
     And a file named "smelly.rb" with:
       """
@@ -73,9 +76,9 @@ Feature: Mix `accept` and `reject` configuration settings
       def omg(arg1); arg1; end # Should not be reported
       def omg(foobar); foobar; end # Should be reported
       """
-    When I run `reek -c config.reek smelly.rb`
+    When I run reek -c config.reek smelly.rb
     Then it reports:
     """
     smelly.rb -- 1 warning:
-      [3]:UncommunicativeParameterName: omg has the parameter name 'foobar' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Parameter-Name.md]
+      [3]:UncommunicativeParameterName: omg has the parameter name 'foobar'
     """