Merge pull request #8687 from edx/ahsan/ECOM-1782-Order-Credit-Eligibility-line-items-progress-page

Order of Credit Eligibility line items

lms/djangoapps/courseware/tests/test_submitting_problems.py

@@ -627,7 +627,7 @@ class TestCourseGrader(TestSubmittingProblems):
             "namespace": "grade",
             "name": "grade",
             "display_name": "Grade",
-            "criteria": {"min_grade": 0.52}
+            "criteria": {"min_grade": 0.52},
         }]
         # Add a single credit requirement (final grade)
         set_credit_requirements(self.course.id, requirements)

lms/djangoapps/courseware/views.py

@@ -1153,14 +1153,9 @@ def _credit_course_requirements(course_key, student):
     else:
         eligibility_status = "partial_eligible"
 
-    paired_requirements = {}
-    for requirement in requirement_statuses:
-        namespace = requirement.pop("namespace")
-        paired_requirements.setdefault(namespace, []).append(requirement)
-
     return {
         'eligibility_status': eligibility_status,
-        'requirements': OrderedDict(sorted(paired_requirements.items(), reverse=True))
+        'requirements': requirement_statuses,
     }
 
 

lms/templates/courseware/progress.html

@@ -120,27 +120,25 @@ from django.utils.http import urlquote_plus
                 %endif
                 <button class="credit-help"><i class="fa fa-question"></i><span class="sr">Help regarding credit requirement</span></button><br>
                 <div class="requirement-container" data-eligible="${credit_course_requirements['eligibility_status']}">
-                %for namespace in credit_course_requirements['requirements']:
-                    %for requirement in credit_course_requirements['requirements'][namespace]:
-                        <div class="requirement">
-                            <div class="requirement-name">${_(requirement['display_name'])}</div>
-                            <div class="requirement-status">
-                                %if requirement['status']:
-                                    %if requirement['status'] == 'submitted':
-                                        <span class="requirement-submitted">${_("Verification Submitted")}</span>
-                                    %elif requirement['status'] == 'failed':
-                                        <i class="fa fa-times"></i>
-                                        <span>${_("Verification Failed" )}</span>
-                                    %elif requirement['status'] == 'satisfied':
-                                        <i class="fa fa-check"></i>
-                                        <span>Verified on ${get_time_display(requirement['status_date'], DEFAULT_SHORT_DATE_FORMAT, settings.TIME_ZONE)}</span>
-                                    %endif
-                                %else:
-                                    <span class="not-achieve">${_("Upcoming")}</span>
+                %for requirement in credit_course_requirements['requirements']:
+                    <div class="requirement">
+                        <div class="requirement-name">${_(requirement['display_name'])}</div>
+                        <div class="requirement-status">
+                            %if requirement['status']:
+                                %if requirement['status'] == 'submitted':
+                                    <span class="requirement-submitted">${_("Verification Submitted")}</span>
+                                %elif requirement['status'] == 'failed':
+                                    <i class="fa fa-times"></i>
+                                    <span>${_("Verification Failed" )}</span>
+                                %elif requirement['status'] == 'satisfied':
+                                    <i class="fa fa-check"></i>
+                                    <span>Verified on ${get_time_display(requirement['status_date'], DEFAULT_SHORT_DATE_FORMAT, settings.TIME_ZONE)}</span>
                                 %endif
-                            </div>
+                            %else:
+                                <span class="not-achieve">${_("Upcoming")}</span>
+                            %endif
                         </div>
-                    %endfor
+                    </div>
                 %endfor
                  </div>
                 <button class="detail-collapse" aria-live="polite"><i class="fa fa-caret-up"></i>

openedx/core/djangoapps/credit/api.py

@@ -92,8 +92,9 @@ def set_credit_requirements(course_key, requirements):
     if requirements_to_disable:
         CreditRequirement.disable_credit_requirements(requirements_to_disable)
 
-    for requirement in requirements:
-        CreditRequirement.add_or_update_course_requirement(credit_course, requirement)
+    # update requirement with new order
+    for order, requirement in enumerate(requirements):
+        CreditRequirement.add_or_update_course_requirement(credit_course, requirement, order)
 
 
 def get_credit_requirements(course_key, namespace=None):
@@ -427,6 +428,7 @@ def get_credit_requirement_status(course_key, username, namespace=None, name=Non
                         "display_name": "In Course Reverification",
                         "criteria": {},
                         "status": "failed",
+                        "status_date": "2015-06-26 07:49:13",
                     },
                     {
                         "namespace": "proctored_exam",
@@ -434,6 +436,7 @@ def get_credit_requirement_status(course_key, username, namespace=None, name=Non
                         "display_name": "Proctored Mid Term Exam",
                         "criteria": {},
                         "status": "satisfied",
+                        "status_date": "2015-06-26 11:07:42",
                     },
                     {
                         "namespace": "grade",
@@ -441,6 +444,7 @@ def get_credit_requirement_status(course_key, username, namespace=None, name=Non
                         "display_name": "Minimum Passing Grade",
                         "criteria": {"min_grade": 0.8},
                         "status": "failed",
+                        "status_date": "2015-06-26 11:07:44",
                     },
                 ]
 

openedx/core/djangoapps/credit/models.py

@@ -142,6 +142,7 @@ class CreditRequirement(TimeStampedModel):
     namespace = models.CharField(max_length=255)
     name = models.CharField(max_length=255)
     display_name = models.CharField(max_length=255, default="")
+    order = models.PositiveIntegerField(default=0)
     criteria = JSONField()
     active = models.BooleanField(default=True)
 
@@ -152,7 +153,7 @@ class CreditRequirement(TimeStampedModel):
         unique_together = ('namespace', 'name', 'course')
 
     @classmethod
-    def add_or_update_course_requirement(cls, credit_course, requirement):
+    def add_or_update_course_requirement(cls, credit_course, requirement, order):
         """
         Add requirement to a given course.
 
@@ -171,12 +172,15 @@ class CreditRequirement(TimeStampedModel):
             defaults={
                 "display_name": requirement["display_name"],
                 "criteria": requirement["criteria"],
+                "order": order,
                 "active": True
             }
         )
         if not created:
             credit_requirement.criteria = requirement["criteria"]
             credit_requirement.active = True
+            credit_requirement.order = order
+            credit_requirement.display_name = requirement["display_name"]
             credit_requirement.save()
 
         return credit_requirement, created
@@ -197,7 +201,8 @@ class CreditRequirement(TimeStampedModel):
             QuerySet of CreditRequirement model
 
         """
-        requirements = CreditRequirement.objects.filter(course__course_key=course_key, active=True)
+        # order credit requirements according to their appearance in courseware
+        requirements = CreditRequirement.objects.filter(course__course_key=course_key, active=True).order_by("-order")
 
         if namespace is not None:
             requirements = requirements.filter(namespace=namespace)

openedx/core/djangoapps/credit/tasks.py

@@ -59,7 +59,7 @@ def _get_course_credit_requirements(course):
     """
     credit_xblock_requirements = _get_credit_course_requirement_xblocks(course)
     min_grade_requirement = _get_min_grade_requirement(course)
-    credit_requirements = credit_xblock_requirements + min_grade_requirement
+    credit_requirements = min_grade_requirement + credit_xblock_requirements
     return credit_requirements
 
 
@@ -85,7 +85,7 @@ def _get_min_grade_requirement(course):
                 "display_name": "Grade",
                 "criteria": {
                     "min_grade": getattr(course, "minimum_grade_credit")
-                }
+                },
             }
         ]
     except AttributeError:
@@ -113,7 +113,7 @@ def _get_credit_course_requirement_xblocks(course):  # pylint: disable=invalid-n
                 "namespace": curr_block.get_credit_requirement_namespace(),
                 "name": curr_block.get_credit_requirement_name(),
                 "display_name": curr_block.get_credit_requirement_display_name(),
-                "criteria": ""
+                "criteria": "",
             }
             requirements_blocks.append(block)
 

openedx/core/djangoapps/credit/tests/test_api.py

@@ -118,7 +118,7 @@ class CreditRequirementApiTests(CreditApiTestBase):
                 "namespace": "grade",
                 "name": "grade",
                 "display_name": "Grade",
-                "criteria": {}
+                "criteria": {},
             }
         ]
         with self.assertRaises(InvalidCreditCourse):
@@ -138,7 +138,7 @@ class CreditRequirementApiTests(CreditApiTestBase):
                 "display_name": "Grade",
                 "criteria": {
                     "min_grade": 0.8
-                }
+                },
             },
             {
                 "namespace": "grade",
@@ -146,7 +146,7 @@ class CreditRequirementApiTests(CreditApiTestBase):
                 "display_name": "Grade",
                 "criteria": {
                     "min_grade": 0.9
-                }
+                },
             }
         ]
         api.set_credit_requirements(self.course_key, requirements)
@@ -161,7 +161,7 @@ class CreditRequirementApiTests(CreditApiTestBase):
                 "namespace": "reverification",
                 "name": "midterm",
                 "display_name": "Midterm",
-                "criteria": {}
+                "criteria": {},
             },
             {
                 "namespace": "grade",
@@ -169,7 +169,7 @@ class CreditRequirementApiTests(CreditApiTestBase):
                 "display_name": "Grade",
                 "criteria": {
                     "min_grade": 0.8
-                }
+                },
             }
         ]
         api.set_credit_requirements(self.course_key, requirements)
@@ -191,7 +191,7 @@ class CreditRequirementApiTests(CreditApiTestBase):
                 "display_name": "Grade",
                 "criteria": {
                     "min_grade": 0.8
-                }
+                },
             }
         ]
         api.set_credit_requirements(self.course_key, requirements)
@@ -202,7 +202,7 @@ class CreditRequirementApiTests(CreditApiTestBase):
                 "namespace": "reverification",
                 "name": "i4x://edX/DemoX/edx-reverification-block/assessment_uuid",
                 "display_name": "Assessment 1",
-                "criteria": {}
+                "criteria": {},
             }
         ]
         api.set_credit_requirements(self.course_key, requirements)
@@ -232,7 +232,7 @@ class CreditRequirementApiTests(CreditApiTestBase):
                 "display_name": "Grade",
                 "criteria": {
                     "min_grade": 0.8
-                }
+                },
             }
         ]
         requirement = api.get_credit_requirement(self.course_key, "grade", "grade")
@@ -261,13 +261,13 @@ class CreditRequirementApiTests(CreditApiTestBase):
                 "display_name": "Grade",
                 "criteria": {
                     "min_grade": 0.8
-                }
+                },
             },
             {
                 "namespace": "reverification",
                 "name": "i4x://edX/DemoX/edx-reverification-block/assessment_uuid",
                 "display_name": "Assessment 1",
-                "criteria": {}
+                "criteria": {},
             }
         ]
 
@@ -299,13 +299,13 @@ class CreditRequirementApiTests(CreditApiTestBase):
                 "display_name": "Grade",
                 "criteria": {
                     "min_grade": 0.8
-                }
+                },
             },
             {
                 "namespace": "reverification",
                 "name": "i4x://edX/DemoX/edx-reverification-block/assessment_uuid",
                 "display_name": "Assessment 1",
-                "criteria": {}
+                "criteria": {},
             }
         ]
         api.set_credit_requirements(self.course_key, requirements)
@@ -366,13 +366,13 @@ class CreditRequirementApiTests(CreditApiTestBase):
                 "display_name": "Grade",
                 "criteria": {
                     "min_grade": 0.8
-                }
+                },
             },
             {
                 "namespace": "reverification",
                 "name": "i4x://edX/DemoX/edx-reverification-block/assessment_uuid",
                 "display_name": "Assessment 1",
-                "criteria": {}
+                "criteria": {},
             }
         ]
         api.set_credit_requirements(self.course_key, requirements)

openedx/core/djangoapps/credit/tests/test_models.py

@@ -37,9 +37,9 @@ class CreditEligibilityModelTests(TestCase):
             "display_name": "Grade",
             "criteria": {
                 "min_grade": 0.8
-            }
+            },
         }
-        credit_req, created = CreditRequirement.add_or_update_course_requirement(credit_course, requirement)
+        credit_req, created = CreditRequirement.add_or_update_course_requirement(credit_course, requirement, 0)
         self.assertEqual(credit_course, credit_req.course)
         self.assertEqual(created, True)
         requirements = CreditRequirement.get_course_requirements(self.course_key)
@@ -53,9 +53,9 @@ class CreditEligibilityModelTests(TestCase):
             "display_name": "Grade",
             "criteria": {
                 "min_grade": 0.8
-            }
+            },
         }
-        credit_req, created = CreditRequirement.add_or_update_course_requirement(credit_course, requirement)
+        credit_req, created = CreditRequirement.add_or_update_course_requirement(credit_course, requirement, 0)
         self.assertEqual(credit_course, credit_req.course)
         self.assertEqual(created, True)
 
@@ -63,9 +63,9 @@ class CreditEligibilityModelTests(TestCase):
             "namespace": "reverification",
             "name": "i4x://edX/DemoX/edx-reverification-block/assessment_uuid",
             "display_name": "Assessment 1",
-            "criteria": {}
+            "criteria": {},
         }
-        credit_req, created = CreditRequirement.add_or_update_course_requirement(credit_course, requirement)
+        credit_req, created = CreditRequirement.add_or_update_course_requirement(credit_course, requirement, 1)
         self.assertEqual(credit_course, credit_req.course)
         self.assertEqual(created, True)
 

openedx/core/djangoapps/credit/tests/test_signals.py

@@ -59,7 +59,7 @@ class TestMinGradedRequirementStatus(ModuleStoreTestCase):
             "namespace": "grade",
             "name": "grade",
             "display_name": "Grade",
-            "criteria": {"min_grade": 0.52}
+            "criteria": {"min_grade": 0.52},
         }]
         # Add a single credit requirement (final grade)
         set_credit_requirements(self.course.id, requirements)