Adds word cloud xblock extracting from edx-platform repo #4

farhan · 2024-07-12T16:26:03Z

Adds word cloud xblock extracting from edx-platform repo

Test PR

Make a test PR on edx-platform like this to run test cases on under development PR.

Some on going changes in word cloud xblock

https://github.com/openedx/edx-platform/pull/36199/files#diff-a0f8168df87bd0334ca63f0abf7c52b2be89224c80bf10aad43ba00234cb21d0

File references:

xblocks_contrib/word_cloud/word_cloud.py has been extracted from
xblocks_contrib/word_cloud/static/html/word_cloud_xblock.html has been extracted from
xblocks_contrib/word_cloud/static/js/src/word_cloud_xblock.js and other d3-cloud files has been extracted from
xblocks_contrib/word_cloud/static/css/word_cloud_xblock.css has been extracted from lms/static/css/WordCloudBlockDisplay.css

Acceptance Criteria:

Extracted XBlock user experience should behave normal if required global css variables donesn't exist
Extracted XBlock funcationality should work fine after turning its relevant Django Settings Flag
In existing built in xblock implementation of edx-platform, update the status or data of the XBlocks. Then change the Django Settings flag and verify after shifting to extracted one, XBlocks are maintaining their required states (including XBlock completion status).
Also test the vice versa of above step, change XBlock from Extracted one to Built in implementation to check fallback case testings.
i18n is supported in the XBlock
Create a course, add multiple XBlocks in the course. Keep different XBlocks in diversity of states (done/un-done etc). Export the course then validate the XBlock states after importing it again.
Make a test PR for the extracted PR like this and fix the test cases if required.
Write further unit test cases for good code coverage

kdmccormick

Just a couple nits so far, but generally this is looking great. I still need to test it myself, but it's exciting to hear that you have this working in edx-platform 🔥

xblocks_contrib/word_cloud/word_cloud.py

kdmccormick · 2024-09-04T18:30:28Z

I'm going to hold off on testing this for now. Let's focus on getting all the stub XBlocks into #2, getting that reviewed and merged, and then getting the waffle flags into edx-platform. That way, it will be easy to test this PR in edx-platform.

kdmccormick

Could you rebase this Farhan? Then I'll be happy to test this using new flag we've added to edx-platform.

farhan · 2024-12-03T12:26:16Z

@kdmccormick This PR's branch is already up-to-date with the main branch.

I think, we can test it on edx-platform by manually install it pip install path-to-xblocks-contrib-proj
I think, we can run test cases on them, after merging it, releasing a new version and then update on edx-platform`
I have created this Test PR on edx-platform as well

Please suggest if we have better ways to do
cc: @irtazaakram @ttqureshi

kdmccormick · 2024-12-03T15:18:12Z

@farhan to test locally with tutor, you can mount the repo and rebuild+reboot:

tutor mounts add path/to/xblocks-contrib
tutor images build openedx-dev
tutor dev reboot

With that setup, you should be able to git switch between xblocks-contrib branches and see that the LMS and CMS containers automatically restart using branch's code.

kdmccormick · 2025-01-30T13:12:09Z

Farhan mentioned in sync-up that this is ready for review.

… of test cases

kdmccormick

I gave this a skim, and I see nothing wrong architecturally 👍🏻

Please take a look at the testing issues I've mentioned in openedx/edx-platform#35983, and also please have someone on Aximprovements review this PR . Once both of those are done, I'm happy to give a quick final review pass.

farhan · 2025-02-11T14:32:09Z

I gave this a skim, and I see nothing wrong architecturally 👍🏻

Please take a look at the testing issues I've mentioned in openedx/edx-platform#35983, and also please have someone on Aximprovements review this PR . Once both of those are done, I'm happy to give a quick final review pass.

@kdmccormick Thanks for looking into it

I have fixed the issue and everything is working fine now
Pass from @openedx/axim-aximprovements is pending

xblocks_contrib/word_cloud/word_cloud.py

irtazaakram · 2025-02-12T11:23:38Z

xblocks_contrib/word_cloud/tests/test_word_cloud.py

@@ -20,7 +20,12 @@ def test_my_student_view(self):
        as_dict = frag.to_dict()
        content = as_dict["content"]
        self.assertIn(
-            "WordCloudBlock: count is now",
+            "Word cloud",


We should move all tests from https://github.com/openedx/edx-platform/blob/master/xmodule/tests/test_word_cloud.py to this file

We can do it another PR. Let's priortize publishing of this XBlock 🚢

xblocks_contrib/word_cloud/static/README.txt

farhan · 2025-02-13T10:26:03Z

@kdmccormick Please review it as it's waiting for your thumbs up for the release.

salman2013

LGTM

farhan requested review from feanil, kdmccormick and irtazaakram July 18, 2024 10:15

farhan mentioned this pull request Jul 18, 2024

Test PR: deprecate WordCloudXBlock and extract it to xblocks-contrib repo openedx/edx-platform#35140

Closed

farhan marked this pull request as ready for review July 24, 2024 14:06

farhan linked an issue Jul 25, 2024 that may be closed by this pull request

WordCloudBlock Extraction openedx/edx-platform#34840

Closed

farhan force-pushed the farhan/word-cloud-xblock branch 2 times, most recently from 200a788 to 91432f2 Compare July 30, 2024 07:34

kdmccormick reviewed Aug 13, 2024

View reviewed changes

xblocks_contrib/word_cloud/word_cloud.py Outdated Show resolved Hide resolved

xblocks_contrib/word_cloud/word_cloud.py Outdated Show resolved Hide resolved

kdmccormick self-requested a review August 20, 2024 18:24

kdmccormick removed their request for review September 4, 2024 18:30

Base automatically changed from core-xblocks to main October 7, 2024 13:59

farhan force-pushed the farhan/word-cloud-xblock branch 3 times, most recently from 5ed4627 to 3c289df Compare October 9, 2024 06:21

farhan force-pushed the farhan/word-cloud-xblock branch from b5b6bf9 to 24544fb Compare November 8, 2024 13:01

farhan requested a review from kdmccormick November 8, 2024 13:13

kdmccormick reviewed Dec 2, 2024

View reviewed changes

farhan requested a review from kdmccormick December 5, 2024 18:45

farhan mentioned this pull request Dec 6, 2024

Add support of gettext() method openedx/xblock-sdk#416

Closed

farhan force-pushed the farhan/word-cloud-xblock branch from cb3e29e to 2566773 Compare January 13, 2025 14:53

farhan mentioned this pull request Jan 16, 2025

Test PR | Enable Extracted Word Cloud openedx/edx-platform#35983

Draft

farhan force-pushed the farhan/word-cloud-xblock branch from 201dee6 to 000dee1 Compare January 22, 2025 11:33

farhan force-pushed the farhan/word-cloud-xblock branch from f1e4d36 to a43d3ea Compare January 29, 2025 12:02

farhan force-pushed the farhan/word-cloud-xblock branch from a43d3ea to ab17b6f Compare February 3, 2025 07:52

feat: Adds word cloud xblock extracting from edx-platform repo

3e22510

farhan added 10 commits February 3, 2025 15:03

chore: Revert ajax impementation to xmodule mixin pattern to fix list…

1b9057e

… of test cases

chore: move x_module utils within code package

99f852a

chore: Update element_id to fix test case

16eee50

chore: Add data class attribute to pass the test cases

40084b1

chore: Drop Xmodule mixin, update ajax to latest pattern

5b49c6f

chore: Optimizations

7261df6

chore: Optimization as per test case

2d89b92

chore: Update block identifier and element class assignment

c225551

chore: Adds support of i18n

fe2cb5c

chore: remove unrequired code

e632fb3

farhan force-pushed the farhan/word-cloud-xblock branch from ab17b6f to e632fb3 Compare February 3, 2025 10:03

kdmccormick mentioned this pull request Feb 4, 2025

fix: Render Word cloud block editor in libraries [FC-0076] openedx/edx-platform#36199

Merged

kdmccormick reviewed Feb 4, 2025

View reviewed changes

chore: update word cloud identifier

6e70ecb

farhan requested a review from a team February 6, 2025 06:38

chore: Add package in html div tag for differentiation

d167964

chore: Update release version

e1bc265

salman2013 reviewed Feb 11, 2025

View reviewed changes

xblocks_contrib/word_cloud/word_cloud.py Show resolved Hide resolved

irtazaakram reviewed Feb 12, 2025

View reviewed changes

chore: Address PR change request

c46a60a

farhan force-pushed the farhan/word-cloud-xblock branch from fdcab16 to c46a60a Compare February 12, 2025 15:41

farhan requested a review from irtazaakram February 12, 2025 16:15

irtazaakram approved these changes Feb 13, 2025

View reviewed changes

farhan requested a review from kdmccormick February 13, 2025 10:25

salman2013 approved these changes Feb 17, 2025

View reviewed changes

kdmccormick approved these changes Feb 18, 2025

View reviewed changes

farhan merged commit 264ae5f into main Feb 18, 2025
10 of 12 checks passed

farhan deleted the farhan/word-cloud-xblock branch February 18, 2025 18:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds word cloud xblock extracting from edx-platform repo #4

Adds word cloud xblock extracting from edx-platform repo #4

farhan commented Jul 12, 2024 •

edited

Loading

kdmccormick left a comment

kdmccormick commented Sep 4, 2024 •

edited

Loading

kdmccormick left a comment

farhan commented Dec 3, 2024 •

edited

Loading

kdmccormick commented Dec 3, 2024

kdmccormick commented Jan 30, 2025

kdmccormick left a comment

farhan commented Feb 11, 2025

irtazaakram Feb 12, 2025

farhan Feb 12, 2025

farhan commented Feb 13, 2025

salman2013 left a comment

Adds word cloud xblock extracting from edx-platform repo #4

Adds word cloud xblock extracting from edx-platform repo #4

Conversation

farhan commented Jul 12, 2024 • edited Loading

Test PR

Some on going changes in word cloud xblock

File references:

Acceptance Criteria:

kdmccormick left a comment

Choose a reason for hiding this comment

kdmccormick commented Sep 4, 2024 • edited Loading

kdmccormick left a comment

Choose a reason for hiding this comment

farhan commented Dec 3, 2024 • edited Loading

kdmccormick commented Dec 3, 2024

kdmccormick commented Jan 30, 2025

kdmccormick left a comment

Choose a reason for hiding this comment

farhan commented Feb 11, 2025

irtazaakram Feb 12, 2025

Choose a reason for hiding this comment

farhan Feb 12, 2025

Choose a reason for hiding this comment

farhan commented Feb 13, 2025

salman2013 left a comment

Choose a reason for hiding this comment

farhan commented Jul 12, 2024 •

edited

Loading

kdmccormick commented Sep 4, 2024 •

edited

Loading

farhan commented Dec 3, 2024 •

edited

Loading