@oat-sa/tao-core-ui 1.60.0 → 1.60.2

package/src/maths/calculator/defaultCalculator.js

@@ -1,66 +1,66 @@
-/**
- * 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 ;
- */
-/**
- * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
- */
-import _ from 'lodash';
-import calculatorComponent from 'ui/maths/calculator/calculatorComponent';
-import pluginKeyboardFactory from 'ui/maths/calculator/plugins/keyboard/templateKeyboard/templateKeyboard';
-import pluginScreenFactory from 'ui/maths/calculator/plugins/screen/simpleScreen/simpleScreen';
-
-/**
- * Creates a simple calculator component. Screen and keyboard layout are replaceable.
- * @param {Object} config - Some config entries (@see ui/dynamicComponent)
- * @param {Function} [config.keyboardLayout] - A Handlebars template for the keyboard
- * @param {Function} [config.screenLayout] - A Handlebars template for the screen
- * @param {Object} [config.calculator] - Config for the calculator (@see ui/maths/calculator/core/board)
- * @returns {dynamicComponent}
- */
-export default function defaultCalculatorFactory(config) {
-    var defaultPluginsConfig = {};
-
-    if (config && config.keyboardLayout) {
-        defaultPluginsConfig.templateKeyboard = {
-            layout: config.keyboardLayout
-        };
-    }
-
-    if (config && config.screenLayout) {
-        defaultPluginsConfig.simpleScreen = {
-            layout: config.screenLayout
-        };
-    }
-
-    config = _.merge(
-        {
-            // The list of default plugins is directly built here instead of using a module variable to ensure the
-            // object is unique to the instance. This wil avoid global polluting by successive instances, as nested
-            // objects and arrays might be simply copied.
-            loadedPlugins: {
-                keyboard: [pluginKeyboardFactory],
-                screen: [pluginScreenFactory]
-            },
-            calculator: {
-                plugins: defaultPluginsConfig
-            }
-        },
-        _.omit(config, ['keyboardLayout', 'screenLayout'])
-    );
-
-    return calculatorComponent(config);
-}
+/**
+ * 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 ;
+ */
+/**
+ * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
+ */
+import _ from 'lodash';
+import calculatorComponent from 'ui/maths/calculator/calculatorComponent';
+import pluginKeyboardFactory from 'ui/maths/calculator/plugins/keyboard/templateKeyboard/templateKeyboard';
+import pluginScreenFactory from 'ui/maths/calculator/plugins/screen/simpleScreen/simpleScreen';
+
+/**
+ * Creates a simple calculator component. Screen and keyboard layout are replaceable.
+ * @param {Object} config - Some config entries (@see ui/dynamicComponent)
+ * @param {Function} [config.keyboardLayout] - A Handlebars template for the keyboard
+ * @param {Function} [config.screenLayout] - A Handlebars template for the screen
+ * @param {Object} [config.calculator] - Config for the calculator (@see ui/maths/calculator/core/board)
+ * @returns {dynamicComponent}
+ */
+export default function defaultCalculatorFactory(config) {
+    var defaultPluginsConfig = {};
+
+    if (config && config.keyboardLayout) {
+        defaultPluginsConfig.templateKeyboard = {
+            layout: config.keyboardLayout
+        };
+    }
+
+    if (config && config.screenLayout) {
+        defaultPluginsConfig.simpleScreen = {
+            layout: config.screenLayout
+        };
+    }
+
+    config = _.merge(
+        {
+            // The list of default plugins is directly built here instead of using a module variable to ensure the
+            // object is unique to the instance. This wil avoid global polluting by successive instances, as nested
+            // objects and arrays might be simply copied.
+            loadedPlugins: {
+                keyboard: [pluginKeyboardFactory],
+                screen: [pluginScreenFactory]
+            },
+            calculator: {
+                plugins: defaultPluginsConfig
+            }
+        },
+        _.omit(config, ['keyboardLayout', 'screenLayout'])
+    );
+
+    return calculatorComponent(config);
+}

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

@@ -1,90 +1,90 @@
-/**
- * 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);
-    }
-});
+/**
+ * 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 +1,166 @@
-/**
- * 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);
-    }
-});
+/**
+ * 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);
+    }
+});