Break out string parsing functions into a separate file called Strings.js

[jywarren]

This is some great code! Let's break it out so it's more readable. We might even make a folder called strings and break it out more thoroughly.

image-sequencer/src/ImageSequencer.js

Lines 234 to 344 in 2243a4b

	// Genates a CLI string for the current sequence
	function toCliString() {
	var cliStringSteps = `"`, cliOptions = {};
	for (var step in this.steps) {
	if (this.steps[step].options.name !== "load-image")
	cliStringSteps += `${this.steps[step].options.name} `;
	for (var inp in modulesInfo(this.steps[step].options.name).inputs) {
	cliOptions[inp] = this.steps[step].options[inp];
	}
	}
	cliStringSteps = cliStringSteps.substr(0, cliStringSteps.length - 1) + `"`;
	return `sequencer -i [PATH] -s ${cliStringSteps} -d '${JSON.stringify(cliOptions)}'`
	}
	// Strigifies the current sequence
	function toString(step) {
	if (step) {
	return stepToString(step);
	} else {
	return copy(this.images.image1.steps).map(stepToString).slice(1).join(',');
	}
	}
	// Stringifies one step of the sequence
	function stepToString(step) {
	let inputs = copy(modulesInfo(step.options.name).inputs);
	inputs = inputs || {};
	for (let input in inputs) {
	inputs[input] = step.options[input] || inputs[input].default;
	inputs[input] = encodeURIComponent(inputs[input]);
	}
	var configurations = Object.keys(inputs).map(key => key + ':' + inputs[key]).join('|');
	return `${step.options.name}{${configurations}}`;
	}
	// exports the current sequence as an array of JSON steps
	function toJSON() {
	return this.stringToJSON(this.toString());
	}
	// Coverts stringified sequence into an array of JSON steps
	function stringToJSON(str) {
	let steps;
	if (str.includes(','))
	steps = str.split(',');
	else
	steps = [str];
	return steps.map(stringToJSONstep);
	}
	// Converts one stringified step into JSON
	function stringToJSONstep(str) {
	var bracesStrings;
	if (str.includes('{'))
	if (str.includes('(') && str.indexOf('(') < str.indexOf('{'))
	bracesStrings = ['(', ')'];
	else
	bracesStrings = ['{', '}'];
	else
	bracesStrings = ['(', ')'];
	if (str.indexOf(bracesStrings[0]) === -1) { // if there are no settings specified
	var moduleName = str.substr(0);
	stepSettings = "";
	} else {
	var moduleName = str.substr(0, str.indexOf(bracesStrings[0]));
	stepSettings = str.slice(str.indexOf(bracesStrings[0]) + 1, -1);
	}
	stepSettings = stepSettings.split('|').reduce(function formatSettings(accumulator, current, i) {
	var settingName = current.substr(0, current.indexOf(':')),
	settingValue = current.substr(current.indexOf(':') + 1);
	settingValue = settingValue.replace(/^\(/, '').replace(/\)$/, ''); // strip () at start/end
	settingValue = settingValue.replace(/^\{/, '').replace(/\}$/, ''); // strip {} at start/end
	settingValue = decodeURIComponent(settingValue);
	current = [
	settingName,
	settingValue
	];
	if (!!settingName) accumulator[settingName] = settingValue;
	return accumulator;
	}, {});
	return {
	name: moduleName,
	options: stepSettings
	}
	}
	// imports a string into the sequencer steps
	function importString(str) {
	let sequencer = this;
	if (this.name != "ImageSequencer")
	sequencer = this.sequencer;
	var stepsFromString = stringToJSON(str);
	stepsFromString.forEach(function eachStep(stepObj) {
	sequencer.addSteps(stepObj.name, stepObj.options);
	});
	}
	// imports a array of JSON steps into the sequencer steps
	function importJSON(obj) {
	let sequencer = this;
	if (this.name != "ImageSequencer")
	sequencer = this.sequencer;
	obj.forEach(function eachStep(stepObj) {
	sequencer.addSteps(stepObj.name, stepObj.options);
	});
	}

Keep an eye on the tests here, which will tell us if we've properly moved the code:

https://github.com/publiclab/image-sequencer/blob/main/test/modules/import-export.js

[jywarren]

@Mridul97 would you be at all interested in this one? Just curious!

[gitmate]

GitMate.io thinks possibly related issues are #26 (Break out longer functions into sub source files and require in), #118 (Assorted improvements to be broken into separate issues), #165 (Various module ideas to be broken out into separate issues), and #141 (move module tests into separate test files).

[gitmate]

GitMate.io thinks possibly related issues are #26 (Break out longer functions into sub source files and require in), #118 (Assorted improvements to be broken into separate issues), #165 (Various module ideas to be broken out into separate issues), and #141 (move module tests into separate test files).

[ho-dor]

Can I claim this @jywarren, please?

[jywarren]

Yes please, that'd be great!!!

…

On Sat, Nov 10, 2018, 4:05 AM Kunal Rai ***@***.*** wrote: Can I claim this @jywarren <https://github.com/jywarren>, please? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#458 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABfJ0XJfWt2pRIZn4jMT1S-zI2tvMicks5utpbCgaJpZM4YVUZx> .

[vibhorgupta-gh]

@jywarren this has been inactive for a while, shall I take this up?

[jywarren]

sure, is anyone currently working on it?

…

On Wed, Dec 5, 2018 at 10:49 AM Vibhor Gupta ***@***.***> wrote: @jywarren <https://github.com/jywarren> this has been inactive for a while, shall I take this up? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#458 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABfJ51LdkkVy15AX3td4KcmUn-7yNemks5u1-rfgaJpZM4YVUZx> .

[vibhorgupta-gh]

Doesn't look like it

[jywarren]

Sure, then, go ahead! Thank you!

…

On Wed, Dec 5, 2018 at 11:02 AM Vibhor Gupta ***@***.***> wrote: Doesn't look like it — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#458 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABfJ0PontV8aQHd3xlp2n5OoACMCZUJks5u1-3hgaJpZM4YVUZx> .

[Mridul97]

@VibhorCodecianGupta I am working on this one. Could you please take up any other issue. Thanks!

[jywarren]

Sorry Mridul, i keep replying in my email inbox, and not seeing prior comments. Apologies!

…

On Wed, Dec 5, 2018 at 11:43 AM Mridul97 ***@***.***> wrote: @VibhorCodecianGupta <https://github.com/VibhorCodecianGupta> I am working on this one. Could you please take up any other issue. Thanks! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#458 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABfJ03yKVs7D3eUvgV_kaW6SDQkVSRYks5u1_eKgaJpZM4YVUZx> .

[Mridul97]

No problem at all! @jywarren

[vibhorgupta-gh]

@Mridul97 yup, no issues!