Skip to content

feat: consistent function naming with underscores #821

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.

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
merged 13 commits into from
Oct 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
148 changes: 80 additions & 68 deletions src/functions.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,79 @@

(function($, val) {

var _ = Mavo.Functions = {
let $u = {
numbers (array, args) {
array = Array.isArray(array)? array : (args? $$(args) : [array]);

return array.filter(number => !isNaN(number) && val(number) !== "" && val(number) !== null).map(n => +n);
},

// Implement function metadata
postProcess (callback) {
var multiValued = callback.multiValued;
var newCallback;

if (multiValued === true || multiValued?.length === 2) {
newCallback = (...args) => {
// Define index of multiValued arguments
// Fallback to first 2 arguments if not explicitly defined
var idxA = multiValued[0] || 0;
var idxB = multiValued[1] || 1;

return Mavo.Script.binaryOperation(args[idxA], args[idxB], {
scalar: (a, b) => {
// Replace multiValued argument with its individual elements
if (idxA in args) {
args[idxA] = a;
}

if (idxB in args) {
args[idxB] = b;
}

return callback(...args);
},
...callback
});
};
}
else if (callback.isAggregate) {
newCallback = function(array) {
if (Mavo.in(Mavo.groupedBy, array)) { // grouped structures
return array.map(e => newCallback(e.$items));
}

var ret = callback.call(this, ...arguments);

return ret === undefined? array : ret;
};
}

if (newCallback) {
// Preserve function metadata
$.extend(newCallback, callback);
newCallback.original = callback;
}

if (callback.alias) {
for (let alias of Mavo.toArray(callback.alias)) {
Mavo.Functions[alias] = newCallback || callback;
}
}

return newCallback;
},

deprecatedFunction (name, oldName, fn) {
return function (...args) {
fn ??= Mavo.Functions[name];
Mavo.warn(`${oldName}() is deprecated and will be removed in the next version of Mavo. Please use ${name}() instead.`);
return fn(...args);
}
}
}

let _ = Mavo.Functions = {
operators: {
"=": "eq"
},
Expand Down Expand Up @@ -550,18 +622,22 @@ var _ = Mavo.Functions = {
multiValued: true,
}),

fromlast: $.extend((haystack, needle) => _.between(haystack, needle, "", true), {
from_last: $.extend((haystack, needle) => _.between(haystack, needle, "", true), {
multiValued: true,
}),

fromlast: $u.deprecatedFunction("from_last", "fromlast"),

to: $.extend((haystack, needle) => _.between(haystack, "", needle), {
multiValued: true,
}),

tofirst: $.extend((haystack, needle) => _.between(haystack, "", needle, true), {
to_first: $.extend((haystack, needle) => _.between(haystack, "", needle, true), {
multiValued: true,
}),

tofirst: $u.deprecatedFunction("to_first", "tofirst"),

between: $.extend((haystack, from, to, tight) => {
[haystack, from, to] = [str(haystack), str(from), str(to)];

Expand Down Expand Up @@ -637,73 +713,9 @@ var _ = Mavo.Functions = {
},

// "Private" helpers
util: {
numbers: function(array, args) {
array = Array.isArray(array)? array : (args? $$(args) : [array]);

return array.filter(number => !isNaN(number) && val(number) !== "" && val(number) !== null).map(n => +n);
},

// Implement function metadata
postProcess: function(callback) {
var multiValued = callback.multiValued;
var newCallback;

if (multiValued === true || multiValued?.length === 2) {
newCallback = (...args) => {
// Define index of multiValued arguments
// Fallback to first 2 arguments if not explicitly defined
var idxA = multiValued[0] || 0;
var idxB = multiValued[1] || 1;

return Mavo.Script.binaryOperation(args[idxA], args[idxB], {
scalar: (a, b) => {
// Replace multiValued argument with its individual elements
if (idxA in args) {
args[idxA] = a;
}

if (idxB in args) {
args[idxB] = b;
}

return callback(...args);
},
...callback
});
};
}
else if (callback.isAggregate) {
newCallback = function(array) {
if (Mavo.in(Mavo.groupedBy, array)) { // grouped structures
return array.map(e => newCallback(e.$items));
}

var ret = callback.call(this, ...arguments);

return ret === undefined? array : ret;
};
}

if (newCallback) {
// Preserve function metadata
$.extend(newCallback, callback);
newCallback.original = callback;
}

if (callback.alias) {
for (let alias of Mavo.toArray(callback.alias)) {
Mavo.Functions[alias] = newCallback || callback;
}
}

return newCallback;
}
}
util: $u
};

var $u = _.util;

/**
* After plugins are loaded, enable
* multi-valued arguments of Mavo and Math functions
Expand Down
6 changes: 5 additions & 1 deletion src/mavoscript.js
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ var _ = Mavo.Script = {
},
precedence: 3
},
"groupby": {
"group_by": {
symbol: "by",
code: (array, key) => {
array = Mavo.toArray(array);
Expand Down Expand Up @@ -491,6 +491,10 @@ var _ = Mavo.Script = {
},
precedence: 2
},
"groupby": {
code: $u.deprecatedFunction("group_by", "groupby"),
precedence: 2
},
"as": {
symbol: "as",
code: (property, name) => {
Expand Down