ara-cli 0.1.9.53__tar.gz → 0.1.9.55__tar.gz

{ara_cli-0.1.9.53 → ara_cli-0.1.9.55}/PKG-INFO

@@ -1,3 +1,3 @@
 Metadata-Version: 2.1
 Name: ara_cli
-Version: 0.1.9.53
+Version: 0.1.9.55

{ara_cli-0.1.9.53 → ara_cli-0.1.9.55}/ara_cli/ara_command_action.py

@@ -123,8 +123,12 @@ def list_action(args):
 def list_tags_action(args):
     from ara_cli.tag_extractor import TagExtractor
 
+    tag_classifier = None
+    if args.include_classifier:
+        tag_classifier = args.include_classifier
+
     tag_extractor = TagExtractor()
-    tags = tag_extractor.extract_tags()
+    tags = tag_extractor.extract_tags(include_classifier=tag_classifier)
 
     if args.json:
         output = json.dumps({"tags": tags})

{ara_cli-0.1.9.53 → ara_cli-0.1.9.55}/ara_cli/ara_command_parser.py

@@ -120,6 +120,7 @@ def list_parser(subparsers):
 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")
 
 
 def add_chat_arguments(chat_parser):

{ara_cli-0.1.9.53 → ara_cli-0.1.9.55}/ara_cli/artefact_fuzzy_search.py

@@ -26,7 +26,7 @@ def suggest_close_name_matches_for_parent(artefact_name: str, all_artefact_names
     message = f"No match found for parent of '{artefact_name}' with name '{parent_name}'"
 
     suggest_close_names(
-        artefact_name=artefact_name,
+        artefact_name=parent_name,
         all_artefact_names=all_artefact_names,
         message=message
     )

{ara_cli-0.1.9.53 → ara_cli-0.1.9.55}/ara_cli/artefact_models/artefact_model.py

@@ -6,6 +6,7 @@ from abc import ABC, abstractmethod
 from ara_cli.classifier import Classifier
 import warnings
 import string
+import os
 
 
 ALLOWED_STATUS_VALUES = ("to-do", "in-progress", "review", "done", "closed")
@@ -188,6 +189,17 @@ class Artefact(BaseModel, ABC):
         sub_dir = Classifier.get_sub_directory(self.artefact_type)
         return f"{sub_dir}/{self.title}.{self.artefact_type}"
 
+    @model_validator(mode="after")
+    def ensure_file_path_consistency(self):
+        if not self._file_path:
+            return self
+        file_path = self._file_path
+        dir_path = os.path.dirname(file_path)
+        artefact_type = self._artefact_type()
+        file_path = f"{dir_path}/{self.title}.{artefact_type}"
+        self._file_path = file_path
+        return self
+
     @field_validator('artefact_type')
     def validate_artefact_type(cls, v):
         if not isinstance(v, ArtefactType):

ara_cli-0.1.9.55/ara_cli/artefact_renamer.py

@@ -0,0 +1,125 @@
+import os
+from functools import lru_cache
+from ara_cli.classifier import Classifier
+from ara_cli.artefact_link_updater import ArtefactLinkUpdater
+from ara_cli.artefact_reader import ArtefactReader
+from ara_cli.artefact_models.artefact_model import Contribution
+from ara_cli.template_manager import DirectoryNavigator
+from ara_cli.artefact_fuzzy_search import suggest_close_name_matches
+import re
+
+
+class ArtefactRenamer:
+    def __init__(self, file_system=None):
+        self.file_system = file_system or os
+        self.link_updater = ArtefactLinkUpdater()
+
+    @lru_cache(maxsize=None)
+    def navigate_to_target(self) -> str:
+        navigator = DirectoryNavigator()
+        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):
+        if not new_name:
+            raise ValueError("New name must be provided for renaming.")
+        if not Classifier.is_valid_classifier(classifier):
+            raise ValueError("Invalid classifier provided. Please provide a valid classifier.")
+
+        fs = self.file_system
+        original_directory = self.navigate_to_target()
+        original_directory = fs.path.abspath(original_directory)
+
+        classified_artefacts = ArtefactReader.read_artefacts()
+
+        artefacts_by_current_classifier = classified_artefacts.get(classifier, [])
+        matching_artefacts = list(filter(lambda a: a.title == old_name, artefacts_by_current_classifier))
+
+        if not matching_artefacts:
+            all_artefact_names = [artefact.title for artefact in artefacts_by_current_classifier]
+            suggest_close_name_matches(old_name, all_artefact_names)
+            return
+
+        matching_artefact = matching_artefacts[0]
+
+        old_file_path = matching_artefact.file_path
+        old_base_path = fs.path.dirname(old_file_path)
+        old_dir_path = f"{old_base_path}/{old_name}.data"
+
+        old_dir_exists = fs.path.exists(old_dir_path)
+
+        if not fs.path.exists(old_file_path):
+            raise FileNotFoundError(f"The file {old_file_path} does not exist.")
+
+        children_by_classifier = ArtefactReader.find_children(
+            artefact_name=old_name,
+            classifier=classifier,
+            classified_artefacts=classified_artefacts
+        )
+
+        matching_artefact.title = new_name
+        new_file_path = matching_artefact.file_path
+        new_base_path = fs.path.dirname(new_file_path)
+        new_dir_path = f"{new_base_path}/{new_name}.data"
+        if fs.path.exists(new_file_path):
+            raise FileExistsError(f"The new file name {new_file_path} already exists.")
+        if fs.path.exists(new_dir_path):
+            raise FileExistsError(f"The new directory name {new_dir_path} already exists.")
+
+        serialized_artefact = matching_artefact.serialize()
+        with open(matching_artefact.file_path, 'w') as file:
+            file.write(serialized_artefact)
+        fs.remove(old_file_path)
+
+        absolute_old_file_path = fs.path.abspath(old_file_path)
+        absolute_new_file_path = fs.path.abspath(new_file_path)
+        print(f"Renamed file: {absolute_old_file_path} to {absolute_new_file_path}")
+
+        if old_dir_exists:
+            absolute_old_dir_path = fs.path.abspath(old_dir_path)
+            absolute_new_dir_path = fs.path.abspath(new_dir_path)
+            fs.rename(old_dir_path, new_dir_path)
+            print(f"Renamed directory: {absolute_old_dir_path} to {absolute_new_dir_path}")
+
+        for children in children_by_classifier.values():
+            for child in children:
+                contribution = child.contribution
+                contribution.artefact_name = new_name
+                child.contribution = contribution
+                serialized_artefact = child.serialize()
+                with open(child.file_path, 'w') as file:
+                    file.write(serialized_artefact)
+
+        fs.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('_', ' ')
+
+        # Get the artefact title prefix using the classifier
+        title_prefix = Classifier.get_artefact_title(classifier.lower())
+
+        if not title_prefix:
+            raise ValueError(f"Invalid classifier: {classifier}")
+
+        # Read the file content
+        with open(artefact_path, 'r') as file:
+            content = file.read()
+
+        # Find the old title line
+        old_title_line = next((line for line in content.split('\n') if self.compile_pattern(f"^{title_prefix}").match(line)), None)
+        if old_title_line is None:
+            raise ValueError(f"The artefact file does not contain the title prefix '{title_prefix}'.")
+
+        # Construct the new title line without adding an extra colon
+        new_title_line = f"{title_prefix}: {formatted_new_title}"
+        # Replace the old title line with the new title line in the content
+        new_content = content.replace(old_title_line, new_title_line, 1)
+
+        # Write the updated content back to the file
+        with open(artefact_path, 'w') as file:
+            file.write(new_content)

{ara_cli-0.1.9.53 → ara_cli-0.1.9.55}/ara_cli/tag_extractor.py

@@ -6,7 +6,7 @@ class TagExtractor:
     def __init__(self, file_system=None):
         self.file_system = file_system or os
 
-    def extract_tags(self, navigate_to_target=False):
+    def extract_tags(self, navigate_to_target=False, include_classifier=None):
         from ara_cli.template_manager import DirectoryNavigator
         from ara_cli.artefact_reader import ArtefactReader
 
@@ -16,6 +16,9 @@ class TagExtractor:
 
         artefacts = ArtefactReader.read_artefacts()
 
+        if include_classifier:
+            artefacts = {include_classifier: artefacts[include_classifier]}
+
         unique_tags = set()
 
         for artefact_list in artefacts.values():

{ara_cli-0.1.9.53 → ara_cli-0.1.9.55}/ara_cli/tests/test_artefact_renamer.py

@@ -19,13 +19,6 @@ def cleanup():
         shutil.rmtree(new_data_dir)
 
 
-@patch("ara_cli.artefact_renamer.os.path.exists")
-def test_rename_checks_filename_exists(mock_exists):
-    mock_exists.return_value = False
-    ar = ArtefactRenamer(os)
-    with pytest.raises(FileNotFoundError):
-        ar.rename("nonexistent_file", "new_file", "vision")
-
 def test_rename_checks_classifier_valid():
     ar = ArtefactRenamer(os)
     with pytest.raises(ValueError):
@@ -38,60 +31,6 @@ def test_rename_checks_new_name_provided():
         ar.rename("existing_file", None, None)
 
 
-@patch("builtins.open", new_callable=mock_open, read_data="Vision: Old Title\nOther content.")
-@patch("ara_cli.artefact_renamer.os.rename")
-@patch("ara_cli.artefact_renamer.os.path.exists", side_effect=[True, True, False, False, True])
-def test_rename_filename_with_new_name(mock_exists, mock_rename, mock_open):
-    ar = ArtefactRenamer(os)
-    ar.rename("existing_file", "new_file", "vision")
-    assert mock_rename.call_count == 2
-    mock_rename.assert_has_calls([
-        call("vision/existing_file.vision", "vision/new_file.vision"),
-        call("vision/existing_file.data", "vision/new_file.data")
-    ])
-
-
-@patch("ara_cli.artefact_renamer.os.path.exists", side_effect=[True, True, True, False])
-def test_rename_throws_error_if_new_file_or_directory_exists(mock_exists):
-    ar = ArtefactRenamer(os)
-    with pytest.raises(FileExistsError):
-        ar.rename("existing_file", "existing_file", "vision")
-
-
-@patch("ara_cli.artefact_renamer.os.path.exists", side_effect=[True, False, False])
-def test_rename_checks_related_data_folder_exists(mock_exists):
-    ar = ArtefactRenamer(os)
-    with pytest.raises(FileNotFoundError):
-        ar.rename("old_name", "new_name", "userstory")
-
-
-@patch("builtins.open", new_callable=mock_open, read_data="Userstory: Old Title\nOther content.")
-@patch("ara_cli.artefact_renamer.os.rename")
-@patch("ara_cli.artefact_renamer.os.path.exists", side_effect=[True, True, False, False, True])
-def test_rename_also_renames_related_data_folder(mock_exists, mock_rename, mock_open):
-    ar = ArtefactRenamer(os)
-    ar.rename("old_name", "new_name", "userstory")
-    assert mock_rename.call_count == 2
-    mock_rename.assert_has_calls([
-        call("userstories/old_name.userstory", "userstories/new_name.userstory"),
-        call("userstories/old_name.data", "userstories/new_name.data")
-    ])
-
-
-@patch("ara_cli.artefact_renamer.os.path.exists", side_effect=[True, True, True])
-def test_rename_throws_error_if_new_file_path_exists(mock_exists):
-    ar = ArtefactRenamer()
-    with pytest.raises(FileExistsError):
-        ar.rename("old_name", "new_name", "userstory")
-
-
-@patch("ara_cli.artefact_renamer.os.path.exists", side_effect=[True, True, False, True])
-def test_rename_throws_error_if_new_data_directory_exists(mock_exists):
-    ar = ArtefactRenamer()
-    with pytest.raises(FileExistsError):
-        ar.rename("old_name", "new_name", "userstory")
-
-
 @pytest.mark.parametrize("classifier,artefact_name,read_data_prefix,old_title,new_title", [
     ("vision", "Vision", "Vision: ", "Old Title", "New title"),
     ("businessgoal", "Businessgoal", "Businessgoal: ", "Old Title", "New title"),

ara_cli-0.1.9.55/ara_cli/tests/test_tag_extractor.py

@@ -0,0 +1,54 @@
+import pytest
+from unittest.mock import MagicMock, patch
+from ara_cli.tag_extractor import TagExtractor
+
+
+@pytest.fixture
+def artefact():
+    """Fixture to create a mock artefact object."""
+    class Artefact:
+        def __init__(self, tags, status, users):
+            self.tags = tags
+            self.status = status
+            self.users = users
+    return Artefact
+
+
+@pytest.mark.parametrize("navigate_to_target, include_classifier, artefact_data, expected_tags", [
+    (False, None, {'artefacts': [
+        (['tag1', 'tag2'], 'status1', ['user1', 'user2']),
+        (['tag3'], 'status2', ['user3'])
+    ]}, ['status1', 'status2', 'tag1', 'tag2', 'tag3', 'user_user1', 'user_user2', 'user_user3']),
+
+    (False, 'key', {'key': [
+        (['tag1', 'tag2'], 'status1', ['user1', 'user2'])
+    ]}, ['status1', 'tag1', 'tag2', 'user_user1', 'user_user2']),
+
+    (True, None, {'artefacts': [
+        (['tag3'], 'status2', ['user3'])
+    ]}, ['status2', 'tag3', 'user_user3'])
+])
+@patch('ara_cli.template_manager.DirectoryNavigator')
+@patch('ara_cli.artefact_reader.ArtefactReader')
+def test_extract_tags(mock_artefact_reader, mock_directory_navigator, artefact, navigate_to_target, include_classifier, artefact_data, expected_tags):
+    # Mock the artefact reader to return artefact data
+    mock_artefact_reader.read_artefacts.return_value = {key: [artefact(
+        *data) for data in artefact_list] for key, artefact_list in artefact_data.items()}
+
+    # Mock the directory navigator
+    mock_navigator_instance = mock_directory_navigator.return_value
+    mock_navigator_instance.navigate_to_target = MagicMock()
+
+    tag_extractor = TagExtractor()
+
+    # Run the extract_tags method with include_classifier
+    result = tag_extractor.extract_tags(
+        navigate_to_target=navigate_to_target, include_classifier=include_classifier)
+
+    # Assertions
+    if navigate_to_target:
+        mock_navigator_instance.navigate_to_target.assert_called_once()
+    else:
+        mock_navigator_instance.navigate_to_target.assert_not_called()
+
+    assert result == expected_tags

{ara_cli-0.1.9.53 → ara_cli-0.1.9.55}/ara_cli/version.py

@@ -1,2 +1,2 @@
 # version.py
-__version__ = "0.1.9.53"   # fith parameter like .0 for local install test purposes only. official numbers should be 4 digit numbers
+__version__ = "0.1.9.55"   # fith parameter like .0 for local install test purposes only. official numbers should be 4 digit numbers

{ara_cli-0.1.9.53 → ara_cli-0.1.9.55}/ara_cli.egg-info/PKG-INFO

@@ -1,3 +1,3 @@
 Metadata-Version: 2.1
 Name: ara-cli
-Version: 0.1.9.53
+Version: 0.1.9.55

ara_cli-0.1.9.53/ara_cli/artefact_renamer.py

@@ -1,93 +0,0 @@
-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 re
-
-
-class ArtefactRenamer:
-    def __init__(self, file_system=None):
-        self.file_system = file_system or os
-        self.link_updater = ArtefactLinkUpdater()
-
-    @lru_cache(maxsize=None)
-    def navigate_to_target(self) -> str:
-        navigator = DirectoryNavigator()
-        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):
-        original_directory = self.navigate_to_target()
-
-        if not new_name:
-            raise ValueError("New name must be provided for renaming.")
-
-        if not Classifier.is_valid_classifier(classifier):
-            raise ValueError("Invalid classifier provided. Please provide a valid classifier.")
-
-        sub_directory = Classifier.get_sub_directory(classifier)
-        old_file_path = self.file_system.path.join(sub_directory, f"{old_name}.{classifier}")
-        new_file_path = self.file_system.path.join(sub_directory, f"{new_name}.{classifier}")
-
-        old_dir_path = self.file_system.path.join(sub_directory, f"{old_name}.data")
-        new_dir_path = self.file_system.path.join(sub_directory, f"{new_name}.data")
-
-        old_dir_exists = self.file_system.path.exists(old_dir_path)
-
-        # Check if the original file exists
-        if not self.file_system.path.exists(old_file_path):
-            raise FileNotFoundError(f"The file {old_file_path} does not exist.")
-
-        # Check if the new file name and directory already exist
-        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.")
-
-        # 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)
-            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)
-
-        # 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('_', ' ')
-
-        # Get the artefact title prefix using the classifier
-        title_prefix = Classifier.get_artefact_title(classifier.lower())
-
-        if not title_prefix:
-            raise ValueError(f"Invalid classifier: {classifier}")
-
-        # Read the file content
-        with open(artefact_path, 'r') as file:
-            content = file.read()
-
-        # Find the old title line
-        old_title_line = next((line for line in content.split('\n') if self.compile_pattern(f"^{title_prefix}").match(line)), None)
-        if old_title_line is None:
-            raise ValueError(f"The artefact file does not contain the title prefix '{title_prefix}'.")
-
-        # Construct the new title line without adding an extra colon
-        new_title_line = f"{title_prefix}: {formatted_new_title}"
-        # Replace the old title line with the new title line in the content
-        new_content = content.replace(old_title_line, new_title_line, 1)
-
-        # Write the updated content back to the file
-        with open(artefact_path, 'w') as file:
-            file.write(new_content)

ara_cli-0.1.9.53/ara_cli/tests/test_tag_extractor.py

@@ -1,45 +0,0 @@
-import pytest
-from unittest.mock import MagicMock, patch
-from ara_cli.tag_extractor import TagExtractor  # Adjust the import based on your project structure
-
-@pytest.fixture
-def artefact():
-    """Fixture to create a mock artefact object."""
-    class Artefact:
-        def __init__(self, tags, status, users):
-            self.tags = tags
-            self.status = status
-            self.users = users
-
-    return Artefact
-
-@pytest.mark.parametrize("navigate_to_target, artefact_data, expected_tags", [
-    (False, {'artefacts': [(
-        ['tag1', 'tag2'], 'status1', ['user1', 'user2']
-    )]}, ['status1', 'tag1', 'tag2', 'user_user1', 'user_user2']),
-    (True, {'artefacts': [(
-        ['tag3'], 'status2', ['user3']
-    )]}, ['status2', 'tag3', 'user_user3'])
-])
-@patch('ara_cli.template_manager.DirectoryNavigator')
-@patch('ara_cli.artefact_reader.ArtefactReader')
-def test_extract_tags(mock_artefact_reader, mock_directory_navigator, artefact, navigate_to_target, artefact_data, expected_tags):
-    # Mock the artefact reader to return artefact data
-    mock_artefact_reader.read_artefacts.return_value = {'key': [artefact(*data) for data in artefact_data['artefacts']]}
-
-    # Mock the directory navigator
-    mock_navigator_instance = mock_directory_navigator.return_value
-    mock_navigator_instance.navigate_to_target = MagicMock()
-
-    tag_extractor = TagExtractor()
-
-    # Run the extract_tags method
-    result = tag_extractor.extract_tags(navigate_to_target=navigate_to_target)
-
-    # Assertions
-    if navigate_to_target:
-        mock_navigator_instance.navigate_to_target.assert_called_once()
-    else:
-        mock_navigator_instance.navigate_to_target.assert_not_called()
-
-    assert result == expected_tags