001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2026 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018///////////////////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.site;
021
022import java.nio.file.Path;
023
024import org.apache.maven.doxia.macro.AbstractMacro;
025import org.apache.maven.doxia.macro.Macro;
026import org.apache.maven.doxia.macro.MacroExecutionException;
027import org.apache.maven.doxia.macro.MacroRequest;
028import org.apache.maven.doxia.sink.Sink;
029import org.codehaus.plexus.component.annotations.Component;
030
031import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
032
033/**
034 * A macro that inserts a description of module from its Javadoc.
035 */
036@Component(role = Macro.class, hint = "description")
037public class DescriptionMacro extends AbstractMacro {
038
039    /**
040     * Creates a new {@code DescriptionMacro} instance.
041     */
042    public DescriptionMacro() {
043        // no code by default
044    }
045
046    @Override
047    public void execute(Sink sink, MacroRequest request) throws MacroExecutionException {
048        final Path modulePath = Path.of((String) request.getParameter("modulePath"));
049        final String moduleName = CommonUtil.getFileNameWithoutExtension(modulePath.toString());
050
051        SiteUtil.processModule(moduleName, modulePath);
052        final String moduleDescription = JavadocScraperResultUtil.getModuleDescription();
053        if (moduleDescription.isEmpty()) {
054            throw new MacroExecutionException(
055                "Javadoc of module " + moduleName + " is not found.");
056        }
057        ModuleJavadocParsingUtil.writeOutJavadocPortion(moduleDescription, sink);
058
059    }
060
061}