added automatic setting for problem element

README.md

@@ -13,7 +13,7 @@ To bring the crowd sourced hinter into a demo course:
 
 Follow https://github.com/edx/edx-platform/wiki/Installing-a-new-XBlock for basic xblock installation. The name of the module to set in the advanced settings tab is "crowdsourcehinter".
 
-In studio view, edit the hinter so that the "Problem Element" is set to the "data-usage-id" of the problem block (findable by inspecting element of the problem block). This allows for multiple problems each with their own corresponding hinters to exist on a single page. While setting the Problem Element is crucial, the hinter can function without setting Initial hints or Generic hints.
+In studio view, edit the hinter so that the "Problem Element" is set to the "data-usage-id" of the problem block (findable by inspecting element of the problem block). If no problem element is set manually, the hinter will default to respond to the first problem block on the page.
 
 ![CrowdSourceHinter Installation Screenshot](crowdsourcehinter_setup.png)
 

crowdsourcehinter/crowdsourcehinter.py

@@ -36,7 +36,7 @@ class CrowdsourceHinter(XBlock):
     # student's incorrect answer within the hint_database dictionary (i.e. no students have made hints for the
     # particular incorrect answer)
     #
-    # Example: ["Make sure to check your answer for simple mistakes, like spelling or spaces!"]
+    # Example: ["Make sure to check your answer for simple mistakes like typos!"]
     generic_hints = List(default=[], scope=Scope.content)
     # List of which hints have been shown to the student
     # this list is used to prevent the same hint from showing up to a student (if they submit the same incorrect answers
@@ -106,6 +106,10 @@ class CrowdsourceHinter(XBlock):
             return True
         return False
 
+    @XBlock.json_handler
+    def auto_set_problem_element(self, data, suffix=''):
+        self.Element = str(data["hintingElement"])
+
     def resource_string(self, path):
         """
         This function is used to get the path of static resources.
@@ -146,9 +150,10 @@ class CrowdsourceHinter(XBlock):
         returns:
           'BestHint': the highest rated hint for an incorrect answer
                         or another random hint for an incorrect answer
-                        or 'Sorry, there are no more hints for this answer.' if no more hints exist
+                        or 'Sorry, there are no hints for this answer.' if no hints exist
           'StudentAnswer': the student's incorrect answer
         """
+
         # populate hint_database with hints from initial_hints if there are no hints in hint_database.
         # this probably will occur only on the very first run of a unit containing this block.
         if not bool(self.hint_database):
@@ -273,6 +278,8 @@ class CrowdsourceHinter(XBlock):
         answer_data = data['student_answer']
         data_rating = data['student_rating']
         data_hint = data['hint']
+        if data_hint == 'Sorry, there are no hints for this answer.':
+            return {"rating": None, 'hint': data_hint}
         if data['student_rating'] == 'unreport':
             for reported_hints in self.reported_hints:
                 if reported_hints == data_hint:

crowdsourcehinter/static/html/crowdsourcehinterstudio.html

@@ -29,7 +29,7 @@
         Initial Hints: <textarea type="text" class="csh_initial_hints" value = "{{initial}}"/>
     </p>
     <p>
-        This is the element of the problem for which the hinter is working. This is the "data-usage-id" of the problem block. e.x. i4x://edX/DemoX/problem/Text_Input
+        This is the element of the problem for which the hinter is working. This is the "data-usage-id" of the problem block. It should look something like i4x://edX/DemoX/problem/f958789435cf47218ff32f0d600f1184
     </p>
     <p>
         Problem Element: <textarea type="text" class="csh_hinting_element" value = "{{hinting_element}}"/>

crowdsourcehinter/static/js/src/crowdsourcehinter.js

@@ -2,6 +2,8 @@ function CrowdsourceHinter(runtime, element, data){
 
     var onHinterPage = true; //We don't do hinter logic if we're on a differ tab in a sequential.
 
+    var problemElement = '';
+    
     $(".crowdsourcehinter_block", element).hide();
 
     if(!onHinterPage){
@@ -22,7 +24,7 @@ function CrowdsourceHinter(runtime, element, data){
     Logger.listen('seq_goto', null, stopScript);
 
     /**
-     * Get a hint from the server to show to the student after incorrectly answering a
+     * Get a hint from the server to show to the student after inc-orrectly answering a
      * question. On success, continue to showHint.
      * @param problemGradedEvent is data generated by the problem_graded event
      */
@@ -85,11 +87,18 @@ function CrowdsourceHinter(runtime, element, data){
             getHint(data);
         }
     }}
-    //IMPORTANT
-    //Comment out the listener for "problem_check" and uncomment "problem_graded" on the lavash devstack release.
-    //problem_check is used in the birch release to detect answer submission
-    //Logger.listen('problem_check', null, onStudentSubmission());
-    Logger.listen('problem_graded', data.hinting_element, onStudentSubmission());
+
+    /**
+     * Set the target problem for which to listen for the problem_graded event. Set target to first
+     * problem block if no hinting element has been manually entered.
+     */
+    if(data.hinting_element == undefined || data.hinting_element == ''){
+        hintingElement = ($('.xblock[data-block-type="problem"]').first().attr('data-usage-id')).replace(/;_/g, '/');
+    } else {
+        hintingElement = data.hinting_element;
+    }
+
+    Logger.listen('problem_graded', hintingElement, onStudentSubmission());
 
     /**
      * Modify csh_hint_text attributes to show hint to the student.