10 | 
11 | }})
12 |
13 | {{app.control('form#select')}}
14 |
--------------------------------------------------------------------------------
/packages/plover/test/fixtures/core/app/modules/layouts/index.js:
--------------------------------------------------------------------------------
1 | exports.view = function() {
2 | this.render();
3 | };
4 |
5 |
6 | exports.index = function() {
7 | this.render();
8 | };
9 |
10 |
11 | exports.mobile = function() {
12 | this.render();
13 | };
14 |
15 |
16 | exports.simple = function() {
17 | this.body = 'simple layout\n' + this.data.content;
18 | };
19 |
20 |
21 | exports.invalid = function() {
22 | // no render, page will 404
23 | };
24 |
--------------------------------------------------------------------------------
/packages/plover-assets/test/fixtures/app/modules/layouts/views/view.art:
--------------------------------------------------------------------------------
1 |
2 |
3 | {{assets.cssTag('lib')}}
4 | {{assets.cssTag()}}
5 | {{assets.css('http://g.cdn.com/bootstrap.css', 'lib')}}
6 | {{assets.css('lib:css/vue.css')}}
7 | {{assets.js('http://g.cdn.com/jquery.js', 'lib')}}
8 | {{assets.js('lib:css/vue.js')}}
9 |
10 |
11 | {{content}}
12 | {{assets.jsTag('lib')}}
13 | {{assets.jsTag()}}
14 |
15 |
16 |
--------------------------------------------------------------------------------
/packages/ploverx/test/fixtures/app/lib/try-logger.js:
--------------------------------------------------------------------------------
1 | const logger = require('plover-logger')('my:lib/hello');
2 |
3 |
4 | module.exports = function() {
5 | logger.info('init try-logger middleware');
6 | return async (ctx, next) => {
7 | if (ctx.path === '/logger') {
8 | const level = ctx.query.level || 'info';
9 | logger[level]('some logger message');
10 | ctx.body = `logger ${level}`;
11 | } else {
12 | await next();
13 | }
14 | };
15 | };
16 |
--------------------------------------------------------------------------------
/packages/plover/test/fixtures/core/app/modules/filter/index.js:
--------------------------------------------------------------------------------
1 | exports.view = function() {
2 | this.layout = false;
3 | this.render();
4 | };
5 |
6 |
7 | exports.beforeRender = function* () {
8 | if (this.query.break === 'true') {
9 | this.body = this.query.body ? 'break in beforeRender' : null;
10 | return false;
11 | }
12 | };
13 |
14 | exports.afterRender = function() {
15 | if (this.query.filterAfter === 'true') {
16 | this.body = 'after:' + this.body;
17 | }
18 | };
19 |
--------------------------------------------------------------------------------
/packages/plover/test/fixtures/core/app/lib/helpers/cms.js:
--------------------------------------------------------------------------------
1 | class CMSHelper {
2 | constructor(rd, viewRender) {
3 | this.rd = rd;
4 | this.viewRender = viewRender;
5 | }
6 |
7 | render(url) {
8 | const defer = new Promise(function(resolve) {
9 | setTimeout(function() {
10 | resolve({ content: 'cms: ' + url });
11 | }, 100);
12 | });
13 | return this.viewRender.renderAsync(this.rd, defer, url);
14 | }
15 | }
16 |
17 |
18 | module.exports = CMSHelper;
19 |
20 |
--------------------------------------------------------------------------------
/packages/plover-assets/test/fixtures/expect/simple.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 | ' + util.inspect(e) + '\n' + (e.stack || '') + '' : 26 | 'Internel Server Error'; 27 | 28 | if (ctx.is('application/json') || 29 | !ctx.accepts('html') && ctx.accepts('application/json')) { 30 | ctx.body = { success: false, message }; 31 | } else { 32 | ctx.body = message; 33 | } 34 | }); 35 | }; 36 | }; 37 | -------------------------------------------------------------------------------- /packages/plover-web/test/web/flash.js: -------------------------------------------------------------------------------- 1 | const Koa = require('koa'); 2 | const request = require('supertest'); 3 | const co = require('co'); 4 | 5 | 6 | describe('plover-web/web/flash', function() { 7 | it('test', function() { 8 | const app = new Koa(); 9 | 10 | app.keys = ['0627e']; 11 | 12 | app.use(require('koa-session')({}, app)); 13 | app.use(require('../../lib/web/flash')(app)); 14 | 15 | app.use(ctx => { 16 | if (ctx.path === '/update') { 17 | ctx.flash.errors = { 18 | message: 'some error happen' 19 | }; 20 | ctx.redirect('/save'); 21 | } else if (ctx.path === '/save') { 22 | ctx.body = ctx.flash.errors; 23 | } else { 24 | ctx.body = 'hello'; 25 | } 26 | }); 27 | 28 | const agent = request.agent(app.callback()); 29 | return co(function* () { 30 | yield agent.get('/update').expect(302); 31 | yield agent.get('/save').expect({ message: 'some error happen' }); 32 | 33 | yield agent.get('/hello').expect('hello'); 34 | }); 35 | }); 36 | }); 37 | -------------------------------------------------------------------------------- /packages/plover-logger/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "plover-logger", 3 | "version": "1.7.0", 4 | "description": "【核心模块】提供统一的日志接口，让使用者不用关心日志实现，方便日志实现切换。", 5 | "main": "lib/index.js", 6 | "scripts": { 7 | "test": "mocha --require should --reporter spec --recursive --check-leaks test/", 8 | "cov": "istanbul cover _mocha -- --require should --recursive --check-leaks test/ -R spec" 9 | }, 10 | "files": [ 11 | "lib" 12 | ], 13 | "dependencies": { 14 | "debug": "^4.1.1" 15 | }, 16 | "devDependencies": { 17 | "istanbul": "^1.1.0-alpha", 18 | "mocha": "^8.0.1", 19 | "should": "^13.1.2", 20 | "sinon": "^9.0.2" 21 | }, 22 | "repository": { 23 | "type": "git", 24 | "url": "git+https://github.com/alibaba/plover.git" 25 | }, 26 | "publishConfig": { 27 | "registry": "https://registry.npmjs.org" 28 | }, 29 | "author": "bencode@163.com", 30 | "license": "Apache-2.0", 31 | "bugs": { 32 | "url": "https://github.com/alibaba/plover/issues" 33 | }, 34 | "homepage": "https://github.com/alibaba/plover#readme" 35 | } 36 | -------------------------------------------------------------------------------- /packages/plover-logger/README.md: -------------------------------------------------------------------------------- 1 | # plover-logger 2 | 3 | 4 | [![NPM version][npm-image]][npm-url] 5 | 6 | 7 | 【核心模块】提供统一的日志接口，让使用者不用关心日志实现，方便日志实现切换。 8 | 9 | ## Usage 10 | ```js 11 | const log = require('plover-logger')('namespace'); 12 | 13 | log.info('init application: %s', name); 14 | log.error(e); 15 | log.debug('data return: %o', data); 16 | log.warn('data already exist: %o', o); 17 | ``` 18 | 19 | ## Level 20 | 分为`error`, `warn`, `info`, `debug`四个日志级别。 21 | 22 | | name | priority | 23 | |:-----|:--------:| 24 | | error | 1 | 25 | | warn | 2 | 26 | | info | 3 | 27 | | debug | 4 | 28 | 29 | 日志级别从高到低分别为: 30 | 31 | `error` > `warn` > `info` > `debug` 32 | 33 | 日志级别默认为`warn`，此时仅显示`error`、`warn`级别的日志信息。可以通过设置`DEBUG`环境变量来显示`namespace`下`info`和`debug`级别的日志信息。例如： 34 | 35 | ```bash 36 | $ DEBUG=namespace node example/app 37 | ``` 38 | 39 | **Note** 40 | 41 | 更多`DEBUG`的设置方式，请参考[debug模块](https://github.com/visionmedia/debug). 42 | 43 | 44 | [npm-image]: https://img.shields.io/npm/v/plover-logger.svg?style=flat-square 45 | [npm-url]: https://www.npmjs.com/package/plover-logger 46 | -------------------------------------------------------------------------------- /packages/plover-web/lib/web/charset.js: -------------------------------------------------------------------------------- 1 | const debug = require('debug')('plover-web:charset'); 2 | 3 | 4 | const map = { 5 | gbk: 1 6 | }; 7 | 8 | const rCharset = /;\s+charset=([-\w]+)/i; 9 | 10 | 11 | /* 12 | * 根据需要转换输出编码 13 | * 14 | * @param {Object} opts 参数 15 | * - outputCharset 编码 16 | */ 17 | module.exports = function() { 18 | return async function OutputCharset(ctx, next) { 19 | await next(); 20 | 21 | const charset = ctx.query._output_charset; // eslint-disable-line 22 | if (!charset || !map[charset]) { 23 | return; 24 | } 25 | 26 | const body = ctx.body; 27 | if (typeof body === 'string') { 28 | debug('encode to %s', charset); 29 | const iconv = require('iconv-lite'); 30 | ctx.body = iconv.encode(body, charset); 31 | 32 | const ctype = ctx.response.headers['content-type']; 33 | if (ctype) { 34 | const newCtype = ctype.replace(rCharset, '') + '; charset=' + charset; 35 | debug('set content-type: %s', newCtype); 36 | ctx.set('content-type', newCtype); 37 | } 38 | } 39 | }; 40 | }; 41 | 42 | -------------------------------------------------------------------------------- /packages/plover-web/test/web/charset.js: -------------------------------------------------------------------------------- 1 | const Koa = require('koa'); 2 | const request = require('supertest'); 3 | const co = require('co'); 4 | const charset = require('../../lib/web/charset'); 5 | 6 | 7 | /* eslint max-nested-callbacks: [2, 4] */ 8 | 9 | 10 | describe('plover-web/web/charset', () => { 11 | it('output gbk with query _output_charset', () => { 12 | const app = new Koa(); 13 | app.use(charset()); 14 | app.use(ctx => { 15 | if (ctx.path === '/a') { 16 | ctx.body = '中国'; 17 | } else if (ctx.path === '/b') { 18 | ctx.body = { data: '中国' }; 19 | } 20 | }); 21 | 22 | const agent = request.agent(app.callback()); 23 | return co(function* () { 24 | yield agent.get('/a').expect('中国'); 25 | 26 | yield agent.get('/a?_output_charset=gbk') 27 | .expect('content-type', 'text/plain; charset=gbk') 28 | .expect(o => { 29 | o.buffered.should.be.true(); 30 | }); 31 | 32 | // json data should not encode 33 | yield agent.get('/b?_output_charset=gbk') 34 | .expect({ data: '中国' }); 35 | }); 36 | }); 37 | }); 38 | -------------------------------------------------------------------------------- /packages/ploverx/lib/util.js: -------------------------------------------------------------------------------- 1 | /* eslint no-process-env: 0 */ 2 | 3 | const pathUtil = require('path'); 4 | const fs = require('fs'); 5 | 6 | 7 | exports.loadSettings = function(root) { 8 | const configRoot = pathUtil.join(root, 'config'); 9 | 10 | const settings = { 11 | applicationRoot: root, 12 | env: process.env.NODE_ENV || 'development', 13 | disableDefaultRouter: true, 14 | defaultLayout: 'layouts:index' 15 | }; 16 | 17 | const appConfig = require(pathUtil.join(configRoot, 'app.js')); 18 | Object.assign(settings, appConfig); 19 | 20 | prepareLibModulesDir(settings); 21 | 22 | const routesPath = pathUtil.join(configRoot, 'routes.js'); 23 | if (fs.existsSync(routesPath)) { 24 | settings.routes = require(routesPath); 25 | } 26 | 27 | return settings; 28 | }; 29 | 30 | 31 | function prepareLibModulesDir(settings) { 32 | const libs = [pathUtil.join(__dirname, '../')]; 33 | 34 | let appLibs = settings.libModulesDir || settings.applicationRoot; 35 | if (!Array.isArray(appLibs)) { 36 | appLibs = [appLibs]; 37 | } 38 | 39 | settings.libModulesDir = libs.concat(appLibs); 40 | } 41 | -------------------------------------------------------------------------------- /packages/plover-assets/test/util/concat-url.js: -------------------------------------------------------------------------------- 1 | const concatUrl = require('../../lib/util/concat-url'); 2 | 3 | 4 | describe('util/concat-url', function() { 5 | it('should concat url', function() { 6 | concatUrl('http://assets??', ['a.js', 'b.js']) 7 | .should.eql(['http://assets??a.js,b.js']); 8 | }); 9 | 10 | 11 | it('should return muti urls when url lenth > 1500', function() { 12 | const list = []; 13 | for (let i = 0; i < 1000; i++) { 14 | list.push('a.js'); 15 | } 16 | const prefix = 'http://assets??'; 17 | const urls = concatUrl(prefix, list); 18 | (urls.length > 1).should.be.true(); 19 | for (const url of urls) { 20 | (url.length < 1600).should.be.true(); 21 | } 22 | }); 23 | 24 | 25 | it('for coverage', function() { 26 | const url = 'a.js'; 27 | const times = Math.floor(1500 / (url.length + 1)) + 1; 28 | const list = []; 29 | for (let i = 0; i < times; i++) { 30 | list.push(url); 31 | } 32 | const prefix = 'http://assets??'; 33 | const urls = concatUrl(prefix, list); 34 | urls.length.should.equal(1); 35 | }); 36 | }); 37 | 38 | -------------------------------------------------------------------------------- /packages/plover-web/lib/web/query.js: -------------------------------------------------------------------------------- 1 | const querystring = require('querystring'); 2 | const qs = require('qs'); 3 | 4 | const QUERY = Symbol('query'); 5 | 6 | 7 | module.exports = function(app) { 8 | Object.defineProperty(app.context, 'query', { 9 | get: function() { 10 | let parsed = this[QUERY]; 11 | if (!parsed) { 12 | parsed = parse(this.querystring); 13 | this[QUERY] = parsed; 14 | } 15 | return parsed; 16 | } 17 | }); 18 | }; 19 | 20 | 21 | const rSimple = /^[-\w]+$/; 22 | 23 | function parse(str) { 24 | const obj = querystring.parse(str); 25 | const keys = Object.keys(obj); 26 | const isSimple = keys.every(key => rSimple.test(key)); 27 | if (isSimple) { 28 | return filter(obj, keys); 29 | } 30 | 31 | const results = qs.parse(str, { allowDots: true }); 32 | return filter(results, keys); 33 | } 34 | 35 | 36 | function filter(obj, keys) { 37 | keys.forEach(key => { 38 | const val = obj[key]; 39 | if (val && Array.isArray(val) && rSimple.test(key)) { 40 | obj[key] = val[val.length - 1]; // use array's last item 41 | } 42 | }); 43 | return obj; 44 | } 45 | -------------------------------------------------------------------------------- /packages/plover-assets/test/fixtures/expect/list.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 |
Hello World
14 |
15 | 
16 | 
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
--------------------------------------------------------------------------------
/packages/plover/test/util/config.js:
--------------------------------------------------------------------------------
1 | const Path = require('path');
2 |
3 | const config = require('../../lib/util/config');
4 |
5 |
6 | describe('util/config', function() {
7 | it('可以载入目录中的配置信息', function() {
8 | let path = Path.join(__dirname, '../fixtures/util/config/config');
9 | let o = config.load(path);
10 | o.should.eql({
11 | app: {
12 | port: 4100
13 | },
14 |
15 | edit: {
16 | name: 'plover'
17 | },
18 |
19 | urls: {
20 | google: 'http://www.google.com',
21 | baidu: 'http://www.baidu.com'
22 | }
23 |
24 | });
25 |
26 | path = Path.join(__dirname, 'not-exists');
27 | o = config.load(path);
28 | o.should.eql({});
29 | });
30 |
31 |
32 | it('载入出错时会抛出异常', function() {
33 | const path = Path.join(__dirname, '../fixtures/util/config/invalid-config');
34 | (function() {
35 | config.load(path);
36 | }.should.throw());
37 | });
38 |
39 |
40 | it('忽略非json|js的文件', function() {
41 | const path = Path.join(__dirname, '../fixtures/util/config/ignore-config');
42 | const o = config.load(path);
43 | o.should.eql({ a: { name: 'hello' } });
44 | });
45 | });
46 |
47 |
--------------------------------------------------------------------------------
/packages/plover-router/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "plover-router",
3 | "version": "3.3.1",
4 | "description": "为Plover应用提供Restful形式API。",
5 | "scripts": {
6 | "test": "mocha --require should --reporter spec --recursive --check-leaks test/",
7 | "cov": "istanbul cover _mocha -- --require should --recursive --check-leaks test/ -R spec"
8 | },
9 | "files": [
10 | "lib"
11 | ],
12 | "dependencies": {
13 | "inflection": "^1.12.0"
14 | },
15 | "devDependencies": {
16 | "istanbul": "^1.1.0-alpha",
17 | "mocha": "^8.0.1",
18 | "plover": "^4.0.0-beta",
19 | "plover-test-mate": "^3.1.0",
20 | "plover-web": "^3.1.0",
21 | "should": "^13.2.3",
22 | "sinon": "^9.0.2"
23 | },
24 | "plover": {
25 | "plugin": "lib/plugin.js"
26 | },
27 | "repository": {
28 | "type": "git",
29 | "url": "git+https://github.com/alibaba/plover.git"
30 | },
31 | "publishConfig": {
32 | "registry": "https://registry.npmjs.org"
33 | },
34 | "author": "bencode@163.com",
35 | "license": "Apache-2.0",
36 | "bugs": {
37 | "url": "https://github.com/alibaba/plover/issues"
38 | },
39 | "homepage": "https://github.com/alibaba/plover#readme"
40 | }
41 |
--------------------------------------------------------------------------------
/packages/plover-xview/test/plugin.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const mm = require('plover-test-mate');
3 | const plugin = require('../lib/plugin');
4 |
5 |
6 | describe('plugin', () => {
7 | const applicationRoot = pathUtil.join(__dirname, 'fixtures/app');
8 | const expectRoot = pathUtil.join(__dirname, 'fixtures/expect');
9 |
10 | describe('xview', () => {
11 | const app = mm({
12 | applicationRoot,
13 | expectRoot,
14 | xview: {
15 | viewdata: {
16 | site: 'xview'
17 | }
18 | }
19 | });
20 |
21 | app.install('plover-arttemplate');
22 | app.install(plugin);
23 |
24 | app.use((ctx, next) => {
25 | ctx.csrf = 'csrf-token-123';
26 | ctx.ctoken = 'ctoken-456';
27 | return next();
28 | });
29 | app.it('/', 'index.html');
30 | });
31 |
32 |
33 | describe('coverage', () => {
34 | const app = mm({
35 | applicationRoot,
36 | expectRoot
37 | });
38 |
39 | app.install('plover-arttemplate');
40 | app.install(plugin);
41 |
42 | app.use((ctx, next) => {
43 | return next();
44 | });
45 | app.it('/index/coverage', 'coverage.html');
46 | });
47 | });
48 |
--------------------------------------------------------------------------------
/packages/plover/test/fixtures/core/app/modules/index/index.js:
--------------------------------------------------------------------------------
1 | exports.view = function() {
2 | const layout = this.query.layout;
3 | if (layout) {
4 | this.layout = layout === 'false' ? false : layout;
5 | }
6 |
7 | this.render({
8 | name: 'plover',
9 | version: '1.0.0',
10 | desc: 'nodejs webframework'
11 | });
12 | };
13 |
14 |
15 | exports.navigate = function* () {
16 | if (this.query.yield === 'true') {
17 | return yield this.navigate('view');
18 | }
19 | return this.navigate('view');
20 | };
21 |
22 |
23 | exports.banner = function() {
24 | this.render();
25 | };
26 |
27 |
28 | exports.returnFalse = function() {
29 | return false;
30 | };
31 |
32 |
33 | exports.setBody = function() {
34 | this.body = 'hello world';
35 | };
36 |
37 |
38 | exports.layoutNotFound = function() {
39 | this.layout = 'notfound';
40 | this.render();
41 | };
42 |
43 |
44 | exports.offer = function() {
45 | this.layout = false;
46 | this.view = 'elements:offer';
47 | const offer = {
48 | name: 'p1',
49 | price: 456
50 | };
51 | this.render({ offer: offer });
52 | };
53 |
54 |
55 | exports['engine-not-found'] = function() {
56 | this.render();
57 | };
58 |
--------------------------------------------------------------------------------
/packages/plover-web/test/web/query.js:
--------------------------------------------------------------------------------
1 | const Koa = require('koa');
2 | const request = require('supertest');
3 | const parseQuery = require('../../lib/web/query');
4 |
5 |
6 | describe('plover-web/web/query', function() {
7 | const app = new Koa();
8 | parseQuery(app);
9 | app.use(ctx => {
10 | ctx.body = ctx.query;
11 | });
12 | const agent = request.agent(app.callback());
13 |
14 | const tests = {
15 | 'a=1&b=2': { a: '1', b: '2' },
16 | 'a=1&a=2': { a: '2' },
17 | 'a[]=1&a[]=2': { a: ['1', '2'] },
18 | 'a[2]=1&a[1]=2&a[0]=100': { a: ['100', '2', '1'] },
19 | 'a.a=1&a.b=2': { a: { a: '1', b: '2' } }
20 | };
21 |
22 | Object.keys(tests).forEach(key => {
23 | const value = tests[key];
24 | it(key, () => {
25 | return agent.get('/?' + key).expect(value);
26 | });
27 | });
28 |
29 |
30 | it('should cached when call `ctx.query` multiple times', function() {
31 | const myapp = new Koa();
32 | parseQuery(myapp);
33 | myapp.use(ctx => {
34 | const query = ctx.query;
35 | (query === ctx.query).should.be.true();
36 | ctx.body = 'ok';
37 | });
38 | return request(myapp.callback())
39 | .get('/').expect('ok');
40 | });
41 | });
42 |
--------------------------------------------------------------------------------
/packages/plover-assets/test/helper.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const mm = require('plover-test-mate');
3 |
4 | const plugin = require('../lib/plugin');
5 |
6 |
7 | describe('helper', function() {
8 | const appRoot = pathUtil.join(__dirname, 'fixtures/app');
9 | const expectRoot = pathUtil.join(__dirname, 'fixtures/expect');
10 |
11 | it('use assets helper', function() {
12 | const app = mm({
13 | applicationRoot: appRoot,
14 | expectRoot: expectRoot,
15 | port: 60001,
16 | env: 'test'
17 | });
18 |
19 | app.install('plover-arttemplate');
20 | app.install(plugin);
21 |
22 | return app.test('/list', 'list.html');
23 | });
24 |
25 | it('assets tags with url concat', function() {
26 | const app = mm({
27 | applicationRoot: appRoot,
28 | expectRoot: expectRoot,
29 | env: 'production',
30 | port: 60002,
31 | assets: {
32 | enableConcat: true,
33 | concatItems: [
34 | { match: /^\/g\/(.*)$/, prefix: '/g/??' }
35 | ]
36 | }
37 | });
38 |
39 | app.install('plover-arttemplate');
40 | app.install(plugin);
41 |
42 | return app.test('/list', 'list-concat.html');
43 | });
44 | });
45 |
--------------------------------------------------------------------------------
/packages/plover/test/fixtures/expects/assets.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Assets
16 |
17 | child
18 |
19 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
--------------------------------------------------------------------------------
/packages/plover/test/fixtures/expects/assets-layoutejs.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Assets
16 |
17 | child
18 |
19 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
--------------------------------------------------------------------------------
/packages/plover/lib/components/startup/middleware.js:
--------------------------------------------------------------------------------
1 | const compose = require('koa-compose');
2 | const util = require('../../util/util');
3 |
4 |
5 | module.exports = function(app) {
6 | const settings = app.settings;
7 | const root = settings.applicationRoot;
8 |
9 | const list = settings.middlewares || [];
10 | for (let item of list) {
11 | // 默认级别为3
12 | if (typeof item === 'string') {
13 | item = { module: item, level: 3 };
14 | }
15 |
16 | // middleware域是为了兼容原来的配置
17 | // 建议使用module或modules属性
18 | let mws = item.module || item.modules || item.middleware;
19 | mws = Array.isArray(mws) ? mws : [mws];
20 | loadMiddlewares(app, root, mws, item);
21 | }
22 | };
23 |
24 |
25 | function loadMiddlewares(app, root, mws, options) {
26 | mws = mws.map(path => {
27 | let mw = util.loadModule(root, path);
28 | mw = util.convertMiddleware(app, mw, options);
29 | mw.$name = path;
30 | return mw;
31 | });
32 |
33 | let middleware = null;
34 | if (mws.length > 1) {
35 | middleware = compose(mws);
36 | middleware.$name = 'compose-' +
37 | mws.map(function(mw) {
38 | return mw.name || mw.$name;
39 | }).join('|');
40 | } else {
41 | middleware = mws[0];
42 | }
43 |
44 | app.use(middleware, options);
45 | }
46 |
--------------------------------------------------------------------------------
/packages/plover-util/test/route-info.js:
--------------------------------------------------------------------------------
1 | const RouteInfo = require('..').RouteInfo;
2 |
3 |
4 | describe('plover-util/lib/route-info', function() {
5 | it('#parse', function() {
6 | const parent = { module: 'index' };
7 |
8 | let route = RouteInfo.parse(parent, 'view');
9 | route.module.should.equal('index');
10 | route.action.should.equal('view');
11 |
12 | route = RouteInfo.parse(parent, 'offer:item');
13 | route.module.should.equal('offer');
14 | route.action.should.equal('item');
15 |
16 | route = RouteInfo.parse(parent, 'tools/photos#show');
17 | route.module.should.equal('tools/photos');
18 | route.action.should.equal('show');
19 |
20 | route = RouteInfo.parse(parent);
21 | route.module.should.equal('index');
22 | route.action.should.equal('view');
23 |
24 | route = RouteInfo.parse(parent, 'lib:css/tabs.css');
25 | route.module.should.equal('lib');
26 | route.action.should.equal('css/tabs.css');
27 | });
28 |
29 |
30 | it('#regular', function() {
31 | let route = { module: 'index', action: 'item' };
32 | RouteInfo.regular(route);
33 | route.url.should.equal('index:item');
34 |
35 | route = { module: 'offer' };
36 | RouteInfo.regular(route);
37 | route.url.should.equal('offer:view');
38 | });
39 | });
40 |
--------------------------------------------------------------------------------
/packages/plover-xview/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "plover-xview",
3 | "version": "3.2.0",
4 | "description": "Plover视图插件，提供页面渲染的工具函数和重用方案。",
5 | "main": "lib/index",
6 | "scripts": {
7 | "test": "mocha --require should --reporter spec --recursive --check-leaks test/",
8 | "cov": "istanbul cover _mocha -- --require should --recursive --check-leaks test/ -R spec"
9 | },
10 | "files": [
11 | "lib"
12 | ],
13 | "dependencies": {
14 | "create-tag": "^0.2.0",
15 | "escape-html": "^1.0.3",
16 | "output-formatter": "^1.0.2",
17 | "plover-util": "^1.8.0"
18 | },
19 | "devDependencies": {
20 | "istanbul": "^1.1.0-alpha",
21 | "mocha": "^8.0.1",
22 | "plover": "^4.0.0-beta",
23 | "plover-arttemplate": "^3.4.0",
24 | "plover-test-mate": "^3.0.0",
25 | "should": "^13.1.2",
26 | "supertest": "^4.0.2"
27 | },
28 | "plover": {
29 | "plugin": "lib/plugin.js"
30 | },
31 | "repository": {
32 | "type": "git",
33 | "url": "git+https://github.com/alibaba/plover.git"
34 | },
35 | "publishConfig": {
36 | "registry": "https://registry.npmjs.org"
37 | },
38 | "author": "bencode@163.com",
39 | "license": "Apache-2.0",
40 | "bugs": {
41 | "url": "https://github.com/alibaba/plover/issues"
42 | },
43 | "homepage": "https://github.com/alibaba/plover#readme"
44 | }
45 |
--------------------------------------------------------------------------------
/packages/plover-assets/test/vendor.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const plover = require('plover');
3 | const plugin = require('../lib/plugin');
4 |
5 |
6 | describe('vendor', function() {
7 | const root = pathUtil.join(__dirname, 'fixtures/vendor');
8 |
9 | it('should load assets modules', function() {
10 | const app = plover({
11 | applicationRoot: root,
12 | assets: {
13 | vendors: [
14 | 'jquery',
15 | 'bootstrap',
16 | { name: 'vue', dist: 'output' }
17 | ]
18 | }
19 | });
20 | plugin(app);
21 |
22 | const resolver = app.moduleResolver;
23 | resolver.resolve('jquery')
24 | .should.eql({
25 | name: 'jquery',
26 | version: '2.0.0',
27 | path: pathUtil.join(root, 'node_modules/jquery'),
28 | assets: true,
29 | assetsRoot: '',
30 | reload: false,
31 | build: false
32 | });
33 |
34 | resolver.resolve('bootstrap').path
35 | .should.equal(pathUtil.join(root, 'node_modules/bootstrap/dist'));
36 |
37 | resolver.resolve('vue').path
38 | .should.equal(pathUtil.join(root, 'node_modules/vue/output'));
39 | });
40 |
41 |
42 | it('coverage for no assets config', function() {
43 | const app = plover({ applicationRoot: root });
44 | plugin(app);
45 | });
46 | });
47 |
--------------------------------------------------------------------------------
/packages/plover/lib/util/config.js:
--------------------------------------------------------------------------------
1 | const fs = require('fs');
2 | const pathUtil = require('path');
3 |
4 |
5 | /**
6 | * 加载由目录中的`json`和`js`文件组织成的配置信息
7 | * 此方法采用同步方式加载文件，所以不能在请求会话中使用
8 | *
9 | * @param {String} dir - 目录
10 | * @return {Object} - 配置信息
11 | */
12 | exports.load = function(dir) {
13 | const config = {};
14 | if (!fs.existsSync(dir)) {
15 | return config;
16 | }
17 |
18 | const files = fs.readdirSync(dir);
19 | for (const file of files) {
20 | const path = pathUtil.join(dir, file);
21 | const ext = pathUtil.extname(path);
22 | const name = pathUtil.basename(file, ext);
23 | const stat = fs.statSync(path);
24 |
25 | const item = stat.isDirectory() ?
26 | tryLoadFromDir(path) : tryLoadFromFile(path);
27 |
28 | if (item) {
29 | config[name] = item;
30 | }
31 | }
32 |
33 | return config;
34 | };
35 |
36 |
37 | /*
38 | * 从目录加载配置信息
39 | */
40 | function tryLoadFromDir(dir) {
41 | let path = null;
42 | try {
43 | path = require.resolve(dir);
44 | } catch (e) {
45 | // 忽略非模块的目录
46 | return null;
47 | }
48 | return require(path);
49 | }
50 |
51 |
52 | /*
53 | * 从文件加载配置信息
54 | */
55 | function tryLoadFromFile(path) {
56 | const ext = pathUtil.extname(path);
57 | if (ext === '.js' || ext === '.json') {
58 | return require(path);
59 | }
60 | return null;
61 | }
62 |
63 |
--------------------------------------------------------------------------------
/packages/plover-assets/lib/builder/digest-assets.js:
--------------------------------------------------------------------------------
1 | const fs = require('fs-extra');
2 | const pathUtil = require('path');
3 | const crypto = require('crypto');
4 | const scanDir = require('../util/scan-dir');
5 |
6 |
7 | module.exports = function(settings, options) {
8 | const assets = settings.assets || {};
9 | if (!assets.digest) {
10 | return;
11 | }
12 |
13 | const root = options.outputDir;
14 | const list = scanDir(root);
15 |
16 | const manifest = {};
17 | for (const path of list) {
18 | const hash = digest(path);
19 | const ext = pathUtil.extname(path);
20 | const filename = pathUtil.basename(path, ext) + '-' + hash;
21 | const outpath = pathUtil.join(pathUtil.dirname(path), filename + ext);
22 | fs.copySync(path, outpath);
23 |
24 | const from = pathUtil.relative(root, path).replace(/\\/g, '/');
25 | const to = pathUtil.relative(root, outpath).replace(/\\/g, '/');
26 | manifest[from] = to;
27 | }
28 |
29 | writeManifest(root, manifest);
30 | };
31 |
32 |
33 | function digest(path) {
34 | const shasum = crypto.createHash('sha1');
35 | const buf = fs.readFileSync(path);
36 | shasum.update(buf);
37 | return shasum.digest('hex').substr(0, 10);
38 | }
39 |
40 |
41 | function writeManifest(root, manifest) {
42 | const path = pathUtil.join(root, 'manifest.json');
43 | fs.writeFileSync(path, JSON.stringify(manifest));
44 | }
45 |
--------------------------------------------------------------------------------
/packages/ploverx/test/index.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const co = require('co');
3 | const sinon = require('sinon');
4 | const request = require('supertest');
5 | const ploverx = require('../');
6 |
7 |
8 | describe('ploverx', () => {
9 | let app = null;
10 | let agent = null;
11 |
12 | before(() => {
13 | const root = pathUtil.join(__dirname, 'fixtures/app');
14 | app = ploverx({ applicationRoot: root });
15 | agent = request(app.callback());
16 | });
17 |
18 | after(() => {
19 | app.__restoreLogger(); // eslint-disable-line
20 | });
21 |
22 |
23 | it('should run app with default plugins', () => {
24 | return agent.get('/hello')
25 | .expect(/Hello<\/h1>/);
26 | });
27 |
28 |
29 | it('server static file', () => {
30 | return agent.get('/ok.txt').expect('ok!\n');
31 | });
32 |
33 |
34 | it('logger with winston', () => {
35 | return co(function* () {
36 | yield agent.get('/logger')
37 | .expect('logger info');
38 |
39 | yield agent.get('/logger?level=warn')
40 | .expect('logger warn');
41 |
42 |
43 | yield agent.get('/logger?level=error')
44 | .expect('logger error');
45 | });
46 | });
47 |
48 |
49 | it('app.run', () => {
50 | sinon.spy(app, 'listen');
51 | app.run();
52 | app.listen.calledWith(4000).should.be.true();
53 | app.listen.restore();
54 | });
55 | });
56 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "plover-packages",
3 | "version": "4.7.2",
4 | "description": "专注于模块化的NodeJs Web框架",
5 | "scripts": {
6 | "lint": "eslint .",
7 | "test": "mocha --require should --reporter spec --recursive --check-leaks --exit --timeout 5000 $(find packages/*/test -name '*.js' ! -path 'packages/*/test/fixtures/*')",
8 | "cov": "istanbul cover _mocha -- --require should --recursive --check-leaks --exit --timeout 5000 $(find packages/*/test -name '*.js' ! -path 'packages/*/test/fixtures/*')",
9 | "travis": "istanbul cover _mocha --report lcovonly -- --require should --recursive --check-leaks --exit --timeout 5000 $(find packages/*/test -name '*.js' ! -path 'packages/*/test/fixtures/*')",
10 | "ci": "npm run lint && npm run travis",
11 | "changelog": "conventional-changelog -p angular -i CHANGELOG.md -o CHANGELOG.md -s"
12 | },
13 | "repository": {
14 | "type": "git",
15 | "url": "git+https://github.com/alibaba/plover.git"
16 | },
17 | "devDependencies": {
18 | "conventional-changelog-cli": "^2.0.5",
19 | "eslint": "^5.4.0",
20 | "eslint-config-bce": "^5.0.0",
21 | "istanbul": "^1.1.0-alpha",
22 | "mocha": "^5.2.0",
23 | "should": "^13.2.3"
24 | },
25 | "author": "bencode@163.com",
26 | "license": "Apache-2.0",
27 | "bugs": {
28 | "url": "https://github.com/alibaba/plover/issues"
29 | },
30 | "homepage": "https://github.com/alibaba/plover#readme"
31 | }
32 |
--------------------------------------------------------------------------------
/packages/plover/test/core/render-helper.js:
--------------------------------------------------------------------------------
1 | const t = require('../../lib/core/render-helper').__test; // eslint-disable-line
2 | const PLACE_HOLDER = t.PLACE_HOLDER;
3 | const mergeDepends = t.mergeDepends;
4 |
5 |
6 | describe('core/render-helper', function() {
7 | const toResult = content => {
8 | return { content: content };
9 | };
10 |
11 | it('.mergeDepends', function() {
12 | const content = `
13 | ABC${PLACE_HOLDER}0000000000
14 | BCD${PLACE_HOLDER}0000000001
15 | ${PLACE_HOLDER}0000000003${PLACE_HOLDER}0000000002
16 | ${PLACE_HOLDER}00000000042${PLACE_HOLDER}0000000005988
17 | OTHER
18 | `;
19 |
20 | const rd = {};
21 | const depends = [
22 | 'child a',
23 | 'child b',
24 | 'child c',
25 | 'child d',
26 | 'child e',
27 | 'child f'
28 | ].map(toResult);
29 |
30 | const result = mergeDepends(rd, content, depends);
31 | const expect = `
32 | ABCchild a
33 | BCDchild b
34 | child dchild c
35 | child e2child f988
36 | OTHER
37 | `;
38 | result.should.be.equal(expect);
39 | });
40 |
41 |
42 | it('.mergeDepends no leading', function() {
43 | const content = `${PLACE_HOLDER}0000000000hi${PLACE_HOLDER}0000000001`;
44 | const rd = {};
45 | const depends = [
46 | 'child a',
47 | 'child b'
48 | ].map(toResult);
49 |
50 | const result = mergeDepends(rd, content, depends);
51 | const expect = 'child ahichild b';
52 | result.should.be.equal(expect);
53 | });
54 | });
55 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | Plover - 专注于模块化的NodeJs Web框架
2 | ====
3 |
4 |
5 | [![NPM version][npm-image]][npm-url]
6 | [![build status][travis-image]][travis-url]
7 | [![Test coverage][coveralls-image]][coveralls-url]
8 |
9 |
10 | Plover是一个专注于 **模块化方式构建web应用** 的NodeJs MVC web框架。不同于其它web框架，它提供完整的应用和模块化模型可以让复杂的业务功能可以方便地抽象成多个模块的方式进行独立开发，让应用可以像搭积目的方式拼装模块而成。
11 |
12 | Plover基于[koa](http://koajs.com)构建，它可以很方便地独立部署或者集成到其他koa的应用一起部署。
13 |
14 | Plover专注于 **模块化** ，为 **快速构建web应用** 提供最佳方案 。
15 |
16 |
17 | ## 参与贡献
18 |
19 | 欢迎以[Issue](https://github.com/alibaba/plover/issues)或[PullRequest](https://github.com/alibaba/plover/pulls)的方式参于共建。
20 |
21 | 提交代码前请确保通过**eslint**和**单元测试**
22 |
23 | 关于commit规范请参考[Angular Commit规范](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format)
24 | 关于lint规范请参考[eslint-config-bce](https://github.com/bencode/eslint-config-bce/blob/master/.eslintrc)
25 |
26 |
27 | ## 相关资源
28 |
29 |
30 | - [开发文档](https://github.com/ploverjs/guides)
31 | - [examples](https://github.com/ploverjs/examples)
32 | - [ploverjs](https://github.com/ploverjs)
33 |
34 |
35 |
36 | [npm-image]: https://img.shields.io/npm/v/ploverx.svg?style=flat-square
37 | [npm-url]: https://www.npmjs.com/package/ploverx
38 | [travis-image]: https://img.shields.io/travis/alibaba/plover/master.svg?style=flat-square
39 | [travis-url]: https://travis-ci.org/alibaba/plover
40 | [coveralls-image]: https://img.shields.io/codecov/c/github/alibaba/plover.svg?style=flat-square
41 | [coveralls-url]: https://codecov.io/github/alibaba/plover?branch=master
42 |
--------------------------------------------------------------------------------
/packages/plover-assets/lib/vendor.js:
--------------------------------------------------------------------------------
1 | const fs = require('fs');
2 | const pathUtil = require('path');
3 | const resolveFrom = require('resolve-from');
4 |
5 | const debug = require('debug')('plover-assets:vendor');
6 |
7 | const rNamespace = /^@[-\w]+\//;
8 |
9 |
10 | module.exports = function(app) {
11 | const settings = app.settings;
12 | const config = settings.assets || {};
13 | const vendors = config.vendors;
14 | if (!vendors) {
15 | return;
16 | }
17 |
18 | debug('try load module for assets vendor: %s', vendors);
19 | for (const item of vendors) {
20 | loadVendor(app, settings, item);
21 | }
22 | };
23 |
24 |
25 | function loadVendor(app, settings, item) {
26 | item = typeof item === 'string' ? { name: item } : item;
27 | const path = resolveFrom(
28 | settings.applicationRoot,
29 | item.name + '/package.json'
30 | );
31 | const root = pathUtil.dirname(path);
32 | const pkg = require(path);
33 |
34 | const tryPath = pathUtil.join(root, 'dist');
35 | const dist = item.dist ? pathUtil.join(root, item.dist) :
36 | isDir(tryPath) ? tryPath : root;
37 |
38 | const info = {
39 | name: pkg.name.replace(rNamespace, ''), // remove namespace
40 | version: pkg.version,
41 | path: dist,
42 | assets: true,
43 | assetsRoot: '',
44 | reload: false,
45 | build: false
46 | };
47 |
48 | debug('try load assets vendor: %o', info);
49 | app.moduleResolver.pushModule(info);
50 | }
51 |
52 |
53 | function isDir(path) {
54 | return fs.existsSync(path) && fs.statSync(path).isDirectory();
55 | }
56 |
57 |
--------------------------------------------------------------------------------
/packages/plover-util/test/lang.js:
--------------------------------------------------------------------------------
1 | const lang = require('..').Lang;
2 |
3 |
4 | /* eslint no-empty-function: 0 */
5 |
6 |
7 | describe('plover-util/lib/lang', function() {
8 | it('.isGenerator', function() {
9 | const fn = function* () {
10 | yield 1;
11 | };
12 |
13 | lang.isGenerator(fn()).should.be.true();
14 | lang.isGenerator({}).should.be.false();
15 | });
16 |
17 |
18 | it('.isGeneratorFunction', function() {
19 | const fn = function* () {
20 | yield 2;
21 | };
22 |
23 | lang.isGeneratorFunction(fn).should.be.true();
24 | lang.isGeneratorFunction(function() {}).should.be.false();
25 | });
26 |
27 |
28 | it('.isPromise', function() {
29 | lang.isPromise(new Promise(function() {})).should.be.true();
30 | lang.isPromise({ then: function() {} }).should.be.true();
31 | lang.isPromise(function() {}).should.be.false();
32 | });
33 |
34 |
35 | it('.isAsyncFunction', function() {
36 | lang.isAsyncFunction(async function() {}).should.be.true();
37 | lang.isAsyncFunction(async() => null).should.be.true();
38 | lang.isAsyncFunction(function() {}).should.be.false();
39 | lang.isAsyncFunction(1).should.be.false();
40 | (!!lang.isAsyncFunction(null)).should.be.false();
41 | });
42 |
43 |
44 | it('.isPureFunction', function() {
45 | lang.isPureFunction(function() {}).should.be.true();
46 | lang.isPureFunction(() => {}).should.be.true();
47 | lang.isPureFunction(function* () {}).should.be.false();
48 | lang.isPureFunction(async function() {}).should.be.false();
49 | });
50 | });
51 |
--------------------------------------------------------------------------------
/packages/plover-assets/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "plover-assets",
3 | "version": "5.0.0",
4 | "description": "plover assets helper and middleware",
5 | "main": "lib/index",
6 | "scripts": {
7 | "test": "mocha --require should --reporter spec --recursive --check-leaks test",
8 | "cov": "istanbul cover _mocha -- --require should --recursive --check-leaks test -R spec"
9 | },
10 | "files": [
11 | "lib"
12 | ],
13 | "dependencies": {
14 | "co": "^4.6.0",
15 | "create-tag": "^0.2.0",
16 | "debug": "^4.1.1",
17 | "fs-extra": "^9.0.1",
18 | "koa-sendfile": "^2.0.0",
19 | "lodash": "^4.17.4",
20 | "minimatch": "^3.0.4",
21 | "mz": "^2.6.0",
22 | "plover-logger": "^1.4.4",
23 | "plover-module-resolver": "^1.6.7",
24 | "plover-util": "^1.7.0",
25 | "resolve-from": "^5.0.0"
26 | },
27 | "devDependencies": {
28 | "istanbul": "^1.1.0-alpha",
29 | "mocha": "^8.0.1",
30 | "plover": "^4.0.0-beta",
31 | "plover-arttemplate": "^3.0.0",
32 | "plover-ejs": "^1.1.0",
33 | "plover-test-mate": "^3.0.0",
34 | "should": "^13.1.2",
35 | "supertest": "^4.0.2"
36 | },
37 | "plover": {
38 | "plugin": "lib/plugin.js"
39 | },
40 | "repository": {
41 | "type": "git",
42 | "url": "git+https://github.com/alibaba/plover.git"
43 | },
44 | "publishConfig": {
45 | "registry": "https://registry.npmjs.org"
46 | },
47 | "author": "bencode@163.com",
48 | "license": "Apache-2.0",
49 | "bugs": {
50 | "url": "https://github.com/alibaba/plover/issues"
51 | },
52 | "homepage": "https://github.com/alibaba/plover#readme"
53 | }
54 |
--------------------------------------------------------------------------------
/packages/ploverx/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "ploverx",
3 | "version": "5.0.0-beta.1",
4 | "description": "集成常用plover插件，提供全栈nodejs web应用开发环境。",
5 | "main": "lib/index",
6 | "bin": {
7 | "plover-build": "bin/build.js"
8 | },
9 | "scripts": {
10 | "test": "mocha --require should --reporter spec --recursive --bail --check-leaks test/",
11 | "cov": "istanbul cover _mocha -- --require should --recursive --bail --check-leaks test/ -R spec"
12 | },
13 | "files": [
14 | "bin",
15 | "lib"
16 | ],
17 | "dependencies": {
18 | "bluebird": "^3.5.0",
19 | "commander": "^5.1.0",
20 | "fs-extra": "^9.0.1",
21 | "plover": "^4.0.0-beta",
22 | "plover-arttemplate": "^3.1.0",
23 | "plover-assets": "^5.0.0",
24 | "plover-benchmark": "^1.1.0",
25 | "plover-ejs": "^1.1.0",
26 | "plover-logger": "^1.4.4",
27 | "plover-router": "^3.3.1",
28 | "plover-web": "^4.0.0",
29 | "plover-xview": "^3.0.0",
30 | "winston": "^3.0.0",
31 | "winston-daily-rotate-file": "^4.0.5"
32 | },
33 | "devDependencies": {
34 | "co": "^4.6.0",
35 | "istanbul": "^1.1.0-alpha",
36 | "mocha": "^8.0.0",
37 | "should": "^13.2.3",
38 | "sinon": "^9.0.2",
39 | "supertest": "^4.0.2"
40 | },
41 | "repository": {
42 | "type": "git",
43 | "url": "git+https://github.com/alibaba/plover.git"
44 | },
45 | "publishConfig": {
46 | "registry": "https://registry.npmjs.org"
47 | },
48 | "author": "bencode@163.com",
49 | "license": "Apache-2.0",
50 | "bugs": {
51 | "url": "https://github.com/alibaba/plover/issues"
52 | },
53 | "homepage": "https://github.com/alibaba/plover#readme"
54 | }
55 |
--------------------------------------------------------------------------------
/packages/plover-web/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "plover-web",
3 | "version": "4.0.0",
4 | "description": "【插件】集成常用web中间件，提供通用web功能。",
5 | "main": "index.js",
6 | "scripts": {
7 | "test": "mocha --require should --reporter spec --recursive --check-leaks test/",
8 | "cov": "istanbul cover _mocha -- --require should --recursive --check-leaks test/"
9 | },
10 | "files": [
11 | "lib"
12 | ],
13 | "dependencies": {
14 | "@koa/cors": "^3.1.0",
15 | "debug": "^4.0.1",
16 | "iconv-lite": "^0.6.1",
17 | "koa-bodyparser": "^4.2.0",
18 | "koa-compress": "^4.0.1",
19 | "koa-conditional-get": "^2.0.0",
20 | "koa-csrf": "^2.5.0",
21 | "koa-etag": "^3.0.0",
22 | "koa-favicon": "^2.0.0",
23 | "koa-response-time": "^2.0.0",
24 | "koa-session": "^6.0.0",
25 | "koa-static": "^5.0.0",
26 | "minimatch": "^3.0.4",
27 | "path-to-regexp": "^6.1.0",
28 | "plover-logger": "^1.4.4",
29 | "qs": "^6.5.0"
30 | },
31 | "devDependencies": {
32 | "co": "^4.6.0",
33 | "istanbul": "^1.1.0-alpha",
34 | "koa": "^2.2.0",
35 | "mocha": "^8.0.1",
36 | "plover": "^4.0.0-beta",
37 | "plover-test-mate": "^3.0.0",
38 | "should": "^13.1.2",
39 | "supertest": "^4.0.2"
40 | },
41 | "plover": {
42 | "plugin": "lib/plugin.js"
43 | },
44 | "repository": {
45 | "type": "git",
46 | "url": "git+https://github.com/alibaba/plover.git"
47 | },
48 | "publishConfig": {
49 | "registry": "https://registry.npmjs.org"
50 | },
51 | "license": "Apache-2.0",
52 | "bugs": {
53 | "url": "https://github.com/alibaba/plover/issues"
54 | },
55 | "homepage": "https://github.com/alibaba/plover#readme"
56 | }
57 |
--------------------------------------------------------------------------------
/packages/plover/test/components/plugin.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const co = require('co');
3 | const request = require('supertest');
4 |
5 | const plover = require('../../');
6 |
7 |
8 | describe('components/plugin', function() {
9 | const root = pathUtil.join(__dirname, '../fixtures/components/plugin');
10 | const settings = { applicationRoot: root };
11 |
12 | it('可以加载并初始化插件', function() {
13 | const app = plover(settings);
14 | const agent = request(app.callback());
15 |
16 | return co(function* () {
17 | yield agent.get('/test')
18 | .expect('hello test');
19 |
20 | yield agent.get('/test-withorder')
21 | .expect('hello test-withorder');
22 |
23 | yield agent.get('/last')
24 | .expect('last');
25 | });
26 | });
27 |
28 |
29 | it('可以通过配置禁掉插件', function() {
30 | const app = plover({
31 | applicationRoot: root,
32 | plugins: {
33 | test: false,
34 | 'test-withorder': {
35 | enable: false
36 | }
37 | }
38 | });
39 |
40 | const agent = request(app.callback());
41 |
42 | return co(function* () {
43 | yield agent.get('/test')
44 | .expect('last');
45 | });
46 | });
47 |
48 |
49 | it('还可以通过disable禁掉插件', function() {
50 | const app = plover({
51 | applicationRoot: root,
52 | plugins: {
53 | test: { disable: true }
54 | }
55 | });
56 |
57 | const agent = request(app.callback());
58 | return co(function* () {
59 | yield agent.get('/test')
60 | .expect('last');
61 |
62 | yield agent.get('/test-withorder')
63 | .expect('hello test-withorder');
64 | });
65 | });
66 | });
67 |
68 |
--------------------------------------------------------------------------------
/packages/ploverx/test/fixtures/app/config/app.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 |
3 |
4 | /**
5 | * 服务器相关配置
6 | */
7 | /*
8 | exports.server = {
9 | // http server启动端口号
10 | port: 4000
11 | };
12 | */
13 |
14 |
15 | /**
16 | * 日志配置
17 | */
18 | exports.loggers = {
19 | system: {
20 | match: /^plover/,
21 | level: 'info',
22 | consoleLevel: 'warn',
23 | file: pathUtil.join(__dirname, '../logs/plover.log'),
24 | errorFile: pathUtil.join(__dirname, '../logs/plover-error.log')
25 | },
26 |
27 | app: {
28 | level: 'info',
29 | consoleLevel: 'info',
30 | file: pathUtil.join(__dirname, '../logs/app.log'),
31 | errorFile: pathUtil.join(__dirname, '../logs/app-error.log')
32 | }
33 | };
34 |
35 |
36 | /**
37 | * 服务
38 | */
39 | exports.services = {
40 | };
41 |
42 |
43 | /**
44 | * 模板帮助方法
45 | */
46 | exports.helpers = {
47 | };
48 |
49 |
50 | /**
51 | * web中间件相关配置
52 | */
53 | exports.web = {
54 | // 用于设置app.keys, 实际应用需要重新产生一个
55 | // http://koajs.com/#app.keys
56 | keys: ['17e6b6bc6129097383dcad4fa1602233'],
57 |
58 | // https://github.com/koajs/favicon
59 | favicon: pathUtil.join(__dirname, '../public/favicon.ico'),
60 |
61 | // https://github.com/koajs/response-time
62 | rtime: {},
63 |
64 | static: {}
65 | };
66 |
67 |
68 | /**
69 | * 安全相关配置
70 | */
71 | exports.security = {
72 | };
73 |
74 |
75 | /**
76 | * plover-assets插件相关配置
77 | */
78 | exports.assets = {
79 | // 是否启用plover-assets中间件模块
80 | // 启动时静态资源由plover应用处理
81 | // 用于不将前端资源交给cdn处理的简单应用场景
82 | // 在开发模式下总是开启的，方便开发。
83 | enableMiddleware: true,
84 |
85 | // 是否开启urlConcat功能，生效于非开发环境
86 | enableConcat: true,
87 |
88 | // 当打开urlConcat功能时使用
89 | concatItems: [
90 | { match: /^\/g\/(.*)$/, prefix: '/g/??' }
91 | ]
92 | };
93 |
--------------------------------------------------------------------------------
/packages/plover/test/components/startup/index.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const sinon = require('sinon');
3 |
4 |
5 | const StartupComponent = require('../../../lib/components/startup');
6 |
7 |
8 | describe('components/startup', function() {
9 | it('plover会根据配置加载各种部件(middleware, service等)', function() {
10 | const settings = getSettings();
11 |
12 | const app = createMockApp(settings);
13 | new StartupComponent(app); // eslint-disable-line
14 |
15 | app.addRoute.called.should.be.true();
16 | app.use.callCount.should.equal(1);
17 | app.addService.called.should.be.true();
18 | app.addFilter.called.should.be.true();
19 | app.addHelper.called.should.be.true();
20 | });
21 | });
22 |
23 |
24 | function getSettings() {
25 | const root = pathUtil.join(__dirname, '../../fixtures/components/startup');
26 |
27 | const settings = {
28 | applicationRoot: root,
29 |
30 | routes: {
31 | '/offer/:offerId': 'offer/view'
32 | },
33 |
34 | middlewares: [
35 | './lib/middlewares/hello.js'
36 | ],
37 |
38 | services: {
39 | productService: './lib/services/product.js'
40 | },
41 |
42 | filters: [
43 | './lib/filters/box.js',
44 | {
45 | module: './lib/filters/api.js',
46 | match: '/api'
47 | }
48 | ],
49 |
50 | helpers: {
51 | priceHelper: './lib/helpers/price.js'
52 | }
53 | };
54 |
55 | return settings;
56 | }
57 |
58 |
59 | function createMockApp(settings) {
60 | const app = {
61 | settings: settings,
62 | config: {},
63 |
64 | addRoute: sinon.spy(),
65 | use: sinon.spy(),
66 | addService: sinon.spy(),
67 | addFilter: sinon.spy(),
68 | addHelper: sinon.spy()
69 | };
70 |
71 | return app;
72 | }
73 |
74 |
--------------------------------------------------------------------------------
/packages/plover/lib/util/invoker.js:
--------------------------------------------------------------------------------
1 | const lang = require('plover-util/lib/lang');
2 |
3 | const logger = require('plover-logger')('plover:util/invoker');
4 |
5 |
6 | /**
7 | * 用于遍历调用拦截器方法
8 | *
9 | * @param {Array} list - 挡截器列表
10 | * @param {String} method - 方法名
11 | * @param {ActionContext} context - 上下文
12 | * @param {Boolean} reverse - 是否逆序调用
13 | * @return {NavigateResult} - 结果
14 | */
15 | /* eslint complexity: [2, 10] */
16 | exports.filter = function* filter(list, method, context, reverse) {
17 | const ctx = context.ctx || {}; // for ActionContext in unit test without ctx field
18 | for (let i = 0, c = list.length; i < c; i++) {
19 | const index = reverse ? c - i - 1 : i;
20 | const item = list[index];
21 | const fn = item.filter[method];
22 | if (fn && (!item.match || item.match.test(ctx.path))) {
23 | const name = item.name || item.filter.name || '';
24 | logger.debug('%s.%s', name, method);
25 | const result = yield* exports.run(fn, context);
26 | if (exports.isSuccess(result)) {
27 | return result;
28 | }
29 | }
30 | }
31 | return null;
32 | };
33 |
34 |
35 | exports.run = function* (fn, context) {
36 | return lang.isAsyncFunction(fn) ? yield fn.call(context, context) :
37 | lang.isGeneratorFunction(fn) ? yield* fn.call(context, context) :
38 | fn.call(context, context);
39 | };
40 |
41 |
42 | /**
43 | * 判断controller或filter的结果是否ok了
44 | * 如果ok了，就表示得到了想要的结果需要break了
45 | *
46 | * @param {NavigateResult} result - 结果
47 | * @return {Boolean} - 是否结束
48 | */
49 | exports.isSuccess = function(result) {
50 | // 快速测试，大多数是这种情况
51 | if (result === undefined || result === null) {
52 | return false;
53 | }
54 | return result === false || typeof result === 'object';
55 | };
56 |
57 |
--------------------------------------------------------------------------------
/packages/plover/test/fixtures/core/app/modules/child/index.js:
--------------------------------------------------------------------------------
1 | exports.view = function() {
2 | const items = [
3 | {
4 | name: 'Javascript高级程序设计',
5 | price: 84.2
6 | },
7 |
8 | {
9 | name: 'Javascript语言精粹',
10 | price: 24.2
11 | }
12 | ];
13 |
14 | this.render({
15 | items: items,
16 | formatPrice: formatPrice
17 | });
18 | };
19 |
20 |
21 | exports.header = function() {
22 | const title = this.query.title;
23 | this.render({ title: title });
24 | };
25 |
26 |
27 | exports.panel = function() {
28 | const slowText = new Promise(resolve => {
29 | setTimeout(() => {
30 | resolve('slow text')
31 | }, 10);
32 | });
33 | this.render({ slowText: slowText });
34 | };
35 |
36 |
37 | exports.books = function* () {
38 | yield sleep(10);
39 | const data = {
40 | books: ['book a', 'book b', 'book c']
41 | };
42 | this.render(data);
43 | };
44 |
45 |
46 | exports.show = function* () {
47 | yield sleep(10);
48 | this.render();
49 | }
50 |
51 |
52 | exports['view-not-found'] = function() {
53 | this.render();
54 | };
55 |
56 |
57 | exports.renderChildError = function() {
58 | this.render();
59 | };
60 |
61 |
62 | exports.renderError = function() {
63 | throw new Error('some error happen');
64 | };
65 |
66 |
67 | exports.renderAsyncChildError = function() {
68 | this.render();
69 | };
70 |
71 | exports.renderAsyncError = function* () {
72 | yield sleep(10);
73 | throw new Error('some error happen');
74 | };
75 |
76 |
77 | exports['not-found'] = function* () {
78 | yield sleep(10);
79 | return false;
80 | };
81 |
82 |
83 | function formatPrice(v) {
84 | return v + '元';
85 | }
86 |
87 |
88 | function sleep(time) {
89 | return new Promise(resolve => {
90 | setTimeout(resolve, time);
91 | });
92 | }
93 |
--------------------------------------------------------------------------------
/packages/plover-web/test/web/csrf.js:
--------------------------------------------------------------------------------
1 | const Koa = require('koa');
2 | const request = require('supertest');
3 | const co = require('co');
4 |
5 |
6 | /* eslint max-nested-callbacks: [2, 4] */
7 |
8 |
9 | describe('plover-web/web/csrf', () => {
10 | const app = new Koa();
11 | app.keys = ['test'];
12 | app.use(require('koa-session')({}, app));
13 | require('koa-csrf')(app);
14 |
15 | const opts = {
16 | match: '/csrf',
17 |
18 | ignore: [
19 | '/ignore/*',
20 | /^\/skip\//
21 | ]
22 | };
23 |
24 | app.use(require('../../lib/web/csrf').middleware(opts));
25 | app.use(async(ctx, next) => {
26 | if (ctx.path === '/getcsrf') {
27 | ctx.body = ctx.csrf;
28 | } else {
29 | await next();
30 | }
31 | });
32 | app.use(ctx => {
33 | ctx.body = 'ok';
34 | });
35 |
36 | const agent = request.agent(app.callback());
37 |
38 | it('`get` ignore csrf check for default', () => {
39 | return agent.get('/').expect('ok');
40 | });
41 |
42 |
43 | it('`post` should check csrf for default', () => {
44 | return agent.post('/').expect(403);
45 | });
46 |
47 |
48 | it('config match force csrf check', () => {
49 | return agent.get('/csrf').expect(403);
50 | });
51 |
52 |
53 | it('config ignore skip csrf check', () => {
54 | return agent.post('/ignore/123').expect('ok');
55 | });
56 |
57 |
58 | it('config ignore rules with regexp', () => {
59 | return agent.post('/skip/123').expect('ok');
60 | });
61 |
62 |
63 | it('pass csrf check', () => {
64 | return co(function* () {
65 | let csrf = false;
66 | yield agent.get('/getcsrf').expect(o => {
67 | csrf = o.text;
68 | });
69 | csrf.should.not.empty();
70 | yield agent.post('/?_csrf=' + csrf).expect('ok');
71 | });
72 | });
73 | });
74 |
--------------------------------------------------------------------------------
/packages/plover-module-resolver/lib/util.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const fs = require('fs');
3 |
4 |
5 | /**
6 | * 判断是否plover模块
7 | * 在package.json中有plover配置信息，就认为是plover模块
8 | *
9 | * @param {String} path - 目录
10 | * @return {Boolean} - 是否plover模块
11 | */
12 | exports.isPloverModule = function(path) {
13 | const pkgpath = pathUtil.join(path, 'package.json');
14 | if (fs.existsSync(pkgpath)) {
15 | const pinfo = require(pkgpath);
16 | return !!(pinfo && pinfo.plover);
17 | }
18 | return false;
19 | };
20 |
21 |
22 | /**
23 | * 判断是否目录
24 | *
25 | * @param {String} path - 路径
26 | * @return {Boolean} - 是否目录
27 | */
28 | exports.isDir = function(path) {
29 | return fs.existsSync(path) && fs.statSync(path).isDirectory();
30 | };
31 |
32 |
33 | /**
34 | * 判断是否空目录
35 | *
36 | * @param {String} path - 路径
37 | * @return {Boolean} - 是否目录
38 | */
39 | exports.isEmptyDir = function(path) {
40 | const files = fs.readdirSync(path);
41 | for (const file of files) {
42 | if (/^[-\w]/.test(file)) {
43 | return false;
44 | }
45 | }
46 | return true;
47 | };
48 |
49 |
50 | /**
51 | * 深度优先遍历出文件夹中的文件，忽略隐藏文件
52 | *
53 | * @param {String} path - 目录
54 | * @return {Array} - 文件列表
55 | */
56 | exports.scan = function(path) {
57 | const list = [];
58 | if (!exports.isDir(path)) {
59 | return list;
60 | }
61 |
62 | const files = fs.readdirSync(path);
63 | for (const file of files) {
64 | if (!file.startsWith('.')) {
65 | const thispath = pathUtil.join(path, file);
66 | const stat = fs.statSync(thispath);
67 | if (stat.isFile()) {
68 | list.push(thispath);
69 | } else { // directory
70 | list.push.apply(list, exports.scan(thispath));
71 | }
72 | }
73 | }
74 |
75 | return list;
76 | };
77 |
78 |
--------------------------------------------------------------------------------
/packages/ploverx/bin/build.js:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env node
2 |
3 | const assert = require('assert');
4 | const pathUtil = require('path');
5 | const co = require('co');
6 | const Builder = require('plover-assets/lib/builder');
7 | const util = require('../lib/util');
8 |
9 |
10 | /* eslint no-console: 0, no-process-exit: 0, no-process-env: 0 */
11 |
12 |
13 | module.exports = build;
14 |
15 |
16 | function build(opts) {
17 | opts = Object.assign({}, opts);
18 |
19 | const appRoot = opts.applicationRoot;
20 | assert(appRoot, '`options.applicationRoot` required');
21 | opts.outputDir = opts.outputDir || pathUtil.join(appRoot, 'public');
22 |
23 | const settings = util.loadSettings(appRoot);
24 | console.log('build assets %s -> %s', appRoot, opts.outputDir);
25 |
26 | const builder = new Builder(settings);
27 | return co(function* () {
28 | yield builder.buildApp(opts);
29 | });
30 | }
31 |
32 |
33 | /* istanbul ignore next */
34 | if (require.main === module) {
35 | // 标识编译过程，可在配置中使用
36 | process.env.PLOVER_ASSETS_BUILD = 'true';
37 |
38 | const program = require('commander');
39 | program
40 | .version(require('../package.json').version)
41 | .option('--applicationRoot [applicationRoot]')
42 | .option('-o, --outputDir [outputDir]', 'output dir')
43 | .parse(process.argv);
44 |
45 | const appRoot = program.applicationRoot ?
46 | pathUtil.resolve(program.applicationRoot) : process.cwd();
47 | const outputDir = program.outputDir && pathUtil.resolve(program.outputDir);
48 |
49 | const opts = {
50 | applicationRoot: appRoot,
51 | outputDir: outputDir
52 | };
53 |
54 | build(opts)
55 | .then(() => console.log('BUILD_SUCCESS'))
56 | .catch(e => {
57 | console.error('BUILD_ERROR');
58 | e = e || {};
59 | console.error(e.stack || e);
60 | process.exit(1);
61 | });
62 | }
63 |
64 |
--------------------------------------------------------------------------------
/packages/plover/test/fixtures/expects/child-production.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Books
5 |
6 |
7 | Books
8 |
9 | Big
10 |
11 | - 126 Hi
12 |
13 |
14 | Show
15 | show is view
16 |
17 |
18 |
19 | - Name: Javascript高级程序设计
20 | Price: 84.2元
21 |
22 | - Name: Javascript语言精粹
23 | Price: 24.2元
24 |
25 |
26 |
27 |
28 |
29 |
30 | Panel
31 |
32 |
33 | - 0 book a
34 | - 1 book b
35 | - 2 book c
36 |
37 |
38 |
39 | Big 2
40 |
41 | - 126 Hi
42 |
43 |
44 | Show
45 | show is view
46 |
47 |
48 |
49 |
50 |
62 |
63 |
64 |
65 |
--------------------------------------------------------------------------------
/packages/plover/test/core/helper-container.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const request = require('supertest');
3 |
4 | const plover = require('../../');
5 |
6 | const equal = require('../util').equalWith;
7 |
8 |
9 | describe('core/helper-container', function() {
10 | const root = pathUtil.join(__dirname, '../fixtures/core/app');
11 | const app = plover({
12 | applicationRoot: root,
13 | helpers: {
14 | urlHelper: './lib/helpers/url-helper',
15 | xview: './lib/helpers/xview',
16 | cms: './lib/helpers/cms',
17 | assets: './lib/helpers/assets'
18 | }
19 | });
20 |
21 |
22 | it('use helper', function() {
23 | return request(app.callback())
24 | .get('/helper')
25 | .expect(equal('helper.html'));
26 | });
27 |
28 |
29 | it('async render', function() {
30 | return request(app.callback())
31 | .get('/helper/async')
32 | .expect(equal('helper-async.html'));
33 | });
34 |
35 |
36 | it('with assets', function() {
37 | return request(app.callback())
38 | .get('/assets')
39 | .expect(equal('assets.html'));
40 | });
41 |
42 |
43 | it('render assets use layoutejs', function() {
44 | return request(app.callback())
45 | .get('/assets?layoutejs=true')
46 | .expect(equal('assets-layoutejs.html'));
47 | });
48 |
49 |
50 | it('navigate with transform assets', function() {
51 | return request(app.callback())
52 | .get('/assets/navigate')
53 | .expect(equal('assets-navigate.html'));
54 | });
55 |
56 |
57 | it('disable assets', function() {
58 | const myapp = plover({
59 | applicationRoot: root,
60 | helpers: {
61 | assets: './lib/helpers/assets'
62 | },
63 | assets: {
64 | disableAutowire: true
65 | }
66 | });
67 | return request(myapp.callback())
68 | .get('/assets')
69 | .expect(equal('assets-disable-autowaire.html'));
70 | });
71 | });
72 |
--------------------------------------------------------------------------------
/packages/plover-web/lib/web/csrf.js:
--------------------------------------------------------------------------------
1 | const debug = require('debug')('plover-web:web/csrf');
2 | const util = require('../util/util');
3 |
4 |
5 | /* eslint no-underscore-dangle: 0 */
6 |
7 |
8 | module.exports = function(app, config) {
9 | config = config || {};
10 | if (config.enable === false) {
11 | return;
12 | }
13 |
14 | debug('install csrf module: %o', config);
15 | require('koa-csrf')(app.server, config);
16 | const mw = middleware(config);
17 | app.use(mw, { level: 0 });
18 | };
19 |
20 |
21 | module.exports.middleware = middleware;
22 | //~
23 |
24 |
25 | function middleware(opts) {
26 | opts = opts || {};
27 | const matchRules = util.regularRules(opts.match);
28 | const ignoreRules = util.regularRules(opts.ignore);
29 |
30 | debug('rules, match: %o, ignore: %o', matchRules, ignoreRules);
31 |
32 | return function PloverCsrf(ctx, next) {
33 | // 如果match匹配了，就检查csrf
34 | if (util.testRules(matchRules, ctx.path)) {
35 | return nextWithAssert(ctx, next);
36 | }
37 |
38 | // 忽略 get, head, options 请求
39 | const method = ctx.method;
40 | if (method === 'GET' ||
41 | method === 'HEAD' ||
42 | method === 'OPTIONS') {
43 | return next();
44 | }
45 |
46 | // multipart自己处理csrf
47 | if (ctx.is('multipart')) {
48 | return next();
49 | }
50 |
51 | // 如果ignore规则匹配，就忽略检查
52 | if (util.testRules(ignoreRules, ctx.path)) {
53 | debug('ignore check csrf ctoken: %s', ctx.path);
54 | return next();
55 | }
56 |
57 | return nextWithAssert(ctx, next);
58 | };
59 | }
60 |
61 |
62 | function nextWithAssert(ctx, next) {
63 | const assertCsrf = ctx.assertCsrf || ctx.assertCSRF;
64 | if (assertCsrf) {
65 | const body = ctx.request.body || {};
66 | debug('check csrf: %s, %s', ctx.path, body._csrf);
67 | assertCsrf.call(ctx, body);
68 |
69 | // 设置标识域，表示已校验过ctoken
70 | ctx[util.CSRF_CHECKED] = true;
71 | }
72 | return next();
73 | }
74 |
--------------------------------------------------------------------------------
/packages/plover/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "plover",
3 | "version": "4.0.0",
4 | "description": "专注于模块化的NodeJs Web框架",
5 | "main": "lib/index.js",
6 | "scripts": {
7 | "test": "mocha --require should --reporter spec --recursive --check-leaks --timeout 5000 $(find test -name '*.js' ! -path 'test/fixtures/*')",
8 | "cov": "istanbul cover _mocha -- --require should --recursive --check-leaks --exit --timeout 5000 $(find test -name '*.js' ! -path 'test/fixtures/*') -R spec"
9 | },
10 | "files": [
11 | "lib"
12 | ],
13 | "dependencies": {
14 | "antsort": "^1.1.2",
15 | "co": "^4.6.0",
16 | "debug": "^4.1.1",
17 | "delegates": "^1.0.0",
18 | "depd": "^2.0.0",
19 | "escape-html": "^1.0.3",
20 | "jsonp-body": "^1.0.0",
21 | "koa": "^2.5.2",
22 | "koa-compose": "^4.1.0",
23 | "koa-convert": "^1.2.0",
24 | "minimatch": "^3.0.4",
25 | "mz": "^2.6.0",
26 | "output-formatter": "^1.0.1",
27 | "path-to-regexp": "^6.1.0",
28 | "plover-logger": "^1.7.0",
29 | "plover-module-resolver": "^2.0.0",
30 | "plover-util": "^1.7.0",
31 | "ready-callback": "^2.1.0",
32 | "resolve-from": "^5.0.0"
33 | },
34 | "devDependencies": {
35 | "istanbul": "^1.1.0-alpha",
36 | "koa-bodyparser": "^4.2.1",
37 | "koa-session": "^6.0.0",
38 | "mocha": "^8.0.1",
39 | "plover-arttemplate": "^3.0.0",
40 | "plover-ejs": "^1.1.0",
41 | "semver": "^7.3.2",
42 | "should": "^13.2.3",
43 | "sinon": "^9.0.2",
44 | "supertest": "^4.0.2"
45 | },
46 | "engines": {
47 | "node": ">=7.6.0"
48 | },
49 | "publishConfig": {
50 | "registry": "https://registry.npmjs.org"
51 | },
52 | "repository": {
53 | "type": "git",
54 | "url": "git+https://github.com/alibaba/plover.git"
55 | },
56 | "author": "bencode@163.com",
57 | "license": "Apache-2.0",
58 | "bugs": {
59 | "url": "https://github.com/alibaba/plover/issues"
60 | },
61 | "homepage": "https://github.com/alibaba/plover#readme"
62 | }
63 |
--------------------------------------------------------------------------------
/packages/plover/test/fixtures/expects/child.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Books
5 |
6 |
7 | Books
8 |
9 | Big
10 |
11 | - 126 Hi
12 |
13 |
14 | Show
15 | show is view
16 |
17 |
18 |
19 | - Name: Javascript高级程序设计
20 | Price: 84.2元
21 |
22 | - Name: Javascript语言精粹
23 | Price: 24.2元
24 |
25 |
26 |
27 | Not Found: child:not-found:view
28 |
29 |
30 | Not Found: child:not-found
31 |
32 |
33 | Not Found: child:child:not-found
34 |
35 |
36 | Panel
37 |
38 |
39 | - 0 book a
40 | - 1 book b
41 | - 2 book c
42 |
43 |
44 |
45 | Big 2
46 |
47 | - 126 Hi
48 |
49 |
50 | Show
51 | show is view
52 |
53 |
54 |
55 |
56 |
68 |
69 |
70 |
71 |
--------------------------------------------------------------------------------
/packages/plover/lib/components/plugin.js:
--------------------------------------------------------------------------------
1 | const assert = require('assert');
2 | const pathUtil = require('path');
3 | const antsort = require('antsort');
4 |
5 |
6 | const logger = require('plover-logger')('plover:components/plugin');
7 |
8 |
9 | class Plugin {
10 | /**
11 | * 加载插件
12 | *
13 | * 插件是一个plover模块
14 | * plover模块是一个`package.json`中配置plover域的node模块
15 | * 插件要求plover域中配置属性`plugin: path`
16 | *
17 | * @param {PloverApplication} app - Plover应用对象
18 | */
19 | constructor(app) {
20 | let plugins = getEnablePlugins(app);
21 | plugins = antsort(plugins, { defaultLevel: 3 });
22 | logger.info('install plugins:\n%o', plugins.map(info => info.name));
23 |
24 | for (const info of plugins) {
25 | logger.info('startup plugin: %s', info.name);
26 | const path = pathUtil.join(info.path, info.plugin);
27 | const fn = require(path);
28 | assert(
29 | typeof fn === 'function',
30 | 'plugin module should be a function: ' + path
31 | );
32 | fn(app.proto);
33 | }
34 | }
35 | }
36 |
37 |
38 | module.exports = Plugin;
39 |
40 |
41 | function getEnablePlugins(app) {
42 | const config = app.settings.plugins || {};
43 |
44 | const modules = app.moduleResolver.list();
45 | const plugins = modules.filter(info => {
46 | if (!info.plugin) {
47 | return false;
48 | }
49 |
50 | /*
51 | * 可以通过配置关闭插件
52 | *
53 | * ```
54 | * {
55 | * plugins: {
56 | * [name]: false
57 | * [name]: {
58 | * enable: false
59 | * }
60 | * [name]: {
61 | * disable: true
62 | * }
63 | * }
64 | * }
65 | * ```
66 | */
67 | const name = info.name;
68 | const pconfig = config[name];
69 | if (pconfig === false ||
70 | (pconfig && pconfig.enable === false) ||
71 | (pconfig && pconfig.disable)) {
72 | return false;
73 | }
74 |
75 | return true;
76 | });
77 |
78 | return plugins;
79 | }
80 |
81 |
--------------------------------------------------------------------------------
/packages/plover-module-resolver/lib/get-module-base-info.js:
--------------------------------------------------------------------------------
1 | const assert = require('assert');
2 | const fs = require('fs');
3 | const pathUtil = require('path');
4 |
5 | const util = require('./util');
6 |
7 |
8 | const rNamespace = /^@[-\w]+\//;
9 |
10 |
11 | /**
12 | * 取得模块基本信息
13 | *
14 | * @param {String} path - 模块路径
15 | * @param {Object} options - 可选参数
16 | * - ensure 需要验证package.json plover属性必须存在
17 | * - namespace 匿名模块名字空间
18 | * @return {Object} - 模块基本信息
19 | * - name
20 | * - version
21 | * - path
22 | */
23 | module.exports = function(path, options) {
24 | if (!util.isDir(path) || util.isEmptyDir(path)) {
25 | return null;
26 | }
27 |
28 | options = options || {};
29 | if (options.ensure && !util.isPloverModule(path)) {
30 | return null;
31 | }
32 |
33 | return getFromPackage(path) || getFromDeduce(path, options);
34 | };
35 |
36 |
37 | function getFromPackage(path) {
38 | const pkgPath = pathUtil.join(path, 'package.json');
39 | // 根据package.json生成基本信息
40 | if (!fs.existsSync(pkgPath)) {
41 | return null;
42 | }
43 |
44 | const o = readJson(pkgPath);
45 | const info = o.plover || {};
46 |
47 | // plover.name配置了就使用它，否则从name属性去掉名字空间得到
48 | info.name = info.name || o.name.replace(rNamespace, '');
49 | info.version = info.version || o.version || '0.0.0';
50 | info.path = path;
51 |
52 | assert(info.name, 'name required');
53 |
54 | return info;
55 | }
56 |
57 |
58 | function getFromDeduce(path, options) {
59 | const info = {
60 | name: pathUtil.basename(path),
61 | version: '0.0.0',
62 | path: path
63 | };
64 |
65 | const namespace = options.namespace;
66 | if (namespace) {
67 | info.name = namespace + '/' + info.name;
68 | info.namespace = namespace;
69 | }
70 |
71 | return info;
72 | }
73 |
74 |
75 | function readJson(path) {
76 | const body = fs.readFileSync(path, 'utf-8');
77 | try {
78 | return JSON.parse(body);
79 | } catch (e) {
80 | throw new Error('invalid json file: ' + path);
81 | }
82 | }
83 |
84 |
--------------------------------------------------------------------------------
/packages/plover-assets/lib/util/util.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const fs = require('mz/fs');
3 | const crypto = require('crypto');
4 |
5 |
6 | exports.getTempDir = function(settings) {
7 | return pathUtil.join(settings.applicationRoot, 'tmp');
8 | };
9 |
10 |
11 | exports.getPublicDir = function(settings) {
12 | return (settings.assets || {}).publicRoot ||
13 | pathUtil.join(settings.applicationRoot, 'public');
14 | };
15 |
16 |
17 | exports.getAssetsPrefix = function(settings) {
18 | return (settings.assets || {}).prefix || '/g';
19 | };
20 |
21 |
22 | exports.loadBuildConfig = function* (info) {
23 | const path = pathUtil.join(info.path, 'build.js');
24 | const config = (yield fs.exists(path)) ? require(path) : {};
25 | const obj = info.build ? info.build :
26 | info.build === false ? { enable: false } : null;
27 | return Object.assign({}, config, obj);
28 | };
29 |
30 |
31 | const rQueryStamp = /\?.*$/;
32 | const rSlash = /^\//;
33 |
34 | /**
35 | * 取得缓存地址
36 | *
37 | * @param {String} path - 原始地址
38 | * @param {Object} settings - 配置
39 | * @return {String} - 缓存地址
40 | */
41 | exports.getCachePath = function(path, settings) {
42 | const tmpdir = exports.getTempDir(settings);
43 | const shasum = crypto.createHash('sha1');
44 | shasum.update(path);
45 | const filename = shasum.digest('hex') +
46 | pathUtil.extname(path).replace(rQueryStamp, '');
47 | return pathUtil.join(tmpdir, filename);
48 | };
49 |
50 |
51 | exports.loadManifest = function(settings) {
52 | const publicDir = exports.getPublicDir(settings);
53 | const prefix = exports.getAssetsPrefix(settings);
54 | const path = settings.assets.manifest ||
55 | pathUtil.join(publicDir, prefix, 'manifest.json');
56 | if (!fs.existsSync(path)) {
57 | return null;
58 | }
59 |
60 | const map = new Map();
61 | const obj = JSON.parse(fs.readFileSync(path, 'utf-8'));
62 | for (const key in obj) {
63 | const url = obj[key].replace(rSlash, '');
64 | map.set(key, url);
65 | }
66 | return map;
67 | };
68 |
--------------------------------------------------------------------------------
/packages/plover-xview/lib/helper.js:
--------------------------------------------------------------------------------
1 | const escape = require('escape-html');
2 | const fmt = require('output-formatter');
3 | const SafeString = require('plover-util/lib/safe-string');
4 | const assign = require('plover-util/lib/assign');
5 |
6 |
7 | const RD = Symbol('rd');
8 | const VIEW_DATA = Symbol('viewdata');
9 |
10 |
11 | /*
12 | * 此方法在由框架自动调用，用于注入一些帮助方法
13 | *
14 | * 视图中可以使用以下数据和方法
15 | *
16 | * - csrf
17 | * - ctoken
18 | *
19 | * - $.viewdata(name, value)
20 | * - $.viewdata(map)
21 | */
22 |
23 | class Helper {
24 | static $init(rd) {
25 | rd.data.csrf = rd.ctx.csrf;
26 | rd.data.ctoken = rd.ctx.ctoken;
27 | }
28 |
29 |
30 | constructor(rd) {
31 | this[RD] = rd;
32 | }
33 |
34 |
35 | viewdata(...args) {
36 | const layoutData = this[RD].layout.data;
37 | const cache = layoutData[VIEW_DATA] || (layoutData[VIEW_DATA] = {});
38 | const type = typeof args[0];
39 | if (type === 'string') {
40 | cache[args[0]] = args[1];
41 | } else if (type === 'object' && args[0]) {
42 | assign(cache, args[0]);
43 | } else {
44 | console.warn(fmt.yellow('invalid viewdata: '), args[0]); // eslint-disable-line
45 | }
46 | return '';
47 | }
48 |
49 |
50 | metaTags(opts) {
51 | opts = opts || {};
52 | const rd = this[RD];
53 | const ctx = rd.ctx;
54 | const settings = ctx.settings;
55 | const config = settings.xview || {};
56 |
57 | let tags = ``;
58 | if (ctx.csrf) {
59 | tags += `\n`;
60 | }
61 | if (ctx.ctoken) {
62 | tags += `\n`;
63 | }
64 |
65 | if (opts.viewdata) {
66 | const data = {};
67 | config.viewdata && assign(data, config.viewdata);
68 | assign(data, rd.layout.data[VIEW_DATA]);
69 | tags += `\n`; // eslint-disable-line
70 | }
71 |
72 | return new SafeString(tags);
73 | }
74 | }
75 |
76 |
77 | module.exports = Helper;
78 |
--------------------------------------------------------------------------------
/packages/plover/lib/core/helper-container.js:
--------------------------------------------------------------------------------
1 | const logger = require('plover-logger')('plover:core/helper-container');
2 | const util = require('../util/util');
3 |
4 |
5 | const RD = Symbol('rd');
6 | const VIEW_RENDER = Symbol('viewRender');
7 | const NAVIGATOR = Symbol('navigator');
8 | const APP = Symbol('app');
9 | const CACHE = Symbol('cache');
10 |
11 | const initList = [];
12 |
13 | class HelperContainer {
14 | /**
15 | * Helper容器，用于管理helper对象
16 | * 模板中只有用到某个helper才去构造
17 | *
18 | * @param {RenderData} rd - 渲染环境
19 | * @param {ViewRender} viewRender - viewRender
20 | * @param {Navigator} navigator - navigator
21 | * @param {PloverApplication} app - plover app对象
22 | */
23 | constructor(rd, viewRender, navigator, app) {
24 | this[RD] = rd;
25 | this[VIEW_RENDER] = viewRender;
26 | this[NAVIGATOR] = navigator;
27 | this[APP] = app;
28 | this[CACHE] = null;
29 |
30 | for (const helper of initList) {
31 | helper.$init.call(this, rd, viewRender, navigator, app);
32 | }
33 | }
34 | }
35 |
36 |
37 | function get(name) {
38 | const cache = this[CACHE] || (this[CACHE] = new Map());
39 | let helper = null;
40 | if (cache.has(name)) {
41 | helper = cache.get(name);
42 | } else {
43 | helper = HelperContainer.helpers[name];
44 | if (typeof helper === 'function') {
45 | logger.debug('create helper object: %s', name);
46 | const Helper = helper;
47 | helper = new Helper(
48 | this[RD], this[VIEW_RENDER],
49 | this[NAVIGATOR], this[APP]
50 | );
51 | }
52 | cache.set(name, helper);
53 | }
54 | return helper;
55 | }
56 |
57 |
58 | module.exports = HelperContainer;
59 |
60 |
61 | HelperContainer.refine = function(app) {
62 | HelperContainer.helpers = app.helpers;
63 | const names = Object.keys(app.helpers);
64 |
65 | util.delegateGetters(HelperContainer.prototype, names, get);
66 |
67 | for (const name of names) {
68 | const helper = app.helpers[name];
69 | if (typeof helper.$init === 'function') {
70 | initList.push(helper);
71 | }
72 | }
73 | };
74 |
--------------------------------------------------------------------------------
/packages/plover-assets/test/util/scan-url.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const scanDir = require('../../lib/util/scan-dir');
3 |
4 |
5 | describe('util/scan-dir', function() {
6 | const dir = pathUtil.join(__dirname, '../fixtures/scan');
7 |
8 | const toRelative = path => pathUtil.relative(dir, path);
9 |
10 | it('scan dir files', function() {
11 | const list = scanDir(dir).map(toRelative);
12 | list.should.eql([
13 | 'README.md',
14 | 'a.txt',
15 | 'assets/css/test.less',
16 | 'assets/js/view.js',
17 | 'b.txt',
18 | 'dist/a.txt',
19 | 'dist/b.txt',
20 | 'package.json'
21 | ]);
22 | });
23 |
24 |
25 | it('scan dir with ignore rules', function() {
26 | const options = {
27 | ignore: ['package.json', 'README.md', 'README', 'dist/']
28 | };
29 | const list = scanDir(dir, options).map(toRelative);
30 | list.should.eql([
31 | 'a.txt',
32 | 'assets/css/test.less',
33 | 'assets/js/view.js',
34 | 'b.txt'
35 | ]);
36 | });
37 |
38 |
39 | it('scan dir with match rules', function() {
40 | const options = {
41 | match: ['a.txt'],
42 | ignore: ['*.txt', 'README.md', 'package.json', 'dist/']
43 | };
44 |
45 | const list = scanDir(dir, options).map(toRelative);
46 | list.should.eql([
47 | 'a.txt',
48 | 'assets/css/test.less',
49 | 'assets/js/view.js'
50 | ]);
51 | });
52 |
53 |
54 | it('options.relative', function() {
55 | const options = {
56 | ignore: ['scan/package.json', 'scan/dist/'],
57 | relative: pathUtil.dirname(dir)
58 | };
59 |
60 | const list = scanDir(dir, options).map(toRelative);
61 | list.should.eql([
62 | 'README.md',
63 | 'a.txt',
64 | 'assets/css/test.less',
65 | 'assets/js/view.js',
66 | 'b.txt'
67 | ]);
68 | });
69 |
70 |
71 | it('match only', function() {
72 | const options = {
73 | match: ['**/*.js', '*.json']
74 | };
75 |
76 | const list = scanDir(dir, options).map(toRelative);
77 | list.should.eql([
78 | 'assets/js/view.js',
79 | 'package.json'
80 | ]);
81 | });
82 | });
83 |
84 |
--------------------------------------------------------------------------------
/packages/plover/lib/components/startup/index.js:
--------------------------------------------------------------------------------
1 | const logger = require('plover-logger')('plover:components/startup');
2 | const util = require('../../util/util');
3 |
4 |
5 | class Startup {
6 | /**
7 | * 根据配置信息初始化应用
8 | * 主要添加以下plover部件：
9 | * 服务，中间件，渲染引擎，渲染帮助方法和渲染拦截器
10 | *
11 | * @param {PloverApplication} app - plover应用对象
12 | */
13 | constructor(app) {
14 | const settings = app.settings;
15 | const root = settings.applicationRoot;
16 |
17 | // 服务
18 | settings.services && addServices(app, root, settings.services);
19 |
20 | // 中间件
21 | require('./middleware')(app);
22 |
23 | // 路由信息，可以在settings配置也可以独立文件配置
24 | const routes = settings.routes;
25 | routes && addRoutes(app, routes);
26 |
27 | // 渲染帮助方法
28 | settings.helpers && addHelpers(app, root, settings.helpers);
29 |
30 | // 渲染拦截器
31 | settings.filters && addFilters(app, root, settings.filters);
32 | }
33 | }
34 |
35 |
36 | module.exports = Startup;
37 |
38 |
39 | /*
40 | * 添加服务
41 | */
42 | function addServices(app, root, services) {
43 | logger.info('add services: %o', services);
44 | for (const name in services) {
45 | const service = util.loadModule(root, services[name]);
46 | app.addService(name, service);
47 | }
48 | }
49 |
50 |
51 | /*
52 | * 添加路由
53 | */
54 | function addRoutes(app, routes) {
55 | logger.info('add routes: %o', routes);
56 | for (const pattern in routes) {
57 | app.addRoute(pattern, routes[pattern]);
58 | }
59 | }
60 |
61 |
62 | /*
63 | * 添加渲染帮助方法
64 | */
65 | function addHelpers(app, root, helpers) {
66 | logger.info('add helpers: %o', helpers);
67 | for (const name in helpers) {
68 | const helper = util.loadModule(root, helpers[name]);
69 | app.addHelper(name, helper);
70 | }
71 | }
72 |
73 |
74 | function addFilters(app, root, filters) {
75 | logger.info('add filters: %o', filters);
76 | for (let item of filters) {
77 | if (typeof item === 'string') {
78 | item = { module: item };
79 | }
80 | const filter = util.loadModule(root, item.module);
81 | // 设置$name属性是为了方便日志记录
82 | filter.$name = filter.$name || item.module;
83 | app.addFilter(filter, item);
84 | }
85 | }
86 |
--------------------------------------------------------------------------------
/packages/plover/test/util/error-handler.js:
--------------------------------------------------------------------------------
1 | const co = require('co');
2 | const Koa = require('koa');
3 | const request = require('supertest');
4 | const sinon = require('sinon');
5 | const Logger = require('plover-logger');
6 |
7 | const errorHandler = require('../../lib/util/error-handler');
8 |
9 |
10 | describe('util/error-handler', () => {
11 | beforeEach(() => {
12 | sinon.stub(Logger.prototype, 'error');
13 | });
14 |
15 |
16 | afterEach(() => {
17 | Logger.prototype.error.restore();
18 | });
19 |
20 |
21 | it('内层中间件出错时，开发环境会在页面打印异常', () => {
22 | const app = new Koa();
23 | const err = new Error('发生了错误怎么办');
24 | app.use(errorHandler({ env: 'development' }));
25 | app.use(ctx => {
26 | if (ctx.query.error === 'string') {
27 | throw err.message;
28 | }
29 | throw err;
30 | });
31 | return co(function* () {
32 | const agent = request.agent(app.callback());
33 | yield agent.get('/')
34 | .expect(500)
35 | .expect(/发生了错误怎么办?/);
36 |
37 | Logger.prototype.error.calledWith(err).should.be.true();
38 | Logger.prototype.error.reset();
39 |
40 | yield agent.get('/?error=string')
41 | .expect(500);
42 |
43 | Logger.prototype.error.calledWith(err.message).should.be.true();
44 | });
45 | });
46 |
47 |
48 | it('不处理500以下的错误', () => {
49 | const app = new Koa();
50 | app.use(errorHandler());
51 | app.use(ctx => {
52 | ctx.throw(400, '不允许进入');
53 | });
54 |
55 | return request(app.callback())
56 | .get('/')
57 | .expect(400);
58 | });
59 |
60 |
61 | it('非开发环境不会打印具体错误', async() => {
62 | const app = new Koa();
63 | app.use(errorHandler());
64 | app.use(() => {
65 | throw new Error('出现了一个粗心大意的错误');
66 | });
67 |
68 | const agent = request(app.callback());
69 |
70 | await agent.get('/')
71 | .expect(500)
72 | .expect('Internel Server Error');
73 |
74 | const res = { success: false, message: 'Internel Server Error' };
75 |
76 | await agent.get('/')
77 | .set('accept', 'application/json')
78 | .expect(res);
79 |
80 | await agent.post('/')
81 | .set('content-type', 'application/json')
82 | .expect(res);
83 | });
84 | });
85 |
--------------------------------------------------------------------------------
/packages/plover/test/fixtures/core/app/lib/helpers/assets.js:
--------------------------------------------------------------------------------
1 | const SafeString = require('plover-util/lib/safe-string')
2 |
3 |
4 | class AssetsHelper {
5 | constructor(rd, viewRender) {
6 | this.rd = rd;
7 | this.viewRender = viewRender;
8 | }
9 |
10 |
11 | css(url) {
12 | push(this, 'css', url);
13 | }
14 |
15 |
16 | js(url) {
17 | push(this, 'js', url);
18 | }
19 |
20 |
21 | cssTag() {
22 | return createTag(this, 'css', url => {
23 | return ``;
24 | });
25 | }
26 |
27 |
28 | jsTag() {
29 | return createTag(this, 'js', url => {
30 | return ``;
31 | });
32 | }
33 |
34 |
35 | transform(assets) {
36 | const fn = function(item) {
37 | return { url: getUrl(item) };
38 | };
39 | for (const group in assets) {
40 | const bag = assets[group];
41 | bag.css = bag.css.map(fn);
42 | bag.js = bag.js.map(fn);
43 | }
44 | }
45 | }
46 |
47 |
48 | module.exports = AssetsHelper;
49 |
50 |
51 | function push(self, type, url) {
52 | const assets = self.rd.assets;
53 | const group = self.rd.route.type === 'layout' ? 'layout' : 'default';
54 | const bag = assets[group] ||
55 | (assets[group] = { css: [], js: [] });
56 | const list = bag[type];
57 | list.push({ url: url });
58 | }
59 |
60 |
61 | function createTag(self, type, fn) {
62 | const assets = self.rd.assets;
63 | const defer = new Promise(resolve => {
64 | resolve(function() {
65 | let layoutList = [];
66 | let defaultList = [];
67 | if (assets.layout) {
68 | layoutList = layoutList.concat(assets.layout[type]);
69 | }
70 | if (assets.default) {
71 | defaultList = defaultList.concat(assets.default[type]);
72 | }
73 |
74 | const list = layoutList.concat(defaultList);
75 | const tags = list.map(item => {
76 | return fn(getUrl(item));
77 | });
78 |
79 | return { content: new SafeString(tags.join('\n')) };
80 | });
81 | });
82 |
83 | return self.viewRender.renderAsync(self.rd, defer, 'assets-' + type);
84 | }
85 |
86 |
87 | function getUrl(item) {
88 | if (item.url) {
89 | return item.url;
90 | }
91 | const route = item.route;
92 | return `/${route.module}/${route.action}`;
93 | }
94 |
--------------------------------------------------------------------------------
/packages/plover/lib/core/action-runner.js:
--------------------------------------------------------------------------------
1 | const assert = require('assert');
2 | const logger = require('plover-logger')('plover:core/action-runner');
3 | const invoker = require('../util/invoker');
4 |
5 |
6 | class ActionRunner {
7 | /**
8 | * 用于运行控制器Action方法
9 | *
10 | * 控制器中暴露的方法被称为`Action`
11 | * 此类被`Navigator`使用，一个`Navigator`对象包含一个`ActionRunner`
12 | *
13 | * @param {PloverApplication} app - Plover应用对象
14 | * @param {Navigator} navigator - Navigator对象
15 | * - filters {Array} - Filter列表
16 | */
17 | constructor(app, navigator) {
18 | this.filters = navigator.filters;
19 | }
20 |
21 |
22 | /**
23 | * 运行`Action`方法
24 | *
25 | * 1. 首先顺序遍历运行filters中的`beforeAction`方法
26 | * 2. 再运行当前控制器`beforeAction`方法
27 | * 3. 运行控制器Action方法
28 | * 4. 运行当前控制器`afterAction`方法
29 | * 5. 逆序遍历运行`afterAction`方法
30 | *
31 | * @param {NavigateData} rd - NavigateData
32 | * @param {ActionContext} ctx - 上下文，即`Action`中可以使用的`this`
33 | * @return {Any} - 运行结果
34 | */
35 | * run(rd, ctx) {
36 | const filters = this.filters;
37 | const route = rd.route;
38 | let ret = null;
39 |
40 | logger.debug('run action: %s[%s]', route.module, route.action);
41 |
42 | if (filters.length) {
43 | ret = yield* invoker.filter(filters, 'beforeAction', ctx);
44 | if (invoker.isSuccess(ret)) {
45 | return ret;
46 | }
47 | }
48 |
49 | ret = yield* runAction(rd, ctx);
50 | if (invoker.isSuccess(ret)) {
51 | return ret;
52 | }
53 |
54 | if (filters.length) {
55 | return yield* invoker.filter(filters, 'afterAction', ctx, true);
56 | }
57 |
58 | return ret;
59 | }
60 | }
61 |
62 |
63 | module.exports = ActionRunner;
64 |
65 |
66 | /* eslint complexity: [2, 9] */
67 | function* runAction(rd, ctx) {
68 | const module = rd.module;
69 | let ret = null;
70 | let fn = module.beforeAction;
71 |
72 | if (fn) {
73 | ret = yield* invoker.run(fn, ctx);
74 | if (invoker.isSuccess(ret)) {
75 | return ret;
76 | }
77 | }
78 |
79 | fn = module[rd.route.action];
80 | assert(fn, 'action method should exists');
81 | ret = yield* invoker.run(fn, ctx);
82 | if (invoker.isSuccess(ret)) {
83 | return ret;
84 | }
85 |
86 | fn = module.afterAction;
87 | if (fn) {
88 | ret = yield* invoker.run(fn, ctx);
89 | if (invoker.isSuccess(ret)) {
90 | return ret;
91 | }
92 | }
93 |
94 | return ret;
95 | }
96 |
--------------------------------------------------------------------------------
/packages/plover/test/components/service.js:
--------------------------------------------------------------------------------
1 | const co = require('co');
2 | const sinon = require('sinon');
3 | const request = require('supertest');
4 | const plover = require('../../');
5 |
6 | /* eslint require-yield: 0 */
7 |
8 | describe('components/service', function() {
9 | const settings = { applicationRoot: 'somepath' };
10 |
11 | it('添加和使用服务', function() {
12 | const app = plover(settings);
13 |
14 | const calc = {
15 | add: function(a, b) {
16 | return a + b;
17 | }
18 | };
19 |
20 | app.addService('calc', calc);
21 |
22 | app.addMiddleware(function* () {
23 | this.body = '' + this.calc.add(1, 2);
24 | });
25 |
26 | (function() {
27 | app.addService('calc', calc);
28 | }).should.throw(/service name conflict: calc/);
29 |
30 | return request(app.callback())
31 | .get('/')
32 | .expect('3');
33 | });
34 |
35 |
36 | it('添加和使用多实例服务', function() {
37 | const Offer = function(ctx) {
38 | this.url = ctx.url;
39 | this.size = Offer.size;
40 | };
41 |
42 | Offer.startup = function() {
43 | Offer.size = 100;
44 | };
45 |
46 | // 没用过的服务不应该初始化
47 | const NotUsed = sinon.spy();
48 |
49 | const app = plover(settings);
50 |
51 | app.addService('offer', Offer);
52 | app.addService('not-used', NotUsed);
53 |
54 | app.addMiddleware(function* () {
55 | this.body = this.offer.url + '/' + this.offer.size;
56 | });
57 |
58 | return co(function* () {
59 | yield request(app.callback())
60 | .get('/hello')
61 | .expect('/hello/100');
62 |
63 | NotUsed.called.should.be.false();
64 | });
65 | });
66 |
67 |
68 | it('需要异步初始化的服务', async function() {
69 | const CacheService = {
70 | async startup() {
71 | await sleep(100);
72 | this.cache = {
73 | name: 'plover'
74 | };
75 | },
76 |
77 | async get(name) {
78 | return this.cache[name];
79 | }
80 | };
81 |
82 | const app = plover(settings);
83 | app.addService('$cache', CacheService);
84 | app.use(async ctx => {
85 | ctx.body = await ctx.$cache.get('name');
86 | });
87 |
88 | await app.start();
89 | await request(app.callback())
90 | .get('/').expect('plover');
91 | });
92 | });
93 |
94 |
95 | function sleep(time) {
96 | return new Promise(resolve => {
97 | setTimeout(resolve, time);
98 | });
99 | }
100 |
--------------------------------------------------------------------------------
/packages/plover/lib/util/util.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const resolveFrom = require('resolve-from');
3 | const convert = require('koa-convert');
4 | const lang = require('plover-util/lib/lang');
5 | const { pathToRegexp } = require('path-to-regexp');
6 |
7 | const depd = require('depd')('plover');
8 |
9 |
10 | /* eslint no-prototype-builtins: 0 */
11 |
12 |
13 | /**
14 | * 代理属性访问到指定方法
15 | *
16 | * @param {Object} obj - 会在此对象上创建属性
17 | * @param {Oject} names - 属性名称列表
18 | * @param {String} to - 方法，默认为obj.$get
19 | */
20 | exports.delegateGetters = function(obj, names, to) {
21 | to = to || obj.$get;
22 | names.forEach(name => {
23 | if (!obj.hasOwnProperty(name)) {
24 | Object.defineProperty(obj, name, {
25 | enumerable: true,
26 | get: function() {
27 | return to.call(this, name);
28 | }
29 | });
30 | }
31 | });
32 | };
33 |
34 |
35 | const rRelativePath = /^\./;
36 |
37 |
38 | /**
39 | * 根据路径加载模块
40 | *
41 | * 如果是相对路径，则相对于应用目录加载
42 | * 否则就会加载应用依赖的模块
43 | *
44 | * @param {String} root - 应用根目录
45 | * @param {String} path - 路径
46 | * @return {Object} - 已加载的模块
47 | */
48 | exports.loadModule = function(root, path) {
49 | if (rRelativePath.test(path)) {
50 | path = pathUtil.join(root, path);
51 | } else if (!pathUtil.isAbsolute(path)) {
52 | path = resolveFrom(root, path);
53 | }
54 | return require(path);
55 | };
56 |
57 |
58 | /**
59 | * 转化中间件成标准格式
60 | *
61 | * @param {Application} app - Ploveration Application
62 | * @param {Function} mw - 中间件对象
63 | * @param {Object} options - 配置
64 | * @return {Middleware} - 中间件函数
65 | */
66 | exports.convertMiddleware = function(app, mw, options) {
67 | // 中间件是普通function时，需要初始化
68 | // 接口形式是middleware(config, koaapp, ploverapp)
69 | if (lang.isPureFunction(mw) && options.prepare !== false) {
70 | mw = mw(app.config, app.server, app.proto);
71 | }
72 | if (lang.isGeneratorFunction(mw)) {
73 | depd('support for generators will be removed in v4.');
74 | const name = mw.name;
75 | mw = convert(mw);
76 | mw.$name = name;
77 | }
78 | return mw;
79 | };
80 |
81 |
82 | exports.patternToRe = function(pattern) {
83 | if (pattern && typeof pattern === 'string') {
84 | return pathToRegexp(pattern.replace(/\/\*/g, '/(.*)'));
85 | }
86 | return pattern || null;
87 | };
88 |
89 |
90 | exports.tryStartupComponent = function(app, name, obj) {
91 | if (typeof obj.startup === 'function') {
92 | const defer = obj.startup(app);
93 | if (lang.isPromise(defer)) {
94 | const done = app.readyCallback(name);
95 | defer.then(done).catch(done);
96 | }
97 | }
98 | };
99 |
--------------------------------------------------------------------------------
/packages/plover-assets/lib/simple-helper.js:
--------------------------------------------------------------------------------
1 | const createTag = require('create-tag');
2 | const assetsUtil = require('./util/util');
3 |
4 |
5 | const rAbs = /^(\w+:)?\/\//;
6 | const rSlash = /^\//;
7 | const rSlashEnd = /\/$/;
8 |
9 |
10 | class Helper {
11 | static startup(app) {
12 | const settings = app.settings;
13 | const config = settings.assets || {};
14 |
15 | const prefix = config.prefix || '/g';
16 | const urlPrefix = settings.development ? prefix :
17 | (config.urlPrefix || prefix);
18 |
19 | this.urlPrefix = urlPrefix.replace(rSlashEnd, '');
20 | this.manifest = assetsUtil.loadManifest(settings);
21 | }
22 |
23 |
24 | constructor(rd) {
25 | this.assets = rd.assets;
26 | this.viewType = rd.route.type;
27 | this.urlPrefix = Helper.urlPrefix;
28 | this.manifest = Helper.manifest;
29 | }
30 |
31 |
32 | url(url) {
33 | if (rAbs.test(url)) {
34 | return url;
35 | }
36 | url = url.replace(rSlash, '');
37 | if (this.manifest) {
38 | url = this.manifest.get(url) || url;
39 | }
40 | return rAbs.test(url) ? url : this.urlPrefix + '/' + url;
41 | }
42 |
43 |
44 | css(url, group) {
45 | push(this, 'css', url, group);
46 | }
47 |
48 |
49 | js(url, group) {
50 | push(this, 'js', url, group);
51 | }
52 |
53 |
54 | cssTag(group, opts) {
55 | const urls = getUrls(this, group, 'css');
56 | return urls.map(url => {
57 | const attrs = Object.assign({
58 | rel: 'stylesheet',
59 | href: url
60 | }, opts);
61 | return createTag('link', attrs);
62 | }).join('\n');
63 | }
64 |
65 |
66 | jsTag(group, opts) {
67 | const urls = getUrls(this, group, 'js');
68 | return urls.map(url => {
69 | const attrs = Object.assign({ src: url }, opts);
70 | return createTag('script', attrs, '');
71 | }).join('\n');
72 | }
73 | }
74 |
75 |
76 | module.exports = Helper;
77 |
78 |
79 | function push(self, type, url, group) {
80 | if (!group) {
81 | group = self.viewType === 'layout' ? 'layout' : 'default';
82 | }
83 | url = self.url(url);
84 | const bag = self.assets[group] ||
85 | (self.assets[group] = { css: [], js: [] });
86 | const list = bag[type];
87 | list.push({ url });
88 | }
89 |
90 |
91 | function getUrls(self, groups, type) {
92 | groups = groups || ['layout', 'default'];
93 | if (!Array.isArray(groups)) {
94 | groups = [groups];
95 | }
96 |
97 | return groups.reduce((acc, group) => {
98 | const list = (self.assets[group] || {})[type];
99 | return list ? acc.concat(list) : acc;
100 | }, []).map(item => item.url);
101 | }
102 |
--------------------------------------------------------------------------------
/packages/plover/test/util/invoker.js:
--------------------------------------------------------------------------------
1 | const co = require('co');
2 |
3 | const invoker = require('../../lib/util/invoker');
4 |
5 | /* eslint require-yield: 0 */
6 |
7 | describe('util/invoker', function() {
8 | it('.filter', function() {
9 | const ctx = {};
10 |
11 | const f1 = {
12 | before: function* () {
13 | this.f1 = 'hello';
14 | this.should.equal(ctx);
15 | }
16 | };
17 |
18 | const f2 = {
19 | before: function() {
20 | this.f2 = 'world';
21 | }
22 | };
23 |
24 |
25 | const f3 = {};
26 |
27 | const list = [
28 | { filter: f1 },
29 | { filter: f2 },
30 | { filter: f3 }
31 | ];
32 |
33 | return co(function* () {
34 | yield invoker.filter(list, 'before', ctx);
35 | ctx.f1.should.equal('hello');
36 | ctx.f2.should.equal('world');
37 | });
38 | });
39 |
40 |
41 | it('.filter - break with false', function() {
42 | const ctx = { };
43 |
44 | const f1 = {
45 | before: async function() {
46 | this.f1 = 'hello';
47 | return false;
48 | }
49 | };
50 |
51 | const f2 = {
52 | before: function* () {
53 | this.f2 = 'world';
54 | }
55 | };
56 |
57 | const list = [
58 | { filter: f1 },
59 | { filter: f2 }
60 | ];
61 |
62 | return co(function* () {
63 | yield invoker.filter(list, 'before', ctx);
64 | ctx.f1.should.equal('hello');
65 | (ctx.f2 === undefined).should.be.true();
66 | });
67 | });
68 |
69 |
70 | it('.filter - break with object', function() {
71 | const ctx = { };
72 | const f1 = {
73 | before: function() {
74 | return { context: 'hello world' };
75 | }
76 | };
77 | const f2 = {
78 | before: function() {
79 | }
80 | };
81 | const list = [
82 | { filter: f1 },
83 | { filter: f2 }
84 | ];
85 |
86 | co(function* () {
87 | const o = yield invoker.filter(list, 'before', ctx);
88 | o.should.eql({ context: 'hello world' });
89 | });
90 | });
91 |
92 |
93 | it('.filter - reverse', function() {
94 | const bag = [];
95 |
96 | const f1 = {
97 | before: function() {
98 | bag.push('hello');
99 | }
100 | };
101 |
102 | const f2 = {
103 | before: function() {
104 | bag.push('world');
105 | }
106 | };
107 |
108 | const list = [
109 | { filter: f1 },
110 | { filter: f2 }
111 | ];
112 |
113 | return co(function* () {
114 | yield invoker.filter(list, 'before', {}, true);
115 | bag.should.eql(['world', 'hello']);
116 | });
117 | });
118 | });
119 |
120 |
--------------------------------------------------------------------------------
/packages/plover-assets/test/middleware.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const co = require('co');
3 | const fs = require('fs-extra');
4 | const mm = require('plover-test-mate');
5 |
6 | const util = require('../lib/util/util');
7 | const middleware = require('../lib/middleware');
8 | const handler = require('../lib/handler');
9 |
10 |
11 | describe('middleware', function() {
12 | const root = pathUtil.join(__dirname, './fixtures/app');
13 | const app = mm({ applicationRoot: root });
14 |
15 | app.addMiddleware(middleware);
16 | app.use(ctx => {
17 | ctx.body = 'ok';
18 | });
19 |
20 | handler.add('css', '.less', LessHandler);
21 |
22 | before(function() {
23 | fs.emptyDirSync(pathUtil.join(root, 'tmp'));
24 | });
25 |
26 |
27 | it('should yield next if not an assets request', function() {
28 | return app.get('/hello').expect('ok');
29 | });
30 |
31 |
32 | it('module assets', function() {
33 | return app.get('/g/index/css/view.css')
34 | .expect('body { }\n');
35 | });
36 |
37 |
38 | it('module assets with handler', function() {
39 | return app.get('/g/index/css/test.css')
40 | .expect('compiled: body: {}\n');
41 | });
42 |
43 |
44 | it('module assets not exists', function() {
45 | return app.get('/g/index/css/not-exists.css')
46 | .expect(404);
47 | });
48 |
49 |
50 | it('concat assets', function() {
51 | return app.get('/g/??index.html,index/js/a.js,index/js/b.js,index/css/test.css,not-found.js') // eslint-disable-line
52 | .expect('Hello World\n\nvar a = 1;\n\nvar b = 2;\n\ncompiled: body: {}\n\n');
53 | });
54 |
55 |
56 | const myapp = mm({ applicationRoot: root, env: 'production' });
57 | myapp.addMiddleware(middleware);
58 |
59 | it('should with cache when run in no dev mode', function() {
60 | return co(function* () {
61 | const url = '/g/index/css/test.css';
62 | const cachePath = util.getCachePath(url, myapp.settings);
63 | fs.existsSync(cachePath).should.not.true();
64 | const expect = 'compiled: body: {}\n';
65 |
66 | yield myapp.get(url).expect(expect);
67 |
68 | fs.existsSync(cachePath).should.be.true();
69 |
70 | yield myapp.get(url).expect(expect);
71 | });
72 | });
73 |
74 |
75 | it('direct access /public file when run in no dev mode', function() {
76 | return myapp.get('/g/index.html').expect('Hello World\n');
77 | });
78 |
79 |
80 | it('module not found', function() {
81 | return app.get('/g/not-exists/js/view.js')
82 | .expect(404);
83 | });
84 |
85 |
86 | it('invalid module assets url', function() {
87 | return app.get('/g/abc.js')
88 | .expect(404);
89 | });
90 | });
91 |
92 |
93 | function LessHandler(path, source) {
94 | return 'compiled: ' + source;
95 | }
96 |
97 |
--------------------------------------------------------------------------------
/packages/plover-router/test/plugin.js:
--------------------------------------------------------------------------------
1 | const mm = require('plover-test-mate');
2 |
3 |
4 | describe('plover-route/lib/plugin', () => {
5 | it('config routes', async() => {
6 | const app = create({
7 | applicationRoot: __dirname,
8 | routes: r => {
9 | r.get('/profile', 'users#show');
10 | r.use('/hello', ctx => {
11 | ctx.body = 'hello';
12 | });
13 | }
14 | });
15 |
16 | app.use(ctx => {
17 | if (ctx.route) {
18 | ctx.body = ctx.route;
19 | }
20 | });
21 |
22 | await app.get('/profile').expect({
23 | module: 'users',
24 | action: 'show',
25 | query: {}
26 | });
27 |
28 | await app.get('/hello').expect('hello');
29 | });
30 |
31 |
32 | it('routes with namespace', async() => {
33 | const app = create({
34 | applicationRoot: __dirname,
35 | disableDefaultRouter: true,
36 | routes: r => {
37 | r.namespace('/users', () => {
38 | r.use(async(ctx, next) => {
39 | await next();
40 | if (ctx.route) {
41 | ctx.body = ctx.route.url;
42 | } else {
43 | ctx.body = ctx.path;
44 | }
45 | });
46 |
47 | r.get('config', 'users#config');
48 | });
49 | }
50 | });
51 |
52 | await app.get('/users/config').expect('users:config');
53 | await app.get('/users/messages').expect('/users/messages');
54 | await app.get('/users/').expect('/users/');
55 | await app.get('/users').expect(404);
56 | });
57 |
58 |
59 | it('routes not config, for coverage', () => {
60 | create({
61 | applicationRoot: __dirname
62 | });
63 |
64 | (true).should.be.ok();
65 | });
66 |
67 |
68 | describe('http method', () => {
69 | const app = create({
70 | applicationRoot: __dirname,
71 | web: {
72 | csrf: {
73 | ignore: ['/*']
74 | }
75 | }
76 | });
77 |
78 | app.use(ctx => {
79 | ctx.body = ctx.method;
80 | });
81 |
82 | it('normal post', async() => {
83 | await app.agent.post('/save')
84 | .send({})
85 | .expect('POST');
86 | });
87 |
88 |
89 | it('put with _method', async() => {
90 | await app.agent.post('/update')
91 | .send({ _method: 'put' })
92 | .expect('PUT');
93 | });
94 |
95 |
96 | it('patch with header: x-http-method-override', async() => {
97 | await app.agent.post('/update')
98 | .set('X-HTTP-Method-Override', 'patch')
99 | .expect('PATCH');
100 | });
101 | });
102 | });
103 |
104 |
105 | function create(opts) {
106 | const app = mm(opts);
107 | app.install('plover-web');
108 | app.install(require('../lib/plugin'));
109 | return app;
110 | }
111 |
--------------------------------------------------------------------------------
/packages/plover-web/test/plugin.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const request = require('supertest');
3 | const plover = require('plover');
4 |
5 | const plugin = require('../lib/plugin');
6 |
7 |
8 | describe('plover-web/plugin', function() {
9 | const root = pathUtil.join(__dirname, './fixtures/app');
10 | const settings = require(pathUtil.join(root, 'config/app.js'));
11 | const app = plover(settings);
12 |
13 | plugin(app);
14 | hello(app);
15 | login(app);
16 |
17 | const agent = request.agent(app.callback());
18 |
19 | it('etag and rtime', () => {
20 | return agent.get('/hello')
21 | .expect(function(res) {
22 | res.header.etag.should.not.empty();
23 | res.header['x-response-time'].should.not.empty();
24 | })
25 | .expect('hello');
26 | });
27 |
28 |
29 | it('favicon', () => {
30 | return agent.get('/favicon.ico').expect(200);
31 | });
32 |
33 |
34 | it('static', () => {
35 | return agent.get('/ok.txt').expect('ok!\n');
36 | });
37 |
38 |
39 | it('compress', () => {
40 | return agent.get('/big.txt')
41 | .expect('Content-Encoding', 'gzip');
42 | });
43 |
44 |
45 | it('not setting.web', () => {
46 | const myapp = plover({ applicationRoot: __dirname });
47 | plugin(myapp);
48 | hello(myapp);
49 | return request(myapp.callback())
50 | .get('/hello').expect('hello');
51 | });
52 |
53 |
54 | it('security headers', () => {
55 | return agent.get('/hello')
56 | .expect('X-XSS-Protection', '1; mode=block')
57 | .expect('X-Content-Type-Options', 'nosniff')
58 | .expect('X-Download-Options', 'noopen');
59 | });
60 |
61 |
62 | it('session', async() => {
63 | await agent.get('/login').expect('ok');
64 | await agent.get('/user').expect({ name: 'tester' });
65 | });
66 |
67 |
68 | it('cors', async() => {
69 | await agent.get('/hello')
70 | .set('Host', 'www.google.com')
71 | .set('Origin', 'http://www.google.com:8080')
72 | .expect('hello')
73 | .expect('access-control-allow-origin', 'http://www.google.com:8080');
74 |
75 | const res = await agent.get('/hello')
76 | .set('Origin', 'http://www.google.com:8080');
77 |
78 | res.text.should.equal('hello');
79 | (res.headers['access-control-allow-origin'] === undefined).should.ok();
80 | });
81 | });
82 |
83 |
84 | function hello(app) {
85 | app.use(async(ctx, next) => {
86 | if (ctx.path === '/hello') {
87 | ctx.body = 'hello';
88 | } else {
89 | await next();
90 | }
91 | });
92 | }
93 |
94 |
95 | function login(app) {
96 | app.use(async(ctx, next) => {
97 | if (ctx.path === '/login') {
98 | ctx.session.user = { name: 'tester' };
99 | ctx.body = 'ok';
100 | } else if (ctx.path === '/user') {
101 | ctx.body = ctx.session.user;
102 | } else {
103 | await next();
104 | }
105 | });
106 | }
107 |
--------------------------------------------------------------------------------
/packages/plover-assets/lib/util/scan-dir.js:
--------------------------------------------------------------------------------
1 | const fs = require('fs');
2 | const pathUtil = require('path');
3 | const minimatch = require('minimatch');
4 |
5 |
6 | const debug = require('debug')('plover-assets-util:scan-dir');
7 |
8 |
9 | /**
10 | * scan dir files with ignore or match rules
11 | *
12 | * @param {String} dir - dir for scan
13 | * @param {Object} options - options
14 | * {
15 | * match: {Array} - match rules
16 | * ignore: {Array} - ignore rules
17 | * relative: {String} - relative path, use dir for default
18 | * }
19 | * @return {Array} - paths
20 | */
21 | module.exports = function(dir, options) {
22 | options = options || {};
23 |
24 | const results = [];
25 |
26 | const opts = {
27 | dirMatch: [],
28 | fileMatch: [],
29 | dirIgnore: [],
30 | fileIgnore: [],
31 | relative: options.relative || dir
32 | };
33 |
34 | makeRules(options.match, opts.dirMatch, opts.fileMatch);
35 | makeRules(options.ignore, opts.dirIgnore, opts.fileIgnore);
36 |
37 | const matchOnly = options.match && !options.ignore;
38 | opts.fileMatchOnly = matchOnly && opts.fileMatch.length;
39 | opts.dirMatchOnly = matchOnly && !opts.fileMatch.length;
40 |
41 | scan(dir, dir, opts, results);
42 |
43 | return results;
44 | };
45 |
46 |
47 | function scan(root, dir, options, results) {
48 | const files = fs.readdirSync(dir);
49 | files.forEach(file => {
50 | const path = pathUtil.join(dir, file);
51 | const stat = fs.statSync(path);
52 | const rpath = pathUtil.relative(options.relative, path);
53 |
54 | /* istanbul ignore else */
55 | if (stat.isFile()) {
56 | if (test(
57 | file, rpath,
58 | options.fileMatch, options.fileIgnore, options.fileMatchOnly
59 | )) {
60 | results.push(path);
61 | }
62 | } else if (stat.isDirectory()) {
63 | if (test(
64 | file, rpath,
65 | options.dirMatch, options.dirIgnore, options.dirMatchOnly
66 | )) {
67 | scan(root, path, options, results);
68 | }
69 | }
70 | });
71 | }
72 |
73 |
74 | function makeRules(patterns, dirRules, fileRules) {
75 | const rDir = /\/$/;
76 | const toRe = pattern => minimatch.makeRe(pattern);
77 | patterns && patterns.forEach(pattern => {
78 | if (rDir.test(pattern)) {
79 | pattern = pattern.replace(rDir, '');
80 | dirRules.push(toRe(pattern));
81 | } else {
82 | fileRules.push(toRe(pattern));
83 | }
84 | });
85 | }
86 |
87 |
88 | /* eslint max-params: [2, 5] */
89 | function test(file, rpath, match, ignore, matchOnly) {
90 | debug(
91 | 'test: %s, match: %o, ignore: %o, matchOnly: %s',
92 | rpath, match, ignore, matchOnly
93 | );
94 |
95 | const fn = re => re.test(rpath);
96 | if (match.length && match.some(fn)) {
97 | return true;
98 | }
99 | if (matchOnly) {
100 | return false;
101 | }
102 | if (ignore.length && ignore.some(fn)) {
103 | return false;
104 | }
105 | return !file.startsWith('.');
106 | }
107 |
108 |
--------------------------------------------------------------------------------
/packages/plover-module-resolver/test/get-module-info.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 |
3 | const getModuleInfo = require('../lib/get-module-info');
4 |
5 |
6 | /* global __dirname */
7 |
8 |
9 | describe('plover-module-resolver/lib/getModuleInfo(path)', function() {
10 | it('取得模块信息', function() {
11 | const path = pathUtil.join(__dirname, 'fixtures/hello');
12 | const info = getModuleInfo(path);
13 | info.should.eql({
14 | name: 'hello',
15 | version: '0.0.0',
16 | assets: true,
17 | assetsRoot: 'assets/',
18 | path: path,
19 | views: {
20 | view: {
21 | template: 'views/view.art',
22 | js: 'js/view.js',
23 | css: 'css/view.css'
24 | },
25 |
26 | item: {
27 | template: 'views/item.ejs',
28 | js: undefined,
29 | css: 'css/item.css'
30 | },
31 |
32 | edit: {
33 | template: 'views/edit.form',
34 | js: 'js/edit.js',
35 | css: undefined
36 | },
37 |
38 | 'controls/shop': {
39 | template: 'views/controls/shop.art',
40 | js: undefined,
41 | css: 'css/controls/shop.css'
42 | }
43 | }
44 | });
45 | });
46 |
47 |
48 | it('空目录不算模块或目录不存都不算模块', function() {
49 | const path = pathUtil.join(__dirname, 'fixtures/empty');
50 | let info = getModuleInfo(path);
51 | (!!info).should.not.be.ok();
52 |
53 | info = getModuleInfo('notexist');
54 | (!!info).should.not.be.ok();
55 | });
56 |
57 |
58 | it('package.json存在plover节点不存在也不能算模块', function() {
59 | const path = pathUtil.join(__dirname, 'fixtures/withpkg');
60 | const info = getModuleInfo(path, { ensure: true });
61 | (!!info).should.not.be.ok();
62 | });
63 |
64 |
65 | it('没有package.json的模块', function() {
66 | const path = pathUtil.join(__dirname, 'fixtures/simple');
67 | const info = getModuleInfo(path);
68 | info.should.eql({
69 | name: 'simple',
70 | version: '0.0.0',
71 | path: path,
72 | views: {}
73 | });
74 | });
75 |
76 |
77 | it('纯assets模块', function() {
78 | const path = pathUtil.join(__dirname, 'fixtures/pureassets');
79 | const info = getModuleInfo(path);
80 | info.should.eql({
81 | name: 'pureassets',
82 | version: '0.0.0',
83 | path: path,
84 | views: {},
85 | assets: true,
86 | assetsRoot: ''
87 | });
88 | });
89 |
90 |
91 | it('不包含assets的模块', function() {
92 | const path = pathUtil.join(__dirname, 'fixtures/noassets');
93 | const info = getModuleInfo(path);
94 | info.should.eql({
95 | name: 'noassets',
96 | version: '0.0.0',
97 | path: path,
98 | views: {}
99 | });
100 | });
101 |
102 |
103 | it('无效的package.json会输出文件路径信息方便排查', function() {
104 | const path = pathUtil.join(__dirname, 'fixtures/invalid-json');
105 | const pkgPath = pathUtil.join(path, 'package.json');
106 | (function() {
107 | getModuleInfo(path);
108 | }).should.throw(`invalid json file: ${pkgPath}`);
109 | });
110 | });
111 |
112 |
--------------------------------------------------------------------------------
Books
8 |
9 |
18 | Big
10 |-
11 |
- 126 Hi 12 |
14 |
17 | Show
15 | show is view 16 |-
19 |
- Name: Javascript高级程序设计20 |Price: 84.2元21 |
22 |
- Name: Javascript语言精粹23 |Price: 24.2元24 |
25 |
Panel
31 |
32 |
38 | -
33 |
- 0 book a 34 |
- 1 book b 35 |
- 2 book c 36 |
39 |
48 |
49 |
50 |
62 |
63 |
64 |
65 |
--------------------------------------------------------------------------------
/packages/plover/test/core/helper-container.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const request = require('supertest');
3 |
4 | const plover = require('../../');
5 |
6 | const equal = require('../util').equalWith;
7 |
8 |
9 | describe('core/helper-container', function() {
10 | const root = pathUtil.join(__dirname, '../fixtures/core/app');
11 | const app = plover({
12 | applicationRoot: root,
13 | helpers: {
14 | urlHelper: './lib/helpers/url-helper',
15 | xview: './lib/helpers/xview',
16 | cms: './lib/helpers/cms',
17 | assets: './lib/helpers/assets'
18 | }
19 | });
20 |
21 |
22 | it('use helper', function() {
23 | return request(app.callback())
24 | .get('/helper')
25 | .expect(equal('helper.html'));
26 | });
27 |
28 |
29 | it('async render', function() {
30 | return request(app.callback())
31 | .get('/helper/async')
32 | .expect(equal('helper-async.html'));
33 | });
34 |
35 |
36 | it('with assets', function() {
37 | return request(app.callback())
38 | .get('/assets')
39 | .expect(equal('assets.html'));
40 | });
41 |
42 |
43 | it('render assets use layoutejs', function() {
44 | return request(app.callback())
45 | .get('/assets?layoutejs=true')
46 | .expect(equal('assets-layoutejs.html'));
47 | });
48 |
49 |
50 | it('navigate with transform assets', function() {
51 | return request(app.callback())
52 | .get('/assets/navigate')
53 | .expect(equal('assets-navigate.html'));
54 | });
55 |
56 |
57 | it('disable assets', function() {
58 | const myapp = plover({
59 | applicationRoot: root,
60 | helpers: {
61 | assets: './lib/helpers/assets'
62 | },
63 | assets: {
64 | disableAutowire: true
65 | }
66 | });
67 | return request(myapp.callback())
68 | .get('/assets')
69 | .expect(equal('assets-disable-autowaire.html'));
70 | });
71 | });
72 |
--------------------------------------------------------------------------------
/packages/plover-web/lib/web/csrf.js:
--------------------------------------------------------------------------------
1 | const debug = require('debug')('plover-web:web/csrf');
2 | const util = require('../util/util');
3 |
4 |
5 | /* eslint no-underscore-dangle: 0 */
6 |
7 |
8 | module.exports = function(app, config) {
9 | config = config || {};
10 | if (config.enable === false) {
11 | return;
12 | }
13 |
14 | debug('install csrf module: %o', config);
15 | require('koa-csrf')(app.server, config);
16 | const mw = middleware(config);
17 | app.use(mw, { level: 0 });
18 | };
19 |
20 |
21 | module.exports.middleware = middleware;
22 | //~
23 |
24 |
25 | function middleware(opts) {
26 | opts = opts || {};
27 | const matchRules = util.regularRules(opts.match);
28 | const ignoreRules = util.regularRules(opts.ignore);
29 |
30 | debug('rules, match: %o, ignore: %o', matchRules, ignoreRules);
31 |
32 | return function PloverCsrf(ctx, next) {
33 | // 如果match匹配了，就检查csrf
34 | if (util.testRules(matchRules, ctx.path)) {
35 | return nextWithAssert(ctx, next);
36 | }
37 |
38 | // 忽略 get, head, options 请求
39 | const method = ctx.method;
40 | if (method === 'GET' ||
41 | method === 'HEAD' ||
42 | method === 'OPTIONS') {
43 | return next();
44 | }
45 |
46 | // multipart自己处理csrf
47 | if (ctx.is('multipart')) {
48 | return next();
49 | }
50 |
51 | // 如果ignore规则匹配，就忽略检查
52 | if (util.testRules(ignoreRules, ctx.path)) {
53 | debug('ignore check csrf ctoken: %s', ctx.path);
54 | return next();
55 | }
56 |
57 | return nextWithAssert(ctx, next);
58 | };
59 | }
60 |
61 |
62 | function nextWithAssert(ctx, next) {
63 | const assertCsrf = ctx.assertCsrf || ctx.assertCSRF;
64 | if (assertCsrf) {
65 | const body = ctx.request.body || {};
66 | debug('check csrf: %s, %s', ctx.path, body._csrf);
67 | assertCsrf.call(ctx, body);
68 |
69 | // 设置标识域，表示已校验过ctoken
70 | ctx[util.CSRF_CHECKED] = true;
71 | }
72 | return next();
73 | }
74 |
--------------------------------------------------------------------------------
/packages/plover/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "plover",
3 | "version": "4.0.0",
4 | "description": "专注于模块化的NodeJs Web框架",
5 | "main": "lib/index.js",
6 | "scripts": {
7 | "test": "mocha --require should --reporter spec --recursive --check-leaks --timeout 5000 $(find test -name '*.js' ! -path 'test/fixtures/*')",
8 | "cov": "istanbul cover _mocha -- --require should --recursive --check-leaks --exit --timeout 5000 $(find test -name '*.js' ! -path 'test/fixtures/*') -R spec"
9 | },
10 | "files": [
11 | "lib"
12 | ],
13 | "dependencies": {
14 | "antsort": "^1.1.2",
15 | "co": "^4.6.0",
16 | "debug": "^4.1.1",
17 | "delegates": "^1.0.0",
18 | "depd": "^2.0.0",
19 | "escape-html": "^1.0.3",
20 | "jsonp-body": "^1.0.0",
21 | "koa": "^2.5.2",
22 | "koa-compose": "^4.1.0",
23 | "koa-convert": "^1.2.0",
24 | "minimatch": "^3.0.4",
25 | "mz": "^2.6.0",
26 | "output-formatter": "^1.0.1",
27 | "path-to-regexp": "^6.1.0",
28 | "plover-logger": "^1.7.0",
29 | "plover-module-resolver": "^2.0.0",
30 | "plover-util": "^1.7.0",
31 | "ready-callback": "^2.1.0",
32 | "resolve-from": "^5.0.0"
33 | },
34 | "devDependencies": {
35 | "istanbul": "^1.1.0-alpha",
36 | "koa-bodyparser": "^4.2.1",
37 | "koa-session": "^6.0.0",
38 | "mocha": "^8.0.1",
39 | "plover-arttemplate": "^3.0.0",
40 | "plover-ejs": "^1.1.0",
41 | "semver": "^7.3.2",
42 | "should": "^13.2.3",
43 | "sinon": "^9.0.2",
44 | "supertest": "^4.0.2"
45 | },
46 | "engines": {
47 | "node": ">=7.6.0"
48 | },
49 | "publishConfig": {
50 | "registry": "https://registry.npmjs.org"
51 | },
52 | "repository": {
53 | "type": "git",
54 | "url": "git+https://github.com/alibaba/plover.git"
55 | },
56 | "author": "bencode@163.com",
57 | "license": "Apache-2.0",
58 | "bugs": {
59 | "url": "https://github.com/alibaba/plover/issues"
60 | },
61 | "homepage": "https://github.com/alibaba/plover#readme"
62 | }
63 |
--------------------------------------------------------------------------------
/packages/plover/test/fixtures/expects/child.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Big 2
40 |-
41 |
- 126 Hi 42 |
44 |
47 | Show
45 | show is view 46 |Books
8 |
9 |
18 | Big
10 |-
11 |
- 126 Hi 12 |
14 |
17 | Show
15 | show is view 16 |-
19 |
- Name: Javascript高级程序设计20 |Price: 84.2元21 |
22 |
- Name: Javascript语言精粹23 |Price: 24.2元24 |
25 |
27 | Not Found: child:not-found:view 28 |
29 |30 | Not Found: child:not-found 31 |
32 |33 | Not Found: child:child:not-found 34 |
35 | 36 |Panel
37 |
38 |
44 | -
39 |
- 0 book a 40 |
- 1 book b 41 |
- 2 book c 42 |
45 |
54 |
55 |
56 |
68 |
69 |
70 |
71 |
--------------------------------------------------------------------------------
/packages/plover/lib/components/plugin.js:
--------------------------------------------------------------------------------
1 | const assert = require('assert');
2 | const pathUtil = require('path');
3 | const antsort = require('antsort');
4 |
5 |
6 | const logger = require('plover-logger')('plover:components/plugin');
7 |
8 |
9 | class Plugin {
10 | /**
11 | * 加载插件
12 | *
13 | * 插件是一个plover模块
14 | * plover模块是一个`package.json`中配置plover域的node模块
15 | * 插件要求plover域中配置属性`plugin: path`
16 | *
17 | * @param {PloverApplication} app - Plover应用对象
18 | */
19 | constructor(app) {
20 | let plugins = getEnablePlugins(app);
21 | plugins = antsort(plugins, { defaultLevel: 3 });
22 | logger.info('install plugins:\n%o', plugins.map(info => info.name));
23 |
24 | for (const info of plugins) {
25 | logger.info('startup plugin: %s', info.name);
26 | const path = pathUtil.join(info.path, info.plugin);
27 | const fn = require(path);
28 | assert(
29 | typeof fn === 'function',
30 | 'plugin module should be a function: ' + path
31 | );
32 | fn(app.proto);
33 | }
34 | }
35 | }
36 |
37 |
38 | module.exports = Plugin;
39 |
40 |
41 | function getEnablePlugins(app) {
42 | const config = app.settings.plugins || {};
43 |
44 | const modules = app.moduleResolver.list();
45 | const plugins = modules.filter(info => {
46 | if (!info.plugin) {
47 | return false;
48 | }
49 |
50 | /*
51 | * 可以通过配置关闭插件
52 | *
53 | * ```
54 | * {
55 | * plugins: {
56 | * [name]: false
57 | * [name]: {
58 | * enable: false
59 | * }
60 | * [name]: {
61 | * disable: true
62 | * }
63 | * }
64 | * }
65 | * ```
66 | */
67 | const name = info.name;
68 | const pconfig = config[name];
69 | if (pconfig === false ||
70 | (pconfig && pconfig.enable === false) ||
71 | (pconfig && pconfig.disable)) {
72 | return false;
73 | }
74 |
75 | return true;
76 | });
77 |
78 | return plugins;
79 | }
80 |
81 |
--------------------------------------------------------------------------------
/packages/plover-module-resolver/lib/get-module-base-info.js:
--------------------------------------------------------------------------------
1 | const assert = require('assert');
2 | const fs = require('fs');
3 | const pathUtil = require('path');
4 |
5 | const util = require('./util');
6 |
7 |
8 | const rNamespace = /^@[-\w]+\//;
9 |
10 |
11 | /**
12 | * 取得模块基本信息
13 | *
14 | * @param {String} path - 模块路径
15 | * @param {Object} options - 可选参数
16 | * - ensure 需要验证package.json plover属性必须存在
17 | * - namespace 匿名模块名字空间
18 | * @return {Object} - 模块基本信息
19 | * - name
20 | * - version
21 | * - path
22 | */
23 | module.exports = function(path, options) {
24 | if (!util.isDir(path) || util.isEmptyDir(path)) {
25 | return null;
26 | }
27 |
28 | options = options || {};
29 | if (options.ensure && !util.isPloverModule(path)) {
30 | return null;
31 | }
32 |
33 | return getFromPackage(path) || getFromDeduce(path, options);
34 | };
35 |
36 |
37 | function getFromPackage(path) {
38 | const pkgPath = pathUtil.join(path, 'package.json');
39 | // 根据package.json生成基本信息
40 | if (!fs.existsSync(pkgPath)) {
41 | return null;
42 | }
43 |
44 | const o = readJson(pkgPath);
45 | const info = o.plover || {};
46 |
47 | // plover.name配置了就使用它，否则从name属性去掉名字空间得到
48 | info.name = info.name || o.name.replace(rNamespace, '');
49 | info.version = info.version || o.version || '0.0.0';
50 | info.path = path;
51 |
52 | assert(info.name, 'name required');
53 |
54 | return info;
55 | }
56 |
57 |
58 | function getFromDeduce(path, options) {
59 | const info = {
60 | name: pathUtil.basename(path),
61 | version: '0.0.0',
62 | path: path
63 | };
64 |
65 | const namespace = options.namespace;
66 | if (namespace) {
67 | info.name = namespace + '/' + info.name;
68 | info.namespace = namespace;
69 | }
70 |
71 | return info;
72 | }
73 |
74 |
75 | function readJson(path) {
76 | const body = fs.readFileSync(path, 'utf-8');
77 | try {
78 | return JSON.parse(body);
79 | } catch (e) {
80 | throw new Error('invalid json file: ' + path);
81 | }
82 | }
83 |
84 |
--------------------------------------------------------------------------------
/packages/plover-assets/lib/util/util.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const fs = require('mz/fs');
3 | const crypto = require('crypto');
4 |
5 |
6 | exports.getTempDir = function(settings) {
7 | return pathUtil.join(settings.applicationRoot, 'tmp');
8 | };
9 |
10 |
11 | exports.getPublicDir = function(settings) {
12 | return (settings.assets || {}).publicRoot ||
13 | pathUtil.join(settings.applicationRoot, 'public');
14 | };
15 |
16 |
17 | exports.getAssetsPrefix = function(settings) {
18 | return (settings.assets || {}).prefix || '/g';
19 | };
20 |
21 |
22 | exports.loadBuildConfig = function* (info) {
23 | const path = pathUtil.join(info.path, 'build.js');
24 | const config = (yield fs.exists(path)) ? require(path) : {};
25 | const obj = info.build ? info.build :
26 | info.build === false ? { enable: false } : null;
27 | return Object.assign({}, config, obj);
28 | };
29 |
30 |
31 | const rQueryStamp = /\?.*$/;
32 | const rSlash = /^\//;
33 |
34 | /**
35 | * 取得缓存地址
36 | *
37 | * @param {String} path - 原始地址
38 | * @param {Object} settings - 配置
39 | * @return {String} - 缓存地址
40 | */
41 | exports.getCachePath = function(path, settings) {
42 | const tmpdir = exports.getTempDir(settings);
43 | const shasum = crypto.createHash('sha1');
44 | shasum.update(path);
45 | const filename = shasum.digest('hex') +
46 | pathUtil.extname(path).replace(rQueryStamp, '');
47 | return pathUtil.join(tmpdir, filename);
48 | };
49 |
50 |
51 | exports.loadManifest = function(settings) {
52 | const publicDir = exports.getPublicDir(settings);
53 | const prefix = exports.getAssetsPrefix(settings);
54 | const path = settings.assets.manifest ||
55 | pathUtil.join(publicDir, prefix, 'manifest.json');
56 | if (!fs.existsSync(path)) {
57 | return null;
58 | }
59 |
60 | const map = new Map();
61 | const obj = JSON.parse(fs.readFileSync(path, 'utf-8'));
62 | for (const key in obj) {
63 | const url = obj[key].replace(rSlash, '');
64 | map.set(key, url);
65 | }
66 | return map;
67 | };
68 |
--------------------------------------------------------------------------------
/packages/plover-xview/lib/helper.js:
--------------------------------------------------------------------------------
1 | const escape = require('escape-html');
2 | const fmt = require('output-formatter');
3 | const SafeString = require('plover-util/lib/safe-string');
4 | const assign = require('plover-util/lib/assign');
5 |
6 |
7 | const RD = Symbol('rd');
8 | const VIEW_DATA = Symbol('viewdata');
9 |
10 |
11 | /*
12 | * 此方法在由框架自动调用，用于注入一些帮助方法
13 | *
14 | * 视图中可以使用以下数据和方法
15 | *
16 | * - csrf
17 | * - ctoken
18 | *
19 | * - $.viewdata(name, value)
20 | * - $.viewdata(map)
21 | */
22 |
23 | class Helper {
24 | static $init(rd) {
25 | rd.data.csrf = rd.ctx.csrf;
26 | rd.data.ctoken = rd.ctx.ctoken;
27 | }
28 |
29 |
30 | constructor(rd) {
31 | this[RD] = rd;
32 | }
33 |
34 |
35 | viewdata(...args) {
36 | const layoutData = this[RD].layout.data;
37 | const cache = layoutData[VIEW_DATA] || (layoutData[VIEW_DATA] = {});
38 | const type = typeof args[0];
39 | if (type === 'string') {
40 | cache[args[0]] = args[1];
41 | } else if (type === 'object' && args[0]) {
42 | assign(cache, args[0]);
43 | } else {
44 | console.warn(fmt.yellow('invalid viewdata: '), args[0]); // eslint-disable-line
45 | }
46 | return '';
47 | }
48 |
49 |
50 | metaTags(opts) {
51 | opts = opts || {};
52 | const rd = this[RD];
53 | const ctx = rd.ctx;
54 | const settings = ctx.settings;
55 | const config = settings.xview || {};
56 |
57 | let tags = ``;
58 | if (ctx.csrf) {
59 | tags += `\n`;
60 | }
61 | if (ctx.ctoken) {
62 | tags += `\n`;
63 | }
64 |
65 | if (opts.viewdata) {
66 | const data = {};
67 | config.viewdata && assign(data, config.viewdata);
68 | assign(data, rd.layout.data[VIEW_DATA]);
69 | tags += `\n`; // eslint-disable-line
70 | }
71 |
72 | return new SafeString(tags);
73 | }
74 | }
75 |
76 |
77 | module.exports = Helper;
78 |
--------------------------------------------------------------------------------
/packages/plover/lib/core/helper-container.js:
--------------------------------------------------------------------------------
1 | const logger = require('plover-logger')('plover:core/helper-container');
2 | const util = require('../util/util');
3 |
4 |
5 | const RD = Symbol('rd');
6 | const VIEW_RENDER = Symbol('viewRender');
7 | const NAVIGATOR = Symbol('navigator');
8 | const APP = Symbol('app');
9 | const CACHE = Symbol('cache');
10 |
11 | const initList = [];
12 |
13 | class HelperContainer {
14 | /**
15 | * Helper容器，用于管理helper对象
16 | * 模板中只有用到某个helper才去构造
17 | *
18 | * @param {RenderData} rd - 渲染环境
19 | * @param {ViewRender} viewRender - viewRender
20 | * @param {Navigator} navigator - navigator
21 | * @param {PloverApplication} app - plover app对象
22 | */
23 | constructor(rd, viewRender, navigator, app) {
24 | this[RD] = rd;
25 | this[VIEW_RENDER] = viewRender;
26 | this[NAVIGATOR] = navigator;
27 | this[APP] = app;
28 | this[CACHE] = null;
29 |
30 | for (const helper of initList) {
31 | helper.$init.call(this, rd, viewRender, navigator, app);
32 | }
33 | }
34 | }
35 |
36 |
37 | function get(name) {
38 | const cache = this[CACHE] || (this[CACHE] = new Map());
39 | let helper = null;
40 | if (cache.has(name)) {
41 | helper = cache.get(name);
42 | } else {
43 | helper = HelperContainer.helpers[name];
44 | if (typeof helper === 'function') {
45 | logger.debug('create helper object: %s', name);
46 | const Helper = helper;
47 | helper = new Helper(
48 | this[RD], this[VIEW_RENDER],
49 | this[NAVIGATOR], this[APP]
50 | );
51 | }
52 | cache.set(name, helper);
53 | }
54 | return helper;
55 | }
56 |
57 |
58 | module.exports = HelperContainer;
59 |
60 |
61 | HelperContainer.refine = function(app) {
62 | HelperContainer.helpers = app.helpers;
63 | const names = Object.keys(app.helpers);
64 |
65 | util.delegateGetters(HelperContainer.prototype, names, get);
66 |
67 | for (const name of names) {
68 | const helper = app.helpers[name];
69 | if (typeof helper.$init === 'function') {
70 | initList.push(helper);
71 | }
72 | }
73 | };
74 |
--------------------------------------------------------------------------------
/packages/plover-assets/test/util/scan-url.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const scanDir = require('../../lib/util/scan-dir');
3 |
4 |
5 | describe('util/scan-dir', function() {
6 | const dir = pathUtil.join(__dirname, '../fixtures/scan');
7 |
8 | const toRelative = path => pathUtil.relative(dir, path);
9 |
10 | it('scan dir files', function() {
11 | const list = scanDir(dir).map(toRelative);
12 | list.should.eql([
13 | 'README.md',
14 | 'a.txt',
15 | 'assets/css/test.less',
16 | 'assets/js/view.js',
17 | 'b.txt',
18 | 'dist/a.txt',
19 | 'dist/b.txt',
20 | 'package.json'
21 | ]);
22 | });
23 |
24 |
25 | it('scan dir with ignore rules', function() {
26 | const options = {
27 | ignore: ['package.json', 'README.md', 'README', 'dist/']
28 | };
29 | const list = scanDir(dir, options).map(toRelative);
30 | list.should.eql([
31 | 'a.txt',
32 | 'assets/css/test.less',
33 | 'assets/js/view.js',
34 | 'b.txt'
35 | ]);
36 | });
37 |
38 |
39 | it('scan dir with match rules', function() {
40 | const options = {
41 | match: ['a.txt'],
42 | ignore: ['*.txt', 'README.md', 'package.json', 'dist/']
43 | };
44 |
45 | const list = scanDir(dir, options).map(toRelative);
46 | list.should.eql([
47 | 'a.txt',
48 | 'assets/css/test.less',
49 | 'assets/js/view.js'
50 | ]);
51 | });
52 |
53 |
54 | it('options.relative', function() {
55 | const options = {
56 | ignore: ['scan/package.json', 'scan/dist/'],
57 | relative: pathUtil.dirname(dir)
58 | };
59 |
60 | const list = scanDir(dir, options).map(toRelative);
61 | list.should.eql([
62 | 'README.md',
63 | 'a.txt',
64 | 'assets/css/test.less',
65 | 'assets/js/view.js',
66 | 'b.txt'
67 | ]);
68 | });
69 |
70 |
71 | it('match only', function() {
72 | const options = {
73 | match: ['**/*.js', '*.json']
74 | };
75 |
76 | const list = scanDir(dir, options).map(toRelative);
77 | list.should.eql([
78 | 'assets/js/view.js',
79 | 'package.json'
80 | ]);
81 | });
82 | });
83 |
84 |
--------------------------------------------------------------------------------
/packages/plover/lib/components/startup/index.js:
--------------------------------------------------------------------------------
1 | const logger = require('plover-logger')('plover:components/startup');
2 | const util = require('../../util/util');
3 |
4 |
5 | class Startup {
6 | /**
7 | * 根据配置信息初始化应用
8 | * 主要添加以下plover部件：
9 | * 服务，中间件，渲染引擎，渲染帮助方法和渲染拦截器
10 | *
11 | * @param {PloverApplication} app - plover应用对象
12 | */
13 | constructor(app) {
14 | const settings = app.settings;
15 | const root = settings.applicationRoot;
16 |
17 | // 服务
18 | settings.services && addServices(app, root, settings.services);
19 |
20 | // 中间件
21 | require('./middleware')(app);
22 |
23 | // 路由信息，可以在settings配置也可以独立文件配置
24 | const routes = settings.routes;
25 | routes && addRoutes(app, routes);
26 |
27 | // 渲染帮助方法
28 | settings.helpers && addHelpers(app, root, settings.helpers);
29 |
30 | // 渲染拦截器
31 | settings.filters && addFilters(app, root, settings.filters);
32 | }
33 | }
34 |
35 |
36 | module.exports = Startup;
37 |
38 |
39 | /*
40 | * 添加服务
41 | */
42 | function addServices(app, root, services) {
43 | logger.info('add services: %o', services);
44 | for (const name in services) {
45 | const service = util.loadModule(root, services[name]);
46 | app.addService(name, service);
47 | }
48 | }
49 |
50 |
51 | /*
52 | * 添加路由
53 | */
54 | function addRoutes(app, routes) {
55 | logger.info('add routes: %o', routes);
56 | for (const pattern in routes) {
57 | app.addRoute(pattern, routes[pattern]);
58 | }
59 | }
60 |
61 |
62 | /*
63 | * 添加渲染帮助方法
64 | */
65 | function addHelpers(app, root, helpers) {
66 | logger.info('add helpers: %o', helpers);
67 | for (const name in helpers) {
68 | const helper = util.loadModule(root, helpers[name]);
69 | app.addHelper(name, helper);
70 | }
71 | }
72 |
73 |
74 | function addFilters(app, root, filters) {
75 | logger.info('add filters: %o', filters);
76 | for (let item of filters) {
77 | if (typeof item === 'string') {
78 | item = { module: item };
79 | }
80 | const filter = util.loadModule(root, item.module);
81 | // 设置$name属性是为了方便日志记录
82 | filter.$name = filter.$name || item.module;
83 | app.addFilter(filter, item);
84 | }
85 | }
86 |
--------------------------------------------------------------------------------
/packages/plover/test/util/error-handler.js:
--------------------------------------------------------------------------------
1 | const co = require('co');
2 | const Koa = require('koa');
3 | const request = require('supertest');
4 | const sinon = require('sinon');
5 | const Logger = require('plover-logger');
6 |
7 | const errorHandler = require('../../lib/util/error-handler');
8 |
9 |
10 | describe('util/error-handler', () => {
11 | beforeEach(() => {
12 | sinon.stub(Logger.prototype, 'error');
13 | });
14 |
15 |
16 | afterEach(() => {
17 | Logger.prototype.error.restore();
18 | });
19 |
20 |
21 | it('内层中间件出错时，开发环境会在页面打印异常', () => {
22 | const app = new Koa();
23 | const err = new Error('发生了错误怎么办');
24 | app.use(errorHandler({ env: 'development' }));
25 | app.use(ctx => {
26 | if (ctx.query.error === 'string') {
27 | throw err.message;
28 | }
29 | throw err;
30 | });
31 | return co(function* () {
32 | const agent = request.agent(app.callback());
33 | yield agent.get('/')
34 | .expect(500)
35 | .expect(/发生了错误怎么办?/);
36 |
37 | Logger.prototype.error.calledWith(err).should.be.true();
38 | Logger.prototype.error.reset();
39 |
40 | yield agent.get('/?error=string')
41 | .expect(500);
42 |
43 | Logger.prototype.error.calledWith(err.message).should.be.true();
44 | });
45 | });
46 |
47 |
48 | it('不处理500以下的错误', () => {
49 | const app = new Koa();
50 | app.use(errorHandler());
51 | app.use(ctx => {
52 | ctx.throw(400, '不允许进入');
53 | });
54 |
55 | return request(app.callback())
56 | .get('/')
57 | .expect(400);
58 | });
59 |
60 |
61 | it('非开发环境不会打印具体错误', async() => {
62 | const app = new Koa();
63 | app.use(errorHandler());
64 | app.use(() => {
65 | throw new Error('出现了一个粗心大意的错误');
66 | });
67 |
68 | const agent = request(app.callback());
69 |
70 | await agent.get('/')
71 | .expect(500)
72 | .expect('Internel Server Error');
73 |
74 | const res = { success: false, message: 'Internel Server Error' };
75 |
76 | await agent.get('/')
77 | .set('accept', 'application/json')
78 | .expect(res);
79 |
80 | await agent.post('/')
81 | .set('content-type', 'application/json')
82 | .expect(res);
83 | });
84 | });
85 |
--------------------------------------------------------------------------------
/packages/plover/test/fixtures/core/app/lib/helpers/assets.js:
--------------------------------------------------------------------------------
1 | const SafeString = require('plover-util/lib/safe-string')
2 |
3 |
4 | class AssetsHelper {
5 | constructor(rd, viewRender) {
6 | this.rd = rd;
7 | this.viewRender = viewRender;
8 | }
9 |
10 |
11 | css(url) {
12 | push(this, 'css', url);
13 | }
14 |
15 |
16 | js(url) {
17 | push(this, 'js', url);
18 | }
19 |
20 |
21 | cssTag() {
22 | return createTag(this, 'css', url => {
23 | return ``;
24 | });
25 | }
26 |
27 |
28 | jsTag() {
29 | return createTag(this, 'js', url => {
30 | return ``;
31 | });
32 | }
33 |
34 |
35 | transform(assets) {
36 | const fn = function(item) {
37 | return { url: getUrl(item) };
38 | };
39 | for (const group in assets) {
40 | const bag = assets[group];
41 | bag.css = bag.css.map(fn);
42 | bag.js = bag.js.map(fn);
43 | }
44 | }
45 | }
46 |
47 |
48 | module.exports = AssetsHelper;
49 |
50 |
51 | function push(self, type, url) {
52 | const assets = self.rd.assets;
53 | const group = self.rd.route.type === 'layout' ? 'layout' : 'default';
54 | const bag = assets[group] ||
55 | (assets[group] = { css: [], js: [] });
56 | const list = bag[type];
57 | list.push({ url: url });
58 | }
59 |
60 |
61 | function createTag(self, type, fn) {
62 | const assets = self.rd.assets;
63 | const defer = new Promise(resolve => {
64 | resolve(function() {
65 | let layoutList = [];
66 | let defaultList = [];
67 | if (assets.layout) {
68 | layoutList = layoutList.concat(assets.layout[type]);
69 | }
70 | if (assets.default) {
71 | defaultList = defaultList.concat(assets.default[type]);
72 | }
73 |
74 | const list = layoutList.concat(defaultList);
75 | const tags = list.map(item => {
76 | return fn(getUrl(item));
77 | });
78 |
79 | return { content: new SafeString(tags.join('\n')) };
80 | });
81 | });
82 |
83 | return self.viewRender.renderAsync(self.rd, defer, 'assets-' + type);
84 | }
85 |
86 |
87 | function getUrl(item) {
88 | if (item.url) {
89 | return item.url;
90 | }
91 | const route = item.route;
92 | return `/${route.module}/${route.action}`;
93 | }
94 |
--------------------------------------------------------------------------------
/packages/plover/lib/core/action-runner.js:
--------------------------------------------------------------------------------
1 | const assert = require('assert');
2 | const logger = require('plover-logger')('plover:core/action-runner');
3 | const invoker = require('../util/invoker');
4 |
5 |
6 | class ActionRunner {
7 | /**
8 | * 用于运行控制器Action方法
9 | *
10 | * 控制器中暴露的方法被称为`Action`
11 | * 此类被`Navigator`使用，一个`Navigator`对象包含一个`ActionRunner`
12 | *
13 | * @param {PloverApplication} app - Plover应用对象
14 | * @param {Navigator} navigator - Navigator对象
15 | * - filters {Array} - Filter列表
16 | */
17 | constructor(app, navigator) {
18 | this.filters = navigator.filters;
19 | }
20 |
21 |
22 | /**
23 | * 运行`Action`方法
24 | *
25 | * 1. 首先顺序遍历运行filters中的`beforeAction`方法
26 | * 2. 再运行当前控制器`beforeAction`方法
27 | * 3. 运行控制器Action方法
28 | * 4. 运行当前控制器`afterAction`方法
29 | * 5. 逆序遍历运行`afterAction`方法
30 | *
31 | * @param {NavigateData} rd - NavigateData
32 | * @param {ActionContext} ctx - 上下文，即`Action`中可以使用的`this`
33 | * @return {Any} - 运行结果
34 | */
35 | * run(rd, ctx) {
36 | const filters = this.filters;
37 | const route = rd.route;
38 | let ret = null;
39 |
40 | logger.debug('run action: %s[%s]', route.module, route.action);
41 |
42 | if (filters.length) {
43 | ret = yield* invoker.filter(filters, 'beforeAction', ctx);
44 | if (invoker.isSuccess(ret)) {
45 | return ret;
46 | }
47 | }
48 |
49 | ret = yield* runAction(rd, ctx);
50 | if (invoker.isSuccess(ret)) {
51 | return ret;
52 | }
53 |
54 | if (filters.length) {
55 | return yield* invoker.filter(filters, 'afterAction', ctx, true);
56 | }
57 |
58 | return ret;
59 | }
60 | }
61 |
62 |
63 | module.exports = ActionRunner;
64 |
65 |
66 | /* eslint complexity: [2, 9] */
67 | function* runAction(rd, ctx) {
68 | const module = rd.module;
69 | let ret = null;
70 | let fn = module.beforeAction;
71 |
72 | if (fn) {
73 | ret = yield* invoker.run(fn, ctx);
74 | if (invoker.isSuccess(ret)) {
75 | return ret;
76 | }
77 | }
78 |
79 | fn = module[rd.route.action];
80 | assert(fn, 'action method should exists');
81 | ret = yield* invoker.run(fn, ctx);
82 | if (invoker.isSuccess(ret)) {
83 | return ret;
84 | }
85 |
86 | fn = module.afterAction;
87 | if (fn) {
88 | ret = yield* invoker.run(fn, ctx);
89 | if (invoker.isSuccess(ret)) {
90 | return ret;
91 | }
92 | }
93 |
94 | return ret;
95 | }
96 |
--------------------------------------------------------------------------------
/packages/plover/test/components/service.js:
--------------------------------------------------------------------------------
1 | const co = require('co');
2 | const sinon = require('sinon');
3 | const request = require('supertest');
4 | const plover = require('../../');
5 |
6 | /* eslint require-yield: 0 */
7 |
8 | describe('components/service', function() {
9 | const settings = { applicationRoot: 'somepath' };
10 |
11 | it('添加和使用服务', function() {
12 | const app = plover(settings);
13 |
14 | const calc = {
15 | add: function(a, b) {
16 | return a + b;
17 | }
18 | };
19 |
20 | app.addService('calc', calc);
21 |
22 | app.addMiddleware(function* () {
23 | this.body = '' + this.calc.add(1, 2);
24 | });
25 |
26 | (function() {
27 | app.addService('calc', calc);
28 | }).should.throw(/service name conflict: calc/);
29 |
30 | return request(app.callback())
31 | .get('/')
32 | .expect('3');
33 | });
34 |
35 |
36 | it('添加和使用多实例服务', function() {
37 | const Offer = function(ctx) {
38 | this.url = ctx.url;
39 | this.size = Offer.size;
40 | };
41 |
42 | Offer.startup = function() {
43 | Offer.size = 100;
44 | };
45 |
46 | // 没用过的服务不应该初始化
47 | const NotUsed = sinon.spy();
48 |
49 | const app = plover(settings);
50 |
51 | app.addService('offer', Offer);
52 | app.addService('not-used', NotUsed);
53 |
54 | app.addMiddleware(function* () {
55 | this.body = this.offer.url + '/' + this.offer.size;
56 | });
57 |
58 | return co(function* () {
59 | yield request(app.callback())
60 | .get('/hello')
61 | .expect('/hello/100');
62 |
63 | NotUsed.called.should.be.false();
64 | });
65 | });
66 |
67 |
68 | it('需要异步初始化的服务', async function() {
69 | const CacheService = {
70 | async startup() {
71 | await sleep(100);
72 | this.cache = {
73 | name: 'plover'
74 | };
75 | },
76 |
77 | async get(name) {
78 | return this.cache[name];
79 | }
80 | };
81 |
82 | const app = plover(settings);
83 | app.addService('$cache', CacheService);
84 | app.use(async ctx => {
85 | ctx.body = await ctx.$cache.get('name');
86 | });
87 |
88 | await app.start();
89 | await request(app.callback())
90 | .get('/').expect('plover');
91 | });
92 | });
93 |
94 |
95 | function sleep(time) {
96 | return new Promise(resolve => {
97 | setTimeout(resolve, time);
98 | });
99 | }
100 |
--------------------------------------------------------------------------------
/packages/plover/lib/util/util.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const resolveFrom = require('resolve-from');
3 | const convert = require('koa-convert');
4 | const lang = require('plover-util/lib/lang');
5 | const { pathToRegexp } = require('path-to-regexp');
6 |
7 | const depd = require('depd')('plover');
8 |
9 |
10 | /* eslint no-prototype-builtins: 0 */
11 |
12 |
13 | /**
14 | * 代理属性访问到指定方法
15 | *
16 | * @param {Object} obj - 会在此对象上创建属性
17 | * @param {Oject} names - 属性名称列表
18 | * @param {String} to - 方法，默认为obj.$get
19 | */
20 | exports.delegateGetters = function(obj, names, to) {
21 | to = to || obj.$get;
22 | names.forEach(name => {
23 | if (!obj.hasOwnProperty(name)) {
24 | Object.defineProperty(obj, name, {
25 | enumerable: true,
26 | get: function() {
27 | return to.call(this, name);
28 | }
29 | });
30 | }
31 | });
32 | };
33 |
34 |
35 | const rRelativePath = /^\./;
36 |
37 |
38 | /**
39 | * 根据路径加载模块
40 | *
41 | * 如果是相对路径，则相对于应用目录加载
42 | * 否则就会加载应用依赖的模块
43 | *
44 | * @param {String} root - 应用根目录
45 | * @param {String} path - 路径
46 | * @return {Object} - 已加载的模块
47 | */
48 | exports.loadModule = function(root, path) {
49 | if (rRelativePath.test(path)) {
50 | path = pathUtil.join(root, path);
51 | } else if (!pathUtil.isAbsolute(path)) {
52 | path = resolveFrom(root, path);
53 | }
54 | return require(path);
55 | };
56 |
57 |
58 | /**
59 | * 转化中间件成标准格式
60 | *
61 | * @param {Application} app - Ploveration Application
62 | * @param {Function} mw - 中间件对象
63 | * @param {Object} options - 配置
64 | * @return {Middleware} - 中间件函数
65 | */
66 | exports.convertMiddleware = function(app, mw, options) {
67 | // 中间件是普通function时，需要初始化
68 | // 接口形式是middleware(config, koaapp, ploverapp)
69 | if (lang.isPureFunction(mw) && options.prepare !== false) {
70 | mw = mw(app.config, app.server, app.proto);
71 | }
72 | if (lang.isGeneratorFunction(mw)) {
73 | depd('support for generators will be removed in v4.');
74 | const name = mw.name;
75 | mw = convert(mw);
76 | mw.$name = name;
77 | }
78 | return mw;
79 | };
80 |
81 |
82 | exports.patternToRe = function(pattern) {
83 | if (pattern && typeof pattern === 'string') {
84 | return pathToRegexp(pattern.replace(/\/\*/g, '/(.*)'));
85 | }
86 | return pattern || null;
87 | };
88 |
89 |
90 | exports.tryStartupComponent = function(app, name, obj) {
91 | if (typeof obj.startup === 'function') {
92 | const defer = obj.startup(app);
93 | if (lang.isPromise(defer)) {
94 | const done = app.readyCallback(name);
95 | defer.then(done).catch(done);
96 | }
97 | }
98 | };
99 |
--------------------------------------------------------------------------------
/packages/plover-assets/lib/simple-helper.js:
--------------------------------------------------------------------------------
1 | const createTag = require('create-tag');
2 | const assetsUtil = require('./util/util');
3 |
4 |
5 | const rAbs = /^(\w+:)?\/\//;
6 | const rSlash = /^\//;
7 | const rSlashEnd = /\/$/;
8 |
9 |
10 | class Helper {
11 | static startup(app) {
12 | const settings = app.settings;
13 | const config = settings.assets || {};
14 |
15 | const prefix = config.prefix || '/g';
16 | const urlPrefix = settings.development ? prefix :
17 | (config.urlPrefix || prefix);
18 |
19 | this.urlPrefix = urlPrefix.replace(rSlashEnd, '');
20 | this.manifest = assetsUtil.loadManifest(settings);
21 | }
22 |
23 |
24 | constructor(rd) {
25 | this.assets = rd.assets;
26 | this.viewType = rd.route.type;
27 | this.urlPrefix = Helper.urlPrefix;
28 | this.manifest = Helper.manifest;
29 | }
30 |
31 |
32 | url(url) {
33 | if (rAbs.test(url)) {
34 | return url;
35 | }
36 | url = url.replace(rSlash, '');
37 | if (this.manifest) {
38 | url = this.manifest.get(url) || url;
39 | }
40 | return rAbs.test(url) ? url : this.urlPrefix + '/' + url;
41 | }
42 |
43 |
44 | css(url, group) {
45 | push(this, 'css', url, group);
46 | }
47 |
48 |
49 | js(url, group) {
50 | push(this, 'js', url, group);
51 | }
52 |
53 |
54 | cssTag(group, opts) {
55 | const urls = getUrls(this, group, 'css');
56 | return urls.map(url => {
57 | const attrs = Object.assign({
58 | rel: 'stylesheet',
59 | href: url
60 | }, opts);
61 | return createTag('link', attrs);
62 | }).join('\n');
63 | }
64 |
65 |
66 | jsTag(group, opts) {
67 | const urls = getUrls(this, group, 'js');
68 | return urls.map(url => {
69 | const attrs = Object.assign({ src: url }, opts);
70 | return createTag('script', attrs, '');
71 | }).join('\n');
72 | }
73 | }
74 |
75 |
76 | module.exports = Helper;
77 |
78 |
79 | function push(self, type, url, group) {
80 | if (!group) {
81 | group = self.viewType === 'layout' ? 'layout' : 'default';
82 | }
83 | url = self.url(url);
84 | const bag = self.assets[group] ||
85 | (self.assets[group] = { css: [], js: [] });
86 | const list = bag[type];
87 | list.push({ url });
88 | }
89 |
90 |
91 | function getUrls(self, groups, type) {
92 | groups = groups || ['layout', 'default'];
93 | if (!Array.isArray(groups)) {
94 | groups = [groups];
95 | }
96 |
97 | return groups.reduce((acc, group) => {
98 | const list = (self.assets[group] || {})[type];
99 | return list ? acc.concat(list) : acc;
100 | }, []).map(item => item.url);
101 | }
102 |
--------------------------------------------------------------------------------
/packages/plover/test/util/invoker.js:
--------------------------------------------------------------------------------
1 | const co = require('co');
2 |
3 | const invoker = require('../../lib/util/invoker');
4 |
5 | /* eslint require-yield: 0 */
6 |
7 | describe('util/invoker', function() {
8 | it('.filter', function() {
9 | const ctx = {};
10 |
11 | const f1 = {
12 | before: function* () {
13 | this.f1 = 'hello';
14 | this.should.equal(ctx);
15 | }
16 | };
17 |
18 | const f2 = {
19 | before: function() {
20 | this.f2 = 'world';
21 | }
22 | };
23 |
24 |
25 | const f3 = {};
26 |
27 | const list = [
28 | { filter: f1 },
29 | { filter: f2 },
30 | { filter: f3 }
31 | ];
32 |
33 | return co(function* () {
34 | yield invoker.filter(list, 'before', ctx);
35 | ctx.f1.should.equal('hello');
36 | ctx.f2.should.equal('world');
37 | });
38 | });
39 |
40 |
41 | it('.filter - break with false', function() {
42 | const ctx = { };
43 |
44 | const f1 = {
45 | before: async function() {
46 | this.f1 = 'hello';
47 | return false;
48 | }
49 | };
50 |
51 | const f2 = {
52 | before: function* () {
53 | this.f2 = 'world';
54 | }
55 | };
56 |
57 | const list = [
58 | { filter: f1 },
59 | { filter: f2 }
60 | ];
61 |
62 | return co(function* () {
63 | yield invoker.filter(list, 'before', ctx);
64 | ctx.f1.should.equal('hello');
65 | (ctx.f2 === undefined).should.be.true();
66 | });
67 | });
68 |
69 |
70 | it('.filter - break with object', function() {
71 | const ctx = { };
72 | const f1 = {
73 | before: function() {
74 | return { context: 'hello world' };
75 | }
76 | };
77 | const f2 = {
78 | before: function() {
79 | }
80 | };
81 | const list = [
82 | { filter: f1 },
83 | { filter: f2 }
84 | ];
85 |
86 | co(function* () {
87 | const o = yield invoker.filter(list, 'before', ctx);
88 | o.should.eql({ context: 'hello world' });
89 | });
90 | });
91 |
92 |
93 | it('.filter - reverse', function() {
94 | const bag = [];
95 |
96 | const f1 = {
97 | before: function() {
98 | bag.push('hello');
99 | }
100 | };
101 |
102 | const f2 = {
103 | before: function() {
104 | bag.push('world');
105 | }
106 | };
107 |
108 | const list = [
109 | { filter: f1 },
110 | { filter: f2 }
111 | ];
112 |
113 | return co(function* () {
114 | yield invoker.filter(list, 'before', {}, true);
115 | bag.should.eql(['world', 'hello']);
116 | });
117 | });
118 | });
119 |
120 |
--------------------------------------------------------------------------------
/packages/plover-assets/test/middleware.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const co = require('co');
3 | const fs = require('fs-extra');
4 | const mm = require('plover-test-mate');
5 |
6 | const util = require('../lib/util/util');
7 | const middleware = require('../lib/middleware');
8 | const handler = require('../lib/handler');
9 |
10 |
11 | describe('middleware', function() {
12 | const root = pathUtil.join(__dirname, './fixtures/app');
13 | const app = mm({ applicationRoot: root });
14 |
15 | app.addMiddleware(middleware);
16 | app.use(ctx => {
17 | ctx.body = 'ok';
18 | });
19 |
20 | handler.add('css', '.less', LessHandler);
21 |
22 | before(function() {
23 | fs.emptyDirSync(pathUtil.join(root, 'tmp'));
24 | });
25 |
26 |
27 | it('should yield next if not an assets request', function() {
28 | return app.get('/hello').expect('ok');
29 | });
30 |
31 |
32 | it('module assets', function() {
33 | return app.get('/g/index/css/view.css')
34 | .expect('body { }\n');
35 | });
36 |
37 |
38 | it('module assets with handler', function() {
39 | return app.get('/g/index/css/test.css')
40 | .expect('compiled: body: {}\n');
41 | });
42 |
43 |
44 | it('module assets not exists', function() {
45 | return app.get('/g/index/css/not-exists.css')
46 | .expect(404);
47 | });
48 |
49 |
50 | it('concat assets', function() {
51 | return app.get('/g/??index.html,index/js/a.js,index/js/b.js,index/css/test.css,not-found.js') // eslint-disable-line
52 | .expect('Hello World\n\nvar a = 1;\n\nvar b = 2;\n\ncompiled: body: {}\n\n');
53 | });
54 |
55 |
56 | const myapp = mm({ applicationRoot: root, env: 'production' });
57 | myapp.addMiddleware(middleware);
58 |
59 | it('should with cache when run in no dev mode', function() {
60 | return co(function* () {
61 | const url = '/g/index/css/test.css';
62 | const cachePath = util.getCachePath(url, myapp.settings);
63 | fs.existsSync(cachePath).should.not.true();
64 | const expect = 'compiled: body: {}\n';
65 |
66 | yield myapp.get(url).expect(expect);
67 |
68 | fs.existsSync(cachePath).should.be.true();
69 |
70 | yield myapp.get(url).expect(expect);
71 | });
72 | });
73 |
74 |
75 | it('direct access /public file when run in no dev mode', function() {
76 | return myapp.get('/g/index.html').expect('Hello World\n');
77 | });
78 |
79 |
80 | it('module not found', function() {
81 | return app.get('/g/not-exists/js/view.js')
82 | .expect(404);
83 | });
84 |
85 |
86 | it('invalid module assets url', function() {
87 | return app.get('/g/abc.js')
88 | .expect(404);
89 | });
90 | });
91 |
92 |
93 | function LessHandler(path, source) {
94 | return 'compiled: ' + source;
95 | }
96 |
97 |
--------------------------------------------------------------------------------
/packages/plover-router/test/plugin.js:
--------------------------------------------------------------------------------
1 | const mm = require('plover-test-mate');
2 |
3 |
4 | describe('plover-route/lib/plugin', () => {
5 | it('config routes', async() => {
6 | const app = create({
7 | applicationRoot: __dirname,
8 | routes: r => {
9 | r.get('/profile', 'users#show');
10 | r.use('/hello', ctx => {
11 | ctx.body = 'hello';
12 | });
13 | }
14 | });
15 |
16 | app.use(ctx => {
17 | if (ctx.route) {
18 | ctx.body = ctx.route;
19 | }
20 | });
21 |
22 | await app.get('/profile').expect({
23 | module: 'users',
24 | action: 'show',
25 | query: {}
26 | });
27 |
28 | await app.get('/hello').expect('hello');
29 | });
30 |
31 |
32 | it('routes with namespace', async() => {
33 | const app = create({
34 | applicationRoot: __dirname,
35 | disableDefaultRouter: true,
36 | routes: r => {
37 | r.namespace('/users', () => {
38 | r.use(async(ctx, next) => {
39 | await next();
40 | if (ctx.route) {
41 | ctx.body = ctx.route.url;
42 | } else {
43 | ctx.body = ctx.path;
44 | }
45 | });
46 |
47 | r.get('config', 'users#config');
48 | });
49 | }
50 | });
51 |
52 | await app.get('/users/config').expect('users:config');
53 | await app.get('/users/messages').expect('/users/messages');
54 | await app.get('/users/').expect('/users/');
55 | await app.get('/users').expect(404);
56 | });
57 |
58 |
59 | it('routes not config, for coverage', () => {
60 | create({
61 | applicationRoot: __dirname
62 | });
63 |
64 | (true).should.be.ok();
65 | });
66 |
67 |
68 | describe('http method', () => {
69 | const app = create({
70 | applicationRoot: __dirname,
71 | web: {
72 | csrf: {
73 | ignore: ['/*']
74 | }
75 | }
76 | });
77 |
78 | app.use(ctx => {
79 | ctx.body = ctx.method;
80 | });
81 |
82 | it('normal post', async() => {
83 | await app.agent.post('/save')
84 | .send({})
85 | .expect('POST');
86 | });
87 |
88 |
89 | it('put with _method', async() => {
90 | await app.agent.post('/update')
91 | .send({ _method: 'put' })
92 | .expect('PUT');
93 | });
94 |
95 |
96 | it('patch with header: x-http-method-override', async() => {
97 | await app.agent.post('/update')
98 | .set('X-HTTP-Method-Override', 'patch')
99 | .expect('PATCH');
100 | });
101 | });
102 | });
103 |
104 |
105 | function create(opts) {
106 | const app = mm(opts);
107 | app.install('plover-web');
108 | app.install(require('../lib/plugin'));
109 | return app;
110 | }
111 |
--------------------------------------------------------------------------------
/packages/plover-web/test/plugin.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 | const request = require('supertest');
3 | const plover = require('plover');
4 |
5 | const plugin = require('../lib/plugin');
6 |
7 |
8 | describe('plover-web/plugin', function() {
9 | const root = pathUtil.join(__dirname, './fixtures/app');
10 | const settings = require(pathUtil.join(root, 'config/app.js'));
11 | const app = plover(settings);
12 |
13 | plugin(app);
14 | hello(app);
15 | login(app);
16 |
17 | const agent = request.agent(app.callback());
18 |
19 | it('etag and rtime', () => {
20 | return agent.get('/hello')
21 | .expect(function(res) {
22 | res.header.etag.should.not.empty();
23 | res.header['x-response-time'].should.not.empty();
24 | })
25 | .expect('hello');
26 | });
27 |
28 |
29 | it('favicon', () => {
30 | return agent.get('/favicon.ico').expect(200);
31 | });
32 |
33 |
34 | it('static', () => {
35 | return agent.get('/ok.txt').expect('ok!\n');
36 | });
37 |
38 |
39 | it('compress', () => {
40 | return agent.get('/big.txt')
41 | .expect('Content-Encoding', 'gzip');
42 | });
43 |
44 |
45 | it('not setting.web', () => {
46 | const myapp = plover({ applicationRoot: __dirname });
47 | plugin(myapp);
48 | hello(myapp);
49 | return request(myapp.callback())
50 | .get('/hello').expect('hello');
51 | });
52 |
53 |
54 | it('security headers', () => {
55 | return agent.get('/hello')
56 | .expect('X-XSS-Protection', '1; mode=block')
57 | .expect('X-Content-Type-Options', 'nosniff')
58 | .expect('X-Download-Options', 'noopen');
59 | });
60 |
61 |
62 | it('session', async() => {
63 | await agent.get('/login').expect('ok');
64 | await agent.get('/user').expect({ name: 'tester' });
65 | });
66 |
67 |
68 | it('cors', async() => {
69 | await agent.get('/hello')
70 | .set('Host', 'www.google.com')
71 | .set('Origin', 'http://www.google.com:8080')
72 | .expect('hello')
73 | .expect('access-control-allow-origin', 'http://www.google.com:8080');
74 |
75 | const res = await agent.get('/hello')
76 | .set('Origin', 'http://www.google.com:8080');
77 |
78 | res.text.should.equal('hello');
79 | (res.headers['access-control-allow-origin'] === undefined).should.ok();
80 | });
81 | });
82 |
83 |
84 | function hello(app) {
85 | app.use(async(ctx, next) => {
86 | if (ctx.path === '/hello') {
87 | ctx.body = 'hello';
88 | } else {
89 | await next();
90 | }
91 | });
92 | }
93 |
94 |
95 | function login(app) {
96 | app.use(async(ctx, next) => {
97 | if (ctx.path === '/login') {
98 | ctx.session.user = { name: 'tester' };
99 | ctx.body = 'ok';
100 | } else if (ctx.path === '/user') {
101 | ctx.body = ctx.session.user;
102 | } else {
103 | await next();
104 | }
105 | });
106 | }
107 |
--------------------------------------------------------------------------------
/packages/plover-assets/lib/util/scan-dir.js:
--------------------------------------------------------------------------------
1 | const fs = require('fs');
2 | const pathUtil = require('path');
3 | const minimatch = require('minimatch');
4 |
5 |
6 | const debug = require('debug')('plover-assets-util:scan-dir');
7 |
8 |
9 | /**
10 | * scan dir files with ignore or match rules
11 | *
12 | * @param {String} dir - dir for scan
13 | * @param {Object} options - options
14 | * {
15 | * match: {Array} - match rules
16 | * ignore: {Array} - ignore rules
17 | * relative: {String} - relative path, use dir for default
18 | * }
19 | * @return {Array} - paths
20 | */
21 | module.exports = function(dir, options) {
22 | options = options || {};
23 |
24 | const results = [];
25 |
26 | const opts = {
27 | dirMatch: [],
28 | fileMatch: [],
29 | dirIgnore: [],
30 | fileIgnore: [],
31 | relative: options.relative || dir
32 | };
33 |
34 | makeRules(options.match, opts.dirMatch, opts.fileMatch);
35 | makeRules(options.ignore, opts.dirIgnore, opts.fileIgnore);
36 |
37 | const matchOnly = options.match && !options.ignore;
38 | opts.fileMatchOnly = matchOnly && opts.fileMatch.length;
39 | opts.dirMatchOnly = matchOnly && !opts.fileMatch.length;
40 |
41 | scan(dir, dir, opts, results);
42 |
43 | return results;
44 | };
45 |
46 |
47 | function scan(root, dir, options, results) {
48 | const files = fs.readdirSync(dir);
49 | files.forEach(file => {
50 | const path = pathUtil.join(dir, file);
51 | const stat = fs.statSync(path);
52 | const rpath = pathUtil.relative(options.relative, path);
53 |
54 | /* istanbul ignore else */
55 | if (stat.isFile()) {
56 | if (test(
57 | file, rpath,
58 | options.fileMatch, options.fileIgnore, options.fileMatchOnly
59 | )) {
60 | results.push(path);
61 | }
62 | } else if (stat.isDirectory()) {
63 | if (test(
64 | file, rpath,
65 | options.dirMatch, options.dirIgnore, options.dirMatchOnly
66 | )) {
67 | scan(root, path, options, results);
68 | }
69 | }
70 | });
71 | }
72 |
73 |
74 | function makeRules(patterns, dirRules, fileRules) {
75 | const rDir = /\/$/;
76 | const toRe = pattern => minimatch.makeRe(pattern);
77 | patterns && patterns.forEach(pattern => {
78 | if (rDir.test(pattern)) {
79 | pattern = pattern.replace(rDir, '');
80 | dirRules.push(toRe(pattern));
81 | } else {
82 | fileRules.push(toRe(pattern));
83 | }
84 | });
85 | }
86 |
87 |
88 | /* eslint max-params: [2, 5] */
89 | function test(file, rpath, match, ignore, matchOnly) {
90 | debug(
91 | 'test: %s, match: %o, ignore: %o, matchOnly: %s',
92 | rpath, match, ignore, matchOnly
93 | );
94 |
95 | const fn = re => re.test(rpath);
96 | if (match.length && match.some(fn)) {
97 | return true;
98 | }
99 | if (matchOnly) {
100 | return false;
101 | }
102 | if (ignore.length && ignore.some(fn)) {
103 | return false;
104 | }
105 | return !file.startsWith('.');
106 | }
107 |
108 |
--------------------------------------------------------------------------------
/packages/plover-module-resolver/test/get-module-info.js:
--------------------------------------------------------------------------------
1 | const pathUtil = require('path');
2 |
3 | const getModuleInfo = require('../lib/get-module-info');
4 |
5 |
6 | /* global __dirname */
7 |
8 |
9 | describe('plover-module-resolver/lib/getModuleInfo(path)', function() {
10 | it('取得模块信息', function() {
11 | const path = pathUtil.join(__dirname, 'fixtures/hello');
12 | const info = getModuleInfo(path);
13 | info.should.eql({
14 | name: 'hello',
15 | version: '0.0.0',
16 | assets: true,
17 | assetsRoot: 'assets/',
18 | path: path,
19 | views: {
20 | view: {
21 | template: 'views/view.art',
22 | js: 'js/view.js',
23 | css: 'css/view.css'
24 | },
25 |
26 | item: {
27 | template: 'views/item.ejs',
28 | js: undefined,
29 | css: 'css/item.css'
30 | },
31 |
32 | edit: {
33 | template: 'views/edit.form',
34 | js: 'js/edit.js',
35 | css: undefined
36 | },
37 |
38 | 'controls/shop': {
39 | template: 'views/controls/shop.art',
40 | js: undefined,
41 | css: 'css/controls/shop.css'
42 | }
43 | }
44 | });
45 | });
46 |
47 |
48 | it('空目录不算模块或目录不存都不算模块', function() {
49 | const path = pathUtil.join(__dirname, 'fixtures/empty');
50 | let info = getModuleInfo(path);
51 | (!!info).should.not.be.ok();
52 |
53 | info = getModuleInfo('notexist');
54 | (!!info).should.not.be.ok();
55 | });
56 |
57 |
58 | it('package.json存在plover节点不存在也不能算模块', function() {
59 | const path = pathUtil.join(__dirname, 'fixtures/withpkg');
60 | const info = getModuleInfo(path, { ensure: true });
61 | (!!info).should.not.be.ok();
62 | });
63 |
64 |
65 | it('没有package.json的模块', function() {
66 | const path = pathUtil.join(__dirname, 'fixtures/simple');
67 | const info = getModuleInfo(path);
68 | info.should.eql({
69 | name: 'simple',
70 | version: '0.0.0',
71 | path: path,
72 | views: {}
73 | });
74 | });
75 |
76 |
77 | it('纯assets模块', function() {
78 | const path = pathUtil.join(__dirname, 'fixtures/pureassets');
79 | const info = getModuleInfo(path);
80 | info.should.eql({
81 | name: 'pureassets',
82 | version: '0.0.0',
83 | path: path,
84 | views: {},
85 | assets: true,
86 | assetsRoot: ''
87 | });
88 | });
89 |
90 |
91 | it('不包含assets的模块', function() {
92 | const path = pathUtil.join(__dirname, 'fixtures/noassets');
93 | const info = getModuleInfo(path);
94 | info.should.eql({
95 | name: 'noassets',
96 | version: '0.0.0',
97 | path: path,
98 | views: {}
99 | });
100 | });
101 |
102 |
103 | it('无效的package.json会输出文件路径信息方便排查', function() {
104 | const path = pathUtil.join(__dirname, 'fixtures/invalid-json');
105 | const pkgPath = pathUtil.join(path, 'package.json');
106 | (function() {
107 | getModuleInfo(path);
108 | }).should.throw(`invalid json file: ${pkgPath}`);
109 | });
110 | });
111 |
112 |
--------------------------------------------------------------------------------
Big 2
46 |-
47 |
- 126 Hi 48 |
50 |
53 |