reek 6.0.2 → 6.2.0

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

data/features/configuration_files/mix_accept_reject_setting.feature

@@ -1,84 +0,0 @@
-Feature: Mix `accept` and `reject` configuration settings
-  In order to have a more fine-grained control over what Reek reports
-  As a user
-  I want to be able to mix the `accept` and `reject` setting
-
-  Scenario: UncommunicativeMethodName
-    Given a file named "config.reek" with:
-      """
-      ---
-      detectors:
-        UncommunicativeMethodName:
-          accept:
-            - x
-            - meth1
-          reject:
-            - helper
-            - foobar
-      """
-    And a file named "smelly.rb" with:
-      """
-      def x; end # Should not be reported
-      def meth1; end # Should not be reported
-      def foobar; end # Should be reported
-      def awesome_helper; end # Should be reported
-      """
-    When I run reek -c config.reek smelly.rb
-    Then it reports:
-    """
-    smelly.rb -- 2 warnings:
-      [4]:UncommunicativeMethodName: awesome_helper has the name 'awesome_helper'
-      [3]:UncommunicativeMethodName: foobar has the name 'foobar'
-    """
-
-  Scenario: UncommunicativeModuleName
-    Given a file named "config.reek" with:
-      """
-      ---
-      detectors:
-        IrresponsibleModule:
-          enabled: false
-        UncommunicativeModuleName:
-          accept:
-            - lassy
-            - M
-          reject:
-            - Helper
-      """
-    And a file named "smelly.rb" with:
-      """
-      class Classy1; end # Should not be reported
-      class M; end # Should not be reported
-      class BaseHelper; end # Should be reported
-      """
-    When I run reek -c config.reek smelly.rb
-    Then it reports:
-    """
-    smelly.rb -- 1 warning:
-      [3]:UncommunicativeModuleName: BaseHelper has the name 'BaseHelper'
-    """
-
-  Scenario: UncommunicativeParameterName
-    Given a file named "config.reek" with:
-      """
-      ---
-      detectors:
-        UncommunicativeParameterName:
-          accept:
-            - x
-            - arg1
-          reject:
-            - foobar
-      """
-    And a file named "smelly.rb" with:
-      """
-      def omg(x); x; end # Should not be reported
-      def omg(arg1); arg1; end # Should not be reported
-      def omg(foobar); foobar; end # Should be reported
-      """
-    When I run reek -c config.reek smelly.rb
-    Then it reports:
-    """
-    smelly.rb -- 1 warning:
-      [3]:UncommunicativeParameterName: omg has the parameter name 'foobar'
-    """

data/features/configuration_files/reject_setting.feature

@@ -1,89 +0,0 @@
-Feature: `reject` configuration setting
-  In order to have a more fine-grained control over what Reek reports
-  As a user
-  I want to be able to reject specific patterns and names to include them into reporting
-
-  Scenario: reject names
-    Given a file named "config.reek" with:
-      """
-      ---
-      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:
-      """
-      # 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 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 -- 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
-    Given a file named "config.reek" with:
-      """
-      ---
-      detectors:
-        UncommunicativeMethodName:
-          accept:
-            - /oobar/
-        UncommunicativeParameterName:
-          accept:
-            - /ola/
-        UncommunicativeModuleName:
-          accept:
-            - /lassy/
-        UncommunicativeVariableName:
-          reject:
-            - /^fine_name/
-      """
-    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
-        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 -- 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

@@ -1,59 +0,0 @@
-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.yml 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
-    """
-    And a directory named "lib/legacy"
-    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/show_configuration_file.feature

@@ -1,44 +0,0 @@
-Feature: Show configuration file
-  With Reeks dynamic mechanism of finding a configuration file you might run into a situation where you are not
-  100% sure what configuration file Reek is using. E.g. you have a project specific configuration file in your
-  project root and also another Reek configuration in your HOME directory that you use for all your other projects
-  and for whatever reasons Reek seems to be using another configuration file than the one you assumed it would.
-  In this case you can pass the flag `--show-configuration-path` to Reek which will cause Reek to output the path
-  to the configuration file it is using.
-
-  Scenario: Default configuration file present
-    Given the clean file "clean.rb"
-    And an empty file named ".reek.yml"
-    When I run reek --show-configuration-path clean.rb
-    Then it reports:
-      """
-      Using '.reek.yml' as configuration file.
-      """
-
-  Scenario: Non-default configuration file passed via CLI
-    Given the clean file "clean.rb"
-    And an empty file named "config.reek"
-    When I run reek --show-configuration-path -c config.reek clean.rb
-    Then it reports:
-      """
-      Using 'config.reek' as configuration file.
-      """
-
-  Scenario: Display the right configuration file even when there are multiple files present
-    Given the clean file "clean.rb"
-    And an empty file named ".reek.yml"
-    And an empty file named "config.reek"
-    When I run reek --show-configuration-path -c config.reek clean.rb
-    Then it reports:
-      """
-      Using 'config.reek' as configuration file.
-      """
-
-  Scenario: Use configuration file we find when traversing up the directory tree
-    Given the clean file "clean.rb"
-    And with a configuration file that is further up in the directory tree
-    When I run reek --show-configuration-path clean.rb
-    Then it reports:
-      """
-      Using '../../.reek.yml' as configuration file.
-      """

data/features/configuration_files/unused_private_method.feature

@@ -1,68 +0,0 @@
-Feature: Unused Private Method detector
-  This detector is a little special in the sense that it takes class contexts but analyzes
-  methods (and thus, is configured in regards to methods) so we need to make sure
-  that our configuration handling still works.
-
-  Scenario: Differentiate between contexts when excluding them
-    Given a file named "config.reek" with:
-      """
-      ---
-      detectors:
-        IrresponsibleModule:
-          enabled: false
-        UnusedPrivateMethod:
-          enabled: true
-          exclude:
-            - Outer::Awesome#foobar
-      """
-    And a file named "sample.rb" with:
-      """
-      module Outer
-        class Smelly
-          private
-          def foobar; end # Should report UnusedPrivateMethod
-        end
-        class Awesome
-          private
-          def foobar; end # Should not report UnusedPrivateMethod
-        end
-      end
-      """
-    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'
-    """
-
-  Scenario: Use regexes for excluding contexts
-    Given a file named "config.reek" with:
-      """
-      ---
-      detectors:
-        IrresponsibleModule:
-          enabled: false
-        UnusedPrivateMethod:
-          enabled: true
-          exclude:
-            - wesome#foo
-      """
-    And a file named "sample.rb" with:
-      """
-      module Outer
-        class Smelly
-          private
-          def foobar; end # Should report UnusedPrivateMethod
-        end
-        class Awesome
-          private
-          def foobar; end # Should not report UnusedPrivateMethod
-        end
-      end
-      """
-    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'
-    """

data/features/configuration_loading.feature

@@ -1,91 +0,0 @@
-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.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.
-    - Your HOME directory
-    Reek will check these in order and stop after the first file found.
-
-  Scenario: Default configuration
-    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: Configuration via CLI
-    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 reports no errors
-    And it succeeds
-
-  Scenario: Configuration file in working directory
-    Given the smelly file 'smelly.rb'
-    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: 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/configuration_via_source_comments/erroneous_source_comments.feature

@@ -1,68 +0,0 @@
-Feature: Erroneous source comments are handled properly
-  Erroneous source comments should be handled in a way that is intuitive and helpful
-  for the user. Reek should neither crash nor silently swallow it.
-  If there is something wrong - no matter how small it is - Reek should report it back
-  to the user right away so the user can actually do something about it.
-  If a user tries to deactivate an unknown smell detector (e.g. because he made a typo)
-  we should just skip this file and tell the user about it so he can fix it and then
-  re-run Reek.
-
-  Scenario: Unknown smell detector
-    Given a file named "bad_comment.rb" with:
-      """
-      # Test class
-      # :reek:UnknownDetectorName
-      def x
-      end
-      """
-    When I run reek bad_comment.rb
-    Then it reports the error "Error: You are trying to configure an unknown smell detector 'UnknownDetectorName'"
-
-  Scenario: One good file, one bad file
-    Given a file named "bad_comment.rb" with:
-      """
-      # Test class
-      # :reek:UnknownDetectorName
-      def x
-      end
-      """
-    Given the smelly file 'smelly.rb'
-    When I run reek bad_comment.rb smelly.rb
-    Then it reports the error "Error: You are trying to configure an unknown smell detector 'UnknownDetectorName'"
-    And 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'
-      2 total warnings
-      """
-
-  Scenario: Garbage as content
-    Given a file named "bad_comment.rb" with:
-      """
-      # Test class
-      # :reek:UncommunicativeMethodName { thats: a: bad: config }
-      def x
-      end
-      """
-    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 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"
-
-  Scenario: Bad configuration key
-    Given a file named "bad_comment.rb" with:
-      """
-      # Test class
-      # exclude -> elude and accept -> accipt are bad keys
-      # :reek:UncommunicativeMethodName { elude: 'foo', accipt: 'bar' }
-      def x
-      end
-      """
-    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 "in one of your source code comments with the unknown option 'elude', 'accipt'"
-    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 4"