learning-credentials 0.4.1rc4__tar.gz → 0.4.1rc6__tar.gz

{learning_credentials-0.4.1rc4/learning_credentials.egg-info → learning_credentials-0.4.1rc6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-credentials
-Version: 0.4.1rc4
+Version: 0.4.1rc6
 Summary: A pluggable service for preparing Open edX credentials.
 Author-email: OpenCraft <help@opencraft.com>
 License-Expression: AGPL-3.0-or-later

{learning_credentials-0.4.1rc4 → learning_credentials-0.4.1rc6}/learning_credentials/generators.py

@@ -378,12 +378,13 @@ def generate_pdf_credential(
 
     # Handle multiline context name.
     context_name = get_learning_context_name(learning_context_key)
+    custom_context_name = ''
     custom_context_text_element = options.get('text_elements', {}).get('context', {})
     if isinstance(custom_context_text_element, dict):
-        context_name = custom_context_text_element.get('text', '') or context_name
+        custom_context_name = custom_context_text_element.get('text', '')
 
     template_path = options.get('template')
-    if '\n' in context_name:
+    if '\n' in context_name or '\n' in custom_context_name:
         template_path = options.get('template_multiline', template_path)
 
     if not template_path:

{learning_credentials-0.4.1rc4 → learning_credentials-0.4.1rc6}/learning_credentials/models.py

@@ -33,6 +33,25 @@ if TYPE_CHECKING:  # pragma: no cover
 log = logging.getLogger(__name__)
 
 
+def _deep_merge(base: dict, override: dict) -> dict:
+    """
+    Deep merge two dictionaries.
+
+    Values from `override` take precedence. Nested dictionaries are merged recursively.
+
+    :param base: The base dictionary.
+    :param override: The dictionary with overriding values.
+    :return: A new dictionary with merged values.
+    """
+    result = base.copy()
+    for key, value in override.items():
+        if key in result and isinstance(result[key], dict) and isinstance(value, dict):
+            result[key] = _deep_merge(result[key], value)
+        else:
+            result[key] = value
+    return result
+
+
 class CredentialType(TimeStampedModel):
     """
     Model to store global credential configurations for each type.
@@ -176,7 +195,7 @@ class CredentialConfiguration(TimeStampedModel):
         module = import_module(module_path)
         func = getattr(module, func_name)
 
-        custom_options = {**self.credential_type.custom_options, **self.custom_options}
+        custom_options = _deep_merge(self.credential_type.custom_options, self.custom_options)
         return func(self.learning_context_key, custom_options)
 
     def generate_credential_for_user(self, user_id: int, celery_task_id: int = 0):
@@ -195,7 +214,7 @@ class CredentialConfiguration(TimeStampedModel):
         # Use the name from the profile if it is not empty. Otherwise, use the first and last name.
         # We check if the profile exists because it may not exist in some cases (e.g., when a User is created manually).
         user_full_name = getattr(getattr(user, 'profile', None), 'name', f"{user.first_name} {user.last_name}")
-        custom_options = {**self.credential_type.custom_options, **self.custom_options}
+        custom_options = _deep_merge(self.credential_type.custom_options, self.custom_options)
 
         credential, _ = Credential.objects.update_or_create(
             user_id=user_id,

{learning_credentials-0.4.1rc4 → learning_credentials-0.4.1rc6/learning_credentials.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-credentials
-Version: 0.4.1rc4
+Version: 0.4.1rc6
 Summary: A pluggable service for preparing Open edX credentials.
 Author-email: OpenCraft <help@opencraft.com>
 License-Expression: AGPL-3.0-or-later

{learning_credentials-0.4.1rc4 → learning_credentials-0.4.1rc6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "learning-credentials"
-version = "0.4.1rc4"
+version = "0.4.1rc6"
 description = "A pluggable service for preparing Open edX credentials."
 dynamic = ["readme"]
 requires-python = ">=3.11"

{learning_credentials-0.4.1rc4 → learning_credentials-0.4.1rc6}/tests/test_generators.py

@@ -484,7 +484,15 @@ def test_save_credential(mock_contentfile: Mock, mock_token_hex: Mock, storage:
             'Single Line',
             {'template_multiline': 'multiline', 'text_elements': {'context': {'text': 'Line 1\nLine 2'}}},
             'multiline',
-            'Line 1\nLine 2',
+            'Single Line',
+        ),
+        # Custom context text without newlines still uses multiline template if the original context name has newlines.
+        # This allows using the `context_name` placeholder in the `context` text element.
+        (
+            'Multi\nLine',
+            {'template_multiline': 'multiline', 'text_elements': {'context': {'text': 'Single Line'}}},
+            'multiline',
+            'Multi\nLine',
         ),
         # Disabled context element falls back to learning context name for template selection.
         (

{learning_credentials-0.4.1rc4 → learning_credentials-0.4.1rc6}/tests/test_models.py

@@ -160,6 +160,61 @@ class TestCredentialConfiguration:
         eligible_user_ids = self.config.get_eligible_user_ids()
         assert eligible_user_ids == [1, 2, 3]
 
+    @patch('test_models._mock_retrieval_func')
+    def test_custom_options_deep_merge(self, mock_retrieval_func: Mock):
+        """Test that custom_options are deep-merged between CredentialType and CredentialConfiguration."""
+        self.credential_type.custom_options = {
+            'top_level': 'base_value',
+            'nested': {
+                'key1': 'base_key1',
+                'key2': 'base_key2',
+                'key3': {
+                    'sub_key1': 'sub_value1',
+                    'sub_key2': 'sub_value2',
+                },
+                'key4': False,
+                'key5': {
+                    'sub_key1': 'sub_value1',
+                    'sub_key2': 'sub_value2',
+                },
+            },
+        }
+        self.config.custom_options = {
+            'top_level': 'override_value',
+            'nested': {
+                'key2': 'override_key2',
+                'key6': 'new_key5',
+                'key3': {
+                    'sub_key1': 'sub_override_value1',
+                },
+                'key4': {
+                    'sub_key': 'sub_value',
+                },
+                'key5': False,
+            },
+            'new_top': 'new_value',
+        }
+
+        self.config.get_eligible_user_ids()
+
+        assert mock_retrieval_func.call_args[0][1] == {
+            'top_level': 'override_value',  # Overridden.
+            'nested': {
+                'key1': 'base_key1',  # Preserved from type.
+                'key2': 'override_key2',  # Overridden.
+                'key3': {  # Merged into type, with an override.
+                    'sub_key1': 'sub_override_value1',
+                    'sub_key2': 'sub_value2',
+                },
+                'key4': {  # Overridden non-dict with dict.
+                    'sub_key': 'sub_value',
+                },
+                'key5': False,  # Overridden dict with non-dict.
+                'key6': 'new_key5',  # Added from override.
+            },
+            'new_top': 'new_value',  # Added from override.
+        }
+
     @pytest.mark.django_db
     def test_filter_out_user_ids_with_credentials(self):
         """Test the filter_out_user_ids_with_credentials method."""