rubocop 1.13.0 → 1.17.0

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Newcomers to ruby applications may write top-level methods,
+      # when ideally they should be organized in appropriate classes or modules.
+      # This cop looks for definitions of top-level methods and warns about them.
+      #
+      # However for ruby scripts it is perfectly fine to use top-level methods.
+      # Hence this cop is disabled by default.
+      #
+      # @example
+      #   # bad
+      #   def some_method
+      #   end
+      #
+      #   # bad
+      #   def self.some_method
+      #   end
+      #
+      #   # bad
+      #   define_method(:foo) { puts 1 }
+      #
+      #   # good
+      #   module Foo
+      #     def some_method
+      #     end
+      #   end
+      #
+      #   # good
+      #   class Foo
+      #     def self.some_method
+      #     end
+      #   end
+      #
+      #   # good
+      #   Struct.new do
+      #     def some_method
+      #     end
+      #   end
+      #
+      #   # good
+      #   class Foo
+      #     define_method(:foo) { puts 1 }
+      #   end
+      class TopLevelMethodDefinition < Base
+        MSG = 'Do not define methods at the top-level.'
+
+        RESTRICT_ON_SEND = %i[define_method].freeze
+
+        def on_def(node)
+          return unless top_level_method_definition?(node)
+
+          add_offense(node)
+        end
+        alias on_defs on_def
+        alias on_send on_def
+
+        def on_block(node)
+          return unless define_method_block?(node) && top_level_method_definition?(node)
+
+          add_offense(node)
+        end
+
+        private
+
+        def top_level_method_definition?(node)
+          if node.parent&.begin_type?
+            node.parent.root?
+          else
+            node.root?
+          end
+        end
+
+        # @!method define_method_block?(node)
+        def_node_matcher :define_method_block?, <<~PATTERN
+          (block (send _ {:define_method} _) ...)
+        PATTERN
+      end
+    end
+  end
+end

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

@@ -27,6 +27,71 @@ module RuboCop
       #   class << self
       #     attr_reader :baz
       #   end
+      #
+      # @example ExactNameMatch: true (default)
+      #   # good
+      #   def name
+      #     @other_name
+      #   end
+      #
+      # @example ExactNameMatch: false
+      #   # bad
+      #   def name
+      #     @other_name
+      #   end
+      #
+      # @example AllowPredicates: true (default)
+      #   # good
+      #   def foo?
+      #     @foo
+      #   end
+      #
+      # @example AllowPredicates: false
+      #   # bad
+      #   def foo?
+      #     @foo
+      #   end
+      #
+      #   # good
+      #   attr_reader :foo
+      #
+      # @example AllowDSLWriters: true (default)
+      #   # good
+      #   def on_exception(action)
+      #     @on_exception=action
+      #   end
+      #
+      # @example AllowDSLWriters: false
+      #   # bad
+      #   def on_exception(action)
+      #     @on_exception=action
+      #   end
+      #
+      #   # good
+      #   attr_writer :on_exception
+      #
+      # @example IgnoreClassMethods: false (default)
+      #   # bad
+      #   def self.foo
+      #     @foo
+      #   end
+      #
+      #   # good
+      #   class << self
+      #     attr_reader :foo
+      #   end
+      #
+      # @example IgnoreClassMethods: true
+      #   # good
+      #   def self.foo
+      #     @foo
+      #   end
+      #
+      # @example AllowedMethods: ['allowed_method']
+      #   # good
+      #   def allowed_method
+      #     @foo
+      #   end
       class TrivialAccessors < Base
         include AllowedMethods
         extend AutoCorrector

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

@@ -20,12 +20,16 @@ module RuboCop
       class WhenThen < Base
         extend AutoCorrector
 
-        MSG = 'Do not use `when x;`. Use `when x then` instead.'
+        MSG = 'Do not use `when %<expression>s;`. Use `when %<expression>s then` instead.'
 
         def on_when(node)
           return if node.multiline? || node.then? || !node.body
 
-          add_offense(node.loc.begin) { |corrector| corrector.replace(node.loc.begin, ' then') }
+          message = format(MSG, expression: node.conditions.map(&:source).join(', '))
+
+          add_offense(node.loc.begin, message: message) do |corrector|
+            corrector.replace(node.loc.begin, ' then')
+          end
         end
       end
     end

data/lib/rubocop/cop/variable_force/branch.rb

@@ -226,6 +226,21 @@ module RuboCop
           end
         end
 
+        # case target
+        # in pattern # in_pattern
+        # else
+        #   else_body
+        # end
+        class CaseMatch < Base
+          define_predicate :target?,     child_index: 0
+          define_predicate :in_pattern?, child_index: 1..-2
+          define_predicate :else_body?,  child_index: -1
+
+          def always_run?
+            target?
+          end
+        end
+
         # for element in collection
         #   loop_body
         # end

data/lib/rubocop/directive_comment.rb

@@ -6,7 +6,9 @@ module RuboCop
   # cops it contains.
   class DirectiveComment
     # @api private
-    REDUNDANT_COP = 'Lint/RedundantCopDisableDirective'
+    REDUNDANT_DIRECTIVE_COP_DEPARTMENT = 'Lint'
+    # @api private
+    REDUNDANT_DIRECTIVE_COP = "#{REDUNDANT_DIRECTIVE_COP_DEPARTMENT}/RedundantCopDisableDirective"
     # @api private
     COP_NAME_PATTERN = '([A-Z]\w+/)*(?:[A-Z]\w+)'
     # @api private
@@ -23,10 +25,11 @@ module RuboCop
       line.split(DIRECTIVE_COMMENT_REGEXP).first
     end
 
-    attr_reader :comment, :mode, :cops
+    attr_reader :comment, :cop_registry, :mode, :cops
 
-    def initialize(comment)
+    def initialize(comment, cop_registry = Cop::Registry.global)
       @comment = comment
+      @cop_registry = cop_registry
       @mode, @cops = match_captures
     end
 
@@ -41,7 +44,11 @@ module RuboCop
     end
 
     def range
-      comment.location.expression
+      match = comment.text.match(DIRECTIVE_COMMENT_REGEXP)
+      begin_pos = comment.loc.expression.begin_pos
+      Parser::Source::Range.new(
+        comment.loc.expression.source_buffer, begin_pos + match.begin(0), begin_pos + match.end(0)
+      )
     end
 
     # Returns match captures to directive comment pattern
@@ -64,6 +71,11 @@ module RuboCop
       !disabled? && all_cops?
     end
 
+    # Checks if this directive disables all cops
+    def disabled_all?
+      disabled? && all_cops?
+    end
+
     # Checks if all cops specified in this directive
     def all_cops?
       cops == 'all'
@@ -74,6 +86,26 @@ module RuboCop
       @cop_names ||= all_cops? ? all_cop_names : parsed_cop_names
     end
 
+    # Returns array of specified in this directive department names
+    # when all department disabled
+    def department_names
+      splitted_cops_string.select { |cop| department?(cop) }
+    end
+
+    # Checks if directive departments include cop
+    def in_directive_department?(cop)
+      department_names.any? { |department| cop.start_with?(department) }
+    end
+
+    # Checks if cop department has already used in directive comment
+    def overridden_by_department?(cop)
+      in_directive_department?(cop) && splitted_cops_string.include?(cop)
+    end
+
+    def directive_count
+      splitted_cops_string.count
+    end
+
     # Returns line number for directive
     def line_number
       comment.loc.expression.line
@@ -81,12 +113,32 @@ module RuboCop
 
     private
 
-    def parsed_cop_names
+    def splitted_cops_string
       (cops || '').split(/,\s*/)
     end
 
+    def parsed_cop_names
+      splitted_cops_string.map do |name|
+        department?(name) ? cop_names_for_department(name) : name
+      end.flatten
+    end
+
+    def department?(name)
+      cop_registry.department?(name)
+    end
+
     def all_cop_names
-      Cop::Registry.global.names - [REDUNDANT_COP]
+      exclude_redundant_directive_cop(cop_registry.names)
+    end
+
+    def cop_names_for_department(department)
+      names = cop_registry.names_for_department(department)
+      has_redundant_directive_cop = department == REDUNDANT_DIRECTIVE_COP_DEPARTMENT
+      has_redundant_directive_cop ? exclude_redundant_directive_cop(names) : names
+    end
+
+    def exclude_redundant_directive_cop(cops)
+      cops - [REDUNDANT_DIRECTIVE_COP]
     end
   end
 end

data/lib/rubocop/formatter/junit_formatter.rb

@@ -22,9 +22,13 @@ module RuboCop
         testsuites = REXML::Element.new('testsuites', @document)
         testsuite = REXML::Element.new('testsuite', testsuites)
         @testsuite = testsuite.tap { |element| element.add_attributes('name' => 'rubocop') }
+
+        reset_count
       end
 
       def file_finished(file, offenses)
+        @inspected_file_count += 1
+
         # TODO: Returns all cops with the same behavior as
         # the original rubocop-junit-formatter.
         # https://github.com/mikian/rubocop-junit-formatter/blob/v0.1.4/lib/rubocop/formatter/junit_formatter.rb#L9
@@ -32,15 +36,11 @@ module RuboCop
         # In the future, it would be preferable to return only enabled cops.
         Cop::Registry.all.each do |cop|
           target_offenses = offenses_for_cop(offenses, cop)
+          @offense_count += target_offenses.count
 
           next unless relevant_for_output?(options, target_offenses)
 
-          REXML::Element.new('testcase', @testsuite).tap do |testcase|
-            testcase.attributes['classname'] = classname_attribute_value(file)
-            testcase.attributes['name'] = cop.cop_name
-
-            add_failure_to(testcase, target_offenses, cop.cop_name)
-          end
+          add_testcase_element_to_testsuite_element(file, target_offenses, cop)
         end
       end
 
@@ -52,16 +52,31 @@ module RuboCop
         all_offenses.select { |offense| offense.cop_name == cop.cop_name }
       end
 
+      def add_testcase_element_to_testsuite_element(file, target_offenses, cop)
+        REXML::Element.new('testcase', @testsuite).tap do |testcase|
+          testcase.attributes['classname'] = classname_attribute_value(file)
+          testcase.attributes['name'] = cop.cop_name
+
+          add_failure_to(testcase, target_offenses, cop.cop_name)
+        end
+      end
+
       def classname_attribute_value(file)
         file.gsub(/\.rb\Z/, '').gsub("#{Dir.pwd}/", '').tr('/', '.')
       end
 
       def finished(_inspected_files)
+        @testsuite.add_attributes('tests' => @inspected_file_count, 'failures' => @offense_count)
         @document.write(output, 2)
       end
 
       private
 
+      def reset_count
+        @inspected_file_count = 0
+        @offense_count = 0
+      end
+
       def add_failure_to(testcase, offenses, cop_name)
         # One failure per offense. Zero failures is a passing test case,
         # for most surefire/nUnit parsers.

data/lib/rubocop/options.rb

@@ -297,7 +297,7 @@ module RuboCop
       validate_auto_gen_config
       validate_auto_correct
       validate_display_only_failed
-      validate_parallel
+      disable_parallel_when_invalid_option_combo
 
       return if incompatible_options.size <= 1
 
@@ -334,33 +334,27 @@ module RuboCop
             format('--disable-uncorrectable can only be used together with --auto-correct.')
     end
 
-    def validate_parallel
+    def disable_parallel_when_invalid_option_combo
       return unless @options.key?(:parallel)
 
-      if @options[:cache] == 'false'
-        raise OptionArgumentError, '-P/--parallel uses caching to speed up ' \
-                                   'execution, so combining with --cache ' \
-                                   'false is not allowed.'
-      end
-
-      disable_parallel_when_invalid_combo
-    end
+      invalid_options = [
+        { name: :auto_gen_config, value: true, flag: '--auto-gen-config' },
+        { name: :fail_fast, value: true, flag: '-F/--fail-fast.' },
+        { name: :auto_correct, value: true, flag: '--auto-correct.' },
+        { name: :cache, value: 'false', flag: '--cache false' }
+      ]
 
-    def disable_parallel_when_invalid_combo
-      combos = {
-        auto_gen_config: '--auto-gen-config',
-        fail_fast: '-F/--fail-fast.',
-        auto_correct: '--auto-correct.'
-      }
-
-      invalid_combos = combos.select { |key, _flag| @options.key?(key) }
+      invalid_flags = invalid_options.each_with_object([]) do |option, flags|
+        # `>` rather than `>=` because `@options` will also contain `parallel: true`
+        flags << option[:flag] if @options > { option[:name] => option[:value] }
+      end
 
-      return if invalid_combos.empty?
+      return if invalid_flags.empty?
 
       @options.delete(:parallel)
 
       puts '-P/--parallel is being ignored because ' \
-           "it is not compatible with #{invalid_combos.values.join(', ')}"
+           "it is not compatible with #{invalid_flags.join(', ')}"
     end
 
     def only_includes_redundant_disable?

data/lib/rubocop/rake_task.rb

@@ -70,7 +70,7 @@ module RuboCop
             options = full_options.unshift('--auto-correct-all')
             # `parallel` will automatically be removed from the options internally.
             # This is a nice to have to suppress the warning message
-            # about parallel and auto-corrent not being compatible.
+            # about parallel and auto-correct not being compatible.
             options.delete('--parallel')
             run_cli(verbose, options)
           end

data/lib/rubocop/remote_config.rb

@@ -55,6 +55,7 @@ module RuboCop
     def generate_request(uri)
       request = Net::HTTP::Get.new(uri.request_uri)
 
+      request.basic_auth(uri.user, uri.password) if uri.user
       request['If-Modified-Since'] = File.stat(cache_path).mtime.rfc2822 if cache_path_exists?
 
       yield request
@@ -70,7 +71,7 @@ module RuboCop
         begin
           response.error!
         rescue StandardError => e
-          message = "#{e.message} while downloading remote config file #{uri}"
+          message = "#{e.message} while downloading remote config file #{cloned_url}"
           raise e, message
         end
       end
@@ -94,9 +95,16 @@ module RuboCop
     end
 
     def cache_name_from_uri
-      uri = @uri.clone
+      uri = cloned_url
       uri.query = nil
       uri.to_s.gsub!(/[^0-9A-Za-z]/, '-')
     end
+
+    def cloned_url
+      uri = @uri.clone
+      uri.user = nil if uri.user
+      uri.password = nil if uri.password
+      uri
+    end
   end
 end