diff --git a/misc/new_module_test_data.py b/misc/ext_bottom_line_test_data.py similarity index 100% rename from misc/new_module_test_data.py rename to misc/ext_bottom_line_test_data.py diff --git a/src/core/js/new_module.js b/src/core/js/ext_bottom_line.js similarity index 92% rename from src/core/js/new_module.js rename to src/core/js/ext_bottom_line.js index 40d47f0ae1a46a17347e2e81d8884ecc6387309d..7223658db430fb3f74e06889b256b476f3b43c8c 100644 --- a/src/core/js/new_module.js +++ b/src/core/js/ext_bottom_line.js @@ -28,13 +28,13 @@ * Add a special section to each entity one the current page where a thumbnail, * a video preview or any other kind of preview for the entity is shown. * - * @module new_module + * @module ext_bottom_line * @version 0.1 * * @requires jQuery * @requires logger */ -var new_module = function ($, logger, is_in_view_port, load_config, getEntityPath, connection) { +var ext_bottom_line = function ($, logger, is_in_view_port, load_config, getEntityPath, connection) { /** @@ -110,12 +110,12 @@ var new_module = function ($, logger, is_in_view_port, load_config, getEntityPat ]; - const previewShownEvent = new Event("new_module.preview.shown"); - const previewReadyEvent = new Event("new_module.preview.ready"); + const previewShownEvent = new Event("ext_bottom_line.preview.shown"); + const previewReadyEvent = new Event("ext_bottom_line.preview.ready"); - const _css_class_preview_container = "caosdb-f-new_module-container"; - const _css_class_preview_container_resolvable = "caosdb-f-new_module-container-resolvable"; - const _css_class_preview_container_button = "caosdb-f-new_module-container-button"; + const _css_class_preview_container = "caosdb-f-ext_bottom_line-container"; + const _css_class_preview_container_resolvable = "caosdb-f-ext_bottom_line-container-resolvable"; + const _css_class_preview_container_button = "caosdb-f-ext_bottom_line-container-button"; /** * Store the list of creators. @@ -141,7 +141,7 @@ var new_module = function ($, logger, is_in_view_port, load_config, getEntityPat * * This method appends the element (usually a preview, a waiting * notification or an error message) to the HTMLElement with class - * `caosdb-f-new_module-container` which was added to the entity by the + * `caosdb-f-ext_bottom_line-container` which was added to the entity by the * {@link root_preview_handler}. * * If the preview container cannot be found an error is logged, but not @@ -150,7 +150,7 @@ var new_module = function ($, logger, is_in_view_port, load_config, getEntityPat * @param {HTMLElement|String} element - A preview, a waiting notification, * an error message or similar. * @param {HTMLElement} entity - An entity in HTML Representation which - * must have a (deep) child with class `caosdb-f-new_module-container`. + * must have a (deep) child with class `caosdb-f-ext_bottom_line-container`. */ var set_preview_container = function (entity, element) { var preview_container = $(get_preview_container(entity)); @@ -408,10 +408,10 @@ var new_module = function ($, logger, is_in_view_port, load_config, getEntityPat * configuration is fetched from the server. */ var init = async function (config) { - logger.info("new_module initialized"); + logger.info("ext_bottom_line initialized"); try { - let _config = config || await load_config("json/new_module.json"); + let _config = config || await load_config("json/ext_bottom_line.json"); await configure(_config); init_watcher(_config.delay || 500, root_preview_handler_trigger); @@ -438,13 +438,13 @@ var new_module = function ($, logger, is_in_view_port, load_config, getEntityPat _css_class_preview_container_button, _css_class_preview_container_resolvable, } -}($, log.getLogger("new_module"), resolve_references.is_in_viewport_vertically, load_config, getEntityPath, connection); +}($, log.getLogger("ext_bottom_line"), resolve_references.is_in_viewport_vertically, load_config, getEntityPath, connection); /** * Helper for plotly */ -var plotly_preview = function (logger, new_module, plotly) { +var plotly_preview = function (logger, ext_bottom_line, plotly) { var create_plot = function (data) { var div = $('<div/>')[0]; @@ -460,9 +460,9 @@ var plotly_preview = function (logger, new_module, plotly) { } var init = function () { - window.addEventListener(new_module.previewReadyEvent.type, + window.addEventListener(ext_bottom_line.previewReadyEvent.type, resize_plots_event_handler, true); - window.addEventListener(new_module.previewShownEvent.type, + window.addEventListener(ext_bottom_line.previewShownEvent.type, resize_plots_event_handler, true); } @@ -471,13 +471,13 @@ var plotly_preview = function (logger, new_module, plotly) { init: init, }; -}(log.getLogger("plotly_preview"), new_module, Plotly); +}(log.getLogger("plotly_preview"), ext_bottom_line, Plotly); // this will be replaced by require.js in the future. $(document).ready(function () { if ("${BUILD_MODULE_NEW_MODULE}" === "ENABLED") { caosdb_modules.register(plotly_preview); - caosdb_modules.register(new_module); + caosdb_modules.register(ext_bottom_line); } }); diff --git a/src/core/xsl/main.xsl b/src/core/xsl/main.xsl index 6f8757919b87a72743007b58416f0c10ec1e27cc..dc4cc0e69add1cff3210677e53a4f513dca710c1 100644 --- a/src/core/xsl/main.xsl +++ b/src/core/xsl/main.xsl @@ -232,7 +232,7 @@ </xsl:element> <xsl:element name="script"> <xsl:attribute name="src"> - <xsl:value-of select="concat($basepath,'webinterface/${BUILD_NUMBER}/js/new_module.js')"/> + <xsl:value-of select="concat($basepath,'webinterface/${BUILD_NUMBER}/js/ext_bottom_line.js')"/> </xsl:attribute> </xsl:element> <!--JS_EXTENSIONS--> diff --git a/test/core/index.html b/test/core/index.html index 5311de07365eec7eebab73f19058aea91fb380d3..b2ec4fceac7f4a78c621046647e55225c1cfb11b 100644 --- a/test/core/index.html +++ b/test/core/index.html @@ -64,7 +64,7 @@ <script src="js/proj4.js"></script> <script src="js/proj4leaflet.js"></script> <script src="js/ext_map.js"></script> - <script src="js/new_module.js"></script> + <script src="js/ext_bottom_line.js"></script> <script src="js/autocomplete.js"></script> <!--EXTENSIONS--> <script src="js/modules/webcaosdb.js.js"></script> @@ -81,7 +81,7 @@ <script src="js/modules/form_elements.js.js"></script> <script src="js/modules/ext_references.js.js"></script> <script src="js/modules/ext_map.js.js"></script> - <script src="js/modules/new_module.js.js"></script> + <script src="js/modules/ext_bottom_line.js.js"></script> <script src="js/modules/autocomplete.js.js"></script> </body> </html> diff --git a/test/core/js/modules/new_module.js.js b/test/core/js/modules/ext_bottom_line.js similarity index 72% rename from test/core/js/modules/new_module.js.js rename to test/core/js/modules/ext_bottom_line.js index 774c355c1bcec115a4b9ff5642e0d03d40771de7..46903ead3226c1cb6038e9320548284ce76b0672 100644 --- a/test/core/js/modules/new_module.js.js +++ b/test/core/js/modules/ext_bottom_line.js @@ -22,7 +22,7 @@ 'use strict'; -var new_module_test_suite = function ($, new_module, QUnit) { +var ext_bottom_line_test_suite = function ($, ext_bottom_line, QUnit) { const sleep = (ms) => { return new Promise(res => setTimeout(res, ms)) @@ -50,10 +50,10 @@ var new_module_test_suite = function ($, new_module, QUnit) { ] }; - QUnit.module("new_module.js", { + QUnit.module("ext_bottom_line.js", { before: async function (assert) { // setup before module - await new_module.configure(test_config); + await ext_bottom_line.configure(test_config); }, beforeEach: function (assert) { // setup before each test @@ -67,14 +67,14 @@ var new_module_test_suite = function ($, new_module, QUnit) { }); QUnit.test("_creators", function (assert) { - assert.equal(new_module._creators.length, 7, "seven creators"); + assert.equal(ext_bottom_line._creators.length, 7, "seven creators"); }); QUnit.test("add_preview_container", function(assert) { var entity = $("<div/>"); - var container = $(new_module.add_preview_container(entity[0])); - assert.ok(container.hasClass(new_module._css_class_preview_container), `has class ${new_module._css_class_preview_container}`); - assert.ok(container.hasClass(new_module._css_class_preview_container_resolvable), `has class ${new_module._css_class_preview_container_resolvable}`); + var container = $(ext_bottom_line.add_preview_container(entity[0])); + assert.ok(container.hasClass(ext_bottom_line._css_class_preview_container), `has class ${ext_bottom_line._css_class_preview_container}`); + assert.ok(container.hasClass(ext_bottom_line._css_class_preview_container_resolvable), `has class ${ext_bottom_line._css_class_preview_container_resolvable}`); }); QUnit.test("root_preview_handler", async function(assert) { @@ -83,21 +83,21 @@ var new_module_test_suite = function ($, new_module, QUnit) { let entity_xml = `<Response><Record name="${name}"><Parent name='TestPreviewRecordType'/></Record></Response>`; let entity = (await transformation.transformEntities(str2xml(entity_xml)))[0]; assert.equal(getEntityName(entity), name, "correct name"); - var container = $(new_module.add_preview_container(entity)); + var container = $(ext_bottom_line.add_preview_container(entity)); - assert.ok(container.hasClass(new_module._css_class_preview_container), `before has class ${new_module._css_class_preview_container}`); - assert.ok(container.hasClass(new_module._css_class_preview_container_resolvable), `before has class ${new_module._css_class_preview_container_resolvable}`); + assert.ok(container.hasClass(ext_bottom_line._css_class_preview_container), `before has class ${ext_bottom_line._css_class_preview_container}`); + assert.ok(container.hasClass(ext_bottom_line._css_class_preview_container_resolvable), `before has class ${ext_bottom_line._css_class_preview_container_resolvable}`); if (name_suffix === "load-forever"){ - new_module.root_preview_handler(entity); + ext_bottom_line.root_preview_handler(entity); await sleep(1000); } else { - await new_module.root_preview_handler(entity); + await ext_bottom_line.root_preview_handler(entity); } // ..._resolvable class removed - assert.ok(container.hasClass(new_module._css_class_preview_container), `after has class ${new_module._css_class_preview_container}`); - assert.notOk(container.hasClass(new_module._css_class_preview_container_resolvable), `after missing class ${new_module._css_class_preview_container_resolvable}`); + assert.ok(container.hasClass(ext_bottom_line._css_class_preview_container), `after has class ${ext_bottom_line._css_class_preview_container}`); + assert.notOk(container.hasClass(ext_bottom_line._css_class_preview_container_resolvable), `after missing class ${ext_bottom_line._css_class_preview_container_resolvable}`); switch(name_suffix) { @@ -121,4 +121,4 @@ var new_module_test_suite = function ($, new_module, QUnit) { }); -}($, new_module, QUnit); +}($, ext_bottom_line, QUnit);