rubocop 0.58.2 → 0.59.0

data/lib/rubocop/ast/node/mixin/method_identifier_predicates.rb

@@ -84,6 +84,27 @@ module RuboCop
       def const_receiver?
         receiver && receiver.const_type?
       end
+
+      # Checks whether this is a negation method, i.e. `!` or keyword `not`.
+      #
+      # @return [Boolean] whether this method is a negation method
+      def negation_method?
+        receiver && method_name == :!
+      end
+
+      # Checks whether this is a prefix not method, e.g. `not foo`.
+      #
+      # @return [Boolean] whether this method is a prefix not
+      def prefix_not?
+        negation_method? && loc.selector.is?('not')
+      end
+
+      # Checks whether this is a prefix bang method, e.g. `!foo`.
+      #
+      # @return [Boolean] whether this method is a prefix bang
+      def prefix_bang?
+        negation_method? && loc.selector.is?('!')
+      end
     end
   end
 end

data/lib/rubocop/ast/node/send_node.rb

@@ -8,29 +8,20 @@ module RuboCop
     class SendNode < Node
       include ParameterizedNode
       include MethodDispatchNode
-      ARROW = '->'.freeze
-
-      # Checks whether this is a negation method, i.e. `!` or keyword `not`.
-      #
-      # @return [Boolean] whether this method is a negation method
-      def negation_method?
-        keyword_bang? || keyword_not?
-      end
 
       # Checks whether this is a lambda. Some versions of parser parses
       # non-literal lambdas as a method send.
       #
       # @return [Boolean] whether this method is a lambda
       def lambda?
-        parent && parent.block_type? && method?(:lambda)
+        block_literal? && method?(:lambda)
       end
 
       # Checks whether this is a stabby lambda. e.g. `-> () {}`
       #
-      # @return [Boolean] whether this method is a staby lambda
+      # @return [Boolean] whether this method is a stabby lambda
       def stabby_lambda?
-        selector = loc.selector
-        selector && selector.source == ARROW
+        loc.selector && loc.selector.source == '->'
       end
     end
   end

data/lib/rubocop/ast/traversal.rb

@@ -9,6 +9,7 @@ module RuboCop
     module Traversal
       def walk(node)
         return if node.nil?
+
         send(:"on_#{node.type}", node)
         nil
       end
@@ -65,6 +66,7 @@ module RuboCop
 
       def on_const(node)
         return unless (child = node.children[0])
+
         send(:"on_#{child.type}", child)
       end
 
@@ -74,6 +76,7 @@ module RuboCop
           send(:"on_#{child.type}", child)
         end
         return unless (child = children[2])
+
         send(:"on_#{child.type}", child)
       end
 
@@ -85,6 +88,7 @@ module RuboCop
           send(:"on_#{child.type}", child)
         end
         return unless (child = children[2])
+
         send(:"on_#{child.type}", child)
       end
 
@@ -92,12 +96,14 @@ module RuboCop
         children = node.children
         on_args(children[1])
         return unless (child = children[2])
+
         send(:"on_#{child.type}", child)
       end
 
       def on_send(node)
         node.children.each_with_index do |child, i|
           next if i == 1
+
           send(:"on_#{child.type}", child) if child
         end
         nil
@@ -119,6 +125,7 @@ module RuboCop
         send(:"on_#{child.type}", child)
         on_args(children[2])
         return unless (child = children[3])
+
         send(:"on_#{child.type}", child)
       end
 
@@ -130,6 +137,7 @@ module RuboCop
           send(:"on_#{child.type}", child)
         end
         return unless (child = children[2])
+
         send(:"on_#{child.type}", child)
       end
 
@@ -138,6 +146,7 @@ module RuboCop
         child = children[0]
         send(:"on_#{child.type}", child)
         return unless (child = children[1])
+
         send(:"on_#{child.type}", child)
       end
 
@@ -151,6 +160,7 @@ module RuboCop
         send(:"on_#{child.type}", child) # can be send, zsuper...
         on_args(children[1])
         return unless (child = children[2])
+
         send(:"on_#{child.type}", child)
       end
 

data/lib/rubocop/cli.rb

@@ -159,7 +159,9 @@ module RuboCop
       display_error_summary(runner.errors)
       maybe_print_corrected_source
 
-      if all_passed && !runner.aborting? && runner.errors.empty?
+      all_pass_or_excluded = all_passed || @options[:auto_gen_config]
+
+      if all_pass_or_excluded && !runner.aborting? && runner.errors.empty?
         STATUS_SUCCESS
       else
         STATUS_OFFENSES
@@ -277,6 +279,7 @@ module RuboCop
       # So a delimiter is needed for tools to easily identify where the
       # autocorrected source begins
       return unless @options[:stdin] && @options[:auto_correct]
+
       puts '=' * 20
       print @options[:stdin]
     end

data/lib/rubocop/config.rb

@@ -373,8 +373,20 @@ module RuboCop
       absolute_file_path = File.expand_path(file)
 
       patterns_to_include.any? do |pattern|
-        match_path?(pattern, relative_file_path) ||
-          match_path?(pattern, absolute_file_path)
+        if block_given?
+          yield pattern, relative_file_path, absolute_file_path
+        else
+          match_path?(pattern, relative_file_path) ||
+            match_path?(pattern, absolute_file_path)
+        end
+      end
+    end
+
+    def allowed_camel_case_file?(file)
+      file_to_include?(file) do |pattern, relative_path, absolute_path|
+        pattern.to_s =~ /[A-Z]/ &&
+          (match_path?(pattern, relative_path) ||
+           match_path?(pattern, absolute_path))
       end
     end
 
@@ -396,11 +408,11 @@ module RuboCop
     end
 
     def patterns_to_include
-      for_all_cops['Include']
+      for_all_cops['Include'] || []
     end
 
     def patterns_to_exclude
-      for_all_cops['Exclude']
+      for_all_cops['Exclude'] || []
     end
 
     def path_relative_to_config(path)
@@ -483,6 +495,7 @@ module RuboCop
 
     def validate_section_presence(name)
       return unless key?(name) && self[name].nil?
+
       raise ValidationError,
             "empty section #{name} found in #{smart_loaded_path}"
     end
@@ -546,6 +559,7 @@ module RuboCop
     def obsolete_cops
       OBSOLETE_COPS.map do |cop_name, message|
         next unless key?(cop_name) || key?(Cop::Badge.parse(cop_name).cop_name)
+
         message + "\n(obsolete configuration found in #{smart_loaded_path}," \
                    ' please update it)'
       end
@@ -615,7 +629,8 @@ module RuboCop
         # "RUBY VERSION" line.
         in_ruby_section ||= line.match(/^\s*RUBY\s*VERSION\s*$/)
         next unless in_ruby_section
-        # We currently only allow this feature to work with MRI ruby.  If jruby
+
+        # We currently only allow this feature to work with MRI ruby. If jruby
         # (or something else) is used by the project, it's lock file will have a
         # line that looks like:
         #     RUBY VERSION
@@ -645,6 +660,7 @@ module RuboCop
 
     def bundler_lock_file_path
       return nil unless loaded_path
+
       base_path = base_dir_for_path_parameters
       ['gems.locked', 'Gemfile.lock'].each do |file_name|
         path = find_file_upwards(file_name, base_path)

data/lib/rubocop/config_loader.rb

@@ -95,6 +95,7 @@ module RuboCop
         return if found_files.empty?
         return if PathUtil.relative_path(found_files.last) ==
                   PathUtil.relative_path(config_file)
+
         print 'AllCops/Exclude ' if debug?
         config.add_excludes_from_higher_level(load_file(found_files.last))
       end
@@ -129,6 +130,7 @@ module RuboCop
         if File.exist?(DOTFILE)
           files = Array(load_yaml_configuration(DOTFILE)['inherit_from'])
           return if files.include?(AUTO_GENERATED_FILE)
+
           files.unshift(AUTO_GENERATED_FILE)
           file_string = "\n  - " + files.join("\n  - ") if files.size > 1
           rubocop_yml_contents = IO.read(DOTFILE, encoding: Encoding::UTF_8)

data/lib/rubocop/config_loader_resolver.rb

@@ -23,6 +23,7 @@ module RuboCop
         .reverse.each_with_index do |base_config, index|
         base_config.each do |k, v|
           next unless v.is_a?(Hash)
+
           if hash.key?(k)
             v = merge(v, hash[k],
                       cop_name: k, file: file, debug: debug,
@@ -51,7 +52,7 @@ module RuboCop
 
     # Merges the given configuration with the default one. If
     # AllCops:DisabledByDefault is true, it changes the Enabled params so that
-    # only cops from user configuration are enabled.  If
+    # only cops from user configuration are enabled. If
     # AllCops::EnabledByDefault is true, it changes the Enabled params so that
     # only cops explicitly disabled in user configuration are disabled.
     def merge_with_default(config, config_file)
@@ -102,6 +103,7 @@ module RuboCop
       return false if inherited_file.start_with?('..') # Legitimate override
       return false if base_hash[key] == derived_hash[key] # Same value
       return false if remote_file?(inherited_file) # Can't change
+
       Gem.path.none? { |dir| inherited_file.start_with?(dir) } # Can change?
     end
 

data/lib/rubocop/cop/autocorrect_logic.rb

@@ -19,6 +19,7 @@ module RuboCop
       def autocorrect_enabled?
         # allow turning off autocorrect on a cop by cop basis
         return true unless cop_config
+
         cop_config['AutoCorrect'] != false
       end
     end

data/lib/rubocop/cop/bundler/gem_comment.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Bundler
+      # Add a comment describing each gem in your Gemfile.
+      #
+      # @example
+      #   # bad
+      #
+      #   gem 'foo'
+      #
+      #   # good
+      #
+      #   # Helpers for the foo things.
+      #   gem 'foo'
+      #
+      class GemComment < Cop
+        include DefNode
+
+        MSG = 'Missing gem description comment.'.freeze
+
+        def_node_matcher :gem_declaration?, '(send nil? :gem str ...)'
+
+        def on_send(node)
+          return unless gem_declaration?(node)
+          return if whitelisted_gem?(node)
+          return if commented?(node)
+
+          add_offense(node)
+        end
+
+        private
+
+        def commented?(node)
+          preceding_lines = preceding_lines(node)
+          preceding_comment?(node, preceding_lines.last)
+        end
+
+        # The args node1 & node2 may represent a RuboCop::AST::Node
+        # or a Parser::Source::Comment. Both respond to #loc.
+        def precede?(node1, node2)
+          node2.loc.line - node1.loc.line == 1
+        end
+
+        def preceding_lines(node)
+          processed_source.ast_with_comments[node].select do |line|
+            line.loc.line < node.loc.line
+          end
+        end
+
+        def preceding_comment?(node1, node2)
+          node1 && node2 && precede?(node2, node1) &&
+            comment_line?(node2.loc.expression.source)
+        end
+
+        def whitelisted_gem?(node)
+          whitelist = Array(cop_config['Whitelist'])
+          whitelist.include?(node.first_argument.value)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/bundler/ordered_gems.rb

@@ -34,6 +34,7 @@ module RuboCop
 
         def investigate(processed_source)
           return if processed_source.blank?
+
           gem_declarations(processed_source.ast)
             .each_cons(2) do |previous, current|
             next unless consecutive_lines(previous, current)
@@ -41,6 +42,7 @@ module RuboCop
               gem_name(current),
               gem_name(previous)
             )
+
             register_offense(previous, current)
           end
         end

data/lib/rubocop/cop/commissioner.rb

@@ -29,6 +29,7 @@ module RuboCop
       Parser::Meta::NODE_TYPES.each do |node_type|
         method_name = :"on_#{node_type}"
         next unless method_defined?(method_name)
+
         define_method(method_name) do |node|
           trigger_responding_cops(method_name, node)
           super(node) unless NO_CHILD_NODES.include?(node_type)
@@ -105,6 +106,7 @@ module RuboCop
         yield
       rescue StandardError => e
         raise e if @options[:raise_error]
+
         if node
           line = node.first_line
           column = node.loc.column

data/lib/rubocop/cop/cop.rb

@@ -152,6 +152,7 @@ module RuboCop
         @corrected_nodes[node] = true
         correction = autocorrect(node)
         return :uncorrected unless correction
+
         @corrections << correction
         :corrected
       end
@@ -204,6 +205,7 @@ module RuboCop
       def file_name_matches_any?(file, parameter, default_result)
         patterns = cop_config[parameter]
         return default_result unless patterns
+
         path = nil
         patterns.any? do |pattern|
           # Try to match the absolute path, as Exclude properties are absolute.
@@ -217,6 +219,7 @@ module RuboCop
 
       def enabled_line?(line_number)
         return true unless @processed_source
+
         @processed_source.comment_config.cop_enabled_at_line?(self, line_number)
       end
 

data/lib/rubocop/cop/corrector.rb

@@ -34,6 +34,7 @@ module RuboCop
         @source_buffer = source_buffer
         raise 'source_buffer should be a Parser::Source::Buffer' unless \
           source_buffer.is_a? Parser::Source::Buffer
+
         @corrections = corrections
         @source_rewriter = Parser::Source::TreeRewriter.new(
           source_buffer,
@@ -155,6 +156,7 @@ module RuboCop
       # :nodoc:
       def validate_range(range)
         return if range.source_buffer == @source_buffer
+
         unless range.source_buffer.is_a?(Parser::Source::Buffer)
           # actually this should be enforced by parser gem
           raise 'Corrector expected range source buffer to be a '\

data/lib/rubocop/cop/correctors/alignment_corrector.rb

@@ -14,6 +14,7 @@ module RuboCop
 
         def correct(processed_source, node, column_delta)
           return unless node
+
           @processed_source = processed_source
           expr = node.respond_to?(:loc) ? node.loc.expression : node
           return if block_comment_within?(expr)

data/lib/rubocop/cop/correctors/line_break_corrector.rb

@@ -36,6 +36,7 @@ module RuboCop
 
         def move_comment(eol_comment:, node:, corrector:)
           return unless eol_comment
+
           text = eol_comment.loc.expression.source
           corrector.insert_before(node.source_range,
                                   text + "\n" + (' ' * node.loc.keyword.column))
@@ -46,6 +47,7 @@ module RuboCop
 
         def remove_semicolon(node, corrector)
           return unless semicolon(node)
+
           corrector.remove(semicolon(node).pos)
         end
 

data/lib/rubocop/cop/correctors/space_corrector.rb

@@ -29,6 +29,7 @@ module RuboCop
             corrector.remove(range)
           end
           return unless right_token.space_before?
+
           range = side_space_range(range: right_token.pos, side: :left)
           corrector.remove(range)
         end
@@ -39,6 +40,7 @@ module RuboCop
             corrector.insert_after(left_token.pos, ' ')
           end
           return if right_token.space_before?
+
           corrector.insert_before(right_token.pos, ' ')
         end
       end