learning-credentials 0.4.0rc2__tar.gz → 0.4.0rc3__tar.gz

{learning_credentials-0.4.0rc2/learning_credentials.egg-info → learning_credentials-0.4.0rc3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-credentials
-Version: 0.4.0rc2
+Version: 0.4.0rc3
 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.0rc2 → learning_credentials-0.4.0rc3}/learning_credentials/generators.py

@@ -95,6 +95,9 @@ def _write_text_on_template(template: PageObject, username: str, context_name: s
     font = _register_font(options.get('font')) or 'Helvetica'
 
     # Write the learner name.
+    if options.get('name_uppercase', getattr(settings, 'LEARNING_CREDENTIALS_NAME_UPPERCASE', False)):
+        username = username.upper()
+
     name_font = _register_font(options.get('name_font')) or font
     pdf_canvas.setFont(name_font, options.get('name_size', 32))
     name_color = options.get('name_color', '#000')
@@ -102,6 +105,7 @@ def _write_text_on_template(template: PageObject, username: str, context_name: s
 
     name_x = (template_width - pdf_canvas.stringWidth(username)) / 2
     name_y = options.get('name_y', 290)
+
     pdf_canvas.drawString(name_x, name_y, username)
 
     # Write the learning context name.
@@ -121,6 +125,9 @@ def _write_text_on_template(template: PageObject, username: str, context_name: s
 
     # Write the issue date.
     issue_date = get_localized_credential_date()
+    if options.get('issue_date_uppercase', getattr(settings, 'LEARNING_CREDENTIALS_ISSUE_DATE_UPPERCASE', False)):
+        issue_date = issue_date.upper()
+
     issue_date_font = _register_font(options.get('issue_date_font')) or font
     pdf_canvas.setFont(issue_date_font, options.get('issue_date_size', 12))
     issue_date_color = options.get('issue_date_color', '#000')
@@ -128,7 +135,12 @@ def _write_text_on_template(template: PageObject, username: str, context_name: s
 
     issue_date_x = (template_width - pdf_canvas.stringWidth(issue_date)) / 2
     issue_date_y = options.get('issue_date_y', 120)
-    pdf_canvas.drawString(issue_date_x, issue_date_y, issue_date)
+
+    issue_date_char_space = options.get(
+        'issue_date_char_space', getattr(settings, 'LEARNING_CREDENTIALS_ISSUE_DATE_CHAR_SPACE', 0)
+    )
+
+    pdf_canvas.drawString(issue_date_x, issue_date_y, issue_date, charSpace=issue_date_char_space)
 
     return pdf_canvas
 
@@ -177,7 +189,7 @@ def generate_pdf_credential(
     credential_uuid: UUID,
     options: dict[str, Any],
 ) -> str:
-    """
+    r"""
     Generate a PDF credential.
 
     :param learning_context_key: The ID of the course or learning path the credential is for.
@@ -188,13 +200,15 @@ def generate_pdf_credential(
 
     Options:
       - template: The path to the PDF template file.
-      - template_two_lines: The path to the PDF template file for two-line context names.
-        A two-line context name is specified by using a semicolon as a separator.
+      - template_multiline: The path to the PDF template file for multiline context names.
+        A multiline context name is specified by using '\n' or ';' as a separator.
       - font: The name of the font to use. The default font is Helvetica.
       - name_y: The Y coordinate of the name on the credential (vertical position on the template).
       - name_color: The color of the name on the credential (hexadecimal color code).
       - name_size: The font size of the name on the credential. The default value is 32.
       - name_font: The font of the name on the credential. It overrides the `font` option.
+      - name_uppercase: If set to true (without quotes), the name will be converted to uppercase.
+        The default value is False, unless specified otherwise in the instance settings.
       - context_name: Specify the custom course or Learning Path name. If not provided, it will be retrieved
         automatically from the "cert_name_long" or "display_name" fields for courses, or from the Learning Path model.
       - context_name_y: The Y coordinate of the context name on the credential (vertical position on the template).
@@ -205,19 +219,29 @@ def generate_pdf_credential(
       - issue_date_color: The color of the issue date on the credential (hexadecimal color code).
       - issue_date_size: The font size of the issue date on the credential. The default value is 12.
       - issue_date_font: The font of the issue date on the credential. It overrides the `font` option.
+      - issue_date_char_space: The character spacing of the issue date on the credential
+        (default is 0.0, unless specified otherwise in the instance settings).
+      - issue_date_uppercase: If set to true (without quotes), the issue date will be converted to uppercase.
+        The default value is False, unless specified otherwise in the instance settings.
     """
     log.info("Starting credential generation for user %s", user.id)
 
     username = _get_user_name(user)
     context_name = options.get('context_name') or get_learning_context_name(learning_context_key)
+    template_path = options.get('template')
+
+    # Handle multiline context name (we support semicolon as a separator to preserve backward compatibility).
+    context_name = context_name.replace(';', '\n').replace(r'\n', '\n')
+    if '\n' in context_name:
+        # `template_two_lines` is kept for backward compatibility.
+        template_path = options.get('template_multiline', options.get('template_two_lines', template_path))
+
+    if not template_path:
+        msg = "Template path must be specified in options."
+        raise ValueError(msg)
 
     # Get template from the CredentialAsset.
-    # HACK: We support two-line strings by using a semicolon as a separator.
-    if ';' in context_name and (template_path := options.get('template_two_lines')):
-        template_file = CredentialAsset.get_asset_by_slug(template_path)
-        context_name = context_name.replace(';', '\n')
-    else:
-        template_file = CredentialAsset.get_asset_by_slug(options['template'])
+    template_file = CredentialAsset.get_asset_by_slug(template_path)
 
     # Load the PDF template.
     with template_file.open('rb') as template_file:

{learning_credentials-0.4.0rc2 → learning_credentials-0.4.0rc3/learning_credentials.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-credentials
-Version: 0.4.0rc2
+Version: 0.4.0rc3
 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.0rc2 → learning_credentials-0.4.0rc3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "learning-credentials"
-version = "0.4.0-rc2"
+version = "0.4.0-rc3"
 description = "A pluggable service for preparing Open edX credentials."
 dynamic = ["readme"]
 requires-python = ">=3.11"
@@ -188,6 +188,7 @@ ignore = [
     'RUF018',  # assignment-in-assert
     'ARG002',  # unused-method-argument
     'PLR0913', # too-many-arguments
+    'FBT001',  # flake8-boolean-trap
 ]
 
 [tool.ruff.lint.flake8-annotations]

{learning_credentials-0.4.0rc2 → learning_credentials-0.4.0rc3}/tests/test_generators.py

@@ -17,6 +17,7 @@ from pypdf import PdfWriter
 from pypdf.constants import UserAccessPermissions
 
 from learning_credentials.generators import (
+    FontError,
     _get_user_name,
     _register_font,
     _save_credential,
@@ -59,6 +60,21 @@ def test_register_font_with_custom_font(mock_register_font: Mock, mock_font_clas
     mock_font_class.assert_called_once_with(custom_font, mock_get_asset_by_slug.return_value)
     mock_register_font.assert_called_once_with(mock_font_class.return_value)
 
+@patch("learning_credentials.generators.CredentialAsset.get_asset_by_slug")
+@patch('learning_credentials.generators.TTFont', side_effect=FontError("Font registration failed"))
+@patch("learning_credentials.generators.registerFont")
+def test_register_font_with_registration_failure(
+    mock_register_font: Mock, mock_font_class: Mock, mock_get_asset_by_slug: Mock
+):
+    """Test the _register_font returns None when font registration fails."""
+    custom_font = "MyFont"
+    mock_get_asset_by_slug.return_value = "font_path"
+
+    assert _register_font(custom_font) is None
+    mock_get_asset_by_slug.assert_called_once_with(custom_font)
+    mock_font_class.assert_called_once_with(custom_font, mock_get_asset_by_slug.return_value)
+    mock_register_font.assert_not_called()
+
 
 @pytest.mark.parametrize(
     ("context_name", "options", "expected"),
@@ -153,6 +169,90 @@ def test_write_text_on_template(mock_canvas_class: Mock, context_name: str, opti
     assert canvas_object.drawString.mock_calls[-1][1] == (expected_issue_date_x, expected_issue_date_y, test_date)
 
 
+@pytest.mark.parametrize(
+    ("option_value", "setting_value", "expected_uppercase"),
+    [
+        (None, False, False),  # No option set, setting is False - use default (lowercase)
+        (None, True, True),  # No option set, setting is True - use setting (uppercase)
+        (False, False, False),  # Explicitly disabled, setting is False
+        (False, True, False),  # Explicitly disabled, setting is True - option overrides
+        (True, False, True),  # Explicitly enabled, setting is False - option overrides
+        (True, True, True),  # Explicitly enabled, setting is True
+    ],
+)
+@patch('learning_credentials.generators.get_localized_credential_date', return_value='April 1, 2021')
+@patch('learning_credentials.generators.Canvas', return_value=Mock(stringWidth=Mock(return_value=10)))
+def test_write_text_on_template_uppercase(
+    mock_canvas_class: Mock,
+    mock_get_date: Mock,
+    option_value: bool | None,
+    setting_value: bool,
+    expected_uppercase: bool,
+):
+    """Test the _write_text_on_template function with uppercase option and settings."""
+    username = "John Doe"
+    context_name = "Programming 101"
+    template_mock = Mock(mediabox=[0, 0, 300, 200])
+    options = {}
+
+    if expected_uppercase:
+        expected_name = "JOHN DOE"
+        expected_date = "APRIL 1, 2021"
+    else:
+        expected_name = username
+        expected_date = mock_get_date.return_value
+
+    if option_value is not None:
+        options['name_uppercase'] = option_value
+        options['issue_date_uppercase'] = option_value
+
+    with override_settings(
+        LEARNING_CREDENTIALS_NAME_UPPERCASE=setting_value,
+        LEARNING_CREDENTIALS_ISSUE_DATE_UPPERCASE=setting_value,
+    ):
+        _write_text_on_template(template_mock, username, context_name, options)
+
+    assert mock_canvas_class.return_value.drawString.mock_calls[-3][1][2] == expected_name
+    assert mock_canvas_class.return_value.drawString.mock_calls[-1][1][2] == expected_date
+
+
+@pytest.mark.parametrize(
+    ("option_value", "setting_value", "expected_char_space"),
+    [
+        (None, 0, 0),  # No option set, setting is 0 - use default
+        (None, 2, 2),  # No option set, setting has value - use setting
+        (0, 0, 0),  # Explicitly set to 0, setting is 0
+        (0, 2, 0),  # Explicitly set to 0, setting has value - option overrides
+        (3, 0, 3),  # Explicitly set to 3, setting is 0 - option overrides
+        (3, 2, 3),  # Explicitly set to 3, setting has value - option overrides
+    ],
+)
+@patch('learning_credentials.generators.get_localized_credential_date', return_value='April 1, 2021')
+@patch('learning_credentials.generators.Canvas', return_value=Mock(stringWidth=Mock(return_value=10)))
+def test_write_text_on_template_issue_date_char_space(
+    mock_canvas_class: Mock,
+    _mock_get_date: Mock,  # noqa: PT019
+    option_value: int | None,
+    setting_value: int,
+    expected_char_space: int,
+):
+    """Test the _write_text_on_template function with issue_date_char_space option and settings."""
+    username = "John Doe"
+    context_name = "Programming 101"
+    template_mock = Mock(mediabox=[0, 0, 300, 200])
+    options = {}
+
+    if option_value is not None:
+        options['issue_date_char_space'] = option_value
+
+    with override_settings(LEARNING_CREDENTIALS_ISSUE_DATE_CHAR_SPACE=setting_value):
+        _write_text_on_template(template_mock, username, context_name, options)
+
+    # Check that the last drawString call (for issue date) has the correct charSpace parameter
+    last_draw_call = mock_canvas_class.return_value.drawString.mock_calls[-1]
+    assert last_draw_call[2]['charSpace'] == expected_char_space
+
+
 @override_settings(LMS_ROOT_URL="https://example.com", MEDIA_URL="media/")
 @pytest.mark.parametrize(
     "storage",
@@ -220,20 +320,22 @@ def test_save_credential(mock_contentfile: Mock, mock_token_hex: Mock, storage:
     ("context_name", "options", "expected_template_slug", "expected_context_name"),
     [
         # Default.
-        ('Test Course', {'template': 'template_slug'}, 'template_slug', 'Test Course'),
-        # Specify a different template for two-line course names and replace semicolon with newline in course name.
-        (
-            'Test Course; Test Course',
-            {'template': 'template_slug', 'template_two_lines': 'template_two_lines_slug'},
-            'template_two_lines_slug',
-            'Test Course\n Test Course',
-        ),
-        # Do not replace semicolon with newline when the `template_two_lines` option is not specified.
-        ('Test Course; Test Course', {'template': 'template_slug'}, 'template_slug', 'Test Course; Test Course'),
+        ('Test Course', {'template': 'default'}, 'default', 'Test Course'),
         # Override course name.
-        ('Test Course', {'template': 'template_slug', 'context_name': 'Override'}, 'template_slug', 'Override'),
+        ('Test Course', {'template': 'default', 'context_name': 'Override'}, 'default', 'Override'),
         # Ignore empty course name override.
-        ('Test Course', {'template': 'template_slug', 'context_name': ''}, 'template_slug', 'Test Course'),
+        ('Test Course', {'template': 'default', 'context_name': ''}, 'default', 'Test Course'),
+        # Specify a different template for multiline course names and replace \n with newline.
+        ('Test\nCourse', {'template': 'default', 'template_multiline': 'multiline'}, 'multiline', 'Test\nCourse'),
+        ('Test\\nCourse', {'template_multiline': 'multiline'}, 'multiline', 'Test\nCourse'),
+        # Backward compatibility with semicolon separator.
+        ('Test;Course', {'template_multiline': 'multiline'}, 'multiline', 'Test\nCourse'),
+        # Mixed semicolon and newline separators.
+        ('Te\nst\\nCourse;', {'template_multiline': 'multiline'}, 'multiline', 'Te\nst\nCourse\n'),
+        # Check backward compatibility with `template_two_lines` option.
+        ('Test\\nCourse', {'template': 'default', 'template_two_lines': 'two_lines'}, 'two_lines', 'Test\nCourse'),
+        # Ensure that the default template is used when no multiline template is specified.
+        ('Test\\nCourse', {'template': 'default'}, 'default', 'Test\nCourse'),
     ],
 )
 @patch(
@@ -292,3 +394,17 @@ def test_generate_pdf_credential(
     assert args[-1] == options
 
     mock_save_credential.assert_called_once()
+
+@patch('learning_credentials.generators.get_learning_context_name')
+@patch('learning_credentials.generators._get_user_name')
+def test_generate_pdf_credential_no_template(mock_get_user_name: Mock, mock_get_learning_context_name: Mock):
+    """Test that generate_pdf_credential raises ValueError when no template is specified."""
+    course_id = CourseKey.from_string('course-v1:edX+DemoX+Demo_Course')
+    user = Mock()
+    options = {}  # No template specified.
+
+    with pytest.raises(ValueError, match=r"Template path must be specified in options."):
+        generate_pdf_credential(course_id, user, Mock(), options)
+
+    mock_get_user_name.assert_called_once_with(user)
+    mock_get_learning_context_name.assert_called_once_with(course_id)