rubocop 0.49.1 → 0.52.0

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

@@ -4,13 +4,25 @@ module RuboCop
   module Cop
     module Style
       # This cop checks for uses of the case equality operator(===).
+      #
+      # @example
+      #   # bad
+      #   Array === something
+      #   (1..100) === 7
+      #   /something/ === some_string
+      #
+      #   # good
+      #   something.is_a?(Array)
+      #   (1..100).include?(7)
+      #   some_string =~ /something/
+      #
       class CaseEquality < Cop
         MSG = 'Avoid the use of the case equality operator `===`.'.freeze
 
         def_node_matcher :case_equality?, '(send _ :=== _)'
 
         def on_send(node)
-          case_equality?(node) { add_offense(node, :selector) }
+          case_equality?(node) { add_offense(node, location: :selector) }
         end
       end
     end

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

@@ -4,6 +4,16 @@ module RuboCop
   module Cop
     module Style
       # Checks for uses of the character literal ?x.
+      #
+      # @example
+      #   # bad
+      #   ?x
+      #
+      #   # good
+      #   'x'
+      #
+      #   # good
+      #   ?\C-\M-d
       class CharacterLiteral < Cop
         include StringHelp
 

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

@@ -6,13 +6,17 @@ module RuboCop
       # This cop checks the style of children definitions at classes and
       # modules. Basically there are two different styles:
       #
-      # nested - have each child on its own line
+      # @example EnforcedStyle: nested (default)
+      #   # good
+      #   # have each child on its own line
       #   class Foo
       #     class Bar
       #     end
       #   end
       #
-      # compact - combine definitions as much as possible
+      # @example EnforcedStyle: compact
+      #   # good
+      #   # combine definitions as much as possible
       #   class Foo::Bar
       #   end
       #
@@ -48,12 +52,12 @@ module RuboCop
 
         def check_nested_style(node)
           return unless compact_node_name?(node)
-          add_offense(node, :name, NESTED_MSG)
+          add_offense(node, location: :name, message: NESTED_MSG)
         end
 
         def check_compact_style(node, body)
           return unless one_child?(body) && !compact_node_name?(node)
-          add_offense(node, :name, COMPACT_MSG)
+          add_offense(node, location: :name, message: COMPACT_MSG)
         end
 
         def one_child?(body)

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

@@ -4,10 +4,29 @@ module RuboCop
   module Cop
     module Style
       # This cop enforces consistent use of `Object#is_a?` or `Object#kind_of?`.
+      #
+      # @example EnforcedStyle: is_a? (default)
+      #   # bad
+      #   var.kind_of?(Date)
+      #   var.kind_of?(Integer)
+      #
+      #   # good
+      #   var.is_a?(Date)
+      #   var.is_a?(Integer)
+      #
+      # @example EnforcedStyle: kind_of?
+      #   # bad
+      #   var.is_a?(Time)
+      #   var.is_a?(String)
+      #
+      #   # good
+      #   var.kind_of?(Time)
+      #   var.kind_of?(String)
+      #
       class ClassCheck < Cop
         include ConfigurableEnforcedStyle
 
-        MSG = 'Prefer `Object#%s` over `Object#%s`.'.freeze
+        MSG = 'Prefer `Object#%<prefer>s` over `Object#%<current>s`.'.freeze
 
         def_node_matcher :class_check?, '(send _ ${:is_a? :kind_of?} _)'
 
@@ -15,15 +34,7 @@ module RuboCop
           class_check?(node) do |method_name|
             return if style == method_name
 
-            add_offense(node, :selector)
-          end
-        end
-
-        def message(node)
-          if node.method?(:is_a?)
-            format(MSG, 'kind_of?', 'is_a?')
-          else
-            format(MSG, 'is_a?', 'kind_of?')
+            add_offense(node, location: :selector)
           end
         end
 
@@ -34,6 +45,14 @@ module RuboCop
             corrector.replace(node.loc.selector, replacement)
           end
         end
+
+        def message(node)
+          if node.method?(:is_a?)
+            format(MSG, prefer: 'kind_of?', current: 'is_a?')
+          else
+            format(MSG, prefer: 'is_a?', current: 'kind_of?')
+          end
+        end
       end
     end
   end

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

@@ -10,18 +10,18 @@ module RuboCop
       #   # bad
       #   class SomeClass
       #     def SomeClass.class_method
-      #       ...
+      #       # ...
       #     end
       #   end
       #
       #   # good
       #   class SomeClass
       #     def self.class_method
-      #       ...
+      #       # ...
       #     end
       #   end
       class ClassMethods < Cop
-        MSG = 'Use `self.%s` instead of `%s.%s`.'.freeze
+        MSG = 'Use `self.%<method>s` instead of `%<class>s.%<method>s`.'.freeze
 
         def on_class(node)
           name, _superclass, body = *node
@@ -33,6 +33,10 @@ module RuboCop
           check(name, body)
         end
 
+        def autocorrect(node)
+          ->(corrector) { corrector.replace(node.loc.name, 'self') }
+        end
+
         private
 
         def check(name, node)
@@ -51,15 +55,12 @@ module RuboCop
           return unless name == definee
 
           _, class_name = *definee
-          add_offense(definee, :name, message(class_name, method_name))
+          add_offense(definee, location: :name,
+                               message: message(class_name, method_name))
         end
 
         def message(class_name, method_name)
-          format(MSG, method_name, class_name, method_name)
-        end
-
-        def autocorrect(node)
-          ->(corrector) { corrector.replace(node.loc.name, 'self') }
+          format(MSG, method: method_name, class: class_name)
         end
       end
     end

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

@@ -5,17 +5,18 @@ module RuboCop
     module Style
       # This cop checks for uses of class variables. Offenses
       # are signaled only on assignment to class variables to
-      # reduced the number of offenses that would be reported.
+      # reduce the number of offenses that would be reported.
       class ClassVars < Cop
-        MSG = 'Replace class var %s with a class instance var.'.freeze
+        MSG = 'Replace class var %<class_var>s with a class ' \
+              'instance var.'.freeze
 
         def on_cvasgn(node)
-          add_offense(node, :name)
+          add_offense(node, location: :name)
         end
 
         def message(node)
           class_var, = *node
-          format(MSG, class_var)
+          format(MSG, class_var: class_var)
         end
       end
     end

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

@@ -12,7 +12,7 @@ module RuboCop
       class CollectionMethods < Cop
         include MethodPreference
 
-        MSG = 'Prefer `%s` over `%s`.'.freeze
+        MSG = 'Prefer `%<prefer>s` over `%<current>s`.'.freeze
 
         def on_block(node)
           check_method_node(node.send_node)
@@ -35,13 +35,15 @@ module RuboCop
         private
 
         def message(node)
-          format(MSG, preferred_method(node.method_name), node.method_name)
+          format(MSG,
+                 prefer: preferred_method(node.method_name),
+                 current: node.method_name)
         end
 
         def check_method_node(node)
           return unless preferred_methods[node.method_name]
 
-          add_offense(node, :selector)
+          add_offense(node, location: :selector)
         end
       end
     end

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

@@ -5,15 +5,31 @@ module RuboCop
     module Style
       # This cop checks for methods invoked via the :: operator instead
       # of the . operator (like FileUtils::rmdir instead of FileUtils.rmdir).
+      #
+      # @example
+      #   # bad
+      #   Timeout::timeout(500) { do_something }
+      #   FileUtils::rmdir(dir)
+      #   Marshal::dump(obj)
+      #
+      #   # good
+      #   Timeout.timeout(500) { do_something }
+      #   FileUtils.rmdir(dir)
+      #   Marshal.dump(obj)
+      #
       class ColonMethodCall < Cop
         MSG = 'Do not use `::` for method calls.'.freeze
 
         def_node_matcher :java_type_node?, <<-PATTERN
           (send
-            (const nil :Java)
+            (const nil? :Java)
             {:boolean :byte :char :double :float :int :long :short})
         PATTERN
 
+        def self.autocorrect_incompatible_with
+          [RedundantSelf]
+        end
+
         def on_send(node)
           # ignore Java interop code like Java::int
           return if java_type_node?(node)
@@ -21,7 +37,7 @@ module RuboCop
           return unless node.receiver && node.double_colon?
           return if node.camel_case_method?
 
-          add_offense(node, :dot)
+          add_offense(node, location: :dot)
         end
 
         def autocorrect(node)

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for class methods that are defined using the `::`
+      # operator instead of the `.` operator.
+      #
+      # @example
+      #   # bad
+      #   class Foo
+      #     def self::bar
+      #     end
+      #   end
+      #
+      #   # good
+      #   class Foo
+      #     def self.bar
+      #     end
+      #   end
+      #
+      class ColonMethodDefinition < Cop
+        MSG = 'Do not use `::` for defining class methods.'.freeze
+
+        def on_defs(node)
+          return unless node.loc.operator.source == '::'
+          add_offense(node, location: :operator)
+        end
+
+        def autocorrect(node)
+          ->(corrector) { corrector.replace(node.loc.operator, '.') }
+        end
+      end
+    end
+  end
+end

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

@@ -5,26 +5,75 @@ module RuboCop
     module Style
       # This cop enforces using `` or %x around command literals.
       #
-      # @example
-      #   # Good if EnforcedStyle is backticks or mixed, bad if percent_x.
+      # @example EnforcedStyle: backticks (default)
+      #   # bad
+      #   folders = %x(find . -type d).split
+      #
+      #   # bad
+      #   %x(
+      #     ln -s foo.example.yml foo.example
+      #     ln -s bar.example.yml bar.example
+      #   )
+      #
+      #   # good
       #   folders = `find . -type d`.split
       #
-      #   # Good if EnforcedStyle is percent_x, bad if backticks or mixed.
+      #   # good
+      #   `
+      #     ln -s foo.example.yml foo.example
+      #     ln -s bar.example.yml bar.example
+      #   `
+      #
+      # @example EnforcedStyle: mixed
+      #   # bad
       #   folders = %x(find . -type d).split
       #
-      #   # Good if EnforcedStyle is backticks, bad if percent_x or mixed.
+      #   # bad
       #   `
       #     ln -s foo.example.yml foo.example
       #     ln -s bar.example.yml bar.example
       #   `
       #
-      #   # Good if EnforcedStyle is percent_x or mixed, bad if backticks.
+      #   # good
+      #   folders = `find . -type d`.split
+      #
+      #   # good
       #   %x(
       #     ln -s foo.example.yml foo.example
       #     ln -s bar.example.yml bar.example
       #   )
       #
-      #   # Bad unless AllowInnerBackticks is true.
+      # @example EnforcedStyle: percent_x
+      #   # bad
+      #   folders = `find . -type d`.split
+      #
+      #   # bad
+      #   `
+      #     ln -s foo.example.yml foo.example
+      #     ln -s bar.example.yml bar.example
+      #   `
+      #
+      #   # good
+      #   folders = %x(find . -type d).split
+      #
+      #   # good
+      #   %x(
+      #     ln -s foo.example.yml foo.example
+      #     ln -s bar.example.yml bar.example
+      #   )
+      #
+      # @example AllowInnerBackticks: false (default)
+      #   # If `false`, the cop will always recommend using `%x` if one or more
+      #   # backticks are found in the command string.
+      #
+      #   # bad
+      #   `echo \`ls\``
+      #
+      #   # good
+      #   %x(echo `ls`)
+      #
+      # @example AllowInnerBackticks: true
+      #   # good
       #   `echo \`ls\``
       class CommandLiteral < Cop
         include ConfigurableEnforcedStyle
@@ -42,31 +91,57 @@ module RuboCop
           end
         end
 
+        def autocorrect(node)
+          return if contains_backtick?(node)
+
+          replacement = if backtick_literal?(node)
+                          ['%x', ''].zip(preferred_delimiters).map(&:join)
+                        else
+                          %w[` `]
+                        end
+
+          lambda do |corrector|
+            corrector.replace(node.loc.begin, replacement.first)
+            corrector.replace(node.loc.end, replacement.last)
+          end
+        end
+
         private
 
         def check_backtick_literal(node)
           return if allowed_backtick_literal?(node)
 
-          add_offense(node, :expression, MSG_USE_PERCENT_X)
+          add_offense(node)
         end
 
         def check_percent_x_literal(node)
           return if allowed_percent_x_literal?(node)
 
-          add_offense(node, :expression, MSG_USE_BACKTICKS)
+          add_offense(node)
+        end
+
+        def message(node)
+          backtick_literal?(node) ? MSG_USE_PERCENT_X : MSG_USE_BACKTICKS
         end
 
         def allowed_backtick_literal?(node)
-          style == :backticks && !contains_disallowed_backtick?(node) ||
-            style == :mixed && node.single_line? &&
-              !contains_disallowed_backtick?(node)
+          case style
+          when :backticks
+            !contains_disallowed_backtick?(node)
+          when :mixed
+            node.single_line? && !contains_disallowed_backtick?(node)
+          end
         end
 
         def allowed_percent_x_literal?(node)
-          style == :backticks && contains_disallowed_backtick?(node) ||
-            style == :percent_x ||
-            style == :mixed && node.multiline? ||
-            style == :mixed && contains_disallowed_backtick?(node)
+          case style
+          when :backticks
+            contains_disallowed_backtick?(node)
+          when :mixed
+            node.multiline? || contains_disallowed_backtick?(node)
+          when :percent_x
+            true
+          end
         end
 
         def contains_disallowed_backtick?(node)
@@ -98,21 +173,6 @@ module RuboCop
           config.for_cop('Style/PercentLiteralDelimiters') \
             ['PreferredDelimiters']['%x'].split(//)
         end
-
-        def autocorrect(node)
-          return if contains_backtick?(node)
-
-          replacement = if backtick_literal?(node)
-                          ['%x', ''].zip(preferred_delimiters).map(&:join)
-                        else
-                          %w[` `]
-                        end
-
-          lambda do |corrector|
-            corrector.replace(node.loc.begin, replacement.first)
-            corrector.replace(node.loc.end, replacement.last)
-          end
-        end
       end
     end
   end