rubocop 0.80.1 → 0.85.0

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
@@ -55,7 +55,7 @@ module RuboCop
           raise Warning, AUTOCORRECT_EMPTY_WARNING if autocorrect_notice.empty?
 
           regex = Regexp.new(notice)
-          return if autocorrect_notice =~ regex
+          return if autocorrect_notice&.match?(regex)
 
           raise Warning, "AutocorrectNotice '#{autocorrect_notice}' must " \
                          "match Notice /#{notice}/"

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

@@ -33,7 +33,7 @@ module RuboCop
 
         def autocorrect(node)
           lambda do |corrector|
-            corrector.replace(node.source_range, '__dir__')
+            corrector.replace(node, '__dir__')
           end
         end
 

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# rubocop:disable Lint/RedundantCopDisableDirective
+
+module RuboCop
+  module Cop
+    module Style
+      # Detects comments to enable/disable RuboCop.
+      # This is useful if want to make sure that every RuboCop error gets fixed
+      # and not quickly disabled with a comment.
+      #
+      # @example
+      #   # bad
+      #   # rubocop:disable Metrics/AbcSize
+      #   def f
+      #   end
+      #   # rubocop:enable Metrics/AbcSize
+      #
+      #   # good
+      #   def fixed_method_name_and_no_rubocop_comments
+      #   end
+      #
+      class DisableCopsWithinSourceCodeDirective < Cop
+        # rubocop:enable Lint/RedundantCopDisableDirective
+        MSG = 'Comment to disable/enable RuboCop.'
+
+        def investigate(processed_source)
+          processed_source.comments.each do |comment|
+            next unless rubocop_directive_comment?(comment)
+
+            add_offense(comment)
+          end
+        end
+
+        def autocorrect(comment)
+          lambda do |corrector|
+            corrector.replace(comment, '')
+          end
+        end
+
+        private
+
+        def rubocop_directive_comment?(comment)
+          comment.text =~ CommentConfig::COMMENT_DIRECTIVE_REGEXP
+        end
+      end
+    end
+  end
+end

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

@@ -3,10 +3,11 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for missing top-level documentation of
-      # classes and modules. Classes with no body are exempt from the
-      # check and so are namespace modules - modules that have nothing in
-      # their bodies except classes, other modules, or constant definitions.
+      # This cop checks for missing top-level documentation of classes and
+      # modules. Classes with no body are exempt from the check and so are
+      # namespace modules - modules that have nothing in their bodies except
+      # classes, other modules, constant definitions or constant visibility
+      # declarations.
       #
       # The documentation requirement is annulled if the class or module has
       # a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the
@@ -18,12 +19,42 @@ module RuboCop
       #     # ...
       #   end
       #
+      #   module Math
+      #   end
+      #
       #   # good
       #   # Description/Explanation of Person class
       #   class Person
       #     # ...
       #   end
       #
+      #   # allowed
+      #     # Class without body
+      #     class Person
+      #     end
+      #
+      #     # Namespace - A namespace can be a class or a module
+      #     # Containing a class
+      #     module Namespace
+      #       # Description/Explanation of Person class
+      #       class Person
+      #         # ...
+      #       end
+      #     end
+      #
+      #     # Containing constant visibility declaration
+      #     module Namespace
+      #       class Private
+      #       end
+      #
+      #       private_constant :Private
+      #     end
+      #
+      #     # Containing constant definition
+      #     module Namespace
+      #       Public = Class.new
+      #     end
+      #
       class Documentation < Cop
         include DocumentationComment
 
@@ -31,6 +62,9 @@ module RuboCop
 
         def_node_matcher :constant_definition?, '{class module casgn}'
         def_node_search :outer_module, '(const (const nil? _) _)'
+        def_node_matcher :constant_visibility_declaration?, <<~PATTERN
+          (send nil? {:public_constant :private_constant} ({sym str} _))
+        PATTERN
 
         def on_class(node)
           return unless node.body
@@ -59,12 +93,16 @@ module RuboCop
           return false unless node
 
           if node.begin_type?
-            node.children.all? { |child| constant_definition?(child) }
+            node.children.all?(&method(:constant_declaration?))
           else
             constant_definition?(node)
           end
         end
 
+        def constant_declaration?(node)
+          constant_definition?(node) || constant_visibility_declaration?(node)
+        end
+
         def compact_namespace?(node)
           node.loc.name.source =~ /::/
         end

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

@@ -45,7 +45,7 @@ module RuboCop
                    end
 
           lambda do |corrector|
-            corrector.replace(comment.loc.expression,
+            corrector.replace(comment,
                               comment.text[/#{prefix} \S+/])
           end
         end

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/each_for_simple_loop.rb

@@ -42,7 +42,7 @@ module RuboCop
 
             max += 1 if range_type == :irange
 
-            corrector.replace(node.send_node.source_range,
+            corrector.replace(node.send_node,
                               "#{max - min}.times")
           end
         end

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

@@ -48,15 +48,15 @@ module RuboCop
 
             first_arg, second_arg = *node.arguments
 
-            corrector.replace(first_arg.loc.expression, second_arg.source)
-            corrector.replace(second_arg.loc.expression, first_arg.source)
+            corrector.replace(first_arg, second_arg.source)
+            corrector.replace(second_arg, first_arg.source)
 
             return_value = return_value(node.body)
 
             if return_value_occupies_whole_line?(return_value)
               corrector.remove(whole_line_expression(return_value))
             else
-              corrector.remove(return_value.loc.expression)
+              corrector.remove(return_value)
             end
           end
         end

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)
@@ -57,7 +57,7 @@ module RuboCop
 
         def autocorrect(node)
           lambda do |corrector|
-            corrector.replace(node.source_range, corrected(node))
+            corrector.replace(node, corrected(node))
           end
         end
 
@@ -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/end_block.rb

@@ -19,6 +19,12 @@ module RuboCop
         def on_postexe(node)
           add_offense(node, location: :keyword)
         end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.keyword, 'at_exit')
+          end
+        end
       end
     end
   end

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

@@ -38,7 +38,7 @@ module RuboCop
             replacement_method = replacement_method(arg, method)
 
             correction = "#{base_number.source}.#{replacement_method}?"
-            ->(corrector) { corrector.replace(node.source_range, correction) }
+            ->(corrector) { corrector.replace(node, correction) }
           end
         end
 

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

@@ -97,7 +97,7 @@ module RuboCop
               autocorrect_expand_path(corrector, current_path, default_dir)
             elsif (default_dir = pathname_parent_expand_path(node)) ||
                   (default_dir = pathname_new_parent_expand_path(node))
-              corrector.replace(default_dir.loc.expression, '__dir__')
+              corrector.replace(default_dir, '__dir__')
               remove_parent_method(corrector, default_dir)
             end
           end
@@ -145,8 +145,8 @@ module RuboCop
           else
             new_path = "'#{parent_path(stripped_current_path)}'"
 
-            corrector.replace(current_path.loc.expression, new_path)
-            corrector.replace(default_dir.loc.expression, '__dir__')
+            corrector.replace(current_path, new_path)
+            corrector.replace(default_dir, '__dir__')
           end
         end
 

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    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)
+      #                and 10 (exclusive).
+      # * `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
+      #              without trailing zeroes.
+      #
+      # @example EnforcedStyle: scientific (default)
+      #   # Enforces a mantissa between 1 (inclusive) and 10 (exclusive).
+      #
+      #   # bad
+      #   10e6
+      #   0.3e4
+      #   11.7e5
+      #   3.14e0
+      #
+      #   # good
+      #   1e7
+      #   3e3
+      #   1.17e6
+      #   3.14
+      #
+      # @example EnforcedStyle: engineering
+      #   # Enforces using multiple of 3 exponents,
+      #   # mantissa should be between 0.1 (inclusive) and 1000 (exclusive)
+      #
+      #   # bad
+      #   3.2e7
+      #   0.1e5
+      #   12e5
+      #   1232e6
+      #
+      #   # good
+      #   32e6
+      #   10e3
+      #   1.2e6
+      #   1.232e9
+      #
+      # @example EnforcedStyle: integral
+      #   # Enforces the mantissa to have no decimal part and no
+      #   # trailing zeroes.
+      #
+      #   # bad
+      #   3.2e7
+      #   0.1e5
+      #   120e4
+      #
+      #   # good
+      #   32e6
+      #   1e4
+      #   12e5
+      #
+      class ExponentialNotation < Cop
+        include ConfigurableEnforcedStyle
+
+        def on_float(node)
+          add_offense(node) if offense?(node)
+        end
+
+        private
+
+        def scientific?(node)
+          mantissa, = node.source.split('e')
+          mantissa =~ /^-?[1-9](\.\d*[0-9])?$/
+        end
+
+        def engineering?(node)
+          mantissa, exponent = node.source.split('e')
+          return false unless /^-?\d+$/.match?(exponent)
+          return false unless (exponent.to_i % 3).zero?
+          return false if /^-?\d{4}/.match?(mantissa)
+          return false if /^-?0\d/.match?(mantissa)
+          return false if /^-?0.0/.match?(mantissa)
+
+          true
+        end
+
+        def integral(node)
+          mantissa, = node.source.split('e')
+          mantissa =~ /^-?[1-9](\d*[1-9])?$/
+        end
+
+        def offense?(node)
+          return false unless node.source['e']
+
+          case style
+          when :scientific
+            !scientific?(node)
+          when :engineering
+            !engineering?(node)
+          when :integral
+            !integral(node)
+          else
+            false
+          end
+        end
+
+        def message(_node)
+          case style
+          when :scientific
+            'Use a mantissa in [1, 10[.'
+          when :engineering
+            'Use an exponent divisible by 3 and a mantissa in [0.1, 1000[.'
+          when :integral
+            'Use an integer as mantissa, without trailing zero.'
+          end
+        end
+      end
+    end
+  end
+end