/*
 * Copyright 2020-2024 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.modulith.docs;

import java.util.Optional;

import org.springframework.util.Assert;

import com.tngtech.archunit.core.domain.JavaClass;
import com.tngtech.archunit.core.domain.JavaMethod;

/**
 * A {@link DocumentationSource} that replaces {@literal {@code …}} or {@literal {@link …}} blocks into inline code
 * references
 *
 * @author Oliver Drotbohm
 */
class CodeReplacingDocumentationSource implements DocumentationSource {

	private final DocumentationSource delegate;
	private final Asciidoctor asciidoctor;

	/**
	 * Creates a new {@link CodeReplacingDocumentationSource} for the given delegate {@link DocumentationSource} and
	 * {@link Asciidoctor} instance.
	 *
	 * @param delegate must not be {@literal null}.
	 * @param asciidoctor must not be {@literal null}.
	 */
	CodeReplacingDocumentationSource(DocumentationSource delegate, Asciidoctor asciidoctor) {

		Assert.notNull(delegate, "Delegate DocumentationSource must not be null!");
		Assert.notNull(asciidoctor, "Asciidoctor must not be null!");

		this.delegate = delegate;
		this.asciidoctor = asciidoctor;
	}

	/*
	 * (non-Javadoc)
	 * @see org.springframework.modulith.docs.DocumentationSource#getDocumentation(com.tngtech.archunit.core.domain.JavaMethod)
	 */
	@Override
	public Optional<String> getDocumentation(JavaMethod method) {

		return delegate.getDocumentation(method)
				.map(asciidoctor::toAsciidoctor);
	}

	/*
	 * (non-Javadoc)
	 * @see org.springframework.modulith.docs.DocumentationSource#getDocumentation(com.tngtech.archunit.core.domain.JavaClass)
	 */
	@Override
	public Optional<String> getDocumentation(JavaClass type) {
		return delegate.getDocumentation(type)
				.map(asciidoctor::toAsciidoctor);
	}
}
