rubocop-grantbirki 1.75.2

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

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for non-nil checks, which are usually redundant.
+      #
+      # With `IncludeSemanticChanges` set to `false` by default, this cop
+      # does not report offenses for `!x.nil?` and does no changes that might
+      # change behavior.
+      # Also `IncludeSemanticChanges` set to `false` with `EnforcedStyle: comparison` of
+      # `Style/NilComparison` cop, this cop does not report offenses for `x != nil` and
+      # does no changes to `!x.nil?` style.
+      #
+      # With `IncludeSemanticChanges` set to `true`, this cop reports offenses
+      # for `!x.nil?` and autocorrects that and `x != nil` to solely `x`, which
+      # is *usually* OK, but might change behavior.
+      #
+      # @example
+      #   # bad
+      #   if x != nil
+      #   end
+      #
+      #   # good
+      #   if x
+      #   end
+      #
+      #   # Non-nil checks are allowed if they are the final nodes of predicate.
+      #   # good
+      #   def signed_in?
+      #     !current_user.nil?
+      #   end
+      #
+      # @example IncludeSemanticChanges: false (default)
+      #   # good
+      #   if !x.nil?
+      #   end
+      #
+      # @example IncludeSemanticChanges: true
+      #   # bad
+      #   if !x.nil?
+      #   end
+      #
+      class NonNilCheck < Base
+        extend AutoCorrector
+
+        MSG_FOR_REPLACEMENT = 'Prefer `%<prefer>s` over `%<current>s`.'
+        MSG_FOR_REDUNDANCY = 'Explicit non-nil checks are usually redundant.'
+
+        RESTRICT_ON_SEND = %i[!= nil? !].freeze
+
+        # @!method not_equal_to_nil?(node)
+        def_node_matcher :not_equal_to_nil?, '(send _ :!= nil)'
+
+        # @!method unless_check?(node)
+        def_node_matcher :unless_check?, '(if (send _ :nil?) ...)'
+
+        # @!method nil_check?(node)
+        def_node_matcher :nil_check?, '(send _ :nil?)'
+
+        # @!method not_and_nil_check?(node)
+        def_node_matcher :not_and_nil_check?, '(send (send _ :nil?) :!)'
+
+        def on_send(node)
+          return if ignored_node?(node) ||
+                    (!include_semantic_changes? && nil_comparison_style == 'comparison')
+          return unless register_offense?(node)
+
+          message = message(node)
+          add_offense(node, message: message) { |corrector| autocorrect(corrector, node) }
+        end
+
+        def on_def(node)
+          body = node.body
+
+          return unless node.predicate_method? && body
+
+          if body.begin_type?
+            ignore_node(body.children.last)
+          else
+            ignore_node(body)
+          end
+        end
+        alias on_defs on_def
+
+        private
+
+        def register_offense?(node)
+          not_equal_to_nil?(node) ||
+            (include_semantic_changes? && (not_and_nil_check?(node) || unless_and_nil_check?(node)))
+        end
+
+        def autocorrect(corrector, node)
+          case node.method_name
+          when :!=
+            autocorrect_comparison(corrector, node)
+          when :!
+            autocorrect_non_nil(corrector, node, node.receiver)
+          when :nil?
+            autocorrect_unless_nil(corrector, node, node.receiver)
+          end
+        end
+
+        def unless_and_nil_check?(send_node)
+          parent = send_node.parent
+
+          nil_check?(send_node) && unless_check?(parent) && !parent.ternary? && parent.unless?
+        end
+
+        def message(node)
+          if node.method?(:!=) && !include_semantic_changes?
+            prefer = "!#{node.receiver.source}.nil?"
+            format(MSG_FOR_REPLACEMENT, prefer: prefer, current: node.source)
+          else
+            MSG_FOR_REDUNDANCY
+          end
+        end
+
+        def include_semantic_changes?
+          cop_config['IncludeSemanticChanges']
+        end
+
+        def autocorrect_comparison(corrector, node)
+          expr = node.source
+
+          new_code = if include_semantic_changes?
+                       expr.sub(/\s*!=\s*nil/, '')
+                     else
+                       expr.sub(/^(\S*)\s*!=\s*nil/, '!\1.nil?')
+                     end
+
+          return if expr == new_code
+
+          corrector.replace(node, new_code)
+        end
+
+        def autocorrect_non_nil(corrector, node, inner_node)
+          if inner_node.receiver
+            corrector.replace(node, inner_node.receiver.source)
+          else
+            corrector.replace(node, 'self')
+          end
+        end
+
+        def autocorrect_unless_nil(corrector, node, receiver)
+          corrector.replace(node.parent.loc.keyword, 'if')
+          corrector.replace(node, receiver.source)
+        end
+
+        def nil_comparison_style
+          nil_comparison_conf = config.for_cop('Style/NilComparison')
+
+          nil_comparison_conf['Enabled'] && nil_comparison_conf['EnforcedStyle']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for uses of the keyword `not` instead of `!`.
+      #
+      # @example
+      #
+      #   # bad - parentheses are required because of op precedence
+      #   x = (not something)
+      #
+      #   # good
+      #   x = !something
+      #
+      class Not < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Use `!` instead of `not`.'
+        RESTRICT_ON_SEND = %i[!].freeze
+
+        OPPOSITE_METHODS = {
+          :== => :!=,
+          :!= => :==,
+          :<= => :>,
+          :> => :<=,
+          :< => :>=,
+          :>= => :<
+        }.freeze
+
+        def on_send(node)
+          return unless node.prefix_not?
+
+          add_offense(node.loc.selector) do |corrector|
+            range = range_with_surrounding_space(node.loc.selector, side: :right)
+
+            if opposite_method?(node.receiver)
+              correct_opposite_method(corrector, range, node.receiver)
+            elsif requires_parens?(node.receiver)
+              correct_with_parens(corrector, range, node)
+            else
+              correct_without_parens(corrector, range)
+            end
+          end
+        end
+
+        private
+
+        def opposite_method?(child)
+          child.send_type? && OPPOSITE_METHODS.key?(child.method_name)
+        end
+
+        def requires_parens?(child)
+          child.operator_keyword? ||
+            (child.send_type? && child.binary_operation?) ||
+            (child.if_type? && child.ternary?)
+        end
+
+        def correct_opposite_method(corrector, range, child)
+          corrector.remove(range)
+          corrector.replace(child.loc.selector, OPPOSITE_METHODS[child.method_name].to_s)
+        end
+
+        def correct_with_parens(corrector, range, node)
+          corrector.replace(range, '!(')
+          corrector.insert_after(node, ')')
+        end
+
+        def correct_without_parens(corrector, range)
+          corrector.replace(range, '!')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for numbered parameters.
+      #
+      # It can either restrict the use of numbered parameters to
+      # single-lined blocks, or disallow completely numbered parameters.
+      #
+      # @example EnforcedStyle: allow_single_line (default)
+      #   # bad
+      #   collection.each do
+      #     puts _1
+      #   end
+      #
+      #   # good
+      #   collection.each { puts _1 }
+      #
+      # @example EnforcedStyle: disallow
+      #   # bad
+      #   collection.each { puts _1 }
+      #
+      #   # good
+      #   collection.each { |item| puts item }
+      #
+      class NumberedParameters < Base
+        include ConfigurableEnforcedStyle
+        extend TargetRubyVersion
+
+        MSG_DISALLOW = 'Avoid using numbered parameters.'
+        MSG_MULTI_LINE = 'Avoid using numbered parameters for multi-line blocks.'
+
+        minimum_target_ruby_version 2.7
+
+        def on_numblock(node)
+          if style == :disallow
+            add_offense(node, message: MSG_DISALLOW)
+          elsif node.multiline?
+            add_offense(node, message: MSG_MULTI_LINE)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Detects use of an excessive amount of numbered parameters in a
+      # single block. Having too many numbered parameters can make code too
+      # cryptic and hard to read.
+      #
+      # The cop defaults to registering an offense if there is more than 1 numbered
+      # parameter but this maximum can be configured by setting `Max`.
+      #
+      # @example Max: 1 (default)
+      #   # bad
+      #   use_multiple_numbered_parameters { _1.call(_2, _3, _4) }
+      #
+      #   # good
+      #   array.each { use_array_element_as_numbered_parameter(_1) }
+      #   hash.each { use_only_hash_value_as_numbered_parameter(_2) }
+      class NumberedParametersLimit < Base
+        extend TargetRubyVersion
+        extend ExcludeLimit
+
+        DEFAULT_MAX_VALUE = 1
+
+        minimum_target_ruby_version 2.7
+        exclude_limit 'Max'
+
+        MSG = 'Avoid using more than %<max>i numbered %<parameter>s; %<count>i detected.'
+        NUMBERED_PARAMETER_PATTERN = /\A_[1-9]\z/.freeze
+
+        def on_numblock(node)
+          param_count = numbered_parameter_nodes(node).uniq.count
+          return if param_count <= max_count
+
+          parameter = max_count > 1 ? 'parameters' : 'parameter'
+          message = format(MSG, max: max_count, parameter: parameter, count: param_count)
+          add_offense(node, message: message) { self.max = param_count }
+        end
+
+        private
+
+        def numbered_parameter_nodes(node)
+          node.each_descendant(:lvar).select do |lvar_node|
+            lvar_node.source.match?(NUMBERED_PARAMETER_PATTERN)
+          end
+        end
+
+        def max_count
+          max = cop_config.fetch('Max', DEFAULT_MAX_VALUE)
+
+          # Ruby does not allow more than 9 numbered parameters
+          [max, 9].min
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for octal, hex, binary, and decimal literals using
+      # uppercase prefixes and corrects them to lowercase prefix
+      # or no prefix (in case of decimals).
+      #
+      # @example EnforcedOctalStyle: zero_with_o (default)
+      #   # bad - missing octal prefix
+      #   num = 01234
+      #
+      #   # bad - uppercase prefix
+      #   num = 0O1234
+      #   num = 0X12AB
+      #   num = 0B10101
+      #
+      #   # bad - redundant decimal prefix
+      #   num = 0D1234
+      #   num = 0d1234
+      #
+      #   # good
+      #   num = 0o1234
+      #   num = 0x12AB
+      #   num = 0b10101
+      #   num = 1234
+      #
+      # @example EnforcedOctalStyle: zero_only
+      #   # bad
+      #   num = 0o1234
+      #   num = 0O1234
+      #
+      #   # good
+      #   num = 01234
+      class NumericLiteralPrefix < Base
+        include IntegerNode
+        extend AutoCorrector
+
+        OCTAL_ZERO_ONLY_REGEX = /^0[Oo][0-7]+$/.freeze
+        OCTAL_REGEX = /^0O?[0-7]+$/.freeze
+        HEX_REGEX = /^0X[0-9A-F]+$/.freeze
+        BINARY_REGEX = /^0B[01]+$/.freeze
+        DECIMAL_REGEX = /^0[dD][0-9]+$/.freeze
+
+        OCTAL_ZERO_ONLY_MSG = 'Use 0 for octal literals.'
+        OCTAL_MSG = 'Use 0o for octal literals.'
+        HEX_MSG = 'Use 0x for hexadecimal literals.'
+        BINARY_MSG = 'Use 0b for binary literals.'
+        DECIMAL_MSG = 'Do not use prefixes for decimal literals.'
+
+        def on_int(node)
+          type = literal_type(node)
+
+          return unless type
+
+          add_offense(node) do |corrector|
+            corrector.replace(node, send(:"format_#{type}", node.source))
+          end
+        end
+
+        private
+
+        def message(node)
+          self.class.const_get(:"#{literal_type(node).upcase}_MSG")
+        end
+
+        def literal_type(node)
+          literal = integer_part(node)
+
+          octal_literal_type(literal) || hex_bin_dec_literal_type(literal)
+        end
+
+        def octal_literal_type(literal)
+          if OCTAL_ZERO_ONLY_REGEX.match?(literal) && octal_zero_only?
+            :octal_zero_only
+          elsif OCTAL_REGEX.match?(literal) && !octal_zero_only?
+            :octal
+          end
+        end
+
+        def hex_bin_dec_literal_type(literal)
+          case literal
+          when HEX_REGEX
+            :hex
+          when BINARY_REGEX
+            :binary
+          when DECIMAL_REGEX
+            :decimal
+          end
+        end
+
+        def octal_zero_only?
+          cop_config['EnforcedOctalStyle'] == 'zero_only'
+        end
+
+        def format_octal(source)
+          source.sub(/^0O?/, '0o')
+        end
+
+        def format_octal_zero_only(source)
+          source.sub(/^0[Oo]?/, '0')
+        end
+
+        def format_hex(source)
+          source.sub(/^0X/, '0x')
+        end
+
+        def format_binary(source)
+          source.sub(/^0B/, '0b')
+        end
+
+        def format_decimal(source)
+          source.sub(/^0[dD]/, '')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for big numeric literals without `_` between groups
+      # of digits in them.
+      #
+      # Additional allowed patterns can be added by adding regexps to
+      # the `AllowedPatterns` configuration. All regexps are treated
+      # as anchored even if the patterns do not contain anchors (so
+      # `\d{4}_\d{4}` will allow `1234_5678` but not `1234_5678_9012`).
+      #
+      # NOTE: Even if `AllowedPatterns` are given, autocorrection will
+      # only correct to the standard pattern of an `_` every 3 digits.
+      #
+      # @example
+      #
+      #   # bad
+      #   1000000
+      #   1_00_000
+      #   1_0000
+      #
+      #   # good
+      #   1_000_000
+      #   1000
+      #
+      # @example Strict: false (default)
+      #
+      #   # good
+      #   10_000_00 # typical representation of $10,000 in cents
+      #
+      # @example Strict: true
+      #
+      #   # bad
+      #   10_000_00 # typical representation of $10,000 in cents
+      #
+      # @example AllowedNumbers: [3000]
+      #
+      #   # good
+      #   3000 # You can specify allowed numbers. (e.g. port number)
+      #
+      class NumericLiterals < Base
+        include IntegerNode
+        include AllowedPattern
+        extend AutoCorrector
+
+        MSG = 'Use underscores(_) as thousands separator and separate every 3 digits with them.'
+        DELIMITER_REGEXP = /[eE.]/.freeze
+
+        # The parameter is called MinDigits (meaning the minimum number of
+        # digits for which an offense can be registered), but essentially it's
+        # a Max parameter (the maximum number of something that's allowed).
+        exclude_limit 'MinDigits'
+
+        def on_int(node)
+          check(node)
+        end
+
+        def on_float(node)
+          check(node)
+        end
+
+        private
+
+        def check(node)
+          int = integer_part(node)
+          # TODO: handle non-decimal literals as well
+          return if int.start_with?('0')
+          return if allowed_numbers.include?(int)
+          return if matches_allowed_pattern?(int)
+          return unless int.size >= min_digits
+
+          case int
+          when /^\d+$/
+            register_offense(node) { self.min_digits = int.size + 1 }
+          when /\d{4}/, short_group_regex
+            register_offense(node) { self.config_to_allow_offenses = { 'Enabled' => false } }
+          end
+        end
+
+        def register_offense(node, &_block)
+          add_offense(node) do |corrector|
+            yield
+            corrector.replace(node, format_number(node))
+          end
+        end
+
+        def short_group_regex
+          cop_config['Strict'] ? /_\d{1,2}(_|$)/ : /_\d{1,2}_/
+        end
+
+        def format_number(node)
+          source = node.source.gsub(/\s+/, '')
+          int_part, additional_part = source.split(DELIMITER_REGEXP, 2)
+          formatted_int = format_int_part(int_part)
+          delimiter = source[DELIMITER_REGEXP]
+
+          if additional_part
+            formatted_int + delimiter + additional_part
+          else
+            formatted_int
+          end
+        end
+
+        # @param int_part [String]
+        def format_int_part(int_part)
+          int_part = Integer(int_part)
+          formatted_int = int_part.abs.to_s.reverse.gsub(/...(?=.)/, '\&_').reverse
+          formatted_int.insert(0, '-') if int_part.negative?
+          formatted_int
+        end
+
+        def min_digits
+          cop_config['MinDigits']
+        end
+
+        def allowed_numbers
+          cop_config.fetch('AllowedNumbers', []).map(&:to_s)
+        end
+
+        def allowed_patterns
+          # Convert the patterns to be anchored
+          super.map { |regexp| /\A#{regexp}\z/ }
+        end
+      end
+    end
+  end
+end