Namnn/need per id json

AUTHORS

@@ -35,3 +35,5 @@ Jörg Kreuzberger <[email protected]>
 Duodu Randy <[email protected]>
 
 Christian Wappler <[email protected]>
+
+Nhat Nam Nguen <[email protected]>

docs/builders.rst

@@ -163,3 +163,21 @@ or
 .. hint::
 
     As an alternative, you can set the config option :ref:`needs_build_needumls` to export the needumls files during each build.
+
+
+.. _needs_id_builder:
+
+needs_id
+--------
+.. versionadded:: 1.3.0
+
+The **needs_id** builder exports all found needs and selected filter results to a set json files of each need with the name is ``id`` of need.
+
+The build creates a folder called :ref:``needs_build_json_per_id_path`` and all file json of each need inside the given build-folder.
+
+Usage
++++++
+
+.. code-block:: bash
+
+    sphinx-build -b needs_id source_dir build_dir

docs/changelog.rst

@@ -15,7 +15,7 @@ Released: under development
 * Improvement: Configuration option :ref:`needs_debug_measurement` added, which creates a runtime report
   for debugging purposes.
   (`#917 <https://github.com/useblocks/sphinx-needs/pull/917>`_)
-
+* Improvement: Builder :ref:`NeedsIdBuilder` added, which exports all needs to list json file for each need.
 * Bugfix: Replace hardcoded `index` with config value `root_doc`.
   (`#877 <https://github.com/useblocks/sphinx-needs/pull/877>`_)
 * Bugfix: Fix unbounded memory usage in pickle environment.
@@ -889,3 +889,5 @@ custom css definitions you need to update them.
 * Integrated interaction with the activated plantuml sphinx extension
 
 * Added role **need** to create a reference to a need by giving the id
+
+

docs/conf.py

@@ -379,13 +379,14 @@ def custom_defined_func():
 
 # build needs.json to make permalinks work
 needs_build_json = True
-
+# build needs_json for every needs-id to make detail panel
+needs_build_json_per_id = False
 # Get and maybe set GitHub credentials for services.
 # This is needed as the rate limit for not authenticated users is too low for the amount of requests we
 # need to perform for this documentation
+
 github_username = os.environ.get("GITHUB_USERNAME", "")
 github_token = os.environ.get("GITHUB_TOKEN", "")
-
 if github_username != "" and github_token != "":
     print(f"---> GITHUB: Using as username: {github_username}. length token: {len(github_token)}")
     for service in ["github-issues", "github-prs", "github-commits"]:

docs/configuration.rst

@@ -2338,3 +2338,43 @@ If true, need options like status, tags or links are collapsed and shown only af
 Default value: True
 
 Can be overwritten for each single need by setting :ref:`need_collapse`.
+
+.. _needs_build_json_per_id:
+
+needs_build_json_per_id 
+~~~~~~~~~~~~~~~~~~~~~~~
+Builds list json file for each need, which have name is ``ID`` of need.
+This option works like :ref:`needs_build_json`. 
+
+Default: False
+
+Example:
+
+.. code-block:: python
+
+    needs_build_json_per_id = False
+
+.. hint::
+ The created single json file per need, located in :ref:`needs_build_json_per_id_path` folder. This is e.g ``_build/needs_id/abc_432.json``
+
+.. _needs_build_json_per_id_path:
+
+needs_build_json_per_id_path 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This option sets the location of the set of ``needs.json`` for every needs-id.
+
+Default value: needs_id
+
+Example:
+
+.. code-block:: python
+
+    needs_build_json_per_id_path = "needs_id"
+
+.. hint::
+
+   The created ``needs_id`` folder gets stored in the ``outdir`` of the current builder. The final location is e.g. ``_build/needs_id``
+
+
+

sphinx_needs/builder.py

@@ -1,3 +1,4 @@
+import json
 import os
 from typing import Iterable, Optional, Set
 
@@ -6,6 +7,7 @@
 from sphinx.application import Sphinx
 from sphinx.builders import Builder
 
+from sphinx_needs.filter_common import filter_needs
 from sphinx_needs.logging import get_logger
 from sphinx_needs.needsfile import NeedsList
 from sphinx_needs.utils import unwrap
@@ -43,9 +45,6 @@ def finish(self) -> None:
         # This is needed as needs could have been removed from documentation and if this is the case,
         # removed needs would stay in needs_list, if list gets not cleaned.
         needs_list.wipe_version(version)
-        #
-        from sphinx_needs.filter_common import filter_needs
-
         filter_string = self.app.config.needs_builder_filter
         filtered_needs = filter_needs(self.app, needs, filter_string)
 
@@ -80,7 +79,6 @@ def get_target_uri(self, _docname: str, _typ: Optional[str] = None) -> str:
 
 
 def build_needs_json(app: Sphinx, _exception: Exception) -> None:
-
     env = unwrap(app.env)
 
     if not env.config.needs_build_json:
@@ -158,3 +156,72 @@ def build_needumls_pumls(app: Sphinx, _exception: Exception) -> None:
         needs_builder.set_environment(env)
 
     needs_builder.finish()
+
+
+class NeedsIdBuilder(Builder):
+
+    """Json builder for needs, which creates one single json-file per need"""
+
+    name = "needs_id"
+    format = "json"
+    file_suffix = ".txt"
+    links_suffix = None
+    LIST_KEY_EXCLUSIONS_NEEDS = ["content_node"]
+
+    def write_doc(self, docname: str, doctree: nodes.document) -> None:
+        pass
+
+    def finish(self) -> None:
+        env = unwrap(self.env)
+        needs = env.needs_all_needs.values()
+        needs_build_json_per_id_path = self.app.config.needs_build_json_per_id_path
+        filter_string = self.app.config.needs_builder_filter
+        filtered_needs = filter_needs(self.app, needs, filter_string)
+        needs_id_json_dir = os.path.join(self.outdir, needs_build_json_per_id_path)
+        if not os.path.exists(needs_id_json_dir):
+            os.mkdir(needs_id_json_dir)
+        for need in filtered_needs:
+            needs_id_dict = {}
+            id = need["id"]
+            needs_id_dict[id] = {key: need[key] for key in need if key not in self.LIST_KEY_EXCLUSIONS_NEEDS}
+            try:
+                fname = os.path.join(needs_id_json_dir, f"{id}.json")
+                with open(fname, "w") as f:
+                    json.dump(needs_id_dict, f, indent=4)
+            except Exception as e:
+                log.error(f"Needs-ID Builder {id} error: {e}")
+        log.info("Needs_id successfully exported")
+
+    def get_outdated_docs(self) -> Iterable[str]:
+        return []
+
+    def prepare_writing(self, _docnames: Set[str]) -> None:
+        pass
+
+    def write_doc_serialized(self, _docname: str, _doctree: nodes.document) -> None:
+        pass
+
+    def cleanup(self) -> None:
+        pass
+
+    def get_target_uri(self, _docname: str, _typ: Optional[str] = None) -> str:
+        return ""
+
+
+def build_needs_id_json(app: Sphinx, _exception: Exception) -> None:
+    env = unwrap(app.env)
+
+    if not env.config.needs_build_json_per_id:
+        return
+
+    # Do not create an additional needs_json for every needs_id, if builder is already "needs_id".
+    if isinstance(app.builder, NeedsIdBuilder):
+        return
+
+    try:
+        needs_id_builder = NeedsIdBuilder(app, env)
+    except TypeError:
+        needs_id_builder = NeedsIdBuilder(app)
+        needs_id_builder.set_environment(env)
+
+    needs_id_builder.finish()

sphinx_needs/needs.py

@@ -12,7 +12,9 @@
 from sphinx_needs.api.configuration import add_extra_option
 from sphinx_needs.builder import (
     NeedsBuilder,
+    NeedsIdBuilder,
     NeedumlsBuilder,
+    build_needs_id_json,
     build_needs_json,
     build_needumls_pumls,
 )
@@ -141,6 +143,7 @@ def setup(app: Sphinx) -> Dict[str, Any]:
 
     app.add_builder(NeedsBuilder)
     app.add_builder(NeedumlsBuilder)
+    app.add_builder(NeedsIdBuilder)
     app.add_config_value(
         "needs_types",
         [
@@ -279,6 +282,9 @@ def setup(app: Sphinx) -> Dict[str, Any]:
     #
     app.add_config_value("needs_debug_measurement", False, "html", types=[dict])
 
+    # add json file per needs_id
+    app.add_config_value("needs_build_json_per_id", False, "html", types=[bool])
+    app.add_config_value("needs_build_json_per_id_path", "needs_id", "html")
     # Define nodes
     app.add_node(Need, html=(html_visit, html_depart), latex=(latex_visit, latex_depart))
     app.add_node(
@@ -374,6 +380,8 @@ def setup(app: Sphinx) -> Dict[str, Any]:
     app.connect("env-updated", install_lib_static_files)
     app.connect("env-updated", install_permalink_file)
 
+    #
+    app.connect("build-finished", build_needs_id_json)
     # This should be called last, so that need-styles can override styles from used libraries
     app.connect("env-updated", install_styles_static_files)
 

tests/doc_test/docs_needs_id_builder/Makefile

@@ -0,0 +1,21 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = needstestdocs
+SOURCEDIR     = .
+BUILDDIR      = _build
+ERRORLOG      = error.log
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" -W --keep-going -w $(ERRORLOG) $(SPHINXOPTS) $(O)