# frozen_string_literal: true module RuboCop module RSpec # Extracts cop descriptions from YARD docstrings class DescriptionExtractor def initialize(yardocs) @code_objects = yardocs.map(&CodeObject.public_method(:new)) end def to_h code_objects .select(&:rspec_cop?) .map(&:configuration) .reduce(:merge) end private attr_reader :code_objects # Decorator of a YARD code object for working with documented rspec cops class CodeObject RSPEC_COP_CLASS_NAME = 'RuboCop::Cop::RSpec::Base' RUBOCOP_COP_CLASS_NAME = 'RuboCop::Cop::Base' RSPEC_NAMESPACE = 'RuboCop::Cop::RSpec' def initialize(yardoc) @yardoc = yardoc end # Test if the YARD code object documents a concrete rspec cop class # # @return [Boolean] def rspec_cop? cop_subclass? && !abstract? && rspec_cop_namespace? end # Configuration for the documented cop that would live in default.yml # # @return [Hash] def configuration { cop_name => { 'Description' => description } } end private def cop_name Object.const_get(documented_constant).cop_name end def description yardoc.docstring.split("\n\n").first.to_s end def rspec_cop_namespace? documented_constant.start_with?(RSPEC_NAMESPACE) end def documented_constant yardoc.to_s end def cop_subclass? yardoc.superclass.path == RSPEC_COP_CLASS_NAME || yardoc.superclass.path == RUBOCOP_COP_CLASS_NAME end def abstract? yardoc.tags.any? { |tag| tag.tag_name.eql?('abstract') } end attr_reader :yardoc end end end end