rubocop 0.52.1 → 0.93.1

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

@@ -3,8 +3,8 @@
 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
       #
@@ -15,30 +15,27 @@ module RuboCop
       #   # good
       #   if x.even?
       #   end
-      class EvenOdd < Cop
-        MSG = 'Replace with `Integer#%<method>s?`.'.freeze
+      class EvenOdd < Base
+        extend AutoCorrector
 
-        def_node_matcher :even_odd_candidate?, <<-PATTERN
+        MSG = 'Replace with `Integer#%<method>s?`.'
+        RESTRICT_ON_SEND = %i[== !=].freeze
+
+        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, method: replacement_method))
-          end
-        end
-
-        def autocorrect(node)
           even_odd_candidate?(node) do |base_number, method, arg|
             replacement_method = replacement_method(arg, method)
-
-            correction = "#{base_number.source}.#{replacement_method}?"
-            ->(corrector) { corrector.replace(node.source_range, correction) }
+            add_offense(node, message: format(MSG, method: replacement_method)) do |corrector|
+              correction = "#{base_number.source}.#{replacement_method}?"
+              corrector.replace(node, correction)
+            end
           end
         end
 

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

@@ -0,0 +1,195 @@
+# 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 < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        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`.'
+
+        RESTRICT_ON_SEND = %i[expand_path].freeze
+
+        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 (current_path, default_dir = file_expand_path(node))
+            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) do |corrector|
+              autocorrect(corrector, node)
+            end
+          elsif (default_dir = pathname_new_parent_expand_path(node))
+            return unless unrecommended_argument?(default_dir)
+
+            add_offense(node, message: PATHNAME_NEW_MSG) do |corrector|
+              autocorrect(corrector, node)
+            end
+          end
+        end
+
+        private
+
+        def autocorrect(corrector, node)
+          if (current_path, default_dir = file_expand_path(node))
+            autocorrect_expand_path(corrector, current_path, default_dir)
+          elsif (dir = pathname_parent_expand_path(node) || pathname_new_parent_expand_path(node))
+            corrector.replace(dir, '__dir__')
+            remove_parent_method(corrector, dir)
+          end
+        end
+
+        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.loc.selector, message: message) do |corrector|
+            autocorrect(corrector, node)
+          end
+        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/explicit_block_argument.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop enforces the use of explicit block argument to avoid writing
+      # block literal that just passes its arguments to another block.
+      #
+      # @example
+      #   # bad
+      #   def with_tmp_dir
+      #     Dir.mktmpdir do |tmp_dir|
+      #       Dir.chdir(tmp_dir) { |dir| yield dir } # block just passes arguments
+      #     end
+      #   end
+      #
+      #   # bad
+      #   def nine_times
+      #     9.times { yield }
+      #   end
+      #
+      #   # good
+      #   def with_tmp_dir(&block)
+      #     Dir.mktmpdir do |tmp_dir|
+      #       Dir.chdir(tmp_dir, &block)
+      #     end
+      #   end
+      #
+      #   with_tmp_dir do |dir|
+      #     puts "dir is accessible as a parameter and pwd is set: #{dir}"
+      #   end
+      #
+      #   # good
+      #   def nine_times(&block)
+      #     9.times(&block)
+      #   end
+      #
+      class ExplicitBlockArgument < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Consider using explicit block argument in the '\
+              "surrounding method's signature over `yield`."
+
+        def_node_matcher :yielding_block?, <<~PATTERN
+          (block $_ (args $...) (yield $...))
+        PATTERN
+
+        def initialize(config = nil, options = nil)
+          super
+          @def_nodes = Set.new
+        end
+
+        def on_yield(node)
+          block_node = node.parent
+
+          yielding_block?(block_node) do |send_node, block_args, yield_args|
+            return unless yielding_arguments?(block_args, yield_args)
+
+            def_node = block_node.each_ancestor(:def, :defs).first
+            # if `yield` is being called outside of a method context, ignore
+            # this is not a valid ruby pattern, but can happen in haml or erb,
+            # so this can cause crashes in haml_lint
+            return unless def_node
+
+            add_offense(block_node) do |corrector|
+              corrector.remove(block_body_range(block_node, send_node))
+
+              add_block_argument(send_node, corrector)
+              add_block_argument(def_node, corrector) if @def_nodes.add?(def_node)
+            end
+          end
+        end
+
+        private
+
+        def yielding_arguments?(block_args, yield_args)
+          yield_args.zip(block_args).all? do |yield_arg, block_arg|
+            block_arg && yield_arg.children.first == block_arg.children.first
+          end
+        end
+
+        def add_block_argument(node, corrector)
+          if node.arguments?
+            last_arg = node.arguments.last
+            arg_range = range_with_surrounding_comma(last_arg.source_range, :right)
+            replacement = ' &block'
+            replacement = ",#{replacement}" unless arg_range.source.end_with?(',')
+            corrector.insert_after(arg_range, replacement) unless last_arg.blockarg_type?
+          elsif node.call_type?
+            corrector.insert_after(node, '(&block)')
+          else
+            corrector.insert_after(node.loc.name, '(&block)')
+          end
+        end
+
+        def block_body_range(block_node, send_node)
+          range_between(
+            send_node.loc.expression.end_pos,
+            block_node.loc.end.end_pos
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,117 @@
+# 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 < Base
+        include ConfigurableEnforcedStyle
+        MESSAGES = {
+          scientific: 'Use a mantissa in [1, 10[.',
+          engineering: 'Use an exponent divisible by 3 and a mantissa in [0.1, 1000[.',
+          integral: 'Use an integer as mantissa, without trailing zero.'
+        }.freeze
+
+        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)
+          MESSAGES[style]
+        end
+      end
+    end
+  end
+end