reek 6.0.2 → 6.2.0

data/features/command_line_interface/options.feature

@@ -1,123 +0,0 @@
-Feature: Reek can be controlled using command-line options
-  In order to change Reek's default behaviour
-  As a developer
-  I want to supply options on the command line
-
-  Scenario: return non-zero status on bad option
-    When I run reek --no-such-option
-    Then the exit status indicates an error
-    And it reports the error "Error: invalid option: --no-such-option"
-    And there is no output on stdout
-
-  Scenario: display the current version number
-    When I run reek --version
-    Then it succeeds
-    And it reports the current version
-
-  Scenario: return given status code when using --failure-exit-code
-    Given the smelly file 'smelly.rb'
-    When I run reek smelly.rb --failure-exit-code 23
-    Then the exit status is 23
-
-  Scenario: return given status code when using --success-exit-code
-    Given the clean file "clean.rb"
-    When I run reek clean.rb --success-exit-code 42
-    Then the exit status is 42
-
-  Scenario: display the help information
-    When I run reek --help
-    Then it succeeds
-    And it reports:
-      """
-      Usage: reek [options] [files]
-
-      Examples:
-
-      reek lib/*.rb
-      reek -s lib
-      cat my_class.rb | reek
-
-      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 MissingSafeMethod source.rb
-                                           Check out https://github.com/troessner/reek/blob/v6.0.2/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
-
-      Report format:
-          -f, --format FORMAT              Report smells in the given format:
-                                             html
-                                             text (default)
-                                             yaml
-                                             json
-                                             xml
-
-      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-]documentation         Show link to related documentation page for each smell (default: true)
-              --[no-]show-configuration-path
-                                           Show which configuration file Reek is using (default: false)
-          -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)
-              --sort-by SORTING            Sort reported files by the given criterium:
-                                             smelliness ("smelliest" files first)
-                                             none (default - output in processing order)
-              --force-exclusion            Force excluding files specified in the configuration `exclude_paths`
-                                             even if they are explicitly passed as arguments
-
-     Exit codes:
-              --success-exit-code CODE     The exit code when no smells are found (default: 0)
-              --failure-exit-code CODE     The exit code when smells are found (default: 2)
-
-      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/v6.0.2/docs/Code-Smells.md for a details on each detector
-      """

data/features/command_line_interface/show_progress.feature

@@ -1,33 +0,0 @@
-Feature: Show progress
-  In order to see the progress of the examiners
-  As a developer
-  I want to be able to selectively activate progress reporting
-
-  # Note that --progress is the default on TTYs, but needs to be explicitely
-  # enabled here because output in the cucumber scenarios does not go to a TTY.
-  Scenario: shows progress output on mixed files by default
-    Given a directory called 'mixed_files' containing some clean and smelly files
-    When I run reek --progress mixed_files
-    Then the exit status indicates smells
-    And it reports:
-      """
-      Inspecting 2 file(s):
-      .S
-
-      mixed_files/dirty.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      2 total warnings
-      """
-
-  Scenario: --no-progress disables progress output
-    Given a directory called 'mixed_files' containing some clean and smelly files
-    When I run reek --no-progress mixed_files
-    Then the exit status indicates smells
-    And it reports:
-      """
-      mixed_files/dirty.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      2 total warnings
-      """

data/features/command_line_interface/smell_selection.feature

@@ -1,15 +0,0 @@
-Feature: Smell selection
-  In order to focus on particular code smells
-  As a developer
-  I want to be able to selectively activate smell detectors
-
-  Scenario: --smell selects a smell to detect
-    Given the smelly file 'smelly.rb'
-    And a configuration file 'partial_mask.reek'
-    When I run reek --no-line-numbers --smell UncommunicativeVariableName smelly.rb
-    Then the exit status indicates smells
-    And it reports:
-      """
-      smelly.rb -- 1 warning:
-        UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      """

data/features/command_line_interface/smells_count.feature

@@ -1,38 +0,0 @@
-Feature: Reports total number of code smells
-  In order to monitor the total number of smells
-  Reek outputs the total number of smells among all files inspected.
-
-  Scenario: Does not output total number of smells when inspecting single file
-    Given the smelly file 'smelly.rb'
-    When I run reek 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: Output total number of smells when inspecting multiple files
-    Given a directory called 'smelly' containing two smelly files
-    When I run reek 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
-      """
-
-  Scenario: Output total number of smells even if total equals 0
-    Given a directory called 'clean' containing two clean files
-    When I run reek clean
-    Then it succeeds
-    And it reports:
-      """
-      0 total warnings
-      """

data/features/command_line_interface/stdin.feature

@@ -1,65 +0,0 @@
-Feature: Reek reads from $stdin when no files are given
-  In order to use reek with pipelines
-  As a developer
-  I want to pipe source code on stdin
-
-  Scenario: return zero status with no smells
-    When I pass "def simple() @fred = 3 end" to reek
-    Then it succeeds
-    And it reports nothing
-
-  Scenario: outputs nothing on empty stdin
-    When I pass "" to reek
-    Then it succeeds
-    And it reports nothing
-
-  Scenario: outputs header only on empty stdin in verbose mode
-    When I pass "" to reek -V
-    Then it succeeds
-    And it reports:
-      """
-      STDIN -- 0 warnings
-      """
-
-  Scenario: return non-zero status when there are smells
-    When I pass "class Turn; def y() @x = 3; end end" to reek
-    Then the exit status indicates smells
-    And it reports:
-      """
-      STDIN -- 3 warnings:
-        [1]:IrresponsibleModule: Turn has no descriptive comment
-        [1]:UncommunicativeMethodName: Turn#y has the name 'y'
-        [1]:UncommunicativeVariableName: Turn has the variable name '@x'
-      """
-
-  Scenario: syntax error causes the source to be ignored
-    When I pass "= invalid syntax =" to reek
-    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:
-      """
-      ---
-      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

@@ -1,87 +0,0 @@
-Feature: `accept` configuration setting
-  In order to have a more fine-grained control over what Reek reports
-  As a user
-  I want to be able to accept specific patterns and names to exclude them from reporting
-
-  Scenario: Accept names
-    Given a file named "config.reek" with:
-      """
-      ---
-      detectors:
-        UncommunicativeMethodName:
-          accept:
-            - m1
-            - m2
-        UncommunicativeParameterName:
-          accept:
-            - a1
-            - a2
-        UncommunicativeModuleName:
-          accept:
-            - C1
-        UncommunicativeVariableName:
-          accept:
-            - var1
-      """
-    And a file named "smelly.rb" with:
-      """
-      # Should not report UncommunicativeModuleName
-      class C1
-        # Should not report UncommunicativeMethodName and UncommunicativeParameterName
-        def m1(a1); a1; end
-        # Should not report UncommunicativeMethodName and UncommunicativeParameterName
-        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 -- 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
-    Given a file named "config.reek" with:
-      """
-      ---
-      detectors:
-        UncommunicativeMethodName:
-          accept:
-            - /oobar/
-        UncommunicativeParameterName:
-          accept:
-            - /ola/
-        UncommunicativeModuleName:
-          accept:
-            - /lassy/
-        UncommunicativeVariableName:
-          accept:
-            - /^var1/
-      """
-    And a file named "smelly.rb" with:
-      """
-      # Should not report UncommunicativeModuleName
-      class Classy1
-        # Should not report UncommunicativeMethodName and UncommunicativeParameterName
-        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 -- 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

@@ -1,274 +0,0 @@
-Feature: Directory directives
-  In order to have a more fine-grained control over what Reek reports
-  And to enable domain specific modes (like a Ruby on Rails mode)
-  As a user
-  I want to be able to configure Reek using directory directives
-
-  Scenario: Configure multiple directories
-    Given a file named "web_app/config.reek" with:
-      """
-      ---
-      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:
-      """
-      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
-      """
-    And a file named "web_app/app/helpers/application_helper.rb" with:
-      """
-      module ApplicationHelper
-        def current_year
-          Time.zone.now.year
-        end
-      end
-      """
-    And a file named "web_app/app/models/user.rb" with:
-      """
-      class User < ActiveRecord::Base
-        def logged_in_with_role(role)
-          true
-        end
-      end
-      """
-    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'
-    web_app/app/models/user.rb -- 2 warnings:
-      [1]:IrresponsibleModule: User has no descriptive comment
-      [2]:UnusedParameters: User#logged_in_with_role has unused parameter 'role'
-    3 total warnings
-    """
-
-  Scenario: Ignore trailing slashes
-    Given a file named "web_app/config.reek" with:
-      """
-      ---
-      directories:
-        "controllers/":
-          IrresponsibleModule:
-            enabled: false
-      """
-    And a file named "controllers/users_controller.rb" with:
-      """
-      class UsersController
-        def show
-        end
-      end
-      """
-    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:
-      """
-      ---
-      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:
-      """
-      class UsersController < ApplicationController
-        def show
-          respond_with do |format|
-            format.json { |json| @user.to_custom_json }
-          end
-        end
-      end
-      """
-    And a file named "web_app/app/helpers/application_helper.rb" with:
-      """
-      module ApplicationHelper
-        def current_year
-          Time.zone.now.year
-        end
-      end
-      """
-    And a file named "web_app/app/models/user.rb" with:
-      """
-      class User < ActiveRecord::Base
-        def logged_in_with_role(role)
-          true
-        end
-      end
-      """
-    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'
-      [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'
-    4 total warnings
-    """
-
-  Scenario: Use the default directive if there is no directory directive
-    Given a file named "config.reek" with:
-      """
-      ---
-      directories:
-        "web_app/app/controllers":
-          IrresponsibleModule:
-            enabled: true
-          NestedIterators:
-            enabled: false
-      detectors:
-        IrresponsibleModule:
-          enabled: false
-        NestedIterators:
-          enabled: true
-      """
-    And a file named "web_app/app/controllers/users_controller.rb" with:
-      """
-      class UsersController < ApplicationController
-        def show
-          respond_with do |format|
-            format.json { |json| @user.to_custom_json }
-          end
-        end
-      end
-      """
-    And a file named "other/projects_controller.rb" with:
-      """
-      class ProjectController < ApplicationController
-        def show
-          respond_with do |format|
-            format.json { |json| @project.to_custom_json }
-          end
-        end
-      end
-      """
-    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'
-      [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'
-      [1]:IrresponsibleModule: UsersController has no descriptive comment
-    4 total warnings
-    """
-
-  Scenario: Abort on non-existent smell type in directory directive
-    Given a file named "config.reek" with:
-      """
-      ---
-      directories:
-        "dummy_directory":
-          # Typo: Should be NestedIterators
-          IteratorsNested:
-            enabled: false
-      """
-    And a file named "dummy_directory/dummy.rb" with:
-      """
-      class Dummy
-      end
-      """
-
-    When I run reek -c config.reek dummy_directory/
-    Then the exit status indicates an error
-    And stderr reports:
-    """
-    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:
-      """
-      ---
-      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/
-    Then the exit status indicates an error
-    And stderr reports:
-    """
-    Error: `dummy_directory/dummy.rb` is supposed to be a directory but is a file
-
-    """
-
-  Scenario: In case of overlapping configurations, pick the most appropriate one
-    Given a file named "config.reek" with:
-      """
-      ---
-      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:
-      """
-      class Klass
-        def meth
-          respond_to do |arg|
-            answer_to do |arg|
-            end
-          end
-        end
-      end
-      """
-    And a file named "foo/bar/klazz.rb" with:
-      """
-      class Klazz
-        def meth
-          respond_to do |arg|
-            answer_to do |arg|
-            end
-          end
-        end
-      end
-      """
-    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
-    foo/bar/klazz.rb -- 1 warning:
-      [1]:IrresponsibleModule: Klazz has no descriptive comment
-    2 total warnings
-    """

data/features/configuration_files/exclude_directives.feature

@@ -1,35 +0,0 @@
-Feature: Exclude directives
-  In order to have a more fine-grained control over what Reek reports
-  As a user
-  I want to be able to exclude specific contexts from reporting
-
-  Scenario: Exclude multiple contexts
-    Given a file named "config.reek" with:
-      """
-      ---
-      detectors:
-        UncommunicativeMethodName:
-          exclude:
-            - "Smelly#x"
-        UnusedPrivateMethod:
-          enabled: true
-          exclude:
-            - "Smelly#foobar"
-      """
-    And a file named "smelly.rb" with:
-      """
-      class Smelly
-        # Should report IrresponsibleModule
-        def foo(arg); end # Should report UnusedParameter
-        def x; end        # Should not report UncommunicativeMethodName
-        private
-        def foobar; end   # Should not report UnusedPrivateMethod
-      end
-      """
-    When I run reek -c config.reek smelly.rb
-    Then it reports:
-    """
-    smelly.rb -- 2 warnings:
-      [1]:IrresponsibleModule: Smelly has no descriptive comment
-      [3]:UnusedParameters: Smelly#foo has unused parameter 'arg'
-    """