ara-cli 0.1.9.61__py3-none-any.whl → 0.1.9.62__py3-none-any.whl

ara_cli/__main__.py

@@ -18,7 +18,8 @@ from ara_cli.ara_command_action import (
     set_status_action,
     set_user_action,
     classifier_directory_action,
-    scan_action
+    scan_action,
+    autofix_action
 )
 import argcomplete
 import sys
@@ -42,7 +43,8 @@ def define_action_mapping():
         "set-status": set_status_action,
         "set-user": set_user_action,
         "classifier-directory": classifier_directory_action,
-        "scan": scan_action
+        "scan": scan_action,
+        "autofix": autofix_action
     }
 
 

ara_cli/ara_command_action.py

@@ -538,3 +538,27 @@ def scan_action(args):
         if invalid:
             invalid_artefacts[classifier] = invalid
     show_results(invalid_artefacts)
+
+
+def autofix_action(args):
+    from ara_cli.artefact_autofix import parse_report, apply_autofix, read_report_file
+
+    content = read_report_file()
+
+    if not content:
+        return False
+
+    issues = parse_report(content)
+
+    if not issues:
+        print("No issues found in the report. Nothing to fix.")
+        return
+
+    # print("Found issues to fix:")
+    for classifier, files in issues.items():
+        print(f"\nClassifier: {classifier}")
+        for file_path, reason in files:
+            print(f"Attempting to fix {file_path} for reason: {reason}")
+            apply_autofix(file_path, classifier, reason)
+
+    print("\nAutofix process completed. Please review the changes.")

ara_cli/ara_command_parser.py

@@ -220,6 +220,10 @@ def scan_parser(subparsers):
     subparsers.add_parser("scan", help="Scan ARA tree for incompatible artefacts.")
 
 
+def autofix_parser(subparsers):
+    subparsers.add_parser("autofix", help="Fix ARA tree with llm models for scanned artefacts with ara scan command.")
+
+
 class CustomHelpFormatter(argparse.HelpFormatter):
     def format_help(self):
         from sys import argv
@@ -307,5 +311,6 @@ def action_parser():
     set_user_parser(subparsers)
     classifier_directory_parser(subparsers)
     scan_parser(subparsers)
+    autofix_parser(subparsers)
 
     return parser

ara_cli/artefact_autofix.py

@@ -0,0 +1,134 @@
+def read_report_file():
+    file_path = "incompatible_artefacts_report.md"
+    try:
+        with open(file_path, "r", encoding="utf-8") as f:
+            content = f.read()
+    except OSError:
+        print('Artefact scan results file not found. Did you run the "ara scan" command?')
+        return
+
+    return content
+
+
+def parse_report(content: str) -> dict:
+    """
+    Parses the incompatible artefacts report and returns structured data.
+    Returns a dictionary where keys are artefact classifiers, and values are lists of (file_path, reason) tuples.
+    """
+    lines = content.splitlines()
+    issues = {}
+    current_classifier = None
+
+    if not lines or lines[0] != "# Artefact Check Report":
+        return issues  # Geçersiz rapor formatı
+
+    if len(lines) >= 3 and lines[2] == "No problems found.":
+        return issues  # Hiç sorun bulunamadı
+
+    for line in lines[1:]:  # Başlıktan sonraki satırları işle
+        line = line.strip()
+        if not line:
+            continue
+
+        # Classifier başlığı tespiti (## ile başlayan)
+        if line.startswith("## "):
+            current_classifier = line[3:].strip()
+            issues[current_classifier] = []
+
+        # Dosya listesi tespiti (- ile başlayan)
+        elif line.startswith("- ") and current_classifier is not None:
+            # Format: "- `file_path`: reason"
+            parts = line.split("`", 2)
+            if len(parts) < 3:
+                continue  # Geçersiz format
+
+            file_path = parts[1]
+            reason = parts[2].split(
+                ":", 1)[1].strip() if ":" in parts[2] else ""
+            issues[current_classifier].append((file_path, reason))
+
+    return issues
+
+
+def read_artefact(file_path):
+    """Reads the artefact text from the given file path."""
+    try:
+        with open(file_path, 'r') as file:
+            return file.read()
+    except FileNotFoundError:
+        print(f"File not found: {file_path}")
+        return None
+
+
+def determine_artefact_type_and_class(classifier):
+    from ara_cli.artefact_models.artefact_mapping import artefact_type_mapping
+    from ara_cli.artefact_models.artefact_model import ArtefactType
+
+    try:
+        artefact_type = ArtefactType(classifier)
+    except ValueError:
+        print(f"Invalid classifier: {classifier}")
+        return None, None
+
+    artefact_class = artefact_type_mapping.get(artefact_type)
+    if not artefact_class:
+        print(f"No artefact class found for {artefact_type}")
+        return None, None
+
+    return artefact_type, artefact_class
+
+
+def construct_prompt(artefact_type, reason, file_path, artefact_text):
+    from ara_cli.artefact_models.artefact_model import ArtefactType
+
+    prompt = (
+        f"Correct the following {artefact_type} artefact to fix the issue: {reason}. "
+        f"Provide the complete, corrected artefact. Don't change the artefact's content, "
+        f"just fix the pydantic model errors. You should follow the name of the file "
+        f"from its path {file_path} for naming the arteafact's title. The current artefact is:\n{artefact_text}"
+    )
+
+    if artefact_type == ArtefactType.task:
+        prompt += (
+            "\nFor task artefacts, if the action items looks like template or empty "
+            "then just delete those action items."
+            "\nFor user tag it should be '@user_{username}'. So you should be careful to "
+            "not make it @user_user_{username}"
+        )
+
+    return prompt
+
+
+def run_agent(prompt, artefact_class):
+    from pydantic_ai import Agent
+
+    agent = Agent(model="openai:gpt-4o",
+                  result_type=artefact_class, instrument=True)
+    result = agent.run_sync(prompt)
+    return result.data
+
+
+def write_corrected_artefact(file_path, corrected_text):
+    with open(file_path, 'w') as file:
+        file.write(corrected_text)
+    print(f"Fixed artefact at {file_path}")
+
+
+def apply_autofix(file_path, classifier, reason):
+    artefact_text = read_artefact(file_path)
+    if artefact_text is None:
+        return
+
+    artefact_type, artefact_class = determine_artefact_type_and_class(
+        classifier)
+    if artefact_type is None or artefact_class is None:
+        return
+
+    prompt = construct_prompt(artefact_type, reason, file_path, artefact_text)
+
+    try:
+        corrected_artefact = run_agent(prompt, artefact_class)
+        corrected_text = corrected_artefact.serialize()
+        write_corrected_artefact(file_path, corrected_text)
+    except Exception as e:
+        print(f"Failed to fix artefact at {file_path}: {e}")

ara_cli/tests/test_ara_autofix.py

@@ -0,0 +1,113 @@
+import pytest
+from unittest.mock import patch, mock_open, MagicMock
+from ara_cli.artefact_autofix import (
+    read_report_file,
+    parse_report,
+    apply_autofix,
+    read_artefact,
+    determine_artefact_type_and_class,
+    run_agent,
+    write_corrected_artefact
+)
+from ara_cli.ara_command_action import autofix_action
+
+
+def test_read_report_file():
+    mock_content = "# Artefact Check Report\n\n## classifier\n- `file_path`: reason\n"
+    with patch("builtins.open", mock_open(read_data=mock_content)) as m:
+        content = read_report_file()
+        assert content == mock_content
+        m.assert_called_once_with(
+            "incompatible_artefacts_report.md", "r", encoding="utf-8")
+
+
+def test_parse_report():
+    content = "# Artefact Check Report\n\n## classifier\n- `file_path`: reason\n"
+    expected_issues = {"classifier": [("file_path", "reason")]}
+    issues = parse_report(content)
+    assert issues == expected_issues
+
+
+@patch("ara_cli.artefact_autofix.run_agent")
+@patch("ara_cli.artefact_autofix.write_corrected_artefact")
+def test_apply_autofix(mock_write_corrected_artefact, mock_run_agent):
+    mock_run_agent.return_value.serialize.return_value = "corrected content"
+    with patch("ara_cli.artefact_autofix.read_artefact", return_value="artefact text"):
+        with patch("ara_cli.artefact_autofix.determine_artefact_type_and_class", return_value=("ArtefactType", MagicMock())):
+            apply_autofix("file_path", "classifier", "reason")
+            mock_run_agent.assert_called_once()
+            mock_write_corrected_artefact.assert_called_once_with(
+                "file_path", "corrected content")
+
+
+@patch("ara_cli.artefact_autofix.apply_autofix")
+@patch("ara_cli.artefact_autofix.parse_report")
+@patch("ara_cli.artefact_autofix.read_report_file")
+def test_autofix_action(mock_read_report_file, mock_parse_report, mock_apply_autofix, capsys):
+    mock_read_report_file.return_value = "# Artefact Check Report\n\n## classifier\n- `file_path`: reason\n"
+    mock_parse_report.return_value = {"classifier": [("file_path", "reason")]}
+
+    args = MagicMock()
+    autofix_action(args)
+
+    captured = capsys.readouterr()
+    assert "Attempting to fix file_path for reason: reason" in captured.out
+    mock_apply_autofix.assert_called_once_with(
+        "file_path", "classifier", "reason")
+
+
+def test_read_artefact():
+    mock_content = "artefact content"
+    with patch("builtins.open", mock_open(read_data=mock_content)) as m:
+        content = read_artefact("file_path")
+        assert content == mock_content
+        m.assert_called_once_with("file_path", "r")
+
+
+def test_read_report_file_not_found(capsys):
+    with patch("builtins.open", side_effect=OSError("File not found")):
+        content = read_report_file()
+        captured = capsys.readouterr()
+        assert content is None
+        assert "Artefact scan results file not found" in captured.out
+
+
+def test_parse_report_no_issues():
+    content = "# Artefact Check Report\n\nNo problems found.\n"
+    issues = parse_report(content)
+    assert issues == {}
+
+
+def test_parse_report_invalid_format():
+    content = "Invalid Format"
+    issues = parse_report(content)
+    assert issues == {}
+
+
+def test_determine_artefact_type_and_class_invalid():
+    artefact_type, artefact_class = determine_artefact_type_and_class(
+        "invalid_classifier")
+    assert artefact_type is None
+    assert artefact_class is None
+
+
+def test_write_corrected_artefact():
+    corrected_content = "corrected content"
+    with patch("builtins.open", mock_open()) as m:
+        write_corrected_artefact("file_path", corrected_content)
+        m.assert_called_once_with("file_path", "w")
+        handle = m()
+        handle.write.assert_called_once_with(corrected_content)
+
+
+@patch("ara_cli.artefact_autofix.read_artefact", return_value=None)
+def test_apply_autofix_file_not_found(mock_read_artefact):
+    apply_autofix("file_path", "classifier", "reason")
+    mock_read_artefact.assert_called_once_with("file_path")
+
+
+@patch("pydantic_ai.Agent")
+def test_run_agent_exception_handling(mock_agent):
+    mock_agent.return_value.run_sync.side_effect = Exception("Agent error")
+    with pytest.raises(Exception, match="Agent error"):
+        run_agent("prompt", MagicMock())

ara_cli/tests/test_ara_command_action.py

@@ -11,7 +11,8 @@ from ara_cli.ara_command_action import (
     set_status_action,
     set_user_action,
     classifier_directory_action,
-    scan_action
+    scan_action,
+    autofix_action
 )
 
 

ara_cli/version.py

@@ -1,2 +1,2 @@
 # version.py
-__version__ = "0.1.9.61"   # fith parameter like .0 for local install test purposes only. official numbers should be 4 digit numbers
+__version__ = "0.1.9.62"   # fith parameter like .0 for local install test purposes only. official numbers should be 4 digit numbers

{ara_cli-0.1.9.61.dist-info → ara_cli-0.1.9.62.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ara_cli
-Version: 0.1.9.61
+Version: 0.1.9.62
 Requires-Dist: litellm
 Requires-Dist: llama-index
 Requires-Dist: llama-index-llms-openai
@@ -12,4 +12,5 @@ Requires-Dist: argparse
 Requires-Dist: argcomplete
 Requires-Dist: cmd2>=2.5
 Requires-Dist: pydantic
+Requires-Dist: pydantic_ai
 Dynamic: requires-dist

{ara_cli-0.1.9.61.dist-info → ara_cli-0.1.9.62.dist-info}/RECORD

@@ -1,9 +1,9 @@
 ara_cli/__init__.py,sha256=0zl7IegxTid26EBGLav_fXZ4CCIV3H5TfAoFQiOHjvg,148
-ara_cli/__main__.py,sha256=3fYaQUcudgjqtJa2gj2LoYnhy-Wy1OfZIfXEYQf4m0U,1806
-ara_cli/analyse_artefacts.py,sha256=JwA2zxkCy8vNOHoU9f3TICJesXRRXndHi2hT5m_uQ8Q,4965
-ara_cli/ara_command_action.py,sha256=OsmNJ9XHVMPveVO0kxlYNU5vR16bX9Sn7mGKaOieZqg,18925
-ara_cli/ara_command_parser.py,sha256=HluFJimQbxS_yuZ2IzLcsfUPrmIJbKJB71YvsGiUXQE,16883
+ara_cli/__main__.py,sha256=Z6XYWRLceIoZPvfC-X9EXouSZdtFOOe84kKVWJGA4r4,1861
+ara_cli/ara_command_action.py,sha256=a2NP1cfWnqSkWWGFG_7iMkIkkOTYd83e_kWzdNyKDTI,19618
+ara_cli/ara_command_parser.py,sha256=qsPo1nsln-vdQUGykH2Zaa3-f1gqcf3c-td0WwSn4r0,17067
 ara_cli/ara_config.py,sha256=_Arkr-b9XnrNHbBlFKb9tAo3OmdP4ZZiWvbY9m6Sbo0,4178
+ara_cli/artefact_autofix.py,sha256=If9a7C6B2i7hpyquQ4pDGCUtXvmHVhFkjF2I0QtqaLg,4533
 ara_cli/artefact_creator.py,sha256=mkxKHkVIK2GdmUrKHAjKvhq66eg21S3x_cvK1ZA9DPw,5964
 ara_cli/artefact_deleter.py,sha256=Co4wwCH3yW8H9NrOq7_2p5571EeHr0TsfE-H8KqoOfY,1900
 ara_cli/artefact_fuzzy_search.py,sha256=XAvoiRafd1u21uKbX5-bow7hdq7uiLLy1KtxHNAFbCk,1337
@@ -31,7 +31,7 @@ ara_cli/run_file_lister.py,sha256=XbrrDTJXp1LFGx9Lv91SNsEHZPP-PyEMBF_P4btjbDA,23
 ara_cli/tag_extractor.py,sha256=R5T103Y60NppYifKV7b8KoI5kE1M66fULz6f_Fdc9VU,1081
 ara_cli/template_manager.py,sha256=YXPj2jGNDb-diIHFEK_vGJ-ZucodnXSGAPofKTnOofI,6633
 ara_cli/update_config_prompt.py,sha256=PZgNIN3dTw6p80GyX8Sp5apkAhSoykwnkEbHo3IOkUo,4571
-ara_cli/version.py,sha256=UnoKKtqPp3m-W25FpDjhgC_5DzQxM2ExEc0zhVw6wiA,146
+ara_cli/version.py,sha256=UDea-52RJGs95q2okzxXLTnZ6sNY38mCpNb6vavgKKU,146
 ara_cli/artefact_models/artefact_load.py,sha256=dNcwZDW2Dk0bts9YnPZ0ESmWD2NbsLIvl4Z-qQeGmTQ,401
 ara_cli/artefact_models/artefact_mapping.py,sha256=8aD0spBjkJ8toMAmFawc6UTUxB6-tEEViZXv2I-r88Q,1874
 ara_cli/artefact_models/artefact_model.py,sha256=vV-Hhtl6DwVt7qcFTnxxr_WqyTZnKtkFU-nryVnTbUg,14853
@@ -130,7 +130,8 @@ ara_cli/templates/specification_breakdown_files/template.step.md,sha256=nzDRl9Xo
 ara_cli/templates/specification_breakdown_files/template.technology.exploration.md,sha256=zQyiJcmbUfXdte-5uZwZUpT6ey0zwfZ00P4VwI97jQk,2274
 ara_cli/templates/specification_breakdown_files/template.technology.md,sha256=bySiksz-8xtq0Nnj4svqe2MgUftWrVkbK9AcrDUE3KY,952
 ara_cli/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ara_cli/tests/test_ara_command_action.py,sha256=vxTaDGThNz8vxazGuYt1ufDaPZbYiIYpN7alISXAi9s,25474
+ara_cli/tests/test_ara_autofix.py,sha256=8AaSuherD2dvo2wMFafgHnkLhSnMs6ZW6RtX-5VKsls,4248
+ara_cli/tests/test_ara_command_action.py,sha256=s7XlNMX1lohnwlRwdCHMKFpJdM7BxyEjYuOcba2BClw,25494
 ara_cli/tests/test_ara_config.py,sha256=1LWby_iSestTIIqK-1clggL8kmbGGbtlYfsxAHaMMF8,2232
 ara_cli/tests/test_artefact_fuzzy_search.py,sha256=5Sh3_l9QK8-WHn6JpGPU1b6h4QEnl2JoMq1Tdp2cj1U,1261
 ara_cli/tests/test_artefact_link_updater.py,sha256=gN5KFF1uY7OoBh8Mr5jWpqXp02YCU5OSIpSU76Rm4Gs,2137
@@ -148,8 +149,8 @@ ara_cli/tests/test_list_filter.py,sha256=gSRKirTtFuhRS3QlFHqWl89WvCvAdVEnFsCWTYm
 ara_cli/tests/test_tag_extractor.py,sha256=n2xNApbDciqKO3QuaveEWSPXU1PCUa_EhxlZMrukONw,2074
 ara_cli/tests/test_template_manager.py,sha256=bRxka6cxHsCAOvXjfG8MrVO8qSZXhxW01tnph80UtNk,3143
 ara_cli/tests/test_update_config_prompt.py,sha256=vSsLvc18HZdVjVM93qXWVbJt752xTLL6VGjSVCrPufk,6729
-ara_cli-0.1.9.61.dist-info/METADATA,sha256=oUtK5-Prz7S1ln3cAuDIDFTpWOjwFSAVUR242nhxtYo,388
-ara_cli-0.1.9.61.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ara_cli-0.1.9.61.dist-info/entry_points.txt,sha256=v4h7MzysTgSIDYfEo3oj4Kz_8lzsRa3hq-KJHEcLVX8,45
-ara_cli-0.1.9.61.dist-info/top_level.txt,sha256=zzee_PwFmKqfBi9XgIunP6xy2S4TIt593CLLxenNaAE,8
-ara_cli-0.1.9.61.dist-info/RECORD,,
+ara_cli-0.1.9.62.dist-info/METADATA,sha256=qcj03ih0hWhPZ3etcPqr99iZNELjw53lz63Q5AsG8Zo,415
+ara_cli-0.1.9.62.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ara_cli-0.1.9.62.dist-info/entry_points.txt,sha256=v4h7MzysTgSIDYfEo3oj4Kz_8lzsRa3hq-KJHEcLVX8,45
+ara_cli-0.1.9.62.dist-info/top_level.txt,sha256=zzee_PwFmKqfBi9XgIunP6xy2S4TIt593CLLxenNaAE,8
+ara_cli-0.1.9.62.dist-info/RECORD,,

ara_cli/analyse_artefacts.py

@@ -1,133 +0,0 @@
-#!/usr/bin/env python3
-"""
-analyse_artefacts.py
-
-Walk a directory tree, try to deserialize every *.vision *.epic *.task … file
-with the appropriate Pydantic artefact model, and write the list of files that
-fail validation (plus the reason) to 'invalid_artefacts.txt'.
-"""
-
-"""
-python analyse_artefacts.py <path_to_ara_folder ex: ./ara/>
-"""
-
-from ara_cli.artefact_models import businessgoal_artefact_model, capability_artefact_model, epic_artefact_model, example_artefact_model, feature_artefact_model, issue_artefact_model, keyfeature_artefact_model, userstory_artefact_model, task_artefact_model, vision_artefact_model
-from ara_cli.artefact_models.artefact_model import Artefact, ArtefactType
-from pydantic import ValidationError
-from typing import Dict, Type, List, Tuple
-from pathlib import Path
-import os
-import sys
-
-
-# --- import your domain model ----------------------------------------------
-# Make sure this import path matches your project layout.
-# (e.g. from ara_cli.artefact_model import Artefact, ArtefactType)
-# ---------------------------------------------------------------------------
-
-
-def build_type_map() -> Dict[ArtefactType, Type[Artefact]]:
-    type_map: Dict[ArtefactType, Type[Artefact]] = {}
-    queue: List[Type[Artefact]] = list(Artefact.__subclasses__())
-    while queue:
-        cls = queue.pop()
-        try:
-            artefact_type = cls._artefact_type()
-            type_map[artefact_type] = cls
-        except Exception:
-            pass        # abstract / helper subclass
-        queue.extend(cls.__subclasses__())
-    if not type_map:
-        raise RuntimeError("No concrete Artefact subclasses found!")
-    return type_map
-
-
-def find_artefact_files(root: Path, valid_exts: List[str]) -> List[Path]:
-    return [
-        p for p in root.rglob("*")
-        if p.is_file() and p.suffix.lstrip(".") in valid_exts
-    ]
-
-
-def scan_folder(
-    root_folder: Path,
-    detailed_report: Path,
-    names_only_report: Path,
-    checklist_report: Path
-) -> Tuple[int, int]:
-    type_map = build_type_map()
-    valid_exts = [t.value for t in type_map]
-
-    artefact_files = find_artefact_files(root_folder, valid_exts)
-    bad: List[Tuple[Path, str]] = []
-
-    for file_path in artefact_files:
-        artefact_type = ArtefactType(file_path.suffix.lstrip("."))
-        artefact_cls = type_map[artefact_type]
-        text = file_path.read_text(encoding="utf-8")
-
-        try:
-            artefact_cls.deserialize(text)
-        except (ValidationError, ValueError, AssertionError) as e:
-            bad.append((file_path, str(e)))
-        except Exception as e:
-            bad.append((file_path, f"Unexpected error: {e!r}"))
-
-    # ───────────── write reports ────────────────────────────────────────────
-    if bad:
-        # 1) detailed txt
-        with detailed_report.open("w", encoding="utf-8") as f:
-            f.write("Invalid artefacts (file  →  reason)\n\n")
-            for path, err in bad:
-                f.write(f"{path}  -->  {err}\n")
-
-        # 2) names-only txt
-        with names_only_report.open("w", encoding="utf-8") as f:
-            for path, _ in bad:
-                f.write(f"{path}\n")
-
-        # 3) markdown checklist
-        with checklist_report.open("w", encoding="utf-8") as f:
-            f.write("# 📋 Artefact-fix checklist\n\n")
-            f.write("Tick a box once you’ve fixed & validated the file.\n\n")
-            for path, err in bad:
-                f.write(f"- [ ] `{path}` – {err}\n")
-
-        print(
-            f"\nFinished. {len(bad)}/{len(artefact_files)} files are invalid."
-            f"\nReports generated:"
-            f"\n • {detailed_report}"
-            f"\n • {names_only_report}"
-            f"\n • {checklist_report}"
-        )
-    else:
-        print(f"\nFinished. All {len(artefact_files)} artefacts are valid ✔️")
-        # clean up stale files from previous runs
-        for p in (detailed_report, names_only_report, checklist_report):
-            if p.exists():
-                p.unlink()
-
-    return len(artefact_files), len(bad)
-
-
-# ─────────────────────────────── main ──────────────────────────────────────
-def main() -> None:
-    if len(sys.argv) < 2:
-        print("Usage:  python scan_artefacts.py  <folder_to_scan>")
-        sys.exit(1)
-
-    root_folder = Path(sys.argv[1]).expanduser().resolve()
-    if not root_folder.is_dir():
-        print(f"Error: '{root_folder}' is not a directory.")
-        sys.exit(1)
-
-    scan_folder(
-        root_folder=root_folder,
-        detailed_report=Path("invalid_artefacts.txt"),
-        names_only_report=Path("invalid_artefact_names.txt"),
-        checklist_report=Path("invalid_artefacts_checklist.md"),
-    )
-
-
-if __name__ == "__main__":
-    main()