rubocop 1.9.0 → 1.12.1

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

@@ -81,10 +81,12 @@ module RuboCop
         MSG_EXPLICIT = 'Avoid rescuing without specifying ' \
           'an error class.'
 
+        # @!method rescue_without_error_class?(node)
         def_node_matcher :rescue_without_error_class?, <<~PATTERN
           (resbody nil? _ _)
         PATTERN
 
+        # @!method rescue_standard_error?(node)
         def_node_matcher :rescue_standard_error?, <<~PATTERN
           (resbody $(array (const {nil? cbase} :StandardError)) _ _)
         PATTERN

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

@@ -35,7 +35,10 @@ module RuboCop
         RETURN_MSG = 'Use `return` instead of `return nil`.'
         RETURN_NIL_MSG = 'Use `return nil` instead of `return`.'
 
+        # @!method return_node?(node)
         def_node_matcher :return_node?, '(return)'
+
+        # @!method return_nil_node?(node)
         def_node_matcher :return_nil_node?, '(return nil)'
 
         def on_return(node)
@@ -79,7 +82,10 @@ module RuboCop
           node.def_type? || node.defs_type? || node.lambda?
         end
 
+        # @!method chained_send?(node)
         def_node_matcher :chained_send?, '(send !nil? ...)'
+
+        # @!method define_method?(node)
         def_node_matcher :define_method?, <<~PATTERN
           (send _ {:define_method :define_singleton_method} _)
         PATTERN

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

@@ -74,6 +74,7 @@ module RuboCop
 
         # if format: (if checked_variable body nil)
         # unless format: (if checked_variable nil body)
+        # @!method modifier_if_safe_navigation_candidate(node)
         def_node_matcher :modifier_if_safe_navigation_candidate, <<~PATTERN
           {
             (if {
@@ -88,6 +89,7 @@ module RuboCop
           }
         PATTERN
 
+        # @!method not_nil_check?(node)
         def_node_matcher :not_nil_check?, '(send (send $_ :nil?) :!)'
 
         def on_if(node)

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

@@ -33,6 +33,7 @@ module RuboCop
         MSG = 'Use `%<correct>s` instead of `%<incorrect>s`.'
         RESTRICT_ON_SEND = %i[first last [] at slice].freeze
 
+        # @!method sample_candidate?(node)
         def_node_matcher :sample_candidate?, <<~PATTERN
           (send $(send _ :shuffle $...) ${:#{RESTRICT_ON_SEND.join(' :')}} $...)
         PATTERN

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

@@ -114,7 +114,10 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[raise fail].freeze
 
+        # @!method kernel_call?(node, name)
         def_node_matcher :kernel_call?, '(send (const {nil? cbase} :Kernel) %1 ...)'
+
+        # @!method custom_fail_methods(node)
         def_node_search :custom_fail_methods,
                         '{(def :fail ...) (defs _ :fail ...)}'
 

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

@@ -29,6 +29,7 @@ module RuboCop
         MSG = 'Use `%<receiver>s[%<argument>s]` instead of `%<original>s`.'
         RESTRICT_ON_SEND = %i[dig].freeze
 
+        # @!method single_argument_dig?(node)
         def_node_matcher :single_argument_dig?, <<~PATTERN
           (send _ :dig $!splat)
         PATTERN

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

@@ -63,6 +63,8 @@ module RuboCop
         end
 
         def correct_to_endless?(body_node)
+          return false if target_ruby_version < 3.0
+
           endless_method_config = config.for_cop('Style/EndlessMethod')
 
           return false unless endless_method_config['Enabled']
@@ -89,8 +91,9 @@ module RuboCop
         end
 
         def correct_to_endless(corrector, node)
+          self_receiver = node.self_receiver? ? 'self.' : ''
           arguments = node.arguments.any? ? node.arguments.source : '()'
-          replacement = "def #{node.method_name}#{arguments} = #{node.body.source}"
+          replacement = "def #{self_receiver}#{node.method_name}#{arguments} = #{node.body.source}"
           corrector.replace(node, replacement)
         end
 

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

@@ -21,6 +21,7 @@ module RuboCop
         MSG = 'Prefer ary[n..] over ary[n..-1].'
         RESTRICT_ON_SEND = %i[[]].freeze
 
+        # @!method range_till_minus_one?(node)
         def_node_matcher :range_till_minus_one?, '(irange !nil? (int -1))'
 
         def on_send(node)

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

@@ -43,6 +43,7 @@ module RuboCop
           return if node.ternary? || node.else? || node.elsif?
 
           if_branch = node.if_branch
+          return if use_variable_assignment_in_condition?(node.condition, if_branch)
           return unless offending_branch?(if_branch)
 
           message = format(MSG, conditional_type: node.keyword)
@@ -53,6 +54,21 @@ module RuboCop
 
         private
 
+        def use_variable_assignment_in_condition?(condition, if_branch)
+          assigned_variables = assigned_variables(condition)
+
+          assigned_variables && if_branch&.if_type? &&
+            assigned_variables.include?(if_branch.condition.source)
+        end
+
+        def assigned_variables(condition)
+          assigned_variables = condition.assignment? ? [condition.children.first.to_s] : []
+
+          assigned_variables + condition.descendants.select(&:assignment?).map do |node|
+            node.children.first.to_s
+          end
+        end
+
         def offending_branch?(branch)
           return false unless branch
 
@@ -112,11 +128,11 @@ module RuboCop
         def correct_outer_condition(corrector, condition)
           return unless requrie_parentheses?(condition)
 
-          range = range_between(
-            condition.loc.selector.end_pos, condition.first_argument.source_range.begin_pos
-          )
+          end_pos = condition.loc.selector.end_pos
+          begin_pos = condition.first_argument.source_range.begin_pos
+          return if end_pos > begin_pos
 
-          corrector.replace(range, '(')
+          corrector.replace(range_between(end_pos, begin_pos), '(')
           corrector.insert_after(condition.last_argument.source_range, ')')
         end
 

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

@@ -81,13 +81,13 @@ module RuboCop
         }
 
         PERL_VARS =
-          Hash[ENGLISH_VARS.flat_map { |k, vs| vs.map { |v| [v, [k]] } }]
+          ENGLISH_VARS.flat_map { |k, vs| vs.map { |v| [v, [k]] } }.to_h
 
         ENGLISH_VARS.merge!(
-          Hash[ENGLISH_VARS.flat_map { |_, vs| vs.map { |v| [v, [v]] } }]
+          ENGLISH_VARS.flat_map { |_, vs| vs.map { |v| [v, [v]] } }.to_h
         )
         PERL_VARS.merge!(
-          Hash[PERL_VARS.flat_map { |_, vs| vs.map { |v| [v, [v]] } }]
+          PERL_VARS.flat_map { |_, vs| vs.map { |v| [v, [v]] } }.to_h
         )
         ENGLISH_VARS.each_value(&:freeze).freeze
         PERL_VARS.each_value(&:freeze).freeze

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

@@ -22,6 +22,7 @@ module RuboCop
           'Use `warn` instead of `%<bad>s` to allow such output to be disabled.'
         RESTRICT_ON_SEND = %i[puts].freeze
 
+        # @!method stderr_puts?(node)
         def_node_matcher :stderr_puts?, <<~PATTERN
           (send
             {(gvar #stderr_gvar?) (const {nil? cbase} :STDERR)}

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for uses of `String#split` with empty string or regexp literal argument.
+      #
+      # This cop is marked as unsafe. But probably it's quite unlikely that some other class would
+      # define a `split` method that takes exactly the same arguments.
+      #
+      # @example
+      #   # bad
+      #   string.split(//)
+      #   string.split('')
+      #
+      #   # good
+      #   string.chars
+      #
+      class StringChars < Base
+        extend AutoCorrector
+
+        MSG = 'Use `chars` instead of `%<current>s`.'
+        RESTRICT_ON_SEND = %i[split].freeze
+        BAD_ARGUMENTS = %w[// '' ""].freeze
+
+        def on_send(node)
+          return unless node.arguments.one? && BAD_ARGUMENTS.include?(node.first_argument.source)
+
+          range = node.loc.selector.begin.join(node.loc.end)
+
+          add_offense(range, message: format(MSG, current: range.source)) do |corrector|
+            corrector.replace(range, 'chars')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -34,6 +34,7 @@ module RuboCop
         MSG = 'Prefer string interpolation to string concatenation.'
         RESTRICT_ON_SEND = %i[+].freeze
 
+        # @!method string_concatenation?(node)
         def_node_matcher :string_concatenation?, <<~PATTERN
           {
             (send str_type? :+ _)

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

@@ -17,10 +17,12 @@ module RuboCop
 
         MSG = 'Prefer symbols instead of strings as hash keys.'
 
+        # @!method string_hash_key?(node)
         def_node_matcher :string_hash_key?, <<~PATTERN
           (pair (str _) _)
         PATTERN
 
+        # @!method receive_environments_method?(node)
         def_node_matcher :receive_environments_method?, <<~PATTERN
           {
             ^^(send (const {nil? cbase} :IO) :popen ...)

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

@@ -20,6 +20,7 @@ module RuboCop
         MSG = 'Use `strip` instead of `%<methods>s`.'
         RESTRICT_ON_SEND = %i[lstrip rstrip].freeze
 
+        # @!method lstrip_rstrip(node)
         def_node_matcher :lstrip_rstrip, <<~PATTERN
           {(send $(send _ $:rstrip) $:lstrip)
            (send $(send _ $:lstrip) $:rstrip)}

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

@@ -37,6 +37,7 @@ module RuboCop
           end
         end
 
+        # @!method struct_constructor?(node)
         def_node_matcher :struct_constructor?, <<~PATTERN
           {(send (const {nil? cbase} :Struct) :new ...)
            (block (send (const {nil? cbase} :Struct) :new ...) ...)}
@@ -47,6 +48,8 @@ module RuboCop
         def correct_parent(parent, corrector)
           if parent.block_type?
             corrector.remove(range_with_surrounding_space(range: parent.loc.end, newlines: false))
+          elsif (class_node = parent.parent).body.nil?
+            corrector.remove(range_by_whole_lines(class_node.loc.end, include_final_newline: true))
           else
             corrector.insert_after(parent.loc.expression, ' do')
           end

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

@@ -5,6 +5,9 @@ module RuboCop
     module Style
       # Use symbols as procs when possible.
       #
+      # If you prefer a style that allows block for method with arguments,
+      # please set `true` to `AllowMethodsWithArguments`.
+      #
       # @example
       #   # bad
       #   something.map { |s| s.upcase }
@@ -12,6 +15,17 @@ module RuboCop
       #
       #   # good
       #   something.map(&:upcase)
+      #
+      # @example AllowMethodsWithArguments: false (default)
+      #   # bad
+      #   something.do_something(foo) { |o| o.bar }
+      #
+      #   # good
+      #   something.do_something(foo, &:bar)
+      #
+      # @example AllowMethodsWithArguments: true
+      #   # good
+      #   something.do_something(foo) { |o| o.bar }
       class SymbolProc < Base
         include RangeHelp
         include IgnoredMethods
@@ -21,8 +35,13 @@ module RuboCop
               'instead of a block.'
         SUPER_TYPES = %i[super zsuper].freeze
 
+        # @!method proc_node?(node)
         def_node_matcher :proc_node?, '(send (const {nil? cbase} :Proc) :new)'
+
+        # @!method symbol_proc_receiver?(node)
         def_node_matcher :symbol_proc_receiver?, '{(send ...) (super ...) zsuper}'
+
+        # @!method symbol_proc?(node)
         def_node_matcher :symbol_proc?, <<~PATTERN
           {
             (block $#symbol_proc_receiver? $(args (arg _var)) (send (lvar _var) $_))
@@ -37,11 +56,12 @@ module RuboCop
         def on_block(node)
           symbol_proc?(node) do |dispatch_node, arguments_node, method_name|
             # TODO: Rails-specific handling that we should probably make
-            # configurable - https://github.com/rubocop-hq/rubocop/issues/1485
+            # configurable - https://github.com/rubocop/rubocop/issues/1485
             # we should ignore lambdas & procs
             return if proc_node?(dispatch_node)
             return if %i[lambda proc].include?(dispatch_node.method_name)
             return if ignored_method?(dispatch_node.method_name)
+            return if allow_if_method_has_argument?(node)
             return if node.block_type? && destructuring_block_argument?(arguments_node)
 
             register_offense(node, method_name, dispatch_node.method_name)
@@ -103,6 +123,10 @@ module RuboCop
             node.loc.begin.begin_pos
           end
         end
+
+        def allow_if_method_has_argument?(node)
+          !!cop_config.fetch('AllowMethodsWithArguments', false) && !node.arguments.count.zero?
+        end
       end
     end
   end

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

@@ -191,6 +191,7 @@ module RuboCop
             (child.send_type? && child.prefix_not?)
         end
 
+        # @!method method_name(node)
         def_node_matcher :method_name, <<~PATTERN
           {($:defined? _ ...)
            (send {_ nil?} $_ _ ...)}

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

@@ -5,6 +5,8 @@ module RuboCop
     module Style
       # This cop checks for trailing code after the method definition.
       #
+      # NOTE: It always accepts endless method definitions that are basically on the same line.
+      #
       # @example
       #   # bad
       #   def some_method; do_stuff
@@ -24,6 +26,8 @@ module RuboCop
       #     b[c: x]
       #   end
       #
+      #   def endless_method = do_stuff
+      #
       class TrailingBodyOnMethodDefinition < Base
         include Alignment
         include TrailingBody
@@ -34,6 +38,7 @@ module RuboCop
 
         def on_def(node)
           return unless trailing_body?(node)
+          return if node.endless?
 
           add_offense(first_part_of(node.body)) do |corrector|
             LineBreakCorrector.correct_trailing_body(

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

@@ -40,7 +40,7 @@ module RuboCop
               'its own line.'
 
         def on_def(node)
-          return unless trailing_end?(node)
+          return if node.endless? || !trailing_end?(node)
 
           add_offense(node.loc.end) do |corrector|
             corrector.insert_before(

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

@@ -120,6 +120,7 @@ module RuboCop
             !allowed_method_name?(node) && !allowed_writer?(node.method_name)
         end
 
+        # @!method looks_like_trivial_writer?(node)
         def_node_matcher :looks_like_trivial_writer?, <<~PATTERN
           {(def    _ (args (arg ...)) (ivasgn _ (lvar _)))
            (defs _ _ (args (arg ...)) (ivasgn _ (lvar _)))}

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for the use of logical operators in an `unless` condition.
+      # It discourages such code, as the condition becomes more difficult
+      # to read and understand.
+      #
+      # This cop supports two styles:
+      # - `forbid_mixed_logical_operators` (default)
+      # - `forbid_logical_operators`
+      #
+      # `forbid_mixed_logical_operators` style forbids the use of more than one type
+      # of logical operators. This makes the `unless` condition easier to read
+      # because either all conditions need to be met or any condition need to be met
+      # in order for the expression to be truthy or falsey.
+      #
+      # `forbid_logical_operators` style forbids any use of logical operator.
+      # This makes it even more easy to read the `unless` condition as
+      # there is only one condition in the expression.
+      #
+      # @example EnforcedStyle: forbid_mixed_logical_operators (default)
+      #   # bad
+      #   return unless a || b && c
+      #   return unless a && b || c
+      #   return unless a && b and c
+      #   return unless a || b or c
+      #   return unless a && b or c
+      #   return unless a || b and c
+      #
+      #   # good
+      #   return unless a && b && c
+      #   return unless a || b || c
+      #   return unless a and b and c
+      #   return unless a or b or c
+      #   return unless a?
+      #
+      # @example EnforcedStyle: forbid_logical_operators
+      #   # bad
+      #   return unless a || b
+      #   return unless a && b
+      #   return unless a or b
+      #   return unless a and b
+      #
+      #   # good
+      #   return unless a
+      #   return unless a?
+      class UnlessLogicalOperators < Base
+        include ConfigurableEnforcedStyle
+
+        FORBID_MIXED_LOGICAL_OPERATORS = 'Do not use mixed logical operators in an `unless`.'
+        FORBID_LOGICAL_OPERATORS = 'Do not use any logical operator in an `unless`.'
+
+        # @!method or_with_and?(node)
+        def_node_matcher :or_with_and?, <<~PATTERN
+          (if (or <`and ...> ) ...)
+        PATTERN
+
+        # @!method and_with_or?(node)
+        def_node_matcher :and_with_or?, <<~PATTERN
+          (if (and <`or ...> ) ...)
+        PATTERN
+
+        # @!method logical_operator?(node)
+        def_node_matcher :logical_operator?, <<~PATTERN
+          (if ({and or} ... ) ...)
+        PATTERN
+
+        def on_if(node)
+          return unless node.unless?
+
+          if style == :forbid_mixed_logical_operators && mixed_logical_operator?(node)
+            add_offense(node, message: FORBID_MIXED_LOGICAL_OPERATORS)
+          elsif style == :forbid_logical_operators && logical_operator?(node)
+            add_offense(node, message: FORBID_LOGICAL_OPERATORS)
+          end
+        end
+
+        private
+
+        def mixed_logical_operator?(node)
+          or_with_and?(node) ||
+            and_with_or?(node) ||
+            mixed_precedence_and?(node) ||
+            mixed_precedence_or?(node)
+        end
+
+        def mixed_precedence_and?(node)
+          and_sources = node.condition.each_descendant(:and).map(&:operator)
+          and_sources << node.condition.operator if node.condition.and_type?
+
+          !(and_sources.all? { |s| s == '&&' } || and_sources.all? { |s| s == 'and' })
+        end
+
+        def mixed_precedence_or?(node)
+          or_sources = node.condition.each_descendant(:or).map(&:operator)
+          or_sources << node.condition.operator if node.condition.or_type?
+
+          !(or_sources.all? { |s| s == '||' } || or_sources.all? { |s| s == 'or' })
+        end
+      end
+    end
+  end
+end