fix paths 2 and tests

Author: fl1pcoin

osa_tool/operations/docs/community_docs_generation/community.py

@@ -6,12 +6,13 @@
 from osa_tool.core.git.metadata import RepositoryMetadata
 from osa_tool.operations.docs.readme_generation.readme_utils import (
     find_in_repo_tree,
+    resolve_repo_host_and_root_url,
     save_sections,
     to_repo_relative_link,
 )
 from osa_tool.tools.repository_analysis.sourcerank import SourceRank
 from osa_tool.utils.logger import logger
-from osa_tool.utils.utils import osa_project_root, parse_folder_name
+from osa_tool.utils.utils import osa_project_root, resolve_repo_path
 
 
 class CommunityTemplateBuilder:
@@ -25,21 +26,26 @@ def __init__(self, config_manager: ConfigManager, metadata: RepositoryMetadata):
         self.sourcerank = SourceRank(self.config_manager)
         self.metadata = metadata
         self.template_path = os.path.join(osa_project_root(), "docs", "templates", "community.toml")
-        self.url_path = f"https://{self.config_manager.get_git_settings().host_domain}/{self.config_manager.get_git_settings().full_name}/"
+        git = self.config_manager.get_git_settings()
+        self.host, self.url_path = resolve_repo_host_and_root_url(
+            repo_url=self.repo_url,
+            clone_url_http=self.metadata.clone_url_http,
+            host=git.host,
+            host_domain=git.host_domain,
+            full_name=git.full_name,
+        )
         self._template = self.load_template()
 
-        self.repo_root = os.path.join(os.getcwd(), parse_folder_name(self.repo_url))
-        self.repo_path = os.path.join(
-            self.repo_root, "." + self.config_manager.get_git_settings().host
-        )
+        self.repo_root = str(resolve_repo_path(self.repo_url))
+        self.repo_path = self.repo_root if "sourcecraft" in self.host else os.path.join(self.repo_root, f".{self.host}")
         self.code_of_conduct_to_save = os.path.join(self.repo_path, "CODE_OF_CONDUCT.md")
         self.security_to_save = os.path.join(self.repo_path, "SECURITY.md")
         self._setup_paths_depends_on_platform()
 
     def _setup_paths_depends_on_platform(self) -> None:
         """Configures file save paths depending on the platform."""
 
-        if "gitlab" in self.config_manager.get_git_settings().host:
+        if "gitlab" in self.host:
             self.issue_templates_path = os.path.join(self.repo_path, "issue_templates")
             self.merge_request_templates_path = os.path.join(self.repo_path, "merge_request_templates")
             os.makedirs(self.issue_templates_path, exist_ok=True)
@@ -52,26 +58,22 @@ def _setup_paths_depends_on_platform(self) -> None:
             self.vulnerability_disclosure_to_save = os.path.join(
                 self.issue_templates_path, "Vulnerability_Disclosure.md"
             )
-        elif "github" in self.config_manager.get_git_settings().host:
+        elif "github" in self.host:
             self.issue_templates_path = os.path.join(self.repo_path, "ISSUE_TEMPLATE")
             os.makedirs(self.issue_templates_path, exist_ok=True)
             self.pr_to_save = os.path.join(self.repo_path, "PULL_REQUEST_TEMPLATE.md")
             self.docs_issue_to_save = os.path.join(self.issue_templates_path, "DOCUMENTATION_ISSUE.md")
             self.feature_issue_to_save = os.path.join(self.issue_templates_path, "FEATURE_ISSUE.md")
             self.bug_issue_to_save = os.path.join(self.issue_templates_path, "BUG_ISSUE.md")
-        elif "sourcecraft" in self.config_manager.get_git_settings().host:
-            self.code_of_conduct_to_save = os.path.join(self.repo_root, "CODE_OF_CONDUCT.md")
-            self.security_to_save = os.path.join(self.repo_root, "SECURITY.md")
-            self.pr_to_save = os.path.join(self.repo_root, "PULL_REQUEST_TEMPLATE.md")
-            self.docs_issue_to_save = os.path.join(self.repo_root, "DOCUMENTATION_ISSUE.md")
-            self.feature_issue_to_save = os.path.join(self.repo_root, "FEATURE_ISSUE.md")
-            self.bug_issue_to_save = os.path.join(self.repo_root, "BUG_ISSUE.md")
+        elif "sourcecraft" in self.host:
+            self.pr_to_save = os.path.join(self.repo_path, "PULL_REQUEST_TEMPLATE.md")
+            self.docs_issue_to_save = os.path.join(self.repo_path, "DOCUMENTATION_ISSUE.md")
+            self.feature_issue_to_save = os.path.join(self.repo_path, "FEATURE_ISSUE.md")
+            self.bug_issue_to_save = os.path.join(self.repo_path, "BUG_ISSUE.md")
 
     def _local_repo_link(self, pattern: str, *, from_path: str) -> str:
         rel_path = find_in_repo_tree(self.sourcerank.tree, pattern)
         from_dir = os.path.relpath(os.path.dirname(from_path), self.repo_root).replace("\\", "/")
-        if from_dir == ".":
-            from_dir = ""
         return to_repo_relative_link(rel_path, from_dir=from_dir)
 
     def load_template(self) -> dict:
@@ -81,6 +83,12 @@ def load_template(self) -> dict:
         with open(self.template_path, "rb") as file:
             return tomli.load(file)
 
+    def _build_security_repo_reference(self) -> str:
+        """Return a web repository reference or an editable local placeholder."""
+        if self.url_path != ".":
+            return self.url_path.rstrip("/")
+        return f"...{resolve_repo_path(self.repo_url).name}"
+
     def build_code_of_conduct(self) -> bool:
         """
         Generates and saves the CODE_OF_CONDUCT.md file.
@@ -99,13 +107,12 @@ def build_code_of_conduct(self) -> bool:
     def build_pull_request(self) -> bool:
         """Generates and saves the PULL_REQUEST_TEMPLATE.md file."""
         try:
+            contributing_url = ""
             if self.sourcerank.contributing_presence():
                 pattern = r"\b\w*contribut\w*\.(md|rst|txt)$"
                 contributing_url = self._local_repo_link(pattern, from_path=self.pr_to_save)
-            else:
-                contributing_url = "Provide the link"
 
-            content = self._template["pull_request"].format(contributing_url=contributing_url)
+            content = self._template["pull_request"].format(contributing_url=contributing_url or "Provide the link")
             save_sections(content, self.pr_to_save)
             logger.info(f"PULL_REQUEST_TEMPLATE.md successfully generated in folder {os.path.dirname(self.pr_to_save)}")
         except Exception as e:
@@ -195,9 +202,7 @@ def build_security(self) -> bool:
             Has the task been completed successfully
         """
         try:
-            content = self._template[f"security_{self.config_manager.get_git_settings().host}"].format(
-                repo_url=self.repo_url
-            )
+            content = self._template[f"security_{self.host}"].format(repo_url=self._build_security_repo_reference())
             save_sections(content, self.security_to_save)
             logger.info(f"SECURITY.md successfully generated in folder {self.repo_path}")
         except Exception as e:

osa_tool/operations/docs/community_docs_generation/contributing.py

@@ -7,12 +7,13 @@
 from osa_tool.operations.docs.readme_generation.readme_utils import (
     find_in_repo_tree,
     remove_extra_blank_lines,
+    resolve_repo_host_and_root_url,
     save_sections,
     to_repo_relative_link,
 )
 from osa_tool.tools.repository_analysis.sourcerank import SourceRank
 from osa_tool.utils.logger import logger
-from osa_tool.utils.utils import osa_project_root, parse_folder_name
+from osa_tool.utils.utils import osa_project_root, resolve_repo_path
 
 
 class ContributingBuilder:
@@ -26,26 +27,26 @@ def __init__(self, config_manager: ConfigManager, metadata: RepositoryMetadata):
         self.repo_url = self.config_manager.get_git_settings().repository
         self.metadata = metadata
         self.template_path = os.path.join(osa_project_root(), "docs", "templates", "contributing.toml")
-        self.url_path = f"https://{self.config_manager.get_git_settings().host_domain}/{self.config_manager.get_git_settings().full_name}/"
-        self.issues_url = self.url_path + (
-            "tasktracker" if "gitverse" in self.config_manager.get_git_settings().host else "issues"
+        git = self.config_manager.get_git_settings()
+        self.host, self.url_path = resolve_repo_host_and_root_url(
+            repo_url=self.repo_url,
+            clone_url_http=self.metadata.clone_url_http,
+            host=git.host,
+            host_domain=git.host_domain,
+            full_name=git.full_name,
+        )
+        self.issues_url = self.metadata.issues_url or (
+            f"{self.url_path}{'tasktracker' if 'gitverse' in self.host else 'issues'}" if self.url_path != "." else "."
         )
         self._template = self.load_template()
 
-        self.repo_root = os.path.join(os.getcwd(), parse_folder_name(self.repo_url))
-        self.repo_path = os.path.join(
-            self.repo_root, "." + self.config_manager.get_git_settings().host
-        )
+        self.repo_root = str(resolve_repo_path(self.repo_url))
+        self.repo_path = self.repo_root if "sourcecraft" in self.host else os.path.join(self.repo_root, f".{self.host}")
         self.file_to_save = os.path.join(self.repo_path, "CONTRIBUTING.md")
 
-        if "sourcecraft" in self.config_manager.get_git_settings().host:
-            self.file_to_save = os.path.join(self.repo_root, "CONTRIBUTING.md")
-
     def _local_repo_link(self, pattern: str, *, prefer_directory: bool = False) -> str:
         rel_path = find_in_repo_tree(self.sourcerank.tree, pattern, prefer_directory=prefer_directory)
         from_dir = os.path.relpath(os.path.dirname(self.file_to_save), self.repo_root).replace("\\", "/")
-        if from_dir == ".":
-            from_dir = ""
         return to_repo_relative_link(rel_path, from_dir=from_dir)
 
     def load_template(self) -> dict:
@@ -67,7 +68,7 @@ def introduction(self) -> str:
     def guide(self) -> str:
         """Generates the guide section with basic project contribution instructions."""
         return self._template["guide"].format(
-            url=self.url_path,
+            url=self.url_path if self.url_path != "." else "./",
             project_name=self.metadata.name,
             clone_url=self.metadata.clone_url_http or self.url_path,
         )

osa_tool/operations/docs/community_docs_generation/docs_run.py

@@ -25,8 +25,6 @@ def generate_documentation(config_manager: ConfigManager, metadata: RepositoryMe
     events: list[OperationEvent] = []
     generated_files: list[str] = []
     contributing = ContributingBuilder(config_manager, metadata)
-    community = CommunityTemplateBuilder(config_manager, metadata)
-    platform_host = getattr(community, "host", None) or config_manager.get_git_settings().host
 
     try:
         contributing.build()
@@ -36,6 +34,9 @@ def generate_documentation(config_manager: ConfigManager, metadata: RepositoryMe
         logger.error("Failed to generate CONTRIBUTING: %s", repr(e), exc_info=True)
         events.append(OperationEvent(kind=EventKind.FAILED, target="CONTRIBUTING", data={"error": repr(e)}))
 
+    community = CommunityTemplateBuilder(config_manager, metadata)
+    platform_host = community.host
+
     try:
         community.build_code_of_conduct()
         events.append(OperationEvent(kind=EventKind.GENERATED, target="CODE_OF_CONDUCT"))

osa_tool/operations/docs/readme_generation/pipeline/nodes/deterministic_builder.py

@@ -2,6 +2,7 @@
 
 import os
 from datetime import datetime
+from pathlib import Path
 from typing import Any
 
 import requests
@@ -16,12 +17,13 @@
 from osa_tool.operations.docs.readme_generation.readme_utils import (
     build_system_message,
     find_in_repo_tree,
+    resolve_repo_host_and_root_url,
     to_readme_relative_link,
 )
 from osa_tool.tools.repository_analysis.sourcerank import SourceRank
 from osa_tool.utils.logger import logger
 from osa_tool.utils.prompts_builder import PromptBuilder
-from osa_tool.utils.utils import extract_readme_content, osa_project_root, parse_folder_name
+from osa_tool.utils.utils import extract_readme_content, osa_project_root, resolve_repo_path
 
 
 def _load_template() -> dict[str, Any]:
@@ -48,12 +50,39 @@ def __init__(self, context: ReadmeContext) -> None:
         self._tpl = _load_template()
 
         git = self._cm.get_git_settings()
-        self._url_path = f"https://{git.host_domain}/{git.full_name}/"
+        self._host, self._repo_root_url = resolve_repo_host_and_root_url(
+            repo_url=git.repository,
+            clone_url_http=self._meta.clone_url_http,
+            host=git.host,
+            host_domain=git.host_domain,
+            full_name=git.full_name,
+        )
+        self._is_local_repo = Path(git.repository).expanduser().is_dir()
 
     def _local_repo_link(self, pattern: str, *, prefer_directory: bool = False) -> str:
         rel_path = find_in_repo_tree(self._sr.tree, pattern, prefer_directory=prefer_directory)
         return to_readme_relative_link(rel_path)
 
+    def _issues_link(self) -> str:
+        if self._meta.issues_url:
+            return self._meta.issues_url.split("{", 1)[0]
+        if self._repo_root_url != ".":
+            suffix = "tasktracker" if self._host == "gitverse" else "issues"
+            return f"{self._repo_root_url}{suffix}"
+        pattern = r"\bBUG_ISSUE\.(md|rst|txt)$"
+        return self._local_repo_link(pattern)
+
+    def _contributing_link(self) -> str:
+        pattern = r"\b\w*contribut\w*\.(md|rst|txt)$"
+        return self._local_repo_link(pattern)
+
+    def _citation_repository_reference(self) -> str:
+        if self._meta.clone_url_http:
+            return self._meta.clone_url_http.removesuffix(".git")
+        if self._repo_root_url != ".":
+            return self._repo_root_url.rstrip("/")
+        return "REPOSITORY_URL"
+
     def header(self) -> str:
         logger.info("[DeterministicBuilder] Building section: header")
         content = HeaderBuilder(self._cm, self._meta).build_header()
@@ -94,23 +123,23 @@ def documentation(self) -> str:
 
     def contributing(self) -> str:
         logger.info("[DeterministicBuilder] Building section: contributing")
-        discussions_url = self._url_path + "discussions"
-        discussions_enabled = _check_url(discussions_url)
+        discussions_url = f"{self._repo_root_url}discussions" if self._repo_root_url != "." else "."
+        discussions_enabled = discussions_url != "." and _check_url(discussions_url)
         discussions = (
             self._tpl["discussion_section"].format(discussions_url=discussions_url) if discussions_enabled else ""
         )
 
-        issues_url = self._url_path + "issues"
-        issues = self._tpl["issues_section"].format(issues_url=issues_url)
+        issues_url = self._issues_link()
+        issues = self._tpl["issues_section"].format(issues_url=issues_url) if issues_url else ""
 
-        contributing_text = ""
-        has_contributing = self._sr.contributing_presence()
-        if has_contributing:
-            pattern = r"\b\w*contribut\w*\.(md|rst|txt)$"
-            contributing_url = self._local_repo_link(pattern)
-            contributing_text = self._tpl["contributing_section"].format(
+        contributing_url = self._contributing_link() if self._sr.contributing_presence() else ""
+        contributing_text = (
+            self._tpl["contributing_section"].format(
                 contributing_url=contributing_url, name=self._cm.get_git_settings().name
             )
+            if contributing_url
+            else ""
+        )
 
         content = self._tpl["contributing"].format(
             dicsussion_section=discussions,
@@ -120,7 +149,7 @@ def contributing(self) -> str:
         logger.info(
             "[DeterministicBuilder] Section 'contributing' built (discussions=%s, contributing_file=%s)",
             discussions_enabled,
-            has_contributing,
+            bool(contributing_url),
         )
         return content
 
@@ -169,20 +198,30 @@ def citation(self) -> str:
 
         git = self._cm.get_git_settings()
         year = self._meta.created_at.split("-")[0] if self._meta.created_at else str(datetime.now().year)
+        repository_reference = self._citation_repository_reference()
+        if self._is_local_repo and not self._meta.clone_url_http:
+            content = self._tpl["citation"] + self._tpl["citation_v3"].format(
+                owner=self._meta.owner or "",
+                year=year,
+                repo_name=git.name,
+                repository_hint=repository_reference,
+            )
+            logger.info("[DeterministicBuilder] Section 'citation' built from local fallback template")
+            return content
         content = self._tpl["citation"] + self._tpl["citation_v2"].format(
             owner=self._meta.owner or "",
             year=year,
             repo_name=git.name,
-            publisher=git.host_domain,
-            repository_url=git.repository,
+            publisher=git.host_domain or "Repository host",
+            repository_url=repository_reference,
         )
         logger.info("[DeterministicBuilder] Section 'citation' built from fallback template")
         return content
 
     def _extract_citation_from_readme(self) -> str:
         """Ask the shared model_handler to find citations in the existing README."""
         logger.info("[DeterministicBuilder] Checking existing README for citation block")
-        repo_path = os.path.join(os.getcwd(), parse_folder_name(self._cm.get_git_settings().repository))
+        repo_path = str(resolve_repo_path(self._cm.get_git_settings().repository))
         readme_content = extract_readme_content(repo_path)
 
         logger.info("[DeterministicBuilder] Detecting citations in README via LLM...")