Anagram finder

.vscode/settings.json

@@ -123,5 +123,5 @@
       "source.organizeImports.ruff": "explicit"
     }
   },
-  "cSpell.words": ["unittests"]
+"cSpell.words": ["dcbae", "doctests", "unittests"]
 }

solutions/README.md

@@ -1,30 +1,37 @@
 # Solutions
 
-## Merge Dictionaries Solution
+This folder contains implementations for the challenges.
 
-This repository contains a Python solution to merge two dictionaries.
-The solution merges two dictionaries by resolving conflicts based on an optional
- conflict resolution function.
+## Challenges
 
-### Features
+1. **Merge Dictionaries**:
+   - A utility to merge two dictionaries with conflict resolution.
+   - See `merge_dictionaries.py` for the implementation.
 
-- Merges two dictionaries.
-- Resolves conflicts with a custom function, or by default, `dict2` overwrites `dict1`.
+2. **Anagram Finder**:
+   - A function to check if two strings are anagrams.
+   - See `anagram_finder.py` for the implementation.
+
+## Usage
+
+To use any solution, simply import the
+required function and pass the appropriate arguments.
 
 ### How to Run
 
 1. Clone the repository.
-2. Install dependencies (if any).
-3. Run the tests:
+2. Navigate to the folder containing the solution.
+3. Run the desired script:
 
     ```bash
-    python -m unittest solutions/tests/test_merge_dictionaries.py
+    python <script_name>.py
     ```
 
 ### Example
 
 ```python
-dict1 = {"a": 1, "b": 2}
-dict2 = {"b": 3, "c": 4}
-merged = merge_dictionaries(dict1, dict2)
-print(merged)  # Output: {'a': 1, 'b': 3, 'c': 4}
+# Example for Anagram Finder
+from anagram_finder import are_anagrams
+
+result = are_anagrams("listen", "silent")
+print(result)  # Output: True

solutions/anagram_finder.py

@@ -0,0 +1,63 @@
+"""
+Anagram Finder Module
+
+This module provides a function to determine if two strings are anagrams of each other.
+It checks if the strings are anagrams, handling edge cases like empty strings, special characters, and case-insensitivity.
+
+Created on 12 01 2025
+@author: Frankline Ambetsa
+"""
+
+
+def anagram_finder(string1: str, string2: str) -> bool:
+    """
+    Check if two strings are anagrams of each other.
+
+    Anagrams are words or phrases made by rearranging the letters of another word or phrase.
+    This function will check for anagram status while ignoring spaces and case sensitivity.
+
+    Args:
+        string1 (str): The first string.
+        string2 (str): The second string.
+
+    Returns:
+        bool: True if the strings are anagrams, False otherwise.
+
+    Raises:
+        ValueError: If any string is empty except when both are empty.
+
+    >>> anagram_finder("listen", "silent")
+    True
+    >>> anagram_finder("evil", "vile")
+    True
+    >>> anagram_finder("hello", "world")
+    False
+    >>> anagram_finder("a gentleman", "elegant man")
+    True
+    >>> anagram_finder("clint eastwood", "old west action")
+    True
+    """
+
+    # Defensive assertions for valid string inputs
+    assert isinstance(string1, str), "string1 must be a string"
+    assert isinstance(string2, str), "string2 must be a string"
+
+    # If any string is empty, raise an error, unless both are empty
+    if string1 == "" and string2 == "":
+        return True  # Both empty strings are considered anagrams of each other
+
+    if string1 == "":
+        raise AssertionError("string1 cannot be empty")
+    if string2 == "":
+        raise AssertionError("string2 cannot be empty")
+
+    # To Remove spaces and convert to lowercase
+    string1 = string1.replace(" ", "").lower()
+    string2 = string2.replace(" ", "").lower()
+
+    # Check if sorted strings are equal (anagram check)
+    return sorted(string1) == sorted(string2)
+
+
+if __name__ == "__main__":
+    pass