reek 5.5.0 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b3b65a38361c8f39a732b5902f9ee84181d3c90da8af1c4fcb7445f1b9c2471
-  data.tar.gz: 7dc904ae5e9f98b757a7c007e1d96bf86773f6024b823cf0fe564a95304ed826
+  metadata.gz: da76dfc3aa1c997bffe832e526907dcf847cb5d86e04bc7c084abe074247e5d7
+  data.tar.gz: 7abc545f4176d0f561797c092bea15f1630b824a3d3ba37b99975450eb3ec3df
 SHA512:
-  metadata.gz: 6534b0dd5502776c06443bcd1b9fc5047179e93511ed2ea1ea507c4566a5e5bb53b3f6bd697045771e060e1332698c6141e1437f6a26bac66db597e0d5116fd7
-  data.tar.gz: 235d484485c0d7d01bde1acb4b268431010505f69d2a8b7fcd1ce14016cbad9854aa09b9a42ea4db0f8489b75d0c711f937b021d0140a57813e4e5774ed8a00c
+  metadata.gz: 7fe6f93cf2fe75c232327e1250c4e72c10c88707ce57879341f43b5a8a195ddb0282d9433e60cb19f635923edcb3fa52bbaadb187b5ee67d4b4cea7fc72ce901
+  data.tar.gz: a55abca10a6875077fda0b873667407f1dddf1840963fd6463ed918db9d9e58408fa93acf5a7e4741d9d488dede75963ad422c2150953e3d69f7af840a563dfd

data/.rubocop.yml

@@ -12,7 +12,7 @@ AllCops:
   TargetRubyVersion: 2.3
 
 # Tables are nice
-Layout/AlignHash:
+Layout/HashAlignment:
   EnforcedColonStyle: table
   EnforcedHashRocketStyle: table
   EnforcedLastArgumentHashStyle: ignore_implicit
@@ -25,6 +25,10 @@ Layout/DotPosition:
 Layout/EmptyLineBetweenDefs:
   AllowAdjacentOneLineDefs: true
 
+# Be rather lenient with line length
+Layout/LineLength:
+  Max: 120
+
 # Always put the closing brace on the last line
 Layout/MultilineMethodCallBraceLayout:
   EnforcedStyle: same_line
@@ -55,10 +59,6 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
 
-# Be rather lenient with line length
-Metrics/LineLength:
-  Max: 120
-
 # Keyword arguments make long parameter lists readable
 Metrics/ParameterLists:
   CountKeywordArgs: false

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-11-04 12:41:28 +0100 using RuboCop version 0.60.0.
+# on 2019-12-22 13:19:30 +0100 using RuboCop version 0.78.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
@@ -15,7 +15,7 @@ Metrics/AbcSize:
 Metrics/ClassLength:
   Max: 161
 
-# Offense count: 13
+# Offense count: 14
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
   Max: 16
@@ -55,8 +55,8 @@ RSpec/NestedGroups:
 
 # Offense count: 2
 # Cop supports --auto-correct.
-# Configuration parameters: ConvertCodeThatCanStartToReturnNil, Whitelist.
-# Whitelist: present?, blank?, presence, try, try!
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods.
+# AllowedMethods: present?, blank?, presence, try, try!
 Style/SafeNavigation:
   Exclude:
     - 'lib/reek/ast/node.rb'

data/.travis.yml

@@ -12,6 +12,7 @@ rvm:
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
   - jruby-9.1.17.0
   - jruby-9.2.6.0
   - jruby-head

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## 5.6.0 (2020-01-20)
+
+* (mvz) Support Ruby 2.7
+* (mvz) Loosen parser dependency to allow version 2.7.x
+
 ## 5.5.0 (2019-11-13)
 
 * (mvz) Use the Parser class matching current ruby for parsing, instead of

data/Gemfile

@@ -13,9 +13,9 @@ group :development do
   gem 'rake',                '~> 13.0'
   gem 'rspec',               '~> 3.0'
   gem 'rspec-benchmark',     '~> 0.5.0'
-  gem 'rubocop',             '~> 0.75.0'
+  gem 'rubocop',             '~> 0.79.0'
   gem 'rubocop-performance', '~> 1.5.0'
-  gem 'rubocop-rspec',       '~> 1.36.0'
+  gem 'rubocop-rspec',       '~> 1.37.0'
   gem 'simplecov',           '~> 0.17.0'
   gem 'yard',                '~> 0.9.5'
 

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.5.0/docs/Code-Smells.md for a list of smells
+                                           Check out https://github.com/troessner/reek/blob/v5.6.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.5.0/docs/Code-Smells.md for a details on each detector
+      Check out https://github.com/troessner/reek/blob/v5.6.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.5.0/docs/Uncommunicative-Method-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.6.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.5.0/docs/Uncommunicative-Variable-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.6.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.5.0/docs/Irresponsible-Module.md"
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.6.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.5.0/docs/Uncommunicative-Method-Name.md]
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.5.0/docs/Uncommunicative-Variable-Name.md]
+        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.6.0/docs/Uncommunicative-Method-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.6.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.5.0/docs/Uncommunicative-Method-Name.md]
-        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.5.0/docs/Uncommunicative-Variable-Name.md]
+        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.6.0/docs/Uncommunicative-Method-Name.md]
+        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.6.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.5.0/docs/Uncommunicative-Method-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.6.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.5.0/docs/Uncommunicative-Variable-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.6.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.5.0/docs/Irresponsible-Module.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.6.0/docs/Irresponsible-Module.md
       """

data/features/support/env.rb

@@ -5,7 +5,7 @@ require 'active_support/core_ext/string/strip'
 
 begin
   require 'pry-byebug'
-rescue LoadError # rubocop:disable Lint/HandleExceptions
+rescue LoadError # rubocop:disable Lint/SuppressedException
 end
 
 #

data/lib/reek/code_comment.rb

@@ -123,20 +123,20 @@ module Reek
       def escalate_bad_detector
         return if SmellDetectors::BaseDetector.valid_detector?(detector_name)
 
-        raise Errors::BadDetectorInCommentError, detector_name: detector_name,
-                                                 original_comment: original_comment,
-                                                 source: source,
-                                                 line: line
+        raise Errors::BadDetectorInCommentError.new(detector_name: detector_name,
+                                                    original_comment: original_comment,
+                                                    source: source,
+                                                    line: line)
       end
 
       def escalate_bad_detector_configuration
         @parsed_options = YAML.safe_load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION,
                                          permitted_classes: [Regexp])
       rescue Psych::SyntaxError
-        raise Errors::GarbageDetectorConfigurationInCommentError, detector_name: detector_name,
-                                                                  original_comment: original_comment,
-                                                                  source: source,
-                                                                  line: line
+        raise Errors::GarbageDetectorConfigurationInCommentError.new(detector_name: detector_name,
+                                                                     original_comment: original_comment,
+                                                                     source: source,
+                                                                     line: line)
       end
 
       def escalate_unknown_configuration_key
@@ -144,11 +144,11 @@ module Reek
 
         return if given_keys_legit?
 
-        raise Errors::BadDetectorConfigurationKeyInCommentError, detector_name: detector_name,
-                                                                 offensive_keys: configuration_keys_difference,
-                                                                 original_comment: original_comment,
-                                                                 source: source,
-                                                                 line: line
+        raise Errors::BadDetectorConfigurationKeyInCommentError.new(detector_name: detector_name,
+                                                                    offensive_keys: configuration_keys_difference,
+                                                                    original_comment: original_comment,
+                                                                    source: source,
+                                                                    line: line)
       end
 
       # @return [Boolean] all keys in code comment are applicable to the detector in question

data/lib/reek/examiner.rb

@@ -105,11 +105,11 @@ module Reek
     rescue Errors::BaseError
       raise
     rescue EncodingError
-      raise Errors::EncodingError, origin: origin
+      raise Errors::EncodingError.new(origin: origin)
     rescue Parser::SyntaxError
-      raise Errors::SyntaxError, origin: origin
+      raise Errors::SyntaxError.new(origin: origin)
     rescue StandardError
-      raise Errors::IncomprehensibleSourceError, origin: origin
+      raise Errors::IncomprehensibleSourceError.new(origin: origin)
     end
 
     def syntax_tree

data/lib/reek/report/text_report.rb

@@ -11,8 +11,8 @@ module Reek
     #
     class TextReport < BaseReport
       # @public
-      def initialize(*args)
-        super(*args)
+      def initialize(**args)
+        super
 
         print progress_formatter.header
       end

data/lib/reek/smell_detectors/subclassed_from_core_class.rb

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

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '5.5.0'
+    STRING = '5.6.0'
   end
 end

data/reek.gemspec

@@ -21,7 +21,7 @@ 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.7', '>= 2.5.0.0', '!= 2.5.1.1'
+  s.add_runtime_dependency 'parser',                '< 2.8', '>= 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/factories/factories.rb

@@ -4,7 +4,7 @@ require_relative '../../lib/reek/smell_warning'
 require_relative '../../lib/reek/cli/options'
 
 FactoryBot.define do
-  factory :smell_warning, class: Reek::SmellWarning do
+  factory :smell_warning, class: 'Reek::SmellWarning' do
     skip_create
 
     smell_type { 'FeatureEnvy' }
@@ -24,7 +24,7 @@ FactoryBot.define do
     end
   end
 
-  factory :code_comment, class: Reek::CodeComment do
+  factory :code_comment, class: 'Reek::CodeComment' do
     comment { '' }
     line { 1 }
     source { 'string' }

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

@@ -7,7 +7,7 @@ require 'stringio'
 
 RSpec.describe Reek::Report::CodeClimateReport do
   let(:options) { {} }
-  let(:instance) { described_class.new(options) }
+  let(:instance) { described_class.new(**options) }
   let(:examiner) { Reek::Examiner.new(source) }
 
   before do

data/spec/reek/report/json_report_spec.rb

@@ -7,7 +7,7 @@ require 'stringio'
 
 RSpec.describe Reek::Report::JSONReport do
   let(:options) { {} }
-  let(:instance) { described_class.new(options) }
+  let(:instance) { described_class.new(**options) }
   let(:examiner) { Reek::Examiner.new(source) }
 
   before do

data/spec/reek/report/text_report_spec.rb

@@ -6,13 +6,7 @@ require_lib 'reek/report/simple_warning_formatter'
 require 'rainbow'
 
 RSpec.describe Reek::Report::TextReport do
-  let(:report_options) do
-    {
-      warning_formatter: Reek::Report::SimpleWarningFormatter.new,
-      heading_formatter: Reek::Report::QuietHeadingFormatter
-    }
-  end
-  let(:instance) { described_class.new report_options }
+  let(:instance) { described_class.new }
 
   context 'with a single empty source' do
     before do

data/spec/reek/report/yaml_report_spec.rb

@@ -7,7 +7,7 @@ require 'stringio'
 
 RSpec.describe Reek::Report::YAMLReport do
   let(:options) { {} }
-  let(:instance) { described_class.new(options) }
+  let(:instance) { described_class.new(**options) }
   let(:examiner) { Reek::Examiner.new(source) }
 
   before do

data/spec/spec_helper.rb

@@ -11,7 +11,7 @@ require_relative '../samples/paths'
 
 begin
   Reek::CLI::Silencer.without_warnings { require 'pry-byebug' }
-rescue LoadError # rubocop:disable Lint/HandleExceptions
+rescue LoadError # rubocop:disable Lint/SuppressedException
 end
 
 require 'factory_bot'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 5.5.0
+  version: 5.6.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-13 00:00:00.000000000 Z
+date: 2020-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -45,28 +45,28 @@ dependencies:
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.0.0
     - - "!="
       - !ruby/object:Gem::Version
         version: 2.5.1.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.0.0
     - - "!="
       - !ruby/object:Gem::Version
         version: 2.5.1.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -499,7 +499,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby