rubocop 0.51.0 → 0.87.0

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

@@ -4,13 +4,27 @@ module RuboCop
   module Cop
     module Style
       # This cop checks for END blocks.
+      #
+      # @example
+      #   # bad
+      #   END { puts 'Goodbye!' }
+      #
+      #   # good
+      #   at_exit { puts 'Goodbye!' }
+      #
       class EndBlock < Cop
         MSG = 'Avoid the use of `END` blocks. ' \
-              'Use `Kernel#at_exit` instead.'.freeze
+              'Use `Kernel#at_exit` instead.'
 
         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/eval_with_location.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks `eval` method usage. `eval` can receive source location
+      # metadata, that are filename and line number. The metadata is used by
+      # backtraces. This cop recommends to pass the metadata to `eval` method.
+      #
+      # @example
+      #   # bad
+      #   eval <<-RUBY
+      #     def do_something
+      #     end
+      #   RUBY
+      #
+      #   # bad
+      #   C.class_eval <<-RUBY
+      #     def do_something
+      #     end
+      #   RUBY
+      #
+      #   # good
+      #   eval <<-RUBY, binding, __FILE__, __LINE__ + 1
+      #     def do_something
+      #     end
+      #   RUBY
+      #
+      #   # good
+      #   C.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      #     def do_something
+      #     end
+      #   RUBY
+      class EvalWithLocation < Cop
+        MSG = 'Pass `__FILE__` and `__LINE__` to `eval` method, ' \
+              'as they are used by backtraces.'
+        MSG_INCORRECT_LINE = 'Use `%<expected>s` instead of `%<actual>s`, ' \
+                             'as they are used by backtraces.'
+
+        def_node_matcher :eval_without_location?, <<~PATTERN
+          {
+            (send nil? :eval ${str dstr})
+            (send nil? :eval ${str dstr} _)
+            (send nil? :eval ${str dstr} _ #special_file_keyword?)
+            (send nil? :eval ${str dstr} _ #special_file_keyword? _)
+
+            (send _ {:class_eval :module_eval :instance_eval}
+              ${str dstr})
+            (send _ {:class_eval :module_eval :instance_eval}
+              ${str dstr} #special_file_keyword?)
+            (send _ {:class_eval :module_eval :instance_eval}
+              ${str dstr} #special_file_keyword? _)
+          }
+        PATTERN
+
+        def_node_matcher :line_with_offset?, <<~PATTERN
+          {
+            (send #special_line_keyword? %1 (int %2))
+            (send (int %2) %1 #special_line_keyword?)
+          }
+        PATTERN
+
+        def on_send(node)
+          eval_without_location?(node) do |code|
+            if with_lineno?(node)
+              on_with_lineno(node, code)
+            else
+              add_offense(node)
+            end
+          end
+        end
+
+        private
+
+        def special_file_keyword?(node)
+          node.str_type? &&
+            node.source == '__FILE__'
+        end
+
+        def special_line_keyword?(node)
+          node.int_type? &&
+            node.source == '__LINE__'
+        end
+
+        # FIXME: It's a Style/ConditionalAssignment's false positive.
+        # rubocop:disable Style/ConditionalAssignment
+        def with_lineno?(node)
+          if node.method?(:eval)
+            node.arguments.size == 4
+          else
+            node.arguments.size == 3
+          end
+        end
+        # rubocop:enable Style/ConditionalAssignment
+
+        def message_incorrect_line(actual, sign, line_diff)
+          expected =
+            if line_diff.zero?
+              '__LINE__'
+            else
+              "__LINE__ #{sign} #{line_diff}"
+            end
+          format(MSG_INCORRECT_LINE, actual: actual.source, expected: expected)
+        end
+
+        def on_with_lineno(node, code)
+          line_node = node.arguments.last
+          lineno_range = line_node.loc.expression
+          line_diff = string_first_line(code) - lineno_range.first_line
+          if line_diff.zero?
+            add_offense_for_same_line(node, line_node)
+          else
+            add_offense_for_different_line(node, line_node, line_diff)
+          end
+        end
+
+        def string_first_line(str_node)
+          if str_node.heredoc?
+            str_node.loc.heredoc_body.first_line
+          else
+            str_node.loc.expression.first_line
+          end
+        end
+
+        def add_offense_for_same_line(node, line_node)
+          return if special_line_keyword?(line_node)
+
+          add_offense(
+            node,
+            location: line_node.loc.expression,
+            message: message_incorrect_line(line_node, nil, 0)
+          )
+        end
+
+        def add_offense_for_different_line(node, line_node, line_diff)
+          sign = line_diff.positive? ? :+ : :-
+          return if line_with_offset?(line_node, sign, line_diff.abs)
+
+          add_offense(
+            node,
+            location: line_node.loc.expression,
+            message: message_incorrect_line(line_node, sign, line_diff.abs)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -3,31 +3,33 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for places where Integer#even? or Integer#odd?
-      # should have been used.
+      # This cop checks for places where `Integer#even?` or `Integer#odd?`
+      # can be used.
       #
       # @example
       #
       #   # bad
       #   if x % 2 == 0
+      #   end
       #
       #   # good
       #   if x.even?
+      #   end
       class EvenOdd < Cop
-        MSG = 'Replace with `Integer#%s?`.'.freeze
+        MSG = 'Replace with `Integer#%<method>s?`.'
 
-        def_node_matcher :even_odd_candidate?, <<-PATTERN
+        def_node_matcher :even_odd_candidate?, <<~PATTERN
           (send
             {(send $_ :% (int 2))
              (begin (send $_ :% (int 2)))}
             ${:== :!=}
-            (int ${0 1 2}))
+            (int ${0 1}))
         PATTERN
 
         def on_send(node)
           even_odd_candidate?(node) do |_base_number, method, arg|
             replacement_method = replacement_method(arg, method)
-            add_offense(node, message: format(MSG, replacement_method))
+            add_offense(node, message: format(MSG, method: replacement_method))
           end
         end
 
@@ -36,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

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for use of the `File.expand_path` arguments.
+      # Likewise, it also checks for the `Pathname.new` argument.
+      #
+      # Contrastive bad case and good case are alternately shown in
+      # the following examples.
+      #
+      # @example
+      #   # bad
+      #   File.expand_path('..', __FILE__)
+      #
+      #   # good
+      #   File.expand_path(__dir__)
+      #
+      #   # bad
+      #   File.expand_path('../..', __FILE__)
+      #
+      #   # good
+      #   File.expand_path('..', __dir__)
+      #
+      #   # bad
+      #   File.expand_path('.', __FILE__)
+      #
+      #   # good
+      #   File.expand_path(__FILE__)
+      #
+      #   # bad
+      #   Pathname(__FILE__).parent.expand_path
+      #
+      #   # good
+      #   Pathname(__dir__).expand_path
+      #
+      #   # bad
+      #   Pathname.new(__FILE__).parent.expand_path
+      #
+      #   # good
+      #   Pathname.new(__dir__).expand_path
+      #
+      class ExpandPathArguments < Cop
+        include RangeHelp
+
+        MSG = 'Use `expand_path(%<new_path>s%<new_default_dir>s)` instead of ' \
+              '`expand_path(%<current_path>s, __FILE__)`.'
+        PATHNAME_MSG = 'Use `Pathname(__dir__).expand_path` instead of ' \
+                       '`Pathname(__FILE__).parent.expand_path`.'
+        PATHNAME_NEW_MSG = 'Use `Pathname.new(__dir__).expand_path` ' \
+                           'instead of ' \
+                           '`Pathname.new(__FILE__).parent.expand_path`.'
+
+        def_node_matcher :file_expand_path, <<~PATTERN
+          (send
+            (const {nil? cbase} :File) :expand_path
+            $_
+            $_)
+        PATTERN
+
+        def_node_matcher :pathname_parent_expand_path, <<~PATTERN
+          (send
+            (send
+              (send nil? :Pathname
+                $_) :parent) :expand_path)
+        PATTERN
+
+        def_node_matcher :pathname_new_parent_expand_path, <<~PATTERN
+          (send
+            (send
+              (send
+                (const {nil? cbase} :Pathname) :new
+                $_) :parent) :expand_path)
+        PATTERN
+
+        def on_send(node)
+          if (captured_values = file_expand_path(node))
+            current_path, default_dir = captured_values
+
+            inspect_offense_for_expand_path(node, current_path, default_dir)
+          elsif (default_dir = pathname_parent_expand_path(node))
+            return unless unrecommended_argument?(default_dir)
+
+            add_offense(node, message: PATHNAME_MSG)
+          elsif (default_dir = pathname_new_parent_expand_path(node))
+            return unless unrecommended_argument?(default_dir)
+
+            add_offense(node, message: PATHNAME_NEW_MSG)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            if (captured_values = file_expand_path(node))
+              current_path, default_dir = captured_values
+
+              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, '__dir__')
+              remove_parent_method(corrector, default_dir)
+            end
+          end
+        end
+
+        private
+
+        def unrecommended_argument?(default_dir)
+          default_dir.source == '__FILE__'
+        end
+
+        def inspect_offense_for_expand_path(node, current_path, default_dir)
+          return unless unrecommended_argument?(default_dir) &&
+                        current_path.str_type?
+
+          current_path = strip_surrounded_quotes!(current_path.source)
+
+          parent_path = parent_path(current_path)
+          new_path = parent_path == '' ? '' : "'#{parent_path}', "
+
+          new_default_dir = depth(current_path).zero? ? '__FILE__' : '__dir__'
+
+          message = format(
+            MSG,
+            new_path: new_path,
+            new_default_dir: new_default_dir,
+            current_path: "'#{current_path}'"
+          )
+
+          add_offense(node, location: :selector, message: message)
+        end
+
+        def autocorrect_expand_path(corrector, current_path, default_dir)
+          stripped_current_path = strip_surrounded_quotes!(current_path.source)
+
+          case depth(stripped_current_path)
+          when 0
+            range = arguments_range(current_path)
+
+            corrector.replace(range, '__FILE__')
+          when 1
+            range = arguments_range(current_path)
+
+            corrector.replace(range, '__dir__')
+          else
+            new_path = "'#{parent_path(stripped_current_path)}'"
+
+            corrector.replace(current_path, new_path)
+            corrector.replace(default_dir, '__dir__')
+          end
+        end
+
+        def strip_surrounded_quotes!(path_string)
+          path_string.slice!(path_string.length - 1)
+          path_string.slice!(0)
+
+          path_string
+        end
+
+        def depth(current_path)
+          paths = current_path.split(File::SEPARATOR)
+
+          paths.count { |path| path != '.' }
+        end
+
+        def parent_path(current_path)
+          paths = current_path.split(File::SEPARATOR)
+
+          paths.delete('.')
+          paths.each_with_index do |path, index|
+            if path == '..'
+              paths.delete_at(index)
+              break
+            end
+          end
+
+          paths.join(File::SEPARATOR)
+        end
+
+        def remove_parent_method(corrector, default_dir)
+          node = default_dir.parent.parent.parent.children.first
+
+          corrector.remove(node.loc.dot)
+          corrector.remove(node.loc.selector)
+        end
+
+        def arguments_range(node)
+          range_between(node.parent.first_argument.source_range.begin_pos,
+                        node.parent.last_argument.source_range.end_pos)
+        end
+      end
+    end
+  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')
+          /^-?[1-9](\.\d*[0-9])?$/.match?(mantissa)
+        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')
+          /^-?[1-9](\d*[1-9])?$/.match?(mantissa)
+        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

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for division with integers coerced to floats.
+      # It is recommended to either always use `fdiv` or coerce one side only.
+      # This cop also provides other options for code consistency.
+      #
+      # @example EnforcedStyle: single_coerce (default)
+      #   # bad
+      #   a.to_f / b.to_f
+      #
+      #   # good
+      #   a.to_f / b
+      #   a / b.to_f
+      #
+      # @example EnforcedStyle: left_coerce
+      #   # bad
+      #   a / b.to_f
+      #   a.to_f / b.to_f
+      #
+      #   # good
+      #   a.to_f / b
+      #
+      # @example EnforcedStyle: right_coerce
+      #   # bad
+      #   a.to_f / b
+      #   a.to_f / b.to_f
+      #
+      #   # good
+      #   a / b.to_f
+      #
+      # @example EnforcedStyle: fdiv
+      #   # bad
+      #   a / b.to_f
+      #   a.to_f / b
+      #   a.to_f / b.to_f
+      #
+      #   # good
+      #   a.fdiv(b)
+      class FloatDivision < Cop
+        include ConfigurableEnforcedStyle
+
+        def_node_matcher :right_coerce?, <<~PATTERN
+          (send _ :/ (send _ :to_f))
+        PATTERN
+        def_node_matcher :left_coerce?, <<~PATTERN
+          (send (send _ :to_f) :/ _)
+        PATTERN
+        def_node_matcher :both_coerce?, <<~PATTERN
+          (send (send _ :to_f) :/ (send _ :to_f))
+        PATTERN
+        def_node_matcher :any_coerce?, <<~PATTERN
+          {(send _ :/ (send _ :to_f)) (send (send _ :to_f) :/ _)}
+        PATTERN
+
+        def on_send(node)
+          add_offense(node) if offense_condition?(node)
+        end
+
+        private
+
+        def offense_condition?(node)
+          case style
+          when :left_coerce
+            right_coerce?(node)
+          when :right_coerce
+            left_coerce?(node)
+          when :single_coerce
+            both_coerce?(node)
+          when :fdiv
+            any_coerce?(node)
+          else
+            false
+          end
+        end
+
+        def message(_node)
+          case style
+          when :left_coerce
+            'Prefer using `.to_f` on the left side.'
+          when :right_coerce
+            'Prefer using `.to_f` on the right side.'
+          when :single_coerce
+            'Prefer using `.to_f` on one side only.'
+          when :fdiv
+            'Prefer using `fdiv` for float divisions.'
+          end
+        end
+      end
+    end
+  end
+end