Merge pull request #3 from nicocoul/dev

add ci

.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: Test
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x, 16.x]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install
+      run: npm install
+    - name: Test
+      run: |
+        npm run test:coverage --if-present
+        npm run lint --if-present
+    - name: Coveralls
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}

.npmignore

@@ -1,6 +1,6 @@
 .npmignore
 .gitignore
-.eslintrc
+.eslintrc.js
 .git/
 .lock-*
 node_modules/
@@ -14,4 +14,4 @@ cli/
 coverage/
 img/
 mrd/
-*.tpl
+.github/

README.md

@@ -1,4 +1,5 @@
-Ya Rfc (Remote Function Execution) is a [rpc](https://en.wikipedia.org/wiki/Remote_procedure_call) library for Node js.
+# ya-rfc [![npm version](https://badge.fury.io/js/ya-rfc.svg)](http://badge.fury.io/js/ya-rfc) [![license](https://img.shields.io/npm/l/ya-rfc.svg)](http://badge.fury.io/js/ya-rfc) [![test](https://github.com/nicocoul/ya-rfc/actions/workflows/test.yml/badge.svg)](https://github.com/nicocoul/ya-rfc/actions/workflows/test.yml) [![Coverage](https://coveralls.io/repos/github/nicocoul/ya-rfc/badge.svg?branch=main)](https://coveralls.io/github/nicocoul/ya-rfc?branch=main) [![Activity](https://img.shields.io/github/commit-activity/m/nicocoul/ya-rfc)](https://github.com/badges/shields/pulse)
+Ya Rfc (Remote Function Call) is a [rpc](https://en.wikipedia.org/wiki/Remote_procedure_call) library for Node js.
 
 Integrates well with [ya-pubsub](https://www.npmjs.com/package/ya-pubsub).
 

cli/README.md.tpl

@@ -0,0 +1,30 @@
+# ya-rfc [![npm version](https://badge.fury.io/js/ya-rfc.svg)](http://badge.fury.io/js/ya-rfc) [![license](https://img.shields.io/npm/l/ya-rfc.svg)](http://badge.fury.io/js/ya-rfc) [![test](https://github.com/nicocoul/ya-rfc/actions/workflows/test.yml/badge.svg)](https://github.com/nicocoul/ya-rfc/actions/workflows/test.yml) [![Coverage](https://coveralls.io/repos/github/nicocoul/ya-rfc/badge.svg?branch=main)](https://coveralls.io/github/nicocoul/ya-rfc?branch=main) [![Activity](https://img.shields.io/github/commit-activity/m/nicocoul/ya-rfc)](https://github.com/badges/shields/pulse)
+Ya Rfc (Remote Function Call) is a [rpc](https://en.wikipedia.org/wiki/Remote_procedure_call) library for Node js.
+
+Integrates well with [ya-pubsub](https://www.npmjs.com/package/ya-pubsub).
+
+### Key Features
+* asynchronous
+* embeddable
+* designed for micro-services
+
+### Execution Flow
+![basic execution flow](https://github.com/nicocoul/ya-rfc/blob/dev/img/basicExecFlow.png)
+
+### Basic Example
+Given a module accessible by the RFC server
+```javascript
+{{{examples.procedures}}}
+```
+function 'count' can be executed remotely over tcp
+```javascript
+{{{examples.tcp}}}
+```
+or over websockets
+```javascript
+{{{examples.ws}}}
+```
+
+## Versioning
+
+Yaps-node uses [Semantic Versioning](http://semver.org/) for predictable versioning.

cli/render-readme.js

@@ -33,6 +33,6 @@ fs.readdirSync(mrdPath).forEach(entry => {
   convert(path.join(mrdPath, entry), path.join(imgPath, `${path.parse(entry).name}.png`))
 })
 
-const template = fs.readFileSync(path.join(__dirname, '..', 'README.md.tpl'), { encoding: 'utf8' })
+const template = fs.readFileSync(path.join(__dirname, 'README.md.tpl'), { encoding: 'utf8' })
 const result = mustache.render(template, { examples })
 fs.writeFileSync(path.join(__dirname, '..', 'README.md'), result, { encoding: 'utf8' })

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ya-rfc",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "",
   "main": "index.js",
   "author": "Nicolas Coulon <coulon_nicolas@hotmail.com> (https://github.com/nicocoul)",

tests/brokers/rpc.test.js

@@ -7,7 +7,7 @@ const rpcBroker = require('../../lib/brokers/rpc')
 const rpcServer = require('../../lib/clients/rpc-server')
 
 function newRpcServer (channel) {
-  return rpcServer.create(channel, path.join(__dirname, 'fixtures', 'rpc-module'))
+  return rpcServer.create(channel, path.join(__dirname, '..', 'fixtures', 'rpc-module'))
 }
 
 describe('Rpc broker', () => {

tests/clients/rpc-server.test.js

@@ -5,7 +5,7 @@ const { COMMANDS } = yac.constants
 const rpc = require('../../lib/clients/rpc-server')
 const logger = yac.logger(__filename)
 
-const modulePath = path.join(__dirname, 'fixtures', 'rpc-module')
+const modulePath = path.join(__dirname, '..', 'fixtures', 'rpc-module')
 
 describe('Rcp server', () => {
   test('executes a function that returns a value', async () => {

tests/clients/rpc-worker.test.js

@@ -4,7 +4,7 @@ const path = require('path')
 
 function createWorker () {
   const result = fork(path.join(__dirname, '..', '..', 'lib', 'clients', 'rpc-worker.js'))
-  result.send({ modulePath: path.join(__dirname, 'fixtures', 'rpc-module') })
+  result.send({ modulePath: path.join(__dirname, '..', 'fixtures', 'rpc-module') })
   return result
 }
 

tests/e2e/rpc-tcp.test.js

@@ -12,7 +12,7 @@ const netChannel = yac.channels.net
 
 function newServer (port) {
   const channel = netChannel('localhost', port)
-  return rpcServer.create(channel, path.join(__dirname, 'fixtures', 'rpc-module'))
+  return rpcServer.create(channel, path.join(__dirname, '..', 'fixtures', 'rpc-module'))
 }
 
 function newClient (port) {