reek 6.0.2 → 6.5.0

data/features/todo_list.feature

@@ -1,108 +0,0 @@
-Feature: Auto-generate a todo file
-  Write a Reek configuration as a kind of todo list that will prevent Reek
-  from reporting smells on the current code. This can then be worked on later on.
-  The main goal here would be to ease the Reek adoption by allowing developers to
-  introduce Reek right away (e.g. for CI), exclude the "old" smells from getting reported
-  and then fix them step by step.
-
-  Scenario: Generate the default configuration file that disables all found smells
-    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'
-      """
-    When I run reek --todo smelly.rb
-    Then it succeeds
-    And it reports:
-      """
-
-      '.reek.yml' generated! You can now use this as a starting point.
-      """
-    And a file named ".reek.yml" should exist
-    And the file ".reek.yml" should contain:
-      """
-      ---
-      detectors:
-        UncommunicativeMethodName:
-          exclude:
-          - Smelly#x
-        UncommunicativeVariableName:
-          exclude:
-          - Smelly#x
-      """
-    When I run reek smelly.rb
-    Then it succeeds
-
-  Scenario: Reacts appropiately when there are no smells
-    Given the clean file "clean.rb"
-    When I run reek --todo clean.rb
-    Then a file named ".reek.yml" should not exist
-    And it reports:
-      """
-
-      No smells found - nothing to do, exiting.
-      """
-
-  Scenario: Don't overwrite existing .reek.yml files
-    Given the smelly file 'smelly.rb'
-    And a file named ".reek.yml" with:
-      """
-      ---
-      detectors:
-        UncommunicativeMethodName:
-          enabled: false
-      """
-    When I run reek smelly.rb
-    Then it reports:
-      """
-      smelly.rb -- 1 warning:
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      """
-    When I run reek --todo smelly.rb
-    Then it reports:
-      """
-
-      Existing '.reek.yml' detected - aborting.
-      """
-    When I run reek smelly.rb
-    Then it reports:
-      """
-      smelly.rb -- 1 warning:
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      """
-
-  Scenario: Ignore existing other configuration files that are passed explicitly
-    Given the smelly file 'smelly.rb'
-    And a file named "config.reek" with:
-      """
-      ---
-      detectors:
-        UncommunicativeMethodName:
-          enabled: false
-      """
-    When I run reek -c config.reek smelly.rb
-    Then it reports:
-      """
-      smelly.rb -- 1 warning:
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      """
-    When I run reek -c config.reek --todo smelly.rb
-    Then it succeeds
-    And a file named ".reek.yml" should exist
-    And the file ".reek.yml" should contain:
-      """
-      ---
-      detectors:
-        UncommunicativeMethodName:
-          exclude:
-          - Smelly#x
-        UncommunicativeVariableName:
-          exclude:
-          - Smelly#x
-      """
-    When I run reek smelly.rb
-    Then it reports nothing

data/lib/reek/configuration/schema.yml

@@ -1,210 +0,0 @@
----
-type: map
-mapping:
-  "detectors":
-    type: map
-    mapping: &all_detectors
-      Attribute:
-        type: map
-        mapping: &detector_base
-          "enabled":
-            type: bool
-          "exclude":
-            type: seq
-            sequence:
-              - type: str
-      BooleanParameter:
-        type: map
-        mapping:
-          <<: *detector_base
-      ClassVariable:
-        type: map
-        mapping:
-          <<: *detector_base
-      ControlParameter:
-        type: map
-        mapping:
-          <<: *detector_base
-      DataClump:
-        type: map
-        mapping:
-          <<: *detector_base
-          max_copies:
-            type: number
-          min_clump_size:
-            type: number
-      DuplicateMethodCall:
-        type: map
-        mapping:
-          <<: *detector_base
-          max_calls:
-            type: number
-          allow_calls:
-            type: seq
-            sequence:
-              - type: str
-      FeatureEnvy:
-        type: map
-        mapping:
-          <<: *detector_base
-      InstanceVariableAssumption:
-        type: map
-        mapping:
-          <<: *detector_base
-      IrresponsibleModule:
-        type: map
-        mapping:
-          <<: *detector_base
-      LongParameterList:
-        type: map
-        mapping:
-          <<: *detector_base
-          max_params:
-            type: number
-          overrides:
-            type: map
-            mapping:
-              initialize:
-                type: map
-                mapping:
-                  max_params:
-                    type: number
-      LongYieldList:
-        type: map
-        mapping:
-          <<: *detector_base
-          max_params:
-            type: number
-      ManualDispatch:
-        type: map
-        mapping:
-          <<: *detector_base
-      MissingSafeMethod:
-        type: map
-        mapping:
-          <<: *detector_base
-      ModuleInitialize:
-        type: map
-        mapping:
-          <<: *detector_base
-      NestedIterators:
-        type: map
-        mapping:
-          <<: *detector_base
-          max_allowed_nesting:
-            type: number
-          ignore_iterators:
-            type: seq
-            sequence:
-              - type: str
-      NilCheck:
-        type: map
-        mapping:
-          <<: *detector_base
-      RepeatedConditional:
-        type: map
-        mapping:
-          <<: *detector_base
-          max_ifs:
-            type: number
-      SubclassedFromCoreClass:
-        type: map
-        mapping:
-          <<: *detector_base
-      Syntax:
-        type: map
-        mapping:
-          <<: *detector_base
-      TooManyConstants:
-        type: map
-        mapping:
-          <<: *detector_base
-          max_constants:
-            type: number
-      TooManyInstanceVariables:
-        type: map
-        mapping:
-          <<: *detector_base
-          max_instance_variables:
-            type: number
-      TooManyMethods:
-        type: map
-        mapping:
-          <<: *detector_base
-          max_methods:
-            type: number
-      TooManyStatements:
-        type: map
-        mapping:
-          <<: *detector_base
-          max_statements:
-            type: number
-      UncommunicativeMethodName:
-        type: map
-        mapping:
-          <<: *detector_base
-          reject: &reject_settings
-            type: seq
-            sequence:
-              - type: str
-          accept: &accept_settings
-            type: seq
-            sequence:
-              - type: str
-      UncommunicativeModuleName:
-        type: map
-        mapping:
-          <<: *detector_base
-          reject: *reject_settings
-          accept: *accept_settings
-      UncommunicativeParameterName:
-        type: map
-        mapping:
-          <<: *detector_base
-          reject: *reject_settings
-          accept: *accept_settings
-      UncommunicativeVariableName:
-        type: map
-        mapping:
-          <<: *detector_base
-          reject: *reject_settings
-          accept: *accept_settings
-      UnusedParameters:
-        type: map
-        mapping:
-          <<: *detector_base
-      UnusedPrivateMethod:
-        type: map
-        mapping:
-          <<: *detector_base
-      UtilityFunction:
-        type: map
-        mapping:
-          <<: *detector_base
-          public_methods_only:
-            type: bool
-
-  "directories":
-    type: map
-    mapping:
-      # For any given key that is not matched somewhere else we'll apply the schema below.
-      # So this will just slurp in every directory we throw at it and then validate everything under
-      # it against all detectors - for instance:
-      #
-      #  directories:
-      #    "web_app/app/controllers":
-      #      NestedIterators:
-      #        enabled: false
-      #    "web_app/app/helpers":
-      #      UtilityFunction:
-      #        enabled: false
-      #
-      # For details check out: http://www.kuwata-lab.com/kwalify/ruby/users-guide.02.html#tips-default
-      =:
-        type: map
-        mapping: *all_detectors
-        
-  "exclude_paths":
-    type: seq
-    sequence:
-      - type: str

data/samples/checkstyle.xml

@@ -1,7 +0,0 @@
-<?xml version='1.0'?>
-<checkstyle>
-  <file name='samples/smelly_source/smelly.rb'>
-    <error column='0' line='4' message='has the name &apos;x&apos;' severity='warning' source='UncommunicativeMethodName'/>
-    <error column='0' line='5' message='has the variable name &apos;y&apos;' severity='warning' source='UncommunicativeVariableName'/>
-  </file>
-</checkstyle>

data/samples/clean_source/clean.rb

@@ -1,6 +0,0 @@
-# Well documented Clean class.
-class Clean
-  def hello(argument)
-    say argument
-  end
-end

data/samples/configuration/accepts_rejects_and_excludes_for_detectors.reek.yml

@@ -1,29 +0,0 @@
----
-detectors:
-  UnusedPrivateMethod:
-    exclude:
-      - "/exclude regexp/"
-  UncommunicativeMethodName:
-    reject:
-      - "reject name"
-    accept:
-      - "accept name"
-  UncommunicativeModuleName:
-    reject:
-      - "reject name 1"
-      - "reject name 2"
-    accept:
-      - "accept name 1"
-      - "accept name 2"
-  UncommunicativeParameterName:
-    reject:
-      - "reject name"
-      - "/reject regexp/"
-    accept:
-      - "accept name"
-      - "/accept regexp/"
-  UncommunicativeVariableName:
-    reject:
-      - "/^reject regexp$/"
-    accept:
-      - "/accept(.*)regexp/"

data/samples/configuration/accepts_rejects_and_excludes_for_directory_directives.reek.yml

@@ -1,30 +0,0 @@
----
-directories:
-  "app/controllers":
-    UnusedPrivateMethod:
-      exclude:
-        - "/exclude regexp/"
-    UncommunicativeMethodName:
-      reject:
-        - "reject name"
-      accept:
-        - "accept name"
-    UncommunicativeModuleName:
-      reject:
-        - "reject name 1"
-        - "reject name 2"
-      accept:
-        - "accept name 1"
-        - "accept name 2"
-    UncommunicativeParameterName:
-      reject:
-        - "reject name"
-        - "/reject regexp/"
-      accept:
-        - "accept name"
-        - "/accept regexp/"
-    UncommunicativeVariableName:
-      reject:
-        - "/^reject regexp$/"
-      accept:
-        - "/accept(.*)regexp/"

data/samples/configuration/corrupt.reek

@@ -1 +0,0 @@
-Not a valid configuration file

data/samples/configuration/full_configuration.reek

@@ -1,13 +0,0 @@
----
-detectors:
-  IrresponsibleModule:
-    enabled: false
-
-directories:
-  "samples/three_clean_files/":
-    UtilityFunction:
-      enabled: false
-
-exclude_paths:
-  - "samples/two_smelly_files/"
-  - "samples/source_with_non_ruby_files/"

data/samples/configuration/full_mask.reek

@@ -1,6 +0,0 @@
----
-detectors:
-  UncommunicativeMethodName:
-    enabled: false
-  UncommunicativeVariableName:
-    enabled: false

data/samples/configuration/home/home.reek.yml

@@ -1,4 +0,0 @@
----
-UncommunicativeVariableName:
-  accept:
-  - md5

data/samples/configuration/partial_mask.reek

@@ -1,4 +0,0 @@
----
-detectors:
-  UncommunicativeMethodName:
-    enabled: false

data/samples/configuration/regular_configuration/.reek.yml

@@ -1,4 +0,0 @@
----
-UncommunicativeVariableName:
-  accept:
-  - md5

data/samples/configuration/with_excluded_paths.reek

@@ -1,5 +0,0 @@
----
-exclude_paths:
-  - samples/source_with_exclude_paths/ignore_me/
-  - samples/source_with_exclude_paths/nested/ignore_me_as_well
-  - samples/source_with_exclude_paths/nested/uncommunicative_parameter_name.rb

data/samples/paths.rb

@@ -1,5 +0,0 @@
-SAMPLES_DIR = Pathname.new(__dir__).relative_path_from(Pathname.pwd)
-CONFIGURATION_DIR = SAMPLES_DIR.join('configuration')
-CLEAN_FILE = SAMPLES_DIR.join('clean_source').join('clean.rb')
-SMELLY_FILE = SAMPLES_DIR.join('smelly_source').join('smelly.rb')
-