rubocop 0.78.0 → 1.13.0

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

@@ -4,12 +4,23 @@ module RuboCop
   module Cop
     module Style
       # This cop checks for trailing comma in array literals.
+      # The configuration options are:
+      #
+      # * `consistent_comma`: Requires a comma after the
+      # last item of all non-empty, multiline array literals.
+      # * `comma`: Requires a comma after last item in an array,
+      # but only when each item is on its own line.
+      # * `no_comma`: Does not requires a comma after the
+      # last item in an array
       #
       # @example EnforcedStyleForMultiline: consistent_comma
       #   # bad
       #   a = [1, 2,]
       #
       #   # good
+      #   a = [1, 2]
+      #
+      #   # good
       #   a = [
       #     1, 2,
       #     3,
@@ -17,6 +28,11 @@ module RuboCop
       #
       #   # good
       #   a = [
+      #     1, 2, 3,
+      #   ]
+      #
+      #   # good
+      #   a = [
       #     1,
       #     2,
       #   ]
@@ -26,6 +42,31 @@ module RuboCop
       #   a = [1, 2,]
       #
       #   # good
+      #   a = [1, 2]
+      #
+      #   # bad
+      #   a = [
+      #     1, 2,
+      #     3,
+      #   ]
+      #
+      #   # good
+      #   a = [
+      #     1, 2,
+      #     3
+      #   ]
+      #
+      #   # bad
+      #   a = [
+      #     1, 2, 3,
+      #   ]
+      #
+      #   # good
+      #   a = [
+      #     1, 2, 3
+      #   ]
+      #
+      #   # good
       #   a = [
       #     1,
       #     2,
@@ -40,18 +81,15 @@ module RuboCop
       #     1,
       #     2
       #   ]
-      class TrailingCommaInArrayLiteral < Cop
+      class TrailingCommaInArrayLiteral < Base
         include TrailingComma
+        extend AutoCorrector
 
         def on_array(node)
           return unless node.square_brackets?
 
           check_literal(node, 'item of %<article>s array')
         end
-
-        def autocorrect(range)
-          PunctuationCorrector.swap_comma(range)
-        end
       end
     end
   end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks whether trailing commas in block arguments are
+      # required. Blocks with only one argument and a trailing comma require
+      # that comma to be present. Blocks with more than one argument never
+      # require a trailing comma.
+      #
+      # @example
+      #   # bad
+      #   add { |foo, bar,| foo + bar }
+      #
+      #   # good
+      #   add { |foo, bar| foo + bar }
+      #
+      #   # good
+      #   add { |foo,| foo }
+      #
+      #   # good
+      #   add { foo }
+      #
+      #   # bad
+      #   add do |foo, bar,|
+      #     foo + bar
+      #   end
+      #
+      #   # good
+      #   add do |foo, bar|
+      #     foo + bar
+      #   end
+      #
+      #   # good
+      #   add do |foo,|
+      #     foo
+      #   end
+      #
+      #   # good
+      #   add do
+      #     foo + bar
+      #   end
+      class TrailingCommaInBlockArgs < Base
+        extend AutoCorrector
+
+        MSG = 'Useless trailing comma present in block arguments.'
+
+        def on_block(node)
+          # lambda literal (`->`) never has block arguments.
+          return if node.send_node.lambda_literal?
+          return unless useless_trailing_comma?(node)
+
+          last_comma_pos = last_comma(node).pos
+
+          add_offense(last_comma_pos) { |corrector| corrector.replace(last_comma_pos, '') }
+        end
+
+        private
+
+        def useless_trailing_comma?(node)
+          arg_count(node) > 1 && trailing_comma?(node)
+        end
+
+        def arg_count(node)
+          node.arguments.each_descendant(:arg, :optarg, :kwoptarg).to_a.size
+        end
+
+        def trailing_comma?(node)
+          argument_tokens(node).last.comma?
+        end
+
+        def last_comma(node)
+          argument_tokens(node).last
+        end
+
+        def argument_tokens(node)
+          tokens = processed_source.tokens_within(node)
+          pipes = tokens.select { |token| token.type == :tPIPE }
+          begin_pos, end_pos = pipes.map { |pipe| tokens.index(pipe) }
+
+          tokens[begin_pos + 1..end_pos - 1]
+        end
+      end
+    end
+  end
+end

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

@@ -4,12 +4,24 @@ module RuboCop
   module Cop
     module Style
       # This cop checks for trailing comma in hash literals.
+      # The configuration options are:
+      #
+      # * `consistent_comma`: Requires a comma after the
+      # last item of all non-empty, multiline hash literals.
+      # * `comma`: Requires a comma after the last item in a hash,
+      # but only when each item is on its own line.
+      # * `no_comma`: Does not requires a comma after the
+      # last item in a hash
       #
       # @example EnforcedStyleForMultiline: consistent_comma
+      #
       #   # bad
       #   a = { foo: 1, bar: 2, }
       #
       #   # good
+      #   a = { foo: 1, bar: 2 }
+      #
+      #   # good
       #   a = {
       #     foo: 1, bar: 2,
       #     qux: 3,
@@ -17,21 +29,53 @@ module RuboCop
       #
       #   # good
       #   a = {
+      #     foo: 1, bar: 2, qux: 3,
+      #   }
+      #
+      #   # good
+      #   a = {
       #     foo: 1,
       #     bar: 2,
       #   }
       #
       # @example EnforcedStyleForMultiline: comma
+      #
       #   # bad
       #   a = { foo: 1, bar: 2, }
       #
       #   # good
+      #   a = { foo: 1, bar: 2 }
+      #
+      #   # bad
+      #   a = {
+      #     foo: 1, bar: 2,
+      #     qux: 3,
+      #   }
+      #
+      #   # good
+      #   a = {
+      #     foo: 1, bar: 2,
+      #     qux: 3
+      #   }
+      #
+      #   # bad
+      #   a = {
+      #     foo: 1, bar: 2, qux: 3,
+      #   }
+      #
+      #   # good
+      #   a = {
+      #     foo: 1, bar: 2, qux: 3
+      #   }
+      #
+      #   # good
       #   a = {
       #     foo: 1,
       #     bar: 2,
       #   }
       #
       # @example EnforcedStyleForMultiline: no_comma (default)
+      #
       #   # bad
       #   a = { foo: 1, bar: 2, }
       #
@@ -40,16 +84,13 @@ module RuboCop
       #     foo: 1,
       #     bar: 2
       #   }
-      class TrailingCommaInHashLiteral < Cop
+      class TrailingCommaInHashLiteral < Base
         include TrailingComma
+        extend AutoCorrector
 
         def on_hash(node)
           check_literal(node, 'item of %<article>s hash')
         end
-
-        def autocorrect(range)
-          PunctuationCorrector.swap_comma(range)
-        end
       end
     end
   end

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

@@ -33,57 +33,31 @@ module RuboCop
       #     end
       #   end
       #
-      class TrailingMethodEndStatement < Cop
-        include Alignment
+      class TrailingMethodEndStatement < Base
+        extend AutoCorrector
 
-        MSG = 'Place the end statement of a multi-line method on ' \
-              'its own line.'
+        MSG = 'Place the end statement of a multi-line method on its own line.'
 
         def on_def(node)
-          return unless trailing_end?(node)
+          return if node.endless? || !trailing_end?(node)
 
-          add_offense(node, location: end_token(node).pos)
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            break_line_before_end(node, corrector)
-            remove_semicolon(node, corrector)
+          add_offense(node.loc.end) do |corrector|
+            corrector.insert_before(
+              node.loc.end,
+              "\n#{' ' * node.loc.keyword.column}"
+            )
           end
         end
 
         private
 
         def trailing_end?(node)
-          node.body &&
-            node.multiline? &&
-            body_and_end_on_same_line?(node)
-        end
-
-        def end_token(node)
-          tokens(node).reverse.find(&:end?)
+          node.body && node.multiline? && body_and_end_on_same_line?(node)
         end
 
         def body_and_end_on_same_line?(node)
-          end_token(node).line == token_before_end(node).line
-        end
-
-        def token_before_end(node)
-          i = tokens(node).index(end_token(node))
-          tokens(node)[i - 1]
-        end
-
-        def break_line_before_end(node, corrector)
-          corrector.insert_before(
-            end_token(node).pos,
-            "\n" + ' ' * configured_indentation_width
-          )
-        end
-
-        def remove_semicolon(node, corrector)
-          return unless token_before_end(node).semicolon?
-
-          corrector.remove(token_before_end(node).pos)
+          last_child = node.children.last
+          last_child.loc.last_line == node.loc.end.last_line
         end
       end
     end

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

@@ -28,13 +28,15 @@ module RuboCop
       #   # bad
       #   a, b, _something = foo()
       #
-      class TrailingUnderscoreVariable < Cop
+      class TrailingUnderscoreVariable < Base
         include SurroundingSpace
         include RangeHelp
+        extend AutoCorrector
 
-        MSG = 'Do not use trailing `_`s in parallel assignment. ' \
-              'Prefer `%<code>s`.'
+        MSG = 'Do not use trailing `_`s in parallel assignment. Prefer `%<code>s`.'
         UNDERSCORE = '_'
+        DISALLOW = %i[lvasgn splat].freeze
+        private_constant :DISALLOW
 
         def on_masgn(node)
           ranges = unneeded_ranges(node)
@@ -44,17 +46,9 @@ module RuboCop
             offset = range.begin_pos - node.source_range.begin_pos
             good_code[offset, range.size] = ''
 
-            add_offense(node,
-                        location: range,
-                        message: format(MSG, code: good_code))
-          end
-        end
-
-        def autocorrect(node)
-          ranges = unneeded_ranges(node)
-
-          lambda do |corrector|
-            ranges.each { |range| corrector.remove(range) if range }
+            add_offense(range, message: format(MSG, code: good_code)) do |corrector|
+              corrector.remove(range)
+            end
           end
         end
 
@@ -71,15 +65,13 @@ module RuboCop
 
         def find_first_possible_offense(variables)
           variables.reduce(nil) do |offense, variable|
-            break offense unless %i[lvasgn splat].include?(variable.type)
+            break offense unless DISALLOW.include?(variable.type)
 
             var, = *variable
             var, = *var
-            if allow_named_underscore_variables
-              break offense unless var == :_
-            else
-              break offense unless var.to_s.start_with?(UNDERSCORE)
-            end
+
+            break offense if (allow_named_underscore_variables && var != :_) ||
+                             !var.to_s.start_with?(UNDERSCORE)
 
             variable
           end
@@ -98,8 +90,7 @@ module RuboCop
         end
 
         def allow_named_underscore_variables
-          @allow_named_underscore_variables ||=
-            cop_config['AllowNamedUnderscoreVariables']
+          @allow_named_underscore_variables ||= cop_config['AllowNamedUnderscoreVariables']
         end
 
         def unneeded_ranges(node)
@@ -126,12 +117,9 @@ module RuboCop
             return unused_range(node.type, mlhs_node, right)
           end
 
-          if Util.parentheses?(mlhs_node)
-            return range_for_parentheses(first_offense, mlhs_node)
-          end
+          return range_for_parentheses(first_offense, mlhs_node) if Util.parentheses?(mlhs_node)
 
-          range_between(first_offense.source_range.begin_pos,
-                        node.loc.operator.begin_pos)
+          range_between(first_offense.source_range.begin_pos, node.loc.operator.begin_pos)
         end
 
         def children_offenses(variables)
@@ -156,10 +144,7 @@ module RuboCop
         end
 
         def range_for_parentheses(offense, left)
-          range_between(
-            offense.source_range.begin_pos - 1,
-            left.loc.expression.end_pos - 1
-          )
+          range_between(offense.source_range.begin_pos - 1, left.loc.expression.end_pos - 1)
         end
       end
     end

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

@@ -27,7 +27,10 @@ module RuboCop
       #   class << self
       #     attr_reader :baz
       #   end
-      class TrivialAccessors < Cop
+      class TrivialAccessors < Base
+        include AllowedMethods
+        extend AutoCorrector
+
         MSG = 'Use `attr_%<kind>s` to define trivial %<kind>s methods.'
 
         def on_def(node)
@@ -39,17 +42,6 @@ module RuboCop
         end
         alias on_defs on_def
 
-        def autocorrect(node)
-          parent = node.parent
-          return if parent&.send_type?
-
-          if node.def_type?
-            autocorrect_instance(node)
-          elsif node.defs_type? && node.children.first.self_type?
-            autocorrect_class(node)
-          end
-        end
-
         private
 
         def in_module_or_instance_eval?(node)
@@ -74,9 +66,20 @@ module RuboCop
                  end
           return unless kind
 
-          add_offense(node,
-                      location: :keyword,
-                      message: format(MSG, kind: kind))
+          add_offense(node.loc.keyword, message: format(MSG, kind: kind)) do |corrector|
+            autocorrect(corrector, node)
+          end
+        end
+
+        def autocorrect(corrector, node)
+          parent = node.parent
+          return if parent&.send_type?
+
+          if node.def_type?
+            autocorrect_instance(corrector, node)
+          elsif node.defs_type? && node.children.first.self_type?
+            autocorrect_class(corrector, node)
+          end
         end
 
         def exact_name_match?
@@ -95,9 +98,8 @@ module RuboCop
           cop_config['IgnoreClassMethods']
         end
 
-        def allowed_methods
-          allowed_methods = cop_config['AllowedMethods']
-          Array(allowed_methods).map(&:to_sym) + [:initialize]
+        def allowed_method_names
+          allowed_methods.map(&:to_sym) + [:initialize]
         end
 
         def dsl_writer?(method_name)
@@ -105,8 +107,7 @@ module RuboCop
         end
 
         def trivial_reader?(node)
-          looks_like_trivial_reader?(node) &&
-            !allowed_method?(node) && !allowed_reader?(node)
+          looks_like_trivial_reader?(node) && !allowed_method_name?(node) && !allowed_reader?(node)
         end
 
         def looks_like_trivial_reader?(node)
@@ -115,16 +116,17 @@ module RuboCop
 
         def trivial_writer?(node)
           looks_like_trivial_writer?(node) &&
-            !allowed_method?(node) && !allowed_writer?(node.method_name)
+            !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 _)))}
         PATTERN
 
-        def allowed_method?(node)
-          allowed_methods.include?(node.method_name) ||
+        def allowed_method_name?(node)
+          allowed_method_names.include?(node.method_name) ||
             exact_name_match? && !names_match?(node)
         end
 
@@ -143,8 +145,7 @@ module RuboCop
         end
 
         def trivial_accessor_kind(node)
-          if trivial_writer?(node) &&
-             !dsl_writer?(node.method_name)
+          if trivial_writer?(node) && !dsl_writer?(node.method_name)
             'writer'
           elsif trivial_reader?(node)
             'reader'
@@ -155,31 +156,26 @@ module RuboCop
           "attr_#{kind} :#{method_name.to_s.chomp('=')}"
         end
 
-        def autocorrect_instance(node)
+        def autocorrect_instance(corrector, node)
           kind = trivial_accessor_kind(node)
 
           return unless names_match?(node) && !node.predicate_method? && kind
 
-          lambda do |corrector|
-            corrector.replace(node.source_range,
-                              accessor(kind, node.method_name))
-          end
+          corrector.replace(node, accessor(kind, node.method_name))
         end
 
-        def autocorrect_class(node)
+        def autocorrect_class(corrector, node)
           kind = trivial_accessor_kind(node)
 
           return unless names_match?(node) && kind
 
-          lambda do |corrector|
-            indent = ' ' * node.loc.column
-            corrector.replace(
-              node.source_range,
-              ['class << self',
-               "#{indent}  #{accessor(kind, node.method_name)}",
-               "#{indent}end"].join("\n")
-            )
-          end
+          indent = ' ' * node.loc.column
+          corrector.replace(
+            node.source_range,
+            ['class << self',
+             "#{indent}  #{accessor(kind, node.method_name)}",
+             "#{indent}end"].join("\n")
+          )
         end
 
         def top_level_node?(node)