feat: added close match suggestions for parameter values

Author: Pythonian

Makefile

@@ -20,7 +20,7 @@ help: ## Display this help message with available make commands.
 	@egrep -h '\s##\s' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
 
 hello: ## Display a welcome message for contributors.
-	@echo "Your face show, your shoe shine. Thank you for contributing to Fakernaija. E go better for you!"
+	@echo "Hey, $(USER)! Your face show, your shoe shine. Thank you for contributing to Fakernaija. E go better for you!"
 
 venv: ## Create a virtual environment.
 	$(PYTHON) -m venv $(VENV_DIR)
@@ -49,15 +49,10 @@ check: ## Run code quality checks with Tox and Pre-commit
 
 clean: ## Clean up all generated files and directories.
 	@echo "Cleaning up the project..."
-	@rm -rf $(VENV_DIR)
-	@rm -rf .cache
-	@rm -rf htmlcov coverage.xml .coverage
-	@rm -rf .tox
-	@rm -rf .mypy_cache
-	@rm -rf .ruff_cache
-	@rm -rf *.egg-info
-	@rm -rf dist
+	@rm -rf $(VENV_DIR) .cache htmlcov coverage.xml .coverage
+	@rm -rf .tox .mypy_cache .ruff_cache *.egg-info dist build
 	@find . -name "*.pyc" -delete
 	@find . -type d -name "__pycache__" -exec rm -rf {} +
+	@find . -type d -name "*.egg-info" -exec rm -rf {} +
 	@find . -type d -name "build" -exec rm -rf {} +
 	@echo "Cleanup completed."

docs/source/index.rst

@@ -107,7 +107,7 @@ You can also generate complete data objects for more complex integrations:
     {'name': 'Bachelor of Science', 'degree_type': 'undergraduate', 'abbr': 'B.Sc.'}
 
     >>> print(naija.school())
-    {'name': 'Lagos State University', 'acronym': 'LASU', 'state': 'Lagos', 'type': 'university', 'ownership': 'State'}
+    {'name': 'Lagos State University', 'acronym': 'LASU', 'state': 'Lagos', 'type': 'University', 'ownership': 'State'}
 
 Command Line Usage
 ------------------

fakernaija/__init__.py

@@ -3,7 +3,7 @@
 This package provides utilities to generate random data with a Nigerian context.
 """
 
-__version__ = "1.0.6"
+__version__ = "1.0.0"
 
 from .naija import Naija
 

fakernaija/commands/__init__.py

@@ -31,23 +31,23 @@
     "degree",
     "degree_abbr",
     "degree_name",
+    "department_name",
     # Email command
     "email",
     # Faculty commands
     "faculty",
     "faculty_name",
-    "department_name",
-    # License plate command
-    "license_plate",
-    # Marital status command
-    "marital_status",
     # Name commands
     "first_name",
     "full_name",
     "last_name",
-    "prefix",
+    # License plate command
+    "license_plate",
+    # Marital status command
+    "marital_status",
     # PhoneNumber command
     "phone_number",
+    "prefix",
     # Religion command
     "religion",
     # School commands

fakernaija/mixins/license_plate.py

@@ -46,8 +46,4 @@ def license_plate(self, state: str | None = None) -> str:
                 >>> print(f"Random license plate number from a specific state: {license_plate}")
                 Random license plate number from a specific state: EZA-352CC
         """
-        try:
-            return self.license_plate_provider.generate_license_plate(state=state)
-        except ValueError as e:
-            msg = f"Invalid state name: {state}. {e!s}"
-            raise ValueError(msg) from e
+        return self.license_plate_provider.generate_license_plate(state=state)

fakernaija/providers/degree.py

@@ -1,5 +1,6 @@
 """This module provides a DegreeProvider class for accessing information about degrees awarded in Nigerian schools from a JSON file."""
 
+import difflib
 from pathlib import Path
 
 from fakernaija.utils import load_json, normalize_input
@@ -38,7 +39,15 @@ def validate_degree_type(self, degree_type: str | None) -> str | None:
         """
         degree_type = normalize_input(degree_type)
         if degree_type and degree_type not in self.valid_degree_types:
-            msg = f"Invalid degree_type. Must be one of {self.valid_degree_types}."
+            # Find close matches to the input degree type
+            suggestions = difflib.get_close_matches(
+                degree_type, self.valid_degree_types, n=3, cutoff=0.6
+            )
+            msg = (
+                f"Invalid degree_type: '{degree_type}'. Did you mean: {', '.join(suggestions)}?"
+                if suggestions
+                else f"Invalid degree_type: '{degree_type}'. Valid types are: {', '.join(self.valid_degree_types)}."
+            )
             raise ValueError(msg)
         return degree_type
 

fakernaija/providers/email.py

@@ -1,5 +1,6 @@
 """This module provides an EmailProvider class for generating email addresses with Nigerian name combinations."""
 
+import difflib
 import random
 import re
 
@@ -74,11 +75,34 @@ def generate_email(
         Raises:
             ValueError: If the domain is invalid or if no matching data is found for the given tribe or gender.
         """
-        # Normalize the inputs to lowercase
+        # Normalize the inputs
         tribe = normalize_input(tribe)
         gender = normalize_input(gender)
         domain = normalize_input(domain)
 
+        if tribe and tribe not in self.name_provider.tribes:
+            # Check if the tribe exists in the list and suggest close matches
+            suggestions = difflib.get_close_matches(
+                tribe, self.name_provider.tribes, n=3, cutoff=0.6
+            )
+            msg = (
+                f"Unsupported tribe: '{tribe}'. Did you mean: {', '.join(suggestions)}?"
+                if suggestions
+                else f"Unsupported tribe: '{tribe}'. Available tribes are: {', '.join(self.name_provider.tribes)}."
+            )
+            raise ValueError(msg)
+
+        if gender and gender not in self.name_provider.genders:
+            suggestions = difflib.get_close_matches(
+                gender, self.name_provider.genders, n=3, cutoff=0.6
+            )
+            msg = (
+                f"Invalid gender: '{gender}'. Did you mean: {', '.join(suggestions)}?"
+                if suggestions
+                else f"Invalid gender: '{gender}'. Valid genders are: {', '.join(self.name_provider.genders)}."
+            )
+            raise ValueError(msg)
+
         if domain and not self.validate_domain(domain):
             msg = f"Invalid domain: {domain}"
             raise ValueError(msg)

fakernaija/providers/faculty.py

@@ -3,6 +3,7 @@
 Resource link: https://punchng.com/full-list-newly-restructured-programmes-in-nigerian-varsities/
 """
 
+import difflib
 from pathlib import Path
 
 from fakernaija.utils import load_json
@@ -24,14 +25,15 @@ def __init__(self) -> None:
                 "departments",
             ],
         )
+        self.faculty_names = [faculty["name"] for faculty in self.faculties_data]
 
     def get_faculty_names(self) -> list[str]:
         """Get a list of all faculty names.
 
         Returns:
             list[str]: A list of faculty names.
         """
-        return [faculty["name"] for faculty in self.faculties_data]
+        return self.faculty_names
 
     def get_department_names(self, faculty: str | None = None) -> list[str]:
         """Get a list of department names. Optionally filter by faculty.
@@ -41,14 +43,33 @@ def get_department_names(self, faculty: str | None = None) -> list[str]:
 
         Returns:
             list[str]: A list of department names.
+
+        Raises:
+            ValueError: If the faculty name is invalid.
         """
-        departments = []
-        if faculty:
-            for fac in self.faculties_data:
-                if fac["name"].lower() == faculty.lower():
-                    departments.extend(fac["departments"])
-                    break
-        else:
+        if faculty and faculty is not None:
+            # Normalize faculty names for case-insensitive comparison
+            faculty_dict = {f.lower(): f for f in self.faculty_names}
+
+            if faculty.lower() not in faculty_dict:
+                # Find close matches to the input faculty name
+                suggestions = difflib.get_close_matches(
+                    faculty, self.faculty_names, n=3, cutoff=0.6
+                )
+                msg = (
+                    f"Invalid faculty name: {faculty}. Did you mean: {', '.join(suggestions)}?"
+                    if suggestions
+                    else f"Invalid faculty name: {faculty}. Valid faculties are: {', '.join(self.faculty_names)}"
+                )
+                raise ValueError(msg)
+
+            faculty_name = faculty_dict[faculty.lower()]
             for fac in self.faculties_data:
-                departments.extend(fac["departments"])
+                if fac["name"] == faculty_name:
+                    return fac["departments"]
+
+        # Return all departments if no faculty is specified
+        departments = []
+        for fac in self.faculties_data:
+            departments.extend(fac["departments"])
         return departments

fakernaija/providers/license_plate.py

@@ -7,9 +7,6 @@
 from fakernaija.providers.state import StateProvider
 from fakernaija.utils import load_json, normalize_input
 
-DIGIT_COUNT = 3
-LETTER_COUNT = 2
-
 
 class LicensePlateProvider:
     """Provider class to generate Nigerian license plates."""
@@ -57,10 +54,11 @@ def generate_license_plate(self, state: str | None = None) -> str:
                 suggestions = difflib.get_close_matches(
                     state, self.state_names, n=3, cutoff=0.6
                 )
-                if suggestions:
-                    msg = f"Invalid state name: {state}. Did you mean: {', '.join(suggestions)}?"
-                else:
-                    msg = f"Invalid state name: {state}. Valid states are: {', '.join(self.state_names)}"
+                msg = (
+                    f"Invalid state name: {state}. Did you mean: {', '.join(suggestions)}?"
+                    if suggestions
+                    else f"Invalid state name: {state}. Valid states are: {', '.join(self.state_names)}"
+                )
                 raise ValueError(msg)
             # Use the correctly cased state name to access LGA codes
             state_name = state_dict[state.lower()]
@@ -70,6 +68,6 @@ def generate_license_plate(self, state: str | None = None) -> str:
             all_lgas = [code for codes in self.lga_codes.values() for code in codes]
             lga_code = random.choice(all_lgas)
 
-        digits = "".join(random.choices("0123456789", k=DIGIT_COUNT))
-        letters = "".join(random.choices("ABCDEFGHIJKLMNOPQRSTUVWXYZ", k=LETTER_COUNT))
+        digits = "".join(random.choices("0123456789", k=3))
+        letters = "".join(random.choices("ABCDEFGHIJKLMNOPQRSTUVWXYZ", k=2))
         return f"{lga_code}-{digits}{letters}"

fakernaija/providers/name.py

@@ -1,5 +1,6 @@
 """This module provides a NameProvider class for generating Nigerian name combinations."""
 
+import difflib
 import random
 from pathlib import Path
 
@@ -104,11 +105,23 @@ def generate_first_name(
         gender = normalize_input(gender)
 
         if tribe and tribe not in self.tribes:
-            msg = f"Unsupported tribe: {tribe}. Supported values are: {', '.join(self.tribes)}"
+            suggestions = difflib.get_close_matches(tribe, self.tribes, n=3, cutoff=0.6)
+            msg = (
+                f"Unsupported tribe: {tribe}. Did you mean: {', '.join(suggestions)}?"
+                if suggestions
+                else f"Unsupported tribe: {tribe}. Supported values are: {', '.join(self.tribes)}"
+            )
             raise ValueError(msg)
 
         if gender and gender not in self.genders:
-            msg = f"Unsupported gender: {gender}. Supported values are: {', '.join(self.genders)}"
+            suggestions = difflib.get_close_matches(
+                gender, self.genders, n=3, cutoff=0.6
+            )
+            msg = (
+                f"Unsupported gender: {gender}. Did you mean: {', '.join(suggestions)}?"
+                if suggestions
+                else f"Unsupported gender: {gender}. Supported values are: {', '.join(self.genders)}"
+            )
             raise ValueError(msg)
 
         first_names = self.get_first_names(tribe, gender)
@@ -132,7 +145,12 @@ def generate_last_name(self, tribe: str | None = None) -> str:
         tribe = normalize_input(tribe)
 
         if tribe and tribe not in self.tribes:
-            msg = f"Unsupported tribe: {tribe}. Supported values are: {', '.join(self.tribes)}"
+            suggestions = difflib.get_close_matches(tribe, self.tribes, n=3, cutoff=0.6)
+            msg = (
+                f"Unsupported tribe: {tribe}. Did you mean: {', '.join(suggestions)}?"
+                if suggestions
+                else f"Unsupported tribe: {tribe}. Supported values are: {', '.join(self.tribes)}"
+            )
             raise ValueError(msg)
 
         last_names = self.get_last_names(tribe)
@@ -164,13 +182,25 @@ def generate_full_name(
         gender = normalize_input(gender)
 
         if gender and gender not in self.genders:
-            msg = f"Unsupported gender: {gender}. Supported values are: {', '.join(self.genders)}"
+            suggestions = difflib.get_close_matches(
+                gender, self.genders, n=3, cutoff=0.6
+            )
+            msg = (
+                f"Unsupported gender: {gender}. Did you mean: {', '.join(suggestions)}?"
+                if suggestions
+                else f"Unsupported gender: {gender}. Supported values are: {', '.join(self.genders)}"
+            )
             raise ValueError(msg)
 
         if tribe is None:
             tribe = random.choice(self.tribes)
         elif tribe not in self.tribes:
-            msg = f"Unsupported tribe: {tribe}. Supported values are: {', '.join(self.tribes)}"
+            suggestions = difflib.get_close_matches(tribe, self.tribes, n=3, cutoff=0.6)
+            msg = (
+                f"Unsupported tribe: {tribe}. Did you mean: {', '.join(suggestions)}?"
+                if suggestions
+                else f"Unsupported tribe: {tribe}. Supported values are: {', '.join(self.tribes)}"
+            )
             raise ValueError(msg)
 
         first_name = self.generate_first_name(tribe, gender)