rubocop 0.58.2 → 0.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3195801b4e3ffa9ab52997ec2600cdc62b5c4e23
-  data.tar.gz: 8b1276d6c0101f1556d374e67d1749010b53542a
+  metadata.gz: 3604f5385c9cdb9a48c56e4b02e873b1f03adc3c
+  data.tar.gz: '039e08df8dc0c3fa47b0a035e650dbdc52068527'
 SHA512:
-  metadata.gz: a5dff57a5eeecb51495820462954f998817b9ad3b9018e603ee0f2f79ea8445e9e4bbe49578f3bdb091fbe47a8f53d179c3713c449fbc6510a7f068f96e7c015
-  data.tar.gz: 0a4d5da0871e328ca5bd9de6b048d3eac8e74a6b95f6682f0ddfbd220a6e4b13a4925e4d31473184fc0bfe818245a93d40225b2353011f88cf12da55e026dd32
+  metadata.gz: 0c6b9b6cce39cf4f4977f691a58b43362249e537e798ecb52d639147b8a92df7b32b6aa8553258b66f7093638c0afc11427390ea71cb90c872dbc8510d14359f
+  data.tar.gz: 2f529fb7c60a2ffc733582edec86c1f66059a41e23a0835adf4d3f05593e6e49d0b061d91d06e4e968e7d5c544505e6781a71bfbe20234262eaa080091d86ffe

data/README.md

@@ -54,7 +54,7 @@ haven't reached version 1.0 yet). To prevent an unwanted RuboCop update you
 might want to use a conservative version locking in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 0.58.2', require: false
+gem 'rubocop', '~> 0.59.0', require: false
 ```
 
 ## Quickstart

data/config/default.yml

@@ -96,7 +96,7 @@ AllCops:
   # cops in user configuration will be enabled even if they don't set the
   # Enabled parameter.
   # When `EnabledByDefault` is `true`, all cops, even those in disabled.yml,
-  # are enabled by default.  Cops can still be disabled in user configuration.
+  # are enabled by default. Cops can still be disabled in user configuration.
   # Note that it is invalid to set both EnabledByDefault and DisabledByDefault
   # to true in the same configuration.
   EnabledByDefault: false
@@ -132,11 +132,11 @@ AllCops:
   # use the oldest officially supported Ruby version (currently Ruby 2.2).
   TargetRubyVersion: ~
   # What version of Rails is the inspected code using?  If a value is specified
-  # for TargetRailsVersion then it is used.  Acceptable values are specificed
+  # for TargetRailsVersion then it is used. Acceptable values are specificed
   # as a float (i.e. 5.1); the patch version of Rails should not be included.
   # If TargetRailsVersion is not set, RuboCop will parse the Gemfile.lock or
   # gems.locked file to find the version of Rails that has been bound to the
-  # application.  If neither of those files exist, RuboCop will use Rails 5.0
+  # application. If neither of those files exist, RuboCop will use Rails 5.0
   # as the default.
   TargetRailsVersion: ~
 
@@ -669,8 +669,8 @@ Layout/TrailingWhitespace:
 #################### Naming ##########################
 
 Naming/FileName:
-  # File names listed in `AllCops:Include` are excluded by default. Add extra
-  # excludes here.
+  # Camel case file names listed in `AllCops:Include` and all file names listed
+  # in `AllCops:Exclude` are excluded by default. Add extra excludes here.
   Exclude: []
   # When `true`, requires that each source file should define a class or module
   # with a name which matches the file name (converted to ... case).
@@ -798,6 +798,7 @@ Naming/UncommunicativeMethodParamName:
     - in
     - at
     - ip
+    - db
   # Blacklisted names that will register an offense
   ForbiddenNames: []
 
@@ -1015,7 +1016,7 @@ Style/ConditionalAssignment:
 # You can override the default Notice in your .rubocop.yml file.
 #
 # In order to use autocorrect, you must supply a value for the
-# `AutocorrectNotice` key that matches the regexp Notice.  A blank
+# `AutocorrectNotice` key that matches the regexp Notice. A blank
 # `AutocorrectNotice` will cause an error during autocorrect.
 #
 # Autocorrect will add a copyright notice in a comment at the top
@@ -1246,6 +1247,12 @@ Style/Next:
     - skip_modifier_ifs
     - always
 
+Style/NilComparison:
+  EnforcedStyle: predicate
+  SupportedStyles:
+    - predicate
+    - comparison
+
 Style/NonNilCheck:
   # With `IncludeSemanticChanges` set to `true`, this cop reports offenses for
   # `!x.nil?` and autocorrects that and `x != nil` to solely `x`, which is
@@ -1270,6 +1277,7 @@ Style/NumericPredicate:
   SupportedStyles:
     - predicate
     - comparison
+  IgnoredMethods: []
   # Exclude RSpec specs because assertions like `expect(1).to be > 0` cause
   # false positives.
   Exclude:
@@ -1528,7 +1536,7 @@ Style/WordArray:
     # bracket style: ['word1', 'word2']
     - brackets
   # The `MinSize` option causes the `WordArray` rule to be ignored for arrays
-  # smaller than a certain size.  The rule is only applied to arrays
+  # smaller than a certain size. The rule is only applied to arrays
   # whose element count is greater than or equal to `MinSize`.
   MinSize: 2
   # The regular expression `WordRegex` decides what is considered a word.
@@ -1802,6 +1810,9 @@ Rails/RefuteMethods:
   Include:
     - '**/test/**/*'
 
+Rails/RelativeDateConstant:
+  AutoCorrect: false
+
 Rails/RequestReferer:
   EnforcedStyle: referer
   SupportedStyles:
@@ -1819,6 +1830,10 @@ Rails/SafeNavigation:
   # implement the intended method. `try` will not raise an exception for this.
   ConvertTry: false
 
+Rails/SaveBang:
+  AllowImplicitReturn: true
+  AllowedReceivers: []
+
 Rails/ScopeArgs:
   Include:
     - app/models/**/*.rb

data/config/disabled.yml

@@ -1,14 +1,19 @@
 # These are all the cops that are disabled in the default configuration.
 
+Bundler/GemComment:
+  Description: 'Add a comment describing each gem.'
+  Enabled: false
+  Include:
+    - '**/*.gemfile'
+    - '**/Gemfile'
+    - '**/gems.rb'
+  Whitelist: []
+
 Layout/ClassStructure:
   Description: 'Enforces a configured order of definitions within a class body.'
   StyleGuide: 'https://github.com/rubocop-hq/ruby-style-guide#consistent-classes'
   Enabled: false
 
-Layout/EmptyLineAfterGuardClause:
-  Description: 'Add empty line after guard clause.'
-  Enabled: false
-
 Layout/FirstArrayElementLineBreak:
   Description: >-
                  Checks for a line break before the first element in a
@@ -42,6 +47,20 @@ Lint/NumberConversion:
   Description: 'Checks unsafe usage of number conversion methods.'
   Enabled: false
 
+Performance/CaseWhenSplat:
+  Description: >-
+                 Reordering `when` conditions with a splat to the end
+                 of the `when` branches can improve performance.
+  Enabled: false
+  AutoCorrect: false
+
+Performance/ChainArrayAllocation:
+  Description: >-
+                  Instead of chaining array methods that allocate new arrays, mutate an
+                  existing array.
+  Reference: 'https://twitter.com/schneems/status/1034123879978029057'
+  Enabled: false
+
 # By default, the rails cops are not run. Override in project or home
 # directory .rubocop.yml files, or by giving the -R/--rails option.
 Rails:
@@ -65,6 +84,12 @@ Style/Copyright:
   Description: 'Include a copyright notice in each file before any code.'
   Enabled: false
 
+Style/DateTime:
+  Description: 'Use Time over DateTime.'
+  StyleGuide: '#date--time'
+  Enabled: false
+  AllowCoercion: false
+
 Style/DocumentationMethod:
   Description: 'Public methods.'
   Enabled: false
@@ -105,6 +130,10 @@ Style/MissingElse:
                 Style/EmptyElse is configured to style "both"
   Enabled: false
 
+Style/MultilineMethodSignature:
+  Description: 'Avoid multi-line method signatures.'
+  Enabled: false
+
 Style/OptionHash:
   Description: "Don't use option hashes when you can use keyword arguments."
   Enabled: false

data/config/enabled.yml

@@ -127,6 +127,10 @@ Layout/EmptyComment:
   Description: 'Checks empty comment.'
   Enabled: true
 
+Layout/EmptyLineAfterGuardClause:
+  Description: 'Add empty line after guard clause.'
+  Enabled: true
+
 Layout/EmptyLineAfterMagicComment:
   Description: 'Add an empty line after magic comments to separate them from code.'
   StyleGuide: '#separate-magic-comments-from-code'
@@ -921,12 +925,6 @@ Performance/Caller:
              Use `caller(n..n)` instead of `caller`.
   Enabled: true
 
-Performance/CaseWhenSplat:
-  Description: >-
-                  Place `when` conditions that use splat at the end
-                  of the list of `when` branches.
-  Enabled: true
-
 Performance/Casecmp:
   Description: >-
              Use `casecmp` rather than `downcase ==`, `upcase ==`, `== downcase`, or `== upcase`..
@@ -1459,11 +1457,6 @@ Style/ConditionalAssignment:
                  of assigning that variable inside of each branch.
   Enabled: true
 
-Style/DateTime:
-  Description: 'Use Date or Time over DateTime.'
-  StyleGuide: '#date--time'
-  Enabled: true
-
 Style/DefWithParentheses:
   Description: 'Use def with parentheses when there are arguments.'
   StyleGuide: '#method-parens'

data/lib/rubocop.rb

@@ -40,6 +40,7 @@ require_relative 'rubocop/ast/node/array_node'
 require_relative 'rubocop/ast/node/block_node'
 require_relative 'rubocop/ast/node/case_node'
 require_relative 'rubocop/ast/node/def_node'
+require_relative 'rubocop/ast/node/defined_node'
 require_relative 'rubocop/ast/node/ensure_node'
 require_relative 'rubocop/ast/node/for_node'
 require_relative 'rubocop/ast/node/hash_node'
@@ -111,6 +112,7 @@ require_relative 'rubocop/cop/mixin/first_element_line_break'
 require_relative 'rubocop/cop/mixin/frozen_string_literal'
 require_relative 'rubocop/cop/mixin/hash_alignment'
 require_relative 'rubocop/cop/mixin/ignored_pattern'
+require_relative 'rubocop/cop/mixin/ignored_methods'
 require_relative 'rubocop/cop/mixin/integer_node'
 require_relative 'rubocop/cop/mixin/match_range'
 require_relative 'rubocop/cop/mixin/method_complexity'
@@ -158,6 +160,7 @@ require_relative 'rubocop/cop/correctors/string_literal_corrector'
 require_relative 'rubocop/cop/correctors/unused_arg_corrector'
 
 require_relative 'rubocop/cop/bundler/duplicated_gem'
+require_relative 'rubocop/cop/bundler/gem_comment'
 require_relative 'rubocop/cop/bundler/insecure_protocol_source'
 require_relative 'rubocop/cop/bundler/ordered_gems'
 
@@ -378,6 +381,7 @@ require_relative 'rubocop/cop/performance/times_map'
 require_relative 'rubocop/cop/performance/unfreeze_string'
 require_relative 'rubocop/cop/performance/unneeded_sort'
 require_relative 'rubocop/cop/performance/uri_default_parser'
+require_relative 'rubocop/cop/performance/chain_array_allocation'
 
 require_relative 'rubocop/cop/style/access_modifier_declarations'
 require_relative 'rubocop/cop/style/alias'
@@ -459,6 +463,7 @@ require_relative 'rubocop/cop/style/module_function'
 require_relative 'rubocop/cop/style/multiline_block_chain'
 require_relative 'rubocop/cop/style/multiline_if_then'
 require_relative 'rubocop/cop/style/multiline_if_modifier'
+require_relative 'rubocop/cop/style/multiline_method_signature'
 require_relative 'rubocop/cop/style/multiline_memoization'
 require_relative 'rubocop/cop/style/multiline_ternary_operator'
 require_relative 'rubocop/cop/style/multiple_comparison'

data/lib/rubocop/ast/builder.rb

@@ -21,6 +21,7 @@ module RuboCop
         block:      BlockNode,
         case:       CaseNode,
         def:        DefNode,
+        defined?:   DefinedNode,
         defs:       DefNode,
         ensure:     EnsureNode,
         for:        ForNode,

data/lib/rubocop/ast/node.rb

@@ -24,7 +24,6 @@ module RuboCop
 
       # <=> isn't included here, because it doesn't return a boolean.
       COMPARISON_OPERATORS = %i[== === != <= >= > <].freeze
-      ARITHMETIC_OPERATORS = %i[+ - * / % **].freeze
 
       TRUTHY_LITERALS = %i[str dstr xstr int float sym dsym array
                            hash regexp true irange erange complex
@@ -182,6 +181,7 @@ module RuboCop
 
         children.each do |child|
           next unless child.is_a?(Node)
+
           yield child if types.empty? || types.include?(child.type)
         end
 
@@ -280,6 +280,7 @@ module RuboCop
 
       def line_count
         return 0 unless source_range
+
         source_range.last_line - source_range.first_line + 1
       end
 
@@ -297,16 +298,13 @@ module RuboCop
         {(send $_ ...) (block (send $_ ...) ...)}
       PATTERN
 
-      def_node_matcher :method_name, <<-PATTERN
-        {(send _ $_ ...) (block (send _ $_ ...) ...)}
-      PATTERN
-
       # Note: for masgn, #asgn_rhs will be an array node
       def_node_matcher :asgn_rhs, '[assignment? (... $_)]'
       def_node_matcher :str_content, '(str $_)'
 
       def const_name
         return unless const_type?
+
         namespace, name = *self
         if namespace && !namespace.cbase_type?
           "#{namespace.const_name}::#{name}"
@@ -360,15 +358,6 @@ module RuboCop
         source_length.zero?
       end
 
-      def asgn_method_call?
-        !COMPARISON_OPERATORS.include?(method_name) &&
-          method_name.to_s.end_with?('='.freeze)
-      end
-
-      def arithmetic_operation?
-        ARITHMETIC_OPERATORS.include?(method_name)
-      end
-
       def_node_matcher :equals_asgn?, <<-PATTERN
         {lvasgn ivasgn cvasgn gvasgn casgn masgn}
       PATTERN
@@ -376,7 +365,7 @@ module RuboCop
       def_node_matcher :shorthand_asgn?, '{op_asgn or_asgn and_asgn}'
 
       def_node_matcher :assignment?, <<-PATTERN
-        {equals_asgn? shorthand_asgn? asgn_method_call?}
+        {equals_asgn? shorthand_asgn?}
       PATTERN
 
       # Some cops treat the shovel operator as a kind of assignment.
@@ -414,10 +403,9 @@ module RuboCop
         define_method(recursive_kind) do
           case type
           when :send
-            receiver, method_name, *args = *self
             [*COMPARISON_OPERATORS, :!, :<=>].include?(method_name) &&
               receiver.send(recursive_kind) &&
-              args.all?(&recursive_kind)
+              arguments.all?(&recursive_kind)
           when :begin, :pair, *OPERATOR_KEYWORDS, *COMPOSITE_LITERALS
             children.all?(&recursive_kind)
           else
@@ -435,7 +423,7 @@ module RuboCop
       end
 
       def keyword?
-        return true if special_keyword? || keyword_not?
+        return true if special_keyword? || send_type? && prefix_not?
         return false unless KEYWORDS.include?(type)
 
         !OPERATOR_KEYWORDS.include?(type) || loc.operator.is?(type.to_s)
@@ -449,24 +437,16 @@ module RuboCop
         OPERATOR_KEYWORDS.include?(type)
       end
 
-      def keyword_not?
-        _receiver, method_name, *args = *self
-        args.empty? && method_name == :! && loc.selector.is?('not'.freeze)
-      end
-
-      def keyword_bang?
-        _receiver, method_name, *args = *self
-        args.empty? && method_name == :! && loc.selector.is?('!'.freeze)
-      end
-
       def unary_operation?
         return false unless loc.respond_to?(:selector) && loc.selector
+
         Cop::Util.operator?(loc.selector.source.to_sym) &&
           source_range.begin_pos == loc.selector.begin_pos
       end
 
       def binary_operation?
         return false unless loc.respond_to?(:selector) && loc.selector
+
         Cop::Util.operator?(method_name) &&
           source_range.begin_pos != loc.selector.begin_pos
       end
@@ -476,14 +456,11 @@ module RuboCop
       end
 
       def chained?
-        return false unless argument?
-
-        receiver, _method_name, *_args = *parent
-        equal?(receiver)
+        parent && parent.send_type? && eql?(parent.receiver)
       end
 
       def argument?
-        parent && parent.send_type?
+        parent && parent.send_type? && parent.arguments.include?(self)
       end
 
       def numeric_type?
@@ -641,6 +618,7 @@ module RuboCop
           # `class_eval` with no receiver applies to whatever module or class
           # we are currently in
           return unless (receiver = ancestor.receiver)
+
           yield unless receiver.const_type?
           receiver.const_name
         elsif !new_class_or_module_block?(ancestor)

data/lib/rubocop/ast/node/block_node.rb

@@ -32,6 +32,13 @@ module RuboCop
         node_parts[2]
       end
 
+      # The name of the dispatched method as a symbol.
+      #
+      # @return [Symbol] the name of the dispatched method
+      def method_name
+        send_node.method_name
+      end
+
       # Checks whether this block takes any arguments.
       #
       # @return [Boolean] whether this `block` node takes any arguments
@@ -101,7 +108,7 @@ module RuboCop
       #
       # @return [Boolean] whether the `block` node body is a void context
       def void_context?
-        VOID_CONTEXT_METHODS.include?(send_node.method_name)
+        VOID_CONTEXT_METHODS.include?(method_name)
       end
     end
   end

data/lib/rubocop/ast/node/defined_node.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `defined?` nodes. This will be used in place of a
+    # plain node when the builder constructs the AST, making its methods
+    # available to all `send` nodes within RuboCop.
+    class DefinedNode < Node
+      include ParameterizedNode
+      include MethodDispatchNode
+    end
+  end
+end

data/lib/rubocop/ast/node/mixin/method_dispatch_node.rb

@@ -8,6 +8,8 @@ module RuboCop
       extend NodePattern::Macros
       include MethodIdentifierPredicates
 
+      ARITHMETIC_OPERATORS = %i[+ - * / % **].freeze
+
       # The receiving node of the method dispatch.
       #
       # @return [Node, nil] the receiver of the dispatched method or `nil`
@@ -29,6 +31,14 @@ module RuboCop
         node_parts[2..-1]
       end
 
+      # The `block` node associated with this method dispatch, if any.
+      #
+      # @return [BlockNode, nil] the `block` node associated with this method
+      #                          call or `nil`
+      def block_node
+        parent if block_literal?
+      end
+
       # Checks whether the dispatched method is a macro method. A macro method
       # is defined as a method that sits in a class, module, or block body and
       # has an implicit receiver.
@@ -80,6 +90,7 @@ module RuboCop
       def setter_method?
         loc.respond_to?(:operator) && loc.operator
       end
+      alias assignment? setter_method?
 
       # Checks whether the dispatched method uses a dot to connect the
       # receiver and the method name.
@@ -132,12 +143,12 @@ module RuboCop
         parent && parent.block_type? && eql?(parent.send_node)
       end
 
-      # The `block` node associated with this method dispatch, if any.
+      # Checks whether this node is an arithmetic operation
       #
-      # @return [BlockNode, nil] the `block` node associated with this method
-      #                          call or `nil`
-      def block_node
-        parent if block_literal?
+      # @return [Boolean] whether the dispatched method is an arithmetic
+      #                   operation
+      def arithmetic_operation?
+        ARITHMETIC_OPERATORS.include?(method_name)
       end
 
       # Checks if this node is part of a chain of `def` modifiers.