rubocop 0.75.1

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for usage of the %Q() syntax when %q() would do.
+      #
+      # @example EnforcedStyle: lower_case_q (default)
+      #   # The `lower_case_q` style prefers `%q` unless
+      #   # interpolation is needed.
+      #   # bad
+      #   %Q[Mix the foo into the baz.]
+      #   %Q(They all said: 'Hooray!')
+      #
+      #   # good
+      #   %q[Mix the foo into the baz]
+      #   %q(They all said: 'Hooray!')
+      #
+      # @example EnforcedStyle: upper_case_q
+      #   # The `upper_case_q` style requires the sole use of `%Q`.
+      #   # bad
+      #   %q/Mix the foo into the baz./
+      #   %q{They all said: 'Hooray!'}
+      #
+      #   # good
+      #   %Q/Mix the foo into the baz./
+      #   %Q{They all said: 'Hooray!'}
+      class PercentQLiterals < Cop
+        include PercentLiteral
+        include ConfigurableEnforcedStyle
+
+        LOWER_CASE_Q_MSG = 'Do not use `%Q` unless interpolation is ' \
+                           'needed. Use `%q`.'
+        UPPER_CASE_Q_MSG = 'Use `%Q` instead of `%q`.'
+
+        def on_str(node)
+          process(node, '%Q', '%q')
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.source_range, corrected(node.source))
+          end
+        end
+
+        private
+
+        def on_percent_literal(node)
+          return if correct_literal_style?(node)
+
+          # Report offense only if changing case doesn't change semantics,
+          # i.e., if the string would become dynamic or has special characters.
+          return if node.children != parse(corrected(node.source)).ast.children
+
+          add_offense(node, location: :begin)
+        end
+
+        def correct_literal_style?(node)
+          style == :lower_case_q && type(node) == '%q' ||
+            style == :upper_case_q && type(node) == '%Q'
+        end
+
+        def message(_node)
+          style == :lower_case_q ? LOWER_CASE_Q_MSG : UPPER_CASE_Q_MSG
+        end
+
+        def corrected(src)
+          src.sub(src[1], src[1].swapcase)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop looks for uses of Perl-style regexp match
+      # backreferences like $1, $2, etc.
+      #
+      # @example
+      #   # bad
+      #   puts $1
+      #
+      #   # good
+      #   puts Regexp.last_match(1)
+      class PerlBackrefs < Cop
+        MSG = 'Avoid the use of Perl-style backrefs.'
+
+        def on_nth_ref(node)
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            backref, = *node
+            parent_type = node.parent ? node.parent.type : nil
+            if %i[dstr xstr regexp].include?(parent_type)
+              corrector.replace(node.source_range,
+                                "{Regexp.last_match(#{backref})}")
+            else
+              corrector.replace(node.source_range,
+                                "Regexp.last_match(#{backref})")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop (by default) checks for uses of methods Hash#has_key? and
+      # Hash#has_value? where it enforces Hash#key? and Hash#value?
+      # It is configurable to enforce the inverse, using `verbose` method
+      # names also.
+      #
+      # @example EnforcedStyle: short (default)
+      #  # bad
+      #  Hash#has_key?
+      #  Hash#has_value?
+      #
+      #  # good
+      #  Hash#key?
+      #  Hash#value?
+      #
+      # @example EnforcedStyle: verbose
+      #  # bad
+      #  Hash#key?
+      #  Hash#value?
+      #
+      #  # good
+      #  Hash#has_key?
+      #  Hash#has_value?
+      class PreferredHashMethods < Cop
+        include ConfigurableEnforcedStyle
+
+        MSG = 'Use `Hash#%<prefer>s` instead of `Hash#%<current>s`.'
+
+        OFFENDING_SELECTORS = {
+          short: %i[has_key? has_value?],
+          verbose: %i[key? value?]
+        }.freeze
+
+        def on_send(node)
+          return unless node.arguments.one? &&
+                        offending_selector?(node.method_name)
+
+          add_offense(node, location: :selector)
+        end
+        alias on_csend on_send
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.selector,
+                              proper_method_name(node.loc.selector.source))
+          end
+        end
+
+        private
+
+        def message(node)
+          format(MSG,
+                 prefer: proper_method_name(node.method_name),
+                 current: node.method_name)
+        end
+
+        def proper_method_name(method_name)
+          if style == :verbose
+            "has_#{method_name}"
+          else
+            method_name.to_s.sub(/has_/, '')
+          end
+        end
+
+        def offending_selector?(method_name)
+          OFFENDING_SELECTORS[style].include?(method_name)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for uses of Proc.new where Kernel#proc
+      # would be more appropriate.
+      #
+      # @example
+      #   # bad
+      #   p = Proc.new { |n| puts n }
+      #
+      #   # good
+      #   p = proc { |n| puts n }
+      #
+      class Proc < Cop
+        MSG = 'Use `proc` instead of `Proc.new`.'
+
+        def_node_matcher :proc_new?,
+                         '(block $(send (const nil? :Proc) :new) ...)'
+
+        def on_block(node)
+          proc_new?(node) do |block_method|
+            add_offense(block_method)
+          end
+        end
+
+        def autocorrect(node)
+          ->(corrector) { corrector.replace(node.source_range, 'proc') }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks the args passed to `fail` and `raise`. For exploded
+      # style (default), it recommends passing the exception class and message
+      # to `raise`, rather than construct an instance of the error. It will
+      # still allow passing just a message, or the construction of an error
+      # with more than one argument.
+      #
+      # The exploded style works identically, but with the addition that it
+      # will also suggest constructing error objects when the exception is
+      # passed multiple arguments.
+      #
+      # @example EnforcedStyle: exploded (default)
+      #   # bad
+      #   raise StandardError.new("message")
+      #
+      #   # good
+      #   raise StandardError, "message"
+      #   fail "message"
+      #   raise MyCustomError.new(arg1, arg2, arg3)
+      #   raise MyKwArgError.new(key1: val1, key2: val2)
+      #
+      # @example EnforcedStyle: compact
+      #   # bad
+      #   raise StandardError, "message"
+      #   raise RuntimeError, arg1, arg2, arg3
+      #
+      #   # good
+      #   raise StandardError.new("message")
+      #   raise MyCustomError.new(arg1, arg2, arg3)
+      #   fail "message"
+      class RaiseArgs < Cop
+        include ConfigurableEnforcedStyle
+
+        EXPLODED_MSG = 'Provide an exception class and message ' \
+          'as arguments to `%<method>s`.'
+        COMPACT_MSG = 'Provide an exception object ' \
+          'as an argument to `%<method>s`.'
+
+        def on_send(node)
+          return unless node.command?(:raise) || node.command?(:fail)
+
+          case style
+          when :compact
+            check_compact(node)
+          when :exploded
+            check_exploded(node)
+          end
+        end
+
+        def autocorrect(node)
+          replacement = if style == :compact
+                          correction_exploded_to_compact(node)
+                        else
+                          correction_compact_to_exploded(node)
+                        end
+
+          ->(corrector) { corrector.replace(node.source_range, replacement) }
+        end
+
+        private
+
+        def correction_compact_to_exploded(node)
+          exception_node, _new, message_node = *node.first_argument
+
+          arguments =
+            [exception_node, message_node].compact.map(&:source).join(', ')
+
+          if node.parent && requires_parens?(node.parent)
+            "#{node.method_name}(#{arguments})"
+          else
+            "#{node.method_name} #{arguments}"
+          end
+        end
+
+        def correction_exploded_to_compact(node)
+          exception_node, *message_nodes = *node.arguments
+          return node.source if message_nodes.size > 1
+
+          argument = message_nodes.first.source
+
+          if node.parent && requires_parens?(node.parent)
+            "#{node.method_name}(#{exception_node.const_name}.new(#{argument}))"
+          else
+            "#{node.method_name} #{exception_node.const_name}.new(#{argument})"
+          end
+        end
+
+        def check_compact(node)
+          if node.arguments.size > 1
+            add_offense(node) do
+              opposite_style_detected
+            end
+          else
+            correct_style_detected
+          end
+        end
+
+        def check_exploded(node)
+          return correct_style_detected unless node.arguments.one?
+
+          first_arg = node.first_argument
+
+          return unless first_arg.send_type? && first_arg.method?(:new)
+
+          return if acceptable_exploded_args?(first_arg.arguments)
+
+          add_offense(node) do
+            opposite_style_detected
+          end
+        end
+
+        def acceptable_exploded_args?(args)
+          # Allow code like `raise Ex.new(arg1, arg2)`.
+          return true if args.size > 1
+
+          # Disallow zero arguments.
+          return false if args.empty?
+
+          arg = args.first
+
+          # Allow code like `raise Ex.new(kw: arg)`.
+          # Allow code like `raise Ex.new(*args)`.
+          arg.hash_type? || arg.splat_type?
+        end
+
+        def requires_parens?(parent)
+          parent.and_type? || parent.or_type? ||
+            parent.if_type? && parent.ternary?
+        end
+
+        def message(node)
+          if style == :compact
+            format(COMPACT_MSG, method: node.method_name)
+          else
+            format(EXPLODED_MSG, method: node.method_name)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for the use of randomly generated numbers,
+      # added/subtracted with integer literals, as well as those with
+      # Integer#succ and Integer#pred methods. Prefer using ranges instead,
+      # as it clearly states the intentions.
+      #
+      # @example
+      #   # bad
+      #   rand(6) + 1
+      #   1 + rand(6)
+      #   rand(6) - 1
+      #   1 - rand(6)
+      #   rand(6).succ
+      #   rand(6).pred
+      #   Random.rand(6) + 1
+      #   Kernel.rand(6) + 1
+      #   rand(0..5) + 1
+      #
+      #   # good
+      #   rand(1..6)
+      #   rand(1...7)
+      class RandomWithOffset < Cop
+        MSG = 'Prefer ranges when generating random numbers instead of ' \
+          'integers with offsets.'
+
+        def_node_matcher :integer_op_rand?, <<~PATTERN
+          (send
+            int {:+ :-}
+            (send
+              {nil? (const nil? :Random) (const nil? :Kernel)}
+              :rand
+              {int irange erange}))
+        PATTERN
+
+        def_node_matcher :rand_op_integer?, <<~PATTERN
+          (send
+            (send
+              {nil? (const nil? :Random) (const nil? :Kernel)}
+              :rand
+              {int irange erange})
+            {:+ :-}
+            int)
+        PATTERN
+
+        def_node_matcher :rand_modified?, <<~PATTERN
+          (send
+            (send
+              {nil? (const nil? :Random) (const nil? :Kernel)}
+              :rand
+              {int irange erange})
+            {:succ :pred :next})
+        PATTERN
+
+        def on_send(node)
+          return unless integer_op_rand?(node) ||
+                        rand_op_integer?(node) ||
+                        rand_modified?(node)
+
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            if integer_op_rand?(node)
+              corrector.replace(node.source_range,
+                                corrected_integer_op_rand(node))
+            elsif rand_op_integer?(node)
+              corrector.replace(node.source_range,
+                                corrected_rand_op_integer(node))
+            elsif rand_modified?(node)
+              corrector.replace(node.source_range,
+                                corrected_rand_modified(node))
+            end
+          end
+        end
+
+        private
+
+        def_node_matcher :random_call, <<~PATTERN
+          {(send (send $_ _ $_) ...)
+           (send _ _ (send $_ _ $_))}
+        PATTERN
+
+        def corrected_integer_op_rand(node)
+          random_call(node) do |prefix_node, random_node|
+            prefix = prefix_from_prefix_node(prefix_node)
+            left_int, right_int = boundaries_from_random_node(random_node)
+
+            offset = to_int(node.receiver)
+
+            if node.method?(:+)
+              "#{prefix}(#{offset + left_int}..#{offset + right_int})"
+            else
+              "#{prefix}(#{offset - right_int}..#{offset - left_int})"
+            end
+          end
+        end
+
+        def corrected_rand_op_integer(node)
+          random_call(node) do |prefix_node, random_node|
+            prefix = prefix_from_prefix_node(prefix_node)
+            left_int, right_int = boundaries_from_random_node(random_node)
+
+            offset = to_int(node.first_argument)
+
+            if node.method?(:+)
+              "#{prefix}(#{left_int + offset}..#{right_int + offset})"
+            else
+              "#{prefix}(#{left_int - offset}..#{right_int - offset})"
+            end
+          end
+        end
+
+        def corrected_rand_modified(node)
+          random_call(node) do |prefix_node, random_node|
+            prefix = prefix_from_prefix_node(prefix_node)
+            left_int, right_int = boundaries_from_random_node(random_node)
+
+            if %i[succ next].include?(node.method_name)
+              "#{prefix}(#{left_int + 1}..#{right_int + 1})"
+            elsif node.method?(:pred)
+              "#{prefix}(#{left_int - 1}..#{right_int - 1})"
+            end
+          end
+        end
+
+        def_node_matcher :namespace, <<~PATTERN
+          {$nil? (const nil? $_)}
+        PATTERN
+
+        def prefix_from_prefix_node(node)
+          namespace(node) do |namespace|
+            [namespace, 'rand'].compact.join('.')
+          end
+        end
+
+        def boundaries_from_random_node(random_node)
+          case random_node.type
+          when :int
+            [0, to_int(random_node) - 1]
+          when :irange
+            [to_int(random_node.begin), to_int(random_node.end)]
+          when :erange
+            [to_int(random_node.begin), to_int(random_node.end) - 1]
+          end
+        end
+
+        def_node_matcher :to_int, <<~PATTERN
+          (int $_)
+        PATTERN
+      end
+    end
+  end
+end