rubocop 0.78.0 → 1.13.0

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

@@ -35,9 +35,7 @@ module RuboCop
 
         def add_space(processed_source, corrector, left_token, right_token)
           @processed_source = processed_source
-          unless left_token.space_after?
-            corrector.insert_after(left_token.pos, ' ')
-          end
+          corrector.insert_after(left_token.pos, ' ') unless left_token.space_after?
           return if right_token.space_before?
 
           corrector.insert_before(right_token.pos, ' ')

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

@@ -7,16 +7,14 @@ module RuboCop
       extend Util
 
       class << self
-        def correct(node, style)
+        def correct(corrector, node, style)
           return if node.dstr_type?
 
-          lambda do |corrector|
-            str = node.str_content
-            if style == :single_quotes
-              corrector.replace(node.source_range, to_string_literal(str))
-            else
-              corrector.replace(node.source_range, str.inspect)
-            end
+          str = node.str_content
+          if style == :single_quotes
+            corrector.replace(node, to_string_literal(str))
+          else
+            corrector.replace(node, str.inspect)
           end
         end
       end

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

@@ -9,33 +9,30 @@ module RuboCop
       class << self
         attr_reader :processed_source
 
-        def correct(processed_source, node)
+        def correct(corrector, processed_source, node)
           return if %i[kwarg kwoptarg].include?(node.type)
 
           @processed_source = processed_source
 
           if node.blockarg_type?
-            correct_for_blockarg_type(node)
+            correct_for_blockarg_type(corrector, node)
           else
-            lambda do |corrector|
-              variable_name = if node.optarg_type?
-                                node.node_parts[0]
-                              else
-                                # Extract only a var name without splat (`*`)
-                                node.source.gsub(/\A\*+/, '')
-                              end
-              corrector.replace(node.loc.name, "_#{variable_name}")
-            end
+            variable_name = if node.optarg_type?
+                              node.node_parts[0]
+                            else
+                              # Extract only a var name without splat (`*`)
+                              node.source.gsub(/\A\*+/, '')
+                            end
+
+            corrector.replace(node.loc.name, "_#{variable_name}")
           end
         end
 
-        def correct_for_blockarg_type(node)
-          lambda do |corrector|
-            range = range_with_surrounding_space(range: node.source_range,
-                                                 side: :left)
-            range = range_with_surrounding_comma(range, :left)
-            corrector.remove(range)
-          end
+        def correct_for_blockarg_type(corrector, node)
+          range = range_with_surrounding_space(range: node.source_range, side: :left)
+          range = range_with_surrounding_comma(range, :left)
+
+          corrector.remove(range)
         end
       end
     end

data/lib/rubocop/cop/documentation.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Helpers for builtin documentation
+    module Documentation
+      module_function
+
+      # @api private
+      def department_to_basename(department)
+        "cops_#{department.downcase}"
+      end
+
+      # @api private
+      def url_for(cop_class)
+        base = department_to_basename(cop_class.department)
+        fragment = cop_class.cop_name.downcase.gsub(/[^a-z]/, '')
+        "https://docs.rubocop.org/rubocop/#{base}.html##{fragment}"
+      end
+    end
+  end
+end

data/lib/rubocop/cop/exclude_limit.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # Allows specified configuration options to have an exclude limit
+  # ie. a maximum value tracked that it can be used by `--auto-gen-config`.
+  module ExcludeLimit
+    # Sets up a configuration option to have an exclude limit tracked.
+    # The parameter name given is transformed into a method name (eg. `Max`
+    # becomes `self.max=` and `MinDigits` becomes `self.min_digits=`).
+    def exclude_limit(parameter_name, method_name: transform(parameter_name))
+      define_method("#{method_name}=") do |value|
+        cfg = config_to_allow_offenses
+        cfg[:exclude_limit] ||= {}
+        current_max = cfg[:exclude_limit][parameter_name]
+        value = [current_max, value].max if current_max
+        cfg[:exclude_limit][parameter_name] = value
+      end
+    end
+
+    private
+
+    def transform(parameter_name)
+      parameter_name.gsub(/(?<!\A)(?=[A-Z])/, '_').downcase
+    end
+  end
+end

data/lib/rubocop/cop/force.rb

@@ -11,6 +11,7 @@ module RuboCop
       end
 
       def self.inherited(subclass)
+        super
         all << subclass
       end
 
@@ -30,7 +31,7 @@ module RuboCop
         cops.each do |cop|
           next unless cop.respond_to?(method_name)
 
-          cop.send(method_name, *args)
+          cop.public_send(method_name, *args)
         end
       end
 

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Gemspec
+      # This cop checks that `date =` is not used in gemspec file.
+      # It is set automatically when the gem is packaged.
+      #
+      # @example
+      #
+      #   # bad
+      #   Gem::Specification.new do |spec|
+      #     s.name = 'your_cool_gem_name'
+      #     spec.date = Time.now.strftime('%Y-%m-%d')
+      #   end
+      #
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     s.name = 'your_cool_gem_name'
+      #   end
+      #
+      class DateAssignment < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Do not use `date =` in gemspec, it is set automatically when the gem is packaged.'
+
+        # @!method gem_specification(node)
+        def_node_matcher :gem_specification, <<~PATTERN
+          (block
+            (send
+              (const
+                (const {cbase nil?} :Gem) :Specification) :new)
+            ...)
+        PATTERN
+
+        def on_block(block_node)
+          return unless gem_specification(block_node)
+
+          block_parameter = block_node.arguments.first.source
+
+          date_assignment = block_node.descendants.detect do |node|
+            node.send_type? && node.receiver&.source == block_parameter && node.method?(:date=)
+          end
+
+          return unless date_assignment
+
+          add_offense(date_assignment) do |corrector|
+            range = range_by_whole_lines(date_assignment.source_range, include_final_newline: true)
+
+            corrector.remove(range)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -34,12 +34,13 @@ module RuboCop
       #     spec.add_runtime_dependency('parallel', '~> 1.10')
       #     spec.add_runtime_dependency('parser', '>= 2.3.3.1', '< 3.0')
       #   end
-      class DuplicatedAssignment < Cop
+      class DuplicatedAssignment < Base
         include RangeHelp
 
         MSG = '`%<assignment>s` method calls already given on line '\
               '%<line_of_first_occurrence>d of the gemspec.'
 
+        # @!method gem_specification(node)
         def_node_search :gem_specification, <<~PATTERN
           (block
             (send
@@ -49,12 +50,13 @@ module RuboCop
               (arg $_)) ...)
         PATTERN
 
+        # @!method assignment_method_declarations(node)
         def_node_search :assignment_method_declarations, <<~PATTERN
           (send
             (lvar #match_block_variable_name?) #assignment_method? ...)
         PATTERN
 
-        def investigate(processed_source)
+        def on_new_investigation
           return if processed_source.blank?
 
           duplicated_assignment_method_nodes.each do |nodes|
@@ -89,14 +91,13 @@ 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,
             line_of_first_occurrence: line_of_first_occurrence
           )
-          add_offense(node, location: offense_location, message: message)
+          add_offense(offense_location, message: message)
         end
       end
     end

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

@@ -64,13 +64,8 @@ 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)
-            )
-            unless get_dependency_name(previous) == get_dependency_name(current)
-              next
-            end
+            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)
           end
@@ -97,8 +92,9 @@ module RuboCop
           node.method_name
         end
 
+        # @!method dependency_declarations(node)
         def_node_search :dependency_declarations, <<~PATTERN
-          (send (lvar _) {:add_dependency :add_runtime_dependency :add_development_dependency} ...)
+          (send (lvar _) {:add_dependency :add_runtime_dependency :add_development_dependency} (str _) ...)
         PATTERN
       end
     end

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

@@ -3,8 +3,8 @@
 module RuboCop
   module Cop
     module Gemspec
-      # Checks that `required_ruby_version` of gemspec and `TargetRubyVersion`
-      # of .rubocop.yml are equal.
+      # Checks that `required_ruby_version` of gemspec is specified and
+      # equal to `TargetRubyVersion` of .rubocop.yml.
       # Thereby, RuboCop to perform static analysis working on the version
       # required by gemspec.
       #
@@ -13,6 +13,11 @@ module RuboCop
       #
       #   # bad
       #   Gem::Specification.new do |spec|
+      #     # no `required_ruby_version` specified
+      #   end
+      #
+      #   # bad
+      #   Gem::Specification.new do |spec|
       #     spec.required_ruby_version = '>= 2.4.0'
       #   end
       #
@@ -31,49 +36,72 @@ module RuboCop
       #     spec.required_ruby_version = '>= 2.5'
       #   end
       #
-      #   # good
+      #   # accepted but not recommended
       #   Gem::Specification.new do |spec|
       #     spec.required_ruby_version = ['>= 2.5.0', '< 2.7.0']
       #   end
-      class RequiredRubyVersion < Cop
-        MSG = '`required_ruby_version` (%<required_ruby_version>s, ' \
-              'declared in %<gemspec_filename>s) and `TargetRubyVersion` ' \
-              '(%<target_ruby_version>s, which may be specified in ' \
-              '.rubocop.yml) should be equal.'
+      #
+      #   # accepted but not recommended, since
+      #   # Ruby does not really follow semantic versionning
+      #   Gem::Specification.new do |spec|
+      #     spec.required_ruby_version = '~> 2.5'
+      #   end
+      class RequiredRubyVersion < Base
+        include RangeHelp
+
+        NOT_EQUAL_MSG = '`required_ruby_version` (%<required_ruby_version>s, ' \
+                        'declared in %<gemspec_filename>s) and `TargetRubyVersion` ' \
+                        '(%<target_ruby_version>s, which may be specified in ' \
+                        '.rubocop.yml) should be equal.'
+        MISSING_MSG = '`required_ruby_version` should be specified.'
 
+        # @!method required_ruby_version(node)
         def_node_search :required_ruby_version, <<~PATTERN
-          (send _ :required_ruby_version= ${(str _) (array (str _))})
+          (send _ :required_ruby_version= $_)
         PATTERN
 
-        def investigate(processed_source)
-          required_ruby_version(processed_source.ast) do |version|
-            ruby_version = extract_ruby_version(version)
+        # @!method defined_ruby_version(node)
+        def_node_matcher :defined_ruby_version, <<~PATTERN
+          {$(str _) $(array (str _) (str _))
+            (send (const (const nil? :Gem) :Requirement) :new $(str _))}
+        PATTERN
+
+        # rubocop:disable Metrics/AbcSize
+        def on_new_investigation
+          version_def = required_ruby_version(processed_source.ast).first
 
-            return if ruby_version == target_ruby_version.to_s
+          if version_def
+            ruby_version = extract_ruby_version(defined_ruby_version(version_def))
+            return if !ruby_version || ruby_version == target_ruby_version.to_s
 
             add_offense(
-              processed_source.ast,
-              location: version.loc.expression,
-              message: message(ruby_version, target_ruby_version)
+              version_def.loc.expression,
+              message: not_equal_message(ruby_version, target_ruby_version)
             )
+          else
+            range = source_range(processed_source.buffer, 1, 0)
+            add_offense(range, message: MISSING_MSG)
           end
         end
+        # rubocop:enable Metrics/AbcSize
 
         private
 
         def extract_ruby_version(required_ruby_version)
+          return unless required_ruby_version
+
           if required_ruby_version.array_type?
             required_ruby_version = required_ruby_version.children.detect do |v|
-              v.str_content =~ /[>=]/
+              /[>=]/.match?(v.str_content)
             end
           end
 
-          required_ruby_version.str_content.match(/(\d\.\d)/)[1]
+          required_ruby_version.str_content.scan(/\d/).first(2).join('.')
         end
 
-        def message(required_ruby_version, target_ruby_version)
+        def not_equal_message(required_ruby_version, target_ruby_version)
           format(
-            MSG,
+            NOT_EQUAL_MSG,
             required_ruby_version: required_ruby_version,
             gemspec_filename: File.basename(processed_source.file_path),
             target_ruby_version: target_ruby_version

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

@@ -25,11 +25,13 @@ module RuboCop
       #     spec.add_runtime_dependency 'gem_a'
       #   end
       #
-      class RubyVersionGlobalsUsage < Cop
+      class RubyVersionGlobalsUsage < Base
         MSG = 'Do not use `RUBY_VERSION` in gemspec file.'
 
-        def_node_matcher :ruby_version?, '(const nil? :RUBY_VERSION)'
+        # @!method ruby_version?(node)
+        def_node_matcher :ruby_version?, '(const {cbase nil?} :RUBY_VERSION)'
 
+        # @!method gem_specification?(node)
         def_node_search :gem_specification?, <<~PATTERN
           (block
             (send

data/lib/rubocop/cop/generator.rb

@@ -6,9 +6,10 @@ module RuboCop
     #
     # This generator will take a cop name and generate a source file
     # and spec file when given a valid qualified cop name.
+    # @api private
     class Generator
-      # Note: RDoc 5.1.0 or lower has the following issue.
-      # https://github.com/rubocop-hq/rubocop/issues/7043
+      # NOTE: RDoc 5.1.0 or lower has the following issue.
+      # https://github.com/rubocop/rubocop/issues/7043
       #
       # The following `String#gsub` can be replaced with
       # squiggly heredoc when RuboCop supports Ruby 2.5 or higher
@@ -16,7 +17,6 @@ module RuboCop
       SOURCE_TEMPLATE = <<-RUBY.gsub(/^ {8}/, '')
         # frozen_string_literal: true
 
-        # TODO: when finished, run `rake generate_cops_documentation` to update the docs
         module RuboCop
           module Cop
             module %<department>s
@@ -54,11 +54,11 @@ module RuboCop
               #   # good
               #   good_foo_method(args)
               #
-              class %<cop_name>s < Cop
+              class %<cop_name>s < Base
                 # TODO: Implement the cop in here.
                 #
                 # In many cases, you can use a node matcher for matching node pattern.
-                # See https://github.com/rubocop-hq/rubocop/blob/master/lib/rubocop/node_pattern.rb
+                # See https://github.com/rubocop/rubocop-ast/blob/master/lib/rubocop/ast/node_pattern.rb
                 #
                 # For example
                 MSG = 'Use `#good_method` instead of `#bad_method`.'
@@ -81,9 +81,7 @@ module RuboCop
       SPEC_TEMPLATE = <<~SPEC
         # frozen_string_literal: true
 
-        RSpec.describe RuboCop::Cop::%<department>s::%<cop_name>s do
-          subject(:cop) { described_class.new(config) }
-
+        RSpec.describe RuboCop::Cop::%<department>s::%<cop_name>s, :config do
           let(:config) { RuboCop::Config.new }
 
           # TODO: Write test code
@@ -104,10 +102,9 @@ module RuboCop
         end
       SPEC
 
-      CONFIGURATION_ADDED_MESSAGE = <<~MESSAGE
-        [modify] A configuration for the cop is added into %<configuration_file_path>s.
-                 If you want to disable the cop by default, set `Enabled` option to false.
-      MESSAGE
+      CONFIGURATION_ADDED_MESSAGE =
+        '[modify] A configuration for the cop is added into ' \
+          '%<configuration_file_path>s.'
 
       def initialize(name, github_user, output: $stdout)
         @badge = Badge.parse(name)
@@ -127,19 +124,17 @@ 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')
+      def inject_config(config_file_path: 'config/default.yml',
+                        version_added: '<<next>>')
         injector =
           ConfigurationInjector.new(configuration_file_path: config_file_path,
                                     badge: badge,
-                                    version_added: bump_minor_version)
+                                    version_added: version_added)
 
-        injector.inject do
+        injector.inject do # rubocop:disable Lint/UnexpectedBlockArity
           output.puts(format(CONFIGURATION_ADDED_MESSAGE,
                              configuration_file_path: config_file_path))
         end
@@ -212,12 +207,6 @@ module RuboCop
           .gsub(/([A-Z])([A-Z][^A-Z\d]+)/, '\1_\2')
           .downcase
       end
-
-      def bump_minor_version
-        versions = RuboCop::Version::STRING.split('.')
-
-        "#{versions[0]}.#{versions[1].succ}"
-      end
     end
   end
 end