reek 6.0.2 → 6.2.0

data/features/configuration_via_source_comments/well_formed_source_comments.feature

@@ -1,116 +0,0 @@
-Feature: Well formed source comments are handled properly
-  As a developer I want to be able to have a fine-grained control
-  over how Reek handles smells via source code comments.
-
-  Scenario: Disable smell detector implicitly
-    Given a file named "disable_detector_implicitly.rb" with:
-      """
-      # Test class
-      # :reek:TooManyInstanceVariables
-      class Alfa
-        def initialize
-          @charlie = @delta = @echo = @foxtrot = @hotel = 1
-        end
-      end
-      """
-    When I run reek disable_detector_implicitly.rb
-    Then it succeeds
-    And it reports nothing
-
-  Scenario: Disable smell detector explicitly
-    Given a file named "disable_detector_explicitly.rb" with:
-      """
-      # Test class
-      # :reek:TooManyInstanceVariables { enabled: false }
-      class Alfa
-        def initialize
-          @charlie = @delta = @echo = @foxtrot = @hotel = 1
-        end
-      end
-      """
-    When I run reek disable_detector_explicitly.rb
-    Then it succeeds
-    And it reports nothing
-
-  Scenario: Enable smell detector explicitly
-    Given a file named "enable_detector_explicitly.rb" with:
-      """
-      # Test class
-      # :reek:TooManyInstanceVariables { enabled: true }
-      class Alfa
-        def initialize
-          @charlie = @delta = @echo = @foxtrot = @hotel = 1
-        end
-      end
-      """
-    When I run reek enable_detector_explicitly.rb
-    Then the exit status indicates smells
-    And it reports:
-      """
-      enable_detector_explicitly.rb -- 1 warning:
-        [3]:TooManyInstanceVariables: Alfa has at least 5 instance variables
-      """
-
-  Scenario: Configure smell detector with the basic exclude option as string
-    Given a file named "configure_exclude_option.rb" with:
-      """
-      # Test class
-      # :reek:TooManyInstanceVariables { exclude: '@hotel' }
-      class Alfa
-        def initialize
-          @charlie = @delta = @echo = @foxtrot = @hotel = 1
-        end
-      end
-      """
-    When I run reek configure_exclude_option.rb
-    Then it succeeds
-    And it reports nothing
-
-  Scenario: Configure smell detector with the basic exclude option as regex
-    Given a file named "configure_exclude_option.rb" with:
-      """
-      # Test class
-      # :reek:TooManyInstanceVariables { exclude: /hotel/ }
-      class Alfa
-        def initialize
-          @charlie = @delta = @echo = @foxtrot = @hotel = 1
-        end
-      end
-      """
-    When I run reek configure_exclude_option.rb
-    Then it succeeds
-    And it reports nothing
-
-  Scenario: Configure smell detector with a detector specific option that silences it
-    Given a file named "configure_detector_specific_option.rb" with:
-    """
-      # Test class
-      # :reek:TooManyInstanceVariables { max_instance_variables: 5 }
-      class Alfa
-        def initialize
-          @charlie = @delta = @echo = @foxtrot = @hotel = 1
-        end
-      end
-      """
-    When I run reek configure_detector_specific_option.rb
-    Then it succeeds
-    And it reports nothing
-
-  Scenario: Configure smell detector with a detector specific option that makes it report again
-    Given a file named "configure_detector_specific_option.rb" with:
-    """
-      # Test class
-      # :reek:TooManyInstanceVariables { max_instance_variables: 2 }
-      class Alfa
-        def initialize
-          @charlie = @delta = @echo = 1
-        end
-      end
-      """
-    When I run reek configure_detector_specific_option.rb
-    Then the exit status indicates smells
-    And it reports:
-      """
-      configure_detector_specific_option.rb -- 1 warning:
-        [3]:TooManyInstanceVariables: Alfa has at least 3 instance variables
-      """

data/features/locales.feature

@@ -1,32 +0,0 @@
-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/programmatic_access.feature

@@ -1,41 +0,0 @@
-Feature: Using Reek programmatically
-  In order to use Reek from inside my program
-  As a developer
-  I want to be able to use its classes
-
-  Scenario: Accessing smells found by an examiner
-    Given the smelly file 'smelly.rb'
-    And a file named "examine.rb" with:
-      """
-      require 'reek'
-      examiner = Reek::Examiner.new(File.new('smelly.rb'))
-      examiner.smells.each do |smell|
-        puts smell.message
-      end
-      """
-    When I run `ruby examine.rb`
-    Then it reports no errors
-    And it reports:
-      """
-      has the name 'x'
-      has the variable name 'y'
-      """
-
-  Scenario: Using Reek's built-in report classes
-    Given the smelly file 'smelly.rb'
-    And a file named "examine.rb" with:
-      """
-      require 'reek'
-      examiner = Reek::Examiner.new(File.new('smelly.rb'))
-      report = Reek::Report::TextReport.new
-      report.add_examiner examiner
-      report.show
-      """
-    When I run `ruby examine.rb`
-    Then it reports no errors
-    And it reports:
-      """
-      smelly.rb -- 2 warnings:
-        UncommunicativeMethodName: Smelly#x has the name 'x'
-        UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      """

data/features/rake_task/rake_task.feature

@@ -1,138 +0,0 @@
-Feature: Reek can be driven through its Task
-  Reek provides an easy way to integrate its use into Rakefiles,
-  via the Task class. These scenarios test its various options.
-
-  Scenario: source_files points at the desired files
-    Given the smelly file 'smelly.rb'
-    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 --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'
-        [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'
-    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 --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'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      """
-
-  Scenario: name changes the task name
-    Given the smelly file 'smelly.rb'
-    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 --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'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      """
-
-  Scenario: verbose prints the reek command
-    Given the smelly file 'smelly.rb'
-    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'
-    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 --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'
-        [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'
-    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

@@ -1,59 +0,0 @@
-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 the code climate reek runner
-    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 the code climate reek runner
-    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

@@ -1,59 +0,0 @@
-Feature: Report smells using simple JSON layout
-  In order to parse Reek's output simply and consistently, simply
-  output a list of smells in JSON.
-
-  Scenario: output is empty when there are no smells
-    Given a directory called 'clean' containing two clean files
-    When I run reek --format json clean
-    Then it succeeds
-    And it reports this JSON:
-    """
-    []
-    """
-
-  Scenario: Indicate smells and print them as JSON when using files
-    Given the smelly file 'smelly.rb'
-    When I run reek --format json smelly.rb
-    Then the exit status indicates smells
-    And it reports this JSON:
-      """
-      [
-          {
-              "smell_type": "UncommunicativeMethodName",
-              "source": "smelly.rb",
-              "context": "Smelly#x",
-              "lines": [ 4 ],
-              "message": "has the name 'x'",
-              "documentation_link": "https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Method-Name.md",
-              "name": "x"
-          },
-          {
-              "smell_type": "UncommunicativeVariableName",
-              "source": "smelly.rb",
-              "context": "Smelly#x",
-              "lines": [ 5 ],
-              "message": "has the variable name 'y'",
-              "documentation_link": "https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Variable-Name.md",
-              "name": "y"
-          }
-      ]
-      """
-
-  Scenario: Indicate smells and print them as JSON when using STDIN
-    When I pass "class Turn; end" to reek --format json
-    Then the exit status indicates smells
-    And it reports this JSON:
-      """
-      [
-          {
-              "smell_type": "IrresponsibleModule",
-              "source": "STDIN",
-              "context": "Turn",
-              "lines": [
-                  1
-              ],
-              "message": "has no descriptive comment",
-              "documentation_link": "https://github.com/troessner/reek/blob/v6.0.2/docs/Irresponsible-Module.md"
-          }
-      ]
-      """

data/features/reports/reports.feature

@@ -1,219 +0,0 @@
-Feature: Correctly formatted reports
-  In order to get the most out of Reek
-  As a developer
-  I want to be able to parse Reek's output simply and consistently
-
-  Scenario Outline: two reports run together with indented smells
-    Given a directory called 'smelly' containing two smelly files
-    When I run reek <args>
-    Then the exit status indicates smells
-    And it reports:
-      """
-      smelly/dirty_one.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      smelly/dirty_two.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      4 total warnings
-      """
-
-    Examples:
-      | args                                    |
-      | smelly/dirty_one.rb smelly/dirty_two.rb |
-      | smelly                                  |
-
-  Scenario Outline: No sorting (which means report each file as it is read in)
-    Given a directory called 'smelly' containing two smelly files
-    When I run reek <option> smelly
-    Then the exit status indicates smells
-    And it reports:
-      """
-      smelly/dirty_one.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      smelly/dirty_two.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      4 total warnings
-      """
-
-    Examples:
-      | option         |
-      |                |
-      | --sort-by none |
-      | --sort-by n    |
-
-  Scenario Outline: Sort by issue count
-    Given a directory called 'smelly' containing two smelly files
-    When I run reek <option> smelly
-    Then the exit status indicates smells
-    And it reports:
-      """
-      smelly/dirty_two.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      smelly/dirty_one.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      4 total warnings
-      """
-
-    Examples:
-      | option               |
-      | --sort-by smelliness |
-      | --sort-by s          |
-
-  Scenario: good files show no headings by default
-    Given a directory called 'clean' containing two clean files
-    When I run reek clean
-    Then it succeeds
-    And it reports:
-      """
-      0 total warnings
-      """
-
-  Scenario Outline: --empty-headings turns on headings for fragrant files
-    Given a directory called 'clean' containing two clean files
-    When I run reek <option> clean
-    Then it succeeds
-    And it reports:
-      """
-      clean/clean_one.rb -- 0 warnings
-      clean/clean_two.rb -- 0 warnings
-      0 total warnings
-      """
-
-    Examples:
-      | option            |
-      | --empty-headings  |
-      | -V                |
-
-  Scenario Outline: --no-empty-headings turns off headings for fragrant files
-    Given a directory called 'clean' containing two clean files
-    When I run reek <option> clean
-    Then it succeeds
-    And it reports:
-      """
-      0 total warnings
-      """
-
-    Examples:
-      | option                 |
-      | --no-empty-headings    |
-      | -V --no-empty-headings |
-
-  Scenario Outline: --no-line-numbers turns off 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'
-        UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      """
-
-    Examples:
-      | option               |
-      | --no-line-numbers    |
-      | --no-line-numbers -V |
-      | -V --no-line-numbers |
-
-  Scenario Outline: --line-numbers turns on 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:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      """
-
-    Examples:
-      | option                           |
-      | --line-numbers                   |
-      | --no-line-numbers --line-numbers |
-      | --no-line-numbers -n             |
-
-  Scenario Outline: --single-line shows filename and one line number
-    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:
-        smelly.rb:4: UncommunicativeMethodName: Smelly#x has the name 'x'
-        smelly.rb:5: UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      """
-
-    Examples:
-      | option        |
-      | -s            |
-      | --single-line |
-      | -s -V         |
-      | -V -s         |
-
-  Scenario Outline: Extra slashes aren't added to directory names
-    Given a directory called 'smelly' containing two smelly files
-    When I run reek <args>
-    Then the exit status indicates smells
-    And it reports:
-      """
-      smelly/dirty_one.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      smelly/dirty_two.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      4 total warnings
-      """
-
-    Examples:
-      | args    |
-      | smelly/ |
-      | smelly  |
-
-  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/v6.0.2/docs/Uncommunicative-Method-Name.md]
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Variable-Name.md]
-      """
-
-    Examples:
-      | option           |
-      | -U               |
-      | --documentation  |
-
-  Scenario: --no-documentation drops links from smell warnings
-    Given the smelly file 'smelly.rb'
-    When I run reek --no-documentation smelly.rb
-    Then the exit status indicates smells
-    And it reports:
-      """
-      smelly.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      """
-
-  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/v6.0.2/docs/Uncommunicative-Method-Name.md]
-        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Variable-Name.md]
-      """
-
-    Examples:
-      | option                             |
-      | --no-line-numbers -U               |
-      | --no-line-numbers --documentation  |