@oat-sa/tao-core-ui 1.64.2 → 1.66.0

package/src/maths/calculator/plugins/keyboard/templateKeyboard/templateKeyboard.js

@@ -1,91 +1,91 @@
-/**
- * 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 keyboard for the calculator, with configurable layout.
- * Each key must declare the target command, using DOM attributes:
- * - data-command: the name of the command to call
- * - data-param: the optional parameter to apply to the command
- * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
- */
-import $ from 'jquery';
-import _ from 'lodash';
-import nsHelper from 'util/namespace';
-import pluginFactory from 'ui/maths/calculator/core/plugin';
-import labels from 'ui/maths/calculator/core/labels';
-import defaultKeyboardTpl from 'ui/maths/calculator/plugins/keyboard/templateKeyboard/defaultTemplate';
-
-var pluginName = 'templateKeyboard';
-
-var defaultConfig = {
-    layout: defaultKeyboardTpl
-};
-
-export default pluginFactory(
-    {
-        name: pluginName,
-
-        /**
-         * Called when the plugin should be initialized.
-         */
-        init: function init() {
-            // required by the plugin factory to validate this plugin
-        },
-
-        /**
-         * Called when the plugin should be rendered.
-         */
-        render: function render() {
-            var calculator = this.getCalculator();
-            var areaBroker = calculator.getAreaBroker();
-            var pluginConfig = this.getConfig();
-            var templateConfig = _.merge({ labels: labels }, pluginConfig);
-
-            if (!_.isFunction(pluginConfig.layout)) {
-                throw new TypeError('The keyboard plugin requires a template to render!');
-            }
-
-            this.$layout = $(pluginConfig.layout(templateConfig)).on(
-                nsHelper.namespaceAll('click', pluginName),
-                '.key',
-                function() {
-                    var $key = $(this).closest('.key');
-                    var command = $key.data('command');
-                    var param = $key.data('param');
-                    if (command) {
-                        calculator.useCommand(command, param);
-                    }
-                }
-            );
-
-            areaBroker.getKeyboardArea().append(this.$layout);
-        },
-
-        /**
-         * Called when the plugin is destroyed. Mostly when the host is destroyed itself.
-         */
-        destroy: function destroy() {
-            var calculator = this.getCalculator();
-            if (this.$layout) {
-                this.$layout.off('.' + pluginName).remove();
-                this.$layout = null;
-            }
-            calculator.off('.' + pluginName);
-        }
-    },
-    defaultConfig
-);
+/**
+ * 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 keyboard for the calculator, with configurable layout.
+ * Each key must declare the target command, using DOM attributes:
+ * - data-command: the name of the command to call
+ * - data-param: the optional parameter to apply to the command
+ * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
+ */
+import $ from 'jquery';
+import _ from 'lodash';
+import nsHelper from 'util/namespace';
+import pluginFactory from 'ui/maths/calculator/core/plugin';
+import labels from 'ui/maths/calculator/core/labels';
+import defaultKeyboardTpl from 'ui/maths/calculator/plugins/keyboard/templateKeyboard/defaultTemplate';
+
+var pluginName = 'templateKeyboard';
+
+var defaultConfig = {
+    layout: defaultKeyboardTpl
+};
+
+export default pluginFactory(
+    {
+        name: pluginName,
+
+        /**
+         * Called when the plugin should be initialized.
+         */
+        init: function init() {
+            // required by the plugin factory to validate this plugin
+        },
+
+        /**
+         * Called when the plugin should be rendered.
+         */
+        render: function render() {
+            var calculator = this.getCalculator();
+            var areaBroker = calculator.getAreaBroker();
+            var pluginConfig = this.getConfig();
+            var templateConfig = _.merge({ labels: labels }, pluginConfig);
+
+            if (!_.isFunction(pluginConfig.layout)) {
+                throw new TypeError('The keyboard plugin requires a template to render!');
+            }
+
+            this.$layout = $(pluginConfig.layout(templateConfig)).on(
+                nsHelper.namespaceAll('click', pluginName),
+                '.key',
+                function() {
+                    var $key = $(this).closest('.key');
+                    var command = $key.data('command');
+                    var param = $key.data('param');
+                    if (command) {
+                        calculator.useCommand(command, param);
+                    }
+                }
+            );
+
+            areaBroker.getKeyboardArea().append(this.$layout);
+        },
+
+        /**
+         * Called when the plugin is destroyed. Mostly when the host is destroyed itself.
+         */
+        destroy: function destroy() {
+            var calculator = this.getCalculator();
+            if (this.$layout) {
+                this.$layout.off('.' + pluginName).remove();
+                this.$layout = null;
+            }
+            calculator.off('.' + pluginName);
+        }
+    },
+    defaultConfig
+);

package/src/maths/calculator/plugins/modifiers/pow10.js

@@ -1,143 +1,143 @@
-/**
- * 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 ;
- */
-/**
- * Plugin that multiplies the current operand by 10^x.
- * @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';
-import tokensHelper from 'ui/maths/calculator/core/tokens';
-
-var pluginName = 'pow10';
-
-/**
- * The basic `10^x` expression.
- * @type {String}
- */
-var termsPow10 = '10^';
-
-/**
- * The multiply by `10^x` expression.
- * @type {String}
- */
-var termsMulByPow10 = '*' + termsPow10;
-
-export default pluginFactory({
-    name: pluginName,
-
-    /**
-     * Called when the plugin is installing in its host.
-     */
-    install: function install() {
-        this.getCalculator().setCommand('pow10', __('Power of 10'), __('Multiply the value by 10^x'));
-    },
-
-    /**
-     * Called when the plugin should be initialized.
-     */
-    init: function init() {
-        var calculator = this.getCalculator();
-
-        /**
-         * Checks if the expression contains a space before the current position
-         * @returns {Boolean}
-         */
-        function spaceBefore() {
-            return calculator.getExpression().charAt(calculator.getPosition() - 1) === ' ';
-        }
-
-        /**
-         * Checks if the token is considered as a separator
-         * @param {token} token
-         * @returns {Boolean}
-         */
-        function isSeparator(token) {
-            return tokensHelper.isFunction(token) || (tokensHelper.isSeparator(token) && token.type !== 'RPAR');
-        }
-
-        // insert the sub-expression based on strategies
-        calculator.on(nsHelper.namespaceAll('command-pow10', pluginName), function() {
-            var position = calculator.getPosition();
-            var tokens = calculator.getTokens();
-            var index = calculator.getTokenIndex();
-            var token = tokens[index] || null;
-            var prevToken = tokens[index - 1] || null;
-            var nextToken = tokens[index + 1] || null;
-            var aligned = false;
-            var expr = termsMulByPow10;
-
-            if (token) {
-                // refine the current position, as it should be either on the start or the end of the token:
-                // "aligned" means the position is properly aligned with the token, said at the start of the value,
-                // while not "aligned" means any other position inside the token
-                aligned = token.offset === position;
-                if (token.type === 'MUL') {
-                    if (aligned) {
-                        // the "multiply" operator is a special case, as it is part of the complete expression,
-                        // so if it is already there, we consider to use it, and move the position just after
-                        calculator.setPosition(position + token.value.length);
-                        aligned = false;
-                    }
-                } else if (!aligned) {
-                    // the strategy is to consider the position is in front of the token,
-                    // the allowed exception is when the position is the last one
-                    if (nextToken || position < token.offset + token.value.length) {
-                        calculator.setPosition(token.offset);
-                        aligned = true;
-                    }
-                }
-            }
-
-            // empty expression or 0, should be replaced by the shorter version
-            if ((tokens.length <= 1 && !token) || token.type === 'NUM0') {
-                calculator.replace(termsPow10);
-            }
-            // will insert expression at position:
-            // - use the shorter version if there is no token before, or the previous one is either an operator
-            //   or a function
-            // - user the longer version in any other cases
-            else {
-                if (aligned) {
-                    if (index === 0 || isSeparator(prevToken)) {
-                        expr = termsPow10;
-                    }
-                } else if (isSeparator(token)) {
-                    expr = termsPow10;
-
-                    // the expression may need a space before if the previous token is a function
-                    if (tokensHelper.isFunction(token) && !spaceBefore()) {
-                        expr = ' ' + expr;
-                    }
-                }
-
-                calculator.insert(expr);
-            }
-        });
-    },
-
-    /**
-     * Called when the plugin is destroyed. Mostly when the host is destroyed itself.
-     */
-    destroy: function destroy() {
-        this.getCalculator()
-            .deleteCommand('pow10')
-            .off('.' + pluginName);
-    }
-});
+/**
+ * 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 ;
+ */
+/**
+ * Plugin that multiplies the current operand by 10^x.
+ * @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';
+import tokensHelper from 'ui/maths/calculator/core/tokens';
+
+var pluginName = 'pow10';
+
+/**
+ * The basic `10^x` expression.
+ * @type {String}
+ */
+var termsPow10 = '10^';
+
+/**
+ * The multiply by `10^x` expression.
+ * @type {String}
+ */
+var termsMulByPow10 = '*' + termsPow10;
+
+export default pluginFactory({
+    name: pluginName,
+
+    /**
+     * Called when the plugin is installing in its host.
+     */
+    install: function install() {
+        this.getCalculator().setCommand('pow10', __('Power of 10'), __('Multiply the value by 10^x'));
+    },
+
+    /**
+     * Called when the plugin should be initialized.
+     */
+    init: function init() {
+        var calculator = this.getCalculator();
+
+        /**
+         * Checks if the expression contains a space before the current position
+         * @returns {Boolean}
+         */
+        function spaceBefore() {
+            return calculator.getExpression().charAt(calculator.getPosition() - 1) === ' ';
+        }
+
+        /**
+         * Checks if the token is considered as a separator
+         * @param {token} token
+         * @returns {Boolean}
+         */
+        function isSeparator(token) {
+            return tokensHelper.isFunction(token) || (tokensHelper.isSeparator(token) && token.type !== 'RPAR');
+        }
+
+        // insert the sub-expression based on strategies
+        calculator.on(nsHelper.namespaceAll('command-pow10', pluginName), function() {
+            var position = calculator.getPosition();
+            var tokens = calculator.getTokens();
+            var index = calculator.getTokenIndex();
+            var token = tokens[index] || null;
+            var prevToken = tokens[index - 1] || null;
+            var nextToken = tokens[index + 1] || null;
+            var aligned = false;
+            var expr = termsMulByPow10;
+
+            if (token) {
+                // refine the current position, as it should be either on the start or the end of the token:
+                // "aligned" means the position is properly aligned with the token, said at the start of the value,
+                // while not "aligned" means any other position inside the token
+                aligned = token.offset === position;
+                if (token.type === 'MUL') {
+                    if (aligned) {
+                        // the "multiply" operator is a special case, as it is part of the complete expression,
+                        // so if it is already there, we consider to use it, and move the position just after
+                        calculator.setPosition(position + token.value.length);
+                        aligned = false;
+                    }
+                } else if (!aligned) {
+                    // the strategy is to consider the position is in front of the token,
+                    // the allowed exception is when the position is the last one
+                    if (nextToken || position < token.offset + token.value.length) {
+                        calculator.setPosition(token.offset);
+                        aligned = true;
+                    }
+                }
+            }
+
+            // empty expression or 0, should be replaced by the shorter version
+            if ((tokens.length <= 1 && !token) || token.type === 'NUM0') {
+                calculator.replace(termsPow10);
+            }
+            // will insert expression at position:
+            // - use the shorter version if there is no token before, or the previous one is either an operator
+            //   or a function
+            // - user the longer version in any other cases
+            else {
+                if (aligned) {
+                    if (index === 0 || isSeparator(prevToken)) {
+                        expr = termsPow10;
+                    }
+                } else if (isSeparator(token)) {
+                    expr = termsPow10;
+
+                    // the expression may need a space before if the previous token is a function
+                    if (tokensHelper.isFunction(token) && !spaceBefore()) {
+                        expr = ' ' + expr;
+                    }
+                }
+
+                calculator.insert(expr);
+            }
+        });
+    },
+
+    /**
+     * Called when the plugin is destroyed. Mostly when the host is destroyed itself.
+     */
+    destroy: function destroy() {
+        this.getCalculator()
+            .deleteCommand('pow10')
+            .off('.' + pluginName);
+    }
+});