Contents

require 'spec_helper'

describe YARD::Templates::Engine.template(:api, :fulldoc) do
  before do
    Registry.clear
    set_option("output", "./tmp/doc")
  end

  describe '@object' do
    it 'should register it as a CodeObject inside the API namespace' do
      populate <<-'eof'
        # @API Quizzes
        #
        # @object Quiz
        #   {
        #     "id": "Quiz",
        #     "description": "A quiz that can be taken by students.",
        #     "properties": {
        #       "id": {
        #         "type": "String"
        #       }
        #     }
        #   }
        class QuizzesController < ApplicationController
        end
      eof

      YARD::Templates::Engine.render({
        objects: [ P('QuizzesController') ],
        type: :fulldoc,
        template: :api,
        format: :html
      })

      expect(Registry.all.map(&:path).sort).to eq(%w[
        API
        API::Quiz
        API::Quizzes
        API::Quizzes::Quiz
        QuizzesController
      ])

      expect(P('API::Quizzes::Quiz')).to be_truthy
      expect(P('API::Quizzes::Quiz').parent).to eq P('API::Quizzes')
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
yard-api-1.1.2	spec/fulldoc_spec.rb
yard-api-1.1.1	spec/fulldoc_spec.rb
yard-api-1.1.0	spec/fulldoc_spec.rb