指定したコードブロックを書き換えられるようにした

MijinkoSD · MijinkoSD · commit 03240adad961 · 2023-02-15T01:41:13.000+09:00
diff --git a/browser/websocket/_codeBlock.ts b/browser/websocket/_codeBlock.ts
@@ -4,30 +4,70 @@ import { getProjectId, getUserId } from "./id.ts";
 import { pushWithRetry } from "./_fetch.ts";
 import { TinyCodeBlock } from "./getCodeBlocks.ts";
 
+/** コードブロックのタイトル行の情報を保持しておくためのinterface */
+export interface CodeTitle {
+  filename: string;
+  lang: string;
+  indent: number;
+}
+
 /** コミットを送信する一連の処理 */
 export async function applyCommit(
   commits: Change[],
   head: HeadData,
   projectName: string,
   pageTitle: string,
   socket: Socket,
+  userId?: string,
 ): ReturnType<typeof pushWithRetry> {
-  const [projectId, userId] = await Promise.all([
+  const [projectId, userId_] = await Promise.all([
     getProjectId(projectName),
-    getUserId(),
+    userId ?? getUserId(),
   ]);
   const { request } = wrap(socket);
   return await pushWithRetry(request, commits, {
     parentId: head.commitId,
     projectId: projectId,
     pageId: head.pageId,
-    userId: userId,
+    userId: userId_,
     project: projectName,
     title: pageTitle,
     retry: 3,
   });
 }
 
+/** コードブロックのタイトル行から各種プロパティを抽出する
+ *
+ * @param lineText {string} 行テキスト
+ * @return `lineText`がコードタイトル行であれば`CodeTitle`を、そうでなければ`null`を返す
+ */
+export function 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">,
diff --git a/browser/websocket/getCodeBlocks.ts b/browser/websocket/getCodeBlocks.ts
@@ -1,5 +1,6 @@
 import type { Line } from "../../deps/scrapbox-rest.ts";
 import { pull } from "./pull.ts";
+import { CodeTitle, extractFromCodeTitle } from "./_codeBlock.ts";
 
 /** pull()から取れる情報で構成したコードブロックの最低限の情報 */
 export interface TinyCodeBlock {
@@ -30,13 +31,6 @@ export interface GetCodeBlocksFilter {
   lang?: string;
 }
 
-/** コードブロックのタイトル行の情報を保持しておくためのinterface */
-interface CodeTitle {
-  fileName: string;
-  lang: string;
-  indent: number;
-}
-
 /** 他のページ（または取得済みの行データ）のコードブロックを全て取得する
  *
  * ファイル単位ではなく、コードブロック単位で返り値を生成する \
@@ -61,7 +55,7 @@ export const getCodeBlocks = async (
   } = {
     isCodeBlock: false,
     isCollect: false,
-    fileName: "",
+    filename: "",
     lang: "",
     indent: 0,
   };
@@ -87,7 +81,7 @@ export const getCodeBlocks = async (
       currentCode = { isCodeBlock: true, isCollect: isCollect, ...matched };
       if (!currentCode.isCollect) continue;
       codeBlocks.push({
-        filename: currentCode.fileName,
+        filename: currentCode.filename,
         lang: currentCode.lang,
         titleLine: line,
         bodyLines: [],
@@ -114,44 +108,12 @@ async function getLines(
   }
 }
 
-/** コードブロックのタイトル行から各種プロパティを抽出する
- *
- * @param lineText {string} 行テキスト
- * @return `lineText`がコードタイトル行であれば`CodeTitle`を、そうでなければ`null`を返す
- */
-function 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].slice(1, -1).trim();
-    }
-  } else {
-    lang = matched[3];
-  }
-  return {
-    fileName: fileName,
-    lang: lang,
-    indent: matched[1].length,
-  };
-}
-
 /** コードタイトルのフィルターを検証する */
 function isMatchFilter(
   codeTitle: CodeTitle,
   filter?: GetCodeBlocksFilter,
 ): boolean {
-  if (filter?.filename && filter.filename !== codeTitle.fileName) return false;
+  if (filter?.filename && filter.filename !== codeTitle.filename) return false;
   if (filter?.lang && filter.lang !== codeTitle.lang) return false;
   return true;
 }
diff --git a/browser/websocket/updateCodeBlock.ts b/browser/websocket/updateCodeBlock.ts
@@ -0,0 +1,156 @@
+import { Line } from "../../deps/scrapbox-rest.ts";
+import {
+  DeleteCommit,
+  InsertCommit,
+  Socket,
+  socketIO,
+  UpdateCommit,
+} from "../../deps/socket.ts";
+import { diffToChanges } from "./diffToChanges.ts";
+import { TinyCodeBlock } from "./getCodeBlocks.ts";
+import { getUserId } from "./id.ts";
+import { pull } from "./pull.ts";
+import { CodeFile, isCodeFile } from "./updateCodeFile.ts";
+import {
+  applyCommit,
+  countBodyIndent,
+  extractFromCodeTitle,
+} from "./_codeBlock.ts";
+
+export interface UpdateCodeBlockOptions {
+  /** WebSocketの通信に使うsocket */
+  socket?: Socket;
+
+  /** `true`でデバッグ出力ON */
+  debug?: boolean;
+}
+
+/** コードブロックの中身を更新する
+ *
+ * @param newCode 更新後のコードブロック
+ * @param target 更新対象のコードブロック
+ * @param project 更新対象のコードブロックが存在するプロジェクト名
+ */
+export const updateCodeBlock = async (
+  newCode: string | string[] | CodeFile,
+  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 (isCodeFile(newCode)) {
+    const titleCommit = makeTitleChangeCommit(newCode, target);
+    if (titleCommit) commits.push(titleCommit);
+  }
+
+  if (opt.debug) {
+    console.log("vvv original code block vvv");
+    console.log(target);
+    console.log("vvv new codes vvv");
+    console.log(newCode);
+    console.log("vvv commits vvv");
+    console.log(commits);
+  }
+
+  await applyCommit(commits, head, projectName, pageTitle, opt.socket, userId);
+  if (!options?.socket) opt.socket.disconnect();
+};
+
+function getCodeBody(code: string | string[] | CodeFile): string[] {
+  const content = isCodeFile(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,
+        },
+      };
+    }
+  }
+}
+
+/** コードタイトルが違う場合は書き換える */
+function makeTitleChangeCommit(
+  code: CodeFile,
+  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,
+    },
+  };
+}
diff --git a/browser/websocket/updateCodeFile.ts b/browser/websocket/updateCodeFile.ts
@@ -45,6 +45,20 @@ export interface UpdateCodeFileOptions {
   debug?: boolean;
 }
 
+/** objectがCodeFile型かどうかを判別する */
+export function isCodeFile(obj: unknown): obj is CodeFile {
+  if (Array.isArray(obj) || !(obj instanceof Object)) return false;
+  const code = obj as CodeFile;
+  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)
+  );
+}
+
 /** REST API経由で取得できるようなコードファイルの中身をまるごと書き換える
  *
  * ファイルが存在していなかった場合、既定では何も書き換えない \
