reek 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6edbc24f9dc5d13f418d60c9fbcadd30e8ac433c
-  data.tar.gz: f0fdcaa7d1a6dc702f24763f62a44367a7004365
+SHA256:
+  metadata.gz: b224c4eef70b2a99e48c212ba52e13a36ac530c2b96e3fd2b3924a38e0cbda42
+  data.tar.gz: 3667c059f76f95f5eeb25b9f6e576d41e4643c8118f93f31f54a41df50d7605a
 SHA512:
-  metadata.gz: aa7cad97b7d6108cf2c8f813adf0dc72258f64aab8645eacbb5854146614a6afa6d35951e950187d967007abeefe38eebd5af468f005d551929a73115e7cbe00
-  data.tar.gz: 4a04b1a57046145c006322cb6d34db5bcd970cceef1834a539209dfe2c2469c1b4d05359e5e3393dd8084f3f605af25dd2aaafaecb6212cf680587a267326e2d
+  metadata.gz: dbd6ef9ccbde8364187729ef0d496246db6da79e6e04f07f149b971fb567c3fa00d56641dcbd3b2e424d31132ba11bbdaac864e7f5077b432f60db518f8eeb68
+  data.tar.gz: c2ea5ccb2646ee26320fcbf791aee04229633862f98af22f186f2e0ed8d4ddd5115255a148f9b56523b61e244a78af0d31eefdebbd97e1437e2beccd9fc19d7a

data/.rubocop.yml

@@ -10,6 +10,12 @@ AllCops:
     - 'vendor/**/*'
   TargetRubyVersion: 2.3
 
+# Tables are nice
+Layout/AlignHash:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
 # Place . on the previous line
 Layout/DotPosition:
   EnforcedStyle: trailing

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-08-17 12:44:20 +0200 using RuboCop version 0.58.2.
+# on 2018-11-04 12:41:28 +0100 using RuboCop version 0.60.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -10,13 +10,13 @@
 Metrics/AbcSize:
   Max: 21
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 178
+  Max: 161
 
-# Offense count: 12
-# Configuration parameters: CountComments.
+# Offense count: 13
+# Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
   Max: 16
 
@@ -49,7 +49,7 @@ RSpec/MultipleDescribes:
 RSpec/MultipleExpectations:
   Max: 5
 
-# Offense count: 23
+# Offense count: 25
 RSpec/NestedGroups:
   Max: 5
 

data/.simplecov

@@ -9,6 +9,8 @@ end
 
 SimpleCov.at_exit do
   SimpleCov.result.format!
-  SimpleCov.minimum_coverage 98.88
-  SimpleCov.minimum_coverage_by_file 81.4
+  unless RUBY_ENGINE == 'jruby'
+    SimpleCov.minimum_coverage 98.88
+    SimpleCov.minimum_coverage_by_file 81.4
+  end
 end

data/.travis.yml

@@ -3,18 +3,23 @@ dist: trusty
 cache: bundler
 language: ruby
 bundler_args: --without debugging
+before_script:
+  # Avoid Java announcing _JAVA_OPTIONS environment variable
+  # See https://github.com/travis-ci/travis-ci/issues/8408
+  - unset _JAVA_OPTIONS
 script: bundle exec rake ci
 rvm:
   - 2.3
   - 2.4
   - 2.5
-  - jruby-9.1.15.0
+  - 2.6
+  - jruby-9.1.17.0
+  - jruby-9.2.5.0
   - jruby-head
   - ruby-head
   - rubinius-3
 matrix:
   allow_failures:
-    - rvm: jruby-9.1.15.0
     - rvm: jruby-head
     - rvm: ruby-head
     - rvm: rubinius-3

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## 5.3.0 (2018-12-28)
+
+* (mvz) Add support for Ruby 2.6.
+* (mvz) Add support for JRuby 9.1 and 9.2
+
 ## 5.2.0 (2018-10-13)
 
 * (troessner) Enable exclusion of single files.

data/Gemfile

@@ -13,8 +13,8 @@ group :development do
   gem 'rake',            '~> 12.0'
   gem 'rspec',           '~> 3.0'
   gem 'rspec-benchmark', '~> 0.4.0'
-  gem 'rubocop',         '~> 0.59.1'
-  gem 'rubocop-rspec',   '~> 1.29.0'
+  gem 'rubocop',         '~> 0.61.1'
+  gem 'rubocop-rspec',   '~> 1.30.1'
   gem 'simplecov',       '~> 0.16.1'
   gem 'yard',            '~> 0.9.5'
 

data/README.md

@@ -100,13 +100,9 @@ demo.rb -- 2 warnings:
 
 ## Supported Ruby versions
 
-Reek is officially supported for the following CRuby versions:
-
-  - 2.3
-  - 2.4
-  - 2.5
-
-Other Ruby implementations (like Rubinius or JRuby) are not officially supported but should work as well.
+Reek is officially supported for CRuby 2.3 to 2.6 and for JRuby 9.1 and 9.2.
+Other Ruby implementations (like Rubinius) are not officially supported but
+should work as well.
 
 ## Fixing Smell Warnings
 

data/features/command_line_interface/options.feature

@@ -43,7 +43,7 @@ Feature: Reek can be controlled using command-line options
           -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/v5.2.0/docs/Code-Smells.md for a list of smells
+                                           Check out https://github.com/troessner/reek/blob/v5.3.0/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:
@@ -120,5 +120,5 @@ Feature: Reek can be controlled using command-line options
       UnusedPrivateMethod
       UtilityFunction
 
-      Check out https://github.com/troessner/reek/blob/v5.2.0/docs/Code-Smells.md for a details on each detector
+      Check out https://github.com/troessner/reek/blob/v5.3.0/docs/Code-Smells.md for a details on each detector
       """

data/features/reports/json.feature

@@ -24,7 +24,7 @@ Feature: Report smells using simple JSON layout
               "context": "Smelly#x",
               "lines": [ 4 ],
               "message": "has the name 'x'",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.2.0/docs/Uncommunicative-Method-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.3.0/docs/Uncommunicative-Method-Name.md",
               "name": "x"
           },
           {
@@ -33,7 +33,7 @@ Feature: Report smells using simple JSON layout
               "context": "Smelly#x",
               "lines": [ 5 ],
               "message": "has the variable name 'y'",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.2.0/docs/Uncommunicative-Variable-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.3.0/docs/Uncommunicative-Variable-Name.md",
               "name": "y"
           }
       ]
@@ -53,7 +53,7 @@ Feature: Report smells using simple JSON layout
                   1
               ],
               "message": "has no descriptive comment",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.2.0/docs/Irresponsible-Module.md"
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.3.0/docs/Irresponsible-Module.md"
           }
       ]
       """

data/features/reports/reports.feature

@@ -182,8 +182,8 @@ Feature: Correctly formatted reports
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.2.0/docs/Uncommunicative-Method-Name.md]
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.2.0/docs/Uncommunicative-Variable-Name.md]
+        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.3.0/docs/Uncommunicative-Method-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.3.0/docs/Uncommunicative-Variable-Name.md]
       """
 
     Examples:
@@ -209,8 +209,8 @@ Feature: Correctly formatted reports
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.2.0/docs/Uncommunicative-Method-Name.md]
-        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.2.0/docs/Uncommunicative-Variable-Name.md]
+        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.3.0/docs/Uncommunicative-Method-Name.md]
+        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.3.0/docs/Uncommunicative-Variable-Name.md]
       """
 
     Examples:

data/features/reports/yaml.feature

@@ -25,7 +25,7 @@ Feature: Report smells using simple YAML layout
         smell_type: UncommunicativeMethodName
         source: smelly.rb
         name: x
-        documentation_link: https://github.com/troessner/reek/blob/v5.2.0/docs/Uncommunicative-Method-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.3.0/docs/Uncommunicative-Method-Name.md
       - context: Smelly#x
         lines:
         - 5
@@ -33,7 +33,7 @@ Feature: Report smells using simple YAML layout
         smell_type: UncommunicativeVariableName
         source: smelly.rb
         name: y
-        documentation_link: https://github.com/troessner/reek/blob/v5.2.0/docs/Uncommunicative-Variable-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.3.0/docs/Uncommunicative-Variable-Name.md
       """
 
   Scenario: Indicate smells and print them as yaml when using STDIN
@@ -48,5 +48,5 @@ Feature: Report smells using simple YAML layout
         lines:
         - 1
         message: has no descriptive comment
-        documentation_link: https://github.com/troessner/reek/blob/v5.2.0/docs/Irresponsible-Module.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.3.0/docs/Irresponsible-Module.md
       """

data/lib/reek/code_comment.rb

@@ -20,8 +20,8 @@ module Reek
                             \s*
                             (\{.*?\}) # optional details in hash style e.g.: { max_methods: 30 }
                           )?
-                         /x
-    SANITIZE_REGEX                 = /(#|\n|\s)+/ # Matches '#', newlines and > 1 whitespaces.
+                         /x.freeze
+    SANITIZE_REGEX                 = /(#|\n|\s)+/.freeze # Matches '#', newlines and > 1 whitespaces.
     DISABLE_DETECTOR_CONFIGURATION = '{ enabled: false }'
     MINIMUM_CONTENT_LENGTH         = 2
 
@@ -45,7 +45,7 @@ module Reek
                                  source:           source,
                                  options:          options).validate
         @config.merge! detector_name => YAML.safe_load(options || DISABLE_DETECTOR_CONFIGURATION,
-                                                       [Regexp])
+                                                       permitted_classes: [Regexp])
       end
     end
 
@@ -131,7 +131,7 @@ module Reek
 
       def escalate_bad_detector_configuration
         @parsed_options = YAML.safe_load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION,
-                                         [Regexp])
+                                         permitted_classes: [Regexp])
       rescue Psych::SyntaxError
         raise Errors::GarbageDetectorConfigurationInCommentError, detector_name: detector_name,
                                                                   original_comment: original_comment,

data/lib/reek/logging_error_handler.rb

@@ -10,7 +10,7 @@ module Reek
       when Errors::BaseError
         warn exception.long_message
       else
-        warn exception
+        warn exception.message
       end
       true
     end

data/lib/reek/report.rb

@@ -17,33 +17,33 @@ module Reek
   # Reek reporting functionality.
   module Report
     REPORT_CLASSES = {
-      yaml: YAMLReport,
-      json: JSONReport,
-      html: HTMLReport,
-      xml: XMLReport,
-      text: TextReport,
+      yaml:         YAMLReport,
+      json:         JSONReport,
+      html:         HTMLReport,
+      xml:          XMLReport,
+      text:         TextReport,
       code_climate: CodeClimateReport
     }.freeze
 
     LOCATION_FORMATTERS = {
       single_line: SingleLineLocationFormatter,
-      plain: BlankLocationFormatter,
-      numbers: DefaultLocationFormatter
+      plain:       BlankLocationFormatter,
+      numbers:     DefaultLocationFormatter
     }.freeze
 
     HEADING_FORMATTERS = {
       verbose: VerboseHeadingFormatter,
-      quiet: QuietHeadingFormatter
+      quiet:   QuietHeadingFormatter
     }.freeze
 
     PROGRESS_FORMATTERS = {
-      dots: ProgressFormatter::Dots,
+      dots:  ProgressFormatter::Dots,
       quiet: ProgressFormatter::Quiet
     }.freeze
 
     WARNING_FORMATTER_CLASSES = {
       documentation_links: DocumentationLinkWarningFormatter,
-      simple: SimpleWarningFormatter
+      simple:              SimpleWarningFormatter
     }.freeze
 
     # Map report format symbol to a report class.

data/lib/reek/smell_detectors/base_detector.rb

@@ -100,7 +100,7 @@ module Reek
         def default_config
           {
             SmellConfiguration::ENABLED_KEY => true,
-            EXCLUDE_KEY => DEFAULT_EXCLUDE_SET.dup
+            EXCLUDE_KEY                     => DEFAULT_EXCLUDE_SET.dup
           }
         end
 

data/lib/reek/smell_detectors/data_clump.rb

@@ -59,7 +59,7 @@ module Reek
                      "to #{methods_length} methods",
             parameters: {
               parameters: clump.map(&:to_s),
-              count: methods_length
+              count:      methods_length
             })
         end
       end

data/lib/reek/smell_detectors/subclassed_from_core_class.rb

@@ -44,8 +44,8 @@ module Reek
 
       def build_smell_warning(ancestor_name)
         smell_attributes = {
-          lines: [source_line],
-          message: "inherits from core class '#{ancestor_name}'",
+          lines:      [source_line],
+          message:    "inherits from core class '#{ancestor_name}'",
           parameters: { ancestor: ancestor_name }
         }
 

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '5.2.0'
+    STRING = '5.3.0'
   end
 end

data/reek.gemspec

@@ -22,5 +22,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'codeclimate-engine-rb', '~> 0.4.0'
   s.add_runtime_dependency 'kwalify',               '~> 0.7.0'
   s.add_runtime_dependency 'parser',                '< 2.6', '>= 2.5.0.0', '!= 2.5.1.1'
+  s.add_runtime_dependency 'psych',                 '~> 3.1.0'
   s.add_runtime_dependency 'rainbow',               '>= 2.0', '< 4.0'
 end

data/spec/reek/cli/application_spec.rb

@@ -141,7 +141,7 @@ RSpec.describe Reek::CLI::Application do
     let(:app) { described_class.new ['--show-configuration-path', '.'] }
 
     around do |example|
-      Dir.mktmpdir('/tmp') do |tmp|
+      Dir.mktmpdir do |tmp|
         Dir.chdir(tmp) do
           example.run
         end

data/spec/reek/cli/command/todo_list_command_spec.rb

@@ -5,17 +5,17 @@ require_lib 'reek/configuration/app_configuration'
 
 RSpec.describe Reek::CLI::Command::TodoListCommand do
   let(:existing_configuration) do
-    <<-EOS.strip_heredoc
-    ---
-    detectors:
-      UncommunicativeMethodName:
-        exclude:
-        - Smelly#x
-    EOS
+    <<~YAML
+      ---
+      detectors:
+        UncommunicativeMethodName:
+          exclude:
+          - Smelly#x
+    YAML
   end
 
   let(:smelly_file) do
-    <<-EOS
+    <<~RUBY
       # Smelly class
       class Smelly
         # This will reek of UncommunicativeMethodName
@@ -23,26 +23,26 @@ RSpec.describe Reek::CLI::Command::TodoListCommand do
           y = 10 # This will reek of UncommunicativeVariableName
         end
       end
-    EOS
+    RUBY
   end
 
   let(:new_configuration_file) do
-    <<-EOS.strip_heredoc
-    # Auto generated by Reeks --todo flag
-    ---
-    detectors:
-      UncommunicativeMethodName:
-        exclude:
-        - Smelly#x
-      UncommunicativeVariableName:
-        exclude:
-        - Smelly#x
-    EOS
+    <<~YAML
+      # Auto generated by Reeks --todo flag
+      ---
+      detectors:
+        UncommunicativeMethodName:
+          exclude:
+          - Smelly#x
+        UncommunicativeVariableName:
+          exclude:
+          - Smelly#x
+    YAML
   end
 
   describe '#execute on smelly source' do
     around do |example|
-      Dir.mktmpdir('/tmp') do |tmp|
+      Dir.mktmpdir do |tmp|
         Dir.chdir(tmp) do
           File.write SMELLY_FILE.basename, smelly_file
           example.run

data/spec/reek/configuration/app_configuration_spec.rb

@@ -8,7 +8,7 @@ require_lib 'reek/configuration/excluded_paths'
 RSpec.describe Reek::Configuration::AppConfiguration do
   describe 'factory methods' do
     around do |example|
-      Dir.mktmpdir('/tmp') do |tmp|
+      Dir.mktmpdir do |tmp|
         Dir.chdir(tmp) do
           example.run
         end
@@ -32,30 +32,29 @@ RSpec.describe Reek::Configuration::AppConfiguration do
     end
 
     let(:expected_directory_directives) do
-      { Pathname('directory_with_some_ruby_files') =>
-        { Reek::SmellDetectors::UtilityFunction => { 'enabled' => false } } }
+      { Pathname('directory_with_some_ruby_files') => {
+        Reek::SmellDetectors::UtilityFunction => { 'enabled' => false }
+      } }
     end
 
     describe '#from_path' do
       let(:configuration_path) { 'config.reek' }
       let(:configuration) do
-        <<-EOF.strip_heredoc
-        ---
-        detectors:
-          IrresponsibleModule:
-            enabled: false
-
-        directories:
-          "directory_with_some_ruby_files":
-            UtilityFunction:
+        <<~YAML
+          ---
+          detectors:
+            IrresponsibleModule:
               enabled: false
-
-        exclude_paths:
-          - "exclude_me.rb"
-          - "exclude_me_too.rb"
-          - "directory_with_trailing_slash/"
-          - "directory_without_trailing_slash"
-        EOF
+          directories:
+            "directory_with_some_ruby_files":
+              UtilityFunction:
+                enabled: false
+          exclude_paths:
+            - "exclude_me.rb"
+            - "exclude_me_too.rb"
+            - "directory_with_trailing_slash/"
+            - "directory_without_trailing_slash"
+        YAML
       end
 
       before do
@@ -80,14 +79,17 @@ RSpec.describe Reek::Configuration::AppConfiguration do
       end
 
       let(:default_directive_value) do
-        { Reek::DETECTORS_KEY =>
-            { 'IrresponsibleModule' => { 'enabled' => false } } }
+        { Reek::DETECTORS_KEY => {
+          'IrresponsibleModule' => { 'enabled' => false }
+        } }
       end
 
       let(:directory_directives_value) do
-        { Reek::DIRECTORIES_KEY =>
-            { 'directory_with_some_ruby_files' =>
-                { 'UtilityFunction' => { 'enabled' => false } } } }
+        { Reek::DIRECTORIES_KEY => {
+          'directory_with_some_ruby_files' => {
+            'UtilityFunction' => { 'enabled' => false }
+          }
+        } }
       end
 
       let(:exclude_paths_value) do
@@ -128,11 +130,12 @@ RSpec.describe Reek::Configuration::AppConfiguration do
       let(:expected_result) { { Reek::SmellDetectors::Attribute => { enabled: true } } }
 
       let(:directory_directives) do
-        { Reek::DIRECTORIES_KEY =>
-          {
-            'samples/some_files' => bang_config,
+        {
+          Reek::DIRECTORIES_KEY => {
+            'samples/some_files'  => bang_config,
             'samples/other_files' => baz_config
-          } }
+          }
+        }
       end
 
       it 'returns the corresponding directive' do
@@ -147,11 +150,12 @@ RSpec.describe Reek::Configuration::AppConfiguration do
 
       let(:configuration_as_hash) do
         {
-          Reek::DIRECTORIES_KEY =>
-            { directory => { TooManyStatements: { max_statements: 8 } } },
-          Reek::DETECTORS_KEY => {
+          Reek::DIRECTORIES_KEY => {
+            directory => { TooManyStatements: { max_statements: 8 } }
+          },
+          Reek::DETECTORS_KEY   => {
             IrresponsibleModule: { enabled: false },
-            TooManyStatements: { max_statements: 15 }
+            TooManyStatements:   { max_statements: 15 }
           }
         }
       end
@@ -171,11 +175,12 @@ RSpec.describe Reek::Configuration::AppConfiguration do
 
       let(:configuration_as_hash) do
         {
-          Reek::DETECTORS_KEY => {
+          Reek::DETECTORS_KEY   => {
             IrresponsibleModule: { enabled: false }
           },
-          Reek::DIRECTORIES_KEY =>
-            { 'samples/other_files' => { Attribute: { enabled: false } } }
+          Reek::DIRECTORIES_KEY => {
+            'samples/other_files' => { Attribute: { enabled: false } }
+          }
         }
       end
 

data/spec/reek/configuration/configuration_file_finder_spec.rb

@@ -33,12 +33,14 @@ RSpec.describe Reek::Configuration::ConfigurationFileFinder do
     end
 
     it 'skips files ending in .reek.yml in current dir' do
-      Dir.mktmpdir(nil, regular_configuration_dir) do |tempdir|
+      skip_if_a_config_in_tempdir
+
+      Dir.mktmpdir do |tempdir|
         current = Pathname.new(tempdir)
         bad_config = current.join('ignoreme.reek.yml')
         FileUtils.touch bad_config
-        found = described_class.find(current: Pathname.new(tempdir))
-        expect(found).to eq(regular_configuration_file)
+        found = described_class.find(current: current)
+        expect(found).to be_nil
       end
     end
 
@@ -128,15 +130,15 @@ RSpec.describe Reek::Configuration::ConfigurationFileFinder do
 
         let(:expected) do
           {
-            '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'] },
+            '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/] }
+            'UncommunicativeVariableName'  => { 'reject' => [/^reject regexp$/],
+                                                'accept' => [/accept(.*)regexp/] }
           }
         end
 
@@ -172,15 +174,15 @@ RSpec.describe Reek::Configuration::ConfigurationFileFinder do
         let(:expected) do
           {
             directory_name => {
-              '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'] },
+              '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/] }
+              'UncommunicativeVariableName'  => { 'reject' => [/^reject regexp$/],
+                                                  'accept' => [/accept(.*)regexp/] }
             }
           }
         end

data/spec/reek/configuration/directory_directives_spec.rb

@@ -44,9 +44,9 @@ RSpec.describe Reek::Configuration::DirectoryDirectives do
   describe '#best_match_for' do
     let(:directives) do
       {
-        Pathname.new('foo/bar/baz')  => {},
-        Pathname.new('foo/bar')      => {},
-        Pathname.new('bar/boo')      => {}
+        Pathname.new('foo/bar/baz') => {},
+        Pathname.new('foo/bar')     => {},
+        Pathname.new('bar/boo')     => {}
       }.extend(described_class)
     end
 

data/spec/reek/configuration/rake_task_converter_spec.rb

@@ -6,8 +6,8 @@ RSpec.describe Reek::Configuration::RakeTaskConverter do
     let(:configuration_for_smell_detector) do
       {
         'exclude' => [/Klass#foobar$/, /^Klass#omg$/],
-        'reject' => [/^[a-z]$/, /[0-9]$/, /[A-Z]/],
-        'accept' => [/^_$/]
+        'reject'  => [/^[a-z]$/, /[0-9]$/, /[A-Z]/],
+        'accept'  => [/^_$/]
       }
     end
 

data/spec/reek/examiner_spec.rb

@@ -198,9 +198,9 @@ RSpec.describe Reek::Examiner do
   context 'with a source that triggers a syntax error' do
     let(:examiner) { described_class.new(source) }
     let(:source) do
-      <<-SRC.strip_heredoc
-      1 2 3
-      SRC
+      <<~RUBY
+        1 2 3
+      RUBY
     end
 
     it 'does not raise an error during initialization' do
@@ -225,10 +225,10 @@ RSpec.describe Reek::Examiner do
   context 'with a source that triggers an encoding error' do
     let(:examiner) { described_class.new(source) }
     let(:source) do
-      <<-SRC.strip_heredoc
-      # encoding: US-ASCII
-      puts 'こんにちは世界'
-      SRC
+      <<~RUBY
+        # encoding: US-ASCII
+        puts 'こんにちは世界'
+      RUBY
     end
 
     it 'does not raise an error during initialization' do

data/spec/reek/report/code_climate/code_climate_report_spec.rb

@@ -26,29 +26,29 @@ RSpec.describe Reek::Report::CodeClimateReport do
     let(:source) { 'def simple(a) a[3] end' }
 
     it 'prints smells as json' do
-      expected = <<-EOS.strip_heredoc.delete("\n")
-        {\"type\":\"issue\",
-        \"check_name\":\"UncommunicativeParameterName\",
-        \"description\":\"simple has the parameter name 'a'\",
-        \"categories\":[\"Complexity\"],
-        \"location\":{\"path\":\"string\",\"lines\":{\"begin\":1,\"end\":1}},
-        \"remediation_points\":150000,
-        \"content\":{\"body\":\"An `Uncommunicative Parameter Name` is a parameter name that
+      expected = <<~HERE.delete("\n")
+        {"type":"issue",
+        "check_name":"UncommunicativeParameterName",
+        "description":"simple has the parameter name 'a'",
+        "categories":["Complexity"],
+        "location":{"path":"string","lines":{"begin":1,"end":1}},
+        "remediation_points":150000,
+        "content":{"body":"An `Uncommunicative Parameter Name` is a parameter 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\":\"09970037d92b5a628bf682a3e2bb126d\"}\u0000
-        {\"type\":\"issue\",
-        \"check_name\":\"UtilityFunction\",
-        \"description\":\"simple doesn't depend on instance state (maybe move it to another class?)\",
-        \"categories\":[\"Complexity\"],
-        \"location\":{\"path\":\"string\",\"lines\":{\"begin\":1,\"end\":1}},
-        \"remediation_points\":250000,
-        \"content\":{\"body\":\"A _Utility Function_ is any instance method that has no
-         dependency on the state of the instance.\\n\"},
-        \"fingerprint\":\"db456db7cb344bb5a98b8fc54a2f382e\"}\u0000
-      EOS
+         to interpret the names.\\n"},
+        "fingerprint":"09970037d92b5a628bf682a3e2bb126d"}\u0000
+        {"type":"issue",
+        "check_name":"UtilityFunction",
+        "description":"simple doesn't depend on instance state (maybe move it to another class?)",
+        "categories":["Complexity"],
+        "location":{"path":"string","lines":{"begin":1,"end":1}},
+        "remediation_points":250000,
+        "content":{"body":"A _Utility Function_ is any instance method that has no
+         dependency on the state of the instance.\\n"},
+        "fingerprint":"db456db7cb344bb5a98b8fc54a2f382e"}\u0000
+      HERE
 
       expect { instance.show }.to output(expected).to_stdout
     end

data/spec/reek/report/yaml_report_spec.rb

@@ -30,7 +30,7 @@ RSpec.describe Reek::Report::YAMLReport do
       instance.show(out)
       out.rewind
       result = YAML.safe_load(out.read)
-      expected = YAML.safe_load <<-EOS.strip_heredoc
+      expected = YAML.safe_load <<~YAML
         ---
         - context:        "simple"
           lines:
@@ -47,7 +47,7 @@ RSpec.describe Reek::Report::YAMLReport do
           smell_type:         "UtilityFunction"
           source:             "string"
           documentation_link: "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Utility-Function.md"
-      EOS
+      YAML
 
       expect(result).to eq expected
     end

data/spec/reek/smell_detectors/uncommunicative_parameter_name_spec.rb

@@ -30,7 +30,7 @@ RSpec.describe Reek::SmellDetectors::UncommunicativeParameterName do
   end
 
   { 'alfa.' => 'with a receiver',
-    '' => 'without a receiver' }.each do |host, description|
+    ''      => 'without a receiver' }.each do |host, description|
     context "in a method definition #{description}" do
       it 'does not report two-letter parameter names' do
         src = "def #{host}bravo(ab); charlie(ab); end"

data/spec/reek/spec/should_reek_of_spec.rb

@@ -103,14 +103,14 @@ RSpec.describe Reek::Spec::ShouldReekOf do
 
       it 'sets the proper error message' do
         matcher.matches?(smelly_code)
-        expected = <<-EOS.strip_heredoc
+        expected = <<~TEXT
           Expected string to reek of DuplicateMethodCall (which it did) with smell details {:name=>"foo", :count=>15}, which it didn't.
           The number of smell details I had to compare with the given one was 2 and here they are:
           1.)
           {"context"=>"double_thing", "lines"=>[1, 1], "message"=>"calls '@other.thing' 2 times", "source"=>"string", "name"=>"@other.thing", "count"=>2}
           2.)
           {"context"=>"double_thing", "lines"=>[1, 1], "message"=>"calls '@other.thing.foo' 2 times", "source"=>"string", "name"=>"@other.thing.foo", "count"=>2}
-        EOS
+        TEXT
 
         expect(matcher.failure_message).to eq(expected)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-13 00:00:00.000000000 Z
+date: 2018-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -45,28 +45,42 @@ dependencies:
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.6'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.0.0
     - - "!="
       - !ruby/object:Gem::Version
         version: 2.5.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.6'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.0.0
     - - "!="
       - !ruby/object:Gem::Version
         version: 2.5.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -487,8 +501,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby