Skip to content

refactor: Remove ixml refs in ProgramCall #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
abmusse merged 1 commit into from
Feb 21, 2020
Merged

refactor: Remove ixml refs in ProgramCall #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion lib/Deprecated.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
// previous versions, but will throw a warning message. When we no longer want to support calling
// these methods through these deprecated class names, we can simple disable this file.

/* eslint-disable max-classes-per-file */

const deprecate = require('depd');

const iPgmDeprecate = deprecate('iPgm');
Expand Down Expand Up @@ -66,6 +68,11 @@ class iPgm {
* @param {*} inDs
*/
addParam(data, type, options, inDs) {
if (!Array.isArray(data) && !type) {
iPgmDeprecate('defaulting parameter type to 1024a has been deprecated. You should specify a type instead.');
// eslint-disable-next-line no-param-reassign
type = '1024a';
}
iPgmDeprecate('As of v1.0, \'iPgm.addParam()\' is deprecated. Please use \'ProgramCall.addParam()\' instead.');
return this.ProgramCall.addParam(data, type, options, inDs);
}
Expand All @@ -76,7 +83,12 @@ class iPgm {
* @param {string} type
* @param {object} [options]
*/
addReturn(data, type, options) {
addReturn(data, type = '1024a', options) {
if (!type) {
iPgmDeprecate('defaulting return type to 1024a has been deprecated. You should specify a type instead.');
// eslint-disable-next-line no-param-reassign
type = '1024a';
}
iPgmDeprecate('As of v1.0, \'iPgm.addReturn()\' is deprecated. Please use \'ProgramCall.addParam()\' instead.');
return this.ProgramCall.addReturn(data, type, options);
}
Expand Down
70 changes: 44 additions & 26 deletions lib/ProgramCall.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,18 @@
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

const iXml = require('./ixml');

class ProgramCall {
/**
* @description creates a new ProgramCall object
* @constructor
* @param {string} program
* @param {object} [options]
*/
constructor(program, options) {
if (options && typeof options === 'object') {
// add options if they exist, or empty string if they don't
this.xml = iXml.iXmlNodePgmOpen(program,
options.lib !== undefined ? options.lib : '',
options.func !== undefined ? options.func : '',
options.error !== undefined ? options.error : '');
} else {
this.xml = iXml.iXmlNodePgmOpen(program, '', '', '');
}
constructor(program, options = {}) {
this.xml = `<pgm name='${program}'`;
if (options.lib) this.xml += ` lib='${options.lib}'`;
if (options.func) this.xml += ` func='${options.func}'`;
this.xml += ` error='${options.error || 'fast'}'>`;
}

/**
Expand All @@ -51,28 +44,46 @@ class ProgramCall {
opt = type;
} else {
opt = options;
if (!type) {
throw new Error('Specifying the parameter type is required.');
}
}

if (!inDs) { // In recursive mode, if it is an element in DS, then no <parm> or </parm> needed.
this.xml += iXml.iXmlNodeParmOpen(opt);
this.xml += '<parm';
if (opt && typeof opt === 'object') { // append <param> options
if (opt.io) { this.xml += ` io='${opt.io}'`; }
if (opt.by) { this.xml += ` by='${opt.by}'`; }
}
this.xml += '>';
}

if (Array.isArray(data)) { // If it is a struct parameter, recursivly parse its children.
if (opt) {
this.xml += iXml.iXmlNodeDsOpen(opt.dim, opt.dou, opt.len, opt.data);
} else {
this.xml += iXml.iXmlNodeDsOpen('', '', '', '');
if (Array.isArray(data)) { // If it is a struct parameter, recursively parse its children.
this.xml += '<ds';
if (opt && typeof opt === 'object') { // append <ds> options
if (opt.dim) { this.xml += ` dim='${opt.dim}'`; }
if (opt.dou) { this.xml += ` dou='${opt.dou}'`; }
if (opt.len) { this.xml += ` len='${opt.len}'`; }
if (opt.data) { this.xml += ` data='${opt.data}'`; }
}
this.xml += '>';

for (let i = 0; i < data.length; i += 1) {
this.addParam(data[i][0], data[i][1], data[i][2], true);
}
this.xml += iXml.iXmlNodeDsClose();
this.xml += '</ds>';
} else { // A simple parameter
this.xml += iXml.iXmlNodeDataOpen(type, opt) + data + iXml.iXmlNodeDataClose();
this.xml += `<data type='${type}'`;
if (opt && typeof opt === 'object') { // append <data> options
Object.keys(opt).forEach((key) => {
this.xml += ` ${key}='${opt[key]}'`;
});
}
this.xml += `>${data}</data>`;
}

if (!inDs) { // In recursive mode, if it is an element in DS, then no <parm> or </parm> needed.
this.xml += iXml.iXmlNodeParmClose();
this.xml += '</parm>';
}
}

Expand All @@ -83,21 +94,28 @@ class ProgramCall {
* @param {object} [options]
*/
addReturn(data, type, options = null) {
this.xml += iXml.iXmlNodeReturnOpen();
if (!type) {
throw new Error('Specifying the return type is required.');
}
this.xml += '<return>';

if (options && typeof options === 'object') {
this.xml += iXml.iXmlNodeDataOpen(type, options);
this.xml += `<data type='${type}'`;
Object.keys(options).forEach((key) => {
this.xml += ` ${key}='${options[key]}'`;
});
} else {
this.xml += iXml.iXmlNodeDataOpen(type);
this.xml += `<data type='${type}'`;
}
this.xml += data + iXml.iXmlNodeDataClose() + iXml.iXmlNodeReturnClose();
this.xml += `>${data}</data></return>`;
}

/**
* @description returns the current program XML
* @returns {string} - the generated program XML
*/
toXML() {
return this.xml + iXml.iXmlNodePgmClose();
return `${this.xml}</pgm>`;
}
}

Expand Down
29 changes: 0 additions & 29 deletions lib/ixml.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,49 +35,20 @@ module.exports.iXmlNodeScriptOpen = () => '<myscript>';

module.exports.iXmlNodeScriptClose = () => '</myscript>';

module.exports.iXmlNodePgmOpen = (xname, xlib, xfunc, xerror) => `<pgm${iXmlAttrDefault('name', xname, 'undefined')}${iXmlAttrDefault('lib', xlib, '')}${iXmlAttrDefault('func', xfunc, '')}${iXmlAttrDefault('error', xerror, 'fast')}>`;

module.exports.iXmlNodePgmClose = () => '</pgm>';

module.exports.iXmlNodeParmOpen = (opt) => {
if (!(opt && typeof opt === 'object')) {
return '<parm>';
}

const io = (opt.io) ? iXmlAttrDefault('io', opt.io, '') : '';
const by = (opt.by) ? iXmlAttrDefault('by', opt.by, '') : '';

return `<parm${io}${by}>`;
};

module.exports.iXmlNodeParmClose = () => '</parm>';

module.exports.iXmlNodeReturnOpen = () => '<return>';

module.exports.iXmlNodeReturnClose = () => '</return>';

module.exports.iXmlNodeOverlayOpen = (xio, xoffset, xtop) => `<overlay${iXmlAttrDefault('io', xio, 'both')}${iXmlAttrDefault('offset', xoffset, '')}${iXmlAttrDefault('top', xtop, '')}>`;

module.exports.iXmlNodeOverlayClose = () => '</overlay>';

module.exports.iXmlNodeDsOpen = (xdim, xdou, xlen, xdata) => `<ds${iXmlAttrDefault('dim', xdim, '')}${iXmlAttrDefault('dou', xdou, '')}${iXmlAttrDefault('len', xlen, '')}${iXmlAttrDefault('data', xdata, '')}>`;

module.exports.iXmlNodeDsClose = () => '</ds>';

module.exports.iXmlNodeDataOpen = (xtype, options) => {
let result = `<data${iXmlAttrDefault('type', xtype, '1024a')}`;

if (options && typeof options === 'object') {
Object.keys(options).forEach((key) => {
result += iXmlAttrDefault(key, options[key], '1024a');
});
}

result += '>';
return result;
};

module.exports.iXmlNodeDataClose = () => '</data>';

module.exports.iXmlNodeCmdOpen = (xexec, xhex, xbefore, xafter, xerror) => `<cmd${iXmlAttrDefault('exec', xexec, 'system')}${iXmlAttrDefault('hex', xhex, '')}${iXmlAttrDefault('before', xbefore, '')}${iXmlAttrDefault('after', xafter, '')}${iXmlAttrDefault('error', xerror, 'fast')}>`;

Expand Down