Add SubsemesterScheduler, component reorganization, Prettier code style, add jsdocs

src/app.py

@@ -11,8 +11,6 @@
 import db.courses as Courses
 from io import StringIO
 
-from flask_cors import CORS
-
 # - init interfaces to db
 db_conn = connection.db
 class_info = ClassInfo.ClassInfo(db_conn)
@@ -21,7 +19,6 @@
 app = Flask(
     __name__,
     template_folder='./public/templates')
-CORS(app)
 
 
 # - web routes break into routes/ ... later

src/requirements.txt

@@ -1,5 +1,4 @@
 Flask==1.1.1
-Flask-Cors==3.0.8
 gevent==1.4.0
 gunicorn==19.9.0
 Jinja2==2.10.3

src/yacs-web/.eslintrc.js

@@ -3,15 +3,12 @@ module.exports = {
   env: {
     node: true
   },
-  'extends': [
-    'plugin:vue/essential',
-    'eslint:recommended'
-  ],
+  extends: ['plugin:vue/essential', 'eslint:recommended', 'prettier'],
   parserOptions: {
     parser: 'babel-eslint'
   },
   rules: {
     'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
     'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off'
   }
-}
+};

src/yacs-web/.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 node_modules
 /dist
+docs
 
 # local env files
 .env.local

src/yacs-web/.prettierrc

@@ -0,0 +1,16 @@
+{
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "quoteProps": "as-needed",
+  "jsxSingleQuote": false,
+  "trailingComma": "none",
+  "bracketSpacing": true,
+  "jsxBracketSameLine": false,
+  "arrowParens": "avoid",
+  "proseWrap": "preserve",
+  "htmlWhitespaceSensitivity": "css",
+  "vueIndentScriptAndStyle": false
+}

src/yacs-web/README.md

@@ -1,24 +1,35 @@
 # yacs-web
 
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+
+# Note for vscode users
+
+If you're having trouble getting intellisense or '@' import alias working in .vue files, try using yacs-web as the root directory. For some reason, vscode has a hard time with jsconfig.json when it isn't in the root directory of your current workspace.
+
 ## Project setup
+
 ```
 npm install
 ```
 
 ### Compiles and hot-reloads for development
+
 ```
 npm run serve
 ```
 
 ### Compiles and minifies for production
+
 ```
 npm run build
 ```
 
 ### Lints and fixes files
+
 ```
 npm run lint
 ```
 
 ### Customize configuration
+
 See [Configuration Reference](https://cli.vuejs.org/config/).

src/yacs-web/babel.config.js

@@ -1,5 +1,3 @@
 module.exports = {
-  "presets": [
-    "@vue/cli-plugin-babel/preset"
-  ]
-}
+  presets: ['@vue/cli-plugin-babel/preset']
+};

src/yacs-web/jsconfig.json

@@ -0,0 +1,11 @@
+{
+  "allowSyntheticDefaultImports": false,
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["src/*"]
+    }
+  },
+  "exclude": ["node_modules", "dist"],
+  "include": ["./src/**/*"]
+}

src/yacs-web/jsdoc.config.json

@@ -0,0 +1,12 @@
+{
+  "source": {
+    "includePattern": ".+\\.js(doc|x)?$",
+    "include": ["src"],
+    "exclude": ["node_modules", "dist", "docs"]
+  },
+  "plugins": ["plugins/markdown"],
+  "opts": {
+    "destination": "./docs/",
+    "recurse": true
+  }
+}

src/yacs-web/package.json

@@ -15,8 +15,10 @@
     "axios": "^0.19.2",
     "bootstrap-vue": "^2.1.0",
     "core-js": "^3.6.4",
+    "eslint-config-prettier": "^6.10.0",
     "moment": "^2.24.0",
     "moment-locales-webpack-plugin": "^1.1.2",
+    "prettier": "^1.19.1",
     "vue": "^2.6.11",
     "vue-router": "^3.1.6"
   },

src/yacs-web/src/App.vue

@@ -5,14 +5,13 @@
 </template>
 
 <script>
-
 export default {
   name: 'App'
-}
+};
 </script>
 
 <style lang="scss">
-  body {
-    overflow-x: hidden;
-  }
+body {
+  overflow-x: hidden;
+}
 </style>

src/yacs-web/src/components/CourseList.vue

@@ -0,0 +1,98 @@
+<template>
+  <div>
+    <div class="course-search">
+      <b-form-group label="Search" label-for="search">
+        <b-form-input
+          id="search"
+          v-model="textSearch"
+          trim
+          placeholder="Intro to College - COLG 1030 - 5/2"
+        ></b-form-input>
+      </b-form-group>
+
+      <b-form-group label="Filter Sub-Semester" for="sub-semester">
+        <b-form-select v-model="selectedSubsemester" :options="subsemesterOptions"></b-form-select>
+      </b-form-group>
+
+      <b-form-group label="Filter Department" for="department">
+        <b-form-select v-model="selectedDepartment" :options="departmentOptions"></b-form-select>
+      </b-form-group>
+    </div>
+
+    <hr />
+
+    <b-list-group class="course-list" flush>
+      <b-list-group-item
+        button
+        v-for="course in filteredCourses"
+        :key="course.name + course.date_end + course.date_start"
+        :disabled="course.selected"
+        :class="{ 'bg-light': course.selected }"
+        @click="$emit('addCourse', course)"
+      >
+        <b>{{ course.name }}</b>
+        ({{ readableDate(course.date_start) }} - {{ readableDate(course.date_end) }})
+        <br />
+        {{ course.title }}
+      </b-list-group-item>
+    </b-list-group>
+  </div>
+</template>
+
+<script>
+import '@/typedef';
+
+import { readableDate } from '@/utils';
+
+import { getCourses, getDepartments, getSubSemesters } from '@/services/YacsService';
+
+export default {
+  name: 'CourseList',
+  data() {
+    return {
+      textSearch: null,
+      selectedSubsemester: null,
+      subsemesterOptions: [{ text: 'All', value: null }],
+      selectedDepartment: null,
+      departmentOptions: [{ text: 'All', value: null }],
+      /** @type {Course[]} */
+      courses: []
+    };
+  },
+  created() {
+    getCourses().then(courses => this.courses.push(...courses));
+    getDepartments().then(departments => {
+      this.departmentOptions.push(...departments.map(d => d.department));
+    });
+    getSubSemesters().then(subsemesters => {
+      this.subsemesterOptions.push(
+        ...subsemesters.map(subsemester => {
+          return { text: subsemester.display_string, value: subsemester };
+        })
+      );
+    });
+  },
+  methods: {
+    readableDate
+  },
+  computed: {
+    /**
+     * Returns a list of courses that match the selected filters
+     * @returns {Course[]}
+     */
+    filteredCourses() {
+      return this.courses.filter(({ date_start, date_end, department, str }) => {
+        return (
+          (!this.selectedSubsemester ||
+            (this.selectedSubsemester.date_start.getTime() === date_start.getTime() &&
+              this.selectedSubsemester.date_end.getTime() === date_end.getTime())) &&
+          (!this.selectedDepartment || this.selectedDepartment === department) &&
+          (!this.textSearch || str.includes(this.textSearch.toUpperCase()))
+        );
+      });
+    }
+  }
+};
+</script>
+
+<style></style>

src/yacs-web/src/components/Header.vue

@@ -1,15 +1,13 @@
 <template>
-    <b-navbar variant="info">
-        <b-navbar-brand href="#">YACS</b-navbar-brand>
-    </b-navbar>
+  <b-navbar variant="info">
+    <b-navbar-brand href="#">YACS</b-navbar-brand>
+  </b-navbar>
 </template>
 
 <script>
 export default {
-    name: 'Header'
-}
+  name: 'Header'
+};
 </script>
 
-<style>
-
-</style>
+<style></style>