rubocop 0.57.2 → 0.58.0

data/lib/rubocop/cop/rails/create_table_with_timestamps.rb

@@ -59,7 +59,9 @@ module RuboCop
         PATTERN
 
         def_node_search :created_at_or_updated_at_included?, <<-PATTERN
-          (send _var :datetime (sym {:created_at :updated_at}) ...)
+          (send _var :datetime
+            {(sym {:created_at :updated_at})(str {"created_at" "updated_at"})}
+            ...)
         PATTERN
 
         def on_send(node)

data/lib/rubocop/cop/registry.rb

@@ -23,8 +23,9 @@ module RuboCop
     # Registry that tracks all cops by their badge and department.
     class Registry
       def initialize(cops = [])
-        @registry    = {}
+        @registry = {}
         @departments = {}
+        @cops_by_cop_name = Hash.new { |hash, key| hash[key] = [] }
 
         cops.each { |cop| enlist(cop) }
       end
@@ -33,6 +34,7 @@ module RuboCop
         @registry[cop.badge] = cop
         @departments[cop.department] ||= []
         @departments[cop.department] << cop
+        @cops_by_cop_name[cop.cop_name] << cop
       end
 
       # @return [Array<Symbol>] list of departments for current cops.
@@ -102,8 +104,9 @@ module RuboCop
         end
       end
 
+      # @return [Hash{String => Array<Class>}]
       def to_h
-        cops.group_by(&:cop_name)
+        @cops_by_cop_name
       end
 
       def cops
@@ -142,6 +145,12 @@ module RuboCop
         cops.each(&block)
       end
 
+      # @param [String] cop_name
+      # @return [Class, nil]
+      def find_by_cop_name(cop_name)
+        @cops_by_cop_name[cop_name].first
+      end
+
       private
 
       def with(cops)

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

@@ -4,6 +4,11 @@ module RuboCop
   module Cop
     module Style
       # This cop checks ensures source files have no utf-8 encoding comments.
+      # @example
+      #   # bad
+      #   # encoding: UTF-8
+      #   # coding: UTF-8
+      #   # -*- coding: UTF-8 -*-
       class Encoding < Cop
         include RangeHelp
 

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

@@ -4,6 +4,14 @@ module RuboCop
   module Cop
     module Style
       # This cop checks for END blocks.
+      #
+      # @example
+      #   # bad
+      #   END { puts 'Goodbye!' }
+      #
+      #   # good
+      #   at_exit { puts 'Goodbye!' }
+      #
       class EndBlock < Cop
         MSG = 'Avoid the use of `END` blocks. ' \
               'Use `Kernel#at_exit` instead.'.freeze

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

@@ -5,7 +5,8 @@ module RuboCop
     module Style
       # Checks for if and unless statements that would fit on one line
       # if written as a modifier if/unless. The maximum line length is
-      # configured in the `Metrics/LineLength` cop.
+      # configured in the `Metrics/LineLength` cop. The tab size is configured
+      # in the `IndentationWidth` of the `Layout/Tab` cop.
       #
       # @example
       #   # bad

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.'.freeze
+
+        def offense?(node)
+          contents = node.source[1...-1]
+          return false if contents.empty?
+
+          return false if whitelist.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)
+
+          contents =~ ::Resolv::IPv4::Regex || contents =~ ::Resolv::IPv6::Regex
+        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 whitelist
+          whitelist = cop_config['Whitelist']
+          Array(whitelist).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

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

@@ -18,8 +18,12 @@ module RuboCop
         MSG = 'Avoid comparing a variable with multiple items ' \
           'in a conditional, use `Array#include?` instead.'.freeze
 
-        def on_if(node)
-          return unless nested_variable_comparison?(node.condition)
+        def on_or(node)
+          root_of_or_node = root_of_or_node(node)
+
+          return unless node == root_of_or_node
+          return unless nested_variable_comparison?(root_of_or_node)
+
           add_offense(node)
         end
 
@@ -71,6 +75,16 @@ module RuboCop
         def comparison?(node)
           simple_comparison?(node) || nested_comparison?(node)
         end
+
+        def root_of_or_node(or_node)
+          return or_node unless or_node.parent
+
+          if or_node.parent.or_type?
+            root_of_or_node(or_node.parent)
+          else
+            or_node
+          end
+        end
       end
     end
   end

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

@@ -22,7 +22,7 @@ module RuboCop
         def_node_matcher :symbol_proc?, <<-PATTERN
           (block
             ${(send ...) (super ...) zsuper}
-            (args (arg _var))
+            $(args (arg _var))
             (send (lvar _var) $_))
         PATTERN
 
@@ -31,7 +31,7 @@ module RuboCop
         end
 
         def on_block(node)
-          symbol_proc?(node) do |send_or_super, method|
+          symbol_proc?(node) do |send_or_super, block_args, method|
             block_method_name = resolve_block_method_name(send_or_super)
 
             # TODO: Rails-specific handling that we should probably make
@@ -40,6 +40,8 @@ module RuboCop
             return if proc_node?(send_or_super)
             return if %i[lambda proc].include?(block_method_name)
             return if ignored_method?(block_method_name)
+            return if block_args.children.size == 1 &&
+                      block_args.source.include?(',')
 
             offense(node, method, block_method_name)
           end

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

@@ -34,9 +34,12 @@ module RuboCop
         include RangeHelp
 
         MSG = 'Use double pipes `||` instead.'.freeze
+        UNNEEDED_CONDITION = 'This condition is not needed.'.freeze
 
         def on_if(node)
+          return if node.elsif_conditional?
           return unless offense?(node)
+
           add_offense(node, location: range_of_offense(node))
         end
 
@@ -44,6 +47,8 @@ module RuboCop
           lambda do |corrector|
             if node.ternary?
               corrector.replace(range_of_offense(node), '||')
+            elsif node.modifier_form?
+              corrector.replace(node.source_range, node.if_branch.source)
             else
               corrected = [node.if_branch.source,
                            else_source(node.else_branch)].join(' || ')
@@ -55,16 +60,24 @@ module RuboCop
 
         private
 
+        def message(node)
+          if node.modifier_form?
+            UNNEEDED_CONDITION
+          else
+            MSG
+          end
+        end
+
         def range_of_offense(node)
           return :expression unless node.ternary?
           range_between(node.loc.question.begin_pos, node.loc.colon.end_pos)
         end
 
         def offense?(node)
-          return false if node.elsif_conditional?
-
           condition, if_branch, else_branch = *node
 
+          return false if use_if_branch?(else_branch)
+
           condition == if_branch && !node.elsif? && (
             node.ternary? ||
             !else_branch.instance_of?(AST::Node) ||
@@ -72,6 +85,10 @@ module RuboCop
           )
         end
 
+        def use_if_branch?(else_branch)
+          else_branch && else_branch.if_type?
+        end
+
         def else_source(else_branch)
           wrap_else = MODIFIER_NODES.include?(else_branch.type) &&
                       else_branch.modifier_form?

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -18,8 +18,6 @@ module RuboCop
       @config_to_allow_offenses = {}
       @detected_styles = {}
 
-      COPS = Cop::Cop.registry.to_h
-
       class << self
         attr_accessor :config_to_allow_offenses, :detected_styles
       end
@@ -101,7 +99,9 @@ module RuboCop
         if @show_offense_counts
           output_buffer.puts "# Offense count: #{offense_count}"
         end
-        if COPS[cop_name] && COPS[cop_name].first.new.support_autocorrect?
+
+        cop_class = Cop::Cop.registry.find_by_cop_name(cop_name)
+        if cop_class && cop_class.new.support_autocorrect?
           output_buffer.puts '# Cop supports --auto-correct.'
         end
 

data/lib/rubocop/options.rb

@@ -5,6 +5,7 @@ require 'shellwords'
 
 module RuboCop
   class IncorrectCopNameError < StandardError; end
+  class OptionArgumentError < StandardError; end
 
   # This class handles command line options.
   class Options
@@ -26,7 +27,7 @@ module RuboCop
         # The parser has put the file name given after --stdin into
         # @options[:stdin]. The args array should be empty.
         if args.any?
-          raise ArgumentError, '-s/--stdin requires exactly one path.'
+          raise OptionArgumentError, '-s/--stdin requires exactly one path.'
         end
         # We want the STDIN contents in @options[:stdin] and the file name in
         # args to simplify the rest of the processing.
@@ -241,21 +242,21 @@ module RuboCop
 
     def validate_compatibility # rubocop:disable Metrics/MethodLength
       if only_includes_unneeded_disable?
-        raise ArgumentError, 'Lint/UnneededCopDisableDirective can not ' \
-                             'be used with --only.'
+        raise OptionArgumentError, 'Lint/UnneededCopDisableDirective can not ' \
+                                   'be used with --only.'
       end
       if except_syntax?
-        raise ArgumentError, 'Syntax checking can not be turned off.'
+        raise OptionArgumentError, 'Syntax checking can not be turned off.'
       end
       unless boolean_or_empty_cache?
-        raise ArgumentError, '-C/--cache argument must be true or false'
+        raise OptionArgumentError, '-C/--cache argument must be true or false'
       end
       validate_auto_gen_config
       validate_parallel
 
       return if incompatible_options.size <= 1
-      raise ArgumentError, 'Incompatible cli options: ' \
-                           "#{incompatible_options.inspect}"
+      raise OptionArgumentError, 'Incompatible cli options: ' \
+                                 "#{incompatible_options.inspect}"
     end
 
     def validate_auto_gen_config
@@ -265,7 +266,8 @@ module RuboCop
 
       %i[exclude_limit no_offense_counts no_auto_gen_timestamp].each do |option|
         if @options.key?(option)
-          raise ArgumentError, format(message, flag: option.to_s.tr('_', '-'))
+          raise OptionArgumentError,
+                format(message, flag: option.to_s.tr('_', '-'))
         end
       end
     end
@@ -274,11 +276,15 @@ module RuboCop
       return unless @options.key?(:parallel)
 
       if @options[:cache] == 'false'
-        raise ArgumentError, '-P/--parallel uses caching to speed up ' \
-                             'execution, so combining with --cache false is ' \
-                             'not allowed.'
+        raise OptionArgumentError, '-P/--parallel uses caching to speed up ' \
+                                   'execution, so combining with --cache ' \
+                                   'false is not allowed.'
       end
 
+      validate_parallel_with_combo_option
+    end
+
+    def validate_parallel_with_combo_option
       combos = {
         auto_gen_config: '-P/--parallel uses caching to speed up execution, ' \
                          'while --auto-gen-config needs a non-cached run, ' \
@@ -287,7 +293,9 @@ module RuboCop
         auto_correct: '-P/--parallel can not be combined with --auto-correct.'
       }
 
-      combos.each { |key, msg| raise ArgumentError, msg if @options.key?(key) }
+      combos.each do |key, msg|
+        raise OptionArgumentError, msg if @options.key?(key)
+      end
     end
 
     def only_includes_unneeded_disable?

data/lib/rubocop/processed_source.rb

@@ -163,12 +163,9 @@ module RuboCop
       [ast, comments, tokens]
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+    # rubocop:disable Metrics/MethodLength
     def parser_class(ruby_version)
       case ruby_version
-      when 2.1
-        require 'parser/ruby21'
-        Parser::Ruby21
       when 2.2
         require 'parser/ruby22'
         Parser::Ruby22
@@ -188,7 +185,7 @@ module RuboCop
         raise ArgumentError, "Unknown Ruby version: #{ruby_version.inspect}"
       end
     end
-    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength
+    # rubocop:enable Metrics/MethodLength
 
     def create_parser(ruby_version)
       builder = RuboCop::AST::Builder.new

data/lib/rubocop/rspec/cop_helper.rb

@@ -14,10 +14,6 @@ module CopHelper
     Tempfile.open('tmp') { |f| inspect_source(source, f) }
   end
 
-  def inspect_gemfile(source)
-    inspect_source(source, 'Gemfile')
-  end
-
   def inspect_source(source, file = nil)
     if source.is_a?(Array) && source.size == 1
       raise "Don't use an array for a single line of code: #{source}"

data/lib/rubocop/rspec/shared_contexts.rb

@@ -59,10 +59,6 @@ shared_context 'config', :config do
   end
 end
 
-shared_context 'ruby 2.1', :ruby21 do
-  let(:ruby_version) { 2.1 }
-end
-
 shared_context 'ruby 2.2', :ruby22 do
   let(:ruby_version) { 2.2 }
 end

data/lib/rubocop/rspec/shared_examples.rb

@@ -9,29 +9,6 @@ shared_examples_for 'accepts' do
   end
 end
 
-shared_examples_for 'mimics MRI 2.1' do |grep_mri_warning|
-  if RUBY_ENGINE == 'ruby' && RUBY_VERSION.start_with?('2.1')
-    it "mimics MRI #{RUBY_VERSION} built-in syntax checking" do
-      inspect_source(source)
-      offenses_by_mri = MRISyntaxChecker.offenses_for_source(
-        source, cop.name, grep_mri_warning
-      )
-
-      # Compare objects before comparing counts for clear failure output.
-      cop.offenses.each_with_index do |offense_by_cop, index|
-        offense_by_mri = offenses_by_mri[index]
-        # Exclude column attribute since MRI does not
-        # output column number.
-        %i[severity line cop_name].each do |a|
-          expect(offense_by_cop.send(a)).to eq(offense_by_mri.send(a))
-        end
-      end
-
-      expect(cop.offenses.count).to eq(offenses_by_mri.count)
-    end
-  end
-end
-
 shared_examples_for 'misaligned' do |annotated_source, used_style|
   config_to_allow_offenses = if used_style
                                { 'EnforcedStyleAlignWith' => used_style.to_s }