[지하철 노선도 경로 조회 미션] 강민경 미션 제출합니다.

README.md

@@ -1 +1,199 @@
-# javascript-subway-final
+# 🚇 지하철 노선도 경로 조회 미션
+
+- 등록된 지하철 노선도에서 경로를 조회하는 기능을 구현한다.
+
+> 지하철 노선도 경로 조회 미션은 우아한 테크코스 프리코스 코딩테스트입니다.
+> 지하철 노선도 미션에서는 유저가 이미 등록된 지하철 역들을 통해 경로를 조회할 수 있습니다.
+
+## ✔️ 주어진 요구사항
+
+- [요구사항](#요구사항)
+- [기능요구사항](#기능-요구사항)
+- [프로그래밍 요구사항](#프로그래밍-요구사항)
+- [미션 저장소 및 진행 요구사항](#미션-저장소-및-진행-요구사항)
+
+## ✔️ 주어진 참고사항
+
+- [프로그램 실행 결과](#프로그램-실행-결과)
+- [최단 경로](#최단-경로-라이브러리)
+- [힌트](#힌트)
+
+## ✔️ 구현할 기능 목록
+
+### 전체
+
+- 필요한 데이터(역, 노선, 구간 데이터)를 초기 설정하는 기능
+  - [초기 설정](#초기-설정)을 참고
+- 유저로부터 지하철 출발역을 입력받는 기능
+- 유저로부터 지하철 도착역을 입력받는 기능
+
+  - 🚦 예외상황
+    - 유저가 존재하지 않는 역을 출발/도착역으로 입력했을 때
+    - 유저가 출발/도착역을 1글자 이하로 입력했을 때
+    - 유저가 출발/도착역을 같게 입력했을 ㄸ대
+    - 유저가 연결되지 않은 출발/도착역을 입력했을 때
+    - 유저가 앞뒤로 공백을 포함해 출발/도착역을 입력했을 때
+
+- 유저가 선택한 최단거리/최소시간 옵션을 받는 기능
+- 결과를 표로 보여주는 기능
+
+### 지하철 최단거리 관련 기능
+
+### 지하철 최소시간 관련 기능
+
+## 기능 요구사항
+
+> 프리코스 3주차 미션에서 사용한 코드를 참고해도 무관하다.
+
+### 초기 설정
+
+- 프로그램 시작 시 역, 노선, 구간 데이터를 초기 설정 해야 한다.
+- 거리와 소요 시간은 양의 정수이며 단위는 km와 분을 의미한다.
+- 아래의 사전 등록 정보로 반드시 초기 설정을 한다.
+
+```
+1. 지하철역으로 교대, 강남, 역삼, 남부터미널, 양재, 양재시민의숲, 매봉 역 정보가 등록되어 있다.
+2. 지하철 노선으로 2호선, 3호선, 신분당선이 등록되어 있다.
+3. 노선에 역이 아래와 같이 등록되어 있다.(왼쪽 끝이 상행 종점)
+    - 2호선: 교대 - ( 2km / 3분 ) - 강남 - ( 2km / 3분 ) - 역삼
+    - 3호선: 교대 - ( 3km / 2분 ) - 남부터미널 - ( 6km / 5분 ) - 양재 - ( 1km / 1분 ) - 매봉
+    - 신분당선: 강남 - ( 2km / 8분 ) - 양재 - ( 10km / 3분 ) - 양재시민의숲
+```
+
+### 경로 조회 기능
+
+<img src="/images/path_result.jpg" width="100%">
+
+- 출발역과 도착역을 입력받아 경로를 조회한다.
+- 경로 조회 시 총 거리, 총 소요 시간을 함께 출력한다.
+- 경로 조회 시 `최단 거리` 또는 `최소 시간` 옵션을 선택할 수 있다.
+
+### 예외 처리
+
+- 출발역과 도착역은 2글자 이상이어야 한다.
+- 존재하지 않는 역을 출발역 또는 도착역으로 입력할 수 없다.
+- 경로 조회 시 출발역과 도착역이 같을 수 없다.
+- 경로 조회 시 출발역과 도착역이 연결되지 않으면 경로를 조회할 수 없다.
+- 그 외 정상적으로 프로그램이 수행되지 않은 경우 `alert`으로 에러를 출력한다.
+
+<br>
+
+## 프로그래밍 실행 결과
+
+### 경로 조회
+
+<img src="/images/path_result.gif" width="100%">
+
+## 프로그래밍 요구사항
+
+### 길찾기 관련 기능
+
+- 출발역을 입력하는 input 태그는 `departure-station-name-input` id 속성값을 가진다.
+- 도착역을 입력하는 input 태그는 `arrival-station-name-input` id 속성값을 가진다.
+- 최단거리, 최소시간을 선택하는 radio는 `search-type` name 속성값을 가진다.
+  - **radio option의 default 값은 최단거리이다.**
+- 길찾기 버튼은 `search-button` id 속성값을 가진다.
+- 📝 결과는 `table`을 이용하여 보여준다.
+
+## 힌트
+
+## 데이터 초기화
+
+자바스크립트에서 데이터를 초기화하는 방법 중에 하나는 아래와 같이 data를 `export`하고, `import`하는 것이다.
+
+```javascript
+export const users = [
+  {
+    name: "Alt",
+  },
+  {
+    name: "Jamie",
+  },
+  {
+    name: "Sony",
+  },
+];
+
+export const courses = [
+  {
+    name: "frontend",
+  },
+  {
+    name: "backend",
+  },
+  {
+    name: "iOS",
+  },
+  {
+    name: "Android",
+  },
+];
+```
+
+위와 같이 데이터를 `export`하면 아래와 같이 데이터를 `import` 하여 사용할 수 있다.
+
+```javascript
+import { users, courses } from "./data.js";
+
+function App() {
+  this.users = users;
+  this.courses = courses;
+}
+```
+
+## 최단 경로 라이브러리
+
+- `utils/Dijkstra.js` 라이브러리를 활용하면 간편하게 최단거리를 조회할 수 있다.
+- 정점(Vertex)과 간선(Edge), 그리고 가중치 개념을 이용
+  - 정점: 지하철역
+  - 간선: 지하철역 연결정보
+  - 가중치: 거리 or 소요 시간
+- 최단 거리 기준 조회 시 가중치를 거리로 설정
+- 최소 시간 기준 조회 시 가중치를 시간으로 설정
+
+```javascript
+import Dijkstra from "./utils/Dijkstra.js";
+const dijkstra = new Dijkstra();
+
+//dijkstra.addEdge("출발역", "도착역", 거리 또는 시간);
+dijkstra.addEdge("V1", "V2", 2);
+dijkstra.addEdge("V2", "V3", 2);
+dijkstra.addEdge("V1", "V3", 100);
+
+const result = dijkstra.findShortestPath("V1", "V3");
+// result = ["V1", "V2", "V3"]
+```
+
+#### 테스트설명
+
+<img src="/images/dijkstra_example.png" width="400">
+
+- 역 사이의 거리를 고려하지 않는 경우 V1->V3 경로가 최단 경로
+- 역 사이의 거리를 고려할 경우 V1->V3 경로의 거리는 100km, V1->V2->V3 경로의 거리는 4km이므로 최단 경로는 V1->V2->V3
+
+<br>
+
+### 요구사항
+
+- 사용자가 잘못된 입력 값을 작성한 경우 `alert`을 이용해 메시지를 보여주고, 재입력할 수 있게 한다.
+- 외부 라이브러리(jQuery, Lodash 등)를 사용하지 않고, 순수 Vanilla JS로만 구현한다.
+- **자바스크립트 코드 컨벤션을 지키면서 프로그래밍** 한다
+  - [https://google.github.io/styleguide/jsguide.html](https://google.github.io/styleguide/jsguide.html)
+  - [https://ui.toast.com/fe-guide/ko_CODING-CONVENSION/](https://ui.toast.com/fe-guide/ko_CODING-CONVENTION)
+- **indent(인덴트, 들여쓰기) depth를 3이 넘지 않도록 구현한다. 2까지만 허용**한다.
+  - 예를 들어 while문 안에 if문이 있으면 들여쓰기는 2이다.
+  - 힌트: indent(인덴트, 들여쓰기) depth를 줄이는 좋은 방법은 함수(또는 메소드)를 분리하면 된다.
+- **함수(또는 메소드)의 길이가 15라인을 넘어가지 않도록 구현한다.**
+  - 함수(또는 메소드)가 한 가지 일만 잘 하도록 구현한다.
+- 변수 선언시 [var](https://developer.mozilla.org/ko/docs/Web/JavaScript/Reference/Statements/var) 를 사용하지 않는다. [const](https://developer.mozilla.org/ko/docs/Web/JavaScript/Reference/Statements/const) 와 [let](https://developer.mozilla.org/ko/docs/Web/JavaScript/Reference/Statements/let) 을 사용한다.
+- [import](https://developer.mozilla.org/ko/docs/Web/JavaScript/Reference/Statements/import) 문을 이용해 스크립트를 모듈화하고 불러올 수 있게 만든다.
+- [template literal](https://developer.mozilla.org/ko/docs/Web/JavaScript/Reference/Template_literals)을 이용해 데이터와 html string을 가독성 좋게 표현한다.
+
+<br/>
+
+## 미션 저장소 및 진행 요구사항
+
+- 미션은 [https://github.com/woowacourse/javascript-subway-path-precourse](https://github.com/woowacourse/javascript-subway-path-precourse) 저장소를 fork/clone해 시작한다.
+- **기능을 구현하기 전에 javascript-subway-path-precourse/docs/README.md 파일에 구현할 기능 목록**을 정리해 추가한다.
+- **git의 commit 단위는 앞 단계에서 README.md 파일에 정리한 기능 목록 단위로 추가**한다.
+- [프리코스 과제 제출](https://github.com/woowacourse/woowacourse-docs/tree/master/precourse) 문서 절차를 따라 미션을 제출한다.

index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>지하철 길찾기</title>
+  </head>
+  <body>
+    <div id="app">
+      <h1>🚇 지하철 길찾기</h1>
+    </div>
+    <script type="module" src="src/index.js"></script>
+  </body>
+</html>

src/components/find-path-input-container.js

@@ -0,0 +1,46 @@
+import { makeStringToHTML } from "../utils/display/display-utils.js";
+
+import { dijkstraTime, dijkstraDistance } from "../utils/make-edges.js";
+import {
+  validateInput,
+  checkIfStartAndEndSame,
+} from "../utils/input/validator/input-validator.js";
+import { minPath, newResult } from "./find-path-result-container.js";
+
+const app = document.getElementById("app");
+
+export default function findPath() {
+  const subwayPathHTML = `
+    <div id="find-path">
+      출발역 <input id="departure-station-name-input" type="text" /> <br />
+      도착역 <input id="arrival-station-name-input" type="text" /> <br />
+      <input name="search-type" value="distance" type="radio" checked="checked" />최단거리
+      <input name="search-type" value="time" type="radio" />최소시간<br /> 
+      <button id="search-button" >길 찾기</button>
+    </div>
+  `;
+  app.append(makeStringToHTML(subwayPathHTML).firstElementChild);
+
+  const searchButton = document.getElementById("search-button");
+  searchButton.addEventListener("click", () => {
+    const selected = document.querySelector('input[name="search-type"]:checked')
+      .value;
+    const startStation = document.getElementById("departure-station-name-input")
+      .value;
+    const endStation = document.getElementById("arrival-station-name-input")
+      .value;
+    newResult();
+
+    if (!startStation && !endStation) {
+      return checkIfStartAndEndSame(startStation, endStation);
+    }
+
+    if (validateInput(startStation) && validateInput(endStation)) {
+      if (selected === "distance") {
+        minPath(dijkstraDistance, startStation, endStation);
+      } else if (selected === "time") {
+        minPath(dijkstraTime, startStation, endStation);
+      }
+    }
+  });
+}

src/components/find-path-result-container.js

@@ -0,0 +1,119 @@
+import {
+  makeStringToHTML,
+  clearElement,
+} from "../utils/display/display-utils.js";
+import { lines } from "../data.js";
+
+export function newResult() {
+  resultWrapper();
+
+  const result = document.getElementById("result");
+  clearElement(result);
+  resultPath(result);
+  resultPathTable(result);
+}
+
+function resultWrapper() {
+  const resultWrapperHTML = `<div id="result"></div>`;
+  app.append(makeStringToHTML(resultWrapperHTML).firstElementChild);
+}
+
+function resultPath(parent) {
+  const subwayPathTitleHTML = `<h2>📝 결과</h2>`;
+  parent.append(makeStringToHTML(subwayPathTitleHTML).firstElementChild);
+}
+
+export function minPath(distanceOrTimeDijkstra, startStation, endStation) {
+  const tbody = document.getElementsByTagName("tbody")[0];
+  const shortestDistance = distanceOrTimeDijkstra.findShortestPath(
+    startStation,
+    endStation
+  );
+
+  tbody.append(
+    distanceAndTimeRow(
+      totalDistance(shortestDistance)[0],
+      totalDistance(shortestDistance)[1]
+    ),
+
+    resultPathStations(shortestDistance)
+  );
+
+  return shortestDistance;
+}
+
+function resultPathStations(result) {
+  const td = document.createElement("td");
+  let resultStations = "";
+
+  for (let i = 0; i < result.length; i++) {
+    resultStations += result[i];
+    if (result[i + 1]) {
+      resultStations += "➡";
+    }
+  }
+
+  td.textContent = resultStations;
+  td.colSpan = 2;
+
+  return td;
+}
+
+function textInTd(innerText) {
+  const td = document.createElement("td");
+  td.textContent = innerText;
+
+  return td;
+}
+
+function distanceAndTimeRow(...args) {
+  const tr = document.createElement("tr");
+
+  for (const text of [...args]) {
+    const tdWithText = textInTd(text);
+    tr.append(tdWithText);
+  }
+
+  return tr;
+}
+
+function resultPathTable(parent) {
+  const subwayPathTableHTML = `
+    <table border="1">
+      <thead>
+        <tr>
+          <td><b>총 거리</b></td>
+          <td><b>총 소요 시간</b></td>
+        </tr>
+      </thead>
+      <tbody>
+      </tbody>
+    </table>
+  `;
+  parent.append(makeStringToHTML(subwayPathTableHTML).firstElementChild);
+}
+
+function totalDistance(result) {
+  const totalDistanceAndTimeArray = [];
+  let totalDistances = 0;
+  let totalTimes = 0;
+
+  for (const line of lines) {
+    for (const station of line.stations) {
+      for (let i = 0; i < result.length - 1; i++) {
+        if (
+          (result[i] === station.name &&
+            result[i + 1] === station.nextStation) ||
+          (result[i] === station.nextStation && result[i + 1] === station.name)
+        ) {
+          totalDistances += station.distance;
+          totalTimes += station.time;
+        }
+      }
+    }
+  }
+
+  totalDistanceAndTimeArray.push(totalDistances + "km", totalTimes + "분");
+
+  return totalDistanceAndTimeArray;
+}