From 9c8efab23656480199276b444fed253e55cf3f5c Mon Sep 17 00:00:00 2001
From: N-Pex <npexdev@gmail.com>
Date: Tue, 17 Nov 2020 20:32:37 +0100
Subject: [PATCH] Break message layouts out into separate compontents

---
 src/components/Chat.vue                       | 170 ++++++++----------
 src/components/messages/ContactInvited.vue    |  25 +++
 src/components/messages/ContactJoin.vue       |  25 +++
 src/components/messages/ContactLeave.vue      |  25 +++
 src/components/messages/DebugEvent.vue        |  15 ++
 .../messages/MessageIncomingText.vue          |  35 ++++
 .../messages/MessageOutgoingText.vue          |  26 +++
 src/components/messages/RoomAvatarChanged.vue |  18 ++
 src/components/messages/RoomNameChanged.vue   |  19 ++
 src/components/messages/RoomTopicChanged.vue  |  19 ++
 src/components/messages/messageMixin.js       |  68 +++++++
 11 files changed, 349 insertions(+), 96 deletions(-)
 create mode 100644 src/components/messages/ContactInvited.vue
 create mode 100644 src/components/messages/ContactJoin.vue
 create mode 100644 src/components/messages/ContactLeave.vue
 create mode 100644 src/components/messages/DebugEvent.vue
 create mode 100644 src/components/messages/MessageIncomingText.vue
 create mode 100644 src/components/messages/MessageOutgoingText.vue
 create mode 100644 src/components/messages/RoomAvatarChanged.vue
 create mode 100644 src/components/messages/RoomNameChanged.vue
 create mode 100644 src/components/messages/RoomTopicChanged.vue
 create mode 100644 src/components/messages/messageMixin.js

diff --git a/src/components/Chat.vue b/src/components/Chat.vue
index 37531eb..2015ec0 100644
--- a/src/components/Chat.vue
+++ b/src/components/Chat.vue
@@ -8,97 +8,53 @@
     >
       <div v-for="event in events" :key="event.eventId">
         <!-- Contact joined the chat -->
-        <div
+        <ContactJoin
           class="messageJoin"
           v-if="
             event.event.state_key != myUserId &&
             event.getContent().membership == 'join' &&
             event.getType() == 'm.room.member'
-          "
-        >
-          {{ stateEventDisplayName(event) }} joined the chat
-        </div>
+          " :room="room" :event="event"
+        />
 
         <!-- Contact left the chat -->
-        <div
+        <ContactLeave
           class="messageJoin"
           v-if="
             event.event.state_key != myUserId &&
             event.getContent().membership == 'leave' &&
             event.getType() == 'm.room.member'
-          "
-        >
-          {{ stateEventDisplayName(event) }} left the chat
-        </div>
+          " :room="room" :event="event"
+        />
 
         <!-- Contact invited to the chat -->
-        <div
+        <ContactInvited
           class="messageJoin"
           v-if="
             event.event.state_key != myUserId &&
             event.getContent().membership == 'invite' &&
             event.getType() == 'm.room.member'
-          "
-        >
-          {{ stateEventDisplayName(event) }} was invited to the chat...
-        </div>
+          " :room="room" :event="event"
+        />
 
-        <div
+        <MessageIncomingText
           v-else-if="
             event.getSender() != myUserId && event.getType() == 'm.room.message'
-          "
-        >
-          <div class="messageIn">
-            <div class="sender">{{ messageEventDisplayName(event) }}</div>
-            <v-avatar class="avatar" size="40" color="grey">
-              <img
-                v-if="messageEventAvatar(event)"
-                :src="messageEventAvatar(event)"
-              />
-              <span v-else class="white--text headline">{{
-                messageEventDisplayName(event).substring(0, 1).toUpperCase()
-              }}</span>
-            </v-avatar>
+          " :room="room" :event="event"
+        />
 
-            <div class="bubble">
-              <div class="message">{{ event.getContent().body }}</div>
-            </div>
-          </div>
-          <div class="time">
-            {{ formatTime(event.event.origin_server_ts) }}
-          </div>
-        </div>
-        <div v-else-if="event.getType() == 'm.room.message'">
-          <div class="messageOut">
-            <div class="sender">{{ "You" }}</div>
-            <div class="bubble">
-              <div class="message">{{ event.getContent().body }}</div>
-            </div>
-            <div class="status">{{ event.status }}</div>
-          </div>
-          <div class="time">
-            {{ formatTime(event.event.origin_server_ts) }}
-          </div>
-        </div>
+        <MessageOutgoingText v-else-if="event.getType() == 'm.room.message'" :room="room" :event="event" />
 
         <!-- ROOM NAME CHANGED -->
-        <div v-else-if="event.getType() == 'm.room.name'" class="statusEvent">
-          {{ stateEventDisplayName(event) }} changed room name to
-          {{ event.getContent().name }}
-        </div>
+        <RoomNameChanged v-else-if="event.getType() == 'm.room.name'" :room="room" :event="event" />
 
         <!-- ROOM TOPIC CHANGED -->
-        <div v-else-if="event.getType() == 'm.room.topic'" class="statusEvent">
-          {{ stateEventDisplayName(event) }} changed topic to
-          {{ event.getContent().topic }}
-        </div>
+        <RoomTopicChanged v-else-if="event.getType() == 'm.room.topic'" :room="room" :event="event" />
 
         <!-- ROOM AVATAR CHANGED -->
-        <div v-else-if="event.getType() == 'm.room.avatar'" class="statusEvent">
-          {{ stateEventDisplayName(event) }} changed the room avatar
-        </div>
+        <RoomAvatarChanged v-else-if="event.getType() == 'm.room.avatar'" :room="room" :event="event" />
 
-        <div v-else class="statusEvent">Event: {{ event.getType() }}</div>
+        <DebugEvent v-else :room="room" :event="event" />
       </div>
     </div>
 
@@ -169,6 +125,15 @@
 
 <script>
 import { TimelineWindow, EventTimeline } from "matrix-js-sdk";
+import MessageIncomingText from './messages/MessageIncomingText';
+import MessageOutgoingText from './messages/MessageOutgoingText';
+import ContactJoin from './messages/ContactJoin.vue';
+import ContactLeave from './messages/ContactLeave.vue';
+import ContactInvited from './messages/ContactInvited.vue';
+import RoomNameChanged from './messages/RoomNameChanged.vue';
+import RoomTopicChanged from './messages/RoomTopicChanged.vue';
+import RoomAvatarChanged from './messages/RoomAvatarChanged.vue';
+import DebugEvent from "./messages/DebugEvent.vue";
 
 // from https://kirbysayshi.com/2013/08/19/maintaining-scroll-position-knockoutjs-list.html
 function ScrollPosition(node) {
@@ -200,7 +165,19 @@ ScrollPosition.prototype.prepareFor = function (direction) {
 export default {
   name: "Chat",
 
-  data: () => ({
+  components: {
+    MessageIncomingText,
+    MessageOutgoingText,
+    ContactJoin,
+    ContactLeave,
+    ContactInvited,
+    RoomNameChanged,
+    RoomTopicChanged,
+    RoomAvatarChanged,
+    DebugEvent
+  },
+
+  data() { return {
     room: null,
     events: [],
     currentInput: "",
@@ -212,7 +189,7 @@ export default {
     currentSendOperation: null,
     currentSendProgress: null,
     currentSendError: null,
-  }),
+  }},
 
   mounted() {
     const container = this.$refs.chatContainer;
@@ -313,39 +290,6 @@ export default {
       console.log("Typing:", event);
     },
 
-    /**
-     * Get a display name given an event.
-     */
-    stateEventDisplayName(event) {
-      if (this.room) {
-        const member = this.room.getMember(event.getSender());
-        if (member) {
-          return member.name;
-        }
-      }
-      return event.getContent().displayname || event.event.state_key;
-    },
-
-    messageEventDisplayName(event) {
-      return this.stateEventDisplayName(event);
-    },
-
-    messageEventAvatar(event) {
-      if (this.room) {
-        const member = this.room.getMember(event.getSender());
-        if (member) {
-          return member.getAvatarUrl(
-            this.$matrix.matrixClient.getHomeserverUrl(),
-            40,
-            40,
-            "scale",
-            true
-          );
-        }
-      }
-      return null;
-    },
-
     sendMessage() {
       if (this.currentInput.length > 0) {
         this.sendMatrixMessage(this.currentInput);
@@ -540,6 +484,40 @@ export default {
         }
       });
     },
+
+        /**
+     * Get a display name given an event.
+     */
+    stateEventDisplayName(event) {
+      if (this.room) {
+        const member = this.room.getMember(event.getSender());
+        if (member) {
+          return member.name;
+        }
+      }
+      return event.getContent().displayname || event.event.state_key;
+    },
+
+    messageEventDisplayName(event) {
+      return this.stateEventDisplayName(event);
+    },
+
+    messageEventAvatar(event) {
+      if (this.room) {
+        const member = this.room.getMember(event.getSender());
+        if (member) {
+          return member.getAvatarUrl(
+            this.$matrix.matrixClient.getHomeserverUrl(),
+            40,
+            40,
+            "scale",
+            true
+          );
+        }
+      }
+      return null;
+    },
+
   },
 };
 </script>
diff --git a/src/components/messages/ContactInvited.vue b/src/components/messages/ContactInvited.vue
new file mode 100644
index 0000000..8363b66
--- /dev/null
+++ b/src/components/messages/ContactInvited.vue
@@ -0,0 +1,25 @@
+<template>
+  <!-- Contact invited to the chat -->
+  <div
+    class="messageJoin"
+    v-if="
+      event.event.state_key != myUserId &&
+      event.getContent().membership == 'invite' &&
+      event.getType() == 'm.room.member'
+    "
+  >
+    {{ stateEventDisplayName(event) }} was invited to the chat...
+  </div>
+</template>
+
+<script>
+import messageMixin from "./messageMixin";
+
+export default {
+  mixins: [messageMixin],
+};
+</script>
+
+<style lang="scss">
+@import "@/assets/css/chat.scss";
+</style>
\ No newline at end of file
diff --git a/src/components/messages/ContactJoin.vue b/src/components/messages/ContactJoin.vue
new file mode 100644
index 0000000..cae7d83
--- /dev/null
+++ b/src/components/messages/ContactJoin.vue
@@ -0,0 +1,25 @@
+<template>
+  <!-- Contact joined the chat -->
+  <div
+    class="messageJoin"
+    v-if="
+      event.event.state_key != myUserId &&
+      event.getContent().membership == 'join' &&
+      event.getType() == 'm.room.member'
+    "
+  >
+    {{ stateEventDisplayName(event) }} joined the chat
+  </div>
+</template>
+
+<script>
+import messageMixin from "./messageMixin";
+
+export default {
+  mixins: [messageMixin],
+};
+</script>
+
+<style lang="scss">
+@import "@/assets/css/chat.scss";
+</style>
\ No newline at end of file
diff --git a/src/components/messages/ContactLeave.vue b/src/components/messages/ContactLeave.vue
new file mode 100644
index 0000000..5f6ae6c
--- /dev/null
+++ b/src/components/messages/ContactLeave.vue
@@ -0,0 +1,25 @@
+<template>
+  <!-- Contact left the chat -->
+  <div
+    class="messageJoin"
+    v-if="
+      event.event.state_key != myUserId &&
+      event.getContent().membership == 'leave' &&
+      event.getType() == 'm.room.member'
+    "
+  >
+    {{ stateEventDisplayName(event) }} left the chat
+  </div>
+</template>
+
+<script>
+import messageMixin from "./messageMixin";
+
+export default {
+  mixins: [messageMixin],
+};
+</script>
+
+<style lang="scss">
+@import "@/assets/css/chat.scss";
+</style>
\ No newline at end of file
diff --git a/src/components/messages/DebugEvent.vue b/src/components/messages/DebugEvent.vue
new file mode 100644
index 0000000..e678340
--- /dev/null
+++ b/src/components/messages/DebugEvent.vue
@@ -0,0 +1,15 @@
+<template>
+  <div class="statusEvent">Event: {{ event.getType() }}</div>
+</template>
+
+<script>
+import messageMixin from "./messageMixin";
+
+export default {
+  mixins: [messageMixin],
+};
+</script>
+
+<style lang="scss">
+@import "@/assets/css/chat.scss";
+</style>
\ No newline at end of file
diff --git a/src/components/messages/MessageIncomingText.vue b/src/components/messages/MessageIncomingText.vue
new file mode 100644
index 0000000..99802fc
--- /dev/null
+++ b/src/components/messages/MessageIncomingText.vue
@@ -0,0 +1,35 @@
+<template>
+  <div>
+    <div class="messageIn">
+      <div class="sender">{{ messageEventDisplayName(event) }}</div>
+      <v-avatar class="avatar" size="40" color="grey">
+        <img
+          v-if="messageEventAvatar(event)"
+          :src="messageEventAvatar(event)"
+        />
+        <span v-else class="white--text headline">{{
+          messageEventDisplayName(event).substring(0, 1).toUpperCase()
+        }}</span>
+      </v-avatar>
+
+      <div class="bubble">
+        <div class="message">{{ event.getContent().body }}</div>
+      </div>
+    </div>
+    <div class="time">
+      {{ formatTime(event.event.origin_server_ts) }}
+    </div>
+  </div>
+</template>
+
+<script>
+import messageMixin from "./messageMixin";
+
+export default {
+  mixins: [messageMixin],
+};
+</script>
+
+<style lang="scss">
+@import "@/assets/css/chat.scss";
+</style>
\ No newline at end of file
diff --git a/src/components/messages/MessageOutgoingText.vue b/src/components/messages/MessageOutgoingText.vue
new file mode 100644
index 0000000..113fb85
--- /dev/null
+++ b/src/components/messages/MessageOutgoingText.vue
@@ -0,0 +1,26 @@
+<template>
+  <div>
+    <div class="messageOut">
+      <div class="sender">{{ "You" }}</div>
+      <div class="bubble">
+        <div class="message">{{ event.getContent().body }}</div>
+      </div>
+      <div class="status">{{ event.status }}</div>
+    </div>
+    <div class="time">
+      {{ formatTime(event.event.origin_server_ts) }}
+    </div>
+  </div>
+</template>
+
+<script>
+import messageMixin from "./messageMixin";
+
+export default {
+  mixins: [messageMixin],
+};
+</script>
+
+<style lang="scss">
+@import "@/assets/css/chat.scss";
+</style>
\ No newline at end of file
diff --git a/src/components/messages/RoomAvatarChanged.vue b/src/components/messages/RoomAvatarChanged.vue
new file mode 100644
index 0000000..62b06f8
--- /dev/null
+++ b/src/components/messages/RoomAvatarChanged.vue
@@ -0,0 +1,18 @@
+<template>
+  <!-- ROOM AVATAR CHANGED -->
+  <div class="statusEvent">
+    {{ stateEventDisplayName(event) }} changed the room avatar
+  </div>
+</template>
+
+<script>
+import messageMixin from "./messageMixin";
+
+export default {
+  mixins: [messageMixin],
+};
+</script>
+
+<style lang="scss">
+@import "@/assets/css/chat.scss";
+</style>
\ No newline at end of file
diff --git a/src/components/messages/RoomNameChanged.vue b/src/components/messages/RoomNameChanged.vue
new file mode 100644
index 0000000..ac3e30f
--- /dev/null
+++ b/src/components/messages/RoomNameChanged.vue
@@ -0,0 +1,19 @@
+<template>
+  <!-- ROOM NAME CHANGED -->
+  <div class="statusEvent">
+    {{ stateEventDisplayName(event) }} changed room name to
+    {{ event.getContent().name }}
+  </div>
+</template>
+
+<script>
+import messageMixin from "./messageMixin";
+
+export default {
+  mixins: [messageMixin],
+};
+</script>
+
+<style lang="scss">
+@import "@/assets/css/chat.scss";
+</style>
\ No newline at end of file
diff --git a/src/components/messages/RoomTopicChanged.vue b/src/components/messages/RoomTopicChanged.vue
new file mode 100644
index 0000000..d669bb3
--- /dev/null
+++ b/src/components/messages/RoomTopicChanged.vue
@@ -0,0 +1,19 @@
+<template>
+  <!-- ROOM TOPIC CHANGED -->
+  <div class="statusEvent">
+    {{ stateEventDisplayName(event) }} changed topic to
+    {{ event.getContent().topic }}
+  </div>
+</template>
+
+<script>
+import messageMixin from "./messageMixin";
+
+export default {
+  mixins: [messageMixin],
+};
+</script>
+
+<style lang="scss">
+@import "@/assets/css/chat.scss";
+</style>
\ No newline at end of file
diff --git a/src/components/messages/messageMixin.js b/src/components/messages/messageMixin.js
new file mode 100644
index 0000000..2d049d2
--- /dev/null
+++ b/src/components/messages/messageMixin.js
@@ -0,0 +1,68 @@
+export default {
+  props: {
+    room: {
+      type: Object,
+      default: function () {
+        return null
+      }
+    },
+    event: {
+      type: Object,
+      default: function () {
+        return {}
+      }
+    },
+  },
+  computed: {
+  },
+  methods: {
+    /**
+     * Get a display name given an event.
+     */
+    stateEventDisplayName(event) {
+      if (this.room) {
+        const member = this.room.getMember(event.getSender());
+        if (member) {
+          return member.name;
+        }
+      }
+      return event.getContent().displayname || event.event.state_key;
+    },
+
+    messageEventDisplayName(event) {
+      return this.stateEventDisplayName(event);
+    },
+
+    messageEventAvatar(event) {
+      if (this.room) {
+        const member = this.room.getMember(event.getSender());
+        if (member) {
+          return member.getAvatarUrl(
+            this.$matrix.matrixClient.getHomeserverUrl(),
+            40,
+            40,
+            "scale",
+            true
+          );
+        }
+      }
+      return null;
+    },
+
+    formatTime(time) {
+      const date = new Date();
+      date.setTime(time);
+
+      const today = new Date();
+      if (
+        date.getDate() == today.getDate() &&
+        date.getMonth() == today.getMonth() &&
+        date.getFullYear() == today.getFullYear()
+      ) {
+        // For today, skip the date part
+        return date.toLocaleTimeString();
+      }
+      return date.toLocaleString();
+    },
+  }
+}
\ No newline at end of file