reek 6.0.1 → 6.0.5

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

data/features/configuration_files/exclude_paths_directives.feature

@@ -1,42 +0,0 @@
-Feature: Exclude paths directives
-  In order to avoid Reek wasting time on files that cannot be fixed
-  As a user
-  I want to be able to exclude specific paths from being checked
-
-  Scenario: Exclude paths
-    Given the smelly file "smelly.rb" in the directory "smelly_sources"
-    And the smelly file "smelly.rb" in the directory "smelly_as_well"
-    And the smelly file "smelly.rb" in the directory "smelly_as_well_2"
-    When I run reek .
-    Then the exit status indicates smells
-    Given a file named "config.reek" with:
-      """
-      ---
-      exclude_paths:
-        - smelly_sources/smelly.rb
-        - smelly_as_well/
-        - smelly_as_well_2
-      """
-    When I run reek -c config.reek .
-    Then it succeeds
-    And it reports nothing
-
-  Scenario: Using a file name within an excluded directory
-    Given a file named "bad_files_live_here/smelly.rb" with:
-      """
-      # A smelly example class
-      class Smelly
-        def alfa(bravo); end
-      end
-      """
-    And a file named "config.reek" with:
-      """
-      ---
-      exclude_paths:
-        - bad_files_live_here
-      """
-    When I run reek -c config.reek bad_files_live_here/smelly.rb
-    Then the exit status indicates smells
-    When I run reek -c config.reek --force-exclusion bad_files_live_here/smelly.rb
-    Then it succeeds
-    And it reports nothing

data/features/configuration_files/masking_smells.feature

@@ -1,94 +0,0 @@
-Feature: Masking smells using config files
-  In order to keep my reports meaningful
-  As a developer
-  I want to mask some smells using config files
-
-  Scenario: corrupt config file prevents normal output
-    Given the smelly file 'smelly.rb'
-    And a configuration file 'corrupt.reek'
-    When I run reek -c corrupt.reek smelly.rb
-    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
-
-  Scenario: missing source file is an error
-    When I run reek not_here.rb
-    Then it reports the error "Error: No such file - not_here.rb"
-
-  Scenario: masking smells in the configuration file
-    Given the smelly file 'smelly.rb'
-    And a configuration file 'full_mask.reek'
-    When I run reek -c full_mask.reek smelly.rb
-    Then it succeeds
-    And it reports nothing
-
-  Scenario: allow masking some calls for duplication smell
-    Given the smelly file 'smelly.rb'
-    And a configuration file 'partial_mask.reek'
-    When I run reek -c partial_mask.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: provide extra masking inline in comments
-    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
-    And it reports nothing
-
-  Scenario: empty config file outputs normally
-    Given the smelly file 'smelly.rb'
-    And a configuration file 'empty.reek'
-    When I run reek -c empty.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: Disable UtilityFunction for non-public methods
-    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:
-        [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