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

ara_cli/artefact_models/artefact_model.py

@@ -184,6 +184,10 @@ class Artefact(BaseModel, ABC):
         default=[],
         description="Optional list of tags (0-many)",
     )
+    author: Optional[str] = Field(
+        default="creator_unknown",
+        description="Author of the artefact, must be a single entry of the form 'creator_<someone>'."
+    )
     title: str = Field(
         ...,
         description="Descriptive Artefact title (mandatory)",
@@ -252,6 +256,17 @@ class Artefact(BaseModel, ABC):
                 raise ValueError(f"Tag '{tag}' has the form of a status tag. Set `status` field instead of passing it with other tags")
             if tag.startswith("user_"):
                 raise ValueError(f"Tag '{tag} has the form of a user tag. Set `users` field instead of passing it with other tags")
+            if tag.startswith("creator_"):
+                raise ValueError(f"Tag '{tag}' has the form of an author tag. Set `author` field instead of passing it with other tags")
+        return v
+
+    @field_validator('author')
+    def validate_author(cls, v):
+        if v:
+            if not v.startswith("creator_"):
+                raise ValueError(f"Author '{v}' must start with 'creator_'.")
+            if len(v) <= len("creator_"):
+                raise ValueError("Creator name cannot be empty in author tag.")
         return v
 
     @field_validator('title')
@@ -291,32 +306,81 @@ class Artefact(BaseModel, ABC):
         tag_line = lines[0]
         if not tag_line.startswith('@'):
             return {}, lines
+
         tags = tag_line.split()
+        tag_dict = cls._process_tags(tags)
+        return tag_dict, lines[1:]
+
+    @classmethod
+    def _process_tags(cls, tags) -> Dict[str, str]:
+        """Process a list of tags and return a dictionary with categorized tags."""
         status = None
         regular_tags = []
         users = []
-        status_list = ["@to-do", "@in-progress", "@review", "@done", "@closed"]
-        user_prefix = "@user_"
-        user_prefix_length = len(user_prefix)
-
+        author = None
+        
         for tag in tags:
-            if not tag.startswith('@'):
-                raise ValueError(f"Tag '{tag}' should start with '@' but started with '{tag[0]}'")
-            if tag in status_list and status is not None:
-                raise ValueError(f"Multiple status tags found: '@{status}' and '{tag}'")
-            if tag in status_list:
-                status = tag[1:]
-                continue
-            if tag.startswith("@user_") and len(tag) > user_prefix_length + 1:
-                users.append(tag[user_prefix_length:])
-                continue
-            regular_tags.append(tag[1:])
-        tag_dict = {
+            cls._validate_tag_format(tag)
+            
+            if cls._is_status_tag(tag):
+                status = cls._process_status_tag(tag, status)
+            elif cls._is_user_tag(tag):
+                users.append(cls._extract_user_from_tag(tag))
+            elif cls._is_author_tag(tag):
+                author = cls._process_author_tag(tag, author)
+            else:
+                regular_tags.append(tag[1:])
+        
+        return {
             "status": status,
             "users": users,
-            "tags": regular_tags
+            "tags": regular_tags,
+            "author": author
         }
-        return tag_dict, lines[1:]
+
+    @classmethod
+    def _validate_tag_format(cls, tag):
+        """Validate that tag starts with @."""
+        if not tag.startswith('@'):
+            raise ValueError(f"Tag '{tag}' should start with '@' but started with '{tag[0]}'")
+
+    @classmethod
+    def _is_status_tag(cls, tag) -> bool:
+        """Check if tag is a status tag."""
+        status_list = ["@to-do", "@in-progress", "@review", "@done", "@closed"]
+        return tag in status_list
+
+    @classmethod
+    def _process_status_tag(cls, tag, current_status):
+        """Process status tag and check for duplicates."""
+        if current_status is not None:
+            raise ValueError(f"Multiple status tags found: '@{current_status}' and '{tag}'")
+        return tag[1:]  # Remove @ prefix
+
+    @classmethod
+    def _is_user_tag(cls, tag) -> bool:
+        """Check if tag is a user tag."""
+        user_prefix = "@user_"
+        return tag.startswith(user_prefix) and len(tag) > len(user_prefix)
+
+    @classmethod
+    def _extract_user_from_tag(cls, tag) -> str:
+        """Extract username from user tag."""
+        user_prefix = "@user_"
+        return tag[len(user_prefix):]
+
+    @classmethod
+    def _is_author_tag(cls, tag) -> bool:
+        """Check if tag is an author tag."""
+        creator_prefix = "@creator_"
+        return tag.startswith(creator_prefix) and len(tag) > len(creator_prefix)
+
+    @classmethod
+    def _process_author_tag(cls, tag, current_author):
+        """Process author tag and check for duplicates."""
+        if current_author is not None:
+            raise ValueError(f"Multiple author tags found: '@{current_author}' and '@{tag[1:]}'")
+        return tag[1:] 
 
     @classmethod
     def _deserialize_title(cls, lines) -> (str, List[str]):
@@ -346,14 +410,26 @@ class Artefact(BaseModel, ABC):
         return contribution, lines
 
     @classmethod
-    def _deserialize_description(cls, lines) -> (Optional[str], List[str]):
+    def _deserialize_description(cls, lines: List[str]) -> (Optional[str], List[str]):
         description_start = cls._description_starts_with()
+        start_index = -1
         for i, line in enumerate(lines):
             if line.startswith(description_start):
-                description = line[len(description_start):].strip()
-                del lines[i]
-                return description, lines
-        return None, lines
+                start_index = i
+                break
+
+        if start_index == -1:
+            return None, lines
+
+        first_line_content = lines[start_index][len(description_start):].strip()
+
+        description_lines = ([first_line_content] if first_line_content else []) + lines[start_index + 1:]
+
+        description = "\n".join(description_lines)
+
+        remaining_lines = lines[:start_index]
+
+        return (description if description else None), remaining_lines
 
     @classmethod
     def _parse_common_fields(cls, text: str) -> dict:
@@ -367,7 +443,7 @@ class Artefact(BaseModel, ABC):
         contribution, remaining_lines = cls._deserialize_contribution(remaining_lines)
         description, remaining_lines = cls._deserialize_description(remaining_lines)
 
-        return {
+        fields = {
             'artefact_type': cls._artefact_type(),
             'tags': tags.get('tags', []),
             'users': tags.get('users', []),
@@ -376,6 +452,9 @@ class Artefact(BaseModel, ABC):
             'contribution': contribution,
             'description': description,
         }
+        if tags.get("author"):
+            fields["author"] = tags.get("author")
+        return fields
 
     @classmethod
     def deserialize(cls, text: str) -> 'Artefact':
@@ -407,6 +486,8 @@ class Artefact(BaseModel, ABC):
             tags.append(f"@{self.status}")
         for user in self.users:
             tags.append(f"@user_{user}")
+        if self.author:
+            tags.append(f"@{self.author}")
         for tag in self.tags:
             tags.append(f"@{tag}")
         return ' '.join(tags)
@@ -430,4 +511,4 @@ class Artefact(BaseModel, ABC):
             classifier=classifier,
             rule=rule
         )
-        self.contribution = contribution
+        self.contribution = contribution

ara_cli/artefact_models/artefact_templates.py

@@ -29,7 +29,8 @@ def _default_vision(title: str, use_default_contribution: bool) -> VisionArtefac
         our_product="<statement of primary differentiation>"
     )
     return VisionArtefact(
-        tags=["sample_tag"],
+        tags=[],
+        author="creator_unknown",
         title=title,
         description="<further optional description to understand the vision, markdown capable text formatting>",
         intent=intent,
@@ -44,7 +45,8 @@ def _default_businessgoal(title: str, use_default_contribution: bool) -> Busines
         i_want="<something that helps me to reach my monetary goal>"
     )
     return BusinessgoalArtefact(
-        tags=["sample_tag"],
+        tags=[],
+        author="creator_unknown",
         title=title,
         description="<further optional description to understand the businessgoal, markdown capable text formatting>",
         intent=intent,
@@ -57,7 +59,8 @@ def _default_capability(title: str, use_default_contribution: bool) -> Capabilit
         to_be_able_to="<needed capability for stakeholders that are the enablers/relevant for reaching the business goal>"
     )
     return CapabilityArtefact(
-        tags=["sample_tag"],
+        tags=[],
+        author="creator_unknown",
         title=title,
         description="<further optional description to understand the capability, markdown capable text formatting>",
         intent=intent,
@@ -77,7 +80,8 @@ def _default_epic(title: str, use_default_contribution: bool) -> EpicArtefact:
         "<rule needed to fulfill the wanted product behavior>"
     ]
     return EpicArtefact(
-        tags=["sample_tag"],
+        tags=[],
+        author="creator_unknown",
         title=title,
         description="<further optional description to understand the epic, markdown capable text formatting>",
         intent=intent,
@@ -98,7 +102,8 @@ def _default_userstory(title: str, use_default_contribution: bool) -> UserstoryA
         "<rule needed to fulfill the wanted product behavior>"
     ]
     return UserstoryArtefact(
-        tags=["sample_tag"],
+        tags=[],
+        author="creator_unknown",
         title=title,
         description="<further optional description to understand the userstory, markdown capable text formatting>",
         intent=intent,
@@ -110,7 +115,8 @@ def _default_userstory(title: str, use_default_contribution: bool) -> UserstoryA
 
 def _default_example(title: str, use_default_contribution: bool) -> ExampleArtefact:
     return ExampleArtefact(
-        tags=["sample_tag"],
+        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
@@ -130,7 +136,8 @@ def _default_keyfeature(title: str, use_default_contribution: bool) -> Keyfeatur
     THEN some result is to be expected
     AND some other result is to be expected>"""
     return KeyfeatureArtefact(
-        tags=["sample_tag"],
+        tags=[],
+        author="creator_unknown",
         title=title,
         description=description,
         intent=intent,
@@ -148,9 +155,9 @@ def _default_feature(title: str, use_default_contribution: bool) -> FeatureArtef
         Scenario(
             title="<descriptive_scenario_title>",
             steps=[
-                "Given <precondition>",
-                "When <action>",
-                "Then <expected result>"
+                "Given [precondition]",
+                "When [action]",
+                "Then [expected result]"
             ],
         ),
         ScenarioOutline(
@@ -185,7 +192,8 @@ def _default_feature(title: str, use_default_contribution: bool) -> FeatureArtef
     description = """<further optional description to understand the feature, no format defined, the example artefact is only a placeholder>"""
 
     return FeatureArtefact(
-        tags=["sample_tag"],
+        tags=[],
+        author="creator_unknown",
         title=title,
         description=description,
         intent=intent,
@@ -196,7 +204,8 @@ def _default_feature(title: str, use_default_contribution: bool) -> FeatureArtef
 
 def _default_task(title: str, use_default_contribution: bool) -> TaskArtefact:
     return TaskArtefact(
-        status="to-do",
+        tags=[],
+        status=None,
         title=title,
         description="<further optional description to understand the task, no format defined>",
         contribution=default_contribution() if use_default_contribution else None
@@ -214,7 +223,8 @@ def _default_issue(title: str, use_default_contribution: bool) -> IssueArtefact:
     *or optional free text description*"""
 
     return IssueArtefact(
-        tags=["sample_tag"],
+        tags=[],
+        author="creator_unknown",
         title=title,
         description=description,
         additional_description=additional_description,

ara_cli/artefact_models/epic_artefact_model.py

@@ -1,5 +1,5 @@
 from ara_cli.artefact_models.artefact_model import Artefact, ArtefactType, Intent
-from pydantic import Field, field_validator
+from pydantic import Field, field_validator, model_validator
 from typing import List, Tuple, Optional
 
 
@@ -91,6 +91,15 @@ class EpicArtefact(Artefact):
         description="Rules the epic defines. It is recommended to create rules to clarify the desired outcome"
     )
 
+    @model_validator(mode='after')
+    def check_for_misplaced_rules(self) -> 'EpicArtefact':
+        if self.description:
+            desc_lines = self.description.split('\n')
+            for line in desc_lines:
+                if line.strip().startswith("Rule:"):
+                    raise ValueError("Found 'Rule:' inside description. Rules must be defined before the 'Description:' section.")
+        return self
+
     @field_validator('artefact_type')
     def validate_artefact_type(cls, v):
         if v != ArtefactType.epic:
@@ -166,4 +175,4 @@ class EpicArtefact(Artefact):
             lines.append("")
         lines.append(description)
         lines.append("")
-        return "\n".join(lines)
+        return "\n".join(lines)

ara_cli/artefact_models/feature_artefact_model.py

@@ -148,6 +148,30 @@ class Scenario(BaseModel):
             raise ValueError("steps list must not be empty")
         return steps
 
+    @model_validator(mode='after')
+    def check_no_placeholders(cls, values: 'Scenario') -> 'Scenario':
+        """Ensure regular scenarios don't contain placeholders that should be in scenario outlines."""
+        placeholders = set()
+        for step in values.steps:
+            # Skip validation if step contains docstring placeholders (during parsing)
+            if '__DOCSTRING_PLACEHOLDER_' in step:
+                continue
+            
+            # Skip validation if step contains docstring markers (after reinjection)
+            if '"""' in step:
+                continue
+                
+            found = re.findall(r'<([^>]+)>', step)
+            placeholders.update(found)
+        
+        if placeholders:
+            placeholder_list = ', '.join(f"<{p}>" for p in sorted(placeholders))
+            raise ValueError(
+                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
+
     @classmethod
     def from_lines(cls, lines: List[str], start_idx: int) -> Tuple['Scenario', int]:
         """Parse a Scenario from a list of lines starting at start_idx."""
@@ -277,6 +301,37 @@ class FeatureArtefact(Artefact):
                 f"FeatureArtefact must have artefact_type of '{ArtefactType.feature}', not '{v}'")
         return v
 
+    @classmethod
+    def _deserialize_description(cls, lines: List[str]) -> (Optional[str], List[str]):
+        description_start = cls._description_starts_with()
+        scenario_markers = ["Scenario:", "Scenario Outline:"]
+
+        start_index = -1
+        for i, line in enumerate(lines):
+            if line.startswith(description_start):
+                start_index = i
+                break
+
+        if start_index == -1:
+            return None, lines
+
+        end_index = len(lines)
+        for i in range(start_index + 1, len(lines)):
+            if any(lines[i].startswith(marker) for marker in scenario_markers):
+                end_index = i
+                break
+
+        first_line_content = lines[start_index][len(description_start):].strip()
+
+        description_lines_list = [first_line_content] if first_line_content else []
+        description_lines_list.extend(lines[start_index+1:end_index])
+
+        description = "\n".join(description_lines_list).strip() or None
+
+        remaining_lines = lines[:start_index] + lines[end_index:]
+
+        return description, remaining_lines
+
     @classmethod
     def _title_prefix(cls) -> str:
         return "Feature:"
@@ -494,4 +549,4 @@ class FeatureArtefact(Artefact):
                     # or the placeholder is at the end of a line (e.g., "Then I see... __PLACEHOLDER__").
                     step = step.replace(key, value)
             rehydrated_steps.append(step)
-        return rehydrated_steps
+        return rehydrated_steps

ara_cli/artefact_models/userstory_artefact_model.py

@@ -1,5 +1,5 @@
 from ara_cli.artefact_models.artefact_model import Artefact, ArtefactType, Intent
-from pydantic import Field, field_validator
+from pydantic import Field, field_validator, model_validator
 from typing import List, Tuple
 
 
@@ -92,6 +92,18 @@ class UserstoryArtefact(Artefact):
         default_factory=list,
         description="Rules the userstory defines. It is recommended to create rules to clarify the desired outcome")
 
+    @model_validator(mode='after')
+    def check_for_misplaced_content(self) -> 'UserstoryArtefact':
+        if self.description:
+            desc_lines = self.description.split('\n')
+            for line in desc_lines:
+                stripped_line = line.strip()
+                if stripped_line.startswith("Rule:"):
+                    raise ValueError("Found 'Rule:' inside description. Rules must be defined before the 'Description:' section.")
+                if stripped_line.startswith("Estimate:"):
+                    raise ValueError("Found 'Estimate:' inside description. Estimate must be defined before the 'Description:' section.")
+        return self
+
     @field_validator('artefact_type')
     def validate_artefact_type(cls, v):
         if v != ArtefactType.userstory:
@@ -171,7 +183,7 @@ class UserstoryArtefact(Artefact):
         rules = self._serialize_rules()
 
         lines = []
-        if self.tags:
+        if tags:  # Changed from self.tags to tags to include all tag types
             lines.append(tags)
         lines.append(title)
         lines.append("")
@@ -188,4 +200,4 @@ class UserstoryArtefact(Artefact):
         lines.append(description)
         lines.append("")
 
-        return '\n'.join(lines)
+        return '\n'.join(lines)

ara_cli/artefact_reader.py

@@ -1,3 +1,4 @@
+from . import error_handler
 from ara_cli.classifier import Classifier
 from ara_cli.file_classifier import FileClassifier
 from ara_cli.artefact_models.artefact_model import Artefact
@@ -12,8 +13,7 @@ class ArtefactReader:
     @staticmethod
     def read_artefact_data(artefact_name, classifier, classified_file_info = None) -> tuple[str, dict[str, str]]:
         if not Classifier.is_valid_classifier(classifier):
-            print("Invalid classifier provided. Please provide a valid classifier.")
-            return None, None
+            raise ValueError("Invalid classifier provided. Please provide a valid classifier.")
 
         if not classified_file_info:
             file_classifier = FileClassifier(os)
@@ -74,7 +74,6 @@ class ArtefactReader:
 
     @staticmethod
     def read_artefacts(classified_artefacts=None, file_system=os, tags=None) -> Dict[str, List[Artefact]]:
-        from ara_cli.artefact_models.artefact_load import artefact_from_content
 
         if classified_artefacts is None:
             file_classifier = FileClassifier(file_system)
@@ -89,7 +88,7 @@ class ArtefactReader:
                     artefact = ArtefactReader.read_artefact(title, artefact_type, classified_artefacts)
                     artefacts[artefact_type].append(artefact)
                 except Exception as e:
-                    print(f"Failed to read {artefact_type} '{title}' with an error: ", e)
+                    error_handler.report_error(e, f"reading {artefact_type} '{title}'")
                     continue
         return artefacts
 
@@ -143,7 +142,7 @@ class ArtefactReader:
         ArtefactReader._ensure_classifier_key(classifier, artefacts_by_classifier)
 
         artefact = ArtefactReader._find_artefact_by_name(
-            artefact_name, 
+            artefact_name,
             classified_artefacts.get(classifier, [])
         )
 

ara_cli/artefact_renamer.py

@@ -1,9 +1,10 @@
-import os
 from functools import lru_cache
 from ara_cli.classifier import Classifier
 from ara_cli.artefact_link_updater import ArtefactLinkUpdater
 from ara_cli.template_manager import DirectoryNavigator
+import os
 import re
+import warnings
 
 
 class ArtefactRenamer:
@@ -22,6 +23,8 @@ class ArtefactRenamer:
         return re.compile(pattern)
 
     def rename(self, old_name, new_name, classifier):
+        import shutil
+
         original_directory = self.navigate_to_target()
 
         if not new_name:
@@ -47,7 +50,8 @@ class ArtefactRenamer:
         if self.file_system.path.exists(new_file_path):
             raise FileExistsError(f"The new file name {new_file_path} already exists.")
         if self.file_system.path.exists(new_dir_path):
-            raise FileExistsError(f"The new directory name {new_dir_path} already exists.")
+            warnings.warn(f"The new directory name {new_dir_path} already exists. It will be replaced by the artefact's data directory or removed entirely.", UserWarning)
+            shutil.rmtree(new_dir_path)
 
         # Perform the renaming of the file and directory
         self.file_system.rename(old_file_path, new_file_path)

ara_cli/artefact_scan.py

@@ -25,10 +25,10 @@ def is_rule_valid(contribution, classified_artefact_info) -> bool:
     if not rule:
         return True
     parent = ArtefactReader.read_artefact(contribution.artefact_name, contribution.classifier)
-    if not parent or not parent.rules:
+    if not parent:
         return True
     rules = parent.rules
-    if rule not in rules:
+    if not rules or rule not in rules:
         return False
     return True