Merge pull request #108 from MijinkoSD/set-codeblock

コードブロックの取得、および上書きを行う関数の追加

Author: takker99

browser/websocket/__snapshots__/_codeBlock.test.ts.snap

@@ -0,0 +1,57 @@
+export const snapshot = {};
+
+snapshot[`extractFromCodeTitle() > accurate titles > "code:foo.extA(extB)" 1`] = `
+{
+  filename: "foo.extA",
+  indent: 0,
+  lang: "extB",
+}
+`;
+
+snapshot[`extractFromCodeTitle() > accurate titles > " code:foo.extA(extB)" 1`] = `
+{
+  filename: "foo.extA",
+  indent: 1,
+  lang: "extB",
+}
+`;
+
+snapshot[`extractFromCodeTitle() > accurate titles > "  code: foo.extA (extB)" 1`] = `
+{
+  filename: "foo.extA",
+  indent: 2,
+  lang: "extB",
+}
+`;
+
+snapshot[`extractFromCodeTitle() > accurate titles > "  code: foo (extB) " 1`] = `
+{
+  filename: "foo",
+  indent: 2,
+  lang: "extB",
+}
+`;
+
+snapshot[`extractFromCodeTitle() > accurate titles > "  code: foo.extA " 1`] = `
+{
+  filename: "foo.extA",
+  indent: 2,
+  lang: "extA",
+}
+`;
+
+snapshot[`extractFromCodeTitle() > accurate titles > "  code: foo " 1`] = `
+{
+  filename: "foo",
+  indent: 2,
+  lang: "foo",
+}
+`;
+
+snapshot[`extractFromCodeTitle() > accurate titles > "  code: .foo " 1`] = `
+{
+  filename: ".foo",
+  indent: 2,
+  lang: ".foo",
+}
+`;

browser/websocket/_codeBlock.test.ts

@@ -0,0 +1,36 @@
+/// <reference lib="deno.ns" />
+
+import { assertEquals, assertSnapshot } from "../../deps/testing.ts";
+import { extractFromCodeTitle } from "./_codeBlock.ts";
+
+Deno.test("extractFromCodeTitle()", async (t) => {
+  await t.step("accurate titles", async (st) => {
+    const titles = [
+      "code:foo.extA(extB)",
+      " code:foo.extA(extB)",
+      "  code: foo.extA (extB)",
+      "  code: foo (extB) ",
+      "  code: foo.extA ",
+      "  code: foo ",
+      "  code: .foo ",
+    ];
+    for (const title of titles) {
+      await st.step(`"${title}"`, async (sst) => {
+        await assertSnapshot(sst, extractFromCodeTitle(title));
+      });
+    }
+  });
+
+  await t.step("inaccurate titles", async (st) => {
+    const nonTitles = [
+      "  code: foo. ", // コードブロックにはならないので`null`が正常
+      "any:code: foo ",
+      " I'm not code block ",
+    ];
+    for (const title of nonTitles) {
+      await st.step(`"${title}"`, async () => {
+        await assertEquals(null, extractFromCodeTitle(title));
+      });
+    }
+  });
+});

browser/websocket/_codeBlock.ts

@@ -0,0 +1,77 @@
+import { Change, Socket, wrap } from "../../deps/socket.ts";
+import { TinyCodeBlock } from "../../rest/getCodeBlocks.ts";
+import { HeadData } from "./pull.ts";
+import { getProjectId, getUserId } from "./id.ts";
+import { pushWithRetry } from "./_fetch.ts";
+
+/** コードブロックのタイトル行の情報を保持しておくためのinterface */
+export interface CodeTitle {
+  filename: string;
+  lang: string;
+  indent: number;
+}
+
+/** コミットを送信する一連の処理 */
+export const applyCommit = async (
+  commits: Change[],
+  head: HeadData,
+  projectName: string,
+  pageTitle: string,
+  socket: Socket,
+  userId?: string,
+): ReturnType<typeof pushWithRetry> => {
+  const [projectId, userId_] = await Promise.all([
+    getProjectId(projectName),
+    userId ?? getUserId(),
+  ]);
+  const { request } = wrap(socket);
+  return await pushWithRetry(request, commits, {
+    parentId: head.commitId,
+    projectId: projectId,
+    pageId: head.pageId,
+    userId: userId_,
+    project: projectName,
+    title: pageTitle,
+    retry: 3,
+  });
+};
+
+/** コードブロックのタイトル行から各種プロパティを抽出する
+ *
+ * @param lineText {string} 行テキスト
+ * @return `lineText`がコードタイトル行であれば`CodeTitle`を、そうでなければ`null`を返す
+ */
+export const extractFromCodeTitle = (lineText: string): CodeTitle | null => {
+  const matched = lineText.match(/^(\s*)code:(.+?)(\(.+\)){0,1}\s*$/);
+  if (matched === null) return null;
+  const filename = matched[2].trim();
+  let lang = "";
+  if (matched[3] === undefined) {
+    const ext = filename.match(/.+\.(.*)$/);
+    if (ext === null) {
+      // `code:ext`
+      lang = filename;
+    } else if (ext[1] === "") {
+      // `code:foo.`の形式はコードブロックとして成り立たないので排除する
+      return null;
+    } else {
+      // `code:foo.ext`
+      lang = ext[1].trim();
+    }
+  } else {
+    lang = matched[3].slice(1, -1);
+  }
+  return {
+    filename: filename,
+    lang: lang,
+    indent: matched[1].length,
+  };
+};
+
+/** コードブロック本文のインデント数を計算する */
+export function countBodyIndent(
+  codeBlock: Pick<TinyCodeBlock, "titleLine">,
+): number {
+  return codeBlock.titleLine.text.length -
+    codeBlock.titleLine.text.trimStart().length + 1;
+}

browser/websocket/isSimpleCodeFile.test.ts

@@ -0,0 +1,28 @@
+import { assert, assertFalse } from "../../deps/testing.ts";
+import { isSimpleCodeFile } from "./isSimpleCodeFile.ts";
+import { SimpleCodeFile } from "./updateCodeFile.ts";
+
+const codeFile: SimpleCodeFile = {
+  filename: "filename",
+  content: ["line 0", "line 1"],
+  lang: "language",
+};
+
+Deno.test("isSimpleCodeFile()", async (t) => {
+  await t.step("SimpleCodeFile object", () => {
+    assert(isSimpleCodeFile(codeFile));
+    assert(isSimpleCodeFile({ ...codeFile, content: "line 0" }));
+    assert(isSimpleCodeFile({ ...codeFile, lang: undefined }));
+  });
+  await t.step("similer objects", () => {
+    assertFalse(isSimpleCodeFile({ ...codeFile, filename: 10 }));
+    assertFalse(isSimpleCodeFile({ ...codeFile, content: 10 }));
+    assertFalse(isSimpleCodeFile({ ...codeFile, content: [0, 1] }));
+    assertFalse(isSimpleCodeFile({ ...codeFile, lang: 10 }));
+  });
+  await t.step("other type values", () => {
+    assertFalse(isSimpleCodeFile(10));
+    assertFalse(isSimpleCodeFile(undefined));
+    assertFalse(isSimpleCodeFile(["0", "1", "2"]));
+  });
+});

browser/websocket/isSimpleCodeFile.ts

@@ -0,0 +1,15 @@
+import { SimpleCodeFile } from "./updateCodeFile.ts";
+
+/** objectがSimpleCodeFile型かどうかを判別する */
+export function isSimpleCodeFile(obj: unknown): obj is SimpleCodeFile {
+  if (Array.isArray(obj) || !(obj instanceof Object)) return false;
+  const code = obj as SimpleCodeFile;
+  const { filename, content, lang } = code;
+  return (
+    typeof filename == "string" &&
+    (typeof content == "string" ||
+      (Array.isArray(content) &&
+        (content.length == 0 || typeof content[0] == "string"))) &&
+    (typeof lang == "string" || lang === undefined)
+  );
+}

browser/websocket/mod.ts

@@ -3,3 +3,5 @@ export * from "./patch.ts";
 export * from "./deletePage.ts";
 export * from "./pin.ts";
 export * from "./listen.ts";
+export * from "./updateCodeBlock.ts";
+export * from "./updateCodeFile.ts";

browser/websocket/updateCodeBlock.ts

@@ -0,0 +1,161 @@
+import { Line } from "../../deps/scrapbox-rest.ts";
+import {
+  DeleteCommit,
+  InsertCommit,
+  Socket,
+  socketIO,
+  UpdateCommit,
+} from "../../deps/socket.ts";
+import { TinyCodeBlock } from "../../rest/getCodeBlocks.ts";
+import { diffToChanges } from "./diffToChanges.ts";
+import { getUserId } from "./id.ts";
+import { isSimpleCodeFile } from "./isSimpleCodeFile.ts";
+import { pull } from "./pull.ts";
+import { SimpleCodeFile } from "./updateCodeFile.ts";
+import {
+  applyCommit,
+  countBodyIndent,
+  extractFromCodeTitle,
+} from "./_codeBlock.ts";
+
+export interface UpdateCodeBlockOptions {
+  /** WebSocketの通信に使うsocket */
+  socket?: Socket;
+
+  /** `true`でデバッグ出力ON */
+  debug?: boolean;
+}
+
+/** コードブロックの中身を更新する
+ *
+ * newCodeにSimpleCodeFileオブジェクトを渡すと、そのオブジェクトに添ってコードブロックのファイル名も書き換えます
+ * （文字列や文字列配列を渡した場合は書き換えません）。
+ *
+ * @param newCode 更新後のコードブロック
+ * @param target 更新対象のコードブロック
+ * @param project 更新対象のコードブロックが存在するプロジェクト名
+ */
+export const updateCodeBlock = async (
+  newCode: string | string[] | SimpleCodeFile,
+  target: TinyCodeBlock,
+  options?: UpdateCodeBlockOptions,
+) => {
+  /** optionsの既定値はこの中に入れる */
+  const defaultOptions: Required<UpdateCodeBlockOptions> = {
+    socket: options?.socket ?? await socketIO(),
+    debug: false,
+  };
+  const opt = options ? { ...defaultOptions, ...options } : defaultOptions;
+  const { projectName, pageTitle } = target.pageInfo;
+  const [
+    head,
+    userId,
+  ] = await Promise.all([
+    pull(projectName, pageTitle),
+    getUserId(),
+  ]);
+  const newCodeBody = getCodeBody(newCode);
+  const bodyIndent = countBodyIndent(target);
+  const oldCodeWithoutIndent: Line[] = target.bodyLines.map((e) => {
+    return { ...e, text: e.text.slice(bodyIndent) };
+  });
+
+  const diffGenerator = diffToChanges(oldCodeWithoutIndent, newCodeBody, {
+    userId,
+  });
+  const commits = [...fixCommits([...diffGenerator], target)];
+  if (isSimpleCodeFile(newCode)) {
+    const titleCommit = makeTitleChangeCommit(newCode, target);
+    if (titleCommit) commits.push(titleCommit);
+  }
+
+  if (opt.debug) {
+    console.log("%cvvv original code block vvv", "color: limegreen;");
+    console.log(target);
+    console.log("%cvvv new codes vvv", "color: limegreen;");
+    console.log(newCode);
+    console.log("%cvvv commits vvv", "color: limegreen;");
+    console.log(commits);
+  }
+
+  await applyCommit(commits, head, projectName, pageTitle, opt.socket, userId);
+  if (!options?.socket) opt.socket.disconnect();
+};
+
+/** コード本文のテキストを取得する */
+const getCodeBody = (code: string | string[] | SimpleCodeFile): string[] => {
+  const content = isSimpleCodeFile(code) ? code.content : code;
+  if (Array.isArray(content)) return content;
+  return content.split("\n");
+};
+
+/** insertコミットの行IDとtextのインデントを修正する */
+function* fixCommits(
+  commits: readonly (DeleteCommit | InsertCommit | UpdateCommit)[],
+  target: TinyCodeBlock,
+): Generator<DeleteCommit | InsertCommit | UpdateCommit, void, unknown> {
+  const { nextLine } = target;
+  const indent = " ".repeat(countBodyIndent(target));
+  for (const commit of commits) {
+    if ("_delete" in commit) {
+      yield commit;
+    } else if (
+      "_update" in commit
+    ) {
+      yield {
+        ...commit,
+        lines: {
+          ...commit.lines,
+          text: indent + commit.lines.text,
+        },
+      };
+    } else if (
+      commit._insert != "_end" ||
+      nextLine === null
+    ) {
+      yield {
+        ...commit,
+        lines: {
+          ...commit.lines,
+          text: indent + commit.lines.text,
+        },
+      };
+    } else {
+      yield {
+        _insert: nextLine.id,
+        lines: {
+          ...commit.lines,
+          text: indent + commit.lines.text,
+        },
+      };
+    }
+  }
+}
+
+/** コードタイトルが違う場合は書き換える */
+const makeTitleChangeCommit = (
+  code: SimpleCodeFile,
+  target: Pick<TinyCodeBlock, "titleLine">,
+): UpdateCommit | null => {
+  const lineId = target.titleLine.id;
+  const targetTitle = extractFromCodeTitle(target.titleLine.text);
+  if (
+    targetTitle &&
+    code.filename.trim() == targetTitle.filename &&
+    code.lang?.trim() == targetTitle.lang
+  ) return null;
+  const ext = (() => {
+    const matched = code.filename.match(/.+\.(.*)$/);
+    if (matched === null) return code.filename;
+    else if (matched[1] === "") return "";
+    else return matched[1].trim();
+  })();
+  const title = code.filename +
+    (code.lang && code.lang != ext ? `(${code.lang})` : "");
+  return {
+    _update: lineId,
+    lines: {
+      text: " ".repeat(countBodyIndent(target) - 1) + "code:" + title,
+    },
+  };
+};