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:: 0.1.30
+
+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,8 +379,8 @@ def custom_defined_func():
 
 # build needs.json to make permalinks work
 needs_build_json = True
-# build needs per id
-needs_per_id = True
+# build needs_json for every needs-id to make detail panel
+needs_build_json_per_id = True
 # 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

docs/configuration.rst

@@ -2339,23 +2339,40 @@ Default value: True
 
 Can be overwritten for each single need by setting :ref:`need_collapse`.
 
-.. _needs_per_id_build_path:
+.. _needs_build_json_per_id_path:
 
-needs_per_id_build_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:
 
-.. _needs_per_id:
+.. code-block:: python
 
-needs_per_id 
-~~~~~~~~~~~~~~~~
+    needs_build_json_per_id_path = "needs_id"
 
-Exports forder ``needs_per_id_build_path`` include all file ``needs.json`` for every 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``
 
-This option works like needs_build_json. 
+.. _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``
+

sphinx_needs/builder.py

@@ -79,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:
@@ -160,6 +159,9 @@ def build_needumls_pumls(app: Sphinx, _exception: Exception) -> None:
 
 
 class NeedsIdBuilder(Builder):
+
+    """Json builder for needs, which creates one single json-file per need"""
+
     name = "needs_id"
     format = "json"
     file_suffix = ".txt"
@@ -172,10 +174,10 @@ def write_doc(self, docname: str, doctree: nodes.document) -> None:
     def finish(self) -> None:
         env = unwrap(self.env)
         needs = env.needs_all_needs.values()
-        needs_per_id_build_path = self.app.config.needs_per_id_build_path
+        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_per_id_build_path)
+        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:
@@ -187,7 +189,7 @@ def finish(self) -> None:
                 with open(fname, "w") as f:
                     json.dump(needs_id_dict, f, indent=4)
             except Exception as e:
-                log.error(f"Error during writing json file: {e}_{id}")
+                log.error(f"Needs-ID Builder {id} error: {e}")
         log.info("Needs_id successfully exported")
 
     def get_outdated_docs(self) -> Iterable[str]:
@@ -209,7 +211,7 @@ def get_target_uri(self, _docname: str, _typ: Optional[str] = None) -> str:
 def build_needs_id_json(app: Sphinx, _exception: Exception) -> None:
     env = unwrap(app.env)
 
-    if not env.config.needs_per_id:
+    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".

sphinx_needs/needs.py

@@ -283,8 +283,8 @@ 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_per_id", False, "html", types=[bool])
-    app.add_config_value("needs_per_id_build_path", "needs_id", "html")
+    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(

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)

tests/doc_test/docs_needs_id_builder/conf.py

@@ -0,0 +1,162 @@
+#
+# needs test docs documentation build configuration file, created by
+# sphinx-quickstart on Tue Mar 28 11:37:14 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../../sphinxcontrib"))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+
+extensions = ["sphinx_needs"]
+
+needs_table_style = "TABLE"
+
+
+needs_types = [
+    {"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
+    {"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
+    {"directive": "impl", "title": "Implementation", "prefix": "IM_", "color": "#DF744A", "style": "node"},
+    {"directive": "test", "title": "Test Case", "prefix": "TC_", "color": "#DCB239", "style": "node"},
+]
+
+plantuml = "java -jar %s" % os.path.join(os.path.dirname(__file__), "..", "utils", "plantuml.jar")
+plantuml_output_format = "svg"
+
+needs_file = "custom_needs_test.json"
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+project = "needs test docs"
+copyright = "2017, team useblocks"
+author = "team useblocks"
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = "1.0"
+# The full version, including alpha/beta/rc tags.
+release = "1.0"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "alabaster"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ["_static"]
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "needstestdocsdoc"
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, "needstestdocs.tex", "needs test docs Documentation", "team useblocks", "manual"),
+]
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, "needstestdocs", "needs test docs Documentation", [author], 1)]
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        "needstestdocs",
+        "needs test docs Documentation",
+        author,
+        "needstestdocs",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
+]

tests/doc_test/docs_needs_id_builder/index.rst

@@ -0,0 +1,14 @@
+TEST DOCUMENT NEEDS Builder
+===========================
+
+.. story:: A story
+   :status: in progress
+   :tags: 1
+
+.. test:: Test example
+    :id: TC_001
+    :status: open
+
+.. test:: Negative test example
+    :id: TC_NEG_001
+    :status: closed