rubocop 0.82.0 → 0.86.0

data/lib/rubocop/cop/style/array_join.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for uses of "\*" as a substitute for *join*.
+      # This cop checks for uses of "*" as a substitute for _join_.
       #
       # Not all cases can reliably checked, due to Ruby's dynamic
       # types, so we consider only cases when the first argument is an

data/lib/rubocop/cop/style/attr.rb

@@ -35,9 +35,7 @@ module RuboCop
           node_expr = node.source_range
           attr_expr = attr_name.source_range
 
-          if setter&.boolean_type?
-            remove = range_between(attr_expr.end_pos, node_expr.end_pos)
-          end
+          remove = range_between(attr_expr.end_pos, node_expr.end_pos) if setter&.boolean_type?
 
           lambda do |corrector|
             corrector.replace(node.loc.selector, replacement_method(node))

data/lib/rubocop/cop/style/bare_percent_literals.rb

@@ -60,11 +60,11 @@ module RuboCop
         end
 
         def requires_percent_q?(source)
-          style == :percent_q && source =~ /^%[^\w]/
+          style == :percent_q && /^%[^\w]/.match?(source)
         end
 
         def requires_bare_percent?(source)
-          style == :bare_percent && source =~ /^%Q/
+          style == :bare_percent && source.start_with?('%Q')
         end
 
         def add_offense_for_wrong_style(node, good, bad)

data/lib/rubocop/cop/style/block_delimiters.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/ClassLength
 module RuboCop
   module Cop
     module Style
@@ -210,9 +209,7 @@ module RuboCop
         end
 
         def message(node)
-          if braces_required_method?(node.method_name)
-            return braces_required_message(node)
-          end
+          return braces_required_message(node) if braces_required_method?(node.method_name)
 
           case style
           when :line_count_based    then line_count_based_message(node)
@@ -248,14 +245,13 @@ module RuboCop
         end
 
         def whitespace_before?(range)
-          range.source_buffer.source[range.begin_pos - 1, 1] =~ /\s/
+          /\s/.match?(range.source_buffer.source[range.begin_pos - 1, 1])
         end
 
         def whitespace_after?(range, length = 1)
-          range.source_buffer.source[range.begin_pos + length, 1] =~ /\s/
+          /\s/.match?(range.source_buffer.source[range.begin_pos + length, 1])
         end
 
-        # rubocop:disable Metrics/CyclomaticComplexity
         def get_blocks(node, &block)
           case node.type
           when :block
@@ -273,12 +269,9 @@ module RuboCop
             node.each_child_node { |child| get_blocks(child, &block) }
           end
         end
-        # rubocop:enable Metrics/CyclomaticComplexity
 
         def proper_block_style?(node)
-          if special_method?(node.method_name)
-            return special_method_proper_block_style?(node)
-          end
+          return special_method_proper_block_style?(node) if special_method?(node.method_name)
 
           case style
           when :line_count_based    then line_count_based_block_style?(node)
@@ -387,4 +380,3 @@ module RuboCop
     end
   end
 end
-# rubocop:enable Metrics/ClassLength

data/lib/rubocop/cop/style/case_equality.rb

@@ -42,7 +42,7 @@ module RuboCop
 
         def const?(node)
           if cop_config.fetch('AllowOnConstant', false)
-            !node.const_type?
+            !node&.const_type?
           else
             true
           end

data/lib/rubocop/cop/style/class_and_module_children.rb

@@ -143,7 +143,7 @@ module RuboCop
         end
 
         def compact_node_name?(node)
-          node.loc.name.source =~ /::/
+          /::/.match?(node.loc.name.source)
         end
       end
     end

data/lib/rubocop/cop/style/command_literal.rb

@@ -153,7 +153,7 @@ module RuboCop
         end
 
         def contains_backtick?(node)
-          node_body(node) =~ /`/
+          /`/.match?(node_body(node))
         end
 
         def node_body(node)

data/lib/rubocop/cop/style/commented_keyword.rb

@@ -55,8 +55,8 @@ module RuboCop
 
         def offensive?(comment)
           line = line(comment)
-          KEYWORDS.any? { |word| line =~ /^\s*#{word}\s/ } &&
-            ALLOWED_COMMENTS.none? { |c| line =~ /#\s*#{c}/ }
+          KEYWORDS.any? { |word| /^\s*#{word}\s/.match?(line) } &&
+            ALLOWED_COMMENTS.none? { |c| /#\s*#{c}/.match?(line) }
         end
 
         def message(comment)

data/lib/rubocop/cop/style/conditional_assignment.rb

@@ -67,7 +67,7 @@ module RuboCop
 
         private
 
-        def expand_elsif(node, elsif_branches = [])
+        def expand_elsif(node, elsif_branches = []) # rubocop:todo Metrics/CyclomaticComplexity
           return [] if node.nil? || !node.if_type? || !node.elsif?
 
           elsif_branches << node.if_branch
@@ -312,9 +312,7 @@ module RuboCop
           # ignore pseudo-assignments without rhs in for nodes
           return if node.parent&.for_type?
 
-          if assignment.begin_type? && assignment.children.one?
-            assignment, = *assignment
-          end
+          assignment, = *assignment if assignment.begin_type? && assignment.children.one?
 
           assignment
         end

data/lib/rubocop/cop/style/copyright.rb

@@ -8,8 +8,8 @@ module RuboCop
       # The default regexp for an acceptable copyright notice can be found in
       # config/default.yml. The default can be changed as follows:
       #
-      #     Style/Copyright:
-      #       Notice: '^Copyright (\(c\) )?2\d{3} Acme Inc'
+      #  Style/Copyright:
+      #    Notice: '^Copyright (\(c\) )?2\d{3} Acme Inc'
       #
       # This regex string is treated as an unanchored regex. For each file
       # that RuboCop scans, a comment that matches this regex must be found or
@@ -72,14 +72,14 @@ module RuboCop
           return false if token_index >= processed_source.tokens.size
 
           token = processed_source.tokens[token_index]
-          token.comment? && token.text =~ /^#!.*$/
+          token.comment? && /^#!.*$/.match?(token.text)
         end
 
         def encoding_token?(processed_source, token_index)
           return false if token_index >= processed_source.tokens.size
 
           token = processed_source.tokens[token_index]
-          token.comment? && token.text =~ /^#.*coding\s?[:=]\s?(?:UTF|utf)-8/
+          token.comment? && /^#.*coding\s?[:=]\s?(?:UTF|utf)-8/.match?(token.text)
         end
 
         def notice_found?(processed_source)
@@ -88,7 +88,7 @@ module RuboCop
           processed_source.each_token do |token|
             break unless token.comment?
 
-            notice_found = !(token.text =~ notice_regexp).nil?
+            notice_found = notice_regexp.match?(token.text)
             break if notice_found
           end
           notice_found

data/lib/rubocop/cop/style/disable_cops_within_source_code_directive.rb

@@ -41,7 +41,7 @@ module RuboCop
         private
 
         def rubocop_directive_comment?(comment)
-          comment.text =~ CommentConfig::COMMENT_DIRECTIVE_REGEXP
+          CommentConfig::COMMENT_DIRECTIVE_REGEXP.match?(comment.text)
         end
       end
     end

data/lib/rubocop/cop/style/documentation.rb

@@ -104,7 +104,7 @@ module RuboCop
         end
 
         def compact_namespace?(node)
-          node.loc.name.source =~ /::/
+          /::/.match?(node.loc.name.source)
         end
 
         # First checks if the :nodoc: comment is associated with the
@@ -123,7 +123,7 @@ module RuboCop
         end
 
         def nodoc?(comment, require_all = false)
-          comment.text =~ /^#\s*:nodoc:#{"\s+all\s*$" if require_all}/
+          /^#\s*:nodoc:#{"\s+all\s*$" if require_all}/.match?(comment.text)
         end
 
         def nodoc(node)

data/lib/rubocop/cop/style/double_negation.rb

@@ -3,32 +3,69 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for uses of double negation (!!) to convert something
-      # to a boolean value. As this is both cryptic and usually redundant, it
-      # should be avoided.
+      # This cop checks for uses of double negation (`!!`) to convert something to a boolean value.
       #
-      # @example
+      # When using `EnforcedStyle: allowed_in_returns`, allow double nagation in contexts
+      # that use boolean as a return value. When using `EnforcedStyle: forbidden`, double nagation
+      # should be forbidden always.
       #
+      # @example
       #   # bad
       #   !!something
       #
       #   # good
       #   !something.nil?
       #
+      # @example EnforcedStyle: allowed_in_returns (default)
+      #   # good
+      #   def foo?
+      #     !!return_value
+      #   end
+      #
+      # @example EnforcedStyle: forbidden
+      #   # bad
+      #   def foo?
+      #     !!return_value
+      #   end
+      #
       # Please, note that when something is a boolean value
       # !!something and !something.nil? are not the same thing.
       # As you're unlikely to write code that can accept values of any type
       # this is rarely a problem in practice.
       class DoubleNegation < Cop
+        include ConfigurableEnforcedStyle
+
         MSG = 'Avoid the use of double negation (`!!`).'
 
         def_node_matcher :double_negative?, '(send (send _ :!) :!)'
 
         def on_send(node)
           return unless double_negative?(node) && node.prefix_bang?
+          return if style == :allowed_in_returns && allowed_in_returns?(node)
 
           add_offense(node, location: :selector)
         end
+
+        private
+
+        def allowed_in_returns?(node)
+          node.parent&.return_type? || end_of_method_definition?(node)
+        end
+
+        def end_of_method_definition?(node)
+          return false unless (def_node = find_def_node_from_ascendant(node))
+
+          last_child = def_node.child_nodes.last
+
+          last_child.last_line == node.last_line
+        end
+
+        def find_def_node_from_ascendant(node)
+          return unless (parent = node.parent)
+          return parent if parent.def_type? || parent.defs_type?
+
+          find_def_node_from_ascendant(node.parent)
+        end
       end
     end
   end

data/lib/rubocop/cop/style/empty_case_condition.rb

@@ -43,13 +43,15 @@ module RuboCop
 
         def on_case(case_node)
           return if case_node.condition
-          return if case_node.when_branches.any? do |when_branch|
-            when_branch.each_descendant.any?(&:return_type?)
-          end
 
-          if (else_branch = case_node.else_branch)
-            return if else_branch.return_type? ||
-                      else_branch.each_descendant.any?(&:return_type?)
+          branch_bodies = [
+            *case_node.when_branches.map(&:body),
+            case_node.else_branch
+          ].compact
+
+          return if branch_bodies.any? do |body|
+            body.return_type? ||
+            body.each_descendant.any?(&:return_type?)
           end
 
           add_offense(case_node, location: :keyword)

data/lib/rubocop/cop/style/empty_literal.rb

@@ -68,9 +68,7 @@ module RuboCop
 
         def first_argument_unparenthesized?(node)
           parent = node.parent
-          unless parent && %i[send super zsuper].include?(parent.type)
-            return false
-          end
+          return false unless parent && %i[send super zsuper].include?(parent.type)
 
           node.object_id == parent.arguments.first.object_id &&
             !parentheses?(node.parent)

data/lib/rubocop/cop/style/empty_method.rb

@@ -8,7 +8,7 @@ module RuboCop
       # line (compact style), but it can be configured to enforce the `end`
       # to go on its own line (expanded style).
       #
-      # Note: A method definition is not considered empty if it contains
+      # NOTE: A method definition is not considered empty if it contains
       #       comments.
       #
       # @example EnforcedStyle: compact (default)
@@ -90,10 +90,6 @@ module RuboCop
           compact_style? ? '; ' : "\n#{indent}"
         end
 
-        def comment_lines?(node)
-          processed_source[line_range(node)].any? { |line| comment_line?(line) }
-        end
-
         def compact?(node)
           node.single_line?
         end

data/lib/rubocop/cop/style/encoding.rb

@@ -42,7 +42,7 @@ module RuboCop
         end
 
         def encoding_omitable?(line)
-          line =~ ENCODING_PATTERN
+          ENCODING_PATTERN.match?(line)
         end
 
         def encoding_line_number(processed_source)

data/lib/rubocop/cop/style/exponential_notation.rb

@@ -5,12 +5,12 @@ module RuboCop
     module Style
       # This cop enforces consistency when using exponential notation
       # for numbers in the code (eg 1.2e4). Different styles are supported:
-      # - `scientific` which enforces a mantissa between 1 (inclusive)
+      # * `scientific` which enforces a mantissa between 1 (inclusive)
       #                and 10 (exclusive).
-      # - `engineering` which enforces the exponent to be a multiple of 3
+      # * `engineering` which enforces the exponent to be a multiple of 3
       #                 and the mantissa to be between 0.1 (inclusive)
       #                 and 10 (exclusive).
-      # - `integral` which enforces the mantissa to always be a whole number
+      # * `integral` which enforces the mantissa to always be a whole number
       #              without trailing zeroes.
       #
       # @example EnforcedStyle: scientific (default)
@@ -69,7 +69,7 @@ module RuboCop
 
         def scientific?(node)
           mantissa, = node.source.split('e')
-          mantissa =~ /^-?[1-9](\.\d*[0-9])?$/
+          /^-?[1-9](\.\d*[0-9])?$/.match?(mantissa)
         end
 
         def engineering?(node)
@@ -85,7 +85,7 @@ module RuboCop
 
         def integral(node)
           mantissa, = node.source.split('e')
-          mantissa =~ /^-?[1-9](\d*[1-9])?$/
+          /^-?[1-9](\d*[1-9])?$/.match?(mantissa)
         end
 
         def offense?(node)

data/lib/rubocop/cop/style/format_string_token.rb

@@ -5,11 +5,10 @@ module RuboCop
     module Style
       # Use a consistent style for named format string tokens.
       #
-      # **Note:**
-      # `unannotated` style cop only works for strings
+      # NOTE: `unannotated` style cop only works for strings
       # which are passed as arguments to those methods:
       # `printf`, `sprintf`, `format`, `%`.
-      # The reason is that *unannotated* format is very similar
+      # The reason is that _unannotated_ format is very similar
       # to encoded URLs or Date/Time formatting strings.
       #
       # @example EnforcedStyle: annotated (default)

data/lib/rubocop/cop/style/frozen_string_literal_comment.rb

@@ -8,8 +8,7 @@ module RuboCop
       # It will add the comment `# frozen_string_literal: true` to the top of
       # files to enable frozen string literals. Frozen string literals may be
       # default in future Ruby. The comment will be added below a shebang and
-      # encoding comment. The frozen string literal comment is only valid in
-      # Ruby 2.3+.
+      # encoding comment.
       #
       # Note that the cop will ignore files where the comment exists but is set
       # to `false` instead of `true`.
@@ -149,9 +148,7 @@ module RuboCop
           end
 
           next_token = processed_source.tokens[token_number]
-          if next_token && next_token.text =~ Encoding::ENCODING_PATTERN
-            token = next_token
-          end
+          token = next_token if Encoding::ENCODING_PATTERN.match?(next_token&.text)
 
           token
         end
@@ -216,7 +213,7 @@ module RuboCop
           if comment
             corrector.insert_after(line_range(comment.line), following_comment)
           else
-            corrector.insert_before(line_range(1), preceding_comment)
+            corrector.insert_before(processed_source.buffer.source_range, preceding_comment)
           end
         end
 

data/lib/rubocop/cop/style/guard_clause.rb

@@ -35,6 +35,17 @@ module RuboCop
       #   # good
       #   raise 'exception' if something
       #   ok
+      #
+      #   # bad
+      #   if something
+      #     foo || raise('exception')
+      #   else
+      #     ok
+      #   end
+      #
+      #   # good
+      #   foo || raise('exception') if something
+      #   ok
       class GuardClause < Cop
         include MinBodyLength
         include StatementModifier
@@ -69,7 +80,8 @@ module RuboCop
                else
                  opposite_keyword(node)
                end
-          register_offense(node, guard_clause.source, kw)
+
+          register_offense(node, guard_clause_source(guard_clause), kw)
         end
 
         private
@@ -98,13 +110,24 @@ module RuboCop
                       message: format(MSG, example: example))
         end
 
+        def guard_clause_source(guard_clause)
+          parent = guard_clause.parent
+
+          if parent.and_type? || parent.or_type?
+            guard_clause.parent.source
+          else
+            guard_clause.source
+          end
+        end
+
         def too_long_for_single_line?(node, example)
           max = max_line_length
           max && node.source_range.column + example.length > max
         end
 
         def accepted_form?(node, ending = false)
-          accepted_if?(node, ending) || node.condition.multiline?
+          accepted_if?(node, ending) || node.condition.multiline? ||
+            node.parent&.assignment?
         end
 
         def accepted_if?(node, ending)