From 1d2224e9410fa2cd68bc6d151d9861726b6a2b4e Mon Sep 17 00:00:00 2001
From: Ramon Wenger <ramon.wenger@iterativ.ch>
Date: Wed, 17 Jul 2024 16:28:58 +0200
Subject: [PATCH] Add filter to learning path list view, refactor code

---
 .../LearningPathListTopic.vue                 | 37 +++++++++++
 .../learningPathPage/LearningPathListView.vue | 21 +++----
 .../learningPathPage/LearningPathPage.vue     |  1 +
 .../LearningPathPathTopic.vue                 | 63 +++++++++++++++++++
 .../learningPathPage/LearningPathPathView.vue | 58 ++++-------------
 client/tailwind.css                           |  5 +-
 6 files changed, 123 insertions(+), 62 deletions(-)
 create mode 100644 client/src/pages/learningPath/learningPathPage/LearningPathListTopic.vue
 create mode 100644 client/src/pages/learningPath/learningPathPage/LearningPathPathTopic.vue

diff --git a/client/src/pages/learningPath/learningPathPage/LearningPathListTopic.vue b/client/src/pages/learningPath/learningPathPage/LearningPathListTopic.vue
new file mode 100644
index 00000000..9921976a
--- /dev/null
+++ b/client/src/pages/learningPath/learningPathPage/LearningPathListTopic.vue
@@ -0,0 +1,37 @@
+<script lang="ts" setup>
+import LearningPathCircleListTile from "@/pages/learningPath/learningPathPage/LearningPathCircleListTile.vue";
+import type { LearningContentWithCompletion, TopicType } from '@/types';
+import { computed } from "vue";
+
+interface Props {
+  topic: TopicType;
+  nextLearningContent?: LearningContentWithCompletion;
+  filter?: string;
+}
+const props = defineProps<Props>();
+
+
+const filteredCircles = computed(() => {
+  if (props.filter === undefined || props.filter === "") {
+    return props.topic.circles;
+  }
+  return props.topic.circles.filter(
+    (circle) =>
+      circle.profiles.indexOf(props.filter as string) > -1 || circle.is_base_circle
+  );
+});
+</script>
+
+<template>
+  <div>
+    <div class="pb-2 font-bold text-gray-700">
+      {{ topic.title }}
+    </div>
+    <LearningPathCircleListTile
+      v-for="circle in filteredCircles"
+      :key="circle.id"
+      :circle="circle"
+      :next-learning-content="nextLearningContent"
+    ></LearningPathCircleListTile>
+  </div>
+</template>
diff --git a/client/src/pages/learningPath/learningPathPage/LearningPathListView.vue b/client/src/pages/learningPath/learningPathPage/LearningPathListView.vue
index 3fe62231..e4f6fd56 100644
--- a/client/src/pages/learningPath/learningPathPage/LearningPathListView.vue
+++ b/client/src/pages/learningPath/learningPathPage/LearningPathListView.vue
@@ -1,26 +1,23 @@
 <script setup lang="ts">
-import LearningPathCircleListTile from "@/pages/learningPath/learningPathPage/LearningPathCircleListTile.vue";
 import { computed } from "vue";
 import type { LearningContentWithCompletion, LearningPathType } from "@/types";
+import LearningPathListTopic from "./LearningPathListTopic.vue";
 
 const props = defineProps<{
   learningPath: LearningPathType | undefined;
   nextLearningContent: LearningContentWithCompletion | undefined;
+  filter?: string;
 }>();
 
 const topics = computed(() => props.learningPath?.topics ?? []);
 </script>
 
 <template>
-  <div v-for="topic in topics" :key="topic.title">
-    <div class="pb-2 font-bold text-gray-700">
-      {{ topic.title }}
-    </div>
-    <LearningPathCircleListTile
-      v-for="circle in topic.circles"
-      :key="circle.id"
-      :circle="circle"
-      :next-learning-content="props.nextLearningContent"
-    ></LearningPathCircleListTile>
-  </div>
+  <LearningPathListTopic
+    v-for="topic in topics"
+    :key="topic.title"
+    :topic="topic"
+    :next-learning-content="nextLearningContent"
+    :filter="filter"
+  />
 </template>
diff --git a/client/src/pages/learningPath/learningPathPage/LearningPathPage.vue b/client/src/pages/learningPath/learningPathPage/LearningPathPage.vue
index 093ba280..7af5a9b3 100644
--- a/client/src/pages/learningPath/learningPathPage/LearningPathPage.vue
+++ b/client/src/pages/learningPath/learningPathPage/LearningPathPage.vue
@@ -152,6 +152,7 @@ const changeViewType = (viewType: ViewType) => {
           <LearningPathListView
             :learning-path="learningPath"
             :next-learning-content="lpQueryResult.nextLearningContent.value"
+            :filter="filter"
           ></LearningPathListView>
         </div>
         <div
diff --git a/client/src/pages/learningPath/learningPathPage/LearningPathPathTopic.vue b/client/src/pages/learningPath/learningPathPage/LearningPathPathTopic.vue
new file mode 100644
index 00000000..ae04022b
--- /dev/null
+++ b/client/src/pages/learningPath/learningPathPage/LearningPathPathTopic.vue
@@ -0,0 +1,63 @@
+<script setup lang="ts">
+import {computed} from "vue";
+import type { LearningContentWithCompletion, TopicType } from '@/types';
+import LearningPathCircleColumn from './LearningPathCircleColumn.vue';
+
+interface Props {
+  topic: TopicType;
+  topicIndex: number;
+  nextLearningContent?: LearningContentWithCompletion;
+  overrideCircleUrlBase?: string;
+  filter?: string;
+  isLastTopic: boolean;
+}
+
+const props = defineProps<Props>();
+
+const isFirstCircle = (circleIndex: number) =>
+  props.topicIndex === 0 && circleIndex === 0;
+
+const isLastCircle = (circleIndex: number, numCircles: number) =>
+  props.isLastTopic && circleIndex === numCircles - 1;
+
+
+const filteredCircles = computed(() => {
+  if (props.filter === undefined || props.filter === "") {
+    return props.topic.circles;
+  }
+  return props.topic.circles.filter(
+    (circle) =>
+      circle.profiles.indexOf(props.filter as string) > -1 || circle.is_base_circle
+  );
+});
+</script>
+
+<template>
+  <div
+    class="border-l border-gray-500"
+    :class="topicIndex == 0 ? 'ml-6 sm:ml-12' : ''"
+  >
+    <p
+      :id="`topic-${topic.slug}`"
+      class="inline-block h-12 self-start px-4 font-bold text-gray-800"
+      data-cy="lp-topic"
+    >
+      {{ topic.title }}
+    </p>
+    <div class="flex flex-row pt-6">
+      <LearningPathCircleColumn
+        v-for="(circle, circleIndex) in filteredCircles"
+        :key="circle.id"
+        :circle="circle"
+        :next-learning-content="nextLearningContent"
+        :is-first-circle="isFirstCircle(circleIndex)"
+        :is-last-circle="
+        isLastCircle(circleIndex, topic.circles.length)
+        "
+        :override-circle-url="
+        overrideCircleUrlBase ? `${overrideCircleUrlBase}/${circle.slug}` : undefined
+        "
+      ></LearningPathCircleColumn>
+    </div>
+  </div>
+</template>
diff --git a/client/src/pages/learningPath/learningPathPage/LearningPathPathView.vue b/client/src/pages/learningPath/learningPathPage/LearningPathPathView.vue
index 1eb7e0ba..58068ba8 100644
--- a/client/src/pages/learningPath/learningPathPage/LearningPathPathView.vue
+++ b/client/src/pages/learningPath/learningPathPage/LearningPathPathView.vue
@@ -2,13 +2,13 @@
 import LearningPathCircleColumn from "@/pages/learningPath/learningPathPage/LearningPathCircleColumn.vue";
 import LearningPathScrollButton from "@/pages/learningPath/learningPathPage/LearningPathScrollButton.vue";
 import { useScroll } from "@vueuse/core";
-import { nextTick, ref, watch } from "vue";
+import { computed, nextTick, ref, watch } from "vue";
 import type {
   LearningContentWithCompletion,
   LearningPathType,
-  TopicType,
 } from "@/types";
 import LoadingSpinner from "@/components/ui/LoadingSpinner.vue";
+import LearningPathPathTopic from "./LearningPathPathTopic.vue";
 
 const props = defineProps<{
   learningPath: LearningPathType | undefined;
@@ -24,13 +24,6 @@ const scrollIncrement = 600;
 const learnPathDiagram = ref<HTMLElement | null>(null);
 const { x, arrivedState } = useScroll(learnPathDiagram, { behavior: "smooth" });
 
-const isFirstCircle = (topicIndex: number, circleIndex: number) =>
-  topicIndex === 0 && circleIndex === 0;
-
-const isLastCircle = (topicIndex: number, circleIndex: number, numCircles: number) =>
-  topicIndex === (props.learningPath?.topics ?? []).length - 1 &&
-  circleIndex === numCircles - 1;
-
 const scrollRight = () => scrollLearnPathDiagram(scrollIncrement);
 
 const scrollLeft = () => scrollLearnPathDiagram(-scrollIncrement);
@@ -39,15 +32,7 @@ const scrollLearnPathDiagram = (offset: number) => {
   x.value += offset;
 };
 
-const filterCircles = (topic: TopicType) => {
-  if (props.filter === undefined || props.filter === "") {
-    return topic.circles;
-  }
-  return topic.circles.filter(
-    (circle) =>
-      circle.profiles.indexOf(props.filter as string) > -1 || circle.is_base_circle
-  );
-};
+const topics = computed(() => props.learningPath?.topics ?? []);
 
 watch(()=> props.filter, () => {
   // we need to update the scroll state of the element, otherwise the arrows won't match the scroll state
@@ -76,37 +61,16 @@ watch(()=> props.filter, () => {
       ref="learnPathDiagram"
       class="no-scrollbar flex h-96 snap-x flex-row overflow-auto py-5 sm:py-10"
     >
-      <div
+      <LearningPathPathTopic
         v-for="(topic, topicIndex) in props.learningPath?.topics ?? []"
         :key="topic.title"
-        class="border-l border-gray-500"
-        :class="topicIndex == 0 ? 'ml-6 sm:ml-12' : ''"
-      >
-        <p
-          :id="`topic-${topic.slug}`"
-          class="inline-block h-12 self-start px-4 font-bold text-gray-800"
-          data-cy="lp-topic"
-        >
-          {{ topic.title }}
-        </p>
-        <div class="flex flex-row pt-6">
-          <LearningPathCircleColumn
-            v-for="(circle, circleIndex) in filterCircles(topic)"
-            :key="circle.id"
-            :circle="circle"
-            :next-learning-content="props.nextLearningContent"
-            :is-first-circle="isFirstCircle(topicIndex, circleIndex)"
-            :is-last-circle="
-              isLastCircle(topicIndex, circleIndex, topic.circles.length)
-            "
-            :override-circle-url="
-              props.overrideCircleUrlBase
-                ? `${props.overrideCircleUrlBase}/${circle.slug}`
-                : undefined
-            "
-          ></LearningPathCircleColumn>
-        </div>
-      </div>
+        :topic-index="topicIndex"
+        :topic="topic"
+        :next-learning-content="nextLearningContent"
+        :override-circle-url-base="overrideCircleUrlBase"
+        :filter="filter"
+        :is-last-topic="topicIndex === (topics.length - 1)"
+         />
     </div>
     <LearningPathScrollButton
       v-show="!arrivedState.right"
diff --git a/client/tailwind.css b/client/tailwind.css
index 260b86fd..87ca4176 100644
--- a/client/tailwind.css
+++ b/client/tailwind.css
@@ -93,7 +93,7 @@ textarea {
   }
 
   .link {
-    @apply underline underline-offset-2;
+    @apply underline underline-offset-2 cursor-pointer;
   }
 
   .link-large {
@@ -117,8 +117,7 @@ textarea {
   }
 
   .filter-blue-900 {
-    filter: invert(9%) sepia(38%) saturate(5684%) hue-rotate(200deg) brightness(95%)
-      contrast(105%);
+    filter: invert(9%) sepia(38%) saturate(5684%) hue-rotate(200deg) brightness(95%) contrast(105%);
   }
 }