febus982/mkdocs-macros-adr-summary

#  Copyright (c) 2024 Federico Busetti <729029+febus982@users.noreply.github.com>
#
#  Permission is hereby granted, free of charge, to any person obtaining a
#  copy of this software and associated documentation files (the "Software"),
#  to deal in the Software without restriction, including without limitation
#  the rights to use, copy, modify, merge, publish, distribute, sublicense,
#  and/or sell copies of the Software, and to permit persons to whom the
#  Software is furnished to do so, subject to the following conditions:
#
#  The above copyright notice and this permission notice shall be included in
#  all copies or substantial portions of the Software.
#
#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
#  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
#  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
#  DEALINGS IN THE SOFTWARE.
import logging
from abc import ABC, abstractmethod
from datetime import date
from pathlib import Path
from typing import Any, Dict, Optional, Sequence, Tuple

from mistune import Markdown, create_markdown
from mistune.renderers.markdown import MarkdownRenderer
from mkdocs_macros import fix_url

from mkdocs_macros_adr_summary.interfaces import ADRDocument, ADRParser

from .exceptions import InvalidFileError
from .types import TYPE_AST


class BaseParser(ADRParser, ABC):
    renderer: MarkdownRenderer = MarkdownRenderer()
    parser: Markdown = create_markdown(
        escape=False,
        renderer=None,
        plugins=["strikethrough", "footnotes", "table", "speedup"],
    )

    @classmethod
    def parse(cls, file_path: Path, base_path: Path) -> ADRDocument:
        with open(file_path, "r") as f:
            file = f.read()
        try:
            metadata, ast = cls._get_metadata_and_ast(file)
        except LookupError as e:
            raise InvalidFileError(file_path) from e

        doc = ADRDocument(
            file_path=fix_url(str(file_path.relative_to(base_path))),
            document_id=cls._get_id(file_path),
            title=cls._get_title(metadata, ast),
            date=cls._get_date(metadata, ast),
            status=cls._get_status(metadata, ast),
            statuses=cls._get_statuses(metadata, ast),
            deciders=cls._get_deciders(metadata, ast),
            consulted=cls._get_consulted(metadata, ast),
            informed=cls._get_informed(metadata, ast),
        )
        return doc

    @classmethod
    def _get_title(cls, metadata: dict, ast: TYPE_AST) -> Optional[str]:
        title_index = cls._get_title_index(ast)
        if title_index is None:
            return None
        return cls.renderer.paragraph(ast[0][title_index], ast[1]).strip()

    @classmethod
    def _get_title_index(cls, ast: TYPE_AST) -> Optional[int]:
        h1_file_lines = [
            i
            for i, x in enumerate(ast[0])
            if x.get("type") == "heading" and x.get("attrs", {}).get("level") == 1
        ]
        if len(h1_file_lines) != 1:
            logging.warning("Malformed content: Could not find the title heading.")
            return None

        return h1_file_lines[0]

    @classmethod
    def _get_first_h2_index(cls, ast: TYPE_AST) -> Optional[int]:
        h2_file_lines = [
            i
            for i, x in enumerate(ast[0])
            if x.get("type") == "heading" and x.get("attrs", {}).get("level") == 2
        ]
        if len(h2_file_lines) < 1:
            logging.warning("Malformed content: Could not find the title heading.")
            return None

        return h2_file_lines[0]

    @classmethod
    @abstractmethod
    def _get_date(cls, metadata: dict, ast: TYPE_AST) -> Optional[date]: ...

    @classmethod
    @abstractmethod
    def _get_statuses(cls, metadata: dict, ast: TYPE_AST) -> Sequence[str]: ...

    @classmethod
    @abstractmethod
    def _get_status(cls, metadata: dict, ast: TYPE_AST) -> Optional[str]: ...

    @classmethod
    @abstractmethod
    def _get_metadata_and_ast(cls, file: str) -> Tuple[Dict[str, Any], TYPE_AST]: ...

    @classmethod
    def _get_id(cls, file_path: Path) -> Optional[int]:
        try:
            return int(file_path.parts[-1][0:4])
        except ValueError:
            return None

    @classmethod
    def _get_deciders(cls, metadata: dict, ast: TYPE_AST) -> Optional[str]:
        return None

    @classmethod
    def _get_consulted(cls, metadata: dict, ast: TYPE_AST) -> Optional[str]:
        return None

    @classmethod
    def _get_informed(cls, metadata: dict, ast: TYPE_AST) -> Optional[str]:
        return None

    @staticmethod
    def _upperfirst(text: str) -> str:
        return text[0].capitalize() + text[1::] if text[0].islower() else text