rubocop 1.19.0 → 1.33.0

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

@@ -2,11 +2,12 @@
 
 module RuboCop
   module Cop
-    # This auto-corrects gem dependency order
+    # This autocorrects gem dependency order
     class OrderedGemCorrector
-      extend OrderedGemNode
-
       class << self
+        include OrderedGemNode
+        include RangeHelp
+
         attr_reader :processed_source, :comments_as_separators
 
         def correct(processed_source, node,
@@ -17,24 +18,24 @@ module RuboCop
           current_range = declaration_with_comment(node)
           previous_range = declaration_with_comment(previous_declaration)
 
-          ->(corrector) do swap_range(corrector, current_range, previous_range) end
+          ->(corrector) { swap_range(corrector, current_range, previous_range) }
         end
 
         private
 
         def declaration_with_comment(node)
           buffer = processed_source.buffer
-          begin_pos = get_source_range(node, comments_as_separators).begin_pos
+          begin_pos = range_by_whole_lines(get_source_range(node, comments_as_separators)).begin_pos
           end_line = buffer.line_for_position(node.loc.expression.end_pos)
-          end_pos = buffer.line_range(end_line).end_pos
-          Parser::Source::Range.new(buffer, begin_pos, end_pos)
+          end_pos = range_by_whole_lines(buffer.line_range(end_line),
+                                         include_final_newline: true).end_pos
+
+          range_between(begin_pos, end_pos)
         end
 
         def swap_range(corrector, range1, range2)
-          src1 = range1.source
-          src2 = range2.source
-          corrector.replace(range1, src2)
-          corrector.replace(range2, src1)
+          corrector.insert_before(range2, range1.source)
+          corrector.remove(range1)
         end
       end
     end

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

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This auto-corrects parentheses
+    # This autocorrects parentheses
     class ParenthesesCorrector
       class << self
         def correct(corrector, node)

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

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This auto-corrects percent literals
+    # This autocorrects percent literals
     class PercentLiteralCorrector
       include Util
 

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

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This auto-corrects punctuation
+    # This autocorrects punctuation
     class PunctuationCorrector
       class << self
         def remove_space(corrector, space_before)

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

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This auto-corrects whitespace
+    # This autocorrects whitespace
     class SpaceCorrector
       extend SurroundingSpace
 

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

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This auto-corrects string literals
+    # This autocorrects string literals
     class StringLiteralCorrector
       extend Util
 

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

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This auto-corrects unused arguments.
+    # This autocorrects unused arguments.
     class UnusedArgCorrector
       extend RangeHelp
 
@@ -29,7 +29,7 @@ module RuboCop
         end
 
         def correct_for_blockarg_type(corrector, node)
-          range = range_with_surrounding_space(range: node.source_range, side: :left)
+          range = range_with_surrounding_space(node.source_range, side: :left)
           range = range_with_surrounding_comma(range, :left)
 
           corrector.remove(range)

data/lib/rubocop/cop/documentation.rb

@@ -8,14 +8,31 @@ module RuboCop
 
       # @api private
       def department_to_basename(department)
-        "cops_#{department.downcase}"
+        "cops_#{department.to_s.downcase.tr('/', '_')}"
       end
 
       # @api private
-      def url_for(cop_class)
+      def url_for(cop_class, config = nil)
         base = department_to_basename(cop_class.department)
         fragment = cop_class.cop_name.downcase.gsub(/[^a-z]/, '')
-        "https://docs.rubocop.org/rubocop/#{base}.html##{fragment}"
+        base_url = base_url_for(cop_class, config)
+
+        "#{base_url}/#{base}.html##{fragment}"
+      end
+
+      # @api private
+      def base_url_for(cop_class, config)
+        return default_base_url unless config
+
+        department_name = cop_class.department.to_s
+
+        config.for_department(department_name)['DocumentationBaseURL'] ||
+          config.for_all_cops['DocumentationBaseURL']
+      end
+
+      # @api private
+      def default_base_url
+        'https://docs.rubocop.org/rubocop'
       end
     end
   end

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

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Gemspec
+      # Enforce that gem dependency version specifications or a commit reference (branch,
+      # ref, or tag) are either required or forbidden.
+      #
+      # @example EnforcedStyle: required (default)
+      #
+      #   # bad
+      #   Gem::Specification.new do |spec|
+      #     spec.add_dependency 'parser'
+      #   end
+      #
+      #   # bad
+      #   Gem::Specification.new do |spec|
+      #     spec.add_development_dependency 'parser'
+      #   end
+      #
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     spec.add_dependency 'parser', '>= 2.3.3.1', '< 3.0'
+      #   end
+      #
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     spec.add_development_dependency 'parser', '>= 2.3.3.1', '< 3.0'
+      #   end
+      #
+      # @example EnforcedStyle: forbidden
+      #
+      #   # bad
+      #   Gem::Specification.new do |spec|
+      #     spec.add_dependency 'parser', '>= 2.3.3.1', '< 3.0'
+      #   end
+      #
+      #   # bad
+      #   Gem::Specification.new do |spec|
+      #     spec.add_development_dependency 'parser', '>= 2.3.3.1', '< 3.0'
+      #   end
+      #
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     spec.add_dependency 'parser'
+      #   end
+      #
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     spec.add_development_dependency 'parser'
+      #   end
+      #
+      class DependencyVersion < Base
+        include ConfigurableEnforcedStyle
+        include GemspecHelp
+
+        REQUIRED_MSG = 'Dependency version specification is required.'
+        FORBIDDEN_MSG = 'Dependency version specification is forbidden.'
+        VERSION_SPECIFICATION_REGEX = /^\s*[~<>=]*\s*[0-9.]+/.freeze
+
+        # @!method add_dependency_method_declarations(node)
+        def_node_search :add_dependency_method_declarations, <<~PATTERN
+          (send
+            (lvar #match_block_variable_name?) #add_dependency_method? ...)
+        PATTERN
+
+        # @!method includes_version_specification?(node)
+        def_node_matcher :includes_version_specification?, <<~PATTERN
+          (send _ #add_dependency_method? <(str #version_specification?) ...>)
+        PATTERN
+
+        # @!method includes_commit_reference?(node)
+        def_node_matcher :includes_commit_reference?, <<~PATTERN
+          (send _ #add_dependency_method? <(hash <(pair (sym {:branch :ref :tag}) (str _)) ...>) ...>)
+        PATTERN
+
+        def on_new_investigation
+          return if processed_source.blank?
+
+          add_dependency_method_nodes.each do |node|
+            next if allowed_gem?(node)
+
+            if offense?(node)
+              add_offense(node)
+              opposite_style_detected
+            else
+              correct_style_detected
+            end
+          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 match_block_variable_name?(receiver_name)
+          gem_specification(processed_source.ast) do |block_variable_name|
+            return block_variable_name == receiver_name
+          end
+        end
+
+        def add_dependency_method?(method_name)
+          method_name.to_s.end_with?('_dependency')
+        end
+
+        def add_dependency_method_nodes
+          add_dependency_method_declarations(processed_source.ast)
+        end
+
+        def offense?(node)
+          required_offense?(node) || forbidden_offense?(node)
+        end
+
+        def required_offense?(node)
+          return unless required_style?
+
+          !includes_version_specification?(node) && !includes_commit_reference?(node)
+        end
+
+        def forbidden_offense?(node)
+          return unless forbidden_style?
+
+          includes_version_specification?(node) || includes_commit_reference?(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/gemspec/deprecated_attribute_assignment.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Gemspec
+      # Checks that deprecated attribute attributes are not set in a gemspec file.
+      # Removing deprecated attributes allows the user to receive smaller packed gems.
+      #
+      # @example
+      #
+      #   # bad
+      #   Gem::Specification.new do |spec|
+      #     spec.name = 'your_cool_gem_name'
+      #     spec.test_files = Dir.glob('test/**/*')
+      #   end
+      #
+      #   # bad
+      #   Gem::Specification.new do |spec|
+      #     spec.name = 'your_cool_gem_name'
+      #     spec.test_files += Dir.glob('test/**/*')
+      #   end
+      #
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     spec.name = 'your_cool_gem_name'
+      #   end
+      #
+      class DeprecatedAttributeAssignment < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Do not set `%<attribute>s` in gemspec.'
+
+        # @!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
+
+          assignment = block_node.descendants.detect do |node|
+            use_deprecated_attributes?(node, block_parameter)
+          end
+          return unless assignment
+
+          message = format_message_from
+          add_offense(assignment, message: message) do |corrector|
+            range = range_by_whole_lines(assignment.source_range, include_final_newline: true)
+
+            corrector.remove(range)
+          end
+        end
+
+        private
+
+        def node_and_method_name(node, attribute)
+          if node.op_asgn_type?
+            lhs, _op, _rhs = *node
+            [lhs, attribute]
+          else
+            [node, "#{attribute}=".to_sym]
+          end
+        end
+
+        def use_deprecated_attributes?(node, block_parameter)
+          %i[test_files date specification_version rubygems_version].each do |attribute|
+            node, method_name = node_and_method_name(node, attribute)
+            unless node.send_type? && node.receiver&.source == block_parameter &&
+                   node.method?(method_name)
+              next
+            end
+
+            @attribute = attribute.to_s
+            return true
+          end
+          false
+        end
+
+        def format_message_from
+          format(MSG, attribute: @attribute)
+        end
+      end
+    end
+  end
+end

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

@@ -36,36 +36,23 @@ module RuboCop
       #   end
       class DuplicatedAssignment < Base
         include RangeHelp
+        include GemspecHelp
 
-        MSG = '`%<assignment>s` method calls already given on line '\
+        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
-              (const
-                (const {cbase nil?} :Gem) :Specification) :new)
-            (args
-              (arg $_)) ...)
-        PATTERN
-
         # @!method assignment_method_declarations(node)
         def_node_search :assignment_method_declarations, <<~PATTERN
           (send
-            (lvar #match_block_variable_name?) #assignment_method? ...)
+            (lvar #match_block_variable_name?) _ ...)
         PATTERN
 
         def on_new_investigation
           return if processed_source.blank?
 
           duplicated_assignment_method_nodes.each do |nodes|
-            nodes[1..-1].each do |node|
-              register_offense(
-                node,
-                node.method_name,
-                nodes.first.first_line
-              )
+            nodes[1..].each do |node|
+              register_offense(node, node.method_name, nodes.first.first_line)
             end
           end
         end
@@ -78,12 +65,9 @@ module RuboCop
           end
         end
 
-        def assignment_method?(method_name)
-          method_name.to_s.end_with?('=')
-        end
-
         def duplicated_assignment_method_nodes
           assignment_method_declarations(processed_source.ast)
+            .select(&:assignment_method?)
             .group_by(&:method_name)
             .values
             .select { |nodes| nodes.size > 1 }

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

@@ -50,15 +50,15 @@ module RuboCop
       #   spec.add_dependency 'rubocop'
       #   # For tests
       #   spec.add_dependency 'rspec'
-      class OrderedDependencies < Cop # rubocop:disable InternalAffairs/InheritDeprecatedCopClass
-        include ConfigurableEnforcedStyle
+      class OrderedDependencies < Base
+        extend AutoCorrector
         include OrderedGemNode
 
         MSG = 'Dependencies should be sorted in an alphabetical order within ' \
-              'their section of the gemspec. '\
+              'their section of the gemspec. ' \
               'Dependency `%<previous>s` should appear before `%<current>s`.'
 
-        def investigate(processed_source)
+        def on_new_investigation
           return if processed_source.blank?
 
           dependency_declarations(processed_source.ast)
@@ -71,15 +71,6 @@ module RuboCop
           end
         end
 
-        def autocorrect(node)
-          OrderedGemCorrector.correct(
-            processed_source,
-            node,
-            previous_declaration(node),
-            treat_comments_as_separators
-          )
-        end
-
         private
 
         def previous_declaration(node)

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

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Gemspec
+      # Requires a gemspec to have `rubygems_mfa_required` metadata set.
+      #
+      # This setting tells RubyGems that MFA (Multi-Factor Authentication) is
+      # required for accounts to be able perform privileged operations, such as
+      # (see RubyGems' documentation for the full list of privileged
+      # operations):
+      #
+      # * `gem push`
+      # * `gem yank`
+      # * `gem owner --add/remove`
+      # * adding or removing owners using gem ownership page
+      #
+      # This helps make your gem more secure, as users can be more
+      # confident that gem updates were pushed by maintainers.
+      #
+      # @example
+      #   # bad
+      #   Gem::Specification.new do |spec|
+      #     # no `rubygems_mfa_required` metadata specified
+      #   end
+      #
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     spec.metadata = {
+      #       'rubygems_mfa_required' => 'true'
+      #     }
+      #   end
+      #
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     spec.metadata['rubygems_mfa_required'] = 'true'
+      #   end
+      #
+      #   # bad
+      #   Gem::Specification.new do |spec|
+      #     spec.metadata = {
+      #       'rubygems_mfa_required' => 'false'
+      #     }
+      #   end
+      #
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     spec.metadata = {
+      #       'rubygems_mfa_required' => 'true'
+      #     }
+      #   end
+      #
+      #   # bad
+      #   Gem::Specification.new do |spec|
+      #     spec.metadata['rubygems_mfa_required'] = 'false'
+      #   end
+      #
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     spec.metadata['rubygems_mfa_required'] = 'true'
+      #   end
+      #
+      class RequireMFA < Base
+        include GemspecHelp
+        extend AutoCorrector
+
+        MSG = "`metadata['rubygems_mfa_required']` must be set to `'true'`."
+
+        # @!method metadata(node)
+        def_node_matcher :metadata, <<~PATTERN
+          `{
+            (send _ :metadata= $_)
+            (send (send _ :metadata) :[]= (str "rubygems_mfa_required") $_)
+          }
+        PATTERN
+
+        # @!method rubygems_mfa_required(node)
+        def_node_search :rubygems_mfa_required, <<~PATTERN
+          (pair (str "rubygems_mfa_required") $_)
+        PATTERN
+
+        # @!method true_string?(node)
+        def_node_matcher :true_string?, <<~PATTERN
+          (str "true")
+        PATTERN
+
+        def on_block(node) # rubocop:disable Metrics/MethodLength
+          gem_specification(node) do |block_var|
+            metadata_value = metadata(node)
+            mfa_value = mfa_value(metadata_value)
+
+            if mfa_value
+              unless true_string?(mfa_value)
+                add_offense(mfa_value) do |corrector|
+                  change_value(corrector, mfa_value)
+                end
+              end
+            else
+              add_offense(node) do |corrector|
+                autocorrect(corrector, node, block_var, metadata_value)
+              end
+            end
+          end
+        end
+
+        private
+
+        def mfa_value(metadata_value)
+          return unless metadata_value
+          return metadata_value if metadata_value.str_type?
+
+          rubygems_mfa_required(metadata_value).first
+        end
+
+        def autocorrect(corrector, node, block_var, metadata)
+          if metadata
+            return unless metadata.hash_type?
+
+            correct_metadata(corrector, metadata)
+          else
+            insert_mfa_required(corrector, node, block_var)
+          end
+        end
+
+        def correct_metadata(corrector, metadata)
+          if metadata.pairs.any?
+            corrector.insert_after(metadata.pairs.last, ",\n'rubygems_mfa_required' => 'true'")
+          else
+            corrector.insert_before(metadata.loc.end, "'rubygems_mfa_required' => 'true'")
+          end
+        end
+
+        def insert_mfa_required(corrector, node, block_var)
+          corrector.insert_before(node.loc.end, <<~RUBY)
+            #{block_var}.metadata['rubygems_mfa_required'] = 'true'
+          RUBY
+        end
+
+        def change_value(corrector, value)
+          corrector.replace(value, "'true'")
+        end
+      end
+    end
+  end
+end