plugins {
    id 'org.asciidoctor.jvm.convert' version '3.3.2'
}

configurations {
    asciidoctorExt
}

dependencies {
    asciidoctorExt 'org.springframework.restdocs:spring-restdocs-asciidoctor'
    testImplementation 'org.springframework.restdocs:spring-restdocs-restassured'
}

// build/generated-snippets 폴더에 스니펫이 생깁니다.
ext {
    snippetsDir = file('build/generated-snippets')
}

test {
    outputs.dir snippetsDir
}

// src/docs/asciidoc 폴더에 adoc 확장자로 만든 문서를 html로 변환합니다.
asciidoctor { 
    configurations 'asciidoctorExt'
    baseDirFollowsSourceFile()
    inputs.dir snippetsDir
    dependsOn test
}

// 최신화를 위해 전에 복사된 html 파일을 삭제합니다.
asciidoctor.doFirst {
    delete file('src/main/resources/static/docs')
}

// html로 변환한 문서를 src/main/resources/static/docs 파일로 복사합니다.
task copyDocument(type: Copy) {
    dependsOn asciidoctor
    from file("${asciidoctor.outputDir}")
    into file("src/main/resources/static/docs")
}

build {
    dependsOn copyDocument
}

bootJar {
    dependsOn asciidoctor
    from("${asciidoctor.outputDir}") {
        into 'static/docs'
    }
}
  

  @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
// 아래 클래스를 등록해야 문서가 작성됩니다.
@ExtendWith({RestDocumentationExtension.class})
public class ControllerTest {
		// 상속받는 클래스에서 사용하기 위해 접근 제어자를 protected으로 사용했습니다.
    protected RequestSpecification spec;

    @BeforeEach
    void setPort(RestDocumentationContextProvider restDocumentation) {
        spec = new RequestSpecBuilder().addFilter(
                        documentationConfiguration(restDocumentation)
                                .operationPreprocessors()
                                // 입출력 JSON을 문서에서 이쁘게 보이도록 만들어줍니다.
                                .withRequestDefaults(prettyPrint())
                                .withResponseDefaults(prettyPrint()))
                .build();
    }
}
  

  @DisplayName("동아리 생성 성공 시, 201을 응답한다.")
@Test
void create() {
    String name = "club name";
    ClubCreateRequest request = new ClubCreateRequest(name);
    String url = String.format("/v1/clubs?member_id=%d", member.getId());
    
    RestAssured.given(spec).log().all()
            .contentType(ContentType.JSON)
            .body(request)
            .filter(document("club/create/",
                    queryParameters(parameterWithName("member_id").description("동아리를 생성한 사용자의 id")),
                    requestFields(fieldWithPath("name").description("생성할 동아리의 이름"))
            ))
            .when().post(url)
            .then().log().all().statusCode(201);
}
  

  @DisplayName("지원자의 상세 정보를 읽어오는 데 성공하면 200을 응답한다.")
@Test
void readDetail() {
    // given
    Dashboard dashboard = dashboardRepository.save(createBackendDashboard());
    Process process = processRepository.save(createFirstProcess(dashboard));
    Applicant applicant = applicantRepository.save(createApplicantDobby(process));
    Question question = questionRepository.save(new Question("나이", 0, dashboard));
    answerRepository.save(new Answer("28", question, applicant));

    // when&then
    RestAssured.given(spec).log().all()
            .filter(document("applicant/read-detail-profile/",
                    pathParameters(parameterWithName("applicant_id").description("정보를 읽어올 지원자의 id")),
                    responseFields(fieldWithPath("details").description("지원자의 질의응답"))
                            .andWithPrefix("details[].",
                                    fieldWithPath("order_index").description("질문 순서"),
                                    fieldWithPath("question").description("질문"),
                                    fieldWithPath("answer").description("응답"))
            ))
            .when().get("/v1/applicants/{applicant_id}/detail", applicant.getId())
            .then().log().all().statusCode(200);
}
  

  responseFields(
        fieldWithPath("details").description("지원자의 질의응답")
        fieldWithPath("details[].order_index").description("질문 순서"),
        fieldWithPath("details[].question").description("질문"),
        fieldWithPath("details[].answer").description("응답")
)
  

  private static final FieldDescriptor[] FIELD_DESCRIPTORS = {
        fieldWithPath("order_index").description("질문 순서"),
        fieldWithPath("question").description("질문"),
        fieldWithPath("answer").description("응답")
};

responseFields(fieldWithPath("details").description("지원자의 질의응답"))
        .andWithPrefix("details[].", FIELD_DESCRIPTORS)
  

  = 크루루 API 문서 v1.0
:source-highlighter: highlightjs
:toc: left
:toclevels: 3
:toc-title: API 목록
:sectnums:

include::applicant.adoc[]
include::club.adoc[]
include::dashboard.adoc[]
include::evaluation.adoc[]
include::member.adoc[]
include::process.adoc[]
  

  == 동아리

=== 동아리 생성

==== 성공

operation::club/create[snippets="http-request,query-parameters,request-fields,http-response"]

==== 실패: 존재하지 않는 사용자

operation::club/create-fail/member-not-found[snippets="http-request,query-parameters,request-fields,http-response"]

==== 실패: 조건에 맞지 않는 동아리 이름

operation::club/create-fail/invalid-name[snippets="http-request,query-parameters,request-fields,http-response"]