rbhint 0.8.5.rc1

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for comparison of something with nil using `==` and
+      # `nil?`.
+      #
+      # Supported styles are: predicate, comparison.
+      #
+      # @example EnforcedStyle: predicate (default)
+      #
+      #   # bad
+      #   if x == nil
+      #   end
+      #
+      #   # good
+      #   if x.nil?
+      #   end
+      #
+      # @example EnforcedStyle: comparison
+      #
+      #   # bad
+      #   if x.nil?
+      #   end
+      #
+      #   # good
+      #   if x == nil
+      #   end
+      #
+      class NilComparison < Cop
+        include ConfigurableEnforcedStyle
+
+        PREDICATE_MSG = 'Prefer the use of the `nil?` predicate.'
+        EXPLICIT_MSG = 'Prefer the use of the `==` comparison.'
+
+        def_node_matcher :nil_comparison?, '(send _ {:== :===} nil)'
+        def_node_matcher :nil_check?, '(send _ :nil?)'
+
+        def on_send(node)
+          style_check?(node) do
+            add_offense(node, location: :selector)
+          end
+        end
+
+        def autocorrect(node)
+          new_code = if prefer_comparison?
+                       node.source.sub('.nil?', ' == nil')
+                     else
+                       node.source.sub(/\s*={2,3}\s*nil/, '.nil?')
+                     end
+          ->(corrector) { corrector.replace(node, new_code) }
+        end
+
+        private
+
+        def message(_node)
+          prefer_comparison? ? EXPLICIT_MSG : PREDICATE_MSG
+        end
+
+        def style_check?(node, &block)
+          if prefer_comparison?
+            nil_check?(node, &block)
+          else
+            nil_comparison?(node, &block)
+          end
+        end
+
+        def prefer_comparison?
+          style == :comparison
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop 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.
+      #
+      # 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 < Cop
+        def_node_matcher :not_equal_to_nil?, '(send _ :!= nil)'
+        def_node_matcher :unless_check?, '(if (send _ :nil?) ...)'
+        def_node_matcher :nil_check?, '(send _ :nil?)'
+        def_node_matcher :not_and_nil_check?, '(send (send _ :nil?) :!)'
+
+        def on_send(node)
+          return if ignored_node?(node)
+
+          if not_equal_to_nil?(node)
+            add_offense(node, location: :selector)
+          elsif include_semantic_changes? &&
+                (not_and_nil_check?(node) || unless_and_nil_check?(node))
+            add_offense(node)
+          end
+        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
+
+        def autocorrect(node)
+          case node.method_name
+          when :!=
+            autocorrect_comparison(node)
+          when :!
+            autocorrect_non_nil(node, node.receiver)
+          when :nil?
+            autocorrect_unless_nil(node, node.receiver)
+          end
+        end
+
+        private
+
+        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?(:!=)
+            'Prefer `!expression.nil?` over `expression != nil`.'
+          else
+            'Explicit non-nil checks are usually redundant.'
+          end
+        end
+
+        def include_semantic_changes?
+          cop_config['IncludeSemanticChanges']
+        end
+
+        def autocorrect_comparison(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) { corrector.replace(node, new_code) }
+        end
+
+        def autocorrect_non_nil(node, inner_node)
+          lambda do |corrector|
+            if inner_node.receiver
+              corrector.replace(node, inner_node.receiver.source)
+            else
+              corrector.replace(node, 'self')
+            end
+          end
+        end
+
+        def autocorrect_unless_nil(node, receiver)
+          lambda do |corrector|
+            corrector.replace(node.parent.loc.keyword, 'if')
+            corrector.replace(node, receiver.source)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop 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 < Cop
+        include RangeHelp
+
+        MSG = 'Use `!` instead of `not`.'
+
+        OPPOSITE_METHODS = {
+          :== => :!=,
+          :!= => :==,
+          :<= => :>,
+          :> => :<=,
+          :< => :>=,
+          :>= => :<
+        }.freeze
+
+        def on_send(node)
+          return unless node.prefix_not?
+
+          add_offense(node, location: :selector)
+        end
+
+        def autocorrect(node)
+          range = range_with_surrounding_space(range: node.loc.selector,
+                                               side: :right)
+
+          if opposite_method?(node.receiver)
+            correct_opposite_method(range, node.receiver)
+          elsif requires_parens?(node.receiver)
+            correct_with_parens(range, node)
+          else
+            correct_without_parens(range)
+          end
+        end
+
+        private
+
+        def opposite_method?(child)
+          child.send_type? && OPPOSITE_METHODS.key?(child.method_name)
+        end
+
+        def requires_parens?(child)
+          child.and_type? || child.or_type? ||
+            child.send_type? && child.binary_operation? ||
+            child.if_type? && child.ternary?
+        end
+
+        def correct_opposite_method(range, child)
+          lambda do |corrector|
+            corrector.remove(range)
+            corrector.replace(child.loc.selector,
+                              OPPOSITE_METHODS[child.method_name].to_s)
+          end
+        end
+
+        def correct_with_parens(range, node)
+          lambda do |corrector|
+            corrector.replace(range, '!(')
+            corrector.insert_after(node, ')')
+          end
+        end
+
+        def correct_without_parens(range)
+          ->(corrector) { corrector.replace(range, '!') }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop 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 < Cop
+        include IntegerNode
+
+        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)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            type = literal_type(node)
+            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 literal =~ OCTAL_ZERO_ONLY_REGEX && octal_zero_only?
+            :octal_zero_only
+          elsif literal =~ OCTAL_REGEX && !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,114 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for big numeric literals without _ between groups
+      # of digits in them.
+      #
+      # @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
+      #
+      class NumericLiterals < Cop
+        # 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).
+        include ConfigurableMax
+        include IntegerNode
+
+        MSG = 'Use underscores(_) as thousands separator and ' \
+              'separate every 3 digits with them.'
+        DELIMITER_REGEXP = /[eE.]/.freeze
+
+        def on_int(node)
+          check(node)
+        end
+
+        def on_float(node)
+          check(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node, format_number(node))
+          end
+        end
+
+        private
+
+        def max_parameter_name
+          'MinDigits'
+        end
+
+        def check(node)
+          int = integer_part(node)
+
+          # TODO: handle non-decimal literals as well
+          return if int.start_with?('0')
+          return unless int.size >= min_digits
+
+          case int
+          when /^\d+$/
+            add_offense(node) { self.max = int.size + 1 }
+          when /\d{4}/, short_group_regex
+            add_offense(node) do
+              self.config_to_allow_offenses = { 'Enabled' => false }
+            end
+          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
+      end
+    end
+  end
+end