Factor out rubric rendering

common/lib/xmodule/xmodule/combined_open_ended_rubric.py

@@ -0,0 +1,116 @@
+from mitxmako.shortcuts import render_to_string
+
+class CombinedOpenEndedRubric:
+
+    def render_rubric(self, rubric_xml):
+        rubric_categories = CombinedOpenEndedRubric.extract_rubric_categories(rubric_xml)
+        html = render_to_string('open_ended_rubric.html', {'rubric_categories'  : rubric_categories})
+        return html
+
+    @staticmethod
+    def extract_rubric_categories(element):
+        '''
+        Contstruct a list of categories such that the structure looks like:
+        [ { category: "Category 1 Name",
+            options: [{text: "Option 1 Name", points: 0}, {text:"Option 2 Name", points: 5}]
+            },
+           { category: "Category 2 Name",
+             options: [{text: "Option 1 Name", points: 0},
+                         {text: "Option 2 Name", points: 1},
+                         {text: "Option 3 Name", points: 2]}]
+
+        '''
+        element = etree.fromstring(element)
+        categories = []
+        for category in element:
+            if category.tag != 'category':
+                raise Exception("[capa.inputtypes.extract_categories] Expected a <category> tag: got {0} instead".format(category.tag))
+            else:
+                categories.append(CombinedOpenEndedRubric.extract_category(category))
+        return categories
+
+    @staticmethod
+    def extract_category(category):
+        '''
+        construct an individual category
+        {category: "Category 1 Name",
+         options: [{text: "Option 1 text", points: 1},
+                   {text: "Option 2 text", points: 2}]}
+
+        all sorting and auto-point generation occurs in this function
+        '''
+
+        has_score=False
+        descriptionxml = category[0]
+        scorexml = category[1]
+        if score_xml.tag == "option":
+            optionsxml = category[1:]
+        else:
+            optionsxml = category[2:]
+            has_score=True
+
+        # parse description
+        if descriptionxml.tag != 'description':
+            raise Exception("[extract_category]: expected description tag, got {0} instead".format(descriptionxml.tag))
+
+        if has_score:
+            if scorexml.tag != 'score':
+                raise Exception("[extract_category]: expected score tag, got {0} instead".format(scorexml.tag))
+
+        for option in optionsxml:
+            if option.tag != "option":
+                raise Exception("[extract_category]: expected option tag, got {0} instead".format(option.tag))
+
+        description = descriptionxml.text
+
+        if has_score:
+            score = int(scorexml.text)
+        else:
+            score = 0
+
+        cur_points = 0
+        options = []
+        autonumbering = True
+        # parse options
+        for option in optionsxml:
+            if option.tag != 'option':
+                raise Exception("[extract_category]: expected option tag, got {0} instead".format(option.tag))
+            else:
+                pointstr = option.get("points")
+                if pointstr:
+                    autonumbering = False
+                    # try to parse this into an int
+                    try:
+                        points = int(pointstr)
+                    except ValueError:
+                        raise Exception("[extract_category]: expected points to have int, got {0} instead".format(pointstr))
+                elif autonumbering:
+                    # use the generated one if we're in the right mode
+                    points = cur_points
+                    cur_points = cur_points + 1
+                else:
+                    raise Exception("[extract_category]: missing points attribute. Cannot continue to auto-create points values after a points value is explicitly dfined.")
+                optiontext = option.text
+                options.append({'text': option.text, 'points': points})
+
+        # sort and check for duplicates
+        options = sorted(options, key=lambda option: option['points'])
+        CombinedOpenEndedRubric.validate_options(options)
+
+        return {'description': description, 'options': options, 'score' : score, 'has_score' : has_score}
+
+    @staticmethod
+    def validate_options(options):
+        '''
+        Validates a set of options. This can and should be extended to filter out other bad edge cases
+        '''
+        if len(options) == 0:
+            raise Exception("[extract_category]: no options associated with this category")
+        if len(options) == 1:
+            return
+        prev = options[0]['points']
+        for option in options[1:]:
+            if prev == option['points']:
+                raise Exception("[extract_category]: found duplicate point values between two different options")
+            else:
+                prev = option['points']

common/lib/xmodule/xmodule/open_ended_module.py

@@ -35,6 +35,8 @@ from numpy import median
 
 from datetime import datetime
 
+from combined_open_ended_rubric import CombinedOpenEndedRubric
+
 log = logging.getLogger("mitx.courseware")
 
 class OpenEndedModule(openendedchild.OpenEndedChild):
@@ -380,7 +382,7 @@ class OpenEndedModule(openendedchild.OpenEndedChild):
         rubric_feedback=""
         feedback = self._convert_longform_feedback_to_html(response_items)
         if response_items['rubric_scores_complete']==True:
-            rubric_feedback = self.render_rubric(response_items['rubric_xml'])
+            rubric_feedback = CombinedOpenEndedRubric.render_rubric(response_items['rubric_xml'])
 
         if not response_items['success']:
             return system.render_template("open_ended_error.html",
@@ -604,104 +606,6 @@ class OpenEndedModule(openendedchild.OpenEndedChild):
         html = system.render_template('open_ended.html', context)
         return html
 
-    def render_rubric(self, rubric_xml):
-        rubric_categories = OpenEndedModule.extract_rubric_categories(rubric_xml)
-        html = render_to_string('open_ended_rubric.html', {'rubric_categories'  : rubric_categories})
-        return html
-
-    @staticmethod
-    def extract_rubric_categories(element):
-        '''
-        Contstruct a list of categories such that the structure looks like:
-        [ { category: "Category 1 Name",
-            options: [{text: "Option 1 Name", points: 0}, {text:"Option 2 Name", points: 5}]
-            },
-           { category: "Category 2 Name",
-             options: [{text: "Option 1 Name", points: 0},
-                         {text: "Option 2 Name", points: 1},
-                         {text: "Option 3 Name", points: 2]}]
-
-        '''
-        element = etree.fromstring(element)
-        categories = []
-        for category in element:
-            if category.tag != 'category':
-                raise Exception("[capa.inputtypes.extract_categories] Expected a <category> tag: got {0} instead".format(category.tag))
-            else:
-                categories.append(OpenEndedModule.extract_category(category))
-        return categories
-
-    @staticmethod
-    def extract_category(category):
-        '''
-        construct an individual category
-        {category: "Category 1 Name",
-         options: [{text: "Option 1 text", points: 1},
-                   {text: "Option 2 text", points: 2}]}
-
-        all sorting and auto-point generation occurs in this function
-        '''
-        descriptionxml = category[0]
-        scorexml = category[1]
-        optionsxml = category[2:]
-
-        # parse description
-        if descriptionxml.tag != 'description':
-            raise Exception("[extract_category]: expected description tag, got {0} instead".format(descriptionxml.tag))
-
-        if scorexml.tag != 'score':
-            raise Exception("[extract_category]: expected score tag, got {0} instead".format(descriptionxml.tag))
-
-        description = descriptionxml.text
-        score = int(scorexml.text)
-
-        cur_points = 0
-        options = []
-        autonumbering = True
-        # parse options
-        for option in optionsxml:
-            if option.tag != 'option':
-                raise Exception("[extract_category]: expected option tag, got {0} instead".format(option.tag))
-            else:
-                pointstr = option.get("points")
-                if pointstr:
-                    autonumbering = False
-                    # try to parse this into an int
-                    try:
-                        points = int(pointstr)
-                    except ValueError:
-                        raise Exception("[extract_category]: expected points to have int, got {0} instead".format(pointstr))
-                elif autonumbering:
-                    # use the generated one if we're in the right mode
-                    points = cur_points
-                    cur_points = cur_points + 1
-                else:
-                    raise Exception("[extract_category]: missing points attribute. Cannot continue to auto-create points values after a points value is explicitly dfined.")
-                optiontext = option.text
-                options.append({'text': option.text, 'points': points})
-
-        # sort and check for duplicates
-        options = sorted(options, key=lambda option: option['points'])
-        OpenEndedModule.validate_options(options)
-
-        return {'description': description, 'options': options, 'score' : score}
-
-    @staticmethod
-    def validate_options(options):
-        '''
-        Validates a set of options. This can and should be extended to filter out other bad edge cases
-        '''
-        if len(options) == 0:
-            raise Exception("[extract_category]: no options associated with this category")
-        if len(options) == 1:
-            return
-        prev = options[0]['points']
-        for option in options[1:]:
-            if prev == option['points']:
-                raise Exception("[extract_category]: found duplicate point values between two different options")
-            else:
-                prev = option['points']
-
 
 class OpenEndedDescriptor(XmlDescriptor, EditingDescriptor):
     """

lms/templates/open_ended_rubric.html

@@ -3,7 +3,9 @@
     <% category = rubric_categories[i] %>
     <tr>
         <th>${category['description']}</th>
-        <td>Your Score: ${category['score']}  </td>
+        % if category['has_score'] == True:
+            <td>Your Score: ${category['score']}  </td>
+        % endif
         % for j in range(len(category['options'])):
         <% option = category['options'][j] %>
         <td>