astefanutti/decktape
1
1
Fork 0
mirror of https://github.com/astefanutti/decktape.git synced 2024-09-11 22:27:11 +03:00
Code Issues Projects Releases Wiki Activity

Fix EOL in generic plugin

Browse Source
This commit is contained in:
Antonin Stefanutti 2020-08-15 11:39:28 +02:00
parent 1512b1e162
commit 67b735e7cc
No known key found for this signature in database
GPG Key ID: 451D46E2047E7837
1 changed files with 95 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

190
plugins/generic.js
View File

@ -1,95 +1,95 @@
// The generic plugin emulates end-user interaction by pressing keyboard
// and detects changes to the DOM. The deck is considered over when no change
// is detected afterward.
const { pause } = require('../libs/util');
exports.options = {
key : {
default : 'ArrowRight',
metavar : '<key>',
help : 'Key pressed to navigate to next slide',
},
maxSlides : {
full : 'max-slides',
metavar : '<size>',
help : 'Maximum number of slides to export',
},
media: {
default : 'screen',
choices : ['screen', 'print'],
metavar : '<media>',
help : 'CSS media type to emulate, one of [print, screen]',
},
};
exports.help =
`Emulates the end-user interaction by pressing the key with the specified --key option
and iterates over the presentation as long as:
- Any change to the DOM is detected by observing mutation events targeting the body element
and its subtree,
- Nor the number of slides exported has reached the specified --max-slides option.
The --key option must be one of the 'KeyboardEvent' keys and defaults to [${exports.options.key.default}].`;
exports.create = (page, options) => new Generic(page, options);
class Generic {
constructor(page, options) {
this.page = page;
this.options = options;
this.currentSlide = 1;
this.isNextSlideDetected = false;
this.key = this.options.key || exports.options.key.default;
this.media = this.options.media || exports.options.media.default;
}
getName() {
return 'Generic';
}
isActive() {
return true;
}
async configure() {
await this.page.emulateMediaType(this.media);
await this.page.exposeFunction('onMutation', _ => (this.isNextSlideDetected = true));
await this.page.evaluate(_ =>
new MutationObserver(_ => window.onMutation()).observe(document, {
attributes : true,
childList : true,
subtree : true,
})
);
}
slideCount() {
return undefined;
}
// A priori knowledge is impossible to achieve in a generic way. Thus the only way is to
// actually emulate end-user interaction by pressing the configured key and check whether
// the DOM has changed a posteriori.
async hasNextSlide() {
if (this.options.maxSlides && this.currentSlide >= this.options.maxSlides) {
return false;
}
await this.page.keyboard.press(this.key);
// TODO: use mutation event directly instead of relying on a timeout
// TODO: detect cycle to avoid infinite navigation for frameworks
// that support loopable presentations like impress.js and flowtime.js
await pause(1000);
return this.isNextSlideDetected;
}
nextSlide() {
this.currentSlide++;
this.isNextSlideDetected = false;
}
async currentSlideIndex() {
const hash = await this.page.evaluate(_ => window.location.hash);
const [, fragment] = hash.match(/^#\/?([^?]*)/) || [];
return fragment || this.currentSlide;
}
}
// The generic plugin emulates end-user interaction by pressing keyboard
// and detects changes to the DOM. The deck is considered over when no change
// is detected afterward.
const { pause } = require('../libs/util');
exports.options = {
key : {
default : 'ArrowRight',
metavar : '<key>',
help : 'Key pressed to navigate to next slide',
},
maxSlides : {
full : 'max-slides',
metavar : '<size>',
help : 'Maximum number of slides to export',
},
media: {
default : 'screen',
choices : ['screen', 'print'],
metavar : '<media>',
help : 'CSS media type to emulate, one of [print, screen]',
},
};
exports.help =
`Emulates the end-user interaction by pressing the key with the specified --key option
and iterates over the presentation as long as:
- Any change to the DOM is detected by observing mutation events targeting the body element
and its subtree,
- Nor the number of slides exported has reached the specified --max-slides option.
The --key option must be one of the 'KeyboardEvent' keys and defaults to [${exports.options.key.default}].`;
exports.create = (page, options) => new Generic(page, options);
class Generic {
constructor(page, options) {
this.page = page;
this.options = options;
this.currentSlide = 1;
this.isNextSlideDetected = false;
this.key = this.options.key || exports.options.key.default;
this.media = this.options.media || exports.options.media.default;
}
getName() {
return 'Generic';
}
isActive() {
return true;
}
async configure() {
await this.page.emulateMediaType(this.media);
await this.page.exposeFunction('onMutation', _ => (this.isNextSlideDetected = true));
await this.page.evaluate(_ =>
new MutationObserver(_ => window.onMutation()).observe(document, {
attributes : true,
childList : true,
subtree : true,
})
);
}
slideCount() {
return undefined;
}
// A priori knowledge is impossible to achieve in a generic way. Thus the only way is to
// actually emulate end-user interaction by pressing the configured key and check whether
// the DOM has changed a posteriori.
async hasNextSlide() {
if (this.options.maxSlides && this.currentSlide >= this.options.maxSlides) {
return false;
}
await this.page.keyboard.press(this.key);
// TODO: use mutation event directly instead of relying on a timeout
// TODO: detect cycle to avoid infinite navigation for frameworks
// that support loopable presentations like impress.js and flowtime.js
await pause(1000);
return this.isNextSlideDetected;
}
nextSlide() {
this.currentSlide++;
this.isNextSlideDetected = false;
}
async currentSlideIndex() {
const hash = await this.page.evaluate(_ => window.location.hash);
const [, fragment] = hash.match(/^#\/?([^?]*)/) || [];
return fragment || this.currentSlide;
}
}