ara-cli 0.1.9.69__py3-none-any.whl → 0.1.10.8__py3-none-any.whl

ara_cli/artefact_creator.py

@@ -16,7 +16,7 @@ class ArtefactCreator:
 
     @lru_cache(maxsize=None)
     def read_template_content(self, template_file_path):
-        with open(template_file_path, "r") as template_file:
+        with open(template_file_path, "r", encoding="utf-8") as template_file:
             return template_file.read()
 
     def create_artefact_prompt_files(self, dir_path, template_path, classifier):
@@ -38,11 +38,9 @@ class ArtefactCreator:
         destination = Path(dir_path) / dest_name
 
         if not source.exists():
-            print("[ERROR] Source file does not exist!")
             raise FileNotFoundError(f"Source file {source} not found!")
 
         if not destination.parent.exists():
-            print("[ERROR] Destination directory does not exist!")
             raise NotADirectoryError(f"Destination directory {destination.parent} does not exist!")
 
         copyfile(source, destination)
@@ -70,9 +68,7 @@ class ArtefactCreator:
     def validate_template(self, template_path, classifier):
         template_name = f"template.{classifier}"
         if not self.template_exists(template_path, template_name):
-            print(f"Template file '{template_name}' not found in the specified template path.")
-            return False
-        return True
+            raise FileNotFoundError(f"Template file '{template_name}' not found in the specified template path.")
 
     def set_artefact_parent(self, artefact, parent_classifier, parent_file_name) -> Artefact:
         classified_artefacts = ArtefactReader.read_artefacts()
@@ -94,8 +90,7 @@ class ArtefactCreator:
         navigator.navigate_to_target()
 
         if not Classifier.is_valid_classifier(classifier):
-            print("Invalid classifier provided. Please provide a valid classifier.")
-            return
+            raise ValueError("Invalid classifier provided. Please provide a valid classifier.")
 
         sub_directory = Classifier.get_sub_directory(classifier)
         file_path = self.file_system.path.join(sub_directory, f"{filename}.{classifier}")
@@ -106,7 +101,7 @@ class ArtefactCreator:
         if not self.handle_existing_files(file_exists):
             return
 
-        artefact = template_artefact_of_type(classifier, filename)
+        artefact = template_artefact_of_type(classifier, filename, True)
 
         if parent_classifier and parent_name:
             artefact.set_contribution(
@@ -114,11 +109,13 @@ class ArtefactCreator:
                 classifier=parent_classifier,
                 rule=rule
             )
+        else:
+            artefact.set_contribution(None, None, None)
 
         artefact_content = artefact.serialize()
         rmtree(dir_path, ignore_errors=True)
         os.makedirs(dir_path, exist_ok=True)
-        with open(file_path, 'w') as artefact_file:
+        with open(file_path, 'w', encoding='utf-8') as artefact_file:
             artefact_file.write(artefact_content)
 
         relative_file_path = os.path.relpath(file_path, original_directory)
@@ -138,7 +135,7 @@ class ArtefactCreator:
 
         title = Classifier.get_artefact_title(classifier)
 
-        with open(file_path, "r") as file:
+        with open(file_path, "r", encoding="utf-8") as file:
             for line in file:
                 if line.strip().startswith(title):
                     return line.split(':')[1].strip()

ara_cli/artefact_deleter.py

@@ -20,16 +20,14 @@ class ArtefactDeleter:
         self.navigate_to_target()
 
         if not Classifier.is_valid_classifier(classifier):
-            print("Invalid classifier provided. Please provide a valid classifier.")
-            return
+            raise ValueError("Invalid classifier provided. Please provide a valid classifier.")
 
         sub_directory = Classifier.get_sub_directory(classifier)
         file_path = self.file_system.path.join(sub_directory, f"{filename}.{classifier}")
         dir_path = self.file_system.path.join(sub_directory, f"{filename}.data")
 
         if not self.file_system.path.exists(file_path):
-            print(f"Artefact {file_path} not found.")
-            return
+            raise FileNotFoundError(f"Artefact {file_path} not found.")
         if not force:
             user_choice = input(f"Are you sure you want to delete the file {filename} and data directory if existing? (y/N): ")
 

ara_cli/artefact_fuzzy_search.py

@@ -1,11 +1,16 @@
 import difflib
 from textwrap import indent
 from typing import Optional
+from . import error_handler
+from ara_cli.error_handler import AraError
 
 
-def suggest_close_names(artefact_name: str, all_artefact_names: list[str], message: str, cutoff=0.5):
+def suggest_close_names(artefact_name: str, all_artefact_names: list[str], message: str, cutoff=0.5, report_as_error: bool = False):
     closest_matches = difflib.get_close_matches(artefact_name, all_artefact_names, cutoff=cutoff)
-    print(message)
+    if report_as_error:
+        error_handler.report_error(AraError(message))
+    else:
+        print(message)
     if not closest_matches:
         return
     print("Closest matches:")
@@ -13,32 +18,39 @@ def suggest_close_names(artefact_name: str, all_artefact_names: list[str], messa
         print(f"  - {match}")
 
 
-def suggest_close_name_matches(artefact_name: str, all_artefact_names: list[str]):
+def suggest_close_name_matches(artefact_name: str, all_artefact_names: list[str], report_as_error: bool = False):
     message = f"No match found for artefact with name '{artefact_name}'"
 
     suggest_close_names(
         artefact_name=artefact_name,
         all_artefact_names=all_artefact_names,
-        message=message
+        message=message,
+        report_as_error=report_as_error
     )
 
 
-def suggest_close_name_matches_for_parent(artefact_name: str, all_artefact_names: list[str], parent_name: str):
+def suggest_close_name_matches_for_parent(artefact_name: str, all_artefact_names: list[str], parent_name: str, report_as_error: bool = False):
     message = f"No match found for parent of '{artefact_name}' with name '{parent_name}'"
 
     suggest_close_names(
         artefact_name=parent_name,
         all_artefact_names=all_artefact_names,
-        message=message
+        message=message,
+        report_as_error=report_as_error
     )
 
 
-def find_closest_name_match(artefact_name: str, all_artefact_names: list[str]) -> Optional[str]:
-    closest_matches = difflib.get_close_matches(artefact_name, all_artefact_names, cutoff=0.5, n=1)
+def find_closest_name_matches(artefact_name: str, all_artefact_names: list[str]) -> Optional[str]:
+    closest_matches = difflib.get_close_matches(artefact_name, all_artefact_names, cutoff=0.5)
     if not closest_matches:
         return None
-    closest_match = closest_matches[0]
-    return closest_match
+    return closest_matches
+
+
+def extract_artefact_names_of_classifier(classified_files: dict[str, list[dict]], classifier: str):
+    artefact_info_of_classifier = classified_files.get(classifier, [])
+    titles = list(map(lambda artefact: artefact['title'], artefact_info_of_classifier))
+    return titles
 
 
 def find_closest_rule(parent_artefact: 'Artefact', rule: str):

ara_cli/artefact_link_updater.py

@@ -34,7 +34,7 @@ class ArtefactLinkUpdater:
             # Check if it's a file and not a directory
             elif self.file_system.path.isfile(item_path) and Classifier.is_valid_classifier(extension):
                 # Read the content of the file
-                with open(item_path, 'r') as file:
+                with open(item_path, 'r', encoding='utf-8') as file:
                     content = file.read()
 
                 # Replace all occurrences of the old name with the new name using regular expressions
@@ -42,7 +42,7 @@ class ArtefactLinkUpdater:
                     content = pattern.sub(replacement, content)
 
                 # Write the updated content back to the file
-                with open(item_path, 'w') as file:
+                with open(item_path, 'w', encoding='utf-8') as file:
                     file.write(content)
 
     def remove_links_in_related_artefacts(self, artefact_name, dir_path="."):
@@ -65,12 +65,12 @@ class ArtefactLinkUpdater:
 
             # Check if it's a file and not a directory, and if extension is a valid artefact classifier
             elif self.file_system.path.isfile(item_path) and Classifier.is_valid_classifier(extension):
-                with open(item_path, 'r') as file:
+                with open(item_path, 'r', encoding='utf-8') as file:
                     content = file.read()
 
                 # Remove the artefact name from 'Contributes to' and 'Illustrates' lines
                 content = contribute_pattern.sub("Contributes to", content)
                 content = illustrates_pattern.sub("Illustrates", content)
 
-                with open(item_path, 'w') as file:
+                with open(item_path, 'w', encoding='utf-8') as file:
                     file.write(content)

ara_cli/artefact_lister.py

@@ -1,9 +1,13 @@
 from ara_cli.file_classifier import FileClassifier
 from ara_cli.artefact_reader import ArtefactReader
 from ara_cli.file_lister import list_files_in_directory
-from ara_cli.artefact_models.artefact_model import Artefact
 from ara_cli.list_filter import ListFilter, filter_list
 from ara_cli.artefact_fuzzy_search import suggest_close_name_matches
+from ara_cli.artefact_models.artefact_data_retrieval import (
+    artefact_content_retrieval,
+    artefact_path_retrieval,
+    artefact_tags_retrieval,
+)
 import os
 
 
@@ -11,43 +15,18 @@ class ArtefactLister:
     def __init__(self, file_system=None):
         self.file_system = file_system or os
 
-    @staticmethod
-    def artefact_content_retrieval(artefact: Artefact):
-        content = artefact.serialize()
-        return content
-
-    @staticmethod
-    def artefact_path_retrieval(artefact: Artefact):
-        return artefact.file_path
-
-    @staticmethod
-    def artefact_tags_retrieval(artefact: Artefact):
-        final_tags = []
-
-        if not artefact:
-            return []
-
-        final_tags.extend([f"user_{user}" for user in artefact.users])
-        final_tags.append(artefact.status)
-        final_tags.extend(artefact.tags)
-
-        return final_tags
-
     def filter_artefacts(self, classified_files: list, list_filter: ListFilter):
         filtered_list = filter_list(
             list_to_filter=classified_files,
             list_filter=list_filter,
-            content_retrieval_strategy=ArtefactLister.artefact_content_retrieval,
-            file_path_retrieval=ArtefactLister.artefact_path_retrieval,
-            tag_retrieval=ArtefactLister.artefact_tags_retrieval
+            content_retrieval_strategy=artefact_content_retrieval,
+            file_path_retrieval=artefact_path_retrieval,
+            tag_retrieval=artefact_tags_retrieval,
         )
         return filtered_list
 
     def list_files(
-        self,
-        tags=None,
-        navigate_to_target=False,
-        list_filter: ListFilter | None = None
+        self, tags=None, navigate_to_target=False, list_filter: ListFilter | None = None
     ):
         artefact_list = ArtefactReader.read_artefacts(tags=tags)
         artefact_list = self.filter_artefacts(artefact_list, list_filter)
@@ -60,20 +39,18 @@ class ArtefactLister:
         file_classifier.print_classified_files(filtered_artefact_list)
 
     def list_branch(
-        self,
-        classifier,
-        artefact_name,
-        list_filter: ListFilter | None = None
+        self, classifier, artefact_name, list_filter: ListFilter | None = None
     ):
         file_classifier = FileClassifier(os)
         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]
+        matching_artefact_info = [
+            p for p in artefact_info if p["title"] == artefact_name
+        ]
 
         if not matching_artefact_info:
             suggest_close_name_matches(
-                artefact_name,
-                [info["title"] for info in artefact_info]
+                artefact_name, [info["title"] for info in artefact_info]
             )
 
         artefacts_by_classifier = {classifier: []}
@@ -82,29 +59,28 @@ class ArtefactLister:
             classifier=classifier,
             artefacts_by_classifier=artefacts_by_classifier,
         )
-        artefacts_by_classifier = self.filter_artefacts(artefacts_by_classifier, list_filter)
+        artefacts_by_classifier = self.filter_artefacts(
+            artefacts_by_classifier, list_filter
+        )
         file_classifier.print_classified_files(artefacts_by_classifier)
 
     def list_children(
-        self,
-        classifier,
-        artefact_name,
-        list_filter: ListFilter | None = None
+        self, classifier, artefact_name, list_filter: ListFilter | None = None
     ):
         file_classifier = FileClassifier(os)
         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]
+        matching_artefact_info = [
+            p for p in artefact_info if p["title"] == artefact_name
+        ]
 
         if not matching_artefact_info:
             suggest_close_name_matches(
-                artefact_name,
-                [info["title"] for info in artefact_info]
+                artefact_name, [info["title"] for info in artefact_info]
             )
 
         child_artefacts = ArtefactReader.find_children(
-            artefact_name=artefact_name,
-            classifier=classifier
+            artefact_name=artefact_name, classifier=classifier
         )
 
         child_artefacts = self.filter_artefacts(child_artefacts, list_filter)
@@ -112,25 +88,23 @@ class ArtefactLister:
         file_classifier.print_classified_files(child_artefacts)
 
     def list_data(
-        self,
-        classifier,
-        artefact_name,
-        list_filter: ListFilter | None = None
+        self, classifier, artefact_name, list_filter: ListFilter | None = None
     ):
         file_classifier = FileClassifier(os)
         classified_artefact_info = file_classifier.classify_files()
         artefact_info_dict = classified_artefact_info.get(classifier, [])
 
-        matching_info = [info for info in artefact_info_dict if info["title"] == artefact_name]
+        matching_info = [
+            info for info in artefact_info_dict if info["title"] == artefact_name
+        ]
 
         if not matching_info:
             suggest_close_name_matches(
-                artefact_name,
-                [info["title"] for info in artefact_info_dict]
+                artefact_name, [info["title"] for info in artefact_info_dict]
             )
             return
 
         artefact_info = matching_info[0]
-        data_dir = os.path.splitext(artefact_info["file_path"])[0] + '.data'
+        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_data_retrieval.py

@@ -0,0 +1,23 @@
+from ara_cli.artefact_models.artefact_model import Artefact
+
+
+def artefact_content_retrieval(artefact: Artefact):
+    content = artefact.serialize()
+    return content
+
+
+def artefact_path_retrieval(artefact: Artefact):
+    return artefact.file_path
+
+
+def artefact_tags_retrieval(artefact: Artefact):
+    final_tags = []
+
+    if not artefact:
+        return []
+
+    final_tags.extend([f"user_{user}" for user in artefact.users])
+    final_tags.append(artefact.status)
+    final_tags.extend(artefact.tags)
+
+    return final_tags

ara_cli/artefact_models/artefact_load.py

@@ -2,9 +2,17 @@ from ara_cli.artefact_models.artefact_mapping import title_prefix_to_artefact_cl
 
 
 def artefact_from_content(content):
-    relevant_lines = content.splitlines()[:2]
-    for line in relevant_lines:
+    lines = content.splitlines()
+    
+    # Look through more lines to find the title, skipping empty lines
+    for line in lines:
+        line = line.strip()
+        if not line:  # Skip empty lines
+            continue
+        if line.startswith('@'):  # Skip tag lines
+            continue
+            
         for prefix, artefact_class in title_prefix_to_artefact_class.items():
-            if line.strip().startswith(prefix):
+            if line.startswith(prefix):
                 return artefact_class.deserialize(content)
     return None