oops, disregard this PR, never used or released

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,7 +9,6 @@ If not all TODOs are marked, this PR is considered WIP (work in progress)
 - [ ] Have **tests** been written for the new code? If you're fixing a bug, write a regression test (or have a really good reason for not writing one... and I mean **really** good!)
 - [ ] Has documentation been written/updated?
 - [ ] New dependencies (if any) added to requirements file
-- [ ] Add an entry to CHANGELOG.rst
 
 ## Reviewer guidance
 

kalite/coachreports/api_views.py

@@ -13,6 +13,28 @@
 from kalite.shared.decorators.auth import require_admin
 from kalite.topic_tools.content_models import get_topic_contents, get_topic_nodes, get_leafed_topics, get_content_parents
 
+
+def unique_by_id_and_kind_sort(seq):
+    """
+    Due to the fact that we have duplicate content items for the same content id in our topic tree, as the way that
+    we have implemented duplication of content across the topic tree.
+    :param seq: an iterator of content items.
+    :return: A unique, sorted list of content items.
+    """
+
+    seq.sort(key=lambda x: x.get("sort_order", 0))
+    seen = {}
+    result = []
+    for item in seq:
+        marker = item.get("id") + item.get("kind")
+
+        if marker in seen:
+            continue
+        seen[marker] = 1
+        result.append(item)
+    return result
+
+
 def get_learners_from_GET(request):
     learner_ids = request.GET.getlist("user_id")
 
@@ -74,7 +96,7 @@ def learner_logs(request):
 
     end_date = request.GET.get("end_date")
 
-    topic_ids = request.GET.getlist("topic_id", [])
+    topic_ids = json.loads(request.GET.get("topic_ids", "[]"))
 
     learners = get_learners_from_GET(request)
 
@@ -107,8 +129,12 @@ def learner_logs(request):
         output_objects.extend(objects)
         output_logs.extend(log_objects)
 
+    output_objects = unique_by_id_and_kind_sort(output_objects)
+
     return JsonResponse({
+        # All learner log objects for each content item.
         "logs": output_logs,
+        # All content items for which logs are being returned.
         "contents": output_objects,
         # Sometimes 'learners' gets collapsed to a list from the Queryset. This insures against that eventuality.
         "learners": [{

kalite/coachreports/static/js/coachreports/coach_reports/models.js

@@ -11,6 +11,11 @@ var StateModel = Backbone.Model.extend({
                 group_name: undefined
             });
         }
+        if (key === "facility" || key.facility || key === "group" || key.group) {
+            this.set({
+                topic_ids: undefined
+            });
+        }
 
         Backbone.Model.prototype.set.call(this, key, val, options);
     }
@@ -34,14 +39,16 @@ var CoachReportModel = Backbone.Model.extend({
         this.group = options.group;
         this.start_date = options.start_date;
         this.end_date = options.end_date;
+        this.topic_ids = options.topic_ids;
     },
 
     url: function() {
         return setGetParamDict(Urls.learner_logs(), {
             facility_id: this.facility,
             group_id: this.group,
             start_date: this.start_date,
-            end_date: this.end_date
+            end_date: this.end_date,
+            topic_ids: this.topic_ids
         });
     }
 });

kalite/coachreports/static/js/coachreports/coach_reports/views.js

@@ -88,7 +88,7 @@ var CoachSummaryView = BaseView.extend({
 
     events: {
         "click #show_tabular_report": "toggle_tabular_view",
-        "click #topic-list-submit": "set_data_model"
+        "click #topic-list-submit": "set_topics"
     },
 
 
@@ -100,7 +100,7 @@ var CoachSummaryView = BaseView.extend({
         var targetElem = $("#topic-list").get(0);
         var frag = document.createDocumentFragment();
 
-        var tids = $.parseJSON(this.data_model.get("topic_ids"));
+        var tids = $.parseJSON(this.data_model.get("topic_ids") || "[]");
         var ctr = -1;
 
         parseData.forEach(function(datum, index) {
@@ -196,14 +196,19 @@ var CoachSummaryView = BaseView.extend({
         _.bindAll(this, "set_data_model", "render");
         this.listenTo(this.model, "change:facility", this.set_data_model);
         this.listenTo(this.model, "change:group", this.set_data_model);
+        this.listenTo(this.model, "change:topic_ids", this.set_data_model);
         this.listenTo(this.model, "set_time", this.set_data_model);
         this.set_data_model();
+    },
 
+    set_topics: function() {
+        var topic_ids = _.map(this.$("#topic-list option:checked"), function (node) {return node.value;});
+        this.model.set("topic_ids", JSON.stringify(topic_ids));
     },
 
     set_data_model: function (){
         if (this.data_model) {
-            var check_fields = ["facility", "group", "start_date", "end_date"];
+            var check_fields = ["facility", "group", "start_date", "end_date", "topic_ids"];
             var data_fields = _.pick(this.data_model.attributes, check_fields);
             var status_fields = _.pick(this.model.attributes, check_fields);
             if (!_.isEqual(data_fields, status_fields)) {
@@ -212,13 +217,12 @@ var CoachSummaryView = BaseView.extend({
         }
 
         if (!this.data_model) {
-            var topic_ids = _.map(this.$("#topic-list option:checked"), function (node) {return node.value;});
             this.data_model = new Models.CoachReportAggregateModel({
                 facility: this.model.get("facility"),
                 group: this.model.get("group"),
                 start_date: date_string(this.model.get("start_date")),
                 end_date: date_string(this.model.get("end_date")),
-                topic_ids: JSON.stringify(topic_ids)
+                topic_ids: this.model.get("topic_ids")
             });
             if (this.model.get("facility")) {
                 this.listenTo(this.data_model, "sync", this.render);
@@ -242,14 +246,16 @@ var CoachSummaryView = BaseView.extend({
         var w = 500;
         var dataset = [struggling/total, complete/total, in_progress/total];
 
-        console.log(dataset);
+
         var svg = d3.select("div.progressbar").append("svg").attr("width", w).attr("height", h).
             attr("class", "col-md-8 innerbar");
 
         svg.selectAll("rect").data(dataset).enter().append("rect").attr("x", function(d, i){
-                return _.reduce(dataset.slice(0, i), function(memo, num) { return memo + num; }, 0) * w;
+                var out = _.reduce(dataset.slice(0, i), function(memo, num) { return memo + num; }, 0) * w;
+                out = isNaN(out) ? 0 : out;
+                return out;
             }).attr("y", 0).attr("width", function(d) {
-                return d * w;
+                return isNaN(d * w) ? 0 : d*w;
             }).attr("height", h).attr("class", "rect").attr("class", function(d, i){
                 switch(i) {
                     case(0):
@@ -272,7 +278,9 @@ var CoachSummaryView = BaseView.extend({
                     return in_progress;
             }
         }).attr("fill", "black").attr("x", function(d, i){
-            return (_.reduce(dataset.slice(0, i), function(memo, num) { return memo + num; }, 0) + d/2) * w;
+            var out = (_.reduce(dataset.slice(0, i), function(memo, num) { return memo + num; }, 0) + d/2) * w;
+            out = isNaN(out) ? 0 : out;
+            return out;
         }).attr("y", h/2).attr("font-size", "12px").style("text-anchor", "middle");
 
     },

kalite/coachreports/static/js/coachreports/tabular_reports/views.js

@@ -375,7 +375,8 @@ var TabularReportView = BaseView.extend({
             facility: this.model.get("facility"),
             group: this.model.get("group"),
             start_date: date_string(this.model.get("start_date")),
-            end_date: date_string(this.model.get("end_date"))
+            end_date: date_string(this.model.get("end_date")),
+            topic_ids: this.model.get("topic_ids")
         });
         if (this.model.get("facility")) {
             this.data_model.fetch().then(function() {

kalite/coachreports/tests/coachreport_tests.py

@@ -10,7 +10,7 @@
 from kalite.testing.mixins.securesync_mixins import CreateZoneMixin
 from kalite.testing.mixins.facility_mixins import FacilityMixins
 from kalite.testing.mixins.student_progress_mixins import StudentProgressMixin
-from kalite.topic_tools.content_models import get_content_parents, Item ,set_database
+from kalite.topic_tools.content_models import get_content_parents, Item, set_database, create
 
 
 class ExternalAPITests(FacilityMixins,
@@ -78,6 +78,8 @@ def setUp(self):
         self.group = self.create_group(name='group1', facility=self.facility)
         self.empty_group = self.create_group(name='empty_group', facility=self.facility)
 
+        self.facility_user = self.create_student()
+
     def test_learner_log_endpoint(self):
         response_keys = ["logs","contents","learners","page","pages","limit"]
         self.client.login(username='admin', password='admin')
@@ -139,3 +141,114 @@ def test_playlist_progress(self):
         self.assertEqual(len(exercises),1)
         #checking if the returned list is accurate
         self.assertEqual(exercises[0]["title"],"Comparing two-digit numbers")
+
+
+class LearnerLogAPITests(FacilityMixins,
+                       StudentProgressMixin,
+                       CreateZoneMixin,
+                       CreateAdminMixin,
+                       KALiteTestCase):
+    """
+    These tests test the learner log API endpoint in the coachreports app.
+    """
+
+    def setUp(self):
+        super(LearnerLogAPITests, self).setUp()
+
+        self.admin_data = {"username": "admin", "password": "admin"}
+        self.admin = self.create_admin(**self.admin_data)
+
+        self.zone = self.create_zone()
+        self.device_zone = self.create_device_zone(self.zone)
+        self.facility = self.create_facility()
+
+        self.group = self.create_group(name='group1', facility=self.facility)
+        self.empty_group = self.create_group(name='empty_group', facility=self.facility)
+
+        self.facility_user = self.create_student()
+
+        self.topic1 = create({
+            "id": "stuff_here",
+            "slug": "stuff_here",
+            "path": "qwrqweqweqwe",
+            "kind": "Topic",
+            "title": "",
+            "description": "",
+            "available": True,
+        })
+        self.topic2 = create({
+            "id": "stuff_there",
+            "slug": "stuff_there",
+            "path": "qwrqweqweqw",
+            "kind": "Topic",
+            "title": "",
+            "description": "",
+            "available": True,
+        })
+
+        self.exercise1 = create({
+            "id": "stuff_here_ex",
+            "slug": "stuff_here_ex",
+            "path": "qwrqweqweqwe/qwrqweqweq",
+            "kind": "Exercise",
+            "title": "",
+            "description": "",
+            "available": True,
+            "parent": self.topic1,
+        })
+        self.exercise2 = create({
+            "id": "stuff_there_ex",
+            "slug": "stuff_there_ex",
+            "path": "qwrqweqweqw/qwrqweqw",
+            "kind": "Exercise",
+            "title": "",
+            "description": "",
+            "available": True,
+            "parent": self.topic2,
+        })
+
+        self.create_exercise_log(user=self.facility_user, exercise_id=self.exercise1.id)
+        self.create_exercise_log(user=self.facility_user, exercise_id=self.exercise2.id)
+
+    def tearDown(self):
+        self.exercise1.delete()
+        self.exercise2.delete()
+        self.topic1.delete()
+        self.topic2.delete()
+
+    def test_learner_log_topic_filters(self):
+
+        self.client.login(username='admin', password='admin')
+        api_resp_1 = json.loads(self.client.get("%s?facility_id=%s" % (self.reverse("learner_logs"), self.facility.id)).content)
+        api_resp_2 = json.loads(self.client.get("%s?facility_id=%s&topic_ids=%s" % (self.reverse("learner_logs"), self.facility.id, json.dumps([self.topic1.id]))).content)
+        assert len(api_resp_2["contents"]) < len(api_resp_1["contents"])
+
+    def test_learner_log_topic_filters_contents_length(self):
+
+        self.client.login(username='admin', password='admin')
+        api_resp_2 = json.loads(self.client.get("%s?facility_id=%s&topic_ids=%s" % (self.reverse("learner_logs"), self.facility.id, json.dumps([self.topic1.id]))).content)
+        assert len(api_resp_2["contents"]) == 1
+
+    def test_learner_log_topic_filters_contents_id(self):
+
+        self.client.login(username='admin', password='admin')
+        api_resp_2 = json.loads(self.client.get("%s?facility_id=%s&topic_ids=%s" % (self.reverse("learner_logs"), self.facility.id, json.dumps([self.topic1.id]))).content)
+        assert api_resp_2["contents"][0]["id"] == self.exercise1.id
+
+    def test_learner_log_contents(self):
+
+        self.client.login(username='admin', password='admin')
+        api_resp_1 = json.loads(self.client.get("%s?facility_id=%s" % (self.reverse("learner_logs"), self.facility.id)).content)
+        assert len(api_resp_1["contents"]) == 2
+
+    def test_learner_log_logs(self):
+
+        self.client.login(username='admin', password='admin')
+        api_resp_1 = json.loads(self.client.get("%s?facility_id=%s" % (self.reverse("learner_logs"), self.facility.id)).content)
+        assert len(api_resp_1["logs"]) == 2
+
+    def test_learner_log_log_contents(self):
+
+        self.client.login(username='admin', password='admin')
+        api_resp_2 = json.loads(self.client.get("%s?facility_id=%s&topic_ids=%s" % (self.reverse("learner_logs"), self.facility.id, json.dumps([self.topic1.id]))).content)
+        assert api_resp_2["logs"][0]["exercise_id"] == self.exercise1.id

kalite/distributed/static/css/distributed/content_recommendation.less

@@ -1,4 +1,10 @@
 .content-nextsteps-topic-link div {
 	background-color: #5aa685;
 	color: white;
-}
+}
+
+i.content-rec-icon {
+	font-size:4em;
+	top: 0.2em;
+    position: relative;
+}

kalite/distributed/static/js/distributed/contentrec/hbtemplates/content-explore-topic.handlebars

@@ -7,11 +7,11 @@
       </div>
     </div>
     <div class="row">
-      <div class="col-xs-5">
+      <div class="col-xs-12">
           <h2 class="h3">{{ suggested_topic.title }}:</h2>
       </div>
       {{#if suggested_topic.description }}
-      <div class="col-xs-7">
+      <div class="col-xs-12">
         <p class="h4">{{_ "Description" }}:</p>
         <p aria-hidden="true">{{ truncate suggested_topic.description 70 }}</p>
         <span class="sr-only">{{ suggested_topic.description }}</span>

kalite/distributed/static/js/distributed/contentrec/hbtemplates/content-nextsteps-lesson.handlebars

@@ -12,7 +12,7 @@
                   alt="{{ truncate description 150 }}"
               {{/if}}>
           {{else}}
-          <span aria-hidden="true" role="presentation"><i class="icon-{{kind}} glyphicon glyphicon-expand gly-h1"></i></span>
+          <span aria-hidden="true" role="presentation"><i class="icon-{{kind}} content-rec-icon"></i></span>
           {{/if}}
         </center>
       </div>

kalite/distributed/static/js/distributed/contentrec/hbtemplates/content-resume.handlebars

@@ -49,7 +49,7 @@
       <div class="row">
         <div class="col-xs-3">
           <center>
-            <span aria-hidden="true" role="presentation"><i id="exercise-icon" class="icon-{{kind}} glyphicon glyphicon-pencil gly-h1"></i></span>
+            <span aria-hidden="true" role="presentation"><i class="icon-{{kind}} content-rec-icon"></i></span>
           </center>
         </div> 
 

kalite/distributed/static/js/distributed/exercises/models.js

@@ -65,7 +65,7 @@ var ExerciseDataModel = ContentModels.ContentDataModel.extend({
                 "secondsPerFastProblem": this.get("seconds_per_fast_problem"),
                 "authorName": this.get("author_name"),
                 "relatedVideos": this.get("related_videos"),
-                "fileName": this.get("template")
+                "fileName": this.get("file_name")
             },
             "exerciseProgress": {
                 "level": "" // needed to keep khan-exercises from blowing up