rubocop 1.10.0 → 1.14.0

data/lib/rubocop/config_obsoletion/cop_rule.rb

@@ -17,8 +17,7 @@ module RuboCop
       end
 
       def message
-        rule_message + "\n(obsolete configuration found in " \
-                       "#{smart_loaded_path}, please update it)"
+        rule_message + "\n(obsolete configuration found in #{smart_loaded_path}, please update it)"
       end
 
       # Cop rules currently can only be failures, not warnings

data/lib/rubocop/config_store.rb

@@ -27,8 +27,7 @@ module RuboCop
 
     def options_config=(options_config)
       loaded_config = ConfigLoader.load_file(options_config)
-      @options_config = ConfigLoader.merge_with_default(loaded_config,
-                                                        options_config)
+      @options_config = ConfigLoader.merge_with_default(loaded_config, options_config)
     end
 
     def force_default_config!

data/lib/rubocop/config_validator.rb

@@ -9,8 +9,7 @@ module RuboCop
     extend Forwardable
 
     # @api private
-    COMMON_PARAMS = %w[Exclude Include Severity inherit_mode
-                       AutoCorrect StyleGuide Details].freeze
+    COMMON_PARAMS = %w[Exclude Include Severity inherit_mode AutoCorrect StyleGuide Details].freeze
     # @api private
     INTERNAL_PARAMS = %w[Description StyleGuide
                          VersionAdded VersionChanged VersionRemoved
@@ -60,8 +59,7 @@ module RuboCop
     def validate_section_presence(name)
       return unless @config.key?(name) && @config[name].nil?
 
-      raise ValidationError,
-            "empty section #{name} found in #{smart_loaded_path}"
+      raise ValidationError, "empty section #{name} found in #{smart_loaded_path}"
     end
 
     private
@@ -123,8 +121,7 @@ module RuboCop
       syntax_config = @config['Lint/Syntax']
       default_config = ConfigLoader.default_configuration['Lint/Syntax']
 
-      return unless syntax_config &&
-                    default_config.merge(syntax_config) != default_config
+      return unless syntax_config && default_config.merge(syntax_config) != default_config
 
       raise ValidationError,
             "configuration for Syntax cop found in #{smart_loaded_path}\n" \
@@ -133,8 +130,7 @@ module RuboCop
 
     def validate_new_cops_parameter
       new_cop_parameter = @config.for_all_cops['NewCops']
-      return if new_cop_parameter.nil? ||
-                NEW_COPS_VALUES.include?(new_cop_parameter)
+      return if new_cop_parameter.nil? || NEW_COPS_VALUES.include?(new_cop_parameter)
 
       message = "invalid #{new_cop_parameter} for `NewCops` found in" \
                 "#{smart_loaded_path}\n" \
@@ -208,8 +204,7 @@ module RuboCop
     def reject_conflicting_safe_settings
       @config.each do |name, cop_config|
         next unless cop_config.is_a?(Hash)
-        next unless cop_config['Safe'] == false &&
-                    cop_config['SafeAutoCorrect'] == true
+        next unless cop_config['Safe'] == false && cop_config['SafeAutoCorrect'] == true
 
         msg = 'Unsafe cops cannot have a safe auto-correction ' \
               "(section #{name} in #{smart_loaded_path})"

data/lib/rubocop/cop/autocorrect_logic.rb

@@ -21,8 +21,7 @@ module RuboCop
       end
 
       def safe_autocorrect?
-        cop_config.fetch('Safe', true) &&
-          cop_config.fetch('SafeAutoCorrect', true)
+        cop_config.fetch('Safe', true) && cop_config.fetch('SafeAutoCorrect', true)
       end
 
       def autocorrect_enabled?
@@ -68,9 +67,7 @@ module RuboCop
         begin_of_first_line = range.begin_pos - range.column
         end_of_first_line = begin_of_first_line + range.source_line.length
 
-        Parser::Source::Range.new(range.source_buffer,
-                                  begin_of_first_line,
-                                  end_of_first_line)
+        Parser::Source::Range.new(range.source_buffer, begin_of_first_line, end_of_first_line)
       end
 
       # Expand the given range to include all of any lines it covers. Does not
@@ -82,9 +79,7 @@ module RuboCop
         last_line_offset = last_line.length - range.last_column
         end_of_last_line = range.end_pos + last_line_offset
 
-        Parser::Source::Range.new(range.source_buffer,
-                                  begin_of_first_line,
-                                  end_of_last_line)
+        Parser::Source::Range.new(range.source_buffer, begin_of_first_line, end_of_last_line)
       end
 
       def max_line_length

data/lib/rubocop/cop/badge.rb

@@ -38,8 +38,7 @@ module RuboCop
       end
 
       def match?(other)
-        cop_name == other.cop_name &&
-          (!qualified? || department == other.department)
+        cop_name == other.cop_name && (!qualified? || department == other.department)
       end
 
       def to_s

data/lib/rubocop/cop/base.rb

@@ -187,8 +187,7 @@ module RuboCop
       def self.match?(given_names)
         return false unless given_names
 
-        given_names.include?(cop_name) ||
-          given_names.include?(department.to_s)
+        given_names.include?(cop_name) || given_names.include?(department.to_s)
       end
 
       def cop_name
@@ -206,13 +205,11 @@ module RuboCop
       end
 
       def config_to_allow_offenses
-        Formatter::DisabledConfigFormatter
-          .config_to_allow_offenses[cop_name] ||= {}
+        Formatter::DisabledConfigFormatter.config_to_allow_offenses[cop_name] ||= {}
       end
 
       def config_to_allow_offenses=(hash)
-        Formatter::DisabledConfigFormatter.config_to_allow_offenses[cop_name] =
-          hash
+        Formatter::DisabledConfigFormatter.config_to_allow_offenses[cop_name] = hash
       end
 
       def target_ruby_version
@@ -233,6 +230,11 @@ module RuboCop
         !relevant_file?(file)
       end
 
+      # There should be very limited reasons for a Cop to do it's own parsing
+      def parse(source, path = nil)
+        ProcessedSource.new(source, target_ruby_version, path)
+      end
+
       ### Persistence
 
       # Override if your cop should be called repeatedly for multiple investigations

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

@@ -30,7 +30,7 @@ module RuboCop
       #   if Dir.exist?(local)
       #     gem 'rubocop', path: local
       #   elsif ENV['RUBOCOP_VERSION'] == 'master'
-      #     gem 'rubocop', git: 'https://github.com/rubocop-hq/rubocop.git'
+      #     gem 'rubocop', git: 'https://github.com/rubocop/rubocop.git'
       #   else
       #     gem 'rubocop', '~> 0.90.0'
       #   end
@@ -57,6 +57,7 @@ module RuboCop
 
         private
 
+        # @!method gem_declarations(node)
         def_node_search :gem_declarations, '(send nil? :gem str ...)'
 
         def duplicated_gem_nodes
@@ -82,8 +83,7 @@ module RuboCop
 
         def register_offense(node, gem_name, line_of_first_occurrence)
           line_range = node.loc.column...node.loc.last_column
-          offense_location =
-            source_range(processed_source.buffer, node.first_line, line_range)
+          offense_location = source_range(processed_source.buffer, node.first_line, line_range)
           message = format(
             MSG,
             gem_name: gem_name,

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

@@ -3,15 +3,24 @@
 module RuboCop
   module Cop
     module Bundler
-      # Add a comment describing each gem in your Gemfile.
+      # Each gem in the Gemfile should have a comment explaining
+      # its purpose in the project, or the reason for its version
+      # or source.
       #
-      # Optionally, the "OnlyFor" configuration
+      # The optional "OnlyFor" configuration array
       # can be used to only register offenses when the gems
       # use certain options or have version specifiers.
-      # Add "version_specifiers" and/or the gem option names
-      # you want to check.
       #
-      # A useful use-case is to enforce a comment when using
+      # When "version_specifiers" is included, a comment
+      # will be enforced if the gem has any version specifier.
+      #
+      # When "restrictive_version_specifiers" is included, a comment
+      # will be enforced if the gem has a version specifier that
+      # holds back the version of the gem.
+      #
+      # For any other value in the array, a comment will be enforced for
+      # a gem if an option by the same name is present.
+      # A useful use case is to enforce a comment when using
       # options that change the source of a gem:
       #
       # - `bitbucket`
@@ -21,7 +30,8 @@ module RuboCop
       # - `source`
       #
       # For a full list of options supported by bundler,
-      # you can check the https://bundler.io/man/gemfile.5.html[official documentation].
+      # see https://bundler.io/man/gemfile.5.html
+      # .
       #
       # @example OnlyFor: [] (default)
       #   # bad
@@ -43,6 +53,18 @@ module RuboCop
       #   # Version 2.1 introduces breaking change baz
       #   gem 'foo', '< 2.1'
       #
+      # @example OnlyFor: ['restrictive_version_specifiers']
+      #   # bad
+      #
+      #   gem 'foo', '< 2.1'
+      #
+      #   # good
+      #
+      #   gem 'foo', '>= 1.0'
+      #
+      #   # Version 2.1 introduces breaking change baz
+      #   gem 'foo', '< 2.1'
+      #
       # @example OnlyFor: ['version_specifiers', 'github']
       #   # bad
       #
@@ -60,14 +82,15 @@ module RuboCop
       #
       class GemComment < Base
         include DefNode
+        include GemDeclaration
 
         MSG = 'Missing gem description comment.'
         CHECKED_OPTIONS_CONFIG = 'OnlyFor'
         VERSION_SPECIFIERS_OPTION = 'version_specifiers'
+        RESTRICTIVE_VERSION_SPECIFIERS_OPTION = 'restrictive_version_specifiers'
+        RESTRICTIVE_VERSION_PATTERN = /<|~>/.freeze
         RESTRICT_ON_SEND = %i[gem].freeze
 
-        def_node_matcher :gem_declaration?, '(send nil? :gem str ...)'
-
         def on_send(node)
           return unless gem_declaration?(node)
           return if ignored_gem?(node)
@@ -101,8 +124,7 @@ module RuboCop
         end
 
         def preceding_comment?(node1, node2)
-          node1 && node2 && precede?(node2, node1) &&
-            comment_line?(node2.loc.expression.source)
+          node1 && node2 && precede?(node2, node1) && comment_line?(node2.loc.expression.source)
         end
 
         def ignored_gem?(node)
@@ -113,6 +135,8 @@ module RuboCop
         def checked_options_present?(node)
           (cop_config[CHECKED_OPTIONS_CONFIG].include?(VERSION_SPECIFIERS_OPTION) &&
             version_specified_gem?(node)) ||
+            (cop_config[CHECKED_OPTIONS_CONFIG].include?(RESTRICTIVE_VERSION_SPECIFIERS_OPTION) &&
+              restrictive_version_specified_gem?(node)) ||
             contains_checked_options?(node)
         end
 
@@ -123,6 +147,15 @@ module RuboCop
           node.arguments[1]&.str_type?
         end
 
+        # Version specifications that restrict all updates going forward. This excludes versions
+        # like ">= 1.0" or "!= 2.0.3".
+        def restrictive_version_specified_gem?(node)
+          return unless version_specified_gem?(node)
+
+          node.arguments
+              .any? { |arg| arg&.str_type? && RESTRICTIVE_VERSION_PATTERN.match?(arg.to_s) }
+        end
+
         def contains_checked_options?(node)
           (Array(cop_config[CHECKED_OPTIONS_CONFIG]) & gem_options(node).map(&:to_s)).any?
         end

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Bundler
+      # Enforce that Gem version specifications are either required
+      # or forbidden.
+      #
+      # @example EnforcedStyle: required (default)
+      #  # bad
+      #  gem 'rubocop'
+      #
+      #  # good
+      #  gem 'rubocop', '~> 1.12'
+      #
+      #  # good
+      #  gem 'rubocop', '>= 1.10.0'
+      #
+      #  # good
+      #  gem 'rubocop', '>= 1.5.0', '< 1.10.0'
+      #
+      # @example EnforcedStyle: forbidden
+      #  # good
+      #  gem 'rubocop'
+      #
+      #  # bad
+      #  gem 'rubocop', '~> 1.12'
+      #
+      #  # bad
+      #  gem 'rubocop', '>= 1.10.0'
+      #
+      #  # bad
+      #  gem 'rubocop', '>= 1.5.0', '< 1.10.0'
+      #
+      class GemVersion < Base
+        include ConfigurableEnforcedStyle
+        include GemDeclaration
+
+        REQUIRED_MSG = 'Gem version specification is required.'
+        FORBIDDEN_MSG = 'Gem version specification is forbidden.'
+        VERSION_SPECIFICATION_REGEX = /^\s*[~<>=]*\s*[0-9.]+/.freeze
+
+        # @!method includes_version_specification?(node)
+        def_node_matcher :includes_version_specification?, <<~PATTERN
+          (send nil? :gem <(str #version_specification?) ...>)
+        PATTERN
+
+        def on_send(node)
+          return unless gem_declaration?(node)
+          return if allowed_gem?(node)
+
+          if offense?(node)
+            add_offense(node)
+            opposite_style_detected
+          else
+            correct_style_detected
+          end
+        end
+
+        private
+
+        def allowed_gem?(node)
+          allowed_gems.include?(node.first_argument.value)
+        end
+
+        def allowed_gems
+          Array(cop_config['AllowedGems'])
+        end
+
+        def message(range)
+          gem_specification = range.source
+
+          if required_style?
+            format(REQUIRED_MSG, gem_specification: gem_specification)
+          elsif forbidden_style?
+            format(FORBIDDEN_MSG, gem_specification: gem_specification)
+          end
+        end
+
+        def offense?(node)
+          (required_style? && !includes_version_specification?(node)) ||
+            (forbidden_style? && includes_version_specification?(node))
+        end
+
+        def forbidden_style?
+          style == :forbidden
+        end
+
+        def required_style?
+          style == :required
+        end
+
+        def version_specification?(expression)
+          expression.match?(VERSION_SPECIFICATION_REGEX)
+        end
+      end
+    end
+  end
+end

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

@@ -36,6 +36,7 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[source].freeze
 
+        # @!method insecure_protocol_source?(node)
         def_node_matcher :insecure_protocol_source?, <<~PATTERN
           (send nil? :source
             $(sym ${:gemcutter :rubygems :rubyforge}))

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

@@ -38,10 +38,7 @@ module RuboCop
           gem_declarations(processed_source.ast)
             .each_cons(2) do |previous, current|
             next unless consecutive_lines(previous, current)
-            next unless case_insensitive_out_of_order?(
-              gem_name(current),
-              gem_name(previous)
-            )
+            next unless case_insensitive_out_of_order?(gem_name(current), gem_name(previous))
 
             register_offense(previous, current)
           end
@@ -64,6 +61,7 @@ module RuboCop
           declarations.to_a[node_index - 1]
         end
 
+        # @!method gem_declarations(node)
         def_node_search :gem_declarations, <<~PATTERN
           (:send nil? :gem str ...)
         PATTERN

data/lib/rubocop/cop/commissioner.rb

@@ -143,20 +143,14 @@ module RuboCop
         map = {}
         callbacks&.select! do |cop|
           restrictions = cop.class.send :restrict_on_send
-          restrictions.each do |name|
-            (map[name] ||= []) << cop
-          end
+          restrictions.each { |name| (map[name] ||= []) << cop }
           restrictions.empty?
         end
         map
       end
 
       def invoke(callback, cops, *args)
-        cops.each do |cop|
-          with_cop_error_handling(cop) do
-            cop.send(callback, *args)
-          end
-        end
+        cops.each { |cop| with_cop_error_handling(cop) { cop.send(callback, *args) } }
       end
 
       # Allow blind rescues here, since we're absorbing and packaging or

data/lib/rubocop/cop/cop.rb

@@ -18,9 +18,7 @@ module RuboCop
         def call(corrector)
           lambda.call(corrector)
         rescue StandardError => e
-          raise ErrorWithAnalyzedFileLocation.new(
-            cause: e, node: node, cop: cop
-          )
+          raise ErrorWithAnalyzedFileLocation.new(cause: e, node: node, cop: cop)
         end
       end
 
@@ -55,9 +53,7 @@ module RuboCop
         return unless method_defined?(:join_force?)
 
         cop = new
-        Force.all.select do |force_class|
-          cop.join_force?(force_class)
-        end
+        Force.all.select { |force_class| cop.join_force?(force_class) }
       end
 
       # @deprecated
@@ -97,12 +93,6 @@ module RuboCop
         Registry.qualified_cop_name(name, origin)
       end
 
-      # @deprecated
-      # Open issue if there's a valid use case to include this in Base
-      def parse(source, path = nil)
-        ProcessedSource.new(source, target_ruby_version, path)
-      end
-
       private
 
       def begin_investigation(processed_source)
@@ -130,17 +120,13 @@ module RuboCop
 
         return unless lambda
 
-        suppress_clobbering do
-          lambda.call(corrector)
-        end
+        suppress_clobbering { lambda.call(corrector) }
       end
 
       def correction_lambda
         return unless support_autocorrect?
 
-        dedup_on_node(@v0_argument) do
-          autocorrect(@v0_argument)
-        end
+        dedup_on_node(@v0_argument) { autocorrect(@v0_argument) }
       end
 
       def dedup_on_node(node)