rubocop 0.87.1

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for uses of semicolon in if statements.
+      #
+      # @example
+      #
+      #   # bad
+      #   result = if some_condition; something else another_thing end
+      #
+      #   # good
+      #   result = some_condition ? something : another_thing
+      #
+      class IfWithSemicolon < Cop
+        include OnNormalIfUnless
+
+        MSG = 'Do not use if x; Use the ternary operator instead.'
+
+        def on_normal_if_unless(node)
+          return unless node.else_branch
+
+          beginning = node.loc.begin
+          return unless beginning&.is?(';')
+
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node, correct_to_ternary(node))
+          end
+        end
+
+        private
+
+        def correct_to_ternary(node)
+          else_code = node.else_branch ? node.else_branch.source : 'nil'
+
+          "#{node.condition.source} ? #{node.if_branch.source} : #{else_code}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for `raise` or `fail` statements which do not specify an
+      # explicit exception class. (This raises a `RuntimeError`. Some projects
+      # might prefer to use exception classes which more precisely identify the
+      # nature of the error.)
+      #
+      # @example
+      #   # bad
+      #   raise 'Error message here'
+      #
+      #   # good
+      #   raise ArgumentError, 'Error message here'
+      class ImplicitRuntimeError < Cop
+        MSG = 'Use `%<method>s` with an explicit exception class and message,' \
+              ' rather than just a message.'
+
+        def_node_matcher :implicit_runtime_error_raise_or_fail,
+                         '(send nil? ${:raise :fail} {str dstr})'
+
+        def on_send(node)
+          implicit_runtime_error_raise_or_fail(node) do |method|
+            add_offense(node, message: format(MSG, method: method))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Use `Kernel#loop` for infinite loops.
+      #
+      # @example
+      #   # bad
+      #   while true
+      #     work
+      #   end
+      #
+      #   # good
+      #   loop do
+      #     work
+      #   end
+      class InfiniteLoop < Cop
+        LEADING_SPACE = /\A(\s*)/.freeze
+
+        MSG = 'Use `Kernel#loop` for infinite loops.'
+
+        def join_force?(force_class)
+          force_class == VariableForce
+        end
+
+        def after_leaving_scope(scope, _variable_table)
+          @variables ||= []
+          @variables.concat(scope.variables.values)
+        end
+
+        def on_while(node)
+          while_or_until(node) if node.condition.truthy_literal?
+        end
+
+        def on_until(node)
+          while_or_until(node) if node.condition.falsey_literal?
+        end
+
+        alias on_while_post on_while
+        alias on_until_post on_until
+
+        def autocorrect(node)
+          if node.while_post_type? || node.until_post_type?
+            replace_begin_end_with_modifier(node)
+          elsif node.modifier_form?
+            replace_source(node.source_range, modifier_replacement(node))
+          else
+            replace_source(non_modifier_range(node), 'loop do')
+          end
+        end
+
+        private
+
+        def while_or_until(node)
+          range = node.source_range
+          # Not every `while true` and `until false` can be turned into a
+          # `loop do` without further modification. The reason is that a
+          # variable that's introduced inside a while/until loop is in scope
+          # outside of that loop too, but a variable that's assigned for the
+          # first time inside a block cannot be accessed after the block. In
+          # those more complicated cases we don't report an offense.
+          return if @variables.any? do |var|
+            assigned_inside_loop?(var, range) &&
+            !assigned_before_loop?(var, range) &&
+            referenced_after_loop?(var, range)
+          end
+
+          add_offense(node, location: :keyword)
+        end
+
+        def assigned_inside_loop?(var, range)
+          var.assignments.any? { |a| range.contains?(a.node.source_range) }
+        end
+
+        def assigned_before_loop?(var, range)
+          b = range.begin_pos
+          var.assignments.any? { |a| a.node.source_range.end_pos < b }
+        end
+
+        def referenced_after_loop?(var, range)
+          e = range.end_pos
+          var.references.any? { |r| r.node.source_range.begin_pos > e }
+        end
+
+        def replace_begin_end_with_modifier(node)
+          lambda do |corrector|
+            corrector.replace(node.body.loc.begin, 'loop do')
+            corrector.remove(node.body.loc.end.end.join(node.source_range.end))
+          end
+        end
+
+        def replace_source(range, replacement)
+          lambda do |corrector|
+            corrector.replace(range, replacement)
+          end
+        end
+
+        def modifier_replacement(node)
+          body = node.body
+          if node.single_line?
+            'loop { ' + body.source + ' }'
+          else
+            indentation = body.source_range.source_line[LEADING_SPACE]
+
+            ['loop do', body.source.gsub(/^/, configured_indent),
+             'end'].join("\n#{indentation}")
+          end
+        end
+
+        def non_modifier_range(node)
+          start_range = node.loc.keyword.begin
+          end_range = if node.do?
+                        node.loc.begin.end
+                      else
+                        node.condition.source_range.end
+                      end
+
+          start_range.join(end_range)
+        end
+
+        def configured_indent
+          ' ' * config.for_cop('Layout/IndentationWidth')['Width']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for trailing inline comments.
+      #
+      # @example
+      #
+      #   # good
+      #   foo.each do |f|
+      #     # Standalone comment
+      #     f.bar
+      #   end
+      #
+      #   # bad
+      #   foo.each do |f|
+      #     f.bar # Trailing inline comment
+      #   end
+      class InlineComment < Cop
+        MSG = 'Avoid trailing inline comments.'
+
+        def investigate(processed_source)
+          processed_source.each_comment do |comment|
+            next if comment_line?(processed_source[comment.loc.line - 1]) ||
+                    comment.text.match?(/\A# rubocop:(enable|disable)/)
+
+            add_offense(comment)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop check for usages of not (`not` or `!`) called on a method
+      # when an inverse of that method can be used instead.
+      # Methods that can be inverted by a not (`not` or `!`) should be defined
+      # in `InverseMethods`
+      # Methods that are inverted by inverting the return
+      # of the block that is passed to the method should be defined in
+      # `InverseBlocks`
+      #
+      # @example
+      #   # bad
+      #   !foo.none?
+      #   !foo.any? { |f| f.even? }
+      #   !foo.blank?
+      #   !(foo == bar)
+      #   foo.select { |f| !f.even? }
+      #   foo.reject { |f| f != 7 }
+      #
+      #   # good
+      #   foo.none?
+      #   foo.blank?
+      #   foo.any? { |f| f.even? }
+      #   foo != bar
+      #   foo == bar
+      #   !!('foo' =~ /^\w+$/)
+      #   !(foo.class < Numeric) # Checking class hierarchy is allowed
+      #   # Blocks with guard clauses are ignored:
+      #   foo.select do |f|
+      #     next if f.zero?
+      #     f != 1
+      #   end
+      class InverseMethods < Cop
+        include IgnoredNode
+        include RangeHelp
+
+        MSG = 'Use `%<inverse>s` instead of inverting `%<method>s`.'
+        CLASS_COMPARISON_METHODS = %i[<= >= < >].freeze
+        EQUALITY_METHODS = %i[== != =~ !~ <= >= < >].freeze
+        NEGATED_EQUALITY_METHODS = %i[!= !~].freeze
+        CAMEL_CASE = /[A-Z]+[a-z]+/.freeze
+
+        def self.autocorrect_incompatible_with
+          [Style::Not, Style::SymbolProc]
+        end
+
+        def_node_matcher :inverse_candidate?, <<~PATTERN
+          {
+            (send $(send $(...) $_ $...) :!)
+            (send (block $(send $(...) $_) $...) :!)
+            (send (begin $(send $(...) $_ $...)) :!)
+          }
+        PATTERN
+
+        def_node_matcher :inverse_block?, <<~PATTERN
+          (block $(send (...) $_) ... { $(send ... :!)
+                                        $(send (...) {:!= :!~} ...)
+                                        (begin ... $(send ... :!))
+                                        (begin ... $(send (...) {:!= :!~} ...))
+                                      })
+        PATTERN
+
+        def on_send(node)
+          return if part_of_ignored_node?(node)
+
+          inverse_candidate?(node) do |_method_call, lhs, method, rhs|
+            return unless inverse_methods.key?(method)
+            return if possible_class_hierarchy_check?(lhs, rhs, method)
+            return if negated?(node)
+
+            add_offense(node,
+                        message: format(MSG, method: method,
+                                             inverse: inverse_methods[method]))
+          end
+        end
+
+        def on_block(node)
+          inverse_block?(node) do |_method_call, method, block|
+            return unless inverse_blocks.key?(method)
+            return if negated?(node) && negated?(node.parent)
+            return if node.each_node(:next).any?
+
+            # Inverse method offenses inside of the block of an inverse method
+            # offense, such as `y.reject { |key, _value| !(key =~ /c\d/) }`,
+            # can cause auto-correction to apply improper corrections.
+            ignore_node(block)
+            add_offense(node,
+                        message: format(MSG, method: method,
+                                             inverse: inverse_blocks[method]))
+          end
+        end
+
+        def autocorrect(node)
+          if node.block_type?
+            correct_inverse_block(node)
+          elsif node.send_type?
+            correct_inverse_method(node)
+          end
+        end
+
+        def correct_inverse_method(node)
+          method_call, _lhs, method, _rhs = inverse_candidate?(node)
+          return unless method_call && method
+
+          lambda do |corrector|
+            corrector.remove(not_to_receiver(node, method_call))
+            corrector.replace(method_call.loc.selector,
+                              inverse_methods[method].to_s)
+            remove_end_parenthesis(corrector, node, method, method_call)
+          end
+        end
+
+        def correct_inverse_block(node)
+          method_call, method, block = inverse_block?(node)
+
+          lambda do |corrector|
+            corrector.replace(method_call.loc.selector,
+                              inverse_blocks[method].to_s)
+            correct_inverse_selector(block, corrector)
+          end
+        end
+
+        def correct_inverse_selector(block, corrector)
+          selector_loc = block.loc.selector
+          selector = selector_loc.source
+
+          if NEGATED_EQUALITY_METHODS.include?(selector.to_sym)
+            selector[0] = '='
+            corrector.replace(selector_loc, selector)
+          else
+            if block.loc.dot
+              range = dot_range(block.loc)
+              corrector.remove(range)
+            end
+
+            corrector.remove(selector_loc)
+          end
+        end
+
+        private
+
+        def inverse_methods
+          @inverse_methods ||= cop_config['InverseMethods']
+                               .merge(cop_config['InverseMethods'].invert)
+        end
+
+        def inverse_blocks
+          @inverse_blocks ||= cop_config['InverseBlocks']
+                              .merge(cop_config['InverseBlocks'].invert)
+        end
+
+        def negated?(node)
+          node.parent.respond_to?(:method?) && node.parent.method?(:!)
+        end
+
+        def not_to_receiver(node, method_call)
+          Parser::Source::Range.new(node.loc.expression.source_buffer,
+                                    node.loc.selector.begin_pos,
+                                    method_call.loc.expression.begin_pos)
+        end
+
+        def end_parentheses(node, method_call)
+          Parser::Source::Range.new(node.loc.expression.source_buffer,
+                                    method_call.loc.expression.end_pos,
+                                    node.loc.expression.end_pos)
+        end
+
+        # When comparing classes, `!(Integer < Numeric)` is not the same as
+        # `Integer > Numeric`.
+        def possible_class_hierarchy_check?(lhs, rhs, method)
+          CLASS_COMPARISON_METHODS.include?(method) &&
+            (camel_case_constant?(lhs) ||
+             (rhs.size == 1 &&
+              camel_case_constant?(rhs.first)))
+        end
+
+        def camel_case_constant?(node)
+          node.const_type? && CAMEL_CASE.match?(node.source)
+        end
+
+        def dot_range(loc)
+          range_between(loc.dot.begin_pos, loc.expression.end_pos)
+        end
+
+        def remove_end_parenthesis(corrector, node, method, method_call)
+          return unless EQUALITY_METHODS.include?(method) ||
+                        method_call.parent.begin_type?
+
+          corrector.remove(end_parentheses(node, method_call))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'resolv'
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for hardcoded IP addresses, which can make code
+      # brittle. IP addresses are likely to need to be changed when code
+      # is deployed to a different server or environment, which may break
+      # a deployment if forgotten. Prefer setting IP addresses in ENV or
+      # other configuration.
+      #
+      # @example
+      #
+      #   # bad
+      #   ip_address = '127.59.241.29'
+      #
+      #   # good
+      #   ip_address = ENV['DEPLOYMENT_IP_ADDRESS']
+      class IpAddresses < Cop
+        include StringHelp
+
+        IPV6_MAX_SIZE = 45 # IPv4-mapped IPv6 is the longest
+        MSG = 'Do not hardcode IP addresses.'
+
+        def offense?(node)
+          contents = node.source[1...-1]
+          return false if contents.empty?
+
+          return false if allowed_addresses.include?(contents.downcase)
+
+          # To try to avoid doing two regex checks on every string,
+          # shortcut out if the string does not look like an IP address
+          return false unless could_be_ip?(contents)
+
+          ::Resolv::IPv4::Regex.match?(contents) || ::Resolv::IPv6::Regex.match?(contents)
+        end
+
+        # Dummy implementation of method in ConfigurableEnforcedStyle that is
+        # called from StringHelp.
+        def opposite_style_detected; end
+
+        # Dummy implementation of method in ConfigurableEnforcedStyle that is
+        # called from StringHelp.
+        def correct_style_detected; end
+
+        private
+
+        def allowed_addresses
+          allowed_addresses = cop_config['AllowedAddresses']
+          Array(allowed_addresses).map(&:downcase)
+        end
+
+        def could_be_ip?(str)
+          # If the string is too long, it can't be an IP
+          return false if too_long?(str)
+
+          # If the string doesn't start with a colon or hexadecimal char,
+          # we know it's not an IP address
+          starts_with_hex_or_colon?(str)
+        end
+
+        def too_long?(str)
+          str.size > IPV6_MAX_SIZE
+        end
+
+        def starts_with_hex_or_colon?(str)
+          first_char = str[0].ord
+          (48..58).cover?(first_char) || (65..70).cover?(first_char) ||
+            (97..102).cover?(first_char)
+        end
+      end
+    end
+  end
+end