reek 4.6.0 → 5.0.0

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:
       """
@@ -27,23 +28,24 @@ Feature: Unused Private Method detector
         end
       end
       """
-    When I run `reek -c config.reek sample.rb`
+    When I run reek -c config.reek sample.rb
     Then it reports:
     """
     sample.rb -- 1 warning:
-      [4]:UnusedPrivateMethod: Outer::Smelly has the unused private instance method 'foobar' [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
+      [4]:UnusedPrivateMethod: Outer::Smelly has the unused private instance method 'foobar'
     """
 
   Scenario: Use regexes for excluding contexts
     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:
       """
@@ -58,9 +60,9 @@ Feature: Unused Private Method detector
         end
       end
       """
-    When I run `reek -c config.reek sample.rb`
+    When I run reek -c config.reek sample.rb
     Then it reports:
     """
     sample.rb -- 1 warning:
-      [4]:UnusedPrivateMethod: Outer::Smelly has the unused private instance method 'foobar' [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
+      [4]:UnusedPrivateMethod: Outer::Smelly has the unused private instance method 'foobar'
     """

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.
@@ -17,8 +17,8 @@ Feature: Offer different ways how to load configuration
     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: Configuration via CLI
@@ -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:
-        [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'
       """

data/features/configuration_via_source_comments/erroneous_source_comments.feature

@@ -33,8 +33,8 @@ Feature: Erroneous source comments are handled properly
     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'
       2 total warnings
       """
 
@@ -48,7 +48,7 @@ Feature: Erroneous source comments are handled properly
       """
     When I run reek bad_comment.rb
     Then it reports the error "Error: You are trying to configure the smell detector 'UncommunicativeMethodName'"
-    And it reports the error "Unfortunately we can not parse the configuration you have given."
+    And it reports the error "Unfortunately we cannot parse the configuration you have given."
     And it reports the error "The source is 'bad_comment.rb'"
     And it reports the error "the comment belongs to the expression starting in line 3"
 

data/features/configuration_via_source_comments/well_formed_source_comments.feature

@@ -48,7 +48,7 @@ Feature: Well formed source comments are handled properly
     And it reports:
       """
       enable_detector_explicitly.rb -- 1 warning:
-        [3]:TooManyInstanceVariables: Alfa has at least 5 instance variables [https://github.com/troessner/reek/blob/master/docs/Too-Many-Instance-Variables.md]
+        [3]:TooManyInstanceVariables: Alfa has at least 5 instance variables
       """
 
   Scenario: Configure smell detector with the basic exclude option as string
@@ -112,5 +112,5 @@ Feature: Well formed source comments are handled properly
     And it reports:
       """
       configure_detector_specific_option.rb -- 1 warning:
-        [3]:TooManyInstanceVariables: Alfa has at least 3 instance variables [https://github.com/troessner/reek/blob/master/docs/Too-Many-Instance-Variables.md]
+        [3]:TooManyInstanceVariables: Alfa has at least 3 instance variables
       """

data/features/locales.feature

@@ -0,0 +1,32 @@
+Feature: Handling different locales
+  In order to work in a variety of environments
+  As a developer
+  I want Reek to work properly in any locale
+
+  Scenario: Running Reek in an UTF-8 locale
+    Given I set the environment variable "LANG" to "en_US.utf8"
+    And a file "konnichiwa.rb" with:
+    """
+    puts 'こんにちは世界'
+    """
+    When I run reek -V konnichiwa.rb
+    Then it succeeds
+    And it reports no errors
+    And it reports:
+      """
+      konnichiwa.rb -- 0 warnings
+      """
+
+  Scenario: Running Reek in the POSIX locale
+    Given I set the environment variable "LANG" to "POSIX"
+    And a file "konnichiwa.rb" with:
+    """
+    puts 'こんにちは世界'
+    """
+    When I run reek -V konnichiwa.rb
+    Then it succeeds
+    And it reports no errors
+    And it reports:
+      """
+      konnichiwa.rb -- 0 warnings
+      """

data/features/rake_task/rake_task.feature

@@ -4,95 +4,135 @@ Feature: Reek can be driven through its Task
 
   Scenario: source_files points at the desired files
     Given the smelly file 'smelly.rb'
-    When I run rake reek with:
+    And a file "Rakefile" with:
       """
+      require 'reek/rake/task'
+
       Reek::Rake::Task.new do |t|
         t.source_files = 'smelly.rb'
-        t.reek_opts = '--no-color'
+        t.reek_opts = '--no-color --no-documentation'
       end
       """
+    When I run `rake reek`
     Then the exit status indicates an error
     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: source_files using a FileList instead of a String
     Given the smelly file 'smelly.rb'
-    When I run rake reek with:
+    And a file "Rakefile" with:
       """
+      require 'reek/rake/task'
+
       Reek::Rake::Task.new do |t|
         t.source_files = FileList['smelly.*']
-        t.reek_opts = '--no-color'
+        t.reek_opts = '--no-color --no-documentation'
       end
       """
+    When I run `rake reek`
     Then the exit status indicates an error
     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: name changes the task name
     Given the smelly file 'smelly.rb'
-    When I run rake silky with:
+    And a file "Rakefile" with:
       """
+      require 'reek/rake/task'
+
       Reek::Rake::Task.new('silky') do |t|
         t.source_files = 'smelly.rb'
-        t.reek_opts = '--no-color'
+        t.reek_opts = '--no-color --no-documentation'
       end
       """
+    When I run `rake silky`
     Then the exit status indicates an error
     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: verbose prints the reek command
     Given the smelly file 'smelly.rb'
-    When I run rake reek with:
+    And a file "Rakefile" with:
       """
+      require 'reek/rake/task'
+
       Reek::Rake::Task.new do |t|
         t.source_files = 'smelly.rb'
         t.verbose = true
       end
       """
+    When I run `rake reek`
     Then the exit status indicates an error
     And stdout includes "Running 'reek' rake command"
 
   Scenario: fail_on_error can hide the error status
     Given the smelly file 'smelly.rb'
-    When I run rake reek with:
+    And a file "Rakefile" with:
       """
+      require 'reek/rake/task'
+
       Reek::Rake::Task.new do |t|
         t.fail_on_error = false
         t.source_files = 'smelly.rb'
-        t.reek_opts = '--no-color'
+        t.reek_opts = '--no-color --no-documentation'
       end
       """
+    When I run `rake reek`
     Then it reports no errors
     And it succeeds
     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: can be configured with config_file
     Given the smelly file 'smelly.rb'
     And a configuration file 'full_mask.reek'
-    When I run rake reek with:
+    And a file "Rakefile" with:
       """
+      require 'reek/rake/task'
+
       Reek::Rake::Task.new do |t|
         t.config_file  = 'full_mask.reek'
         t.source_files = 'smelly.rb'
       end
       """
+    When I run `rake reek`
     Then it succeeds
     And it reports nothing
+
+  Scenario: REEK_SRC overrides the files to check
+    Given the smelly file 'smelly.rb'
+    And the clean file 'clean.rb'
+    And a file "Rakefile" with:
+      """
+      require 'reek/rake/task'
+
+      Reek::Rake::Task.new do |t|
+        t.source_files = 'clean.rb'
+        t.reek_opts = '--no-color --no-documentation'
+      end
+      """
+    When I set the environment variable "REEK_SRC" to "smelly.rb"
+    And I run `rake reek`
+    Then the exit status indicates an error
+    And it reports:
+      """
+      smelly.rb -- 2 warnings:
+        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
+      """

data/features/reports/codeclimate.feature

@@ -0,0 +1,59 @@
+Feature: Report smells using Code Climate format
+  In order to run as an Engine on Code Climate, output format following their
+  spec.
+
+  Scenario: output is empty when there are no smells
+    Given a directory called 'clean' containing two clean files
+    When I run reek --format code_climate clean
+    Then it succeeds
+    And it reports this Code Climate output:
+    """
+    """
+
+  Scenario: Indicate smells and print them as JSON when using files
+    Given the smelly file 'smelly.rb'
+    When I run reek --format code_climate smelly.rb
+    Then it reports this Code Climate output:
+      """
+      {
+        "type": "issue",
+        "check_name": "UncommunicativeMethodName",
+        "description": "Smelly#x has the name 'x'",
+        "categories": [
+          "Complexity"
+        ],
+        "location": {
+          "path": "smelly.rb",
+          "lines": {
+            "begin": 4,
+            "end": 4
+          }
+        },
+        "remediation_points": 150000,
+        "content": {
+          "body": "An `Uncommunicative Method Name` is a method name that doesn't communicate its intent well enough.\n\nPoor 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.\n"
+        },
+        "fingerprint": "2b41a3a4bb7de31ac4f5944bf68b7f5f"
+      }
+      NULL_BYTE_CHARACTER
+      {
+        "type": "issue",
+        "check_name": "UncommunicativeVariableName",
+        "description": "Smelly#x has the variable name 'y'",
+        "categories": [
+          "Complexity"
+        ],
+        "location": {
+          "path": "smelly.rb",
+          "lines": {
+            "begin": 5,
+            "end": 5
+          }
+        },
+        "remediation_points": 150000,
+        "content": {
+          "body": "An `Uncommunicative Variable Name` is a variable name that doesn't communicate its intent well enough.\n\nPoor 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.\n"
+        },
+        "fingerprint": "72f0dc8f8da5f9d7b8b29318636e5609"
+      }
+      """

data/features/reports/json.feature

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