rubocop 1.12.0 → 1.16.0

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/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

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)

data/lib/rubocop/cop/corrector.rb

@@ -36,10 +36,7 @@ module RuboCop
       # @param [Integer] size
       def remove_preceding(node_or_range, size)
         range = to_range(node_or_range)
-        to_remove = range.with(
-          begin_pos: range.begin_pos - size,
-          end_pos:   range.begin_pos
-        )
+        to_remove = range.with(begin_pos: range.begin_pos - size, end_pos: range.begin_pos)
         remove(to_remove)
       end
 

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

@@ -54,8 +54,7 @@ module RuboCop
         def inside_string_ranges(node)
           return [] unless node.is_a?(Parser::AST::Node)
 
-          node.each_node(:str, :dstr, :xstr).map { |n| inside_string_range(n) }
-              .compact
+          node.each_node(:str, :dstr, :xstr).map { |n| inside_string_range(n) }.compact
         end
 
         def inside_string_range(node)
@@ -76,8 +75,7 @@ module RuboCop
         def delimited_string_literal?(node)
           loc = node.location
 
-          loc.respond_to?(:begin) && loc.begin &&
-            loc.respond_to?(:end) && loc.end
+          loc.respond_to?(:begin) && loc.begin && loc.respond_to?(:end) && loc.end
         end
 
         def block_comment_within?(expr)
@@ -89,8 +87,7 @@ module RuboCop
         def calculate_range(expr, line_begin_pos, column_delta)
           return range_between(line_begin_pos, line_begin_pos) if column_delta.positive?
 
-          starts_with_space =
-            expr.source_buffer.source[line_begin_pos].start_with?(' ')
+          starts_with_space = expr.source_buffer.source[line_begin_pos].start_with?(' ')
 
           if starts_with_space
             range_between(line_begin_pos, line_begin_pos + column_delta.abs)

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

@@ -6,8 +6,7 @@ module RuboCop
     class EachToForCorrector
       extend NodePattern::Macros
 
-      CORRECTION_WITH_ARGUMENTS =
-        'for %<variables>s in %<collection>s do'
+      CORRECTION_WITH_ARGUMENTS = 'for %<variables>s in %<collection>s do'
       CORRECTION_WITHOUT_ARGUMENTS = 'for _ in %<enumerable>s do'
 
       def initialize(block_node)
@@ -30,8 +29,7 @@ module RuboCop
                  collection: collection_node.source,
                  variables: argument_node.children.first.source)
         else
-          format(CORRECTION_WITHOUT_ARGUMENTS,
-                 enumerable: collection_node.source)
+          format(CORRECTION_WITHOUT_ARGUMENTS, enumerable: collection_node.source)
         end
       end
 

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

@@ -23,8 +23,7 @@ module RuboCop
       attr_reader :for_node, :variable_node, :collection_node
 
       def correction
-        format(CORRECTION, collection: collection_source,
-                           argument: variable_node.source)
+        format(CORRECTION, collection: collection_source, argument: variable_node.source)
       end
 
       def collection_source

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

@@ -20,8 +20,7 @@ module RuboCop
 
           break_line_before(range: range, node: node, corrector: corrector,
                             configured_width: configured_width)
-          move_comment(eol_comment: eol_comment, node: node,
-                       corrector: corrector)
+          move_comment(eol_comment: eol_comment, node: node, corrector: corrector)
           remove_semicolon(node, corrector)
         end
 
@@ -29,8 +28,7 @@ module RuboCop
                               indent_steps: 1)
           corrector.insert_before(
             range,
-            "\n#{' ' * (node.loc.keyword.column +
-                          indent_steps * configured_width)}"
+            "\n#{' ' * (node.loc.keyword.column + indent_steps * configured_width)}"
           )
         end
 
@@ -38,8 +36,7 @@ module RuboCop
           return unless eol_comment
 
           text = eol_comment.loc.expression.source
-          corrector.insert_before(node,
-                                  "#{text}\n#{' ' * node.loc.keyword.column}")
+          corrector.insert_before(node, "#{text}\n#{' ' * node.loc.keyword.column}")
           corrector.remove(eol_comment)
         end
 

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

@@ -41,9 +41,7 @@ module RuboCop
       end
 
       def correct_next_line_brace(corrector)
-        corrector.remove(
-          range_with_surrounding_space(range: node.loc.end, side: :left)
-        )
+        corrector.remove(range_with_surrounding_space(range: node.loc.end, side: :left))
 
         corrector.insert_before(
           last_element_range_with_trailing_comma(node).end,

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

@@ -17,9 +17,7 @@ module RuboCop
           current_range = declaration_with_comment(node)
           previous_range = declaration_with_comment(previous_declaration)
 
-          lambda do |corrector|
-            swap_range(corrector, current_range, previous_range)
-          end
+          ->(corrector) do swap_range(corrector, current_range, previous_range) end
         end
 
         private

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

@@ -32,9 +32,7 @@ module RuboCop
       end
 
       def delimiters_for(type)
-        PreferredDelimiters
-          .new(type, config, preferred_delimiters)
-          .delimiters
+        PreferredDelimiters.new(type, config, preferred_delimiters).delimiters
       end
 
       def new_contents(node, escape, delimiters)
@@ -61,11 +59,7 @@ module RuboCop
         base_line_num = node.first_line
         prev_line_num = base_line_num
         node.children.map.with_index do |word_node, index|
-          line_breaks = line_breaks(word_node,
-                                    node.source,
-                                    prev_line_num,
-                                    base_line_num,
-                                    index)
+          line_breaks = line_breaks(word_node, node.source, prev_line_num, base_line_num, index)
           prev_line_num = word_node.last_line
           content = fix_escaped_content(word_node, escape, delimiters)
           line_breaks + content

data/lib/rubocop/cop/gemspec/duplicated_assignment.rb

@@ -91,8 +91,7 @@ module RuboCop
 
         def register_offense(node, assignment, 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,
             assignment: assignment,

data/lib/rubocop/cop/gemspec/ordered_dependencies.rb

@@ -64,10 +64,7 @@ module RuboCop
           dependency_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))
             next unless get_dependency_name(previous) == get_dependency_name(current)
 
             register_offense(previous, current)

data/lib/rubocop/cop/generator.rb

@@ -124,10 +124,7 @@ module RuboCop
       end
 
       def inject_require(root_file_path: 'lib/rubocop.rb')
-        RequireFileInjector.new(
-          source_path: source_path,
-          root_file_path: root_file_path
-        ).inject
+        RequireFileInjector.new(source_path: source_path, root_file_path: root_file_path).inject
       end
 
       def inject_config(config_file_path: 'config/default.yml',

data/lib/rubocop/cop/generator/configuration_injector.rb

@@ -24,8 +24,7 @@ module RuboCop
         def inject
           target_line = find_target_line
           if target_line
-            configuration_entries.insert(target_line,
-                                         "#{new_configuration_entry}\n")
+            configuration_entries.insert(target_line, "#{new_configuration_entry}\n")
           else
             configuration_entries.push("\n#{new_configuration_entry}")
           end

data/lib/rubocop/cop/generator/require_file_injector.rb

@@ -29,14 +29,11 @@ module RuboCop
         attr_reader :require_entries, :root_file_path, :source_path, :output
 
         def require_exists?
-          require_entries.any? do |entry|
-            entry == injectable_require_directive
-          end
+          require_entries.any?(injectable_require_directive)
         end
 
         def updated_directives
-          require_entries.insert(target_line,
-                                 injectable_require_directive).join
+          require_entries.insert(target_line, injectable_require_directive).join
         end
 
         def target_line

data/lib/rubocop/cop/internal_affairs/example_description.rb

@@ -41,7 +41,7 @@ module RuboCop
 
         EXPECT_NO_OFFENSES_INCORRECT_DESCRIPTIONS = [
           /^(adds|registers|reports|finds) (an? )?offense/,
-          /^flags\b/
+          /^(flags|handles|works)\b/
         ].freeze
 
         EXPECT_OFFENSE_INCORRECT_DESCRIPTIONS = [
@@ -49,9 +49,7 @@ module RuboCop
           /^(does not|doesn't) add (a|an|any )?offense/
         ].freeze
 
-        EXPECT_NO_CORRECTIONS_INCORRECT_DESCRIPTIONS = [
-          /^(auto[- ]?)?correct/
-        ].freeze
+        EXPECT_NO_CORRECTIONS_INCORRECT_DESCRIPTIONS = [/^(auto[- ]?)?correct/].freeze
 
         EXPECT_CORRECTION_INCORRECT_DESCRIPTIONS = [
           /\b(does not|doesn't) (auto[- ]?)?correct/
@@ -80,10 +78,14 @@ module RuboCop
         private
 
         def check_description(description, regexps, message)
-          return unless regexps.any? { |regexp| regexp.match?(description.value) }
+          return unless regexps.any? { |regexp| regexp.match?(string_contents(description)) }
 
           add_offense(description, message: message)
         end
+
+        def string_contents(node)
+          node.str_type? ? node.value : node.source
+        end
       end
     end
   end