rubocop 0.54.0 → 0.55.0

data/lib/rubocop/cop/rails/inverse_of.rb

@@ -4,11 +4,16 @@ module RuboCop
   module Cop
     module Rails
       # This cop looks for has_(one|many) and belongs_to associations where
-      # ActiveRecord can't automatically determine the inverse association
-      # because of a scope or the options used. This can result in unnecessary
-      # queries in some circumstances. `:inverse_of` must be manually specified
-      # for associations to work in both ways, or set to `false` or `nil`
-      # to opt-out.
+      # Active Record can't automatically determine the inverse association
+      # because of a scope or the options used. Using the blog with order scope
+      # example below, traversing the a Blog's association in both directions
+      # with `blog.posts.first.blog` would cause the `blog` to be loaded from
+      # the database twice.
+      #
+      # `:inverse_of` must be manually specified for Active Record to use the
+      # associated object in memory, or set to `false` to opt-out. Note that
+      # setting `nil` does not stop Active Record from trying to determine the
+      # inverse automatically, and is not considered a valid value for this.
       #
       # @example
       #   # good
@@ -62,15 +67,6 @@ module RuboCop
       #     )
       #   end
       #
-      #   # good
-      #   # You can also opt-out with specifying `inverse_of: nil`.
-      #   class Blog < ApplicationRecord
-      #     has_many(:posts,
-      #       -> { order(published_at: :desc) },
-      #       inverse_of: nil
-      #     )
-      #   end
-      #
       # @example
       #   # bad
       #   class Picture < ApplicationRecord
@@ -139,7 +135,9 @@ module RuboCop
 
         minimum_target_rails_version 4.1
 
-        MSG = 'Specify an `:inverse_of` option.'.freeze
+        SPECIFY_MSG = 'Specify an `:inverse_of` option.'.freeze
+        NIL_MSG = 'You specified `inverse_of: nil`, you probably meant to ' \
+          'use `inverse_of: false`.'.freeze
 
         def_node_matcher :association_recv_arguments, <<-PATTERN
           (send $_ {:has_many :has_one :belongs_to} _ $...)
@@ -165,16 +163,16 @@ module RuboCop
           (pair (sym :as) !nil)
         PATTERN
 
-        def_node_matcher :class_name_option?, <<-PATTERN
-          (pair (sym :class_name) !nil)
-        PATTERN
-
         def_node_matcher :foreign_key_option?, <<-PATTERN
           (pair (sym :foreign_key) !nil)
         PATTERN
 
         def_node_matcher :inverse_of_option?, <<-PATTERN
-          (pair (sym :inverse_of) _)
+          (pair (sym :inverse_of) !nil)
+        PATTERN
+
+        def_node_matcher :inverse_of_nil_option?, <<-PATTERN
+          (pair (sym :inverse_of) nil)
         PATTERN
 
         def on_send(node)
@@ -191,7 +189,7 @@ module RuboCop
                         options_requiring_inverse_of?(options)
 
           return if options_contain_inverse_of?(options)
-          add_offense(node, location: :selector)
+          add_offense(node, message: message(options), location: :selector)
         end
 
         def scope?(arguments)
@@ -201,7 +199,6 @@ module RuboCop
         def options_requiring_inverse_of?(options)
           required = options.any? do |opt|
             conditions_option?(opt) ||
-              class_name_option?(opt) ||
               foreign_key_option?(opt)
           end
 
@@ -231,6 +228,16 @@ module RuboCop
           return true if arg.nil? && recv.nil?
           arg && recv && arg.children[0] == recv.children[0]
         end
+
+        private
+
+        def message(options)
+          if options.any? { |opt| inverse_of_nil_option?(opt) }
+            NIL_MSG
+          else
+            SPECIFY_MSG
+          end
+        end
       end
     end
   end

data/lib/rubocop/cop/rails/read_write_attribute.rb

@@ -3,8 +3,15 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of the read_attribute or
-      # write_attribute methods.
+      # This cop checks for the use of the read_attribute or write_attribute
+      # methods, and recommends square brackets instead.
+      #
+      # If an attribute is missing from the instance (for example, when
+      # initialized by a partial `select`) then read_attribute will return nil,
+      # but square brackets will raise an ActiveModel::MissingAttributeError.
+      #
+      # Explicitly raising an error in this situation is preferable, and that
+      # is why rubocop recommends using square brackets.
       #
       # @example
       #

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

@@ -15,7 +15,7 @@ module RuboCop
       #   %w(foo bar baz) * ","
       #
       #   # good
-      #   %w(foo bar bax).join(",")
+      #   %w(foo bar baz).join(",")
       #
       class ArrayJoin < Cop
         MSG = 'Favor `Array#join` over `Array#*`.'.freeze

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

@@ -7,10 +7,11 @@ module RuboCop
       # are signaled only on assignment to class variables to
       # reduce the number of offenses that would be reported.
       #
-      # Setting value for class variable need to take care.
-      # If some class has been inherited by other classes, setting value
-      # for class variable affected children classes.
-      # So using class instance variable is better in almost case.
+      # You have to be careful when setting a value for a class
+      # variable; if a class has been inherited, changing the
+      # value of a class variable also affects the inheriting
+      # classes. This means that it's almost always better to
+      # use a class instance variable instead.
       #
       # @example
       #   # bad

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

@@ -74,10 +74,9 @@ module RuboCop
 
         def extract_heredoc_lines(ast)
           return [] unless ast
-          ast.each_node.with_object([]) do |node, heredocs|
-            next unless node.location.is_a?(Parser::Source::Map::Heredoc)
+          ast.each_node(:str, :dstr, :xstr).select(&:heredoc?).map do |node|
             body = node.location.heredoc_body
-            heredocs << (body.first_line...body.last_line)
+            (body.first_line...body.last_line)
           end
         end
       end

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

@@ -39,17 +39,25 @@ module RuboCop
         include RangeHelp
 
         MSG = 'Add empty line after guard clause.'.freeze
+        END_OF_HEREDOC_LINE = 1
 
         def on_if(node)
-          return unless contains_guard_clause?(node)
+          return if correct_style?(node)
 
-          return if next_line_rescue_or_ensure?(node)
-          return if next_sibling_parent_empty_or_else?(node)
-          return if next_sibling_empty_or_guard_clause?(node)
+          if last_argument_is_heredoc?(node)
+            heredoc_node = last_argument(node)
 
-          return if next_line_empty?(node)
+            num_of_heredoc_lines = heredoc_node.children.size
+            line = node.last_line + num_of_heredoc_lines + END_OF_HEREDOC_LINE
 
-          add_offense(node)
+            return if next_line_empty?(line)
+
+            add_offense(heredoc_node, location: :heredoc_end)
+          else
+            return if next_line_empty?(node.last_line)
+
+            add_offense(node)
+          end
         end
 
         def autocorrect(node)
@@ -61,12 +69,19 @@ module RuboCop
 
         private
 
+        def correct_style?(node)
+          !contains_guard_clause?(node) ||
+            next_line_rescue_or_ensure?(node) ||
+            next_sibling_parent_empty_or_else?(node) ||
+            next_sibling_empty_or_guard_clause?(node)
+        end
+
         def contains_guard_clause?(node)
           node.if_branch && node.if_branch.guard_clause?
         end
 
-        def next_line_empty?(node)
-          processed_source[node.last_line].blank?
+        def next_line_empty?(line)
+          processed_source[line].blank?
         end
 
         def next_line_rescue_or_ensure?(node)
@@ -89,6 +104,22 @@ module RuboCop
 
           next_sibling.if_type? && contains_guard_clause?(next_sibling)
         end
+
+        def last_argument_is_heredoc?(node)
+          last_children = node.children.last
+
+          return false unless last_children && last_children.send_type?
+
+          last_argument = last_argument(node)
+
+          last_argument &&
+            (last_argument.str_type? || last_argument.dstr_type?) &&
+            last_argument.heredoc?
+        end
+
+        def last_argument(node)
+          node.children.last.last_argument
+        end
       end
     end
   end

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

@@ -74,20 +74,12 @@ module RuboCop
           end
         end
 
-        def autocorrect(node) # rubocop:disable Metrics/MethodLength
+        def autocorrect(node)
           lambda do |corrector|
             if style == :never
-              corrector.remove(range_with_surrounding_space(range: node.pos,
-                                                            side: :right))
+              remove_comment(corrector, node)
             else
-              last_special_comment = last_special_comment(processed_source)
-              if last_special_comment.nil?
-                corrector.insert_before(processed_source.tokens[0].pos,
-                                        "#{FROZEN_STRING_LITERAL_ENABLED}\n")
-              else
-                corrector.insert_after(last_special_comment.pos,
-                                       "\n#{FROZEN_STRING_LITERAL_ENABLED}")
-              end
+              insert_comment(corrector)
             end
           end
         end
@@ -138,6 +130,25 @@ module RuboCop
                       location: frozen_string_literal_comment.pos,
                       message: MSG_UNNECESSARY)
         end
+
+        def remove_comment(corrector, node)
+          corrector.remove(range_with_surrounding_space(range: node.pos,
+                                                        side: :right))
+        end
+
+        def insert_comment(corrector)
+          last_special_comment = last_special_comment(processed_source)
+          if last_special_comment.nil?
+            corrector.insert_before(processed_source.tokens[0].pos,
+                                    "#{FROZEN_STRING_LITERAL_ENABLED}\n\n")
+          elsif processed_source.following_line(last_special_comment).empty?
+            corrector.insert_after(last_special_comment.pos,
+                                   "\n#{FROZEN_STRING_LITERAL_ENABLED}")
+          else
+            corrector.insert_after(last_special_comment.pos,
+                                   "\n#{FROZEN_STRING_LITERAL_ENABLED}\n")
+          end
+        end
       end
     end
   end

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

@@ -20,6 +20,7 @@ module RuboCop
         def on_send(node)
           return if ineligible_node?(node)
           return unless !node.arguments? && node.parenthesized?
+          return if ignored_method?(node.method_name)
           return if same_name_assignment?(node)
 
           add_offense(node, location: :begin)
@@ -38,6 +39,10 @@ module RuboCop
           node.camel_case_method? || node.implicit_call? || node.keyword_not?
         end
 
+        def ignored_method?(method)
+          cop_config['IgnoredMethods'].to_a.map(&:to_sym).include?(method)
+        end
+
         def same_name_assignment?(node)
           any_assignment?(node) do |asgn_node|
             if asgn_node.masgn_type?

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

@@ -12,6 +12,11 @@ module RuboCop
       #
       #   # good
       #   CONST = [1, 2, 3].freeze
+      #
+      #   # good
+      #   CONST = <<~TESTING.freeze
+      #   This is a heredoc
+      #   TESTING
       class MutableConstant < Cop
         include FrozenStringLiteral
 

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

@@ -4,6 +4,24 @@ module RuboCop
   module Cop
     module Style
       # Checks for uses of while with a negated condition.
+      #
+      # @example
+      #   # bad
+      #   while !foo
+      #     bar
+      #   end
+      #
+      #   # good
+      #   until foo
+      #     bar
+      #   end
+      #
+      #   # bad
+      #   bar until !foo
+      #
+      #   # good
+      #   bar while foo
+      #   bar while !foo && baz
       class NegatedWhile < Cop
         include NegativeConditional
 

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

@@ -4,6 +4,17 @@ module RuboCop
   module Cop
     module Style
       # This cop checks for nested ternary op expressions.
+      #
+      # @example
+      #   # bad
+      #   a ? (b ? b1 : b2) : a2
+      #
+      #   # good
+      #   if a
+      #     b ? b1 : b2
+      #   else
+      #     a2
+      #   end
       class NestedTernaryOperator < Cop
         MSG = 'Ternary operators must not be nested. Prefer `if` or `else` ' \
               'constructs instead.'.freeze

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

@@ -14,7 +14,7 @@ module RuboCop
       #
       # The cop ignores comparisons to global variables, since they are often
       # populated with objects which can be compared with integers, but are
-      # not themselves `Interger` polymorphic.
+      # not themselves `Integer` polymorphic.
       #
       # @example EnforcedStyle: predicate (default)
       #   # bad

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

@@ -5,6 +5,23 @@ module RuboCop
     module Style
       # TODO: Make configurable.
       # Checks for uses of if/then/else/end on a single line.
+      #
+      # @example
+      #   # bad
+      #   if foo then boo else doo end
+      #   unless foo then boo else goo end
+      #
+      #   # good
+      #   foo ? boo : doo
+      #   boo if foo
+      #   if foo then boo end
+      #
+      #   # good
+      #   if foo
+      #     boo
+      #   else
+      #     doo
+      #   end
       class OneLineConditional < Cop
         include OnNormalIfUnless
 

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

@@ -27,6 +27,8 @@ module RuboCop
         PATTERN
 
         def on_args(node)
+          return if super_used?(node)
+
           option_hash(node) do |options|
             add_offense(options)
           end
@@ -38,6 +40,10 @@ module RuboCop
           cop_config.key?('SuspiciousParamNames') &&
             cop_config['SuspiciousParamNames'].include?(arg_name.to_s)
         end
+
+        def super_used?(node)
+          node.parent.each_node(:zsuper).any?
+        end
       end
     end
   end

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

@@ -8,6 +8,26 @@ module RuboCop
       #
       # For instance one can configure `reduce`(`inject`) to use |a, e| as
       # parameters.
+      #
+      # Configuration option: Methods
+      # Should be set to use this cop. Array of hashes, where each key is the
+      # method name and value - array of argument names.
+      #
+      # @example Methods: [{reduce: %w[a b]}]
+      #   # bad
+      #   foo.reduce { |c, d| c + d }
+      #   foo.reduce { |_, _d| 1 }
+      #
+      #   # good
+      #   foo.reduce { |a, b| a + b }
+      #   foo.reduce { |a, _b| a }
+      #   foo.reduce { |a, (id, _)| a + id }
+      #   foo.reduce { true }
+      #
+      #   # good
+      #   foo.reduce do |c, d|
+      #     c + d
+      #   end
       class SingleLineBlockParams < Cop
         MSG = 'Name `%<method>s` block params `|%<params>s|`.'.freeze
 

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

@@ -3,7 +3,59 @@
 module RuboCop
   module Cop
     module Style
+      #
       # This cop looks for uses of Perl-style global variables.
+      #
+      # @example EnforcedStyle: use_english_names (default)
+      #   # good
+      #   puts $LOAD_PATH
+      #   puts $LOADED_FEATURES
+      #   puts $PROGRAM_NAME
+      #   puts $ERROR_INFO
+      #   puts $ERROR_POSITION
+      #   puts $FIELD_SEPARATOR # or $FS
+      #   puts $OUTPUT_FIELD_SEPARATOR # or $OFS
+      #   puts $INPUT_RECORD_SEPARATOR # or $RS
+      #   puts $OUTPUT_RECORD_SEPARATOR # or $ORS
+      #   puts $INPUT_LINE_NUMBER # or $NR
+      #   puts $LAST_READ_LINE
+      #   puts $DEFAULT_OUTPUT
+      #   puts $DEFAULT_INPUT
+      #   puts $PROCESS_ID # or $PID
+      #   puts $CHILD_STATUS
+      #   puts $LAST_MATCH_INFO
+      #   puts $IGNORECASE
+      #   puts $ARGV # or ARGV
+      #   puts $MATCH
+      #   puts $PREMATCH
+      #   puts $POSTMATCH
+      #   puts $LAST_PAREN_MATCH
+      #
+      # @example EnforcedStyle: use_perl_names
+      #   # good
+      #   puts $:
+      #   puts $"
+      #   puts $0
+      #   puts $!
+      #   puts $@
+      #   puts $;
+      #   puts $,
+      #   puts $/
+      #   puts $\
+      #   puts $.
+      #   puts $_
+      #   puts $>
+      #   puts $<
+      #   puts $$
+      #   puts $?
+      #   puts $~
+      #   puts $=
+      #   puts $*
+      #   puts $&
+      #   puts $`
+      #   puts $'
+      #   puts $+
+      #
       class SpecialGlobalVars < Cop
         include ConfigurableEnforcedStyle