Expose inventory

Author: oprypin

mkdocstrings/handlers/crystal/__init__.py

@@ -2,12 +2,13 @@
 
 from mkdocstrings.handlers.base import BaseHandler
 
+from . import inventory
 from .collector import CrystalCollector
 from .renderer import CrystalRenderer
 
 
 class CrystalHandler(BaseHandler):
-    pass
+    load_inventory = staticmethod(inventory.list_object_urls)
 
 
 def get_handler(

mkdocstrings/handlers/crystal/collector.py

@@ -1,7 +1,6 @@
 import collections
 import dataclasses
 import functools
-import json
 import logging
 import os
 import re
@@ -14,6 +13,7 @@
 from cached_property import cached_property
 from mkdocstrings.handlers.base import BaseCollector, CollectionError
 
+from . import inventory
 from .items import DocConstant, DocItem, DocLocation, DocMapping, DocMethod, DocModule, DocType
 
 try:
@@ -68,9 +68,8 @@ def root(self) -> "DocRoot":
         """The top-level namespace, represented as a fake module."""
         try:
             with self._proc:
-                data = json.load(self._proc.stdout)
-            data["program"]["full_name"] = ""
-            root = DocRoot(data["program"], None, None)
+                root = inventory.read(self._proc.stdout)
+            root.__class__ = DocRoot
             root.source_locations = self._source_locations
             return root
         finally:

mkdocstrings/handlers/crystal/inventory.py

@@ -0,0 +1,40 @@
+import itertools
+import json
+import posixpath
+
+from .items import DocModule
+
+
+def read(file) -> DocModule:
+    data = json.load(file)
+    data["program"]["full_name"] = ""
+    return DocModule(data["program"], None, None)
+
+
+def list_objects(obj):
+    path = obj.data["path"]
+
+    if obj.full_name:
+        yield obj.abs_id, path
+
+    for const in obj.constants:
+        yield const.abs_id, path + "#" + const.name
+
+    for meth in itertools.chain(
+        obj.constructors, obj.class_methods, obj.instance_methods, obj.macros
+    ):
+        yield meth.abs_id, path + "#" + meth.data["html_id"]
+
+    for typ in obj.types:
+        yield from list_objects(typ)
+
+
+def list_object_urls(file, url="", base_url=None, **kwargs):
+    if base_url is None:
+        if url.endswith("/index.json"):
+            base_url = url[: -len("/index.json")]
+        else:
+            base_url = url
+
+    for abs_id, path in list_objects(read(file)):
+        yield abs_id, posixpath.join(base_url, path)