reek 4.8.2 → 5.0.0

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:
       """
@@ -34,14 +35,15 @@ Feature: Mix `accept` and `reject` configuration settings
     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:
       """
@@ -60,12 +62,13 @@ Feature: Mix `accept` and `reject` configuration settings
     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:
       """

data/features/configuration_files/reject_setting.feature

@@ -3,20 +3,25 @@ Feature: `reject` configuration setting
   As a user
   I want to be able to reject specific patterns and names to include them into reporting
 
-  Scenario: reject names as list and as single item
+  Scenario: reject names
     Given a file named "config.reek" with:
       """
       ---
-      UncommunicativeMethodName:
-        reject:
-          - awesome_helper
-          - little_helper
-      UncommunicativeParameterName:
-        reject:
-          - solid_argument
-          - nifty_argument
-      UncommunicativeModuleName:
-        reject: Dummy
+      detectors:
+        UncommunicativeMethodName:
+          reject:
+            - awesome_helper
+            - little_helper
+        UncommunicativeParameterName:
+          reject:
+            - solid_argument
+            - nifty_argument
+        UncommunicativeModuleName:
+          reject:
+            - Dummy
+        UncommunicativeVariableName:
+          reject:
+            - fine_name
       """
     And a file named "smelly.rb" with:
       """
@@ -28,51 +33,57 @@ Feature: `reject` configuration setting
         def little_helper(nifty_argument); nifty_argument; end
         # Should not report UncommunicativeMethodName and UncommunicativeParameterName
         def meth(argument); argument; end
+        fine_name = 2 # Should report UncommunicativeMethodName
+        other_name = 2 # Should not report UncommunicativeMethodName
       end
       """
     When I run reek -c config.reek smelly.rb
     Then it reports:
     """
-    smelly.rb -- 5 warnings:
+    smelly.rb -- 6 warnings:
       [4]:UncommunicativeMethodName: Dummy#awesome_helper has the name 'awesome_helper'
       [6]:UncommunicativeMethodName: Dummy#little_helper has the name 'little_helper'
       [2]:UncommunicativeModuleName: Dummy has the name 'Dummy'
       [4]:UncommunicativeParameterName: Dummy#awesome_helper has the parameter name 'solid_argument'
       [6]:UncommunicativeParameterName: Dummy#little_helper has the parameter name 'nifty_argument'
+      [9]:UncommunicativeVariableName: Dummy has the variable name 'fine_name'
     """
 
-  Scenario: reject regexes as list and as single item
+  Scenario: Reject regexes
     Given a file named "config.reek" with:
       """
       ---
-      UncommunicativeMethodName:
-        reject: !ruby/regexp /helper/
-      UncommunicativeParameterName:
-        reject:
-          - !ruby/regexp /solid/
-          - !ruby/regexp /nifty/
-      UncommunicativeModuleName:
-        reject: !ruby/regexp /ummy/
+      detectors:
+        UncommunicativeMethodName:
+          accept:
+            - /oobar/
+        UncommunicativeParameterName:
+          accept:
+            - /ola/
+        UncommunicativeModuleName:
+          accept:
+            - /lassy/
+        UncommunicativeVariableName:
+          reject:
+            - /^fine_name/
       """
     And a file named "smelly.rb" with:
       """
-      # Should report UncommunicativeModuleName
-      class Dummy
-        # Should report UncommunicativeMethodName and UncommunicativeParameterName
-        def awesome_helper(solid_argument); solid_argument; end
-        # Should report UncommunicativeMethodName and UncommunicativeParameterName
-        def little_helper(nifty_argument); nifty_argument; end
+      # Should not report UncommunicativeModuleName
+      class Classy1
         # Should not report UncommunicativeMethodName and UncommunicativeParameterName
-        def meth(argument); argument; end
+        def foobar1(hola1); hola1; end
+        # Should report UncommunicativeMethodName and UncommunicativeParameterName
+        def m2(a2); a2; end
+        fine_name = 2 # Should report UncommunicativeMethodName
+        my_fine_name = 2 # Should not report UncommunicativeMethodName
       end
       """
     When I run reek -c config.reek smelly.rb
     Then it reports:
     """
-    smelly.rb -- 5 warnings:
-      [4]:UncommunicativeMethodName: Dummy#awesome_helper has the name 'awesome_helper'
-      [6]:UncommunicativeMethodName: Dummy#little_helper has the name 'little_helper'
-      [2]:UncommunicativeModuleName: Dummy has the name 'Dummy'
-      [4]:UncommunicativeParameterName: Dummy#awesome_helper has the parameter name 'solid_argument'
-      [6]:UncommunicativeParameterName: Dummy#little_helper has the parameter name 'nifty_argument'
+    smelly.rb -- 3 warnings:
+      [6]:UncommunicativeMethodName: Classy1#m2 has the name 'm2'
+      [6]:UncommunicativeParameterName: Classy1#m2 has the parameter name 'a2'
+      [7]:UncommunicativeVariableName: Classy1 has the variable name 'fine_name'
     """

data/features/configuration_files/schema_validation.feature

@@ -0,0 +1,59 @@
+Feature: Validate schema
+  In order to ensure that I am using the right configuration
+  As a user
+  I want to be notified when I am using a configuration that violates our schema
+
+  Scenario: Our generated default configuration
+    Given our default configuration file
+    And the clean file 'clean.rb'
+    When I run reek -c defaults.reek clean.rb
+    Then it succeeds
+    And it reports nothing
+
+  Scenario: Detectors, directories and exclude paths all mixed
+    Given a file named "config.reek" with:
+    """
+    ---
+    detectors:
+      IrresponsibleModule:
+        enabled: false
+      NestedIterators:
+        exclude:
+          - "MyWorker#self.class_method"
+          - "AnotherWorker#instance_method"
+      DataClump:
+        max_copies: 3
+        min_clump_size: 3
+
+    directories:
+      "web_app/app/controllers":
+        NestedIterators:
+          enabled: false
+      "web_app/app/helpers":
+        UtilityFunction:
+          enabled: false
+
+    exclude_paths:
+      - lib/legacy
+      - lib/rake/legacy_tasks
+    """
+    And the clean file 'clean.rb'
+    When I run reek -c config.reek clean.rb
+    Then it succeeds
+    And it reports nothing
+
+  Scenario: Invalid detector name
+    Given a file named "config.reek" with:
+    """
+    ---
+    detectors:
+      DoesNotExist:
+        enabled: true
+    """
+    And the clean file 'clean.rb'
+    When I run reek -c config.reek clean.rb
+    Then the exit status indicates an error
+    And stderr reports:
+    """
+    Error: We found some problems with your configuration file: [/detectors/DoesNotExist] key 'DoesNotExist:' is undefined.
+    """

data/features/configuration_files/unused_private_method.feature

@@ -7,12 +7,13 @@ Feature: Unused Private Method detector
     Given a file named "config.reek" with:
       """
       ---
-      IrresponsibleModule:
-        enabled: false
-      UnusedPrivateMethod:
-        enabled: true
-        exclude:
-          - "Outer::Awesome#foobar"
+      detectors:
+        IrresponsibleModule:
+          enabled: false
+        UnusedPrivateMethod:
+          enabled: true
+          exclude:
+            - Outer::Awesome#foobar
       """
     And a file named "sample.rb" with:
       """
@@ -38,12 +39,13 @@ Feature: Unused Private Method detector
     Given a file named "config.reek" with:
       """
       ---
-      IrresponsibleModule:
-        enabled: false
-      UnusedPrivateMethod:
-        enabled: true
-        exclude:
-          - !ruby/regexp /(.*)wesome#foo(.*)/
+      detectors:
+        IrresponsibleModule:
+          enabled: false
+        UnusedPrivateMethod:
+          enabled: true
+          exclude:
+            - wesome#foo
       """
     And a file named "sample.rb" with:
       """

data/features/configuration_loading.feature

@@ -3,7 +3,7 @@ Feature: Offer different ways how to load configuration
   Reek can be configured in two ways:
   - Using the cli "-c" switch to pass a configuration file on the command line.
   - Having a Reek configuration file that is automatically found. Reek will
-    look for a file ending in .reek in the following places, in order:
+    look for a file ending in .reek.yml in the following places, in order:
     - The current working directory
     - The working directory's ancestor directories, traversing all the way up
       to the root.
@@ -30,19 +30,62 @@ Feature: Offer different ways how to load configuration
 
   Scenario: Configuration file in working directory
     Given the smelly file 'smelly.rb'
-    And a configuration file 'full_mask.reek'
+    And a file named ".reek.yml" with:
+      """
+      ---
+      detectors:
+        UncommunicativeMethodName:
+          enabled: false
+        UncommunicativeVariableName:
+          enabled: false
+      """
     When I run reek smelly.rb
     Then it reports no errors
     And it succeeds
 
-  Scenario: Two opposing configuration files and we stop after the first one
-    Given the smelly file 'smelly.rb' in a subdirectory
-    And a configuration file 'partial_mask.reek' in a subdirectory
-    And a configuration file 'full_mask.reek'
-    When I run "reek smelly.rb" in a subdirectory
+  Scenario: Do not use the default config file when we explicitly specify one configuration file
+    Given the smelly file 'smelly.rb'
+    And a file named "config.reek" with:
+      """
+      ---
+      detectors:
+        UncommunicativeMethodName:
+          enabled: false
+      """
+    And a file named ".reek.yml" with:
+      """
+      ---
+      UncommunicativeVariableName:
+        enabled: false
+      """
+    When I run reek -c config.reek smelly.rb
     Then the exit status indicates smells
     And it reports:
       """
       smelly.rb -- 1 warning:
         [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
       """
+
+  Scenario: Prefer the default config file over other configuration files
+    Given the smelly file 'smelly.rb'
+    And a file named "config.reek" with:
+      """
+      ---
+      detectors:
+        UncommunicativeMethodName:
+          enabled: false
+      """
+    And a file named ".reek.yml" with:
+      """
+      ---
+      detectors:
+        UncommunicativeVariableName:
+          enabled: false
+      """
+    When I run reek smelly.rb
+    Then the exit status indicates smells
+    And it reports:
+      """
+      smelly.rb -- 1 warning:
+        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
+      """

data/features/rake_task/rake_task.feature

@@ -10,7 +10,7 @@ Feature: Reek can be driven through its Task
 
       Reek::Rake::Task.new do |t|
         t.source_files = 'smelly.rb'
-        t.reek_opts = '--no-color --no-wiki-links'
+        t.reek_opts = '--no-color --no-documentation'
       end
       """
     When I run `rake reek`
@@ -30,7 +30,7 @@ Feature: Reek can be driven through its Task
 
       Reek::Rake::Task.new do |t|
         t.source_files = FileList['smelly.*']
-        t.reek_opts = '--no-color --no-wiki-links'
+        t.reek_opts = '--no-color --no-documentation'
       end
       """
     When I run `rake reek`
@@ -50,7 +50,7 @@ Feature: Reek can be driven through its Task
 
       Reek::Rake::Task.new('silky') do |t|
         t.source_files = 'smelly.rb'
-        t.reek_opts = '--no-color --no-wiki-links'
+        t.reek_opts = '--no-color --no-documentation'
       end
       """
     When I run `rake silky`
@@ -86,7 +86,7 @@ Feature: Reek can be driven through its Task
       Reek::Rake::Task.new do |t|
         t.fail_on_error = false
         t.source_files = 'smelly.rb'
-        t.reek_opts = '--no-color --no-wiki-links'
+        t.reek_opts = '--no-color --no-documentation'
       end
       """
     When I run `rake reek`
@@ -124,7 +124,7 @@ Feature: Reek can be driven through its Task
 
       Reek::Rake::Task.new do |t|
         t.source_files = 'clean.rb'
-        t.reek_opts = '--no-color --no-wiki-links'
+        t.reek_opts = '--no-color --no-documentation'
       end
       """
     When I set the environment variable "REEK_SRC" to "smelly.rb"

data/features/reports/json.feature

@@ -24,6 +24,7 @@ Feature: Report smells using simple JSON layout
               "context": "Smelly#x",
               "lines": [ 4 ],
               "message": "has the name 'x'",
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.0.0/docs/Uncommunicative-Method-Name.md",
               "name": "x"
           },
           {
@@ -32,6 +33,7 @@ Feature: Report smells using simple JSON layout
               "context": "Smelly#x",
               "lines": [ 5 ],
               "message": "has the variable name 'y'",
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.0.0/docs/Uncommunicative-Variable-Name.md",
               "name": "y"
           }
       ]
@@ -50,7 +52,8 @@ Feature: Report smells using simple JSON layout
               "lines": [
                   1
               ],
-              "message": "has no descriptive comment"
+              "message": "has no descriptive comment",
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.0.0/docs/Irresponsible-Module.md"
           }
       ]
       """

data/features/reports/reports.feature

@@ -175,25 +175,25 @@ Feature: Correctly formatted reports
       | smelly/ |
       | smelly  |
 
-  Scenario Outline: -U or --wiki-links adds helpful links to smell warnings
+  Scenario Outline: -U or --documentation adds helpful links to smell warnings
     Given the smelly file 'smelly.rb'
     When I run reek <option> smelly.rb
     Then the exit status indicates smells
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v4.8.1/docs/Uncommunicative-Method-Name.md]
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v4.8.1/docs/Uncommunicative-Variable-Name.md]
+        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.0.0/docs/Uncommunicative-Method-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.0.0/docs/Uncommunicative-Variable-Name.md]
       """
 
     Examples:
-      | option        |
-      | -U            |
-      | --wiki-links  |
+      | option           |
+      | -U               |
+      | --documentation  |
 
-  Scenario: --no-wiki-links drops links from smell warnings
+  Scenario: --no-documentation drops links from smell warnings
     Given the smelly file 'smelly.rb'
-    When I run reek --no-wiki-links smelly.rb
+    When I run reek --no-documentation smelly.rb
     Then the exit status indicates smells
     And it reports:
       """
@@ -202,18 +202,18 @@ Feature: Correctly formatted reports
         [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
       """
 
-  Scenario Outline: --wiki-links is independent of --line-numbers
+  Scenario Outline: --documentation is independent of --line-numbers
     Given the smelly file 'smelly.rb'
     When I run reek <option> smelly.rb
     Then the exit status indicates smells
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v4.8.1/docs/Uncommunicative-Method-Name.md]
-        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v4.8.1/docs/Uncommunicative-Variable-Name.md]
+        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.0.0/docs/Uncommunicative-Method-Name.md]
+        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.0.0/docs/Uncommunicative-Variable-Name.md]
       """
 
     Examples:
       | option                             |
       | --no-line-numbers -U               |
-      | --no-line-numbers --wiki-links  |
+      | --no-line-numbers --documentation  |