useblocks__sphinx-needs-1102

{
  "status": "ok",
  "stdout": "37:        \"columns\": directives.unchanged_required,\n56:        columns_str = str(self.options.get(\"columns\", \"\"))\n57:        if len(columns_str) == 0:\n58:            columns_str = NeedsSphinxConfig(env.app.config).table_columns\n59:        if isinstance(columns_str, str):\n60:            _columns = [col.strip() for col in re.split(\";|,\", columns_str)]\n62:            _columns = columns_str\n64:        columns = [get_title(col) for col in _columns]\n70:            if len(columns) != len(colwidths_list):\n72:                    f\"Amount of elements in colwidths and columns do not match: \"\n73:                    f\"colwidths: {len(colwidths_list)} and columns: {len(columns)}\"\n95:            \"columns\": columns,\n125:    # Create a link_type dictionary, which keys-list can be easily used to find columns\n171:        tgroup = nodes.tgroup(cols=len(current_needtable[\"columns\"]))\n175:        for index, value in enumerate(current_needtable[\"columns\"]):\n185:        node_columns = []\n186:        for _option, title in current_needtable[\"columns\"]:\n188:            node_columns.append(nodes.entry(\"\", nodes.paragraph(\"\", header_name)))\n190:        tgroup += nodes.thead(\"\", nodes.row(\"\", *node_columns))\n242:            for option, _title in current_needtable[\"columns\"]:\n279:                    for option, _title in current_needtable[\"columns\"]:\n",
  "stderr": "",
  "exit_code": 0
}

{
  "status": "ok",
  "filepath": "sphinx_needs/directives/needtable.py",
  "content": "import re\nfrom typing import Any, Callable, List, Sequence\n\nfrom docutils import nodes\nfrom docutils.parsers.rst import directives\nfrom sphinx.application import Sphinx\n\nfrom sphinx_needs.api.exceptions import NeedsInvalidException\nfrom sphinx_needs.config import NeedsSphinxConfig\nfrom sphinx_needs.data import NeedsInfoType, SphinxNeedsData\nfrom sphinx_needs.debug import measure_time\nfrom sphinx_needs.directives.utils import (\n    get_option_list,\n    get_title,\n    no_needs_found_paragraph,\n    used_filter_paragraph,\n)\nfrom sphinx_needs.filter_common import FilterBase, process_filters\nfrom sphinx_needs.functions.functions import check_and_get_content\nfrom sphinx_needs.utils import add_doc, profile, remove_node_from_tree, row_col_maker\n\n\nclass Needtable(nodes.General, nodes.Element):\n    pass\n\n\nclass NeedtableDirective(FilterBase):\n    \"\"\"\n    Directive present filtered needs inside a table.\n    \"\"\"\n\n    optional_arguments = 1\n    final_argument_whitespace = True\n    option_spec = {\n        \"show_filters\": directives.flag,\n        \"show_parts\": directives.flag,\n        \"columns\": directives.unchanged_required,\n        \"colwidths\": directives.unchanged_required,\n        \"style\": directives.unchanged_required,\n        \"style_row\": directives.unchanged_required,\n        \"style_col\": directives.unchanged_required,\n        \"sort\": directives.unchanged_required,\n        \"class\": directives.unchanged_required,\n    }\n\n    # Update the options_spec with values defined in the FilterBase class\n    option_spec.update(FilterBase.base_option_spec)\n\n    @profile(\"NEEDTABLE_RUN\")\n    def run(self) -> Sequence[nodes.Node]:\n        env = self.env\n\n        targetid = \"needtable-{docname}-{id}\".format(docname=env.docname, id=env.new_serialno(\"needtable\"))\n        targetnode = nodes.target(\"\", \"\", ids=[targetid])\n\n        columns_str = str(self.options.get(\"columns\", \"\"))\n        if len(columns_str) == 0:\n            columns_str = NeedsSphinxConfig(env.app.config).table_columns\n        if isinstance(columns_str, str):\n            _columns = [col.strip() for col in re.split(\";|,\", columns_str)]\n        else:\n            _columns = columns_str\n\n        columns = [get_title(col) for col in _columns]\n\n        colwidths = str(self.options.get(\"colwidths\", \"\"))\n        colwidths_list = []\n        if colwidths:\n            colwidths_list = [int(width.strip()) for width in re.split(\";|,\", colwidths)]\n            if len(columns) != len(colwidths_list):\n                raise NeedsInvalidException(\n                    f\"Amount of elements in colwidths and columns do not match: \"\n                    f\"colwidths: {len(colwidths_list)} and columns: {len(columns)}\"\n                )\n\n        classes = get_option_list(self.options, \"class\")\n\n        style = self.options.get(\"style\", \"\").upper()\n        style_row = self.options.get(\"style_row\", \"\")\n        style_col = self.options.get(\"style_col\", \"\")\n\n        sort = self.options.get(\"sort\", \"id_complete\")\n\n        title = None\n        if self.arguments:\n            title = self.arguments[0]\n\n        # Add the need and all needed information\n        SphinxNeedsData(env).get_or_create_tables()[targetid] = {\n            \"docname\": env.docname,\n            \"lineno\": self.lineno,\n            \"target_id\": targetid,\n            \"caption\": title,\n            \"classes\": classes,\n            \"columns\": columns,\n            \"colwidths\": colwidths_list,\n            \"style\": style,\n            \"style_row\": style_row,\n            \"style_col\": style_col,\n            \"sort\": sort,",
  "start_line": 1,
  "end_line": 100,
  "total_lines": 340,
  "is_truncated": false
}

{
  "status": "ok",
  "filepath": "sphinx_needs/directives/utils.py",
  "content": "import re\nfrom typing import Any, Dict, List, Optional, Tuple\n\nfrom docutils import nodes\nfrom sphinx.environment import BuildEnvironment\n\nfrom sphinx_needs.config import NeedsSphinxConfig\nfrom sphinx_needs.data import NeedsFilteredBaseType, SphinxNeedsData\nfrom sphinx_needs.defaults import TITLE_REGEX\n\n\ndef no_needs_found_paragraph(message: Optional[str]) -> nodes.paragraph:\n    nothing_found = \"No needs passed the filters\" if message is None else message\n    para = nodes.paragraph()\n    para[\"classes\"].append(\"needs_filter_warning\")\n    nothing_found_node = nodes.Text(nothing_found)\n    para += nothing_found_node\n    return para\n\n\ndef used_filter_paragraph(current_needfilter: NeedsFilteredBaseType) -> nodes.paragraph:\n    para = nodes.paragraph()\n    filter_text = \"Used filter:\"\n    filter_text += (\n        \" status(%s)\" % \" OR \".join(current_needfilter[\"status\"]) if len(current_needfilter[\"status\"]) > 0 else \"\"\n    )\n    if len(current_needfilter[\"status\"]) > 0 and len(current_needfilter[\"tags\"]) > 0:\n        filter_text += \" AND \"\n    filter_text += \" tags(%s)\" % \" OR \".join(current_needfilter[\"tags\"]) if len(current_needfilter[\"tags\"]) > 0 else \"\"\n    if (len(current_needfilter[\"status\"]) > 0 or len(current_needfilter[\"tags\"]) > 0) and len(\n        current_needfilter[\"types\"]\n    ) > 0:\n        filter_text += \" AND \"\n    filter_text += (\n        \" types(%s)\" % \" OR \".join(current_needfilter[\"types\"]) if len(current_needfilter[\"types\"]) > 0 else \"\"\n    )\n\n    filter_node = nodes.emphasis(filter_text, filter_text)\n    para += filter_node\n    return para\n\n\ndef get_title(option_string: str) -> Tuple[str, str]:\n    \"\"\"\n    Returns a tuple of uppercase option and calculated title of given option string.\n\n    :param option_string:\n    :return: string\n    \"\"\"\n    if option_string.upper() == \"ID\":\n        return \"ID\", \"ID\"\n    match = re.search(TITLE_REGEX, option_string)\n    if not match:\n        return option_string.upper(), option_string.title().replace(\"_\", \" \")\n\n    option_name = match.group(1)\n    title = match.group(2)\n\n    return option_name.upper(), title\n\n\ndef get_option_list(options: Dict[str, Any], name: str) -> List[str]:\n    \"\"\"\n    Gets and creates a list of a given directive option value in a safe way\n    :param options: List of options\n    :param name: Name of the option\n    :return: List with strings\n    \"\"\"\n    values = str(options.get(name, \"\"))\n    values_list = []\n    if isinstance(values, str):\n        values_list = [value.strip() for value in re.split(\"[;,]\", values)]\n\n    return values_list\n\n\ndef analyse_needs_metrics(env: BuildEnvironment) -> Dict[str, Any]:\n    \"\"\"\n    Function to generate metrics about need objects.\n\n    :param env: Sphinx build environment\n    :return: Dictionary consisting of needs metrics.\n    \"\"\"\n    needs = SphinxNeedsData(env).get_or_create_needs()\n    metric_data: Dict[str, Any] = {\"needs_amount\": len(needs)}\n    needs_types = {i[\"directive\"]: 0 for i in NeedsSphinxConfig(env.config).types}\n\n    for i in needs.values():\n        if i[\"type\"] in needs_types:\n            needs_types[i[\"type\"]] += 1\n\n    metric_data[\"needs_types\"] = {i[0]: i[1] for i in sorted(needs_types.items(), key=lambda x: x[0])}\n    return metric_data\n\n\nclass SphinxNeedsLinkTypeException(BaseException):\n    \"\"\"Raised if problems with link types happen\"\"\"",
  "start_line": 1,
  "end_line": 97,
  "total_lines": 97,
  "is_truncated": false
}

{
  "status": "ok",
  "filepath": "sphinx_needs/defaults.py",
  "content": "import os\nfrom typing import Any, Dict\n\nfrom docutils.parsers.rst import directives\n\nDEFAULT_DIAGRAM_TEMPLATE = \"\"\"\n{%- if is_need -%}\n<size:12>{{type_name}}</size>\\\\n**{{title|wordwrap(15, wrapstring='**\\\\\\\\n**')}}**\\\\n<size:10>{{id}}</size>\n{%- else -%}\n<size:12>{{type_name}} (part)</size>\\\\n**{{content|wordwrap(15, wrapstring='**\\\\\\\\n**')}}**\\\\n<size:10>{{id_parent}}.**{{id}}**</size>\n{%- endif -%}\n\"\"\"\n\nLAYOUT_COMMON_SIDE = {\n    \"side\": ['<<image(\"field:image\", align=\"center\")>>'],\n    \"head\": ['<<meta(\"type_name\")>>: **<<meta(\"title\")>>** <<meta_id()>>'],\n    \"meta\": [\"<<meta_all(no_links=True)>>\", \"<<meta_links_all()>>\"],\n}\n\nLAYOUTS = {\n    \"test\": {\n        \"grid\": \"simple\",\n        \"layout\": {\n            \"head\": [\n                '<<meta(\"type_name\")>>: **<<meta(\"title\")>>** <<meta_id()>>  <<collapse_button(\"meta\", '\n                'collapsed=\"icon:arrow-down-circle\", visible=\"icon:arrow-right-circle\", initial=False)>> '\n            ],\n            \"meta\": [\"<<meta_all(no_links=True)>>\", \"<<meta_links_all()>>\"],\n        },\n    },\n    \"clean\": {\n        \"grid\": \"simple\",\n        \"layout\": {\n            \"head\": [\n                '<<meta(\"type_name\")>>: **<<meta(\"title\")>>** <<meta_id()>>  <<collapse_button(\"meta\", '\n                'collapsed=\"icon:arrow-down-circle\", visible=\"icon:arrow-right-circle\", initial=False)>> '\n            ],\n            \"meta\": [\"<<meta_all(no_links=True)>>\", \"<<meta_links_all()>>\"],\n        },\n    },\n    \"clean_l\": {\"grid\": \"simple_side_left\", \"layout\": LAYOUT_COMMON_SIDE},\n    \"clean_lp\": {\"grid\": \"simple_side_left_partial\", \"layout\": LAYOUT_COMMON_SIDE},\n    \"clean_r\": {\"grid\": \"simple_side_right\", \"layout\": LAYOUT_COMMON_SIDE},\n    \"clean_rp\": {\"grid\": \"simple_side_right_partial\", \"layout\": LAYOUT_COMMON_SIDE},\n    \"complete\": {\n        \"grid\": \"complex\",\n        \"layout\": {\n            \"head_left\": [\n                \"<<meta_id()>>\",\n            ],\n            \"head\": [\n                '<<meta(\"title\")>>',\n            ],\n            \"head_right\": ['<<meta(\"type_name\")>>'],\n            \"meta_left\": ['<<meta_all(no_links=True, exclude=[\"layout\",\"style\"])>>'],\n            \"meta_right\": [\"<<meta_links_all()>>\"],\n            \"footer_left\": [\n                'layout: <<meta(\"layout\")>>',\n            ],\n            \"footer\": [],\n            \"footer_right\": ['style: <<meta(\"style\")>>'],\n        },\n    },\n    \"focus\": {\"grid\": \"content\", \"layout\": {}},\n    \"focus_f\": {\"grid\": \"content_footer\", \"layout\": {\"footer\": [\"<<meta_id()>>\"]}},\n    \"focus_l\": {\"grid\": \"content_side_left\", \"layout\": {\"side\": [\"<<meta_id()>>\"]}},\n    \"focus_r\": {\"grid\": \"content_side_right\", \"layout\": {\"side\": [\"<<meta_id()>>\"]}},\n    \"debug\": {\n        \"grid\": \"simple\",\n        \"layout\": {\n            \"head\": [\n                '<<meta_id()>> **<<meta(\"title\")>>**',\n                '**<<collapse_button(\"meta\", collapsed=\"Debug view on\", visible=\"Debug view off\", initial=True)>>**',\n            ],\n            \"meta\": [\"<<meta_all(exclude=[], defaults=False, show_empty=True)>>\"],\n        },\n    },\n}\n\nNEEDFLOW_CONFIG_DEFAULTS = {\n    \"mixing\": \"\"\"\n        allowmixing\n    \"\"\",\n    \"monochrome\": \"\"\"\n        skinparam monochrome true\n    \"\"\",\n    \"handwritten\": \"\"\"\n        skinparam handwritten true\n    \"\"\",\n    \"lefttoright\": \"\"\"\n        left to right direction\n    \"\"\",\n    \"toptobottom\": \"\"\"\n        top to bottom direction\n    \"\"\",\n    \"transparent\": \"\"\"\n    skinparam backgroundcolor transparent\n    \"\"\",\n    \"tne\": \"\"\"\n    ' Based on \"Tomorrow night eighties\" color theme (see https://github.com/chriskempson/tomorrow-theme)\n    ' Provided by gabrieljoelc (https://github.com/gabrieljoelc/plantuml-themes)\n    !define Background   #2d2d2d\n    !define CurrentLine  #393939\n    !define Selection    #515151\n    !define Foregound    #cccccc\n    !define Comment      #999999\n    !define Red          #f2777a\n    !define Orange       #f99157\n    !define Yellow       #ffcc66\n    !define Green        #99cc99\n    !define Aqua         #66cccc\n    !define Blue         #6699cc\n    !define Purple       #cc99cc\n\n    skinparam Shadowing false\n    skinparam backgroundColor #2d2d2d\n    skinparam Arrow {\n      Color Foregound\n      FontColor Foregound\n      FontStyle Bold\n    }\n    skinparam Default {\n      FontName Menlo\n      FontColor #fdfdfd\n    }\n    skinparam package {\n      FontColor Purple\n      BackgroundColor CurrentLine\n      BorderColor Selection\n    }\n    skinparam node {\n      FontColor Yellow\n      BackgroundColor CurrentLine\n      BorderColor Selection\n    }\n    skinparam component {\n      BackgroundColor Selection\n      BorderColor Blue\n      FontColor Blue\n      Style uml2\n    }\n    skinparam database {\n      BackgroundColor CurrentLine\n      BorderColor Selection\n      FontColor Orange\n    }\n\n    skinparam cloud {\n      BackgroundColor CurrentLine\n      BorderColor Selection",
  "start_line": 1,
  "end_line": 150,
  "total_lines": 231,
  "is_truncated": true
}

{
  "status": "ok",
  "filepath": "sphinx_needs/defaults.py",
  "content": "    }\n\n    skinparam interface {\n      BackgroundColor CurrentLine\n      BorderColor Selection\n      FontColor Green\n    }\n    \"\"\",\n    \"cplant\": \"\"\"\n    ' CPLANT by AOKI (https://github.com/aoki/cplant)\n    !define BLACK   #363D5D\n    !define RED     #F6363F\n    !define PINK    #F6216E\n    !define MAGENTA #A54FBD\n    !define GREEN   #37A77C\n    !define YELLOW  #F97A00\n    !define BLUE    #1E98F2\n    !define CYAN    #25AFCA\n    !define WHITE   #FEF2DC\n\n    ' Base Setting\n    skinparam Shadowing false\n    skinparam BackgroundColor transparent\n    skinparam ComponentStyle uml2\n    skinparam Default {\n      FontName  'Hiragino Sans'\n      FontColor BLACK\n      FontSize  10\n      FontStyle plain\n    }\n\n    skinparam Sequence {\n      ArrowThickness 1\n      ArrowColor RED\n      ActorBorderThickness 1\n      LifeLineBorderColor GREEN\n      ParticipantBorderThickness 0\n    }\n    skinparam Participant {\n      BackgroundColor BLACK\n      BorderColor BLACK\n      FontColor #FFFFFF\n    }\n\n    skinparam Actor {\n      BackgroundColor BLACK\n      BorderColor BLACK\n    }\n    \"\"\",\n}\n\nTITLE_REGEX = r'([\\w]+) as \"([\\w ]+)\"'\n\n\nNEED_DEFAULT_OPTIONS: Dict[str, Any] = {\n    \"id\": directives.unchanged_required,\n    \"status\": directives.unchanged_required,\n    \"tags\": directives.unchanged_required,\n    \"links\": directives.unchanged_required,\n    \"collapse\": directives.unchanged_required,\n    \"delete\": directives.unchanged,\n    \"jinja_content\": directives.unchanged,\n    \"hide\": directives.flag,\n    \"title_from_content\": directives.flag,\n    \"style\": directives.unchanged_required,\n    \"layout\": directives.unchanged_required,\n    \"template\": directives.unchanged_required,\n    \"pre_template\": directives.unchanged_required,\n    \"post_template\": directives.unchanged_required,\n    \"duration\": directives.unchanged_required,\n    \"completion\": directives.unchanged_required,\n    \"constraints\": directives.unchanged_required,\n    \"constraints_passed\": directives.unchanged_required,\n    \"constraints_results\": directives.unchanged_required,\n}\n\nNEEDEXTEND_NOT_ALLOWED_OPTIONS = [\"id\"]\n\nNEEDS_PROFILING = [x.upper() for x in os.environ.get(\"NEEDS_PROFILING\", \"\").split(\",\")]\n\nNEEDS_TABLES_CLASSES = [\"rtd-exclude-wy-table\", \"no-sphinx-material-strip\"]",
  "start_line": 151,
  "end_line": 231,
  "total_lines": 231,
  "is_truncated": false
}

{
  "status": "ok",
  "stdout": "Input: 'id' | Expected: ('ID', 'ID') | Actual: ('ID', 'ID') | OK\nInput: 'title' | Expected: ('TITLE', 'Title') | Actual: ('TITLE', 'Title') | OK\nInput: 'status-desc as \"Description\"' | Expected: ('STATUS-DESC', 'Description') | Actual: ('DESC', 'Description') | FAIL\nInput: 'status' | Expected: ('STATUS', 'Status') | Actual: ('STATUS', 'Status') | OK\nInput: 'my_option as \"My Option\"' | Expected: ('MY_OPTION', 'My Option') | Actual: ('MY_OPTION', 'My Option') | OK\n",
  "stderr": "",
  "exit_code": 0
}

{
  "status": "ok",
  "stdout": "Old: ('desc', 'Description')\nNew: ('status-desc', 'Description')\nOld 2: ('my_option', 'My Option')\nNew 2: ('my_option', 'My Option')\n",
  "stderr": "",
  "exit_code": 0
}

{
  "status": "ok",
  "stdout": "./sphinx_needs/directives/utils.py:9:from sphinx_needs.defaults import TITLE_REGEX\n./sphinx_needs/directives/utils.py:52:    match = re.search(TITLE_REGEX, option_string)\n./sphinx_needs/defaults.py:202:TITLE_REGEX = r'([\\w]+) as \"([\\w ]+)\"'\n",
  "stderr": "",
  "exit_code": 0
}

{
  "status": "ok",
  "stdout": "Testing Proposal 1:\n'status-desc as \"Description\"' -> ('STATUS-DESC', 'Description') | OK: True\n'my_option as \"My Option\"' -> ('MY_OPTION', 'My Option') | OK: True\n'id' -> ('ID', 'Id') | OK: False\n'status' -> ('STATUS', 'Status') | OK: True\n'complex-option_1 as \"Complex Title\"' -> ('COMPLEX-OPTION_1', 'Complex Title') | OK: True\n\nTesting Proposal 2:\n'status-desc as \"Description\"' -> ('STATUS-DESC', 'Description') | OK: True\n'my_option as \"My Option\"' -> ('MY_OPTION', 'My Option') | OK: True\n'id' -> ('ID', 'Id') | OK: False\n'status' -> ('STATUS', 'Status') | OK: True\n'complex-option_1 as \"Complex Title\"' -> ('COMPLEX-OPTION_1', 'Complex Title') | OK: True\n",
  "stderr": "",
  "exit_code": 0
}

{
  "status": "ok",
  "stdout": "Input: 'id' | Expected: ('ID', 'ID') | Actual: ('ID', 'ID') | OK\nInput: 'status' | Expected: ('STATUS', 'Status') | Actual: ('STATUS', 'Status') | OK\nInput: 'status-desc as \"Description\"' | Expected: ('STATUS-DESC', 'Description') | Actual: ('STATUS-DESC', 'Description') | OK\nInput: 'my_option as \"My Option\"' | Expected: ('MY_OPTION', 'My Option') | Actual: ('MY_OPTION', 'My Option') | OK\nInput: 'complex.option as \"Complex Title!\"' | Expected: ('COMPLEX.OPTION', 'Complex Title!') | Actual: ('COMPLEX.OPTION', 'Complex Title!') | OK\nInput: '  status-desc as \"Description\"  ' | Expected: ('  STATUS-DESC AS \"DESCRIPTION\"  ', '  Status-Desc As \"Description\"  ') | Actual: ('  STATUS-DESC AS \"DESCRIPTION\"  ', '  Status-Desc As \"Description\"  ') | OK\n",
  "stderr": "",
  "exit_code": 0
}

{
  "status": "ok",
  "filepath": "sphinx_needs/defaults.py",
  "occurrences": 1,
  "strategy": "exact",
  "diff": "--- a/sphinx_needs/defaults.py\n+++ b/sphinx_needs/defaults.py\n@@ -199,7 +199,7 @@\n     \"\"\",\n }\n \n-TITLE_REGEX = r'([\\w]+) as \"([\\w ]+)\"'\n+TITLE_REGEX = r'^(.+) as \"(.+)\"'\n \n \n NEED_DEFAULT_OPTIONS: Dict[str, Any] = {\n",
  "is_truncated": false
}