@oat-sa/tao-core-ui 1.67.0 → 1.69.0

package/src/maths/calculator/core/tokens.js

@@ -1,178 +0,0 @@
-/**
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; under version 2
- * of the License (non-upgradable).
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
- *
- * Copyright (c) 2019 Open Assessment Technologies SA ;
- */
-/**
- * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
- */
-import registeredTerms from 'ui/maths/calculator/core/terms';
-
-/**
- * List of helpers that apply on tokens
- * @type {Object}
- */
-var tokensHelper = {
-    /**
-     * Identifies the type of a given token
-     * @param {String|Object} token
-     * @returns {String|null}
-     */
-    getType: function getType(token) {
-        var type, term;
-        if ('string' !== typeof token) {
-            type = (token && token.type) || null;
-            term = registeredTerms[type];
-            return (term && term.type) || type;
-        }
-        return token;
-    },
-
-    /**
-     * Checks if the type is related to a digit value
-     * @param {String|Object} type
-     * @returns {Boolean}
-     */
-    isDigit: function isDigit(type) {
-        return tokensHelper.getType(type) === 'digit';
-    },
-
-    /**
-     * Checks if the type is related to an operator
-     * @param {String|Object} type
-     * @returns {Boolean}
-     */
-    isOperator: function isOperator(type) {
-        return tokensHelper.getType(type) === 'operator';
-    },
-
-    /**
-     * Checks if the type is related to an operand
-     * @param {String|Object} type
-     * @returns {Boolean}
-     */
-    isOperand: function isOperand(type) {
-        type = tokensHelper.getType(type);
-        return type !== 'operator' && type !== 'aggregator' && type !== 'separator';
-    },
-
-    /**
-     * Checks if the type is related to an operand
-     * @param {String|Object} type
-     * @returns {Boolean}
-     */
-    isValue: function isValue(type) {
-        type = tokensHelper.getType(type);
-        return type === 'digit' || type === 'constant' || type === 'variable' || type === 'term' || type === 'error';
-    },
-
-    /**
-     * Checks if the type is related to an aggregator
-     * @param {String|Object} type
-     * @returns {Boolean}
-     */
-    isAggregator: function isAggregator(type) {
-        return tokensHelper.getType(type) === 'aggregator';
-    },
-
-    /**
-     * Checks if the type is related to an error
-     * @param {String|Object} type
-     * @returns {Boolean}
-     */
-    isError: function isError(type) {
-        return tokensHelper.getType(type) === 'error';
-    },
-
-    /**
-     * Checks if the type is related to a constant
-     * @param {String|Object} type
-     * @returns {Boolean}
-     */
-    isConstant: function isConstant(type) {
-        return tokensHelper.getType(type) === 'constant';
-    },
-
-    /**
-     * Checks if the type is related to a variable
-     * @param {String|Object} type
-     * @returns {Boolean}
-     */
-    isVariable: function isVariable(type) {
-        type = tokensHelper.getType(type);
-        return type === 'variable' || type === 'term';
-    },
-
-    /**
-     * Checks if the type is related to a function
-     * @param {String|Object} type
-     * @returns {Boolean}
-     */
-    isFunction: function isFunction(type) {
-        return tokensHelper.getType(type) === 'function';
-    },
-
-    /**
-     * Checks if the type is related to an identifier
-     * @param {String|Object} type
-     * @returns {Boolean}
-     */
-    isIdentifier: function isIdentifier(type) {
-        type = tokensHelper.getType(type);
-        return type === 'constant' || type === 'variable' || type === 'term' || type === 'function' || type === 'error';
-    },
-
-    /**
-     * Checks if the type is related to a separator
-     * @param {String|Object} type
-     * @returns {Boolean}
-     */
-    isSeparator: function isSeparator(type) {
-        type = tokensHelper.getType(type);
-        return type === 'operator' || type === 'aggregator' || type === 'separator';
-    },
-
-    /**
-     * Checks if the type is related to a modifier
-     * @param {String|Object} type
-     * @returns {Boolean}
-     */
-    isModifier: function isModifier(type) {
-        type = tokensHelper.getType(type);
-        return type === 'operator' || type === 'function';
-    },
-
-    /**
-     * Ensures an expression is a string. If a token or a descriptor is provided, extract the value.
-     * @param {String|Number|Object} expression
-     * @returns {String}
-     */
-    stringValue: function stringValue(expression) {
-        var type = typeof expression;
-        if (type !== 'string') {
-            if (expression && 'undefined' !== typeof expression.value) {
-                expression = expression.value;
-            } else if (expression && 'undefined' !== typeof expression.result) {
-                expression = expression.result;
-            } else if (type === 'object' || type === 'undefined' || expression === null) {
-                expression = '';
-            }
-            expression = String(expression);
-        }
-        return expression;
-    }
-};
-
-export default tokensHelper;

package/src/maths/calculator/plugins/core/degrad.js

@@ -1,90 +0,0 @@
-/**
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; under version 2
- * of the License (non-upgradable).
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
- *
- * Copyright (c) 2018 Open Assessment Technologies SA ;
- */
-/**
- * Plugin that switch mode between degree and radian in the calculator
- * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
- */
-import __ from 'i18n';
-import nsHelper from 'util/namespace';
-import pluginFactory from 'ui/maths/calculator/core/plugin';
-
-var pluginName = 'degrad';
-
-export default pluginFactory({
-    name: pluginName,
-
-    /**
-     * Called when the plugin is installing in its host.
-     */
-    install: function install() {
-        var calculator = this.getCalculator();
-
-        calculator
-            .setCommand('degree', __('Degree'), __('Set the trigonometric function to work in degrees'))
-            .setCommand('radian', __('Radian'), __('Set the trigonometric function to work in radians'));
-    },
-
-    /**
-     * Called when the plugin should be initialized.
-     */
-    init: function init() {
-        var calculator = this.getCalculator();
-
-        function getMathsConfig() {
-            var config = calculator.getConfig();
-            if (!config.maths) {
-                config.maths = {};
-            }
-            return config.maths;
-        }
-
-        function setupMathsEvaluator() {
-            var config = calculator.getConfig();
-            var degree = config.maths && config.maths.degree;
-            calculator
-                .setState('degree', degree)
-                .setState('radian', !degree)
-                .setupMathsEvaluator();
-        }
-
-        setupMathsEvaluator();
-
-        calculator
-            .on(nsHelper.namespaceAll('command-degree', pluginName), function() {
-                getMathsConfig().degree = true;
-                setupMathsEvaluator();
-            })
-            .on(nsHelper.namespaceAll('command-radian', pluginName), function() {
-                getMathsConfig().degree = false;
-                setupMathsEvaluator();
-            });
-    },
-
-    /**
-     * Called when the plugin is destroyed. Mostly when the host is destroyed itself.
-     */
-    destroy: function destroy() {
-        var calculator = this.getCalculator();
-        calculator
-            .deleteCommand('degree')
-            .deleteCommand('radian')
-            .setState('degree', false)
-            .setState('radian', false)
-            .off('.' + pluginName);
-    }
-});

package/src/maths/calculator/plugins/core/history.js

@@ -1,166 +0,0 @@
-/**
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; under version 2
- * of the License (non-upgradable).
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
- *
- * Copyright (c) 2018 Open Assessment Technologies SA ;
- */
-/**
- * Plugin that manages an history of evaluated expressions in the calculator
- * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
- */
-import _ from 'lodash';
-import __ from 'i18n';
-import nsHelper from 'util/namespace';
-import pluginFactory from 'ui/maths/calculator/core/plugin';
-
-var pluginName = 'history';
-
-/**
- * Defines an entry in the history
- * @typedef {Object} historyEntry
- * @property {String} expression - The expression that has been extracted when the entry was created
- * @property {Object} variables - The list of variables that has been extracted when the entry was created
- * @property {String} [current] - The current edited expression if the entry is modified
- */
-
-export default pluginFactory({
-    name: pluginName,
-
-    /**
-     * Called when the plugin is installing in its host.
-     */
-    install: function install() {
-        var calculator = this.getCalculator();
-
-        calculator
-            .setCommand('historyClear', __('Clear History'), __('Clear history'))
-            .setCommand('historyGet', __('Get History'), __('Get the history list'))
-            .setCommand('historyUp', __('Previous'), __('Remind the previous expression in the history'))
-            .setCommand('historyDown', __('Next'), __('Remind the next expression in the history'));
-    },
-
-    /**
-     * Called when the plugin should be initialized.
-     */
-    init: function init() {
-        var calculator = this.getCalculator();
-        var history, cursor, current;
-
-        /**
-         * Creates an entry from the current state
-         * @returns {historyEntry}
-         */
-        function getCurrentState() {
-            return {
-                expression: calculator.getExpression(),
-                variables: calculator.getVariables(),
-                current: null
-            };
-        }
-
-        /**
-         * Clears the entire history
-         */
-        function reset() {
-            current = getCurrentState();
-            history = [];
-            cursor = 0;
-        }
-
-        /**
-         * Retrieves a memory entry in the history
-         * @param {Number} position
-         * @returns {Object|null}
-         */
-        function getMemoryAt(position) {
-            if (position >= 0 && position < history.length) {
-                return history[position];
-            } else if (position === history.length) {
-                return current;
-            }
-            return null;
-        }
-
-        /**
-         * Reminds an expression from the history
-         * @param {Number} position
-         */
-        function remind(position) {
-            var memory = getMemoryAt(position);
-
-            // keep the current expression in the memory, in case the user goes back to it
-            if (cursor === history.length && position !== cursor) {
-                current = getCurrentState();
-            } else {
-                history[cursor].current = calculator.getExpression();
-            }
-
-            // restore an expression from the history at the wanted position
-            if (memory) {
-                cursor = position;
-                if (memory.variables) {
-                    calculator.setVariables(memory.variables);
-                }
-                calculator.replace(memory.current || memory.expression);
-                memory.current = null;
-            }
-        }
-
-        /**
-         * Adds a memory entry in the history from the current expression
-         */
-        function push() {
-            var last = getMemoryAt(history.length - 1);
-            var memory = getMemoryAt(cursor);
-            if (!last || calculator.getExpression() !== last.expression) {
-                history.push(getCurrentState());
-            }
-            if (memory) {
-                memory.current = null;
-            }
-            cursor = history.length;
-        }
-
-        reset();
-        calculator
-            .on(nsHelper.namespaceAll('evaluate', pluginName), push)
-            .on(nsHelper.namespaceAll('command-historyClear command-clearAll destroy', pluginName), reset)
-            .on(nsHelper.namespaceAll('command-historyUp', pluginName), function() {
-                remind(cursor - 1);
-            })
-            .on(nsHelper.namespaceAll('command-historyDown', pluginName), function() {
-                remind(cursor + 1);
-            })
-            .on(nsHelper.namespaceAll('command-historyGet', pluginName), function() {
-                /**
-                 * @event history
-                 * @param {Array} history - The current history list
-                 */
-                calculator.trigger('history', _.map(history, 'expression'));
-            });
-    },
-
-    /**
-     * Called when the plugin is destroyed. Mostly when the host is destroyed itself.
-     */
-    destroy: function destroy() {
-        var calculator = this.getCalculator();
-        calculator
-            .deleteCommand('historyClear')
-            .deleteCommand('historyUp')
-            .deleteCommand('historyDown')
-            .deleteCommand('historyGet')
-            .off('.' + pluginName);
-    }
-});

package/src/maths/calculator/plugins/core/remind.js

@@ -1,96 +0,0 @@
-/**
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; under version 2
- * of the License (non-upgradable).
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
- *
- * Copyright (c) 2018 Open Assessment Technologies SA ;
- */
-/**
- * Plugin that manages a simple value reminder in the calculator
- * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
- */
-
-import __ from 'i18n';
-import nsHelper from 'util/namespace';
-import pluginFactory from 'ui/maths/calculator/core/plugin';
-
-var pluginName = 'remind';
-var varRemindName = 'mem';
-var varLastName = 'last';
-
-export default pluginFactory({
-    name: pluginName,
-
-    /**
-     * Called when the plugin is installing in its host.
-     */
-    install: function install() {
-        var calculator = this.getCalculator();
-
-        calculator
-            .setCommand('remind', __('Remind'), __('Remind the recorded value'))
-            .setCommand('remindLast', __('Remind Last'), __('Remind the last value'))
-            .setCommand('remindStore', __('Store'), __('Store the value a variable'))
-            .setCommand('remindClear', __('Clear'), __('Clear the stored variables'));
-    },
-
-    /**
-     * Called when the plugin should be initialized.
-     */
-    init: function init() {
-        var calculator = this.getCalculator();
-
-        calculator
-            .on(nsHelper.namespaceAll('evaluate', pluginName), function(result) {
-                calculator.setVariable(varLastName, result);
-            })
-            .on(nsHelper.namespaceAll('command-remind', pluginName), function() {
-                if (calculator.hasVariable(varRemindName)) {
-                    calculator.useVariable(varRemindName);
-                }
-            })
-            .on(nsHelper.namespaceAll('command-remindLast', pluginName), function() {
-                if (calculator.hasVariable(varLastName)) {
-                    calculator.useVariable(varLastName);
-                }
-            })
-            .on(nsHelper.namespaceAll('command-remindStore', pluginName), function() {
-                if (calculator.hasVariable(varLastName)) {
-                    calculator.setVariable(varRemindName, calculator.getVariable(varLastName));
-                }
-            })
-            .on(nsHelper.namespaceAll('command-remindClear command-clearAll destroy', pluginName), function() {
-                if (calculator.hasVariable(varRemindName)) {
-                    calculator.deleteVariable(varRemindName);
-                }
-            })
-            .on(nsHelper.namespaceAll('destroy', pluginName), function() {
-                if (calculator.hasVariable(varLastName)) {
-                    calculator.deleteVariable(varLastName);
-                }
-            });
-    },
-
-    /**
-     * Called when the plugin is destroyed. Mostly when the host is destroyed itself.
-     */
-    destroy: function destroy() {
-        var calculator = this.getCalculator();
-        calculator
-            .deleteCommand('remind')
-            .deleteCommand('remindLast')
-            .deleteCommand('remindStore')
-            .deleteCommand('remindClear')
-            .off('.' + pluginName);
-    }
-});