Merge pull request #404 from penge/sort-by-created

Order notes by Latest Created

Author: penge

.eslintignore

@@ -1,3 +1,4 @@
+node_modules/*
 dist/*
 jest.config.ts
 build.ts

src/i18n/en.json

@@ -116,7 +116,8 @@
   "Current order:": "Current order:",
   "Orders": {
     "Alphabetical": "Alphabetical",
-    "NewestFirst": "Newest first",
+    "LatestCreated": "Latest Created",
+    "LatestModified": "Latest Modified",
     "Custom": "Custom"
   },
   "Orders description": "When <b>\"Custom\"</b> is selected, you can <b>Drag & Drop</b> notes to change their order.",

src/notes.tsx

@@ -19,13 +19,13 @@ import {
 } from "shared/storage/schema";
 import { setTheme as setThemeCore } from "themes/set-theme";
 
+import Overview from "notes/components/Overview";
 import __Notification from "notes/components/Notification";
 import __Sidebar from "notes/components/Sidebar";
 import __Content from "notes/components/content/Content";
 import { ContentNote } from "notes/components/content/common";
 import __CommandPalette, { CommandPaletteProps } from "notes/components/CommandPalette";
 import __Toolbar from "notes/components/Toolbar";
-import range from "notes/range";
 
 import __ContextMenu, { ContextMenuProps } from "notes/components/ContextMenu";
 import __RenameNoteModal, { RenameNoteModalProps } from "notes/components/modals/RenameNoteModal";
@@ -44,14 +44,14 @@ import {
 import sendMessage from "shared/messages/send";
 
 import { getActiveFromUrl, getFocusOverride, isOverview } from "notes/location";
-import Overview from "notes/overview/Overview";
 import getFirstAvailableNoteName from "notes/filters/get-first-available-note-name";
 import notesHistory from "notes/history";
 import keyboardShortcuts, { KeyboardShortcut } from "notes/keyboard-shortcuts";
-import { useKeyboardShortcut } from "notes/hooks/use-keyboard-shortcut";
+import { useKeyboardShortcut } from "notes/components/hooks/use-keyboard-shortcut";
 import {
   Command, toggleSidebar, toggleToolbar, toggleFocusMode,
 } from "notes/commands";
+import range from "notes/range";
 import { exportNote } from "notes/export";
 import { notesToSidebarNotes } from "notes/adapters";
 

src/notes/adapters/__tests__/index.test.ts

@@ -1,98 +1,72 @@
-import { NotesObject, NotesOrder } from "shared/storage/schema";
-import { notesToSidebarNotes } from "..";
+import { Note, NotesObject, NotesOrder } from "shared/storage/schema";
+import * as sortNotes from "notes/sort";
+import { notesToSidebarNotes, SidebarNote } from "..";
 
-describe("notesToSidebarNotes()", () => {
-  describe("unpinned notes only", () => {
-    it("returns notes in correct order", () => {
-      const notes: NotesObject = {
-        Todo: {
-          content: "my todo",
-          createdTime: "CT-TODO",
-          modifiedTime: "MT-TODO",
-        },
-        Article: {
-          content: "my article",
-          createdTime: "CT-ARTICLE",
-          modifiedTime: "MT-ARTICLE",
-        },
-        Shopping: {
-          content: "my shopping",
-          createdTime: "CT-SHOPPING",
-          modifiedTime: "MT-SHOPPING",
-        },
-      };
-
-      const sidebarNotes = notesToSidebarNotes(notes, NotesOrder.Alphabetical);
-      expect(sidebarNotes).toEqual([
-        { name: "Article", ...notes.Article },
-        { name: "Shopping", ...notes.Shopping },
-        { name: "Todo", ...notes.Todo },
-      ]);
-    });
-  });
+const notRelevant: Pick<Note, "createdTime" | "modifiedTime"> = {
+  createdTime: "",
+  modifiedTime: "",
+};
 
-  describe("pinned and unpinned notes", () => {
-    it("returns notes in correct order", () => {
-      const notes: NotesObject = {
-        Todo: {
-          content: "my todo",
-          createdTime: "CT-TODO",
-          modifiedTime: "MT-3",
-        },
-        Shopping: {
-          content: "my shopping",
-          createdTime: "CT-SHOPPING",
-          modifiedTime: "MT-9",
-          pinnedTime: "PT-SHOPPING",
-        },
-        Article: {
-          content: "my article",
-          createdTime: "CT-ARTICLE",
-          modifiedTime: "MT-2",
-        },
-        Clipboard: {
-          content: "my clipboard",
-          createdTime: "CT-CLIPBOARD",
-          modifiedTime: "MT-8",
-          pinnedTime: "PT-CLIPBOARD",
-        },
-      };
+const notes: NotesObject = {
+  Todo: {
+    content: "my todo",
+    ...notRelevant,
+  },
+  Shopping: {
+    content: "my shopping",
+    ...notRelevant,
+    pinnedTime: "PT-2",
+  },
+  Article: {
+    content: "my article",
+    ...notRelevant,
+  },
+  Clipboard: {
+    content: "my clipboard",
+    ...notRelevant,
+    pinnedTime: "PT-1",
+  },
+};
 
-      const sidebarNotes = notesToSidebarNotes(notes, NotesOrder.Alphabetical);
-      expect(sidebarNotes).toEqual([
-        { name: "Clipboard", ...notes.Clipboard },
-        { name: "Shopping", ...notes.Shopping },
-
-        { name: "Article", ...notes.Article },
-        { name: "Todo", ...notes.Todo },
-      ]);
+describe("notesToSidebarNotes()", () => {
+  it("returns notes in correct order", () => {
+    const sidebarNotes = notesToSidebarNotes(notes, NotesOrder.Alphabetical);
+    expect(sidebarNotes).toEqual([
+      { name: "Clipboard", ...notes.Clipboard },
+      { name: "Shopping", ...notes.Shopping },
 
-      const sidebarNotes2 = notesToSidebarNotes(notes, NotesOrder.NewestFirst);
-      expect(sidebarNotes2).toEqual([
-        { name: "Shopping", ...notes.Shopping },
-        { name: "Clipboard", ...notes.Clipboard },
+      { name: "Article", ...notes.Article },
+      { name: "Todo", ...notes.Todo },
+    ]);
+  });
 
-        { name: "Todo", ...notes.Todo },
-        { name: "Article", ...notes.Article },
-      ]);
+  describe("dependency on sortNotes()", () => {
+    const expectedNotesArgument: SidebarNote[] = [
+      { name: "Todo", ...notes.Todo },
+      { name: "Shopping", ...notes.Shopping },
+      { name: "Article", ...notes.Article },
+      { name: "Clipboard", ...notes.Clipboard },
+    ];
 
-      const sidebarNotes3 = notesToSidebarNotes(notes, NotesOrder.Custom, ["Shopping", "Article"]);
-      expect(sidebarNotes3).toEqual([
-        { name: "Clipboard", ...notes.Clipboard },
-        { name: "Shopping", ...notes.Shopping },
+    const dummyReturn: SidebarNote[] = [{
+      name: "dummy", ...notes.Todo,
+    }];
 
-        { name: "Todo", ...notes.Todo },
-        { name: "Article", ...notes.Article },
-      ]);
+    it("calls sortNotes() with correct arguments", () => {
+      const spy = jest.spyOn(sortNotes, "default").mockReturnValue(dummyReturn);
 
-      const sidebarNotes4 = notesToSidebarNotes(notes, NotesOrder.Custom, []);
-      expect(sidebarNotes4).toEqual([
-        { name: "Shopping", ...notes.Shopping },
-        { name: "Clipboard", ...notes.Clipboard },
+      const scenarios: Array<[NotesObject, NotesOrder, string[] | undefined]> = [
+        [notes, NotesOrder.Alphabetical, undefined],
+        [notes, NotesOrder.LatestCreated, undefined],
+        [notes, NotesOrder.LatestModified, undefined],
+        [notes, NotesOrder.Custom, ["Shopping", "Article"]],
+      ];
 
-        { name: "Todo", ...notes.Todo },
-        { name: "Article", ...notes.Article },
-      ]);
+      scenarios.forEach((scenario) => {
+        const returnValue = notesToSidebarNotes(...scenario);
+        expect(spy).toHaveBeenCalledWith(expectedNotesArgument, scenario[1], scenario[2]);
+        expect(returnValue).toEqual(dummyReturn);
+      });
     });
   });
 });

src/notes/components/CommandPalette.tsx

@@ -3,7 +3,7 @@ import {
   useRef, useState, useEffect, useMemo,
 } from "preact/hooks";
 import clsx from "clsx";
-import useBodyClass from "notes/hooks/use-body-class";
+import useBodyClass from "notes/components/hooks/use-body-class";
 import { t, tString } from "i18n";
 import {
   Command, commands as contentCommands, toggleSidebar, toggleToolbar,

src/notes/components/Overlay.tsx

@@ -1,5 +1,5 @@
 import { h } from "preact";
-import useBodyClass from "notes/hooks/use-body-class";
+import useBodyClass from "notes/components/hooks/use-body-class";
 
 interface OverlayProps {
   type: "to-rename" | "to-delete" | "to-create"

src/notes/overview/Overview.tsx renamed to src/notes/components/Overview.tsx

@@ -7,7 +7,7 @@ import { SidebarNote } from "notes/adapters";
 import clsx from "clsx";
 import SVG from "notes/components/SVG";
 import LockSvgText from "svg/lock.svg";
-import { useKeyboardShortcut, KeyboardShortcut } from "notes/hooks/use-keyboard-shortcut";
+import { useKeyboardShortcut, KeyboardShortcut } from "notes/components/hooks/use-keyboard-shortcut";
 import sendMessage from "shared/messages/send";
 
 export interface SidebarNotesProps {

src/notes/components/SidebarNotes.tsx

@@ -2,7 +2,7 @@ import { h } from "preact";
 import { useCallback, useEffect, useRef } from "preact/hooks";
 import runUploadPreconditions from "background/google-drive/preconditions/run-upload-preconditions";
 import { KeyboardShortcut } from "notes/keyboard-shortcuts";
-import { useKeyboardShortcut } from "notes/hooks/use-keyboard-shortcut";
+import { useKeyboardShortcut } from "notes/components/hooks/use-keyboard-shortcut";
 import __range from "notes/range";
 import { insideListItem } from "notes/content/list";
 import { reinitTables } from "notes/content/table";

src/notes/components/content/ContentHtml.tsx

@@ -1,7 +1,7 @@
 import { h } from "preact";
 import { useCallback, useEffect, useRef } from "preact/hooks";
 import { KeyboardShortcut } from "notes/keyboard-shortcuts";
-import { useKeyboardShortcut } from "notes/hooks/use-keyboard-shortcut";
+import { useKeyboardShortcut } from "notes/components/hooks/use-keyboard-shortcut";
 import { InsertTabFactory } from "../../commands";
 import { ContentProps, reattachEditNote } from "./common";
 

src/notes/components/content/ContentText.tsx

@@ -3,8 +3,8 @@ import {
   useRef, useState, useEffect, useMemo, useCallback,
 } from "preact/hooks";
 import clsx from "clsx";
-import useBodyClass from "notes/hooks/use-body-class";
-import { useKeyboardShortcut, KeyboardShortcut } from "notes/hooks/use-keyboard-shortcut";
+import useBodyClass from "notes/components/hooks/use-body-class";
+import { useKeyboardShortcut, KeyboardShortcut } from "notes/components/hooks/use-keyboard-shortcut";
 
 interface ModalProps {
   className?: string

src/notes/hooks/use-body-class.ts renamed to src/notes/components/hooks/use-body-class.ts

@@ -6,26 +6,29 @@ const notes: SidebarNote[] = [
   {
     name: "Clipboard",
     content: "my todo",
-    createdTime: "CT1",
-    modifiedTime: "MT4",
-  },
-  {
-    name: "Todo",
-    content: "my todo",
-    createdTime: "CT2",
-    modifiedTime: "MT8",
+    createdTime: "CT-1",
+    modifiedTime: "MT-4",
+    pinnedTime: "PT-2",
   },
   {
     name: "Article",
     content: "my article",
-    createdTime: "CT4",
-    modifiedTime: "MT3",
+    createdTime: "CT-4",
+    modifiedTime: "MT-3",
+  },
+  {
+    name: "Todo",
+    content: "my todo",
+    createdTime: "CT-2",
+    modifiedTime: "MT-8",
+    pinnedTime: "PT-1",
   },
+
   {
     name: "Shopping",
     content: "my shopping",
-    createdTime: "CT3",
-    modifiedTime: "MT7",
+    createdTime: "CT-3",
+    modifiedTime: "MT-7",
   },
 ];
 
@@ -34,30 +37,46 @@ const nameMap = (item: SidebarNote) => item.name;
 test("sortNotes() sorts notes in Alphabetical order", () => {
   expect(
     sortNotes(notes, NotesOrder.Alphabetical).map(nameMap),
-  ).toEqual(["Article", "Clipboard", "Shopping", "Todo"]);
+  ).toEqual([
+    "Clipboard", "Todo",
+    "Article", "Shopping",
+  ]);
 });
 
-test("sortNotes() sorts notes in NewestFirst order", () => {
+test("sortNotes() sorts notes in LatestCreated order", () => {
   expect(
-    sortNotes(notes, NotesOrder.NewestFirst).map(nameMap),
-  ).toEqual(["Todo", "Shopping", "Clipboard", "Article"]);
+    sortNotes(notes, NotesOrder.LatestCreated).map(nameMap),
+  ).toEqual([
+    "Todo", "Clipboard",
+    "Article", "Shopping",
+  ]);
 });
 
-test("sortNotes() sorts notes in Custom order", () => {
-  const custom = ["Article", "Todo", "Clipboard", "Shopping"];
+test("sortNotes() sorts notes in LatestModified order", () => {
   expect(
-    sortNotes(notes, NotesOrder.Custom, custom).map(nameMap),
-  ).toEqual(custom);
+    sortNotes(notes, NotesOrder.LatestModified).map(nameMap),
+  ).toEqual([
+    "Todo", "Clipboard",
+    "Shopping", "Article",
+  ]);
 });
 
-test("sortNotes() returns original order when custom order is not provided", () => {
-  const original = notes.map(nameMap);
-
+test("sortNotes() sorts notes in Custom order", () => {
   expect(
-    sortNotes(notes, NotesOrder.Custom).map(nameMap), // "custom" is not provided
-  ).toEqual(original);
+    sortNotes(notes, NotesOrder.Custom, ["Article", "Todo", "Clipboard", "Shopping"]).map(nameMap),
+  ).toEqual([
+    "Todo", "Clipboard",
+    "Article", "Shopping",
+  ]);
+});
 
-  expect(
-    sortNotes(notes, NotesOrder.Custom, []).map(nameMap), // "custom" is empty
-  ).toEqual(original);
+test("sortNotes() only groups by pinned and unpinned when no order is provided", () => {
+  [undefined, []].forEach((order) => {
+    expect(
+      sortNotes(notes, NotesOrder.Custom, order).map(nameMap),
+    ).toEqual([
+      "Clipboard", "Todo",
+      "Article", "Shopping",
+    ]);
+  });
 });