wip: refactor load_component logic

Author: pedro-psb

src/pulp_docs/plugin.py

@@ -45,6 +45,7 @@ class Component:
     git_url: str
     rest_api: str
 
+    version: str
     repository_dir: Path
     component_dir: Path
 
@@ -58,11 +59,19 @@ def build(cls, find_path: list[str], component_opt: ComponentOption):
         for dir in expanded_path:
             dir = Path(dir)
             component_dir = dir.parent / component_opt.path
-            if repository_name == dir.name and component_dir.exists():
+            found_dir = repository_name == dir.name and component_dir.exists()
+            if found_dir:
+                version = "unknown"
+                try:
+                    pyproject = component_dir / "pyproject.toml"
+                    version = tomllib.loads(pyproject.read_text())["project"]["version"]
+                except Exception:
+                    pass
+                body["version"] = version
                 body["repository_dir"] = dir
                 body["component_dir"] = component_dir
                 return cls(**body)
-        raise None
+        return None
 
 
 class PulpDocsPluginConfig(Config):
@@ -211,12 +220,6 @@ def component_data(
     component_dir = component.component_dir
     path = component_dir.name
 
-    version = "unknown"
-    try:
-        pyproject = component_dir / "pyproject.toml"
-        version = tomllib.loads(pyproject.read_text())["project"]["version"]
-    except Exception:
-        pass
     github_org = "pulp"
     try:
         template_config = component_dir / "template_config.yml"
@@ -234,7 +237,7 @@ def component_data(
     return {
         "title": f"[{component.title}](site:{path}/)",
         "kind": component.kind,
-        "version": version,
+        "version": component.version,
         "links": links,
     }
 
@@ -255,35 +258,49 @@ def rss_items() -> list:
     return rss_feed["items"][:20]
 
 
+def load_components(find_path: list[str], config: MkDocsConfig, draft: bool):
+    loaded_components = []
+    for component_opt in config.components:
+        component = Component.build(find_path, component_opt)
+        if component:
+            loaded_components.append(component)
+    all_components = {o.path for o in config.components}
+    not_loaded_components = all_components.difference(
+        {o.path for o in loaded_components}
+    )
+    if not_loaded_components:
+        if draft:
+            log.warning(f"Skip missing components {not_loaded_components}.")
+        else:
+            raise PluginError(f"Components missing: {not_loaded_components}.")
+    return loaded_components
+
+
 class PulpDocsPlugin(BasePlugin[PulpDocsPluginConfig]):
     def on_config(self, config: MkDocsConfig) -> MkDocsConfig | None:
-        # Two directories up from docs is where we expect all the other repositories.
         self.blog = ctx_blog.get()
         self.docstrings = ctx_docstrings.get()
         self.draft = ctx_draft.get()
 
         self.pulp_docs_dir = Path(config.docs_dir).parent
+        # Two directories up from docs is where we expect all the other repositories by default.
         self.find_path = ctx_path.get() or [f"{self.pulp_docs_dir.parent}/*"]
 
+        loaded_components = load_components(self.find_path, self.config, self.draft)
+        self.config.components = loaded_components
+
+        log.info(
+            f"Using components={[str(c.component_dir) for c in loaded_components]}"
+        )
+
         mkdocstrings_config = config.plugins["mkdocstrings"].config
         components_var = []
-        new_components = []
-        for component_opt in self.config.components:
-            component = Component.build(self.find_path, component_opt)
-            if component:
-                components_var.append(component_data(component))
-                config.watch.append(str(component.component_dir / "docs"))
-                mkdocstrings_config.handlers["python"]["paths"].append(
-                    str(component.component_dir)
-                )
-                new_components.append(component)
-            else:
-                if self.draft:
-                    log.warning(f"Skip missing component '{component.title}'.")
-                else:
-                    raise PluginError(f"Component '{component.title}' missing.")
-        self.config.components = new_components
-        log.info(f"Using components={[str(c.component_dir) for c in new_components]}")
+        for component in self.config.components:
+            components_var.append(component_data(component))
+            config.watch.append(str(component.component_dir / "docs"))
+            mkdocstrings_config.handlers["python"]["paths"].append(
+                str(component.component_dir)
+            )
 
         macros_plugin = config.plugins["macros"]
         macros_plugin.register_macros({"rss_items": rss_items})