ara-cli 0.1.9.51__py3-none-any.whl → 0.1.9.53__py3-none-any.whl

ara_cli/ara_command_action.py

@@ -266,6 +266,12 @@ def fetch_templates_action(args):
             target = join(target_dir, item)
             shutil.copy2(source, target)
 
+    custom_prompt_templates_subdir = config.custom_prompt_templates_subdir
+    local_prompt_modules_dir = join(prompt_templates_dir, custom_prompt_templates_subdir)
+    os.makedirs(local_prompt_modules_dir, exist_ok=True)
+    for subdir in subdirs:
+        os.makedirs(join(local_prompt_modules_dir, subdir), exist_ok=True)
+
 
 def read_action(args):
     from ara_cli.artefact_reader import ArtefactReader
@@ -318,55 +324,49 @@ def read_action(args):
 
 
 def reconnect_action(args):
-    from ara_cli.artefact import Artefact
+    from ara_cli.artefact_models.artefact_load import artefact_from_content
+    from ara_cli.artefact_models.artefact_model import Contribution
     from ara_cli.artefact_reader import ArtefactReader
-    from ara_cli.file_classifier import FileClassifier
-    from ara_cli.directory_navigator import DirectoryNavigator
 
     classifier = args.classifier
     artefact_name = args.parameter
     parent_classifier = args.parent_classifier
     parent_name = args.parent_name
 
-    file_classifier = FileClassifier(os)
-    classified_artefacts_info = file_classifier.classify_files_new()
-
-    all_artefact_names = [info["title"] for info in classified_artefacts_info.get(classifier, [])]
-    if artefact_name not in all_artefact_names:
-        suggest_close_name_matches(artefact_name, all_artefact_names)
-        return
+    read_error_message = f"Could not connect {classifier} '{artefact_name}' to {parent_classifier} '{parent_name}'"
 
-    all_artefact_names = [info["title"] for info in classified_artefacts_info.get(parent_classifier, [])]
-    if parent_name not in all_artefact_names:
-        suggest_close_name_matches(parent_name, all_artefact_names)
-        return
-
-    directory_navigator = DirectoryNavigator()
-    original_directory = directory_navigator.navigate_to_target()
-
-    content, file_path = ArtefactReader.read_artefact(
+    content, artefact_info = ArtefactReader.read_artefact(
         artefact_name=artefact_name,
         classifier=classifier
     )
+    if not content:
+        print(read_error_message)
+        return
 
-    parent_content, parent_path = ArtefactReader.read_artefact(
+    parent_content, parent_info = ArtefactReader.read_artefact(
         artefact_name=parent_name,
         classifier=parent_classifier
     )
+    if not parent_content:
+        print(read_error_message)
+        return
 
-    artefact = Artefact.from_content(
+    artefact = artefact_from_content(
         content=content,
-        file_path=file_path
-    )
-    parent = Artefact.from_content(
-        content=parent_content,
-        file_path=parent_path
     )
+    artefact._file_path = artefact_info["file_path"]
 
-    artefact._parent = parent
-    artefact.write_to_file()
+    parent = artefact_from_content(
+        content=parent_content
+    )
 
-    os.chdir(original_directory)
+    artefact.contribution = Contribution(
+        artefact_name=parent.title,
+        classifier=parent.artefact_type
+    )
+    with open(artefact.file_path, 'w') as file:
+        artefact_content = artefact.serialize()
+        file.write(artefact_content)
 
 
 def read_status_action(args):
@@ -377,7 +377,7 @@ def read_status_action(args):
     artefact_name = args.parameter
 
     file_classifier = FileClassifier(os)
-    artefact_info = file_classifier.classify_files_new()
+    artefact_info = file_classifier.classify_files()
     artefact_info_dicts = artefact_info.get(classifier, [])
 
     all_artefact_names = [artefact_info["title"] for artefact_info in artefact_info_dicts]
@@ -409,7 +409,7 @@ def read_user_action(args):
     artefact_name = args.parameter
 
     file_classifier = FileClassifier(os)
-    artefact_info = file_classifier.classify_files_new()
+    artefact_info = file_classifier.classify_files()
     artefact_info_dicts = artefact_info.get(classifier, [])
 
     all_artefact_names = [artefact_info["title"] for artefact_info in artefact_info_dicts]
@@ -451,7 +451,7 @@ def set_status_action(args):
     check_validity(new_status in status_tags, "Invalid status provided. Please provide a valid status.")
 
     file_classifier = FileClassifier(os)
-    classified_artefacts_info = file_classifier.classify_files_new()
+    classified_artefacts_info = file_classifier.classify_files()
     classified_artefact_dict = classified_artefacts_info.get(classifier, [])
     all_artefact_names = [artefact_info["title"] for artefact_info in classified_artefact_dict]
 
@@ -488,7 +488,7 @@ def set_user_action(args):
         new_user = new_user.lstrip('@')
 
     file_classifier = FileClassifier(os)
-    classified_artefacts_info = file_classifier.classify_files_new()
+    classified_artefacts_info = file_classifier.classify_files()
     classified_artefact_dict = classified_artefacts_info.get(classifier, [])
     all_artefact_names = [artefact_info["title"] for artefact_info in classified_artefact_dict]
 
@@ -527,7 +527,7 @@ def scan_action(args):
     from ara_cli.artefact_scan import find_invalid_files, show_results
     import os
 
-    classified_artefact_info = FileClassifier(os).classify_files_new()
+    classified_artefact_info = FileClassifier(os).classify_files()
     invalid_artefacts = {}
     for classifier in classified_artefact_info:
         invalid = find_invalid_files(classified_artefact_info, classifier)

ara_cli/ara_config.py

@@ -2,7 +2,7 @@ from typing import List, Dict, Union, Optional
 from pydantic import BaseModel
 import json
 import os
-from os.path import exists, join, dirname
+from os.path import exists, dirname
 from os import makedirs
 from functools import lru_cache
 
@@ -18,6 +18,7 @@ class ARAconfig(BaseModel):
     glossary_dir: str = "./glossary"
     doc_dir: str = "./docs"
     local_prompt_templates_dir: str = "./ara/.araconfig"
+    custom_prompt_templates_subdir: Optional[str] = "custom-prompt-modules"
     local_ara_templates_dir: str = "./ara/.araconfig/templates/"
     ara_prompt_given_list_includes: List[str] = [
         "*.businessgoal",
@@ -136,12 +137,6 @@ class ConfigManager:
 
             if not exists(config_dir):
                 makedirs(config_dir)
-                # create defined default path structure for custom prompts
-                makedirs(join(config_dir, "custom-prompt-modules"))
-                makedirs(join(config_dir, "custom-prompt-modules", "commands"))
-                makedirs(join(config_dir, "custom-prompt-modules", "rule"))
-                makedirs(join(config_dir, "custom-prompt-modules", "intentions"))
-                makedirs(join(config_dir, "custom-prompt-modules", "blueprints"))
 
             cls._config_instance = read_data(filepath)
         return cls._config_instance

ara_cli/artefact_creator.py

@@ -2,9 +2,9 @@ import os
 from functools import lru_cache
 from ara_cli.classifier import Classifier
 from ara_cli.template_manager import DirectoryNavigator
-from ara_cli.artefact import Artefact
+from ara_cli.artefact_reader import ArtefactReader
+from ara_cli.artefact_models.artefact_model import Artefact
 from ara_cli.artefact_models.artefact_templates import template_artefact_of_type
-from ara_cli.file_classifier import FileClassifier
 from ara_cli.artefact_fuzzy_search import suggest_close_name_matches
 from pathlib import Path
 from shutil import copyfile
@@ -75,8 +75,7 @@ class ArtefactCreator:
         return True
 
     def set_artefact_parent(self, artefact, parent_classifier, parent_file_name) -> Artefact:
-        file_classifier = FileClassifier(os)
-        classified_artefacts = file_classifier.classify_files()
+        classified_artefacts = ArtefactReader.read_artefacts()
         if parent_classifier not in classified_artefacts:
             return artefact
         artefact_list = classified_artefacts[parent_classifier]

ara_cli/artefact_lister.py

@@ -66,7 +66,7 @@ class ArtefactLister:
         list_filter: ListFilter | None = None
     ):
         file_classifier = FileClassifier(os)
-        classified_artefacts = file_classifier.classify_files_new()
+        classified_artefacts = file_classifier.classify_files()
         artefact_info = classified_artefacts.get(classifier, [])
         matching_artefact_info = [p for p in artefact_info if p["title"] == artefact_name]
 
@@ -92,7 +92,7 @@ class ArtefactLister:
         list_filter: ListFilter | None = None
     ):
         file_classifier = FileClassifier(os)
-        classified_artefacts = file_classifier.classify_files_new()
+        classified_artefacts = file_classifier.classify_files()
         artefact_info = classified_artefacts.get(classifier, [])
         matching_artefact_info = [p for p in artefact_info if p["title"] == artefact_name]
 
@@ -118,21 +118,19 @@ class ArtefactLister:
         list_filter: ListFilter | None = None
     ):
         file_classifier = FileClassifier(os)
-        classified_artefacts = file_classifier.classify_files()
-        artefact_paths = classified_artefacts.get(classifier, [])
-        matching_paths = [p for p in artefact_paths if os.path.basename(p).startswith(artefact_name + '.')]
+        classified_artefact_info = file_classifier.classify_files()
+        artefact_info_dict = classified_artefact_info.get(classifier, [])
 
-        if not matching_paths:
+        matching_info = [info for info in artefact_info_dict if info["title"] == artefact_name]
+
+        if not matching_info:
             suggest_close_name_matches(
                 artefact_name,
-                [os.path.basename(f).split('.')[0] for f in artefact_paths]
+                [info["title"] for info in artefact_info_dict]
             )
-        artefact_paths = classified_artefacts.get(classifier, [])
-        matching_paths = [p for p in artefact_paths if os.path.basename(p).startswith(artefact_name + '.')]
-
-        if len(matching_paths) == 0:
             return
-        artefact_path = matching_paths[0]
-        data_dir = os.path.splitext(artefact_path)[0] + '.data'
+
+        artefact_info = matching_info[0]
+        data_dir = os.path.splitext(artefact_info["file_path"])[0] + '.data'
         if os.path.exists(data_dir):
             list_files_in_directory(data_dir, list_filter)

ara_cli/artefact_models/artefact_model.py

@@ -11,6 +11,14 @@ import string
 ALLOWED_STATUS_VALUES = ("to-do", "in-progress", "review", "done", "closed")
 
 
+def replace_space_with_underscore(input: string):
+    return input.replace(' ', '_')
+
+
+def replace_underscore_with_space(input: string):
+    return input.replace('_', ' ')
+
+
 class ArtefactType(str, Enum):
     vision = "vision"
     businessgoal = "businessgoal"
@@ -44,6 +52,12 @@ class Contribution(BaseModel):
         classifier = self.classifier
         rule = self.rule
 
+        if artefact_name:
+            artefact_name = replace_space_with_underscore(artefact_name)
+        if artefact_name and classifier:
+            artefact_name = artefact_name.removesuffix(f"_{classifier}")
+            artefact_name = artefact_name.removesuffix(f"_{classifier.capitalize()}")
+            self.artefact_name = artefact_name
         if not artefact_name or not classifier:
             self.artefact_name = None
             self.classifier = None
@@ -60,7 +74,7 @@ class Contribution(BaseModel):
             return value
         if ' ' in value:
             warnings.warn(message="artefact_name can not contain spaces. Replacing spaces with '_'")
-            value = value.replace(' ', '_')
+            value = replace_space_with_underscore(value)
         return value
 
     @field_validator('classifier', mode='after')
@@ -102,7 +116,7 @@ class Contribution(BaseModel):
         if not self.classifier or not self.artefact_name:
             return ""
         artefact_type = Classifier.get_artefact_title(self.classifier)
-        artefact_name = self.artefact_name.replace("_", " ")
+        artefact_name = replace_underscore_with_space(self.artefact_name)
         contribution = f"{artefact_name} {artefact_type}"
         if self.rule:
             contribution = f"{contribution} using rule {self.rule}"
@@ -136,6 +150,7 @@ class Artefact(BaseModel, ABC):
         "validate_assignment": True
     }
 
+    _file_path: Optional[str] = None
     artefact_type: ArtefactType = Field(
         ...,
         description=f"Artefact classifier (mandatory). Allowed classifiers are {', '.join(ArtefactType)}"
@@ -165,7 +180,6 @@ class Artefact(BaseModel, ABC):
         default=None,
         description="Optional further description to understand the artefact. It is strongly recommended to add a description to every artefact."
     )
-    _file_path: Optional[str] = None
 
     @property
     def file_path(self) -> str:
@@ -207,9 +221,7 @@ class Artefact(BaseModel, ABC):
     def validate_title(cls, v):
         if not v.strip():
             raise ValueError("artefact_title must not be empty")
-        if ' ' in v:
-            warnings.warn(message="artefact_name can not contain spaces. Replacing spaces with '_'")
-            v = v.replace(' ', '_')
+        v = replace_space_with_underscore(v)
 
         letters = list(string.ascii_letters)
         digits = list(string.digits)
@@ -281,7 +293,7 @@ class Artefact(BaseModel, ABC):
             raise ValueError(
                 f"No title found in {cls._artefact_type()}. Expected '{title_prefix}' as start of the title in line '{title_line}'")
         title = title_line[len(title_prefix):].strip()
-        title = title.replace(' ', '_')
+        title = replace_space_with_underscore(title)
         return title, lines
 
     @classmethod
@@ -351,7 +363,7 @@ class Artefact(BaseModel, ABC):
         pass
 
     def _serialize_title(self) -> str:
-        title = self.title.replace('_', ' ')
+        title = replace_underscore_with_space(self.title)
         return f"{self._title_prefix()} {title}"
 
     def _serialize_tags(self) -> (Optional[str]):

ara_cli/artefact_reader.py

@@ -1,4 +1,3 @@
-from ara_cli.directory_navigator import DirectoryNavigator
 from ara_cli.classifier import Classifier
 from ara_cli.file_classifier import FileClassifier
 from ara_cli.artefact_models.artefact_model import Artefact
@@ -11,33 +10,28 @@ import re
 class ArtefactReader:
     @staticmethod
     def read_artefact(artefact_name, classifier):
-        original_directory = os.getcwd()
-        navigator = DirectoryNavigator()
-        navigator.navigate_to_target()
-
         if not Classifier.is_valid_classifier(classifier):
             print("Invalid classifier provided. Please provide a valid classifier.")
-            os.chdir(original_directory)
             return None, None
 
         file_classifier = FileClassifier(os)
-        classified_files = file_classifier.classify_files()
-        artefact_paths = classified_files.get(classifier, [])
+        classified_file_info = file_classifier.classify_files()
+        artefact_info_of_classifier = classified_file_info.get(classifier, [])
 
-        for file_path in artefact_paths:
-            if os.path.basename(file_path).startswith(artefact_name + '.'):
+        for artefact_info in artefact_info_of_classifier:
+            file_path = artefact_info["file_path"]
+            artefact_title = artefact_info["title"]
+            if artefact_title == artefact_name:
                 with open(file_path, 'r') as file:
                     content = file.read()
-                os.chdir(original_directory)
-                return content, file_path
+                return content, artefact_info
 
-        print(f"No match found for artefact with name '{artefact_name}'")
+        all_artefact_names = [info["title"] for info in artefact_info_of_classifier]
         suggest_close_name_matches(
             artefact_name,
-            [os.path.basename(f).split('.')[0] for f in artefact_paths]
+            all_artefact_names
         )
 
-        os.chdir(original_directory)
         return None, None
 
     @staticmethod
@@ -72,7 +66,7 @@ class ArtefactReader:
 
         if classified_artefacts is None:
             file_classifier = FileClassifier(file_system)
-            classified_artefacts = file_classifier.classify_files_new()
+            classified_artefacts = file_classifier.classify_files()
 
         artefacts = {artefact_type: []
                      for artefact_type in classified_artefacts.keys()}

ara_cli/artefact_renamer.py

@@ -12,16 +12,17 @@ class ArtefactRenamer:
         self.link_updater = ArtefactLinkUpdater()
 
     @lru_cache(maxsize=None)
-    def navigate_to_target(self):
+    def navigate_to_target(self) -> str:
         navigator = DirectoryNavigator()
-        navigator.navigate_to_target()
+        original_directory = navigator.navigate_to_target()
+        return original_directory
 
     @lru_cache(maxsize=None)
     def compile_pattern(self, pattern):
         return re.compile(pattern)
 
     def rename(self, old_name, new_name, classifier):
-        self.navigate_to_target()
+        original_directory = self.navigate_to_target()
 
         if not new_name:
             raise ValueError("New name must be provided for renaming.")
@@ -50,13 +51,10 @@ class ArtefactRenamer:
 
         # Perform the renaming of the file and directory
         self.file_system.rename(old_file_path, new_file_path)
+        print(f"Renamed file: {old_file_path} to {new_file_path}")
         if old_dir_exists:
             self.file_system.rename(old_dir_path, new_dir_path)
-        # TODO: we should be able to remove this next line once ara delete ignores non-existent data folders
-        os.makedirs(new_dir_path, exist_ok=True)
-
-        print(f"Renamed file: {old_file_path} to {new_file_path}")
-        print(f"Renamed directory: {old_dir_path} to {new_dir_path}")
+            print(f"Renamed directory: {old_dir_path} to {new_dir_path}")
 
         # Update the title within the artefact file
         self._update_title_in_artefact(new_file_path, new_name, classifier)
@@ -64,6 +62,8 @@ class ArtefactRenamer:
         # Update links in related artefact files
         self.link_updater.update_links_in_related_artefacts(old_name, new_name)
 
+        os.chdir(original_directory)
+
     def _update_title_in_artefact(self, artefact_path, new_title, classifier):
         # Format the new title: replace underscores with spaces
         formatted_new_title = new_title.replace('_', ' ')

ara_cli/chat.py

@@ -662,7 +662,8 @@ Start chatting (type 'HELP'/'h' for available commands, 'QUIT'/'q' to exit chat
         local_templates_path = os.path.join(os.getcwd(), local_templates_path)
         os.chdir(original_directory)
 
-        template_directory = f"{local_templates_path}/custom-prompt-modules/{plural}"
+        custom_prompt_templates_subdir = self.config.custom_prompt_templates_subdir
+        template_directory = f"{local_templates_path}/{custom_prompt_templates_subdir}/{plural}"
         self._load_helper(template_directory, template_name, template_type)
 
     def _load_template_helper(self, template_name, template_type, default_pattern):

ara_cli/file_classifier.py

@@ -1,5 +1,5 @@
 from ara_cli.classifier import Classifier
-from ara_cli.artefact import Artefact
+from ara_cli.artefact_models.artefact_model import Artefact
 from ara_cli.artefact_fuzzy_search import find_closest_name_match
 from functools import lru_cache
 from typing import Optional
@@ -14,7 +14,7 @@ class FileClassifier:
     def find_closest_artefact_name_match(self, name, classifier) -> Optional[str]:
         classified_artefacts = self.classify_files()
         all_artefact_names = [
-            artefact_name for artefact_name in classified_artefacts.get(classifier, [])]
+            info["title"] for info in classified_artefacts.get(classifier, [])]
         if name in all_artefact_names:
             return name
         return find_closest_name_match(name, all_artefact_names)
@@ -64,37 +64,7 @@ class FileClassifier:
                 return classifier
         return None
 
-    def classify_files(self, tags=None, read_content=False) -> dict[str, list]:
-        from ara_cli.artefact_models.artefact_load import artefact_from_content
-
-        files_by_classifier = {classifier: []
-                               for classifier in Classifier.ordered_classifiers()}
-
-        # TODO: file location information inside the artefact.
-        for root, _, files in self.file_system.walk("."):
-            for file in files:
-                file_path = self.file_system.path.join(root, file)
-                classifier = self.classify_file(file_path, tags)
-                if not classifier:
-                    continue
-
-                if not read_content:
-                    files_by_classifier[classifier].append(file_path)
-                    continue
-
-                with open(file_path, 'r') as f:
-                    content = f.read()
-                try:
-                    artefact = artefact_from_content(content)
-                    if artefact:
-                        artefact._file_path = file_path
-                        files_by_classifier[classifier].append(artefact)
-                except ValueError:
-                    continue
-
-        return files_by_classifier
-
-    def classify_files_new(self, tags=None) -> dict[str, list[dict]]:
+    def classify_files(self, tags=None) -> dict[str, list[dict]]:
         files_by_classifier = {classifier: [] for classifier in Classifier.ordered_classifiers()}
 
         for root, _, files in self.file_system.walk("."):

ara_cli/tests/test_ara_command_action.py

@@ -385,7 +385,7 @@ def test_read_status_action(classifier, artefact_name, artefact_exists, status,
 
         # Configure file classifier mock
         mock_classifier_instance = MockFileClassifier.return_value
-        mock_classifier_instance.classify_files_new.return_value = {classifier: artefact_info_dicts}
+        mock_classifier_instance.classify_files.return_value = {classifier: artefact_info_dicts}
         
         # Configure file open mock
         mock_file_handle = MagicMock()
@@ -422,7 +422,7 @@ def read_user_action(args):
     artefact_name = args.parameter
 
     file_classifier = FileClassifier(os)
-    artefact_info = file_classifier.classify_files_new()
+    artefact_info = file_classifier.classify_files()
     artefact_info_dicts = artefact_info.get(classifier, [])
 
     all_artefact_names = [artefact_info["title"] for artefact_info in artefact_info_dicts]
@@ -489,7 +489,7 @@ def test_set_status_action(classifier, artefact_name, artefact_names, new_status
 
         # Configure mock file classifier
         mock_classifier_instance = MockFileClassifier.return_value
-        mock_classifier_instance.classify_files_new.return_value = {classifier: artefact_info_dicts}
+        mock_classifier_instance.classify_files.return_value = {classifier: artefact_info_dicts}
         
         # Configure mock file handling
         mock_file_handle = MagicMock()
@@ -569,7 +569,7 @@ def test_set_user_action(
         
         # Configure mocks
         mock_file_classifier_instance = MockFileClassifier.return_value
-        mock_file_classifier_instance.classify_files_new.return_value = {classifier: artefact_info_dicts}
+        mock_file_classifier_instance.classify_files.return_value = {classifier: artefact_info_dicts}
         
         mock_file_handle = MagicMock()
         mock_file_handle.__enter__.return_value.read.return_value = mock_file_content
@@ -628,7 +628,7 @@ def test_scan_action_with_issues(capsys):
             patch("builtins.open", mock_open()) as m:
 
         mock_classifier = MockFileClassifier.return_value
-        mock_classifier.classify_files_new.return_value = {
+        mock_classifier.classify_files.return_value = {
             "classifier1": ["file1.txt"],
             "classifier2": ["file2.txt"]
         }
@@ -667,7 +667,7 @@ def test_scan_action_all_good(capsys):
          patch("builtins.open", mock_open()) as m:
 
         mock_classifier = MockFileClassifier.return_value
-        mock_classifier.classify_files_new.return_value = {
+        mock_classifier.classify_files.return_value = {
             "classifier1": ["file1.txt"],
             "classifier2": ["file2.txt"]
         }