markdown-xblock 2.4.0__py3-none-any.whl

releasenotes/notes/add-default-css-for-tables-3a53e02e8a350253.yaml

@@ -0,0 +1,5 @@
+---
+other:
+  - |
+    Add default CSS for tables to match the current raw-HTML
+    XBlock table styling for better user experience.

releasenotes/notes/add_public_view-d24763b7941dc2b0.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    The XBlock can now also be used in a public course.

releasenotes/notes/custom-css-classes-7984a9c95147d39c.yaml

@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    The XBlock now has a new editable field 'classes' that allows course authors
+    to add custom CSS classes to the component.

releasenotes/notes/export-md-to-file-ab1528b4c28cb2f0.yaml

@@ -0,0 +1,5 @@
+---
+other:
+  - |
+    Markdown content is now written to a separate .md file during
+    course export and read from that file during course import.

releasenotes/notes/fix-course-export-b35c78a22be0c6b5.yaml

@@ -0,0 +1,6 @@
+---
+other:
+  - |
+    Markdown content is now exported between opening and closing
+    <markdown></markdown> tags instead of the markdown element's "data"
+    attribute.

releasenotes/notes/missing-codemirror-files-d64ccb15d0faf640.yaml

@@ -0,0 +1,6 @@
+---
+fixes:
+  - |
+    Course authors using Open edX Studio would not be able to use
+    syntax highlighting, due to missing JavaScript and CSS files for
+    CodeMirror. These files are now included.

releasenotes/notes/pypi-release-3e4d5ceb7b6e252a.yaml

@@ -0,0 +1,7 @@
+---
+prelude: >
+    This is the first PyPI release of this XBlock.
+other:
+  - |
+    This project now uses reno (https://pypi.org/project/reno/) to
+    manage its changelog and release notes.

releasenotes/notes/python-3.12-support-dac839f8d01ac6b9.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    Add support for Python 3.12

releasenotes/notes/refactor-ci-36abda8c15250d06.yaml

@@ -0,0 +1,6 @@
+---
+other:
+  - |
+    The unit testing / linting / CI setup now uses tox and flake8, and
+    includes a .gitlab-ci.yml configuration for those who mirror the
+    repository to a GitLab instance.

releasenotes/notes/refactor-export-import-49bbf0e8a364f139.yaml

@@ -0,0 +1,8 @@
+---
+
+other:
+  - |
+    Each markdown file written during the course export
+    is no longer accompanied by an xml file with XBlock attributes.
+    The XBlock attributes are now included in the markdown node,
+    defined in a vertical block.

releasenotes/notes/remove_py35-0b265861449b1753.yaml

@@ -0,0 +1,9 @@
+---
+upgrade:
+  - |
+    This release removes support for Python 3.5. Do not upgrade to
+    this release on platforms still using Python 3.5.
+deprecations:
+  - |
+    With this release, all automated testing on Python 3.5 has been
+    removed, and Python 3.8 is the recommended Python release.

releasenotes/notes/safe_mode_replace_escape-40fdb78ec8aa5eff.yaml

@@ -0,0 +1,7 @@
+---
+features:
+  - |
+    The XBlock settings now support the string values "replace" and "escape"
+    for safe_mode, just like the upstream Markdown2 library does. A Boolean
+    value of True is considered to be equivalent to "replace". A value of
+    False, None, or the empty string disables safe mode.

releasenotes/notes/show_in_read_only_mode-3af39459d5d56b33.yaml

@@ -0,0 +1,7 @@
+---
+fixes:
+  - |
+    The XBlock now renders normally in "read-only" ("masquerading")
+    mode, which applies when a course instructor (a user with either
+    per-course or platform-wide Staff permissions) selects the "View
+    this course as" → "Specific learner" option in the Open edX LMS.

requirements/base.txt

@@ -0,0 +1,9 @@
+# Requirements for app run
+
+xblock-sdk
+django-statici18n<=2.7.1
+edx-i18n-tools<=2.0
+Mako<=1.3.12
+bleach<=6.3.0
+django<=5.2
+markdown2>=2.5.4

requirements/dev.txt

@@ -0,0 +1,2 @@
+# Requirements for development
+reno

requirements/reno.txt

@@ -0,0 +1 @@
+reno

requirements/test.txt

@@ -0,0 +1,9 @@
+# Requirements for test runs
+
+lazy<=1.6
+pytest-cov<=7.0.0
+mock<6
+
+# Github requirements
+openedx-django-pyfs>=3.8.0
+XBlock>=5.2,<7

tests/__init__.py

@@ -0,0 +1 @@
+"""Tests module."""

tests/test_basics.py

@@ -0,0 +1,280 @@
+"""
+Markdown XBlock tests
+"""
+from __future__ import print_function
+
+import unittest
+
+from mock import Mock, patch
+from workbench.runtime import WorkbenchRuntime
+from xblock.field_data import DictFieldData
+from xblock.fields import ScopeIds
+
+from markdown2 import MarkdownError
+
+import markdown_xblock
+from markdown_xblock.html import DEFAULT_EXTRAS
+
+
+class TestMarkdownXBlock(unittest.TestCase):
+    """
+    Unit tests for `markdown_xblock`
+    """
+    def setUp(self):
+        block_type = 'markdown'
+        self.runtime = WorkbenchRuntime()
+        def_id = self.runtime.id_generator.create_definition(block_type)
+        usage_id = self.runtime.id_generator.create_usage(def_id)
+
+        self.scope_ids = ScopeIds('user', block_type, def_id, usage_id)
+
+    def test_render(self):
+        """
+        Test a basic rendering with default settings.
+        """
+        field_data = DictFieldData({'data': '# This is h1'})
+        block = markdown_xblock.MarkdownXBlock(self.runtime, field_data, scope_ids=self.scope_ids)
+        fragment = block.student_view()
+        self.assertIn('<div class="markdown_xblock"><h1>This is h1</h1>\n</div>\n', fragment.content)
+
+    def test_public_view(self):
+        """
+        Test public view rendering.
+        """
+        field_data = DictFieldData({'data': '# This is h1'})
+        block = markdown_xblock.MarkdownXBlock(self.runtime, field_data, scope_ids=self.scope_ids)
+        student_view_fragment = block.student_view()
+        self.assertIn('<div class="markdown_xblock"><h1>This is h1</h1>\n</div>\n',
+                      student_view_fragment.content)
+        public_view_fragment = block.public_view()
+        self.assertIn('<div class="markdown_xblock"><h1>This is h1</h1>\n</div>\n',
+                      public_view_fragment.content)
+
+    def test_render_default_settings(self):
+        """
+        Test a basic rendering with default settings.
+
+        Expects the content to be sanitized by injecting
+        [HTML_REMOVED] in place of the HTML tags, and the sentence
+        being wrapped in a <p> block (since the <h1> tags are no
+        longer interpreted as HTML).
+        """
+        field_data = DictFieldData({'data': '<h1>This is h1</h1>'})
+        block = markdown_xblock.MarkdownXBlock(self.runtime, field_data, scope_ids=self.scope_ids)
+        fragment = block.student_view()
+        self.assertIn(
+            '<div class="markdown_xblock"><p>[HTML_REMOVED]This is h1[HTML_REMOVED]</p>\n</div>\n',
+            fragment.content
+        )
+
+    def test_render_invalid_safe_mode(self):
+        """
+        Test a basic rendering with default settings.
+
+        Expects the rendering to fail since safe_mode is not set to
+        one of 'replace', 'escape', True or False.
+        """
+        field_data = DictFieldData({'data': '<h1>This is h1</h1>'})
+        block = markdown_xblock.MarkdownXBlock(self.runtime, field_data, scope_ids=self.scope_ids)
+        settings = {
+            "extras": DEFAULT_EXTRAS,
+            "safe_mode": 'this is an invalid safe mode'
+        }
+        with patch('markdown_xblock.html.get_xblock_settings') as get_settings_mock:
+            get_settings_mock.return_value = settings
+            with self.assertRaises(MarkdownError):
+                _ = block.student_view()
+
+    def test_render_replace_inline_html(self):
+        """
+        Test a basic rendering with safe_mode explicitly set to 'replace'.
+
+        Expects the content to be sanitized by injecting
+        [HTML_REMOVED] in place of the HTML tags, and the sentence
+        being wrapped in a <p> block (since the <h1> tags are no
+        longer interpreted as HTML).
+        """
+        field_data = DictFieldData({'data': '<h1>This is h1</h1>'})
+        block = markdown_xblock.MarkdownXBlock(self.runtime, field_data, scope_ids=self.scope_ids)
+        settings = {
+            "extras": DEFAULT_EXTRAS,
+            "safe_mode": 'replace'
+        }
+        with patch('markdown_xblock.html.get_xblock_settings') as get_settings_mock:
+            get_settings_mock.return_value = settings
+            fragment = block.student_view()
+            self.assertIn(
+                '<div class="markdown_xblock"><p>[HTML_REMOVED]This is h1[HTML_REMOVED]</p>\n</div>\n',
+                fragment.content
+            )
+
+    def test_render_replace_inline_html_boolean_setting(self):
+        """
+        Test a basic rendering with safe_mode set to True (instead of 'replace').
+
+        Expects the content to be sanitized by injecting
+        [HTML_REMOVED] in place of the HTML tags, and the sentence
+        being wrapped in a <p> block (since the <h1> tags are no
+        longer interpreted as HTML).
+        """
+        field_data = DictFieldData({'data': '<h1>This is h1</h1>'})
+        block = markdown_xblock.MarkdownXBlock(self.runtime, field_data, scope_ids=self.scope_ids)
+        settings = {
+            "extras": DEFAULT_EXTRAS,
+            "safe_mode": True
+        }
+        with patch('markdown_xblock.html.get_xblock_settings') as get_settings_mock:
+            get_settings_mock.return_value = settings
+            fragment = block.student_view()
+            self.assertIn(
+                '<div class="markdown_xblock"><p>[HTML_REMOVED]This is h1[HTML_REMOVED]</p>\n</div>\n',
+                fragment.content
+            )
+
+    def test_render_escape_inline_html(self):
+        """
+        Test a basic rendering with safe_mode set to 'escape'
+
+        Expects the content to be sanitized by escaping < and > with &lt; and &gt;
+        and the sentence being wrapped in a <p> block (since the <h1> tags are
+        no longer interpreted as HTML).
+        """
+        field_data = DictFieldData({'data': '<h1>This is h1</h1>'})
+        block = markdown_xblock.MarkdownXBlock(self.runtime, field_data, scope_ids=self.scope_ids)
+        settings = {
+            "extras": DEFAULT_EXTRAS,
+            "safe_mode": 'escape'
+        }
+        with patch('markdown_xblock.html.get_xblock_settings') as get_settings_mock:
+            get_settings_mock.return_value = settings
+            fragment = block.student_view()
+            self.assertIn(
+                '<div class="markdown_xblock"><p>&lt;h1&gt;This is h1&lt;/h1&gt;</p>\n</div>\n',
+                fragment.content
+            )
+
+    def test_render_allow_inline_html(self):
+        """
+        Test a basic rendering with javascript enabled.
+        Expects the content *not* to be sanitized.
+        """
+        field_data = DictFieldData({'data': '<h1>This is h1</h1>'})
+        block = markdown_xblock.MarkdownXBlock(self.runtime, field_data, scope_ids=self.scope_ids)
+        settings = {
+            "extras": DEFAULT_EXTRAS,
+            "safe_mode": False
+        }
+        with patch('markdown_xblock.html.get_xblock_settings') as get_settings_mock:
+            get_settings_mock.return_value = settings
+            fragment = block.student_view()
+            self.assertIn('<div class="markdown_xblock"><h1>This is h1</h1>\n</div>\n',
+                          fragment.content)
+
+    def test_render_url_safe_mode_replace(self):
+        """
+        Test rendering a URL with safe_mode set to 'replace'.
+        """
+        field_data = DictFieldData(
+            {'data': '[test1](https://test.com/courses/course-v1:Org+Class+Version/about) [test2](https://test.com/courses/course-v1%3AOrg%2BClass%2BVersion/about)'}  # noqa: E501
+        )
+        block = markdown_xblock.MarkdownXBlock(self.runtime, field_data, scope_ids=self.scope_ids)
+        settings = {
+            "extras": DEFAULT_EXTRAS,
+            "safe_mode": 'replace'
+        }
+        with patch('markdown_xblock.html.get_xblock_settings') as get_settings_mock:
+            get_settings_mock.return_value = settings
+            fragment = block.student_view()
+            self.assertIn(
+                '<a href="https://test.com/courses/course-v1:Org+Class+Version/about">test1</a>',
+                fragment.content
+            )
+            self.assertIn(
+                '<a href="https://test.com/courses/course-v1%3AOrg%2BClass%2BVersion/about">test2</a>',
+                fragment.content
+            )
+
+    def test_render_url_safe_mode_escape(self):
+        """
+        Test rendering a URL with safe_mode set to 'replace'.
+        """
+        field_data = DictFieldData(
+            {'data': '[test1](https://test.com/courses/course-v1:Org+Class+Version/about) [test2](https://test.com/courses/course-v1%3AOrg%2BClass%2BVersion/about)'}  # noqa: E501
+        )
+        block = markdown_xblock.MarkdownXBlock(self.runtime, field_data, scope_ids=self.scope_ids)
+        settings = {
+            "extras": DEFAULT_EXTRAS,
+            "safe_mode": 'escape'
+        }
+        with patch('markdown_xblock.html.get_xblock_settings') as get_settings_mock:
+            get_settings_mock.return_value = settings
+            fragment = block.student_view()
+            self.assertIn(
+                '<a href="https://test.com/courses/course-v1:Org+Class+Version/about">test1</a>',
+                fragment.content
+            )
+            self.assertIn(
+                '<a href="https://test.com/courses/course-v1%3AOrg%2BClass%2BVersion/about">test2</a>',
+                fragment.content
+            )
+
+    def test_render_url_no_safe_mode(self):
+        """
+        Test rendering a URL with safe_mode disabled.
+        """
+        field_data = DictFieldData(
+            {'data': '[test](https://test.com/courses/course-v1:Org+Class+Version/about)'}
+        )
+        block = markdown_xblock.MarkdownXBlock(self.runtime, field_data, scope_ids=self.scope_ids)
+        settings = {
+            "extras": DEFAULT_EXTRAS,
+            "safe_mode": False
+        }
+        with patch('markdown_xblock.html.get_xblock_settings') as get_settings_mock:
+            get_settings_mock.return_value = settings
+            fragment = block.student_view()
+            self.assertIn(
+                '<a href="https://test.com/courses/course-v1:Org+Class+Version/about">test</a>',
+                fragment.content
+            )
+
+    def test_substitution_no_system(self):
+        """
+        Test that the substitution is not performed when `system` is not present inside XBlock.
+        """
+        field_data = DictFieldData({'data': '%%USER_ID%% %%COURSE_ID%%'})
+        block = markdown_xblock.MarkdownXBlock(self.runtime, field_data, scope_ids=self.scope_ids)
+        fragment = block.student_view()
+        self.assertIn('<div class="markdown_xblock"><p>%%USER_ID%% %%COURSE_ID%%</p>\n</div>\n', fragment.content)
+
+    def test_substitution_not_found(self):
+        """
+        Test that the keywords are not replaced when they're not found.
+        """
+        field_data = DictFieldData({'data': 'USER_ID%% %%COURSE_ID%%'})
+        block = markdown_xblock.MarkdownXBlock(self.runtime, field_data, scope_ids=self.scope_ids)
+        block.system = Mock(anonymous_student_id=None)
+        fragment = block.student_view()
+        self.assertIn('<div class="markdown_xblock"><p>USER_ID%% %%COURSE_ID%%</p>\n</div>\n', fragment.content)
+
+    def test_user_id_substitution(self):
+        """
+        Test replacing %%USER_ID%% with anonymous user ID.
+        """
+        field_data = DictFieldData({'data': '%%USER_ID%%'})
+        block = markdown_xblock.MarkdownXBlock(self.runtime, field_data, scope_ids=self.scope_ids)
+        block.system = Mock(anonymous_student_id='test_user')
+        fragment = block.student_view()
+        self.assertIn('<div class="markdown_xblock"><p>test_user</p>\n</div>\n', fragment.content)
+
+    def test_course_id_substitution(self):
+        """
+        Test replacing %%COURSE_ID%% with HTML representation of course key.
+        """
+        field_data = DictFieldData({'data': '%%COURSE_ID%%'})
+        block = markdown_xblock.MarkdownXBlock(self.runtime, field_data, scope_ids=self.scope_ids)
+        course_locator_mock = Mock()
+        course_locator_mock.html_id = Mock(return_value='test_course')
+        block.system = Mock(course_id=course_locator_mock)
+        fragment = block.student_view()
+        self.assertIn('<div class="markdown_xblock"><p>test_course</p>\n</div>\n', fragment.content)

var/.placeholder

@@ -0,0 +1,2 @@
+This file exists solely to preserve its parent directory,
+which the unit tests use to store Workbench logs.