ara-cli 0.1.9.64__tar.gz → 0.1.9.66__tar.gz

{ara_cli-0.1.9.64 → ara_cli-0.1.9.66}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ara_cli
-Version: 0.1.9.64
+Version: 0.1.9.66
 Requires-Dist: litellm
 Requires-Dist: llama-index
 Requires-Dist: llama-index-llms-openai

{ara_cli-0.1.9.64 → ara_cli-0.1.9.66}/ara_cli/ara_command_action.py

@@ -18,6 +18,8 @@ def create_action(args):
     from ara_cli.classifier import Classifier
     from ara_cli.filename_validator import is_valid_filename
     from ara_cli.template_manager import SpecificationBreakdownAspects
+    from ara_cli.artefact_reader import ArtefactReader
+    from ara_cli.artefact_fuzzy_search import find_closest_rule
 
     check_validity(Classifier.is_valid_classifier(args.classifier), "Invalid classifier provided. Please provide a valid classifier.")
     check_validity(is_valid_filename(args.parameter), "Invalid filename provided. Please provide a valid filename.")
@@ -25,11 +27,20 @@ def create_action(args):
     def handle_parent_arguments(args):
         parent_classifier = args.parent_classifier if hasattr(args, "parent_classifier") else None
         parent_name = args.parent_name if hasattr(args, "parent_name") else None
+        rule = args.rule if hasattr(args, 'rule') else None
+        invalid_classifier_message = "Invalid parent classifier provided. Please provide a valid classifier"
+        invalid_name_message = "Invalid filename provided for parent. Please provide a valid filename."
+        if parent_classifier and parent_name and rule:
+            check_validity(Classifier.is_valid_classifier(parent_classifier), invalid_classifier_message)
+            check_validity(is_valid_filename(parent_name), invalid_name_message)
+            parent_artefact = ArtefactReader.read_single_artefact(artefact_name=parent_name, classifier=parent_classifier)
+            rule = find_closest_rule(parent_artefact, rule)
+            return parent_classifier, parent_name, rule
         if parent_classifier and parent_name:
-            check_validity(Classifier.is_valid_classifier(parent_classifier), "Invalid parent classifier provided. Please provide a valid classifier")
-            check_validity(is_valid_filename(parent_name), "Invalid filename provided for parent. Please provide a valid filename.")
-            return parent_classifier, parent_name
-        return None, None
+            check_validity(Classifier.is_valid_classifier(parent_classifier), invalid_classifier_message)
+            check_validity(is_valid_filename(parent_name), invalid_name_message)
+            return parent_classifier, parent_name, rule
+        return None, None, None
 
     def handle_aspect_creation(args):
         aspect = args.aspect if hasattr(args, "aspect") else None
@@ -43,12 +54,12 @@ def create_action(args):
                 sys.exit(1)
         return False
 
-    parent_classifier, parent_name = handle_parent_arguments(args)
+    parent_classifier, parent_name, rule = handle_parent_arguments(args)
     if handle_aspect_creation(args):
         return
 
     artefact_creator = ArtefactCreator()
-    artefact_creator.run(args.parameter, args.classifier, parent_classifier, parent_name)
+    artefact_creator.run(args.parameter, args.classifier, parent_classifier, parent_name, rule)
 
 
 def delete_action(args):
@@ -122,15 +133,17 @@ def list_action(args):
 
 def list_tags_action(args):
     from ara_cli.tag_extractor import TagExtractor
+    from ara_cli.list_filter import ListFilter
 
-    tag_classifier = None
-    if args.include_classifier:
-        tag_classifier = args.include_classifier
+    list_filter = ListFilter(
+        include_extension=args.include_classifier,
+        exclude_extension=args.exclude_classifier,
+    )
 
     tag_extractor = TagExtractor()
     tags = tag_extractor.extract_tags(
-        include_classifier=tag_classifier,
-        filtered_extra_column=getattr(args, "filtered_extra_column", False)
+        filtered_extra_column=getattr(args, "filtered_extra_column", False),
+        list_filter=list_filter
     )
 
     if args.json:
@@ -340,12 +353,12 @@ def reconnect_action(args):
     artefact_name = args.parameter
     parent_classifier = args.parent_classifier
     parent_name = args.parent_name
-    rule = None
-    if args.rule:
-        rule = ' '.join(args.rule)
+    rule = args.rule if hasattr(args, 'rule') else None
 
     read_error_message = f"Could not connect {classifier} '{artefact_name}' to {parent_classifier} '{parent_name}'"
 
+    feedback_message = f"Updated contribution of {classifier} '{artefact_name}' to {parent_classifier} '{parent_name}'"
+
     content, artefact_info = ArtefactReader.read_artefact(
         artefact_name=artefact_name,
         classifier=classifier
@@ -377,15 +390,21 @@ def reconnect_action(args):
     )
 
     if rule:
-        closest_rule = find_closest_rule(parent, rule)
-        print("")
-        contribution.rule = closest_rule
+        try:
+            closest_rule = find_closest_rule(parent, rule)
+            contribution.rule = closest_rule
+            feedback_message += f" using rule '{closest_rule}'"
+        except TypeError as e:
+            print(f"{type(e).__name__}:", e)
+            exit(1)
 
     artefact.contribution = contribution
     with open(artefact.file_path, 'w') as file:
         artefact_content = artefact.serialize()
         file.write(artefact_content)
 
+    print(feedback_message + ".")
+
 
 def read_status_action(args):
     from ara_cli.file_classifier import FileClassifier

{ara_cli-0.1.9.64 → ara_cli-0.1.9.66}/ara_cli/ara_command_parser.py

@@ -18,6 +18,7 @@ def create_parser(subparsers):
     contribution_parser = option_parser.add_parser("contributes-to")
     contribution_parser.add_argument("parent_classifier", choices=classifiers, help="Classifier of the parent")
     contribution_parser.add_argument("parent_name",  help="Name of a parent artefact").completer = ParentNameCompleter()
+    contribution_parser.add_argument("-r", "--rule", dest="rule", action="store")
 
     aspect_parser = option_parser.add_parser("aspect")
     aspect_parser.add_argument("aspect", choices=aspects, help="Adds additional specification breakdown aspects in data directory.")
@@ -70,12 +71,16 @@ def add_filter_flags(parser):
     extension_group.add_argument(
         "-i",
         "--include-extension",
+        "--include-classifier",
+        dest="include_extension",
         nargs='+',
         help='list of extensions to include in listing'
     )
     extension_group.add_argument(
         "-e",
         "--exclude-extension",
+        "--exclude-classifier",
+        dest="exclude_extension",
         nargs='+',
         help='list of extensions to exclude from listing'
     )
@@ -121,6 +126,7 @@ 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")
+    tags_parser.add_argument("--exclude_classifier", choices=classifiers, help="Show tags for an artefact type")
     tags_parser.add_argument("--filtered-extra-column", action="store_true", help="Filter tags for extra column") 
 
 
@@ -184,7 +190,7 @@ def reconnect_parser(subparsers):
     reconnect_parser.add_argument("parameter", help="Filename of artefact").completer = ArtefactCompleter()
     reconnect_parser.add_argument("parent_classifier", choices=classifiers, help="Classifier of the parent artefact type")
     reconnect_parser.add_argument("parent_name", help="Filename of parent artefact").completer = ParentNameCompleter()
-    reconnect_parser.add_argument("-r", "--rule", dest="rule", nargs='+')
+    reconnect_parser.add_argument("-r", "--rule", dest="rule", action="store")
 
 
 def read_status_parser(subparsers):

{ara_cli-0.1.9.64 → ara_cli-0.1.9.66}/ara_cli/artefact_creator.py

@@ -87,7 +87,7 @@ class ArtefactCreator:
         artefact._parent = matching_artefacts[0]
         return artefact
 
-    def run(self, filename, classifier, parent_classifier=None, parent_name=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()
@@ -111,7 +111,8 @@ class ArtefactCreator:
         if parent_classifier and parent_name:
             artefact.set_contribution(
                 artefact_name=parent_name,
-                classifier=parent_classifier
+                classifier=parent_classifier,
+                rule=rule
             )
 
         artefact_content = artefact.serialize()

{ara_cli-0.1.9.64 → ara_cli-0.1.9.66}/ara_cli/artefact_fuzzy_search.py

@@ -41,7 +41,7 @@ def find_closest_name_match(artefact_name: str, all_artefact_names: list[str]) -
     return closest_match
 
 
-def find_closest_rule(parent_artefact, rule):
+def find_closest_rule(parent_artefact: 'Artefact', rule: str):
     parent_classifier = parent_artefact.artefact_type.value
     parent_title = parent_artefact.title
     if not hasattr(parent_artefact, 'rules'):

{ara_cli-0.1.9.64 → ara_cli-0.1.9.66}/ara_cli/artefact_models/artefact_model.py

@@ -401,9 +401,10 @@ class Artefact(BaseModel, ABC):
             return description
         return f"{description}{self.description}"
 
-    def set_contribution(self, artefact_name, classifier):
+    def set_contribution(self, artefact_name, classifier, rule=None):
         contribution = Contribution(
             artefact_name=artefact_name,
-            classifier=classifier
+            classifier=classifier,
+            rule=rule
         )
         self.contribution = contribution

{ara_cli-0.1.9.64 → ara_cli-0.1.9.66}/ara_cli/artefact_reader.py

@@ -1,6 +1,7 @@
 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 typing import Dict, List
 import os
@@ -9,7 +10,7 @@ import re
 
 class ArtefactReader:
     @staticmethod
-    def read_artefact(artefact_name, classifier):
+    def read_artefact(artefact_name, classifier) -> tuple[str, dict[str, str]]:
         if not Classifier.is_valid_classifier(classifier):
             print("Invalid classifier provided. Please provide a valid classifier.")
             return None, None
@@ -34,6 +35,27 @@ class ArtefactReader:
 
         return None, None
 
+    @staticmethod
+    def read_single_artefact(artefact_name, classifier, classified_file_info=None) -> Artefact:
+        if not Classifier.is_valid_classifier(classifier):
+            print("Invalid classifier provided. Please provide a valid classifier.")
+            return None
+        if not classified_file_info:
+            file_classifier = FileClassifier(os)
+            classified_file_info = file_classifier.classify_files()
+        artefact_info_of_classifier = classified_file_info.get(classifier, [])
+
+        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()
+                artefact = artefact_from_content(content)
+                artefact._file_path = file_path
+                return artefact
+        return None
+
     @staticmethod
     def extract_parent_tree(artefact_content):
         artefact_titles = Classifier.artefact_titles()

{ara_cli-0.1.9.64 → ara_cli-0.1.9.66}/ara_cli/prompt_handler.py

@@ -357,10 +357,8 @@ def prepend_system_prompt(message_list):
 def append_images_to_message(message, image_data_list):
     if not image_data_list:
         return message
-    new_content_list = [{"type": "text", "text": message}]
-    new_content_list.extend(image_data_list)
-    
-    message["content"] = new_content_list
+    message_content = message["content"]
+    message["content"] = message_content + image_data_list
 
     return message
 
@@ -380,23 +378,24 @@ def create_and_send_custom_prompt(classifier, parameter):
     append_headings(classifier, parameter, "prompt")
     write_prompt_result(classifier, parameter, prompt)
 
-    base_message = {
+    message = {
         "role": "user",
         "content": combined_content_markdown
     }
 
-    final_message = append_images_to_message(base_message, image_data_list)
-
-    message_list_to_send = [final_message]
+    message_list = [message]
 
+    message_list = append_images_to_message(message_list, image_data_list)
     append_headings(classifier, parameter, "result")
+
     artefact_data_path = f"ara/{sub_directory}/{parameter}.data/{classifier}.prompt_log.md"
     with open(artefact_data_path, 'a') as file:
-        for chunk in send_prompt(message_list_to_send):
-            content = chunk.choices[0].delta.content
-            if content:
-                file.write(content)
-                file.flush()
+        for chunk in send_prompt(message_list):
+            chunk_content = chunk.choices[0].delta.content
+            if not chunk_content:
+                continue
+            file.write(chunk_content)
+            file.flush()
     # write_prompt_result(classifier, parameter, response)
 
 

{ara_cli-0.1.9.64 → ara_cli-0.1.9.66}/ara_cli/tag_extractor.py

@@ -1,12 +1,18 @@
 import os
-from ara_cli.artefact_models.artefact_load import artefact_from_content
+from ara_cli.list_filter import ListFilter, filter_list
+from ara_cli.artefact_lister import ArtefactLister
 
 
 class TagExtractor:
     def __init__(self, file_system=None):
         self.file_system = file_system or os
 
-    def extract_tags(self, navigate_to_target=False, include_classifier=None, filtered_extra_column=False):
+    def extract_tags(
+        self,
+        navigate_to_target=False,
+        filtered_extra_column=False,
+        list_filter: ListFilter | None = None
+    ):
         from ara_cli.template_manager import DirectoryNavigator
         from ara_cli.artefact_reader import ArtefactReader
 
@@ -16,24 +22,29 @@ class TagExtractor:
 
         artefacts = ArtefactReader.read_artefacts()
 
-        if include_classifier:
-            artefacts = {include_classifier: artefacts[include_classifier]}
+        filtered_artefacts = filter_list(
+            list_to_filter=artefacts,
+            list_filter=list_filter,
+            content_retrieval_strategy=ArtefactLister.artefact_content_retrieval,
+            file_path_retrieval=ArtefactLister.artefact_path_retrieval,
+            tag_retrieval=ArtefactLister.artefact_tags_retrieval
+        )
 
         unique_tags = set()
 
         if filtered_extra_column:
             status_tags = {"to-do", "in-progress", "review", "done", "closed"}
-            filtered_artefacts = []
+            artefacts_to_process = []
 
-            for artefact_list in artefacts.values():
+            for artefact_list in filtered_artefacts.values():
                 for artefact in artefact_list:
                     tags = artefact.tags + \
                         [artefact.status] if artefact.status else artefact.tags
                     tag_set = set(tag for tag in tags if tag is not None)
                     if not tag_set & status_tags:
-                        filtered_artefacts.append(artefact)
+                        artefacts_to_process.append(artefact)
 
-            for artefact in filtered_artefacts:
+            for artefact in artefacts_to_process:
                 tags = [tag for tag in (
                     artefact.tags + [artefact.status]) if tag is not None]
                 for tag in tags:
@@ -46,7 +57,7 @@ class TagExtractor:
                     unique_tags.add(tag)
 
         else:
-            for artefact_list in artefacts.values():
+            for artefact_list in filtered_artefacts.values():
                 for artefact in artefact_list:
                     user_tags = [f"user_{tag}" for tag in artefact.users]
                     tags = [tag for tag in (artefact.tags + [artefact.status] + user_tags) if tag is not None]

{ara_cli-0.1.9.64 → ara_cli-0.1.9.66}/ara_cli/tests/test_ara_command_action.py

@@ -26,8 +26,10 @@ def mock_dependencies():
         "ara_cli.filename_validator.is_valid_filename"
     ) as mock_is_valid_filename, patch(
         "ara_cli.template_manager.SpecificationBreakdownAspects"
-    ) as MockSpecificationBreakdownAspects:
-        yield MockArtefactCreator, MockClassifier, mock_is_valid_filename, MockSpecificationBreakdownAspects
+    ) as MockSpecificationBreakdownAspects, patch(
+        "ara_cli.artefact_fuzzy_search.find_closest_rule"
+    ) as mock_find_closest_rule:
+        yield MockArtefactCreator, MockClassifier, mock_is_valid_filename, MockSpecificationBreakdownAspects, mock_find_closest_rule
 
 
 @pytest.fixture
@@ -129,9 +131,11 @@ def test_create_action_validity_checks(
         MockClassifier,
         mock_is_valid_filename,
         MockSpecificationBreakdownAspects,
+        mock_find_closest_rule,
     ) = mock_dependencies
     MockClassifier.is_valid_classifier.return_value = classifier_valid
     mock_is_valid_filename.return_value = filename_valid
+    mock_find_closest_rule.return_value = None
 
     args = MagicMock()
     args.classifier = "test_classifier"

ara_cli-0.1.9.66/ara_cli/tests/test_tag_extractor.py

@@ -0,0 +1,83 @@
+import pytest
+from unittest.mock import MagicMock, patch
+from ara_cli.tag_extractor import TagExtractor
+from ara_cli.list_filter import ListFilter
+
+
+@pytest.fixture
+def artefact():
+    """Fixture to create a mock artefact object."""
+    class Artefact:
+        def __init__(self, tags, status, users, path="dummy.md", content=""):
+            self.tags = tags
+            self.status = status
+            self.users = users
+            self.path = path
+            self.content = content
+    return Artefact
+
+
+@pytest.mark.parametrize("navigate_to_target, filtered_extra_column, list_filter, artefact_data, expected_tags", [
+    (
+        False, False, None,
+        {'artefacts': [
+            (['tag1', 'tag2'], 'in-progress', ['user1']),
+            (['tag3'], 'done', ['user2'])
+        ]},
+        ['done', 'in-progress', 'tag1', 'tag2', 'tag3', 'user_user1', 'user_user2']
+    ),
+    (
+        False, True, None,
+        {'artefacts': [
+            (['project_a', 'priority_high'], None, ['user1']),
+            (['feature_x'], 'done', ['user2'])
+        ]},
+        ['project_a']
+    ),
+    (
+        False, False, ListFilter(include_tags=['@kritik']),
+        {'artefacts': [
+            (['release', 'kritik'], 'review', ['dev1']),
+            (['bugfix'], 'to-do', ['dev2'])
+        ]},
+        ['kritik', 'release', 'review', 'user_dev1']
+    ),
+    (
+        True, False, None,
+        {'artefacts': [
+            (['tag3'], 'status2', ['user3'])
+        ]},
+        ['status2', 'tag3', 'user_user3']
+    ),
+    (
+        False, False, None,
+        {'artefacts': []},
+        []
+    ),
+])
+@patch('ara_cli.artefact_reader.ArtefactReader')
+@patch('ara_cli.template_manager.DirectoryNavigator')
+def test_extract_tags(mock_directory_navigator, mock_artefact_reader, artefact, navigate_to_target, filtered_extra_column, list_filter, artefact_data, expected_tags):
+    mock_artefacts = {key: [artefact(
+        *data) for data in artefact_list] for key, artefact_list in artefact_data.items()}
+    mock_artefact_reader.read_artefacts.return_value = mock_artefacts
+
+    mock_navigator_instance = mock_directory_navigator.return_value
+    mock_navigator_instance.navigate_to_target = MagicMock()
+
+    tag_extractor = TagExtractor()
+
+    result = tag_extractor.extract_tags(
+        navigate_to_target=navigate_to_target,
+        filtered_extra_column=filtered_extra_column,
+        list_filter=list_filter
+    )
+
+    if navigate_to_target:
+        mock_navigator_instance.navigate_to_target.assert_called_once()
+    else:
+        mock_navigator_instance.navigate_to_target.assert_not_called()
+
+    mock_artefact_reader.read_artefacts.assert_called_once()
+
+    assert sorted(result) == sorted(expected_tags)

{ara_cli-0.1.9.64 → ara_cli-0.1.9.66}/ara_cli/version.py

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

{ara_cli-0.1.9.64 → ara_cli-0.1.9.66}/ara_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ara_cli
-Version: 0.1.9.64
+Version: 0.1.9.66
 Requires-Dist: litellm
 Requires-Dist: llama-index
 Requires-Dist: llama-index-llms-openai

ara_cli-0.1.9.64/ara_cli/tests/test_tag_extractor.py

@@ -1,54 +0,0 @@
-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