Contents

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_NAMESPACE = 'RuboCop::Cop::RSpec'.freeze

        def initialize(yardoc)
          @yardoc = yardoc
        end

        # Test if the YARD code object documents a concrete rspec cop class
        #
        # @return [Boolean]
        def rspec_cop?
          class_documentation? && rspec_cop_namespace? && !abstract?
        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 class_documentation?
          yardoc.type.equal?(:class)
        end

        def rspec_cop_namespace?
          documented_constant.start_with?(RSPEC_NAMESPACE)
        end

        def documented_constant
          yardoc.to_s
        end

        def abstract?
          yardoc.tags.any? { |tag| tag.tag_name.eql?('abstract') }
        end

        attr_reader :yardoc
      end
    end
  end
end

Version data entries

8 entries across 8 versions & 1 rubygems

Version	Path
rubocop-rspec-1.21.0	lib/rubocop/rspec/description_extractor.rb
rubocop-rspec-1.20.1	lib/rubocop/rspec/description_extractor.rb
rubocop-rspec-1.20.0	lib/rubocop/rspec/description_extractor.rb
rubocop-rspec-1.19.0	lib/rubocop/rspec/description_extractor.rb
rubocop-rspec-1.18.0	lib/rubocop/rspec/description_extractor.rb
rubocop-rspec-1.17.1	lib/rubocop/rspec/description_extractor.rb
rubocop-rspec-1.17.0	lib/rubocop/rspec/description_extractor.rb
rubocop-rspec-1.16.0	lib/rubocop/rspec/description_extractor.rb