ara-cli 0.1.13.3__py3-none-any.whl → 0.1.14.0__py3-none-any.whl

ara_cli/artefact_creator.py

@@ -27,11 +27,21 @@ class ArtefactCreator:
             raise ValueError("classifier must not be None or empty!")
 
         # Standard prompt log artefact
-        self._copy_template_file(dir_path, template_path, f"template.{classifier}.prompt_log.md", f"{classifier}.prompt_log.md")
+        self._copy_template_file(
+            dir_path,
+            template_path,
+            f"template.{classifier}.prompt_log.md",
+            f"{classifier}.prompt_log.md",
+        )
 
         # Additional prompt log artefact for 'feature' classifier
-        if classifier == 'feature':
-            self._copy_template_file(dir_path, template_path, "template.steps.prompt_log.md", "steps.prompt_log.md")
+        if classifier == "feature":
+            self._copy_template_file(
+                dir_path,
+                template_path,
+                "template.steps.prompt_log.md",
+                "steps.prompt_log.md",
+            )
 
     def _copy_template_file(self, dir_path, template_path, source_name, dest_name):
         source = Path(template_path) / source_name
@@ -41,7 +51,9 @@ class ArtefactCreator:
             raise FileNotFoundError(f"Source file {source} not found!")
 
         if not destination.parent.exists():
-            raise NotADirectoryError(f"Destination directory {destination.parent} does not exist!")
+            raise NotADirectoryError(
+                f"Destination directory {destination.parent} does not exist!"
+            )
 
         copyfile(source, destination)
 
@@ -59,7 +71,9 @@ class ArtefactCreator:
 
     def handle_existing_files(self, file_exists):
         if file_exists:
-            user_choice = input("File already exists. Do you want to overwrite the existing file and directory? (y/N): ")
+            user_choice = input(
+                "File already exists. Do you want to overwrite the existing file and directory? (y/N): "
+            )
             if user_choice.lower() != "y":
                 print("No changes were made to the existing file and directory.")
                 return False
@@ -68,14 +82,20 @@ class ArtefactCreator:
     def validate_template(self, template_path, classifier):
         template_name = f"template.{classifier}"
         if not self.template_exists(template_path, template_name):
-            raise FileNotFoundError(f"Template file '{template_name}' not found in the specified template path.")
+            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()
+    def set_artefact_parent(
+        self, artefact, parent_classifier, parent_file_name
+    ) -> Artefact:
+        classified_artefacts = ArtefactReader(self.file_system).read_artefacts()
         if parent_classifier not in classified_artefacts:
             return artefact
         artefact_list = classified_artefacts[parent_classifier]
-        matching_artefacts = list(filter(lambda a: a.file_name == parent_file_name, artefact_list))
+        matching_artefacts = list(
+            filter(lambda a: a.file_name == parent_file_name, artefact_list)
+        )
         if not matching_artefacts:
             artefact_names_list = [a.file_name for a in artefact_list]
             suggest_close_name_matches(parent_file_name, artefact_names_list)
@@ -83,17 +103,23 @@ class ArtefactCreator:
         artefact._parent = matching_artefacts[0]
         return artefact
 
-    def run(self, filename, classifier, parent_classifier=None, parent_name=None, rule=None):
+    def run(
+        self, filename, classifier, parent_classifier=None, parent_name=None, rule=None
+    ):
         # make sure this function is always called from the ara top level directory
         original_directory = os.getcwd()
         navigator = DirectoryNavigator()
         navigator.navigate_to_target()
 
         if not Classifier.is_valid_classifier(classifier):
-            raise ValueError("Invalid classifier provided. Please provide a valid classifier.")
+            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}")
+        file_path = self.file_system.path.join(
+            sub_directory, f"{filename}.{classifier}"
+        )
         dir_path = self.file_system.path.join(sub_directory, f"{filename}.data")
 
         file_exists = self.file_system.path.exists(file_path)
@@ -105,9 +131,7 @@ class ArtefactCreator:
 
         if parent_classifier and parent_name:
             artefact.set_contribution(
-                artefact_name=parent_name,
-                classifier=parent_classifier,
-                rule=rule
+                artefact_name=parent_name, classifier=parent_classifier, rule=rule
             )
         else:
             artefact.set_contribution(None, None, None)
@@ -115,7 +139,7 @@ class ArtefactCreator:
         artefact_content = artefact.serialize()
         rmtree(dir_path, ignore_errors=True)
         os.makedirs(dir_path, exist_ok=True)
-        with open(file_path, 'w', encoding='utf-8') 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,6 +162,6 @@ class ArtefactCreator:
         with open(file_path, "r", encoding="utf-8") as file:
             for line in file:
                 if line.strip().startswith(title):
-                    return line.split(':')[1].strip()
+                    return line.split(":")[1].strip()
 
         raise ValueError(f"Title not found in the parent file {file_path}")

ara_cli/artefact_lister.py

@@ -28,7 +28,7 @@ class ArtefactLister:
     def list_files(
         self, tags=None, navigate_to_target=False, list_filter: ListFilter | None = None
     ):
-        artefact_list = ArtefactReader.read_artefacts(tags=tags)
+        artefact_list = ArtefactReader(self.file_system).read_artefacts(tags=tags)
         artefact_list = self.filter_artefacts(artefact_list, list_filter)
 
         filtered_artefact_list = {
@@ -54,7 +54,7 @@ class ArtefactLister:
             )
 
         artefacts_by_classifier = {classifier: []}
-        ArtefactReader.step_through_value_chain(
+        ArtefactReader(self.file_system).step_through_value_chain(
             artefact_name=artefact_name,
             classifier=classifier,
             artefacts_by_classifier=artefacts_by_classifier,
@@ -79,7 +79,7 @@ class ArtefactLister:
                 artefact_name, [info["title"] for info in artefact_info]
             )
 
-        child_artefacts = ArtefactReader.find_children(
+        child_artefacts = ArtefactReader(self.file_system).find_children(
             artefact_name=artefact_name, classifier=classifier
         )
 

ara_cli/artefact_models/artefact_model.py

@@ -185,7 +185,7 @@ class Artefact(BaseModel, ABC):
         description="Optional list of tags (0-many)",
     )
     author: Optional[str] = Field(
-        default="creator_unknown",
+        default=None,
         description="Author of the artefact, must be a single entry of the form 'creator_<someone>'."
     )
     title: str = Field(

ara_cli/artefact_models/artefact_templates.py

@@ -30,7 +30,6 @@ def _default_vision(title: str, use_default_contribution: bool) -> VisionArtefac
     )
     return VisionArtefact(
         tags=[],
-        author="creator_unknown",
         title=title,
         description="<further optional description to understand the vision, markdown capable text formatting>",
         intent=intent,
@@ -46,7 +45,6 @@ def _default_businessgoal(title: str, use_default_contribution: bool) -> Busines
     )
     return BusinessgoalArtefact(
         tags=[],
-        author="creator_unknown",
         title=title,
         description="<further optional description to understand the businessgoal, markdown capable text formatting>",
         intent=intent,
@@ -60,7 +58,6 @@ def _default_capability(title: str, use_default_contribution: bool) -> Capabilit
     )
     return CapabilityArtefact(
         tags=[],
-        author="creator_unknown",
         title=title,
         description="<further optional description to understand the capability, markdown capable text formatting>",
         intent=intent,
@@ -81,7 +78,6 @@ def _default_epic(title: str, use_default_contribution: bool) -> EpicArtefact:
     ]
     return EpicArtefact(
         tags=[],
-        author="creator_unknown",
         title=title,
         description="<further optional description to understand the epic, markdown capable text formatting>",
         intent=intent,
@@ -103,7 +99,6 @@ def _default_userstory(title: str, use_default_contribution: bool) -> UserstoryA
     ]
     return UserstoryArtefact(
         tags=[],
-        author="creator_unknown",
         title=title,
         description="<further optional description to understand the userstory, markdown capable text formatting>",
         intent=intent,
@@ -116,7 +111,6 @@ def _default_userstory(title: str, use_default_contribution: bool) -> UserstoryA
 def _default_example(title: str, use_default_contribution: bool) -> ExampleArtefact:
     return ExampleArtefact(
         tags=[],
-        author="creator_unknown",
         title=title,
         description="<further optional description to understand the example, markdown capable text formatting>",
         contribution=default_contribution() if use_default_contribution else None
@@ -137,7 +131,6 @@ def _default_keyfeature(title: str, use_default_contribution: bool) -> Keyfeatur
     AND some other result is to be expected>"""
     return KeyfeatureArtefact(
         tags=[],
-        author="creator_unknown",
         title=title,
         description=description,
         intent=intent,
@@ -193,7 +186,6 @@ def _default_feature(title: str, use_default_contribution: bool) -> FeatureArtef
 
     return FeatureArtefact(
         tags=[],
-        author="creator_unknown",
         title=title,
         description=description,
         intent=intent,
@@ -224,7 +216,6 @@ def _default_issue(title: str, use_default_contribution: bool) -> IssueArtefact:
 
     return IssueArtefact(
         tags=[],
-        author="creator_unknown",
         title=title,
         description=description,
         additional_description=additional_description,

ara_cli/artefact_models/feature_artefact_model.py

@@ -149,10 +149,10 @@ class Scenario(BaseModel):
         return steps
 
     @model_validator(mode='after')
-    def check_no_placeholders(cls, values: 'Scenario') -> 'Scenario':
+    def check_no_placeholders(self) -> 'Scenario':
         """Ensure regular scenarios don't contain placeholders that should be in scenario outlines."""
         placeholders = set()
-        for step in values.steps:
+        for step in self.steps:
             # Skip validation if step contains docstring placeholders (during parsing)
             if '__DOCSTRING_PLACEHOLDER_' in step:
                 continue
@@ -170,7 +170,7 @@ class Scenario(BaseModel):
                 f"Scenario Contains Placeholders ({placeholder_list}) but is not a Scenario Outline. "
                 f"Use 'Scenario Outline:' instead of 'Scenario:' and provide an Examples table."
             )
-        return values
+        return self
 
     @classmethod
     def from_lines(cls, lines: List[str], start_idx: int) -> Tuple['Scenario', int]:
@@ -219,18 +219,18 @@ class ScenarioOutline(BaseModel):
         return v
 
     @model_validator(mode='after')
-    def check_placeholders(cls, values: 'ScenarioOutline') -> 'ScenarioOutline':
+    def check_placeholders(self) -> 'ScenarioOutline':
         """Ensure all placeholders in steps have corresponding values in examples."""
         placeholders = set()
-        for step in values.steps:
+        for step in self.steps:
             found = re.findall(r'<([^>]+)>', step)
             placeholders.update(found)
-        for example in values.examples:
+        for example in self.examples:
             missing = placeholders - set(example.values.keys())
             if missing:
                 raise ValueError(
                     f"Example is missing values for placeholders: {missing}")
-        return values
+        return self
 
     @classmethod
     def from_lines(cls, lines: List[str], start_idx: int) -> Tuple['ScenarioOutline', int]:
@@ -298,7 +298,7 @@ class FeatureArtefact(Artefact):
     def validate_artefact_type(cls, v):
         if v != ArtefactType.feature:
             raise ValueError(
-                f"FeatureArtefact must have artefact_type of '{ArtefactType.feature}', not '{v}'")
+                f"FeatureArtefact must have artefact_type of '{ArtefactType.feature.value}', not '{v}'")
         return v
 
     @classmethod

ara_cli/artefact_reader.py

@@ -3,20 +3,29 @@ from ara_cli.classifier import Classifier
 from ara_cli.file_classifier import FileClassifier
 from ara_cli.artefact_models.artefact_model import Artefact
 from ara_cli.artefact_models.artefact_load import artefact_from_content
-from ara_cli.artefact_fuzzy_search import suggest_close_name_matches_for_parent, suggest_close_name_matches
+from ara_cli.artefact_fuzzy_search import (
+    suggest_close_name_matches_for_parent,
+    suggest_close_name_matches,
+)
 from typing import Dict, List
 import os
 import re
 
 
 class ArtefactReader:
-    @staticmethod
-    def read_artefact_data(artefact_name, classifier, classified_file_info = None) -> tuple[str, dict[str, str]]:
+    def __init__(self, file_system=None):
+        self.file_system = file_system or os
+
+    def read_artefact_data(
+        self, artefact_name, classifier, classified_file_info=None
+    ) -> tuple[str, dict[str, str]]:
         if not Classifier.is_valid_classifier(classifier):
-            raise ValueError("Invalid classifier provided. Please provide a valid classifier.")
+            raise ValueError(
+                "Invalid classifier provided. Please provide a valid classifier."
+            )
 
         if not classified_file_info:
-            file_classifier = FileClassifier(os)
+            file_classifier = FileClassifier(self.file_system)
             classified_file_info = file_classifier.classify_files()
         artefact_info_of_classifier = classified_file_info.get(classifier, [])
 
@@ -24,21 +33,21 @@ class ArtefactReader:
             file_path = artefact_info["file_path"]
             artefact_title = artefact_info["title"]
             if artefact_title == artefact_name:
-                with open(file_path, 'r', encoding='utf-8') as file:
+                with open(file_path, "r", encoding="utf-8") as file:
                     content = file.read()
                 return content, artefact_info
 
         all_artefact_names = [info["title"] for info in artefact_info_of_classifier]
-        suggest_close_name_matches(
-            artefact_name,
-            all_artefact_names
-        )
+        suggest_close_name_matches(artefact_name, all_artefact_names)
 
         return None, None
 
-    @staticmethod
-    def read_artefact(artefact_name, classifier, classified_file_info=None) -> Artefact:
-        content, artefact_info = ArtefactReader.read_artefact_data(artefact_name, classifier, classified_file_info)
+    def read_artefact(
+        self, artefact_name, classifier, classified_file_info=None
+    ) -> Artefact:
+        content, artefact_info = self.read_artefact_data(
+            artefact_name, classifier, classified_file_info
+        )
         if not content or not artefact_info:
             return None
         file_path = artefact_info["file_path"]
@@ -49,9 +58,11 @@ class ArtefactReader:
     @staticmethod
     def extract_parent_tree(artefact_content):
         artefact_titles = Classifier.artefact_titles()
-        title_segment = '|'.join(artefact_titles)
+        title_segment = "|".join(artefact_titles)
 
-        regex_pattern = rf'(?:Contributes to|Illustrates)\s*:*\s*(.*)\s+({title_segment}).*'
+        regex_pattern = (
+            rf"(?:Contributes to|Illustrates)\s*:*\s*(.*)\s+({title_segment}).*"
+        )
         regex = re.compile(regex_pattern)
         match = re.search(regex, artefact_content)
         if not match:
@@ -72,33 +83,40 @@ class ArtefactReader:
                 merged[key].extend(artefacts)
         return dict(merged)
 
-    @staticmethod
-    def read_artefacts(classified_artefacts=None, file_system=os, tags=None) -> Dict[str, List[Artefact]]:
+    def read_artefacts(
+        self, classified_artefacts=None, tags=None
+    ) -> Dict[str, List[Artefact]]:
 
         if classified_artefacts is None:
-            file_classifier = FileClassifier(file_system)
+            file_classifier = FileClassifier(self.file_system)
             classified_artefacts = file_classifier.classify_files()
 
-        artefacts = {artefact_type: []
-                     for artefact_type in classified_artefacts.keys()}
+        artefacts = {artefact_type: [] for artefact_type in classified_artefacts.keys()}
         for artefact_type, artefact_info_dicts in classified_artefacts.items():
             for artefact_info in artefact_info_dicts:
                 title = artefact_info["title"]
                 try:
-                    artefact = ArtefactReader.read_artefact(title, artefact_type, classified_artefacts)
+                    artefact = self.read_artefact(
+                        title, artefact_type, classified_artefacts
+                    )
                     artefacts[artefact_type].append(artefact)
                 except Exception as e:
                     error_handler.report_error(e, f"reading {artefact_type} '{title}'")
                     continue
         return artefacts
 
-    @staticmethod
-    def find_children(artefact_name, classifier, artefacts_by_classifier=None, classified_artefacts=None):
+    def find_children(
+        self,
+        artefact_name,
+        classifier,
+        artefacts_by_classifier=None,
+        classified_artefacts=None,
+    ):
         artefacts_by_classifier = artefacts_by_classifier or {}
         filtered_artefacts = {k: [] for k in artefacts_by_classifier.keys()}
 
         if classified_artefacts is None:
-            classified_artefacts = ArtefactReader.read_artefacts()
+            classified_artefacts = self.read_artefacts()
 
         for artefact_classifier, artefacts in classified_artefacts.items():
             for artefact in artefacts:
@@ -112,38 +130,37 @@ class ArtefactReader:
     def _process_artefact(artefact, artefact_name, classifier, filtered_artefacts):
         if not isinstance(artefact, Artefact):
             return
-        contribution = getattr(artefact, 'contribution', None)
+        contribution = getattr(artefact, "contribution", None)
         if not contribution:
             return
-        if getattr(contribution, 'artefact_name', None) != artefact_name:
+        if getattr(contribution, "artefact_name", None) != artefact_name:
             return
-        if getattr(contribution, 'classifier', None) != classifier:
+        if getattr(contribution, "classifier", None) != classifier:
             return
 
-        file_classifier = getattr(artefact, '_file_path', '').split('.')[-1]
+        file_classifier = getattr(artefact, "_file_path", "").split(".")[-1]
         if file_classifier not in filtered_artefacts:
             filtered_artefacts[file_classifier] = []
         filtered_artefacts[file_classifier].append(artefact)
 
-    @staticmethod
     def step_through_value_chain(
-            artefact_name,
-            classifier,
-            artefacts_by_classifier=None,
-            classified_artefacts: dict[str, list['Artefact']] | None = None
+        self,
+        artefact_name,
+        classifier,
+        artefacts_by_classifier=None,
+        classified_artefacts: dict[str, list["Artefact"]] | None = None,
     ):
         from ara_cli.artefact_models.artefact_load import artefact_from_content
 
         artefacts_by_classifier = artefacts_by_classifier or {}
 
         if classified_artefacts is None:
-            classified_artefacts = ArtefactReader.read_artefacts()
+            classified_artefacts = self.read_artefacts()
 
         ArtefactReader._ensure_classifier_key(classifier, artefacts_by_classifier)
 
         artefact = ArtefactReader._find_artefact_by_name(
-            artefact_name,
-            classified_artefacts.get(classifier, [])
+            artefact_name, classified_artefacts.get(classifier, [])
         )
 
         if not artefact or artefact in artefacts_by_classifier[classifier]:
@@ -151,7 +168,7 @@ class ArtefactReader:
 
         artefacts_by_classifier[classifier].append(artefact)
 
-        parent = getattr(artefact, 'contribution', None)
+        parent = getattr(artefact, "contribution", None)
         if not ArtefactReader._has_valid_parent(parent):
             return
 
@@ -168,11 +185,11 @@ class ArtefactReader:
             print()
             return
 
-        ArtefactReader.step_through_value_chain(
+        self.step_through_value_chain(
             artefact_name=parent_name,
             classifier=parent_classifier,
             artefacts_by_classifier=artefacts_by_classifier,
-            classified_artefacts=classified_artefacts
+            classified_artefacts=classified_artefacts,
         )
 
     @staticmethod
@@ -186,13 +203,15 @@ class ArtefactReader:
 
     @staticmethod
     def _has_valid_parent(parent):
-        return parent and getattr(parent, 'artefact_name', None) and getattr(parent, 'classifier', None)
+        return (
+            parent
+            and getattr(parent, "artefact_name", None)
+            and getattr(parent, "classifier", None)
+        )
 
     @staticmethod
     def _suggest_parent_name_match(artefact_name, all_artefact_names, parent_name):
         if parent_name is not None:
             suggest_close_name_matches_for_parent(
-                artefact_name,
-                all_artefact_names,
-                parent_name
+                artefact_name, all_artefact_names, parent_name
             )

ara_cli/artefact_scan.py

@@ -4,12 +4,16 @@ import os
 
 def is_contribution_valid(contribution, classified_artefact_info) -> bool:
     from ara_cli.artefact_fuzzy_search import extract_artefact_names_of_classifier
-    if not contribution or not contribution.artefact_name or not contribution.classifier:
+
+    if (
+        not contribution
+        or not contribution.artefact_name
+        or not contribution.classifier
+    ):
         return True
 
     all_artefact_names = extract_artefact_names_of_classifier(
-        classified_files=classified_artefact_info,
-        classifier=contribution.classifier
+        classified_files=classified_artefact_info, classifier=contribution.classifier
     )
     if contribution.artefact_name not in all_artefact_names:
         return False
@@ -19,12 +23,18 @@ def is_contribution_valid(contribution, classified_artefact_info) -> bool:
 def is_rule_valid(contribution, classified_artefact_info) -> bool:
     from ara_cli.artefact_reader import ArtefactReader
 
-    if not contribution or not contribution.artefact_name or not contribution.classifier:
+    if (
+        not contribution
+        or not contribution.artefact_name
+        or not contribution.classifier
+    ):
         return True
     rule = contribution.rule
     if not rule:
         return True
-    parent = ArtefactReader.read_artefact(contribution.artefact_name, contribution.classifier)
+    parent = ArtefactReader().read_artefact(
+        contribution.artefact_name, contribution.classifier
+    )
     if not parent:
         return True
     rules = parent.rules
@@ -33,20 +43,26 @@ def is_rule_valid(contribution, classified_artefact_info) -> bool:
     return True
 
 
-def check_contribution(contribution, classified_artefact_info, file_path) -> tuple[bool, str]:
+def check_contribution(
+    contribution, classified_artefact_info, file_path
+) -> tuple[bool, str]:
     if not contribution:
         return True, None
 
     if not is_contribution_valid(contribution, classified_artefact_info):
-        reason = (f"Invalid Contribution Reference: The contribution references "
-                  f"'{contribution.classifier}' artefact '{contribution.artefact_name}' "
-                  f"which does not exist.")
+        reason = (
+            f"Invalid Contribution Reference: The contribution references "
+            f"'{contribution.classifier}' artefact '{contribution.artefact_name}' "
+            f"which does not exist."
+        )
         return False, reason
 
     if not is_rule_valid(contribution, classified_artefact_info):
-        reason = (f"Rule Mismatch: The contribution references "
-                  f"rule '{contribution.rule}' which the parent "
-                  f"{contribution.classifier} '{contribution.artefact_name}' does not have.")
+        reason = (
+            f"Rule Mismatch: The contribution references "
+            f"rule '{contribution.rule}' which the parent "
+            f"{contribution.classifier} '{contribution.artefact_name}' does not have."
+        )
         return False, reason
     return True, None
 
@@ -73,13 +89,17 @@ def check_file(file_path, artefact_class, classified_artefact_info=None):
 
         # Check title and file name matching
         if artefact_instance.title != file_name_without_ext:
-            reason = (f"Filename-Title Mismatch: The file name '{file_name_without_ext}' "
-                      f"does not match the artefact title '{artefact_instance.title}'.")
+            reason = (
+                f"Filename-Title Mismatch: The file name '{file_name_without_ext}' "
+                f"does not match the artefact title '{artefact_instance.title}'."
+            )
             return False, reason
 
         contribution = artefact_instance.contribution
 
-        contribution_valid, reason = check_contribution(contribution, classified_artefact_info, file_path)
+        contribution_valid, reason = check_contribution(
+            contribution, classified_artefact_info, file_path
+        )
         if not contribution_valid:
             return False, reason
 
@@ -100,7 +120,9 @@ def find_invalid_files(classified_artefact_info, classifier):
             continue
         if ".data" in artefact_info["file_path"]:
             continue
-        is_valid, reason = check_file(artefact_info["file_path"], artefact_class, classified_artefact_info)
+        is_valid, reason = check_file(
+            artefact_info["file_path"], artefact_class, classified_artefact_info
+        )
         if not is_valid:
             invalid_files.append((artefact_info["file_path"], reason))
     return invalid_files
@@ -122,4 +144,4 @@ def show_results(invalid_artefacts):
                 report.write("\n")
         if not has_issues:
             print("All files are good!")
-            report.write("No problems found.\n")
+            report.write("No problems found.\n")