refactor: refactor sequelize example (#83)

Author: dead-horse

.travis.yml

@@ -4,12 +4,13 @@ node_js:
   - '10'
   - '8'
 services:
-  - postgresql
+  - mysql
 before_install:
   - 'wget https://archive.apache.org/dist/zookeeper/zookeeper-3.4.6/zookeeper-3.4.6.tar.gz'
   - 'tar xf zookeeper-3.4.6.tar.gz'
   - 'mv zookeeper-3.4.6/conf/zoo_sample.cfg zookeeper-3.4.6/conf/zoo.cfg'
   - './zookeeper-3.4.6/bin/zkServer.sh start'
+  - mysql -e 'CREATE DATABASE IF NOT EXISTS `egg-sequelize-example-unittest`;'
 install:
   - npm i npminstall && npminstall
 script:

package.json

@@ -10,7 +10,6 @@
     "autod": "^2.7.1",
     "autod-egg": "^1.0.0",
     "chalk": "^1.1.3",
-    "egg-ci": "^1.6.0",
     "eslint": "4",
     "eslint-config-egg": "5",
     "npminstall": "3",

sequelize-example/.autod.conf.js

@@ -0,0 +1,22 @@
+'ues strict';
+
+module.exports = {
+  write: true,
+  prefix: '^',
+  devprefix: '^',
+  exclude: [
+    'test/fixtures',
+    'run',
+  ],
+  devdep: [
+    'egg-bin',
+    'sequelize-cli',
+  ],
+  dep: [
+    'egg',
+    'egg-sequelize',
+    'mysql2',
+  ],
+  semver: [
+  ],
+};

sequelize-example/.sequelizerc

@@ -0,0 +1,9 @@
+'use strict';
+
+const path = require('path');
+
+module.exports = {
+  config: path.join(__dirname, 'database/config.json'),
+  'migrations-path': path.join(__dirname, 'database/migrations'),
+  'seeders-path': path.join(__dirname, 'database/seeders'),
+};

sequelize-example/README.md

@@ -1,38 +1,53 @@
 # sequelize-example
 
-The [egg] example project that uses [egg-sequelize] plugin.
+The [egg] example project that uses [egg-sequelize] plugin. It will show you how to use sequelize in egg project, use [migrations] to help you manage changes of database and use [factory-girl] to help you write test cases more maintainable.
 
 ## QuickStart
 
-<!-- add docs here for user -->
+### Dependencies
 
-see [egg docs][egg] for more detail.
+- install mysql and create database
 
-### Development
-```bash
-$ npm install
-$ createdb example-dev --owner postgres
-$ npm run migrate:up
-$ npm run dev
-$ open http://localhost:7001/users
 ```
+brew install mysql # macOS
+brew service start mysql
 
-### Deploy
+mysql
+  > create database `egg-sequelize-example-dev`;
+  > create database `egg-sequelize-example-unittest`;
+```
+
+- install dependencies
+
+```
+npm install
+```
+
+### Start Server and Run Test
 
-Use `EGG_SERVER_ENV=prod` to enable prod mode
+- prepare database structure
 
-```bash
-$ createdb example-prod --owner postgres
-$ NODE_ENV=production npm run migrate:up
-$ EGG_SERVER_ENV=prod npm start
 ```
+# for develop
+npm run sequelize -- db:migrate
+# for unittest
+NODE_ENV=test npm run sequelize -- db:migrate
+```
+
+- start project
 
-### npm scripts
+```
+npm run dev
+```
 
-- Use `npm run lint` to check code style.
-- Use `npm test` to run unit test.
-- Use `npm run autod` to auto detect dependencies upgrade, see [autod](https://www.npmjs.com/package/autod) for more detail.
+- run test
 
+```
+npm test
+```
 
 [egg]: https://eggjs.org
-[egg-sequelize]: https://github.com/eggjs/egg-sequelize
+[egg-sequelize]: https://github.com/eggjs/egg-sequelize
+[sequelize]: http://docs.sequelizejs.com/
+[migrations]: http://docs.sequelizejs.com/manual/tutorial/migrations.html
+[factory-girl]: https://github.com/aexmachina/factory-girl

sequelize-example/README.zh-CN.md

@@ -1,43 +1,53 @@
 # sequelize-example
 
-使用 [egg-sequelize] 插件的 [egg] 示例项目。
+这个 [egg] 示例项目示范如何使用 [egg-sequelize] 插件。它会展示如何在 egg 项目中使用 [sequelize] 连接数据库，使用 [migrations] 来管理数据结构变更，并通过 [factory-girl] 来编写更易于维护的测试用例。
 
-## 快速入门
+## 快速开始
 
-<!-- 在此次添加使用文档 -->
+### 安装依赖
 
-如需进一步了解，参见 [egg 文档][egg]。
+- 安装 mysql 并建立数据库
 
-### 本地开发
-```bash
-$ npm install
-$ createdb example-dev --owner postgres
-$ npm run migrate:up
-$ npm run dev
-$ open http://localhost:7001/users
 ```
+brew install mysql # macOS
+brew service start mysql
 
-### 部署
+mysql
+  > create database `egg-sequelize-example-dev`;
+  > create database `egg-sequelize-example-unittest`;
+```
 
-线上正式环境用 `EGG_SERVER_ENV=prod` 来启动。
+- 安装 node 依赖
 
-```bash
-$ createdb example-prod --owner postgres
-$ NODE_ENV=production npm run migrate:up
-$ EGG_SERVER_ENV=prod npm start
 ```
+npm install
+```
+
+### 启动和测试
 
-### 单元测试
-- [egg-bin] 内置了 [mocha], [thunk-mocha], [power-assert], [istanbul] 等框架，让你可以专注于写单元测试，无需理会配套工具。
-- 断言库非常推荐使用 [power-assert]。
-- 具体参见 [egg 文档 -单元测试](https://eggjs.org/zh-cn/core/unittest)。
+- 执行 migration 执行数据变更
 
-### 内置指令
+```
+# for develop
+npm run sequelize -- db:migrate
+# for unittest
+NODE_ENV=test npm run sequelize -- db:migrate
+```
 
-- 使用 `npm run lint` 来做代码风格检查。
-- 使用 `npm test` 来执行单元测试。
-- 使用 `npm run autod` 来自动检测依赖更新，详细参见 [autod](https://www.npmjs.com/package/autod) 。
+- 启动项目
 
+```
+npm run dev
+```
+
+- 运行测试
+
+```
+npm test
+```
 
 [egg]: https://eggjs.org
-[egg-sequelize]: https://github.com/eggjs/egg-sequelize
+[egg-sequelize]: https://github.com/eggjs/egg-sequelize
+[sequelize]: http://docs.sequelizejs.com/
+[migrations]: http://docs.sequelizejs.com/manual/tutorial/migrations.html
+[factory-girl]: https://github.com/aexmachina/factory-girl

sequelize-example/app/controller/post.js

@@ -3,37 +3,42 @@
 const Controller = require('egg').Controller;
 
 class PostController extends Controller {
-  async posts() {
+  async index() {
     const ctx = this.ctx;
-    ctx.body = await ctx.service.post.list(ctx.query);
+    const query = {
+      limit: ctx.helper.parseInt(ctx.query.limit),
+      offset: ctx.helper.parseInt(ctx.query.offset),
+    };
+    ctx.body = await ctx.service.post.list(query);
   }
 
-  async post() {
+  async show() {
     const ctx = this.ctx;
-    ctx.body = await ctx.service.post.find(ctx.params.id);
+    ctx.body = await ctx.service.post.find(ctx.helper.parseInt(ctx.params.id));
   }
 
   async create() {
     const ctx = this.ctx;
-    const body = ctx.request.body;
-    body.user_id = +ctx.params.user_id;
-    const created = await ctx.service.post.create(ctx.request.body);
+    const post = await ctx.service.post.create(ctx.request.body);
     ctx.status = 201;
-    ctx.body = created;
+    ctx.body = post;
   }
 
   async update() {
     const ctx = this.ctx;
     const id = ctx.params.id;
-    const user_id = +ctx.params.user_id;
-    const body = ctx.request.body;
-    ctx.body = await ctx.service.post.update({ id, user_id, updates: body });
+    const updates = {
+      title: ctx.request.body.title,
+      content: ctx.request.body.content,
+    };
+    ctx.body = await ctx.service.post.update({ id, user_id: ctx.request.body.user_id, updates });
   }
 
-  async del() {
+  async destroy() {
     const ctx = this.ctx;
-    const id = ctx.params.id;
-    await ctx.service.post.del(id);
+    const id = ctx.helper.parseInt(ctx.params.id);
+    const user_id = ctx.helper.parseInt(ctx.request.body.user_id);
+    await ctx.service.post.destroy({ id, user_id });
     ctx.status = 200;
   }
 }

sequelize-example/app/controller/user.js

@@ -3,33 +3,37 @@
 const Controller = require('egg').Controller;
 
 class UserController extends Controller {
-  async users() {
+  async index() {
     const ctx = this.ctx;
-    ctx.body = await ctx.service.user.list(ctx.query);
+    const query = {
+      limit: ctx.helper.parseInt(ctx.query.limit),
+      offset: ctx.helper.parseInt(ctx.query.offset),
+    };
+    ctx.body = await ctx.service.user.list(query);
   }
 
-  async user() {
+  async show() {
     const ctx = this.ctx;
-    ctx.body = await ctx.service.user.find(ctx.params.id);
+    ctx.body = await ctx.service.user.find(ctx.helper.parseInt(ctx.params.id));
   }
 
   async create() {
     const ctx = this.ctx;
-    const created = await ctx.service.user.create(ctx.request.body);
+    const user = await ctx.service.user.create(ctx.request.body);
     ctx.status = 201;
-    ctx.body = created;
+    ctx.body = user;
   }
 
   async update() {
     const ctx = this.ctx;
-    const id = ctx.params.id;
+    const id = ctx.helper.parseInt(ctx.params.id);
     const body = ctx.request.body;
     ctx.body = await ctx.service.user.update({ id, updates: body });
   }
 
-  async del() {
+  async destroy() {
     const ctx = this.ctx;
-    const id = ctx.params.id;
+    const id = ctx.helper.parseInt(ctx.params.id);
     await ctx.service.user.del(id);
     ctx.status = 200;
   }

sequelize-example/app/extend/helper.js

@@ -0,0 +1,9 @@
+'use strict';
+
+module.exports = {
+  parseInt(string) {
+    if (typeof string === 'number') return string;
+    if (!string) return string;
+    return parseInt(string) || 0;
+  },
+};

sequelize-example/app/model/post.js

@@ -20,5 +20,11 @@ module.exports = app => {
     app.model.Post.belongsTo(app.model.User, { as: 'user', foreignKey: 'user_id' });
   };
 
+  Post.findByIdWithUser = async function(id, userId) {
+    return await this.findOne({
+      where: { id, user_id: userId },
+    });
+  };
+
   return Post;
 };

sequelize-example/app/model/user.js

@@ -16,7 +16,7 @@ module.exports = app => {
   });
 
   User.prototype.associate = function() {
-    app.model.User.hasMany(app.model.Post, { as: 'posts', foreignKey: 'user_id' });
+    app.model.User.hasMany(app.model.Post, { as: 'posts' });
   };
 
   return User;

sequelize-example/app/router.js

@@ -1,15 +1,6 @@
 'use strict';
 
 module.exports = app => {
-  app.router.get('/users', 'user.users');
-  app.router.get('/users/:id', 'user.user');
-  app.router.post('/users', 'user.create');
-  app.router.put('/users/:id', 'user.update');
-  app.del('/users/:id', 'user.del');
-
-  app.router.get('/posts', 'post.posts');
-  app.router.get('/posts/:id', 'post.post');
-  app.router.post('/users/:user_id/posts', 'post.create');
-  app.router.put('/users/:user_id/posts/:id', 'post.update');
-  app.del('/users/:user_id/posts/:id', 'post.del');
+  app.resources('users', '/users', app.controller.user);
+  app.resources('posts', '/posts', app.controller.post);
 };