From 99f7674e8d38d2fb6d1f1d55d87959645ee6e978 Mon Sep 17 00:00:00 2001
From: fspreck <f.spreckelsen@indiscale.com>
Date: Tue, 29 Mar 2022 12:43:19 +0200
Subject: [PATCH] MAINT: Rename default person reference resolver
---
build.properties.d/00_default.properties | 2 +-
src/core/js/ext_references.js | 4 +--
src/doc/extension/references.rst | 7 ++---
src/ext/js/person_reference_resover.js | 36 ++++++++++++-----------
test/core/js/modules/ext_references.js.js | 2 +-
5 files changed, 26 insertions(+), 25 deletions(-)
diff --git a/build.properties.d/00_default.properties b/build.properties.d/00_default.properties
index 60616622..1937dd15 100644
--- a/build.properties.d/00_default.properties
+++ b/build.properties.d/00_default.properties
@@ -59,7 +59,7 @@ BUILD_MODULE_USER_MANAGEMENT=ENABLED
BUILD_MODULE_USER_MANAGEMENT_CHANGE_OWN_PASSWORD_REALM=CaosDB
BUILD_MODULE_EXT_RESOLVE_REFERENCES=ENABLED
-BUILD_EXT_REFERENCES_CUSTOM_RESOLVER=person_reference
+BUILD_EXT_REFERENCES_CUSTOM_RESOLVER=caosdb_default_person_reference
BUILD_MODULE_EXT_EDITMODE_WYSIWYG_TEXT=DISABLED
diff --git a/src/core/js/ext_references.js b/src/core/js/ext_references.js
index fe4d618c..3fea2842 100644
--- a/src/core/js/ext_references.js
+++ b/src/core/js/ext_references.js
@@ -311,8 +311,8 @@ var resolve_references = new function () {
* resolved as a string and returns a `reference_info` object with
* the resolved custom reference as a `text` property.
*
- * See caosdb-webui/src/ext/js/person_reference_resolver.js for an
- * example.
+ * See caosdb-webui/src/ext/js/caosdb_default_person_reference_resolver.js
+ * for an example.
*
* TODO refactor to be configurable. @async @param {string} id - the id of
* the entity which is to be resolved. @return {reference_info}
diff --git a/src/doc/extension/references.rst b/src/doc/extension/references.rst
index 63c55161..621c5328 100644
--- a/src/doc/extension/references.rst
+++ b/src/doc/extension/references.rst
@@ -32,7 +32,6 @@ the basic structure of the module should look like
}
An example is located in
-``caosdb-webui/src/ext/js/person_reference_resolver.js``. It resolves
-any reference to a ``Person`` Record to the value of its ``firstname``
-and ``lastname`` properties separated by a space and is active by
-default.
+``caosdb-webui/src/ext/js/caosdb_default_person_reference_resolver.js``. It
+resolves any reference to a ``Person`` Record to the value of its ``firstname``
+and ``lastname`` properties separated by a space and is active by default.
diff --git a/src/ext/js/person_reference_resover.js b/src/ext/js/person_reference_resover.js
index 39355735..24f098c8 100644
--- a/src/ext/js/person_reference_resover.js
+++ b/src/ext/js/person_reference_resover.js
@@ -22,7 +22,7 @@
*/
/**
- * @module person_reference
+ * @module caosdb_default_person_reference
*
* Replace the reference to a Person Record by the values of that
* Record's firstname and lastname properties.
@@ -30,9 +30,9 @@
* TODO: Make name(s) of person RecordType(s) and names of firstname
* and lastname properties configurable.
*/
-var person_reference = new function () {
+var caosdb_default_person_reference = new function () {
- var logger = log.getLogger("person_reference");
+ var logger = log.getLogger("caosdb_default_person_reference");
const lastname_prop_name = "lastname"
const firstname_prop_name = "firstname"
@@ -42,24 +42,26 @@ var person_reference = new function () {
* Return the name of a person as firstname + lastname
*/
this.get_person_str = function (el) {
- var valpr = getProperties(el);
- if (valpr == undefined) {
- return;
- }
- return valpr.filter(valprel =>
- valprel.name.toLowerCase().trim() ==
- firstname_prop_name.toLowerCase())[0].value +
- " " +
- valpr.filter(valprel => valprel.name.toLowerCase().trim() ==
- lastname_prop_name.toLowerCase())[0].value;
+ var valpr = getProperties(el);
+ if (valpr == undefined) {
+ return;
+ }
+ return valpr.filter(valprel =>
+ valprel.name.toLowerCase().trim() ==
+ firstname_prop_name.toLowerCase())[0].value +
+ " " +
+ valpr.filter(valprel => valprel.name.toLowerCase().trim() ==
+ lastname_prop_name.toLowerCase())[0].value;
}
this.resolve = async function (id) {
- const entity = (await resolve_references.retrieve(id))[0];
+ const entity = (await resolve_references.retrieve(id))[0];
- if (resolve_references.is_child(entity, person_rt_name)) {
- return {"text": person_reference.get_person_str(entity)};
- }
+ if (resolve_references.is_child(entity, person_rt_name)) {
+ return {
+ "text": caosdb_default_person_reference.get_person_str(entity)
+ };
+ }
}
}
diff --git a/test/core/js/modules/ext_references.js.js b/test/core/js/modules/ext_references.js.js
index 54e06d33..905b9067 100644
--- a/test/core/js/modules/ext_references.js.js
+++ b/test/core/js/modules/ext_references.js.js
@@ -104,7 +104,7 @@ QUnit.test("is_child", function(assert){
});
QUnit.test("get_person_str", function(assert){
- assert.ok(person_reference.get_person_str);
+ assert.ok(caosdb_default_person_reference.get_person_str);
});
QUnit.test("update_visible_references_without_summary", async function(assert){
--
GitLab