reek 4.8.2 → 5.0.0

data/features/command_line_interface/options.feature

@@ -37,13 +37,14 @@ Feature: Reek can be controlled using command-line options
       reek -s lib
       cat my_class.rb | reek
 
-      See https://wiki.github.com/troessner/reek for detailed help.
+      See https://github.com/troessner/reek for detailed help.
 
       Configuration:
           -c, --config FILE                Read configuration options from FILE
               --smell SMELL                Only look for a specific smell.
-                                           Call it like this: reek --smell PrimaDonnaMethod source.rb
-                                           Check out https://github.com/troessner/reek/blob/v4.8.1/docs/Code-Smells.md for a list of smells
+                                           Call it like this: reek --smell MissingSafeMethod source.rb
+                                           Check out https://github.com/troessner/reek/blob/v5.0.0/docs/Code-Smells.md for a list of smells
+              --stdin-filename FILE        When passing code in via pipe, assume this filename when checking file or directory rules in the config.
 
       Generate a todo list:
           -t, --todo                       Generate a todo list
@@ -60,7 +61,7 @@ Feature: Reek can be controlled using command-line options
       Text format options:
               --[no-]color                 Use colors for the output (default: true)
           -V, --[no-]empty-headings        Show headings for smell-free source files (default: false)
-          -U, --[no-]wiki-links            Show link to related wiki page for each smell (default: true)
+          -U, --[no-]documentation         Show link to related documentation page for each smell (default: true)
           -n, --[no-]line-numbers          Show line numbers in the output (default: true)
           -s, --single-line                Show location in editor-compatible single-line-per-smell format
           -P, --[no-]progress              Show progress of each source as it is examined (default: true)
@@ -76,5 +77,46 @@ Feature: Reek can be controlled using command-line options
 
       Utility options:
           -h, --help                       Show this message
+          -l, --list                       List all available smell detectors
           -v, --version                    Show version
       """
+
+  Scenario: List all available smell detectors
+    When I run reek --list
+    Then it succeeds
+    And it reports:
+      """
+      All available smell detectors:
+
+      Attribute
+      BooleanParameter
+      ClassVariable
+      ControlParameter
+      DataClump
+      DuplicateMethodCall
+      FeatureEnvy
+      InstanceVariableAssumption
+      IrresponsibleModule
+      LongParameterList
+      LongYieldList
+      ManualDispatch
+      MissingSafeMethod
+      ModuleInitialize
+      NestedIterators
+      NilCheck
+      RepeatedConditional
+      SubclassedFromCoreClass
+      TooManyConstants
+      TooManyInstanceVariables
+      TooManyMethods
+      TooManyStatements
+      UncommunicativeMethodName
+      UncommunicativeModuleName
+      UncommunicativeParameterName
+      UncommunicativeVariableName
+      UnusedParameters
+      UnusedPrivateMethod
+      UtilityFunction
+
+      Check out https://github.com/troessner/reek/blob/v5.0.0/docs/Code-Smells.md for a details on each detector
+      """

data/features/command_line_interface/stdin.feature

@@ -34,10 +34,32 @@ Feature: Reek reads from $stdin when no files are given
 
   Scenario: syntax error causes the source to be ignored
     When I pass "= invalid syntax =" to reek
-    Then the exit status indicates smells
-    And it reports:
+    Then it succeeds
+    And it reports the error "Parser::SyntaxError: unexpected token tEQL"
+
+  Scenario: providing a filename to use for the config to match against
+    Given a file named "web_app/config.reek" with:
       """
-      STDIN -- 2 warnings:
-        [2]:Syntax: This file has unexpected token $end
-        [1]:Syntax: This file has unexpected token tEQL
+      ---
+      directories:
+        "web_app/app/controllers":
+          IrresponsibleModule:
+            enabled: false
+          NestedIterators:
+            enabled: false
+          InstanceVariableAssumption:
+            enabled: false
       """
+    When I pass a stdin to reek --config web_app/config.reek --stdin-filename web_app/app/controllers/users_controller with:
+      """
+      class UsersController < ApplicationController
+        def show
+          respond_with do |format|
+            format.json { |json| @user.to_custom_json }
+            format.xml { |xml| @user.to_fancy_xml }
+          end
+        end
+      end
+      """
+    Then it succeeds
+    And it reports nothing

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
     Then it reports:
     """
-    smelly.rb -- 2 warnings:
+    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
     Then it reports:
     """
-    smelly.rb -- 2 warnings:
+    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:
       """
@@ -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:
       """
@@ -79,17 +81,18 @@ Feature: Directory directives
     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:
       """
@@ -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:
       """
@@ -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:
       """
@@ -194,19 +200,17 @@ Feature: Directory directives
     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:
       """
@@ -217,7 +221,7 @@ Feature: Directory directives
     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:
       """

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:
       """

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
 
@@ -34,7 +37,17 @@ Feature: Masking smells using config files
       """
 
   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
@@ -53,13 +66,29 @@ Feature: Masking smells using config files
     """
 
   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?)
+        [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