Improve controller

64json · 64json · commit f6431e7a47a2 · 2018-07-13T20:04:33.000+09:00
diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +1,6 @@
 [submodule "src/backend/public/algorithms"]
 	path = src/backend/public/algorithms
 	url = git@github.com:algorithm-visualizer/algorithms.git
+[submodule "src/backend/public/docs"]
+	path = src/backend/public/docs
+	url = git@github.com:algorithm-visualizer/tracers.wiki.git
diff --git a/src/backend/controllers/categories.js b/src/backend/controllers/categories.js
diff --git a/src/backend/controllers/compilers.js b/src/backend/controllers/compilers.js
diff --git a/src/backend/controllers/docs.js b/src/backend/controllers/docs.js
@@ -0,0 +1,41 @@
+import express from 'express';
+import fs from 'fs';
+import path from 'path';
+import { NotFoundError } from '/common/error';
+
+const router = express.Router();
+
+const getPath = (...args) => path.resolve(__dirname, '..', 'public', 'docs', ...args);
+
+const readDocs = () => {
+  const createKey = name => name.slice(0, -3);
+  const list = dirPath => fs.readdirSync(dirPath).filter(filename => /(\.md)$/.test(filename));
+  return list(getPath()).map(docName => ({
+    key: createKey(docName),
+    name: docName,
+  }));
+};
+
+const docs = readDocs();
+
+const getDocs = (req, res, next) => {
+  res.json({ docs: docs });
+};
+
+const getDoc = (req, res, next) => {
+  const { docKey } = req.params;
+
+  const doc = docs.find(doc => doc.key === docKey);
+  if (!doc) return next(new NotFoundError());
+
+  const docPath = getPath(doc.name);
+  res.sendFile(docPath);
+};
+
+router.route('/')
+  .get(getDocs);
+
+router.route('/:docKey')
+  .get(getDoc);
+
+export default router;
diff --git a/src/backend/controllers/index.js b/src/backend/controllers/index.js
@@ -1,31 +1,4 @@
-import express from 'express';
-import { AuthorizationError, NotFoundError, PermissionError } from '/common/error';
-import auth from './auth';
-import category from './category';
-import compiler from './compiler';
-import wiki from './wiki';
-
-const router = new express.Router();
-
-router.use('/auth', auth);
-router.use('/category', category);
-router.use('/compiler', compiler);
-router.use('/wiki', wiki);
-router.use((req, res, next) => next(new NotFoundError()));
-router.use((err, req, res, next) => {
-  const statusMap = [
-    [AuthorizationError, 401],
-    [PermissionError, 403],
-    [NotFoundError, 404],
-    [Error, 500],
-  ];
-  const [, status] = statusMap.find(([Error]) => err instanceof Error);
-  res.status(status);
-  res.json({
-    status,
-    err,
-  });
-  console.error(err);
-});
-
-export default router;
+export { default as auth } from './auth';
+export { default as categories } from './categories';
+export { default as compilers } from './compilers';
+export { default as docs } from './docs';
diff --git a/src/backend/controllers/wiki.js b/src/backend/controllers/wiki.js
diff --git a/src/backend/index.js b/src/backend/index.js
@@ -2,13 +2,30 @@ import express from 'express';
 import morgan from 'morgan';
 import cookieParser from 'cookie-parser';
 import bodyParser from 'body-parser';
-import controllers from '/controllers';
+import * as controllers from '/controllers';
+import { AuthorizationError, NotFoundError, PermissionError } from '/common/error';
 
 const app = express();
 app.use(morgan('tiny'));
 app.use(cookieParser());
 app.use(bodyParser.json());
 app.use(bodyParser.urlencoded({ extended: true }));
-app.use(controllers);
+Object.keys(controllers).forEach(key => app.use(`/${key}`, controllers[key]));
+app.use((req, res, next) => next(new NotFoundError()));
+app.use((err, req, res, next) => {
+  const statusMap = [
+    [AuthorizationError, 401],
+    [PermissionError, 403],
+    [NotFoundError, 404],
+    [Error, 500],
+  ];
+  const [, status] = statusMap.find(([Error]) => err instanceof Error);
+  res.status(status);
+  res.json({
+    status,
+    err,
+  });
+  console.error(err);
+});
 
 export default app;
diff --git a/src/backend/public/docs b/src/backend/public/docs
@@ -0,0 +1 @@
+Subproject commit 08dc9b2369dd65a69fa5e3d9eb0e2c268fdb94fd
diff --git a/src/frontend/apis/index.js b/src/frontend/apis/index.js
@@ -54,13 +54,13 @@ const PATCH = URL => {
 };
 
 const CategoryApi = {
-  getCategories: GET('/category'),
-  getAlgorithm: GET('/category/:categoryKey/:algorithmKey'),
+  getCategories: GET('/categories'),
+  getAlgorithm: GET('/categories/:categoryKey/:algorithmKey'),
 };
 
-const WikiApi = {
-  getWikis: GET('/wiki'),
-  getWiki: GET('/wiki/:wiki'),
+const DocApi = {
+  getDocs: GET('/docs'),
+  getDoc: GET('/docs/:docKey'),
 };
 
 const GitHubApi = {
@@ -77,7 +77,7 @@ let jsWorker = null;
 const CompilerApi = {
   js: code => new Promise((resolve, reject) => {
     if (jsWorker) jsWorker.terminate();
-    jsWorker = new Worker('/api/compiler/js');
+    jsWorker = new Worker('/api/compilers/js');
     jsWorker.onmessage = e => resolve(e.data);
     jsWorker.onerror = reject;
     jsWorker.postMessage(code);
@@ -86,7 +86,7 @@ const CompilerApi = {
 
 export {
   CategoryApi,
-  WikiApi,
+  DocApi,
   GitHubApi,
   CompilerApi,
 };
diff --git a/src/frontend/components/WikiViewer/index.jsx b/src/frontend/components/WikiViewer/index.jsx
@@ -1,5 +1,5 @@
 import React from 'react';
-import { WikiApi } from '/apis';
+import { DocApi } from '/apis';
 import { MarkdownViewer } from '/components';
 import { classes } from '/common/util';
 import styles from './stylesheet.scss';
@@ -18,7 +18,7 @@ class WikiViewer extends React.Component {
   }
 
   loadMarkdown(href) {
-    WikiApi.getWiki(href)
+    DocApi.getDoc(href)
       .then(source => this.setState({ source }));
   }
 

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`import React from 'react';`
`2`		`-import { WikiApi } from '/apis';`
	`2`	`+import { DocApi } from '/apis';`
`3`	`3`	`import { MarkdownViewer } from '/components';`
`4`	`4`	`import { classes } from '/common/util';`
`5`	`5`	`import styles from './stylesheet.scss';`
`@@ -18,7 +18,7 @@ class WikiViewer extends React.Component {`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`loadMarkdown(href) {`
`21`		`- WikiApi.getWiki(href)`
	`21`	`+ DocApi.getDoc(href)`
`22`	`22`	`.then(source => this.setState({ source }));`
`23`	`23`	`}`
`24`	`24`