reek 6.1.1 → 6.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e1e79296b4eb0b93d7b6d7bc7b13704b6831765416cab19c729473d2fe135ea
-  data.tar.gz: f9a49ffd6ad47e308a617bafb0901d438617c863ff5279c867d5db8e9148c0e4
+  metadata.gz: a6b704ad454fc35e79cd642ef2083d3a4f03f6222979af19914c8858d2c6afb1
+  data.tar.gz: 8dc0085544cda71395b74e02f3071a25a2f74c803fff69fae0beda0758c0c26f
 SHA512:
-  metadata.gz: 3ea8856c9c0f32543af3bb336790d9875cdf385ed45d2609af219f1857931d1b15de7802386954caff9c68f5753657f138e2eb304ef4ae94edc0e7a0e7e4e070
-  data.tar.gz: 407628086e04a8d2972f1343a34d299e77d462b0236f18e8b4570a9b9dfcd290dc6d690be56c67e06c0fff95326e764254b70c127962f5a90914a73bae115aed
+  metadata.gz: 9f024fbd405935132f011d33d02e4361c94f2ac10127ef1dba6ce8d9590bdaa66d30e77569d2622002dfceae5a60bbf9f32b62619dd73dd6d9b2825a2ddaaa8c
+  data.tar.gz: 128a19e5c080e356fe578faa480813bcd3f063afb55b0afb39318157e31f67536487f75d7cb9ddb109abb09bc1cd60d653bbe20d176c9a346a949fc836922c76

data/.github/dependabot.yml

@@ -7,3 +7,7 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

data/.github/workflows/ruby.yml

@@ -4,11 +4,11 @@
 
 name: CI
 
-on:
+"on":
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
   schedule:
     - cron: '16 4 12 * *'
 
@@ -25,7 +25,7 @@ jobs:
         ruby: [2.6, 2.7, "3.0", "3.1", jruby-9.3]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -47,7 +47,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.rubocop.yml

@@ -48,7 +48,7 @@ Layout/MultilineOperationIndentation:
 Lint/AmbiguousBlockAssociation:
   Enabled: false
 
-# Some of our source examples include interpolation explicitely.
+# Some of our source examples include interpolation explicitly.
 Lint/InterpolationCheck:
   Exclude:
     - 'spec/**/*'

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log
 
+## 6.1.2 (2022-11-21)
+
+* (mvz) Add support for keyword nil arguments
+
 ## 6.1.1 (2022-04-20)
 
 * (ydah) UnusedPrivateMethod to be detect use of methods via `Method#to_proc`

data/CONTRIBUTING.md

@@ -142,7 +142,7 @@ Once you’re happy with your feature / fix – or want to
 share it as a work-in-progress and request comments – once
 again make sure all of the tests pass. This will also run
 [RuboCop](https://github.com/bbatsov/rubocop) – fix any
-offences RuboCop finds (or discuss them in the pull request):
+offenses RuboCop finds (or discuss them in the pull request):
 
 ```
 bundle exec rake

data/Gemfile

@@ -5,17 +5,17 @@ gemspec
 ruby RUBY_VERSION
 
 group :development do
-  gem 'aruba',                 '~> 2.0'
+  gem 'aruba',                 '~> 2.1'
   gem 'codeclimate-engine-rb', '~> 0.4.0'
-  gem 'cucumber',              '>= 4.0', '< 8.0'
+  gem 'cucumber',              '~> 8.0'
   gem 'kramdown',              '~> 2.1'
   gem 'kramdown-parser-gfm',   '~> 1.0'
   gem 'rake',                  '~> 13.0'
   gem 'rspec',                 '~> 3.0'
   gem 'rspec-benchmark',       '~> 0.6.0'
-  gem 'rubocop',               '~> 1.27.0'
-  gem 'rubocop-performance',   '~> 1.13.1'
-  gem 'rubocop-rspec',         '~> 2.9.0'
+  gem 'rubocop',               '~> 1.39.0'
+  gem 'rubocop-performance',   '~> 1.15.0'
+  gem 'rubocop-rspec',         '~> 2.15.0'
   gem 'simplecov',             ['>= 0.18.0', '< 0.22.0']
   gem 'yard',                  '~> 0.9.5'
 

data/README.md

@@ -411,7 +411,7 @@ def smelly_method foo
 end
 ```
 
-This is an incredibly powerful feature and further explained under [Smell Suppresion](docs/Smell-Suppression.md).
+This is an incredibly powerful feature and further explained under [Smell Suppression](docs/Smell-Suppression.md).
 
 #### Debugging trouble with the configuration
 

data/lib/reek/ast/sexp_extensions/arguments.rb

@@ -115,6 +115,15 @@ module Reek
         end
       end
       # rubocop:enable Naming/ClassAndModuleCamelCase
+
+      # Utility methods for :kwnilarg nodes.
+      module KwnilargNode
+        include ArgNodeBase
+
+        def anonymous_splat?
+          true
+        end
+      end
     end
   end
 end

data/lib/reek/cli/command/todo_list_command.rb

@@ -23,7 +23,7 @@ module Reek
             puts EXISTING_FILE_MESSAGE
           else
             write_to_file
-            puts "\n'#{DEFAULT_CONFIGURATION_FILE_NAME}' generated! "\
+            puts "\n'#{DEFAULT_CONFIGURATION_FILE_NAME}' generated! " \
                  'You can now use this as a starting point.'
           end
           options.success_exit_code

data/lib/reek/cli/options.rb

@@ -110,12 +110,12 @@ module Reek
         parser.on('--smell SMELL',
                   'Only look for a specific smell.',
                   'Call it like this: reek --smell MissingSafeMethod source.rb',
-                  "Check out #{DocumentationLink.build('Code Smells')} "\
+                  "Check out #{DocumentationLink.build('Code Smells')} " \
                   'for a list of smells') do |smell|
           smells_to_detect << smell
         end
         parser.on('--stdin-filename FILE',
-                  'When passing code in via pipe, assume this filename when '\
+                  'When passing code in via pipe, assume this filename when ' \
                   'checking file or directory rules in the config.') do |file|
           self.stdin_filename = file
         end
@@ -210,12 +210,12 @@ module Reek
       def set_exit_codes
         parser.separator "\nExit codes:"
         parser.on('--success-exit-code CODE',
-                  'The exit code when no smells are found '\
+                  'The exit code when no smells are found ' \
                   "(default: #{Status::DEFAULT_SUCCESS_EXIT_CODE})") do |option|
           self.success_exit_code = Integer(option)
         end
         parser.on('--failure-exit-code CODE',
-                  'The exit code when smells are found '\
+                  'The exit code when smells are found ' \
                   "(default: #{Status::DEFAULT_FAILURE_EXIT_CODE})") do |option|
           self.failure_exit_code = Integer(option)
         end
@@ -231,7 +231,7 @@ module Reek
         parser.on_tail('-l', '--list', 'List all available smell detectors') do
           puts "All available smell detectors:\n\n"
           puts DetectorRepository.available_detector_names
-          puts "\nCheck out #{DocumentationLink.build('Code Smells')} "\
+          puts "\nCheck out #{DocumentationLink.build('Code Smells')} " \
                'for a details on each detector'
           exit
         end

data/lib/reek/rake/task.rb

@@ -69,15 +69,15 @@ module Reek
 
       # @public
       def initialize(name = :reek)
-        @config_file   = ENV['REEK_CFG']
+        @config_file   = ENV.fetch('REEK_CFG', nil)
         @name          = name
-        @reek_opts     = ENV['REEK_OPTS'] || ''
+        @reek_opts     = ENV.fetch('REEK_OPTS', '')
         @fail_on_error = true
         @verbose       = false
 
         yield self if block_given?
 
-        if (reek_src = ENV['REEK_SRC'])
+        if (reek_src = ENV.fetch('REEK_SRC', nil))
           @source_files = FileList[reek_src]
         end
         @source_files ||= FileList['lib/**/*.rb']
@@ -87,8 +87,8 @@ module Reek
       # @public
       def source_files=(files)
         unless files.is_a?(String) || files.is_a?(FileList)
-          raise ArgumentError, 'File list should be a FileList or a String that can contain'\
-                               " a glob pattern, e.g. '{app,lib,spec}/**/*.rb'"
+          raise ArgumentError, 'File list should be a FileList or a String that can contain ' \
+                               "a glob pattern, e.g. '{app,lib,spec}/**/*.rb'"
         end
         @source_files = FileList[files]
       end

data/lib/reek/report/code_climate/code_climate_configuration.yml

@@ -63,7 +63,7 @@ BooleanParameter:
 
     * Move everything in the `if` branch into a separate method
     * Move everything in the `else` branch into a separate method
-    * Get rid of the `hit_the_switch` method alltogether
+    * Get rid of the `hit_the_switch` method altogether
     * Make the decision what method to call in the initial caller of `hit_the_switch`
 ClassVariable:
   remediation_points: 350_000
@@ -119,7 +119,7 @@ ControlParameter:
     end
     ```
 
-    Fixing those problems is out of the scope of this document but an easy solution could be to remove the "write" method alltogether and to move the calls to "write_quoted" / "write_unquoted" in the initial caller of "write".
+    Fixing those problems is out of the scope of this document but an easy solution could be to remove the "write" method altogether and to move the calls to "write_quoted" / "write_unquoted" in the initial caller of "write".
 DataClump:
   remediation_points: 250_000
   content: |
@@ -768,7 +768,7 @@ TooManyStatements:
     end
     ```
 
-    (You might argue that the two assigments within the first @if@ should count as statements, and that perhaps the nested assignment should count as +2.)
+    (You might argue that the two assignments within the first @if@ should count as statements, and that perhaps the nested assignment should count as +2.)
 UncommunicativeMethodName:
   remediation_points: 150_000
   content: |

data/lib/reek/smell_detectors/class_variable.rb

@@ -25,8 +25,8 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
-        class_variables_in_context.map do |variable, occurences|
-          lines = occurences.map(&:line)
+        class_variables_in_context.map do |variable, occurrences|
+          lines = occurrences.map(&:line)
           smell_warning(
             lines: lines,
             message: "declares the class variable '#{variable}'",

data/lib/reek/smell_detectors/control_parameter_helpers/candidate.rb

@@ -9,20 +9,20 @@ module Reek
       class Candidate
         #
         # @param parameter [Symbol] the parameter name
-        # @param occurences [Array<Reek::AST::Node>] the occurences of the ControlParameter smell
+        # @param occurrences [Array<Reek::AST::Node>] the occurrences of the ControlParameter smell
         #   e.g. [s(:lvar, :bravo), s(:lvar, :bravo)]
         #
-        def initialize(parameter, occurences)
+        def initialize(parameter, occurrences)
           @parameter = parameter
-          @occurences = occurences
+          @occurrences = occurrences
         end
 
         def smells?
-          occurences.any?
+          occurrences.any?
         end
 
         def lines
-          occurences.map(&:line)
+          occurrences.map(&:line)
         end
 
         def name
@@ -31,7 +31,7 @@ module Reek
 
         private
 
-        attr_reader :occurences, :parameter
+        attr_reader :occurrences, :parameter
       end
     end
   end

data/lib/reek/smell_detectors/duplicate_method_call.rb

@@ -67,11 +67,11 @@ module Reek
       class FoundCall
         def initialize(call_node)
           @call_node = call_node
-          @occurences = []
+          @occurrences = []
         end
 
         def record(occurence)
-          occurences.push occurence
+          occurrences.push occurence
         end
 
         def call
@@ -79,16 +79,16 @@ module Reek
         end
 
         def occurs
-          occurences.length
+          occurrences.length
         end
 
         def lines
-          occurences.map(&:line)
+          occurrences.map(&:line)
         end
 
         private
 
-        attr_reader :call_node, :occurences
+        attr_reader :call_node, :occurrences
       end
 
       private_constant :FoundCall

data/lib/reek/spec/should_reek_of.rb

@@ -69,21 +69,21 @@ module Reek
       end
 
       def set_failure_messages_for_smell_type
-        self.failure_message = "Expected #{origin} to reek of #{smell_type}, "\
+        self.failure_message = "Expected #{origin} to reek of #{smell_type}, " \
                                'but it didn\'t'
-        self.failure_message_when_negated = "Expected #{origin} not to reek "\
+        self.failure_message_when_negated = "Expected #{origin} not to reek " \
                                             "of #{smell_type}, but it did"
       end
 
       def set_failure_messages_for_smell_details
         self.failure_message =
-          "Expected #{origin} to reek of #{smell_type} "\
-          "(which it did) with smell details #{smell_details}, which it didn't.\n"\
-          "The number of smell details I had to compare with the given one was #{matching_smell_types.count} "\
-          "and here they are:\n"\
+          "Expected #{origin} to reek of #{smell_type} " \
+          "(which it did) with smell details #{smell_details}, which it didn't.\n" \
+          "The number of smell details I had to compare with the given one was #{matching_smell_types.count} " \
+          "and here they are:\n" \
           "#{all_relevant_smell_details_formatted}"
         self.failure_message_when_negated =
-          "Expected #{origin} not to reek of "\
+          "Expected #{origin} not to reek of " \
           "#{smell_type} with smell details #{smell_details}, but it did"
       end
 

data/lib/reek/spec.rb

@@ -92,7 +92,7 @@ module Reek
     end
 
     #
-    # See the documentaton for "reek_of".
+    # See the documentation for "reek_of".
     #
     # Notable differences to reek_of:
     #   1.) "reek_of" doesn't mind if there are other smells of a different type.

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '6.1.1'
+    STRING = '6.1.2'
   end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 6.1.2
 platform: ruby
 authors:
 - Kevin Rutherford
 - Timo Roessner
 - Matijs van Zuijlen
 - Piotr Szotkowski
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kwalify
@@ -244,7 +244,7 @@ metadata:
   changelog_uri: https://github.com/troessner/reek/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/reek
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -263,8 +263,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Code smell detector for Ruby
 test_files: []