moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Onelinerz updates: 

* Uses standard `itemFormat`
* Uses format of {userName} vs {username} (case)
* Has preview implemented as %TL2
This commit is contained in:
Bryan Ashby 2018-07-09 20:27:09 -06:00
parent 2f22d91bcf
commit 5c826abd5b
4 changed files with 77 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
UPGRADE.md
View File

@ -43,6 +43,7 @@ Report your issue on Xibalba BBS, hop in #enigma-bbs on Freenet and chat, or
* Possible breaking changes in FSE: The MCI code `%TL13` for error indicator is now `%TL4`. This is part of a cleanup and standardization on "custom ranges". You may need to update your `theme.hjson` and related artwork.
* Removed view width auto-size: Some views still can auto-size their height, but in general you should be explicit in your themes
* More standardization using "custom ranges" and `itemFormat` / `focusItemFormat` semantics. Update your themes!
* In addition to using `itemFormat`, the `onelinerz` module uses `userName` vs `username` (note the case) to match other modules
# 0.0.7-alpha to 0.0.8-alpha

16
art/themes/luciano_blocktronics/theme.hjson
View File

@ -88,11 +88,15 @@
fullLoginSequenceOnelinerz: {
config: {
listFormat: "|00|11{username:<12}|08: |03{oneliner:<59.59}"
tsFormat: ddd h:mma
}
0: {
mci: {
VM1: { height: 10, width: 20 }
VM1: {
height: 10
width: 20
itemFormat: "|00|11{userName:<12}|08: |03{oneliner:<59.59}"
}
TM2: {
focusTextStyle: first lower
}
@ -183,13 +187,15 @@
}
mainMenuOnelinerz: {
// :TODO: Need way to just duplicate entry here & in menu.hjson, e.g. use: someName + must supply next/etc. in menu
config: {
listFormat: "|00|11{username:<12}|08: |03{oneliner:<59.59}"
tsFormat: ddd h:mma
}
0: {
mci: {
VM1: { height: 10, width: 10 }
VM1: {
height: 10
itemFormat: "|00|11{userName:<12}|08: |03{oneliner:<59.59}"
}
TM2: {
focusTextStyle: first lower
}

7
core/menu_module.js
View File

@ -319,7 +319,8 @@ exports.MenuModule = class MenuModule extends PluginModule {
}
prepViewController(name, formId, mciMap, cb) {
if(_.isUndefined(this.viewControllers[name])) {
const needsCreated = _.isUndefined(this.viewControllers[name]);
if(needsCreated) {
const vcOpts = {
client : this.client,
formId : formId,
@ -334,13 +335,13 @@ exports.MenuModule = class MenuModule extends PluginModule {
};
return vc.loadFromMenuConfig(loadOpts, err => {
return cb(err, vc);
return cb(err, vc, true);
});
}
this.viewControllers[name].setFocus(true);
return cb(null, this.viewControllers[name]);
return cb(null, this.viewControllers[name], false);
}
prepViewControllerWithArt(name, formId, options, cb) {

146
core/onelinerz.js
View File

@ -9,11 +9,6 @@ const {
getTransactionDatabase
} = require('./database.js');
const ViewController = require('./view_controller.js').ViewController;
const theme = require('./theme.js');
const ansi = require('./ansi_term.js');
const stringFormat = require('./string_format.js');
// deps
const sqlite3 = require('sqlite3');
const async = require('async');
@ -22,13 +17,9 @@ const moment = require('moment');
/*
Module :TODO:
* Add pipe code support
- override max length & monitor *display* len as user types in order to allow for actual display len with color
* Add preview control: Shows preview with pipe codes resolved
* Add ability to at least alternate formatStrings -- every other
*/
exports.moduleInfo = {
name : 'Onelinerz',
desc : 'Standard local onelinerz',
@ -37,20 +28,20 @@ exports.moduleInfo = {
};
const MciViewIds = {
ViewForm : {
Entries : 1,
AddPrompt : 2,
view : {
entries : 1,
addPrompt : 2,
},
AddForm : {
NewEntry : 1,
EntryPreview : 2,
AddPrompt : 3,
add : {
newEntry : 1,
entryPreview : 2,
addPrompt : 3,
}
};
const FormIds = {
View : 0,
Add : 1,
view : 0,
add : 1,
};
exports.getModule = class OnelinerzModule extends MenuModule {
@ -115,46 +106,29 @@ exports.getModule = class OnelinerzModule extends MenuModule {
async.waterfall(
[
function clearAndDisplayArt(callback) {
function prepArtAndViewController(callback) {
if(self.viewControllers.add) {
self.viewControllers.add.setFocus(false);
}
if(clearScreen) {
self.client.term.rawWrite(ansi.resetScreen());
}
theme.displayThemedAsset(
self.menuConfig.config.art.entries,
self.client,
{ font : self.menuConfig.font, trailingLF : false },
(err, artData) => {
return callback(err, artData);
return self.prepViewControllerWithArt(
'view',
FormIds.view,
{
clearScreen,
trailingLF : false
},
(err, artInfo, wasCreated) => {
if(!wasCreated) {
self.viewControllers.view.setFocus(true);
self.viewControllers.view.getView(MciViewIds.view.addPrompt).redraw();
}
return callback(err);
}
);
},
function initOrRedrawViewController(artData, callback) {
if(_.isUndefined(self.viewControllers.add)) {
const vc = self.addViewController(
'view',
new ViewController( { client : self.client, formId : FormIds.View } )
);
const loadOpts = {
callingMenu : self,
mciMap : artData.mciMap,
formId : FormIds.View,
};
return vc.loadFromMenuConfig(loadOpts, callback);
} else {
self.viewControllers.view.setFocus(true);
self.viewControllers.view.getView(MciViewIds.ViewForm.AddPrompt).redraw();
return callback(null);
}
},
function fetchEntries(callback) {
const entriesView = self.viewControllers.view.getView(MciViewIds.ViewForm.Entries);
const entriesView = self.viewControllers.view.getView(MciViewIds.view.entries);
const limit = entriesView.dimens.height;
let entries = [];
@ -179,24 +153,22 @@ exports.getModule = class OnelinerzModule extends MenuModule {
);
},
function populateEntries(entriesView, entries, callback) {
const listFormat = self.menuConfig.config.listFormat || '{username}@{ts}: {oneliner}';// :TODO: should be userName to be consistent
const tsFormat = self.menuConfig.config.timestampFormat || 'ddd h:mma';
const tsFormat = self.menuConfig.config.timestampFormat || self.client.currentTheme.helpers.getDateFormat('short');
entriesView.setItems(entries.map( e => {
return stringFormat(listFormat, {
return {
userId : e.user_id,
username : e.user_name,
userName : e.user_name,
oneliner : e.oneliner,
ts : e.timestamp.format(tsFormat),
} );
};
}));
entriesView.redraw();
return callback(null);
},
function finalPrep(callback) {
const promptView = self.viewControllers.view.getView(MciViewIds.ViewForm.AddPrompt);
const promptView = self.viewControllers.view.getView(MciViewIds.view.addPrompt);
promptView.setFocusItemIndex(1); // default to NO
return callback(null);
}
@ -216,37 +188,41 @@ exports.getModule = class OnelinerzModule extends MenuModule {
[
function clearAndDisplayArt(callback) {
self.viewControllers.view.setFocus(false);
self.client.term.rawWrite(ansi.resetScreen());
theme.displayThemedAsset(
self.menuConfig.config.art.add,
self.client,
{ font : self.menuConfig.font },
(err, artData) => {
return callback(err, artData);
return self.prepViewControllerWithArt(
'add',
FormIds.add,
{
clearScreen : true,
trailingLF : false
},
(err, artInfo, wasCreated) => {
if(!wasCreated) {
self.viewControllers.add.setFocus(true);
self.viewControllers.add.redrawAll();
self.viewControllers.add.switchFocus(MciViewIds.add.newEntry);
}
return callback(err);
}
);
},
function initOrRedrawViewController(artData, callback) {
if(_.isUndefined(self.viewControllers.add)) {
const vc = self.addViewController(
'add',
new ViewController( { client : self.client, formId : FormIds.Add } )
);
const loadOpts = {
callingMenu : self,
mciMap : artData.mciMap,
formId : FormIds.Add,
};
return vc.loadFromMenuConfig(loadOpts, callback);
} else {
self.viewControllers.add.setFocus(true);
self.viewControllers.add.redrawAll();
self.viewControllers.add.switchFocus(MciViewIds.AddForm.NewEntry);
return callback(null);
function initPreviewUpdates(callback) {
const previewView = self.viewControllers.add.getView(MciViewIds.add.entryPreview);
const entryView = self.viewControllers.add.getView(MciViewIds.add.newEntry);
if(previewView) {
let timerId;
entryView.on('key press', () => {
clearTimeout(timerId);
timerId = setTimeout( () => {
const focused = self.viewControllers.add.getFocusedView();
if(focused === entryView) {
previewView.setText(entryView.getData());
focused.setFocus(true);
}
}, 500);
});
}
return callback(null);
}
],
err => {
@ -258,8 +234,8 @@ exports.getModule = class OnelinerzModule extends MenuModule {
}
clearAddForm() {
this.setViewText('add', MciViewIds.AddForm.NewEntry, '');
this.setViewText('add', MciViewIds.AddForm.EntryPreview, '');
this.setViewText('add', MciViewIds.add.newEntry, '');
this.setViewText('add', MciViewIds.add.entryPreview, '');
}
initDatabase(cb) {