Forward Port #54: Don't cause 500 error when get_block returns None

.gitignore

@@ -5,3 +5,6 @@
 /workbench.*
 /dist
 /templates
+*.iml
+.idea/*
+problem_builder.tests.*

LICENSE.MIT

@@ -0,0 +1,30 @@
+------------------------------------------------------------------------------
+This license applies to the following third-party libraries included
+in this repository:
+
+  - backbone.paginator
+  - Backbone.js
+  - Underscore.js
+------------------------------------------------------------------------------
+
+The MIT License (MIT)
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

problem_builder/__init__.py

@@ -2,6 +2,7 @@
 from .answer import AnswerBlock, AnswerRecapBlock
 from .choice import ChoiceBlock
 from .dashboard import DashboardBlock
+from .instructor_tool import InstructorToolBlock
 from .mcq import MCQBlock, RatingBlock
 from .mrq import MRQBlock
 from .message import MentoringMessageBlock

problem_builder/answer.py

@@ -31,6 +31,7 @@
 from xblock.validation import ValidationMessage
 from xblockutils.resources import ResourceLoader
 from xblockutils.studio_editable import StudioEditableXBlockMixin
+from problem_builder.sub_api import SubmittingXBlockMixin, sub_api
 from .step import StepMixin
 import uuid
 
@@ -84,6 +85,23 @@ def get_model_object(self, name=None):
         )
         return answer_data
 
+    @property
+    def student_input(self):
+        if self.name:
+            return self.get_model_object().student_input
+        return ''
+
+    @XBlock.json_handler
+    def answer_value(self, data, suffix=''):
+        """ Current value of the answer, for refresh by client """
+        return {'value': self.student_input}
+
+    @XBlock.json_handler
+    def refresh_html(self, data, suffix=''):
+        """ Complete HTML view of the XBlock, for refresh by client """
+        frag = self.mentoring_view({})
+        return {'html': frag.content}
+
     def validate_field_data(self, validation, data):
         """
         Validate this block's field data.
@@ -102,7 +120,7 @@ def _(self, text):
 
 
 @XBlock.needs("i18n")
-class AnswerBlock(AnswerMixin, StepMixin, StudioEditableXBlockMixin, XBlock):
+class AnswerBlock(SubmittingXBlockMixin, AnswerMixin, StepMixin, StudioEditableXBlockMixin, XBlock):
     """
     A field where the student enters an answer
 
@@ -131,7 +149,8 @@ class AnswerBlock(AnswerMixin, StepMixin, StudioEditableXBlockMixin, XBlock):
         display_name=_("Question"),
         help=_("Question to ask the student"),
         scope=Scope.content,
-        default=""
+        default="",
+        multiline_editor=True,
     )
     weight = Float(
         display_name=_("Weight"),
@@ -164,7 +183,7 @@ def student_input(self):
 
     def mentoring_view(self, context=None):
         """ Render this XBlock within a mentoring block. """
-        context = context or {}
+        context = context.copy() if context else {}
         context['self'] = self
         context['hide_header'] = context.get('hide_header', False) or not self.show_title
         html = loader.render_template('templates/html/answer_editable.html', context)
@@ -179,20 +198,35 @@ def student_view(self, context=None):
         """ Normal view of this XBlock, identical to mentoring_view """
         return self.mentoring_view(context)
 
+    def get_results(self, previous_response=None):
+        # Previous result is actually stored in database table-- ignore.
+        return {
+            'student_input': self.student_input,
+            'status': self.status,
+            'weight': self.weight,
+            'score': 1 if self.status == 'correct' else 0,
+        }
+
+    def get_last_result(self):
+        return self.get_results(None) if self.student_input else {}
+
     def submit(self, submission):
         """
         The parent block is handling a student submission, including a new answer for this
         block. Update accordingly.
         """
         self.student_input = submission[0]['value'].strip()
         self.save()
+
+        if sub_api:
+            # Also send to the submissions API:
+            item_key = self.student_item_key
+            # Need to do this by our own ID, since an answer can be referred to multiple times.
+            item_key['item_id'] = self.name
+            sub_api.create_submission(item_key, self.student_input)
+
         log.info(u'Answer submitted for`{}`: "{}"'.format(self.name, self.student_input))
-        return {
-            'student_input': self.student_input,
-            'status': self.status,
-            'weight': self.weight,
-            'score': 1 if self.status == 'correct' else 0,
-        }
+        return self.get_results()
 
     @property
     def status(self):
@@ -258,22 +292,35 @@ class AnswerRecapBlock(AnswerMixin, StudioEditableXBlockMixin, XBlock):
     )
     editable_fields = ('name', 'display_name', 'description')
 
-    @property
-    def student_input(self):
-        if self.name:
-            return self.get_model_object().student_input
-        return ''
+    css_path = 'public/css/answer.css'
 
     def mentoring_view(self, context=None):
         """ Render this XBlock within a mentoring block. """
-        context = context or {}
+        context = context.copy() if context else {}
+        student_submissions_key = context.get('student_submissions_key')
         context['title'] = self.display_name
         context['description'] = self.description
-        context['student_input'] = self.student_input
+        if student_submissions_key:
+            location = self.location.replace(branch=None, version=None)  # Standardize the key in case it isn't already
+            target_key = {
+                'student_id': student_submissions_key,
+                'course_id': unicode(location.course_key),
+                'item_id': self.name,
+                'item_type': u'pb-answer',
+            }
+            submissions = sub_api.get_submissions(target_key, limit=1)
+            try:
+                context['student_input'] = submissions[0]['answer']
+            except IndexError:
+                context['student_input'] = None
+        else:
+            context['student_input'] = self.student_input
         html = loader.render_template('templates/html/answer_read_only.html', context)
 
         fragment = Fragment(html)
-        fragment.add_css_url(self.runtime.local_resource_url(self, 'public/css/answer.css'))
+        fragment.add_css_url(self.runtime.local_resource_url(self, self.css_path))
+        fragment.add_javascript_url(self.runtime.local_resource_url(self, 'public/js/answer_recap.js'))
+        fragment.initialize_js('AnswerRecapBlock')
         return fragment
 
     def student_view(self, context=None):

problem_builder/dashboard.py

@@ -58,6 +58,39 @@ def _(text):
 # Classes ###########################################################
 
 
+class ExportMixin(object):
+    """
+    Used by blocks which need to provide a downloadable export.
+    """
+    def _get_user_full_name(self):
+        """
+        Get the full name of the current user, for the downloadable report.
+        """
+        user_service = self.runtime.service(self, 'user')
+        if user_service:
+            return user_service.get_current_user().full_name
+        return ""
+
+    def _get_course_name(self):
+        """
+        Get the name of the current course, for the downloadable report.
+        """
+        try:
+            course_key = self.scope_ids.usage_id.course_key
+        except AttributeError:
+            return ""  # We are not in an edX runtime
+        try:
+            course_root_key = course_key.make_usage_key('course', 'course')
+            return self.runtime.get_block(course_root_key).display_name
+        except Exception:  # ItemNotFoundError most likely, but we can't import that exception in non-edX environments
+            # We may be on old mongo:
+            try:
+                course_root_key = course_key.make_usage_key('course', course_key.run)
+                return self.runtime.get_block(course_root_key).display_name
+            except Exception:
+                return ""
+
+
 class ColorRule(object):
     """
     A rule used to conditionally set colors
@@ -155,7 +188,7 @@ class InvalidUrlName(ValueError):
 
 @XBlock.needs("i18n")
 @XBlock.wants("user")
-class DashboardBlock(StudioEditableXBlockMixin, XBlock):
+class DashboardBlock(StudioEditableXBlockMixin, ExportMixin, XBlock):
     """
     A block to summarize self-assessment results.
     """
@@ -260,7 +293,7 @@ class DashboardBlock(StudioEditableXBlockMixin, XBlock):
         'color_rules', 'visual_rules', 'visual_title', 'visual_desc', 'header_html', 'footer_html',
     )
     css_path = 'public/css/dashboard.css'
-    js_path = 'public/js/dashboard.js'
+    js_path = 'public/js/review_blocks.js'
 
     def get_mentoring_blocks(self, mentoring_ids, ignore_errors=True):
         """
@@ -343,34 +376,6 @@ def color_for_value(self, value):
                 return rule.color_str
         return None
 
-    def _get_user_full_name(self):
-        """
-        Get the full name of the current user, for the downloadable report.
-        """
-        user_service = self.runtime.service(self, 'user')
-        if user_service:
-            return user_service.get_current_user().full_name
-        return ""
-
-    def _get_course_name(self):
-        """
-        Get the name of the current course, for the downloadable report.
-        """
-        try:
-            course_key = self.scope_ids.usage_id.course_key
-        except AttributeError:
-            return ""  # We are not in an edX runtime
-        try:
-            course_root_key = course_key.make_usage_key('course', 'course')
-            return self.runtime.get_block(course_root_key).display_name
-        except Exception:  # ItemNotFoundError most likely, but we can't import that exception in non-edX environments
-            # We may be on old mongo:
-            try:
-                course_root_key = course_key.make_usage_key('course', course_key.run)
-                return self.runtime.get_block(course_root_key).display_name
-            except Exception:
-                return ""
-
     def _get_problem_questions(self, mentoring_block):
         """ Generator returning only children of specified block that are MCQs """
         for child_id in mentoring_block.children:
@@ -469,7 +474,11 @@ def student_view(self, context=None):  # pylint: disable=unused-argument
         fragment = Fragment(html)
         fragment.add_css_url(self.runtime.local_resource_url(self, self.css_path))
         fragment.add_javascript_url(self.runtime.local_resource_url(self, self.js_path))
-        fragment.initialize_js('PBDashboardBlock', {'reportTemplate': report_template})
+        fragment.initialize_js(
+            'PBDashboardBlock', {
+                'reportTemplate': report_template,
+                'reportContentSelector': '.dashboard-report'
+            })
         return fragment
 
     def validate_field_data(self, validation, data):