spyne-cli 0.3.0

package/lib/prompts/scale.js

@@ -0,0 +1,237 @@
+'use strict';
+
+const colors = require('ansi-colors');
+const ArrayPrompt = require('../types/array');
+const utils = require('../utils');
+
+class LikertScale extends ArrayPrompt {
+  constructor(options = {}) {
+    super(options);
+    this.widths = [].concat(options.messageWidth || 50);
+    this.align = [].concat(options.align || 'left');
+    this.linebreak = options.linebreak || false;
+    this.edgeLength = options.edgeLength || 3;
+    this.newline = options.newline || '\n   ';
+    let start = options.startNumber || 1;
+    if (typeof this.scale === 'number') {
+      this.scaleKey = false;
+      this.scale = Array(this.scale).fill(0).map((v, i) => ({ name: i + start }));
+    }
+  }
+
+  async reset() {
+    this.tableized = false;
+    await super.reset();
+    return this.render();
+  }
+
+  tableize() {
+    if (this.tableized === true) return;
+    this.tableized = true;
+    let longest = 0;
+
+    for (let ch of this.choices) {
+      longest = Math.max(longest, ch.message.length);
+      ch.scaleIndex = ch.initial || 2;
+      ch.scale = [];
+
+      for (let i = 0; i < this.scale.length; i++) {
+        ch.scale.push({ index: i });
+      }
+    }
+    this.widths[0] = Math.min(this.widths[0], longest + 3);
+  }
+
+  async dispatch(s, key) {
+    if (this.multiple) {
+      return this[key.name] ? await this[key.name](s, key) : await super.dispatch(s, key);
+    }
+    this.alert();
+  }
+
+  heading(msg, item, i) {
+    return this.styles.strong(msg);
+  }
+
+  separator() {
+    return this.styles.muted(this.symbols.ellipsis);
+  }
+
+  right() {
+    let choice = this.focused;
+    if (choice.scaleIndex >= this.scale.length - 1) return this.alert();
+    choice.scaleIndex++;
+    return this.render();
+  }
+
+  left() {
+    let choice = this.focused;
+    if (choice.scaleIndex <= 0) return this.alert();
+    choice.scaleIndex--;
+    return this.render();
+  }
+
+  indent() {
+    return '';
+  }
+
+  format() {
+    if (this.state.submitted) {
+      let values = this.choices.map(ch => this.styles.info(ch.index));
+      return values.join(', ');
+    }
+    return '';
+  }
+
+  pointer() {
+    return '';
+  }
+
+  /**
+   * Render the scale "Key". Something like:
+   * @return {String}
+   */
+
+  renderScaleKey() {
+    if (this.scaleKey === false) return '';
+    if (this.state.submitted) return '';
+    let scale = this.scale.map(item => `   ${item.name} - ${item.message}`);
+    let key = ['', ...scale].map(item => this.styles.muted(item));
+    return key.join('\n');
+  }
+
+  /**
+   * Render the heading row for the scale.
+   * @return {String}
+   */
+
+  renderScaleHeading(max) {
+    let keys = this.scale.map(ele => ele.name);
+    if (typeof this.options.renderScaleHeading === 'function') {
+      keys = this.options.renderScaleHeading.call(this, max);
+    }
+    let diff = this.scaleLength - keys.join('').length;
+    let spacing = Math.round(diff / (keys.length - 1));
+    let names = keys.map(key => this.styles.strong(key));
+    let headings = names.join(' '.repeat(spacing));
+    let padding = ' '.repeat(this.widths[0]);
+    return this.margin[3] + padding + this.margin[1] + headings;
+  }
+
+  /**
+   * Render a scale indicator => ◯ or ◉ by default
+   */
+
+  scaleIndicator(choice, item, i) {
+    if (typeof this.options.scaleIndicator === 'function') {
+      return this.options.scaleIndicator.call(this, choice, item, i);
+    }
+    let enabled = choice.scaleIndex === item.index;
+    if (item.disabled) return this.styles.hint(this.symbols.radio.disabled);
+    if (enabled) return this.styles.success(this.symbols.radio.on);
+    return this.symbols.radio.off;
+  }
+
+  /**
+   * Render the actual scale => ◯────◯────◉────◯────◯
+   */
+
+  renderScale(choice, i) {
+    let scale = choice.scale.map(item => this.scaleIndicator(choice, item, i));
+    let padding = this.term === 'Hyper' ? '' : ' ';
+    return scale.join(padding + this.symbols.line.repeat(this.edgeLength));
+  }
+
+  /**
+   * Render a choice, including scale =>
+   *   "The website is easy to navigate. ◯───◯───◉───◯───◯"
+   */
+
+  async renderChoice(choice, i) {
+    await this.onChoice(choice, i);
+
+    let focused = this.index === i;
+    let pointer = await this.pointer(choice, i);
+    let hint = await choice.hint;
+
+    if (hint && !utils.hasColor(hint)) {
+      hint = this.styles.muted(hint);
+    }
+
+    let pad = str => this.margin[3] + str.replace(/\s+$/, '').padEnd(this.widths[0], ' ');
+    let newline = this.newline;
+    let ind = this.indent(choice);
+    let message = await this.resolve(choice.message, this.state, choice, i);
+    let scale = await this.renderScale(choice, i);
+    let margin = this.margin[1] + this.margin[3];
+    this.scaleLength = colors.unstyle(scale).length;
+    this.widths[0] = Math.min(this.widths[0], this.width - this.scaleLength - margin.length);
+    let msg = utils.wordWrap(message, { width: this.widths[0], newline });
+    let lines = msg.split('\n').map(line => pad(line) + this.margin[1]);
+
+    if (focused) {
+      scale = this.styles.info(scale);
+      lines = lines.map(line => this.styles.info(line));
+    }
+
+    lines[0] += scale;
+
+    if (this.linebreak) lines.push('');
+    return [ind + pointer, lines.join('\n')].filter(Boolean);
+  }
+
+  async renderChoices() {
+    if (this.state.submitted) return '';
+    this.tableize();
+    let choices = this.visible.map(async(ch, i) => await this.renderChoice(ch, i));
+    let visible = await Promise.all(choices);
+    let heading = await this.renderScaleHeading();
+    return this.margin[0] + [heading, ...visible.map(v => v.join(' '))].join('\n');
+  }
+
+  async render() {
+    let { submitted, size } = this.state;
+
+    let prefix = await this.prefix();
+    let separator = await this.separator();
+    let message = await this.message();
+
+    let prompt = '';
+    if (this.options.promptLine !== false) {
+      prompt = [prefix, message, separator, ''].join(' ');
+      this.state.prompt = prompt;
+    }
+
+    let header = await this.header();
+    let output = await this.format();
+    let key = await this.renderScaleKey();
+    let help = await this.error() || await this.hint();
+    let body = await this.renderChoices();
+    let footer = await this.footer();
+    let err = this.emptyError;
+
+    if (output) prompt += output;
+    if (help && !prompt.includes(help)) prompt += ' ' + help;
+
+    if (submitted && !output && !body.trim() && this.multiple && err != null) {
+      prompt += this.styles.danger(err);
+    }
+
+    this.clear(size);
+    this.write([header, prompt, key, body, footer].filter(Boolean).join('\n'));
+    if (!this.state.submitted) {
+      this.write(this.margin[2]);
+    }
+    this.restore();
+  }
+
+  submit() {
+    this.value = {};
+    for (let choice of this.choices) {
+      this.value[choice.name] = choice.scaleIndex;
+    }
+    return this.base.submit.call(this);
+  }
+}
+
+module.exports = LikertScale;

package/lib/prompts/select.js

@@ -0,0 +1,139 @@
+'use strict';
+
+const ArrayPrompt = require('../types/array');
+const utils = require('../utils');
+
+class SelectPrompt extends ArrayPrompt {
+  constructor(options) {
+    super(options);
+    this.emptyError = this.options.emptyError || 'No items were selected';
+  }
+
+  async dispatch(s, key) {
+    if (this.multiple) {
+      return this[key.name] ? await this[key.name](s, key) : await super.dispatch(s, key);
+    }
+    this.alert();
+  }
+
+  separator() {
+    if (this.options.separator) return super.separator();
+    let sep = this.styles.muted(this.symbols.ellipsis);
+    return this.state.submitted ? super.separator() : sep;
+  }
+
+  pointer(choice, i) {
+    return (!this.multiple || this.options.pointer) ? super.pointer(choice, i) : '';
+  }
+
+  indicator(choice, i) {
+    return this.multiple ? super.indicator(choice, i) : '';
+  }
+
+  choiceMessage(choice, i) {
+    let message = this.resolve(choice.message, this.state, choice, i);
+    if (choice.role === 'heading' && !utils.hasColor(message)) {
+      message = this.styles.strong(message);
+    }
+    return this.resolve(message, this.state, choice, i);
+  }
+
+  choiceSeparator() {
+    return ':';
+  }
+
+  async renderChoice(choice, i) {
+    await this.onChoice(choice, i);
+
+    let focused = this.index === i;
+    let pointer = await this.pointer(choice, i);
+    let check = await this.indicator(choice, i) + (choice.pad || '');
+    let hint = await this.resolve(choice.hint, this.state, choice, i);
+
+    if (hint && !utils.hasColor(hint)) {
+      hint = this.styles.muted(hint);
+    }
+
+    let ind = this.indent(choice);
+    let msg = await this.choiceMessage(choice, i);
+    let line = () => [this.margin[3], ind + pointer + check, msg, this.margin[1], hint].filter(Boolean).join(' ');
+
+    if (choice.role === 'heading') {
+      return line();
+    }
+
+    if (choice.disabled) {
+      if (!utils.hasColor(msg)) {
+        msg = this.styles.disabled(msg);
+      }
+      return line();
+    }
+
+    if (focused) {
+      msg = this.styles.em(msg);
+    }
+
+    return line();
+  }
+
+  async renderChoices() {
+    if (this.state.loading === 'choices') {
+      return this.styles.warning('Loading choices');
+    }
+
+    if (this.state.submitted) return '';
+    let choices = this.visible.map(async(ch, i) => await this.renderChoice(ch, i));
+    let visible = await Promise.all(choices);
+    if (!visible.length) visible.push(this.styles.danger('No matching choices'));
+    let result = this.margin[0] + visible.join('\n');
+    let header;
+
+    if (this.options.choicesHeader) {
+      header = await this.resolve(this.options.choicesHeader, this.state);
+    }
+
+    return [header, result].filter(Boolean).join('\n');
+  }
+
+  format() {
+    if (!this.state.submitted || this.state.cancelled) return '';
+    if (Array.isArray(this.selected)) {
+      return this.selected.map(choice => this.styles.primary(choice.name)).join(', ');
+    }
+    return this.styles.primary(this.selected.name);
+  }
+
+  async render() {
+    let { submitted, size } = this.state;
+
+    let prompt = '';
+    let header = await this.header();
+    let prefix = await this.prefix();
+    let separator = await this.separator();
+    let message = await this.message();
+
+    if (this.options.promptLine !== false) {
+      prompt = [prefix, message, separator, ''].join(' ');
+      this.state.prompt = prompt;
+    }
+
+    let output = await this.format();
+    let help = (await this.error()) || (await this.hint());
+    let body = await this.renderChoices();
+    let footer = await this.footer();
+
+    if (output) prompt += output;
+    if (help && !prompt.includes(help)) prompt += ' ' + help;
+
+    if (submitted && !output && !body.trim() && this.multiple && this.emptyError != null) {
+      prompt += this.styles.danger(this.emptyError);
+    }
+
+    this.clear(size);
+    this.write([header, prompt, body, footer].filter(Boolean).join('\n'));
+    this.write(this.margin[2]);
+    this.restore();
+  }
+}
+
+module.exports = SelectPrompt;

package/lib/prompts/snippet.js

@@ -0,0 +1,185 @@
+'use strict';
+
+const colors = require('ansi-colors');
+const interpolate = require('../interpolate');
+const Prompt = require('../prompt');
+
+class SnippetPrompt extends Prompt {
+  constructor(options) {
+    super(options);
+    this.cursorHide();
+    this.reset(true);
+  }
+
+  async initialize() {
+    this.interpolate = await interpolate(this);
+    await super.initialize();
+  }
+
+  async reset(first) {
+    this.state.keys = [];
+    this.state.invalid = new Map();
+    this.state.missing = new Set();
+    this.state.completed = 0;
+    this.state.values = {};
+
+    if (first !== true) {
+      await this.initialize();
+      await this.render();
+    }
+  }
+
+  moveCursor(n) {
+    let item = this.getItem();
+    this.cursor += n;
+    item.cursor += n;
+  }
+
+  dispatch(ch, key) {
+    if (!key.code && !key.ctrl && ch != null && this.getItem()) {
+      this.append(ch, key);
+      return;
+    }
+    this.alert();
+  }
+
+  append(ch, key) {
+    let item = this.getItem();
+    let prefix = item.input.slice(0, this.cursor);
+    let suffix = item.input.slice(this.cursor);
+    this.input = item.input = `${prefix}${ch}${suffix}`;
+    this.moveCursor(1);
+    this.render();
+  }
+
+  delete() {
+    let item = this.getItem();
+    if (this.cursor <= 0 || !item.input) return this.alert();
+    let suffix = item.input.slice(this.cursor);
+    let prefix = item.input.slice(0, this.cursor - 1);
+    this.input = item.input = `${prefix}${suffix}`;
+    this.moveCursor(-1);
+    this.render();
+  }
+
+  increment(i) {
+    return i >= this.state.keys.length - 1 ? 0 : i + 1;
+  }
+
+  decrement(i) {
+    return i <= 0 ? this.state.keys.length - 1 : i - 1;
+  }
+
+  first() {
+    this.state.index = 0;
+    this.render();
+  }
+
+  last() {
+    this.state.index = this.state.keys.length - 1;
+    this.render();
+  }
+
+  right() {
+    if (this.cursor >= this.input.length) return this.alert();
+    this.moveCursor(1);
+    this.render();
+  }
+
+  left() {
+    if (this.cursor <= 0) return this.alert();
+    this.moveCursor(-1);
+    this.render();
+  }
+
+  prev() {
+    this.state.index = this.decrement(this.state.index);
+    this.getItem();
+    this.render();
+  }
+
+  next() {
+    this.state.index = this.increment(this.state.index);
+    this.getItem();
+    this.render();
+  }
+
+  up() {
+    this.prev();
+  }
+
+  down() {
+    this.next();
+  }
+
+  format(value) {
+    let color = this.state.completed < 100 ? this.styles.warning : this.styles.success;
+    if (this.state.submitted === true && this.state.completed !== 100) {
+      color = this.styles.danger;
+    }
+    return color(`${this.state.completed}% completed`);
+  }
+
+  async render() {
+    let { index, keys = [], submitted, size } = this.state;
+
+    let newline = [this.options.newline, '\n'].find(v => v != null);
+    let prefix = await this.prefix();
+    let separator = await this.separator();
+    let message = await this.message();
+
+    let prompt = [prefix, message, separator].filter(Boolean).join(' ');
+    this.state.prompt = prompt;
+
+    let header = await this.header();
+    let error = (await this.error()) || '';
+    let hint = (await this.hint()) || '';
+    let body = submitted ? '' : await this.interpolate(this.state);
+
+    let key = this.state.key = keys[index] || '';
+    let input = await this.format(key);
+    let footer = await this.footer();
+    if (input) prompt += ' ' + input;
+    if (hint && !input && this.state.completed === 0) prompt += ' ' + hint;
+
+    this.clear(size);
+    let lines = [header, prompt, body, footer, error.trim()];
+    this.write(lines.filter(Boolean).join(newline));
+    this.restore();
+  }
+
+  getItem(name) {
+    let { items, keys, index } = this.state;
+    let item = items.find(ch => ch.name === keys[index]);
+    if (item && item.input != null) {
+      this.input = item.input;
+      this.cursor = item.cursor;
+    }
+    return item;
+  }
+
+  async submit() {
+    if (typeof this.interpolate !== 'function') await this.initialize();
+    await this.interpolate(this.state, true);
+
+    let { invalid, missing, output, values } = this.state;
+    if (invalid.size) {
+      let err = '';
+      for (let [key, value] of invalid) err += `Invalid ${key}: ${value}\n`;
+      this.state.error = err;
+      return super.submit();
+    }
+
+    if (missing.size) {
+      this.state.error = 'Required: ' + [...missing.keys()].join(', ');
+      return super.submit();
+    }
+
+    let lines = colors.unstyle(output).split('\n');
+    let result = lines.map(v => v.slice(1)).join('\n');
+    this.value = { values, result };
+    return super.submit();
+  }
+}
+
+module.exports = SnippetPrompt;

package/lib/prompts/sort.js

@@ -0,0 +1,37 @@
+'use strict';
+
+const hint = '(Use <shift>+<up/down> to sort)';
+const Prompt = require('./select');
+
+class Sort extends Prompt {
+  constructor(options) {
+    super({ ...options, reorder: false, sort: true, multiple: true });
+    this.state.hint = [this.options.hint, hint].find(this.isValue.bind(this));
+  }
+
+  indicator() {
+    return '';
+  }
+
+  async renderChoice(choice, i) {
+    let str = await super.renderChoice(choice, i);
+    let sym = this.symbols.identicalTo + ' ';
+    let pre = (this.index === i && this.sorting) ? this.styles.muted(sym) : '  ';
+    if (this.options.drag === false) pre = '';
+    if (this.options.numbered === true) {
+      return pre + `${i + 1} - ` + str;
+    }
+    return pre + str;
+  }
+
+  get selected() {
+    return this.choices;
+  }
+
+  submit() {
+    this.value = this.choices.map(choice => choice.value);
+    return super.submit();
+  }
+}
+
+module.exports = Sort;