🪲Only show programs that has been modified in Overview of programs per adventure #5162

jpelay · 2024-02-19T15:38:42Z

Modifies the way we choose if a program is suitable for having a tick mark in the Overview of programs per adventure table.

The process is basically this:

Get all of the code snippets from the yamls. For this I made a simple loop that kind of parses the markdown code, if it finds 3 consecutive backticks and then 3 more, the text found in-between is the code for that snippet.
For the teacher adventures, I use BeautifulSoup to parse the HTML code used to format the text in these adventures.
After getting all of the relevant code, and removing newlines, I compare the code from the student program with each one of the snippets. If the difference to any of the snippets is less than 10 characters, I consider the snippet not to be worthy of reviewing.

Fixes #5161

How to test

Login as a teacher and go to Overview of program per adventure
Login as a student in other window and copy-paste one of the example's code into the editor, and run the program.
Check that the program isn't being shown for reviewing.
Now in the student's window, modify the program before running it.
Now the program should be available for reviewing.

for more information, see https://pre-commit.ci

ghost · 2024-02-19T15:41:17Z

👇 Click on the image for a new way to code review

Legend

…o adventures_save

for more information, see https://pre-commit.ci

hasan-sh

Hi @jpelay , great work!! I had the following error with a teacher adventure, but after resetting local db, it worked again.

I just wanna share my thoughts on the code. All works fine and all for loops are plausible. Just the one that you go through each charecter within the code is a bit of a hassle! And if the code is long, you can imagine the time complexity of this nested for loop would grow exponentially! So, why not doing it with reg?

Another suggestion is about how you decide whether there's a difference! Your decision is based on the charecter level and if there's 10 chars different, then you say they can modify. What if they just changed the line orders without adding anything new for instance? Do you know https://docs.python.org/3/library/difflib.html? Especially the sequenceMatcher! This way instead of relying on chars being changed from position, we rely on similarity score!

jpelay · 2024-02-26T15:13:21Z

I just wanna share my thoughts on the code. All works fine and all for loops are plausible. Just the one that you go through each charecter within the code is a bit of a hassle! And if the code is long, you can imagine the time complexity of this nested for loop would grow exponentially! So, why not doing it with reg?

Hi! I did it this way in case there was weird nesting inside the adventures, I did it this way to make sure we parse it properly.

Another suggestion is about how you decide whether there's a difference! Your decision is based on the charecter level and if there's 10 chars different, then you say they can modify. What if they just changed the line orders without adding anything new for instance? Do you know https://docs.python.org/3/library/difflib.html? Especially the sequenceMatcher! This way instead of relying on chars being changed from position, we rely on similarity score!

I think this a worth suggestion!!! I implemented it and turned to be a lot better that just doing char diffs! I put an arbitrary value of 0.95 that I don't know if is too strict or not. Perhaps should we include a clause that says that if the original snippet had a underscore and the student filled them, it should be saved?

Felienne · 2024-02-27T06:00:00Z

I put an arbitrary value of 0.95 that I don't know if is too strict or not. Perhaps should we include a clause that says that if the original snippet had a underscore and the student filled them, it should be saved?

I like that idea, but I am not sure it is worth the hassle of implementing it. Shall we open an issue and discuss it separately? (we can ask a teacher too).

Felienne · 2024-02-27T17:58:20Z

I put an arbitrary value of 0.95 that I don't know if is too strict or not. Perhaps should we include a clause that says that if the original snippet had a underscore and the student filled them, it should be saved?

I like that idea, but I am not sure it is worth the hassle of implementing it. Shall we open an issue and discuss it separately? (we can ask a teacher too).

We agreed in the meeting to try to implement the underscore check into this PR after all!

Felienne

Can be merged if we add the underscore check

jpelay · 2024-02-27T20:09:39Z

Ready for review again!

hasan-sh · 2024-02-28T13:52:20Z

website/statistics.py

                can_save = False
        return can_save

+    def has_placeholder(code):


your forgot self!

hasan-sh · 2024-02-28T13:53:12Z

website/statistics.py

@@ -267,10 +268,14 @@ def is_program_modified(self, program, full_adventures, teacher_adventures):
        can_save = True
        for snippet in adventure_snippets:
            seq_match = SequenceMatcher(None, snippet, student_code)
-            if seq_match.ratio() > 0.95:
+            # Allowing a difference of more than 10% or the student filled the placeholders
+            if seq_match.ratio() > 0.95 or (not self.has_placeholder(student_code) and self.has_placeholder(snippet)):


i tested it with the restaurant adventure in level 1, and i can't seem the sutdent's progress still! The function is returning False for both snippets!

You're right!! It should work now!

Cool and it does:)

Ready!

mergify · 2024-03-03T15:13:30Z

Thank you for contributing! Your pull request is now going on the merge train (choo choo! Do not click update from main anymore, and be sure to allow changes to be pushed to your fork).

mergify · 2024-03-03T15:39:58Z

Thank you for contributing! Your pull request is now going on the merge train (choo choo! Do not click update from main anymore, and be sure to allow changes to be pushed to your fork).

jpelay and others added 4 commits February 16, 2024 13:09

save adventure only if 10 characters were changed

c787545

get teacher adventures in the code snippets

6943eea

refactor the code a bit

0ceac2e

[pre-commit.ci] auto fixes from pre-commit.com hooks

560d2cb

for more information, see https://pre-commit.ci

jpelay and others added 3 commits February 19, 2024 11:42

making the linter happy

3dcf55c

Merge branch 'adventures_save' of https://github.com/hedyorg/hedy int…

5deaf60

…o adventures_save

[pre-commit.ci] auto fixes from pre-commit.com hooks

87a79f4

for more information, see https://pre-commit.ci

hasan-sh self-requested a review February 21, 2024 14:24

hasan-sh reviewed Feb 21, 2024

View reviewed changes

use difflib

a4f2ea6

Felienne added the under-review label Feb 27, 2024

Felienne previously requested changes Feb 27, 2024

View reviewed changes

check for underscores

13d38d0

jpelay requested review from Felienne and hasan-sh February 27, 2024 20:09

hasan-sh requested changes Feb 28, 2024

View reviewed changes

jpelay added 2 commits February 28, 2024 11:52

Merge branch 'main' into adventures_save

133b232

fixing placeholder check

86943a5

hasan-sh approved these changes Feb 29, 2024

View reviewed changes

Felienne mentioned this pull request Feb 29, 2024

💻 change calculation and phrasing of number of programs in profile page #5193

Closed

Merge branch 'main' into adventures_save

5586881

Merge branch 'main' into adventures_save

150eddc

mergify bot merged commit 015c8a0 into main Mar 3, 2024
11 checks passed

mergify bot deleted the adventures_save branch March 3, 2024 15:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🪲Only show programs that has been modified in Overview of programs per adventure #5162

🪲Only show programs that has been modified in Overview of programs per adventure #5162

jpelay commented Feb 19, 2024

ghost commented Feb 19, 2024 •

edited by ghost

Loading

Legend

hasan-sh left a comment

jpelay commented Feb 26, 2024 •

edited

Loading

Felienne commented Feb 27, 2024

Felienne commented Feb 27, 2024

Felienne left a comment

jpelay commented Feb 27, 2024

hasan-sh Feb 28, 2024

hasan-sh Feb 28, 2024

jpelay Feb 28, 2024

hasan-sh Feb 29, 2024

mergify bot commented Mar 3, 2024

mergify bot commented Mar 3, 2024

🪲Only show programs that has been modified in Overview of programs per adventure #5162

🪲Only show programs that has been modified in Overview of programs per adventure #5162

Conversation

jpelay commented Feb 19, 2024

ghost commented Feb 19, 2024 • edited by ghost Loading

Legend

hasan-sh left a comment

Choose a reason for hiding this comment

jpelay commented Feb 26, 2024 • edited Loading

Felienne commented Feb 27, 2024

Felienne commented Feb 27, 2024

Felienne left a comment

Choose a reason for hiding this comment

jpelay commented Feb 27, 2024

hasan-sh Feb 28, 2024

Choose a reason for hiding this comment

hasan-sh Feb 28, 2024

Choose a reason for hiding this comment

jpelay Feb 28, 2024

Choose a reason for hiding this comment

hasan-sh Feb 29, 2024

Choose a reason for hiding this comment

mergify bot commented Mar 3, 2024

mergify bot commented Mar 3, 2024

ghost commented Feb 19, 2024 •

edited by ghost

Loading

jpelay commented Feb 26, 2024 •

edited

Loading