From 5fd81a2bd6dce6ed669178a6fa20c985c5b43cc9 Mon Sep 17 00:00:00 2001
From: Ramon Wenger <donramonloco+github@gmail.com>
Date: Mon, 7 Oct 2019 17:10:39 +0200
Subject: [PATCH] Rename Highlight to Bookmark

---
 client/src/components/ContentBlock.vue        |  3 +--
 .../content-blocks/ContentComponent.vue       | 22 +++++++++----------
 .../gql/fragments/contentBlockParts.gql       |  2 +-
 .../gql/mutations/updateContentBookmark.gql   |  5 +++++
 .../gql/mutations/updateContentHighlight.gql  |  5 -----
 ...ghts.py => 0015_contentblock_bookmarks.py} |  6 ++---
 server/books/models/contentblock.py           |  4 ++--
 server/books/schema/mutations/contentblock.py | 14 ++++++------
 server/books/schema/mutations/main.py         |  4 ++--
 server/books/schema/queries.py                |  8 +++----
 server/notes/migrations/0001_initial.py       |  4 ++--
 server/notes/models.py                        |  5 ++---
 12 files changed, 40 insertions(+), 42 deletions(-)
 create mode 100644 client/src/graphql/gql/mutations/updateContentBookmark.gql
 delete mode 100644 client/src/graphql/gql/mutations/updateContentHighlight.gql
 rename server/books/migrations/{0015_contentblock_highlights.py => 0015_contentblock_bookmarks.py} (63%)

diff --git a/client/src/components/ContentBlock.vue b/client/src/components/ContentBlock.vue
index c0b79ec8..a8b22d32 100644
--- a/client/src/components/ContentBlock.vue
+++ b/client/src/components/ContentBlock.vue
@@ -17,12 +17,11 @@
       <h3 v-if="instrumentLabel !== ''" class="content-block__instrument-label">{{instrumentLabel}}</h3>
       <h4 class="content-block__title" v-if="!contentBlock.indent">{{contentBlock.title}}</h4>
 
-
       <content-component v-for="component in contentBlocksWithContentLists.contents"
                          :key="component.id"
                          :component="component"
                          :parent="contentBlock.id"
-                         :highlights="contentBlock.highlights">
+                         :bookmarks="contentBlock.bookmarks">
       </content-component>
 
     </div>
diff --git a/client/src/components/content-blocks/ContentComponent.vue b/client/src/components/content-blocks/ContentComponent.vue
index 4b063a84..4be91e1e 100644
--- a/client/src/components/content-blocks/ContentComponent.vue
+++ b/client/src/components/content-blocks/ContentComponent.vue
@@ -1,9 +1,9 @@
 <template>
-  <div class="content-component" :class="{'content-component--highlighted': highlighted}">
+  <div class="content-component" :class="{'content-component--bookmarked': bookmarked}">
     {{component.id}}
-    <a @click="highlightContent(component.id, !highlighted)">Highlight</a>
+    <a @click="bookmarkContent(component.id, !bookmarked)">Bookmark</a>
     <div>
-      Highlighted: {{highlighted}}
+      Bookmarked: {{bookmarked}}
     </div>
     <component
       :is="component.type"
@@ -29,11 +29,11 @@
   import Survey from '@/components/content-blocks/SurveyBlock';
   import Solution from '@/components/content-blocks/Solution';
 
-  import UPDATE_CONTENT_HIGHLIGHT from '@/graphql/gql/mutations/updateContentHighlight.gql';
+  import UPDATE_CONTENT_BOOKMARK from '@/graphql/gql/mutations/updateContentBookmark.gql';
   import MODULE_DETAILS_QUERY from '@/graphql/gql/moduleDetailsQuery.gql';
 
   export default {
-    props: ['component', 'parent', 'highlights'],
+    props: ['component', 'parent', 'bookmarks'],
 
     components: {
       'text_block': TextBlock,
@@ -55,20 +55,20 @@
     },
 
     computed: {
-      highlighted() {
-        return this.highlights.indexOf(this.component.id) > -1;
+      bookmarked() {
+        return this.bookmarks.indexOf(this.component.id) > -1;
       }
     },
 
     methods: {
-      highlightContent(id, highlight) {
+      bookmarkContent(id, bookmarked) {
         this.$apollo.mutate({
-          mutation: UPDATE_CONTENT_HIGHLIGHT,
+          mutation: UPDATE_CONTENT_BOOKMARK,
           variables: {
             input: {
               id,
               contentBlock: this.parent,
-              highlight
+              bookmarked
             }
           },
           refetchQueries: [{
@@ -85,7 +85,7 @@
 
 <style lang="scss" scoped>
   .content-component {
-    &--highlighted {
+    &--bookmarked {
       background-color: yellow;
     }
   }
diff --git a/client/src/graphql/gql/fragments/contentBlockParts.gql b/client/src/graphql/gql/fragments/contentBlockParts.gql
index ec389fc3..e5fff945 100644
--- a/client/src/graphql/gql/fragments/contentBlockParts.gql
+++ b/client/src/graphql/gql/fragments/contentBlockParts.gql
@@ -6,7 +6,7 @@ fragment ContentBlockParts on ContentBlockNode {
   contents
   userCreated
   mine
-  highlights
+  bookmarks
   hiddenFor {
     edges {
       node {
diff --git a/client/src/graphql/gql/mutations/updateContentBookmark.gql b/client/src/graphql/gql/mutations/updateContentBookmark.gql
new file mode 100644
index 00000000..4dd42b9c
--- /dev/null
+++ b/client/src/graphql/gql/mutations/updateContentBookmark.gql
@@ -0,0 +1,5 @@
+mutation UpdateContentBookmark($input: UpdateContentBookmarkInput!) {
+  updateContentBookmark(input: $input) {
+    success
+  }
+}
diff --git a/client/src/graphql/gql/mutations/updateContentHighlight.gql b/client/src/graphql/gql/mutations/updateContentHighlight.gql
deleted file mode 100644
index 4a50f696..00000000
--- a/client/src/graphql/gql/mutations/updateContentHighlight.gql
+++ /dev/null
@@ -1,5 +0,0 @@
-mutation UpdateContentHighlight($input: UpdateContentHighlightInput!) {
-  updateContentHighlight(input: $input) {
-    success
-  }
-}
diff --git a/server/books/migrations/0015_contentblock_highlights.py b/server/books/migrations/0015_contentblock_bookmarks.py
similarity index 63%
rename from server/books/migrations/0015_contentblock_highlights.py
rename to server/books/migrations/0015_contentblock_bookmarks.py
index c56d12bf..6e3a1b18 100644
--- a/server/books/migrations/0015_contentblock_highlights.py
+++ b/server/books/migrations/0015_contentblock_bookmarks.py
@@ -1,4 +1,4 @@
-# Generated by Django 2.0.6 on 2019-10-01 13:25
+# Generated by Django 2.0.6 on 2019-10-07 14:53
 
 from django.conf import settings
 from django.db import migrations, models
@@ -15,7 +15,7 @@ class Migration(migrations.Migration):
     operations = [
         migrations.AddField(
             model_name='contentblock',
-            name='highlights',
-            field=models.ManyToManyField(related_name='highlighted_content_blocks', through='notes.ContentBlockHighlight', to=settings.AUTH_USER_MODEL),
+            name='bookmarks',
+            field=models.ManyToManyField(related_name='bookmarked_content_blocks', through='notes.ContentBlockBookmark', to=settings.AUTH_USER_MODEL),
         ),
     ]
diff --git a/server/books/models/contentblock.py b/server/books/models/contentblock.py
index 5eafff98..f44e4b0e 100644
--- a/server/books/models/contentblock.py
+++ b/server/books/models/contentblock.py
@@ -10,7 +10,7 @@ from books.blocks import TextBlock, BasicKnowledgeBlock, LinkBlock, VideoBlock,
     ImageUrlBlock, AssignmentBlock, InfogramBlock, GeniallyBlock, SubtitleBlock, SurveyBlock, ModuleRoomSlugBlock
 from books.utils import get_type_and_value
 from core.wagtail_utils import StrictHierarchyPage
-from notes.models import Highlight, ContentBlockHighlight
+from notes.models import ContentBlockBookmark
 from surveys.models import Survey
 from users.models import SchoolClass, User
 
@@ -40,7 +40,7 @@ class ContentBlock(StrictHierarchyPage):
     visible_for = models.ManyToManyField(SchoolClass, related_name='visible_content_blocks')
     user_created = models.BooleanField(default=False)
 
-    highlights = models.ManyToManyField(User, through=ContentBlockHighlight, related_name='highlighted_content_blocks')
+    bookmarks = models.ManyToManyField(User, through=ContentBlockBookmark, related_name='bookmarked_content_blocks')
 
     content_blocks = [
         ('text_block', TextBlock()),
diff --git a/server/books/schema/mutations/contentblock.py b/server/books/schema/mutations/contentblock.py
index 653a1c50..4926f59b 100644
--- a/server/books/schema/mutations/contentblock.py
+++ b/server/books/schema/mutations/contentblock.py
@@ -10,7 +10,7 @@ from books.models import ContentBlock, Chapter, SchoolClass
 from books.schema.inputs import ContentBlockInput
 from books.schema.queries import ContentBlockNode
 from core.utils import set_hidden_for, set_visible_for
-from notes.models import ContentBlockHighlight
+from notes.models import ContentBlockBookmark
 from .utils import handle_content_block, set_user_defined_block_type
 
 
@@ -148,11 +148,11 @@ class DeleteContentBlock(relay.ClientIDMutation):
             return cls(success=False, errors='Content block not found')
 
 
-class UpdateContentHighlight(relay.ClientIDMutation):
+class UpdateContentBookmark(relay.ClientIDMutation):
     class Input:
         id = graphene.String(required=True)
         content_block = graphene.ID(required=True)
-        highlight = graphene.Boolean(required=True)
+        bookmarked = graphene.Boolean(required=True)
 
     success = graphene.Boolean()
     errors = graphene.String()
@@ -162,18 +162,18 @@ class UpdateContentHighlight(relay.ClientIDMutation):
         id = kwargs.get('id')
         user = info.context.user
         content_block_id = kwargs.get('content_block')
-        highlight = kwargs.get('highlight')
+        bookmarked = kwargs.get('bookmarked')
 
         content_block = get_object(ContentBlock, content_block_id)
 
-        if highlight:
-            ContentBlockHighlight.objects.create(
+        if bookmarked:
+            ContentBlockBookmark.objects.create(
                 content_block=content_block,
                 id=id,
                 user=user
             )
         else:
-            ContentBlockHighlight.objects.get(
+            ContentBlockBookmark.objects.get(
                 content_block=content_block,
                 id=id,
                 user=user
diff --git a/server/books/schema/mutations/main.py b/server/books/schema/mutations/main.py
index 08b06c3b..6b423176 100644
--- a/server/books/schema/mutations/main.py
+++ b/server/books/schema/mutations/main.py
@@ -1,5 +1,5 @@
 from books.schema.mutations.contentblock import MutateContentBlock, AddContentBlock, DeleteContentBlock, \
-    UpdateContentHighlight
+    UpdateContentBookmark
 from books.schema.mutations.module import UpdateSolutionVisibility, UpdateLastModule
 
 
@@ -9,4 +9,4 @@ class BookMutations(object):
     delete_content_block = DeleteContentBlock.Field()
     update_solution_visibility = UpdateSolutionVisibility.Field()
     update_last_module = UpdateLastModule.Field()
-    update_content_highlight = UpdateContentHighlight.Field()
+    update_content_bookmark = UpdateContentBookmark.Field()
diff --git a/server/books/schema/queries.py b/server/books/schema/queries.py
index 94881356..a8e73ee7 100644
--- a/server/books/schema/queries.py
+++ b/server/books/schema/queries.py
@@ -5,7 +5,7 @@ from graphene_django.filter import DjangoFilterConnectionField
 
 from api.utils import get_object
 from books.utils import are_solutions_enabled_for
-from notes.models import ContentBlockHighlight
+from notes.models import ContentBlockBookmark
 from rooms.models import ModuleRoomSlug
 from ..models import Book, Topic, Module, Chapter, ContentBlock
 
@@ -25,7 +25,7 @@ def process_module_room_slug_block(content):
 
 class ContentBlockNode(DjangoObjectType):
     mine = graphene.Boolean()
-    highlights = graphene.List(graphene.String)
+    bookmarks = graphene.List(graphene.String)
 
     class Meta:
         model = ContentBlock
@@ -56,8 +56,8 @@ class ContentBlockNode(DjangoObjectType):
         self.contents.stream_data = updated_stream_data
         return self.contents
 
-    def resolve_highlights(self, info, **kwargs):
-        return [highlight.id for highlight in ContentBlockHighlight.objects.filter(
+    def resolve_bookmarks(self, info, **kwargs):
+        return [bookmark.id for bookmark in ContentBlockBookmark.objects.filter(
             user=info.context.user,
             content_block=self
         )]
diff --git a/server/notes/migrations/0001_initial.py b/server/notes/migrations/0001_initial.py
index 83165dd3..61fdfc1f 100644
--- a/server/notes/migrations/0001_initial.py
+++ b/server/notes/migrations/0001_initial.py
@@ -1,4 +1,4 @@
-# Generated by Django 2.0.6 on 2019-10-01 13:25
+# Generated by Django 2.0.6 on 2019-10-07 14:53
 
 from django.conf import settings
 from django.db import migrations, models
@@ -16,7 +16,7 @@ class Migration(migrations.Migration):
 
     operations = [
         migrations.CreateModel(
-            name='ContentBlockHighlight',
+            name='ContentBlockBookmark',
             fields=[
                 ('id', models.UUIDField(primary_key=True, serialize=False)),
                 ('content_block', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='books.ContentBlock')),
diff --git a/server/notes/models.py b/server/notes/models.py
index e01d9a25..5d1e2b13 100644
--- a/server/notes/models.py
+++ b/server/notes/models.py
@@ -5,8 +5,7 @@ from core.wagtail_utils import StrictHierarchyPage
 from users.models import User
 
 
-# todo: change from Highlight to Bookmark / Note (tbd)
-class Highlight(models.Model):
+class Bookmark(models.Model):
     id = models.UUIDField(primary_key=True)
     user = models.ForeignKey(User, on_delete=models.CASCADE)
 
@@ -14,5 +13,5 @@ class Highlight(models.Model):
         abstract = True
 
 
-class ContentBlockHighlight(Highlight):
+class ContentBlockBookmark(Bookmark):
     content_block = models.ForeignKey('books.ContentBlock', on_delete=models.CASCADE)