ara-cli 0.1.9.61__tar.gz → 0.1.9.63__tar.gz

{ara_cli-0.1.9.61 → ara_cli-0.1.9.63}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ara_cli
-Version: 0.1.9.61
+Version: 0.1.9.63
 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 → ara_cli-0.1.9.63}/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-0.1.9.61 → ara_cli-0.1.9.63}/ara_cli/ara_command_action.py

@@ -128,7 +128,10 @@ def list_tags_action(args):
         tag_classifier = args.include_classifier
 
     tag_extractor = TagExtractor()
-    tags = tag_extractor.extract_tags(include_classifier=tag_classifier)
+    tags = tag_extractor.extract_tags(
+        include_classifier=tag_classifier,
+        filtered_extra_column=getattr(args, "filtered_extra_column", False)
+    )
 
     if args.json:
         output = json.dumps({"tags": tags})
@@ -538,3 +541,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-0.1.9.61 → ara_cli-0.1.9.63}/ara_cli/ara_command_parser.py

@@ -121,6 +121,7 @@ def list_tags_parser(subparsers):
     tags_parser = subparsers.add_parser("list-tags", help="Show tags")
     tags_parser.add_argument("--json", "-j", help="Output tags as JSON", action=argparse.BooleanOptionalAction)
     tags_parser.add_argument("--include-classifier", choices=classifiers, help="Show tags for an artefact type")
+    tags_parser.add_argument("--filtered-extra-column", action="store_true", help="Filter tags for extra column") 
 
 
 def add_chat_arguments(chat_parser):
@@ -220,6 +221,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 +312,6 @@ def action_parser():
     set_user_parser(subparsers)
     classifier_directory_parser(subparsers)
     scan_parser(subparsers)
+    autofix_parser(subparsers)
 
     return parser

ara_cli-0.1.9.63/ara_cli/artefact_autofix.py

@@ -0,0 +1,146 @@
+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}. "
+        "Provide the complete, corrected artefact. Do not reformulate the artefact, "
+        "just fix the pydantic model errors, use correct grammar. "
+        "Do not remove comments. "
+        "You should follow the name of the file "
+        f"from its path {file_path} for naming the arteafact's title. "
+        "You are not allowed to use file extention in the artefact title. "
+        "You are not allowed to modify, delete or add tags. "
+        "User tag should be '@user_<username>'. The pydantic model already provides the '@user_' prefix. "
+        "So you should be careful to not make it @user_user_<username>. "
+    )
+
+    if artefact_type == ArtefactType.task:
+        prompt += (
+            "For task artefacts, if the action items looks like template or empty "
+            "then just delete those action items."
+        )
+
+    prompt += (
+        "\nThe current artefact is:\n"
+        "```\n"
+        f"{artefact_text}\n"
+        "```"
+    )
+
+    return prompt
+
+
+def run_agent(prompt, artefact_class):
+    from pydantic_ai import Agent
+    # gpt-4o
+    # anthropic:claude-3-7-sonnet-20250219
+    agent = Agent(model="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-0.1.9.61 → ara_cli-0.1.9.63}/ara_cli/artefact_models/artefact_model.py

@@ -179,7 +179,7 @@ class Artefact(BaseModel, ABC):
     )
     description: Optional[str] = Field(
         default=None,
-        description="Optional further description to understand the artefact. It is strongly recommended to add a description to every artefact."
+        description="Optional further description to understand the artefact. The description should summerize the core intention of the artefact and give additional valuable information about the artefact."
     )
 
     @property

{ara_cli-0.1.9.61 → ara_cli-0.1.9.63}/ara_cli/artefact_models/businessgoal_artefact_model.py

@@ -33,9 +33,14 @@ class BusinessgoalIntent(Intent):
         return v
 
     def serialize(self):
+        from ara_cli.artefact_models.serialize_helper import as_a_serializer
+
         lines = []
+
+        as_a_line = as_a_serializer(self.as_a)
+        
         lines.append(f"In order to {self.in_order_to}")
-        lines.append(f"As a {self.as_a}")
+        lines.append(as_a_line)
         lines.append(f"I want {self.i_want}")
 
         return "\n".join(lines)

{ara_cli-0.1.9.61 → ara_cli-0.1.9.63}/ara_cli/artefact_models/epic_artefact_model.py

@@ -34,9 +34,14 @@ class EpicIntent(Intent):
         return v
 
     def serialize(self):
+        from ara_cli.artefact_models.serialize_helper import as_a_serializer
+
         lines = []
+
+        as_a_line = as_a_serializer(self.as_a)
+
         lines.append(f"In order to {self.in_order_to}")
-        lines.append(f"As a {self.as_a}")
+        lines.append(as_a_line)
         lines.append(f"I want {self.i_want}")
 
         return "\n".join(lines)

{ara_cli-0.1.9.61 → ara_cli-0.1.9.63}/ara_cli/artefact_models/feature_artefact_model.py

@@ -34,8 +34,13 @@ class FeatureIntent(Intent):
         return v
 
     def serialize(self):
+        from ara_cli.artefact_models.serialize_helper import as_a_serializer
+
         lines = []
-        lines.append(f"As a {self.as_a}")
+
+        as_a_line = as_a_serializer(self.as_a)
+
+        lines.append(as_a_line)
         lines.append(f"I want to {self.i_want_to}")
         lines.append(f"So that {self.so_that}")
 
@@ -59,9 +64,9 @@ class FeatureIntent(Intent):
                 as_a = line[len(as_a_prefix):].strip()
             if line.startswith(as_a_prefix_alt) and not as_a:
                 as_a = line[len(as_a_prefix_alt):].strip()
-            elif line.startswith(i_want_to_prefix) and not i_want_to:
+            if line.startswith(i_want_to_prefix) and not i_want_to:
                 i_want_to = line[len(i_want_to_prefix):].strip()
-            elif line.startswith(so_that_prefix) and not so_that:
+            if line.startswith(so_that_prefix) and not so_that:
                 so_that = line[len(so_that_prefix):].strip()
             index += 1
 

{ara_cli-0.1.9.61 → ara_cli-0.1.9.63}/ara_cli/artefact_models/keyfeature_artefact_model.py

@@ -33,9 +33,14 @@ class KeyfeatureIntent(Intent):
         return v
 
     def serialize(self):
+        from ara_cli.artefact_models.serialize_helper import as_a_serializer
+
         lines = []
+
+        as_a_line = as_a_serializer(self.as_a)
+
         lines.append(f"In order to {self.in_order_to}")
-        lines.append(f"As a {self.as_a}")
+        lines.append(as_a_line)
         lines.append(f"I want {self.i_want}")
 
         return "\n".join(lines)

ara_cli-0.1.9.63/ara_cli/artefact_models/serialize_helper.py

@@ -0,0 +1,18 @@
+def as_a_serializer(as_a):
+    role = as_a.strip()
+
+    exceptions_for_a = ('user', 'university', 'one-time', 'european', 'unit')
+    exceptions_for_an = ('hour', 'honest', 'heir')
+    role_lower = role.lower()
+    as_a_prefix = ""
+
+    if any(role_lower.startswith(e) for e in exceptions_for_a):
+        as_a_prefix = "As a"
+    elif any(role_lower.startswith(e) for e in exceptions_for_an):
+        as_a_prefix = "As an"
+    elif role_lower.startswith(('a', 'e', 'i', 'o', 'u')):
+        as_a_prefix = "As an"
+    else:
+        as_a_prefix = "As a"
+
+    return f"{as_a_prefix} {role}"

{ara_cli-0.1.9.61 → ara_cli-0.1.9.63}/ara_cli/artefact_models/userstory_artefact_model.py

@@ -33,9 +33,14 @@ class UserstoryIntent(Intent):
         return v
 
     def serialize(self):
+        from ara_cli.artefact_models.serialize_helper import as_a_serializer
+
         lines = []
+
+        as_a_line = as_a_serializer(self.as_a)
+
         lines.append(f"In order to {self.in_order_to}")
-        lines.append(f"As a {self.as_a}")
+        lines.append(as_a_line)
         lines.append(f"I want {self.i_want}")
 
         return "\n".join(lines)

{ara_cli-0.1.9.61 → ara_cli-0.1.9.63}/ara_cli/artefact_scan.py

@@ -25,6 +25,8 @@ def find_invalid_files(classified_artefact_info, classifier):
     for artefact_info in classified_artefact_info[classifier]:
         if "templates/" in artefact_info["file_path"]:
             continue
+        if ".data" in artefact_info["file_path"]:
+            continue
         is_valid, reason = check_file(artefact_info["file_path"], artefact_class)
         if not is_valid:
             invalid_files.append((artefact_info["file_path"], reason))

ara_cli-0.1.9.63/ara_cli/tag_extractor.py

@@ -0,0 +1,56 @@
+import os
+from ara_cli.artefact_models.artefact_load import artefact_from_content
+
+
+class TagExtractor:
+    def __init__(self, file_system=None):
+        self.file_system = file_system or os
+
+    def extract_tags(self, navigate_to_target=False, include_classifier=None, filtered_extra_column=False):
+        from ara_cli.template_manager import DirectoryNavigator
+        from ara_cli.artefact_reader import ArtefactReader
+
+        navigator = DirectoryNavigator()
+        if navigate_to_target:
+            navigator.navigate_to_target()
+
+        artefacts = ArtefactReader.read_artefacts()
+
+        if include_classifier:
+            artefacts = {include_classifier: artefacts[include_classifier]}
+
+        unique_tags = set()
+
+        if filtered_extra_column:
+            status_tags = {"to-do", "in-progress", "review", "done", "closed"}
+            filtered_artefacts = []
+
+            for artefact_list in artefacts.values():
+                for artefact in artefact_list:
+                    tags = artefact.tags + \
+                        [artefact.status] if artefact.status else artefact.tags
+                    tag_set = set(tag for tag in tags if tag is not None)
+                    if not tag_set & status_tags:
+                        filtered_artefacts.append(artefact)
+
+            for artefact in filtered_artefacts:
+                tags = [tag for tag in (
+                    artefact.tags + [artefact.status]) if tag is not None]
+                for tag in tags:
+                    if (
+                        tag in status_tags
+                        or tag.startswith("priority_")
+                        or tag.startswith("user_")
+                    ):
+                        continue
+                    unique_tags.add(tag)
+
+        else:
+            for artefact_list in artefacts.values():
+                for artefact in artefact_list:
+                    user_tags = [f"user_{tag}" for tag in artefact.users]
+                    tags = [tag for tag in (artefact.tags + [artefact.status] + user_tags) if tag is not None]
+                    unique_tags.update(tags)
+
+        sorted_tags = sorted(unique_tags)
+        return sorted_tags

ara_cli-0.1.9.63/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-0.1.9.61 → ara_cli-0.1.9.63}/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-0.1.9.61 → ara_cli-0.1.9.63}/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.63"   # fith parameter like .0 for local install test purposes only. official numbers should be 4 digit numbers

{ara_cli-0.1.9.61 → ara_cli-0.1.9.63}/ara_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ara_cli
-Version: 0.1.9.61
+Version: 0.1.9.63
 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 → ara_cli-0.1.9.63}/ara_cli.egg-info/SOURCES.txt

@@ -3,10 +3,10 @@ README.md
 setup.py
 ara_cli/__init__.py
 ara_cli/__main__.py
-ara_cli/analyse_artefacts.py
 ara_cli/ara_command_action.py
 ara_cli/ara_command_parser.py
 ara_cli/ara_config.py
+ara_cli/artefact_autofix.py
 ara_cli/artefact_creator.py
 ara_cli/artefact_deleter.py
 ara_cli/artefact_fuzzy_search.py
@@ -52,6 +52,7 @@ ara_cli/artefact_models/example_artefact_model.py
 ara_cli/artefact_models/feature_artefact_model.py
 ara_cli/artefact_models/issue_artefact_model.py
 ara_cli/artefact_models/keyfeature_artefact_model.py
+ara_cli/artefact_models/serialize_helper.py
 ara_cli/artefact_models/task_artefact_model.py
 ara_cli/artefact_models/userstory_artefact_model.py
 ara_cli/artefact_models/vision_artefact_model.py
@@ -139,6 +140,7 @@ ara_cli/templates/specification_breakdown_files/template.step.md
 ara_cli/templates/specification_breakdown_files/template.technology.exploration.md
 ara_cli/templates/specification_breakdown_files/template.technology.md
 ara_cli/tests/__init__.py
+ara_cli/tests/test_ara_autofix.py
 ara_cli/tests/test_ara_command_action.py
 ara_cli/tests/test_ara_config.py
 ara_cli/tests/test_artefact_fuzzy_search.py

{ara_cli-0.1.9.61 → ara_cli-0.1.9.63}/ara_cli.egg-info/requires.txt

@@ -9,3 +9,4 @@ argparse
 argcomplete
 cmd2>=2.5
 pydantic
+pydantic_ai

{ara_cli-0.1.9.61 → ara_cli-0.1.9.63}/setup.py

@@ -26,6 +26,7 @@ setup(
         'argparse',
         'argcomplete',
         'cmd2>=2.5',
-        'pydantic'
+        'pydantic',
+        'pydantic_ai'
     ],
 )