Contents

# encoding: utf-8
# frozen_string_literal: true

require 'rubocop'

module RuboCop
  module Cop
    module Sorbet
      # This cop ensures one ancestor per requires_ancestor line
      # rather than chaining them as a comma-separated list.
      #
      # @example
      #
      #   # bad
      #   module SomeModule
      #     requires_ancestor Kernel, Minitest::Assertions
      #   end
      #
      #   # good
      #   module SomeModule
      #     requires_ancestor Kernel
      #     requires_ancestor Minitest::Assertions
      #   end
      class OneAncestorPerLine < RuboCop::Cop::Cop
        MSG = 'Cannot require more than one ancestor per line'

        def_node_search :requires_ancestors, <<~PATTERN
          (send nil? :requires_ancestor ...)
        PATTERN

        def_node_matcher :more_than_one_ancestor, <<~PATTERN
          (send nil? :requires_ancestor const const+)
        PATTERN

        def_node_search :abstract?, <<~PATTERN
          (send nil? :abstract!)
        PATTERN

        def on_module(node)
          return unless node.body
          return unless requires_ancestors(node)
          process_node(node)
        end

        def on_class(node)
          return unless abstract?(node)
          return unless requires_ancestors(node)
          process_node(node)
        end

        def autocorrect(node)
          -> (corrector) do
            ra_call = node.parent
            split_ra_calls = ra_call.source.gsub(/,\s+/, new_ra_line(ra_call.loc.column))
            corrector.replace(ra_call, split_ra_calls)
          end
        end

        private

        def process_node(node)
          requires_ancestors(node).each do |ra|
            add_offense(ra.child_nodes[1]) if more_than_one_ancestor(ra)
          end
        end

        def new_ra_line(indent_count)
          indents = " " * indent_count
          indented_ra_call = "#{indents}requires_ancestor "
          "\n#{indented_ra_call}"
        end
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
rubocop-sorbet-0.6.2	lib/rubocop/cop/sorbet/one_ancestor_per_line.rb
rubocop-sorbet-0.6.1	lib/rubocop/cop/sorbet/one_ancestor_per_line.rb
rubocop-sorbet-0.6.0	lib/rubocop/cop/sorbet/one_ancestor_per_line.rb