temporary push to github, possibly non functional version

crowdsourcehinter/crowdsourcehinter.py

@@ -26,6 +26,9 @@ class CrowdsourceHinter(XBlock):
     # This is a list of incorrect answer submissions made by the student. this list is mostly used for
     # feedback, to find which incorrect answer's hint a student voted on.
     WrongAnswers = List([], scope=Scope.user_state)
+    # This list will keep track of what student answers didn't have a hint to show them. This list is used for
+    # the feedback stage, where students will be prompted and strongly encouraged to provide a hint for such hintless answers.
+    NoHintsFor = List([], scope=Scope.user_state)
     # A dictionary of default hints. default hints will be shown to students when there are no matches with the
     # student's incorrect answer within the hint_database dictionary (i.e. no students have made hints for the
     # particular incorrect answer)
@@ -166,6 +169,7 @@ class CrowdsourceHinter(XBlock):
                     else:
                         # if there are no more hints left in either the database or defaults
                         self.Used.append(str("There are no hints for" + " " + answer))
+                        self.NoHintsFor.append(answer)
                         return {'HintsToUse': "Sorry, there are no more hints for this answer.", "StudentAnswer": answer}
         self.Used.append(not_used)
         return {'HintsToUse': not_used, "StudentAnswer": answer}
@@ -212,20 +216,7 @@ class CrowdsourceHinter(XBlock):
         # that were not used. The keys are the used hints, the values are the
         # corresponding incorrect answer
         feedback_data = {}
-        number_of_hints = 0
-        if data['isStaff'] == 'true':
-            for answer_keys in self.hint_database:
-                if str(len(self.hint_database[str(answer_keys)])) != str(0):
-                    for hints in self.hint_database[str(answer_keys)]:
-                        if len(self.Flagged) != 0:
-                            for flagged_hints in self.Flagged:
-                                if str(hints) == flagged_hints:
-                                    feedback_data[str(hints)] = str("Flagged")
-                        if hints not in feedback_data.keys():
-                            feedback_data[str(hints)] = str(answer_keys)
-                else:
-                    feedback_data[None] = str(answer_keys)
-        elif len(self.WrongAnswers) == 0:
+        if len(self.WrongAnswers) == 0:
             return
         else:
             for index in range(0, len(self.Used)):
@@ -234,29 +225,12 @@ class CrowdsourceHinter(XBlock):
                     if str(self.Used[index]) in self.hint_database[str(answer_keys)]:
                         # add new key (hint) to feedback_data with a value (incorrect answer)
                         feedback_data[str(self.Used[index])] = str(self.WrongAnswers[index])
-                for answer_keys in self.hint_database:
-                    if str(answer_keys) == str(self.WrongAnswers[index]):
-                        # for answes in self.hint_database, if the len of the answer's corresponding
-                        # hints is not zero...
-                        if str(len(self.hint_database[str(answer_keys)])) != str(0):
-                            number_of_hints = 0
-                            hint_key_shuffled = self.hint_database[str(answer_keys)].keys()
-                            # shuffle keys so that random hints won't repeat. probably can be done better.
-                            random.shuffle(hint_key_shuffled)
-                            for random_hint_key in hint_key_shuffled:
-                                if str(random_hint_key) not in self.Flagged.keys():
-                                    if number_of_hints < 3:
-                                        number_of_hints += 1
-                                        # add random unused hint to feedback_data's keys
-                                        # with the value as the incorrect answer
-                                        feedback_data[str(random_hint_key)] = str(self.WrongAnswers[index])
-                                        self.WrongAnswers.append(str(self.WrongAnswers[index]))
-                                        self.Used.append(str(random_hint_key))
-                        else:
-                            self.no_hints(index)
-                            feedback_data[None] = str(self.WrongAnswers[index])
+                    else:
+                        # if the student's answer had no hints (or all the hints were flagged and unavailable) return None
+                        feedback_data[None] = str(self.WrongAnswers[index])
         self.WrongAnswers=[]
         self.Used=[]
+        print(feedback_data)
         return feedback_data
 
     def no_hints(self, index):

crowdsourcehinter/static/css/crowdsourcehinter.css

@@ -17,7 +17,7 @@
 }
 
 .csh_rating_data{
-  width: 3%;
+  width: 10%;
   vertical-align: middle;
 }
 
@@ -38,7 +38,7 @@
 
 .csh_hint_data{
   justify-content: center;
-  width: 97%;
+  width: 90%;
   display: flex;
   flex-direction: column;
 }

crowdsourcehinter/static/html/crowdsourcehinter.html

@@ -2,11 +2,11 @@
     <div class='csh_hint_value' value="{{hintvalue}}">
         <div class='csh_rating_data'>
             <div role="button" class="csh_rate_hint" data-rate="upvote" data-icon="arrow-u" aria-label="upvote">
-                <b>↑</b>
+                <b>This hint was helpful</b>
             </div>
-            <div class ="csh_rating"> {{rating}} </div>
+            //<div class ="csh_rating"> {{rating}} </div>
             <div role="button" class="csh_rate_hint" data-rate="downvote" aria-label="downvote">
-                <b>↓</b>
+                <b>This hint was not helpful</b>
             </div>
         </div>
         <div class='csh_hint_data'>

crowdsourcehinter/static/js/src/crowdsourcehinter.js

@@ -58,7 +58,7 @@ function CrowdsourceHinter(runtime, element){
                             type: "POST",
                             url: runtime.handlerUrl(element, 'get_feedback'),
                             data: JSON.stringify({"isStaff":"false"}),
-                            success: getFeedback
+                            success: getStudentFeedback
                         });
                     }
                 }
@@ -68,12 +68,11 @@ function CrowdsourceHinter(runtime, element){
 
     function seehint(result){
     //Show a hint to the student after an incorrect answer is submitted.
-        console.log(result.StudentAnswer);
         $('.csh_HintsToUse', element).attr('student_answer', result.StudentAnswer);
         $('.csh_HintsToUse', element).text(result.HintsToUse);
     }
 
-    function showHintFeedback(result){
+    function showHintFeedback(hint){
     //Append answer-specific hints for each student answer during the feedback stage.
     //This appended div includes upvote/downvote/flagging buttons, the hint, and the hint's rating
         $(".csh_student_answer", element).each(function(){
@@ -81,8 +80,7 @@ function CrowdsourceHinter(runtime, element){
                 var html = "";
                 $(function(){
                     var data = {
-                        hint: result.hint,
-                        rating: result.rating
+                        hint: hint
                     };
                     html = Mustache.render($("#show_hint_feedback").html(), data);
                 });
@@ -127,15 +125,8 @@ function CrowdsourceHinter(runtime, element){
             $('.crowdsourcehinter_block').attr('class', 'crowdsourcehinter_block_is_staff');
         }
         if(!isShowingHintFeedback){
-            var student_answers = [];
-            $.each(result, function(index, value) {
-                answer = value;
-                if($.inArray(answer, student_answers) === -1 && answer != "Flagged"){
-                    student_answers.push(answer);
-                }
-            });
-            setStudentAnswers(student_answers);
             $.each(result, function(index, value) {
+                setStudentAnswers(value);
                 student_answer = value;
                 hint = index;
                 //hints return null if no answer-specific hints exist
@@ -153,22 +144,7 @@ function CrowdsourceHinter(runtime, element){
                     });
                 }
                 //flagged hints have their corresponding answer set to "Flagged"
-                else if(student_answer != "Flagged"){
-                    $.ajax({
-                        type: "POST",
-                        url: runtime.handlerUrl(element, 'get_ratings'),
-                        data: JSON.stringify({"student_answer": student_answer, "hint": hint}),
-                        success: showHintFeedback
-                    });
-                }
-                else{
-                    $.ajax({
-                        type: "POST",
-                        url: runtime.handlerUrl(element, 'get_ratings'),
-                        data: JSON.stringify({"student_answer": student_answer, "hint": hint}),
-                        success: showFlaggedFeedback
-                    });
-                }
+                showHintFeedback(hint);
             });
             isShowingHintFeedback = true;
         }