Merge pull request #36 from ut-code/class-data-format

旧シ楽バス用の講義情報.jsonを新シ楽バス用へ変換するスクリプトを作りました。

Author: Axafy5479

.gitignore

@@ -18,6 +18,7 @@ bun.lockb
 
 # production
 /build
+/class_data/build
 
 # misc
 .DS_Store

class_data/data/new/2024A.json

@@ -0,0 +1,51 @@
+import { PreviousClassData } from "./previousClassDaya";
+import fs from "fs";
+import { argv } from "node:process";
+import { NewClassData } from "./newClass";
+
+/**
+ * 変換処理本体
+ */
+function main() {
+  /************ コマンドライン引数のチェック ************/
+  if (argv.length != 4) {
+    throw "パラメーター数が異常です。\n例: npm run start -- 2024 A\n";
+  }
+
+  if (argv[2].length < 4) {
+    throw "年度は西暦で表現してください。\n例: npm run start -- 2024 A\n";
+  }
+
+  if (argv[3] != "S" && argv[3] != "A") {
+    throw "セメスターはSまたはAで表現してください。\n例: npm run start -- 2024 A\n";
+  }
+  const semester = argv[3];
+  const year = Number(argv[2]);
+  if (Number.isNaN(year)) {
+    throw "年度は数字で表現してください。\n例: npm run start -- 2024 A\n";
+  }
+  /****************************************************/
+
+  // 入力ファイルのパス
+  const inputFilepath = `./data/old/${year}${semester}.json`;
+
+  // 出力ファイルのパス
+  const outputFilepath = `./data/new/${year}${semester}.json`;
+
+  // ファイルの読み取り
+  if (!fs.existsSync(inputFilepath)) {
+    throw "ファイルが見つかりませんでした。\n" + inputFilepath + "\n";
+  }
+  const inputData: string = fs.readFileSync(inputFilepath, "utf8");
+
+  // PreviousClassTypeの配列にパース
+  const prevClassData: PreviousClassData[] = JSON.parse(inputData);
+
+  // データを変換
+  const converted = prevClassData.map((c) => new NewClassData(c));
+
+  // ファイル出力
+  fs.writeFileSync(outputFilepath, JSON.stringify(converted, null, 2));
+}
+
+main();

class_data/data/old/2024A.json

@@ -0,0 +1,63 @@
+import { PreviousClassData } from "./previousClassDaya";
+import { dayMappingToEn, DayPeriod } from "./type";
+
+/**
+ * 新シ楽バス仕様の講義情報クラス
+ * 構造はほとんど同様なのでPreviousClassTypeを継承する
+ */
+export class NewClassData extends PreviousClassData {
+  /**
+   * 旧シ楽バスのデータをもとにインスタンス化する
+   * @param prevClass 旧シ楽バスのデータ
+   */
+  constructor(prevClass: PreviousClassData) {
+    super();
+    /********* プロパティのコピー *********/
+    Object.assign(this, prevClass);
+
+    /********* 新仕様特有のプロパティ *********/
+    if (!prevClass.periods) throw "入力データのperiodsがundefinedです";
+    this.dayPeriod = this.toDayPeriod(prevClass.periods);
+    this.periods = undefined;
+
+    if (!prevClass.lecturerJp) throw "入力データのlecturerJpがundefinedです";
+    this.lecturer = prevClass.lecturerJp;
+    this.lecturerJp = undefined;
+  }
+
+  /**
+   * 現行シ楽バスの曜限表現を新シラバス仕様に変換する
+   * @param dayPeriodStrs 旧シラバスの曜限表現
+   * @returns 新シラバスの曜限表現
+   */
+  private toDayPeriod(dayPeriodStrs: string[]): DayPeriod[] | "集中" {
+    // 集中講義ならそのまま"集中"を返す
+    if (dayPeriodStrs.indexOf("集中") != -1) return "集中";
+
+    // 授業は複数コマ開講されることがあるため、
+    // 各曜限を新シラバス仕様に変換
+    return dayPeriodStrs.map((dayStr) => {
+      // dayStrは必ず2文字
+      const day: string = dayStr[0];
+      const period = Number(dayStr[1]);
+
+      // 新フォーマットを返す
+      return {
+        day: dayMappingToEn[day],
+        period: period,
+      };
+    });
+  }
+
+  /********* 新仕様特有のプロパティ *********/
+
+  /**
+   * 開講曜限
+   */
+  dayPeriod: DayPeriod[] | "集中";
+
+  /**
+   * 教授名(Ja)
+   */
+  lecturer: string;
+}

class_data/index.ts

@@ -0,0 +1,13 @@
+{
+  "name": "class_data",
+  "version": "1.0.0",
+  "description": "",
+  "main": "data_converter.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "tsc -p . && node ./build/"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC"
+}

class_data/newClass.ts

@@ -0,0 +1,46 @@
+/**
+ * 現行のシ楽バス(v1)のスクレイピング結果(json)の型
+ * 情報のフィールドを並べているだけ
+ */
+export class PreviousClassData {
+  code?: string;
+  type?: "基礎" | "総合" | "要求" | "主題" | "展開";
+  category?: string;
+  semester?: "S" | "S1" | "S2" | "A" | "A1" | "A2";
+  periods?: string[];
+  classroom?: string;
+  titleJp?: string;
+  lecturerJp?: string;
+  titleEn?: string;
+  lecturerEn?: string;
+  ccCode?: string;
+  credits?: number;
+  detail?: string;
+  schedule?: string;
+  methods?: string;
+  evaluation?: string;
+  notes?: string;
+  class?: string;
+  guidance?: string;
+  guidanceDate?: string;
+  guidancePeriod?: string;
+  guidancePlace?: string;
+  time?: number;
+  timeCompensation?: string;
+  targetClass?: string[][];
+  importance?: ("l1" | "l2" | "l3" | "s1" | "s2" | "s3")[][];
+  shortenedCategory?:
+    | "基礎"
+    | "要求"
+    | "主題"
+    | "展開"
+    | "総合L"
+    | "総合A"
+    | "総合B"
+    | "総合C"
+    | "総合D"
+    | "総合E"
+    | "総合F";
+  shortenedEvaluation?: string;
+  shortenedClassroom?: string;
+}

class_data/package.json

@@ -0,0 +1,10 @@
+## 概要
+
+現行のシ楽バスのためのスクレイピング結果を、シ楽バスnextで利用できる型に変換するスクリプトです。
+
+## 利用方法
+
+1. class_data ディレクトリに移動します。
+1. 変換元のファイル名を`yyyyX.json`(`yyyy`:年度、`X`:セメスター)に変更し(例:2024A.json)、data/old/ に配置します。
+1. `npm run start -- yyyy X` (`yyyy`:年度、`X`:セメスター)
+1. data/new/ に同名のjsonファイルが生成されます。

class_data/previousClassDaya.ts

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "es2016",
+    "module": "commonjs",
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "outDir": "build",
+    "rootDir": "./"
+  }
+}

class_data/readme.md

@@ -0,0 +1,24 @@
+/**
+ * 新シ楽バスで利用する曜限(集中以外)の型
+ */
+export type DayPeriod = {
+  day: Day;
+  period: number;
+};
+
+/**
+ * 曜日の列挙
+ */
+export type Day = "mon" | "tue" | "wed" | "thu" | "fri" | "sat";
+
+/**
+ * 曜日の、日本語から英語への変換
+ */
+export const dayMappingToEn: { [key in string]: Day } = {
+  月: "mon",
+  火: "tue",
+  水: "wed",
+  木: "thu",
+  金: "fri",
+  土: "sat",
+};