rubocop 0.51.0 → 0.87.0

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

@@ -3,14 +3,11 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for Yoda conditions, i.e. comparison operations where
-      # readability is reduced because the operands are not ordered the same
-      # way as they would be ordered in spoken English.
-      #
-      # @example
-      #
-      #   # EnforcedStyle: all_comparison_operators
+      # This cop can either enforce or forbid Yoda conditions,
+      # i.e. comparison operations where the order of expression is reversed.
+      # eg. `5 == x`
       #
+      # @example EnforcedStyle: forbid_for_all_comparison_operators (default)
       #   # bad
       #   99 == foo
       #   "bar" != foo
@@ -22,22 +19,44 @@ module RuboCop
       #   foo == "bar"
       #   foo <= 42
       #   bar > 10
+      #   "#{interpolation}" == foo
+      #   /#{interpolation}/ == foo
       #
-      # @example
+      # @example EnforcedStyle: forbid_for_equality_operators_only
+      #   # bad
+      #   99 == foo
+      #   "bar" != foo
       #
-      #   # EnforcedStyle: equality_operators_only
+      #   # good
+      #   99 >= foo
+      #   3 < a && a < 5
       #
+      # @example EnforcedStyle: require_for_all_comparison_operators
       #   # bad
+      #   foo == 99
+      #   foo == "bar"
+      #   foo <= 42
+      #   bar > 10
+      #
+      #   # good
       #   99 == foo
       #   "bar" != foo
+      #   42 >= foo
+      #   10 < bar
       #
-      #   # good
+      # @example EnforcedStyle: require_for_equality_operators_only
+      #   # bad
       #   99 >= foo
       #   3 < a && a < 5
+      #
+      #   # good
+      #   99 == foo
+      #   "bar" != foo
       class YodaCondition < Cop
         include ConfigurableEnforcedStyle
+        include RangeHelp
 
-        MSG = 'Reverse the order of the operands `%s`.'.freeze
+        MSG = 'Reverse the order of the operands `%<source>s`.'
 
         REVERSE_COMPARISON = {
           '<' => '>',
@@ -50,40 +69,63 @@ module RuboCop
 
         NONCOMMUTATIVE_OPERATORS = %i[===].freeze
 
+        PROGRAM_NAMES = %i[$0 $PROGRAM_NAME].freeze
+
+        def_node_matcher :file_constant_equal_program_name?, <<~PATTERN
+          (send #source_file_path_constant? {:== :!=} (gvar #program_name?))
+        PATTERN
+
         def on_send(node)
-          return unless yoda_condition?(node)
+          return unless yoda_compatible_condition?(node)
+          return if equality_only? && non_equality_operator?(node) ||
+                    file_constant_equal_program_name?(node)
 
-          add_offense(node)
+          valid_yoda?(node) || add_offense(node)
         end
 
-        private
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(actual_code_range(node), corrected_code(node))
+          end
+        end
 
-        def yoda_condition?(node)
-          return false unless node.comparison_method?
+        private
 
-          lhs, operator, rhs = *node
-          if check_equality_only?
-            return false if non_equality_operator?(operator)
-          end
+        def enforce_yoda?
+          style == :require_for_all_comparison_operators ||
+            style == :require_for_equality_operators_only
+        end
 
-          return false if noncommutative_operator?(operator)
+        def equality_only?
+          style == :forbid_for_equality_operators_only ||
+            style == :require_for_equality_operators_only
+        end
 
-          lhs.literal? && !rhs.literal?
+        def yoda_compatible_condition?(node)
+          node.comparison_method? &&
+            !noncommutative_operator?(node)
         end
 
-        def message(node)
-          format(MSG, node.source)
+        def valid_yoda?(node)
+          lhs = node.receiver
+          rhs = node.first_argument
+
+          return true if lhs.literal? && rhs.literal? ||
+                         !lhs.literal? && !rhs.literal? ||
+                         interpolation?(lhs)
+
+          enforce_yoda? ? lhs.literal? : rhs.literal?
         end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(actual_code_range(node), corrected_code(node))
-          end
+        def message(node)
+          format(MSG, source: node.source)
         end
 
         def corrected_code(node)
-          lhs, operator, rhs = *node
-          "#{rhs.source} #{reverse_comparison(operator)} #{lhs.source}"
+          lhs = node.receiver
+          rhs = node.first_argument
+
+          "#{rhs.source} #{reverse_comparison(node.method_name)} #{lhs.source}"
         end
 
         def actual_code_range(node)
@@ -96,16 +138,34 @@ module RuboCop
           REVERSE_COMPARISON.fetch(operator.to_s, operator)
         end
 
-        def check_equality_only?
-          style == :equality_operators_only
+        def non_equality_operator?(node)
+          !EQUALITY_OPERATORS.include?(node.method_name)
+        end
+
+        def noncommutative_operator?(node)
+          NONCOMMUTATIVE_OPERATORS.include?(node.method_name)
+        end
+
+        def source_file_path_constant?(node)
+          node.source == '__FILE__'
         end
 
-        def non_equality_operator?(operator)
-          !EQUALITY_OPERATORS.include?(operator)
+        def program_name?(name)
+          PROGRAM_NAMES.include?(name)
         end
 
-        def noncommutative_operator?(operator)
-          NONCOMMUTATIVE_OPERATORS.include?(operator)
+        def interpolation?(node)
+          return true if node.dstr_type?
+
+          # TODO: Use `RegexpNode#interpolation?` when the following is released.
+          # https://github.com/rubocop-hq/rubocop-ast/pull/18
+          if node.regexp_type?
+            return true if node.children.any? do |child|
+              child.respond_to?(:begin_type?) && child.begin_type?
+            end
+          end
+
+          false
         end
       end
     end

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

@@ -7,11 +7,10 @@ module RuboCop
       # by a predicate method, such as receiver.length == 0,
       # receiver.length > 0, receiver.length != 0,
       # receiver.length < 1 and receiver.size == 0 that can be
-      # replaced by receiver.empty? and !receiver.empty.
+      # replaced by receiver.empty? and !receiver.empty?.
       #
       # @example
-      #
-      #   @bad
+      #   # bad
       #   [1, 2, 3].length == 0
       #   0 == "foobar".length
       #   array.length < 1
@@ -19,7 +18,7 @@ module RuboCop
       #   string.length > 0
       #   hash.size > 0
       #
-      #   @good
+      #   # good
       #   [1, 2, 3].empty?
       #   "foobar".empty?
       #   array.empty?
@@ -27,14 +26,21 @@ module RuboCop
       #   !string.empty?
       #   !hash.empty?
       class ZeroLengthPredicate < Cop
-        ZERO_MSG = 'Use `empty?` instead of `%s %s %s`.'.freeze
-        NONZERO_MSG = 'Use `!empty?` instead of `%s %s %s`.'.freeze
+        ZERO_MSG = 'Use `empty?` instead of `%<lhs>s %<opr>s %<rhs>s`.'
+        NONZERO_MSG = 'Use `!empty?` instead of ' \
+                      '`%<lhs>s %<opr>s %<rhs>s`.'
 
         def on_send(node)
           check_zero_length_predicate(node)
           check_nonzero_length_predicate(node)
         end
 
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node, replacement(node))
+          end
+        end
+
         private
 
         def check_zero_length_predicate(node)
@@ -42,8 +48,14 @@ module RuboCop
 
           return unless zero_length_predicate
 
-          add_offense(node,
-                      message: format(ZERO_MSG, *zero_length_predicate))
+          lhs, opr, rhs = zero_length_predicate
+
+          return if non_polymorphic_collection?(node)
+
+          add_offense(
+            node,
+            message: format(ZERO_MSG, lhs: lhs, opr: opr, rhs: rhs)
+          )
         end
 
         def check_nonzero_length_predicate(node)
@@ -51,28 +63,28 @@ module RuboCop
 
           return unless nonzero_length_predicate
 
-          add_offense(node,
-                      message: format(NONZERO_MSG, *nonzero_length_predicate))
+          lhs, opr, rhs = nonzero_length_predicate
+
+          return if non_polymorphic_collection?(node)
+
+          add_offense(
+            node,
+            message: format(NONZERO_MSG, lhs: lhs, opr: opr, rhs: rhs)
+          )
         end
 
-        def_node_matcher :zero_length_predicate, <<-PATTERN
+        def_node_matcher :zero_length_predicate, <<~PATTERN
           {(send (send (...) ${:length :size}) $:== (int $0))
            (send (int $0) $:== (send (...) ${:length :size}))
            (send (send (...) ${:length :size}) $:<  (int $1))
            (send (int $1) $:> (send (...) ${:length :size}))}
         PATTERN
 
-        def_node_matcher :nonzero_length_predicate, <<-PATTERN
+        def_node_matcher :nonzero_length_predicate, <<~PATTERN
           {(send (send (...) ${:length :size}) ${:> :!=} (int $0))
            (send (int $0) ${:< :!=} (send (...) ${:length :size}))}
         PATTERN
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.expression, replacement(node))
-          end
-        end
-
         def replacement(node)
           receiver = zero_length_receiver(node)
           return "#{receiver.source}.empty?" if receiver
@@ -80,17 +92,25 @@ module RuboCop
           "!#{other_receiver(node).source}.empty?"
         end
 
-        def_node_matcher :zero_length_receiver, <<-PATTERN
+        def_node_matcher :zero_length_receiver, <<~PATTERN
           {(send (send $_ _) :== (int 0))
            (send (int 0) :== (send $_ _))
            (send (send $_ _) :<  (int 1))
            (send (int 1) :> (send $_ _))}
         PATTERN
 
-        def_node_matcher :other_receiver, <<-PATTERN
+        def_node_matcher :other_receiver, <<~PATTERN
           {(send (send $_ _) _ _)
            (send _ _ (send $_ _))}
         PATTERN
+
+        # Some collection like objects in the Ruby standard library
+        # implement `#size`, but not `#empty`. We ignore those to
+        # reduce false positives.
+        def_node_matcher :non_polymorphic_collection?, <<~PATTERN
+          {(send (send (send (const {nil? cbase} :File) :stat _) ...) ...)
+           (send (send (send (const {nil? cbase} {:Tempfile :StringIO}) {:new :open} ...) ...) ...)}
+        PATTERN
       end
     end
   end

data/lib/rubocop/cop/team.rb

@@ -2,29 +2,52 @@
 
 module RuboCop
   module Cop
-    # FIXME
+    # A group of cops, ready to be called on duty to inspect files.
+    # Team is responsible for selecting only relevant cops to be sent on duty,
+    # as well as insuring that the needed forces are sent along with them.
+    #
+    # For performance reasons, Team will first dispatch cops & forces in two groups,
+    # first the ones needed for autocorrection (if any), then the rest
+    # (unless autocorrections happened).
     class Team
-      DEFAULT_OPTIONS = {
-        auto_correct: false,
-        debug: false
-      }.freeze
-
-      Investigation = Struct.new(:offenses, :errors)
-
-      attr_reader :errors, :warnings, :updated_source_file
+      attr_reader :errors, :warnings, :updated_source_file, :cops
 
       alias updated_source_file? updated_source_file
 
-      def initialize(cop_classes, config, options = nil)
-        @cop_classes = cop_classes
+      def initialize(cops, config = nil, options = {})
+        @cops = cops
         @config = config
-        @options = options || DEFAULT_OPTIONS
-        @errors = []
-        @warnings = []
+        @options = options
+        reset
+        @ready = true
 
         validate_config
       end
 
+      # @return [Team]
+      def self.new(cop_or_classes, config, options = {})
+        # Support v0 api:
+        return mobilize(cop_or_classes, config, options) if cop_or_classes.first.is_a?(Class)
+
+        super
+      end
+
+      # @return [Team] with cops assembled from the given `cop_classes`
+      def self.mobilize(cop_classes, config, options = {})
+        cops = mobilize_cops(cop_classes, config, options)
+        new(cops, config, options)
+      end
+
+      # @return [Array<Cop::Cop>]
+      def self.mobilize_cops(cop_classes, config, options = {})
+        cop_classes = Registry.new(cop_classes.to_a) unless cop_classes.is_a?(Registry)
+        only = options.fetch(:only, [])
+        safe = options.fetch(:safe, false)
+        cop_classes.enabled(config, only, safe).map do |cop_class|
+          cop_class.new(config, options)
+        end
+      end
+
       def autocorrect?
         @options[:auto_correct]
       end
@@ -33,152 +56,197 @@ module RuboCop
         @options[:debug]
       end
 
+      # @deprecated. Use investigate
+      # @return Array<offenses>
       def inspect_file(processed_source)
-        # If we got any syntax errors, return only the syntax offenses.
-        unless processed_source.valid_syntax?
-          return Lint::Syntax.offenses_from_processed_source(
-            processed_source, @config, @options
-          )
-        end
-
-        offenses(processed_source)
+        investigate(processed_source).offenses
       end
 
-      def cops
-        only_options = @options.fetch(:only, [])
-        @cops ||= @cop_classes.enabled(@config, only_options).map do |cop_class|
-          cop_class.new(@config, @options)
+      # @return [Commissioner::InvestigationReport]
+      def investigate(processed_source)
+        be_ready
+
+        # The autocorrection process may have to be repeated multiple times
+        # until there are no corrections left to perform
+        # To speed things up, run auto-correcting cops by themselves, and only
+        # run the other cops when no corrections are left
+        on_duty = roundup_relevant_cops(processed_source.file_path)
+
+        autocorrect_cops, other_cops = on_duty.partition(&:autocorrect?)
+
+        report = investigate_partial(autocorrect_cops, processed_source)
+
+        unless autocorrect(processed_source, report)
+          # If we corrected some errors, another round of inspection will be
+          # done, and any other offenses will be caught then, so only need
+          # to check other_cops if no correction was done
+          report = report.merge(investigate_partial(other_cops, processed_source))
         end
+
+        process_errors(processed_source.path, report.errors)
+
+        report
+      ensure
+        @ready = false
       end
 
+      # @deprecated
       def forces
-        @forces ||= forces_for(cops)
+        @forces ||= self.class.forces_for(cops)
       end
 
-      def forces_for(cops)
-        Force.all.each_with_object([]) do |force_class, forces|
-          joining_cops = cops.select { |cop| cop.join_force?(force_class) }
-          next if joining_cops.empty?
-          forces << force_class.new(joining_cops)
+      # @return [Array<Force>] needed for the given cops
+      def self.forces_for(cops)
+        needed = Hash.new { |h, k| h[k] = [] }
+        cops.each do |cop|
+          Array(cop.class.joining_forces).each { |force| needed[force] << cop }
+        end
+
+        needed.map do |force_class, joining_cops|
+          force_class.new(joining_cops)
         end
       end
 
-      def autocorrect(buffer, cops)
+      def external_dependency_checksum
+        keys = cops.map(&:external_dependency_checksum).compact
+        Digest::SHA1.hexdigest(keys.join)
+      end
+
+      private
+
+      def autocorrect(processed_source, report)
         @updated_source_file = false
         return unless autocorrect?
 
-        new_source = autocorrect_all_cops(buffer, cops)
+        new_source = autocorrect_report(report)
 
-        return if new_source == buffer.source
+        return unless new_source
 
         if @options[:stdin]
           # holds source read in from stdin, when --stdin option is used
           @options[:stdin] = new_source
         else
-          filename = buffer.name
+          filename = processed_source.buffer.name
           File.open(filename, 'w') { |f| f.write(new_source) }
         end
         @updated_source_file = true
       end
 
-      private
+      def be_ready
+        return if @ready
 
-      def offenses(processed_source)
-        # The autocorrection process may have to be repeated multiple times
-        # until there are no corrections left to perform
-        # To speed things up, run auto-correcting cops by themselves, and only
-        # run the other cops when no corrections are left
-        autocorrect_cops, other_cops = cops.partition(&:autocorrect?)
-
-        autocorrect =
-          investigate(autocorrect_cops, processed_source) do |offenses|
-            # We corrected some errors. Another round of inspection will be
-            # done, and any other offenses will be caught then, so we don't
-            # need to continue.
-            return offenses if autocorrect(processed_source.buffer,
-                                           autocorrect_cops)
-          end
+        reset
+        @cops.map!(&:ready)
+        @ready = true
+      end
 
-        other = investigate(other_cops, processed_source)
+      def reset
+        @errors = []
+        @warnings = []
+      end
 
-        errors = autocorrect.errors.merge(other.errors)
-        process_commissioner_errors(processed_source.path, errors)
+      # @return [Commissioner::InvestigationReport]
+      def investigate_partial(cops, processed_source)
+        commissioner = Commissioner.new(cops, self.class.forces_for(cops), @options)
+        commissioner.investigate(processed_source)
+      end
 
-        autocorrect.offenses.concat(other.offenses)
+      # @return [Array<cop>]
+      def roundup_relevant_cops(filename)
+        cops.reject do |cop|
+          cop.excluded_file?(filename) ||
+            !support_target_ruby_version?(cop) ||
+            !support_target_rails_version?(cop)
+        end
       end
 
-      def investigate(cops, processed_source)
-        return Investigation.new([], {}) if cops.empty?
+      def support_target_ruby_version?(cop)
+        return true unless cop.class.respond_to?(:support_target_ruby_version?)
+
+        cop.class.support_target_ruby_version?(cop.target_ruby_version)
+      end
 
-        commissioner = Commissioner.new(cops, forces_for(cops))
-        offenses = commissioner.investigate(processed_source)
-        yield offenses if block_given?
+      def support_target_rails_version?(cop)
+        return true unless cop.class.respond_to?(:support_target_rails_version?)
 
-        Investigation.new(offenses, commissioner.errors)
+        cop.class.support_target_rails_version?(cop.target_rails_version)
       end
 
-      def autocorrect_all_cops(buffer, cops)
-        corrector = Corrector.new(buffer)
+      def autocorrect_report(report)
+        corrector = collate_corrections(report)
 
-        collate_corrections(corrector, cops)
+        corrector.rewrite unless corrector.empty?
+      end
 
-        if !corrector.corrections.empty?
-          corrector.rewrite
-        else
-          buffer.source
+      def collate_corrections(report)
+        corrector = Corrector.new(report.processed_source)
+
+        each_corrector(report) do |to_merge|
+          suppress_clobbering do
+            corrector.merge!(to_merge)
+          end
         end
+
+        corrector
       end
 
-      def collate_corrections(corrector, cops)
+      def each_corrector(report)
         skips = Set.new
+        report.cop_reports.each do |cop_report|
+          cop = cop_report.cop
+          corrector = cop_report.corrector
 
-        cops.each do |cop|
-          next if cop.corrections.empty?
+          next if corrector.nil? || corrector.empty?
           next if skips.include?(cop.class)
 
-          corrector.corrections.concat(cop.corrections)
+          yield corrector
+
           skips.merge(cop.class.autocorrect_incompatible_with)
         end
       end
 
+      def suppress_clobbering
+        yield
+      rescue ::Parser::ClobberingError
+        # ignore Clobbering errors
+      end
+
       def validate_config
         cops.each do |cop|
           cop.validate_config if cop.respond_to?(:validate_config)
         end
       end
 
-      def process_commissioner_errors(file, file_errors)
-        file_errors.each do |cop, errors|
-          errors.each do |cop_error|
-            e = cop_error.error
-            line = ":#{cop_error.line}" if cop_error.line
-            column = ":#{cop_error.column}" if cop_error.column
-            location = "#{file}#{line}#{column}"
-
-            if e.is_a?(Warning)
-              handle_warning(e, location)
-            else
-              handle_error(e, location, cop)
-            end
+      def process_errors(file, errors)
+        errors.each do |error|
+          line = ":#{error.line}" if error.line
+          column = ":#{error.column}" if error.column
+          location = "#{file}#{line}#{column}"
+          cause = error.cause
+
+          if cause.is_a?(Warning)
+            handle_warning(cause, location)
+          else
+            handle_error(cause, location, error.cop)
           end
         end
       end
 
-      def handle_warning(e, location)
-        message = Rainbow("#{e.message} (from file: #{location})").yellow
+      def handle_warning(error, location)
+        message = Rainbow("#{error.message} (from file: #{location})").yellow
 
         @warnings << message
         warn message
-        puts e.backtrace if debug?
+        puts error.backtrace if debug?
       end
 
-      def handle_error(e, location, cop)
+      def handle_error(error, location, cop)
         message = Rainbow("An error occurred while #{cop.name}" \
                            " cop was inspecting #{location}.").red
         @errors << message
         warn message
         if debug?
-          puts e.message, e.backtrace
+          puts error.message, error.backtrace
         else
           warn 'To see the complete backtrace run rubocop -d.'
         end