Added extra fields to search options

oarepo · Feb 25, 2024 · 4352610 · 4352610
1 parent 0d65b9c
commit 4352610
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/oarepo_model_builder/datatypes/components/model/search_options.py b/oarepo_model_builder/datatypes/components/model/search_options.py
@@ -41,6 +41,12 @@ class Meta:
         data_key="sort-options-field",
     )
 
+    fields = ma.fields.Dict(
+        keys=ma.fields.Str(),
+        values=ma.fields.Str(),
+        metadata={"doc": "Fields to be used in search options"},
+    )
+
 
 class SearchOptionsModelComponent(DataTypeComponent):
     eligible_datatypes = [ModelDataType]
@@ -77,4 +83,8 @@ def before_model_prepare(self, datatype, *, context, **kwargs):
             "imports",
             [],
         )
+        record_search_options.setdefault(
+            "fields",
+            {},
+        )
         record_search_options.setdefault("sort-options-field", "sort_options")
diff --git a/oarepo_model_builder/invenio/templates/invenio_record_search_options.py.jinja2 b/oarepo_model_builder/invenio/templates/invenio_record_search_options.py.jinja2
@@ -3,6 +3,10 @@
 from oarepo_runtime.i18n import lazy_gettext as _
 from . import facets
 
+{% for extra_field_value in vars.search_options.fields.values() %}
+{{ extra_field_value|code_imports }}
+{% endfor %}
+
 
 class {{ vars.search_options| class_header }}:
     """{{ vars.record.class|base_name }} search options."""
@@ -49,5 +53,8 @@ class {{ vars.search_options| class_header }}:
 {% endfor %}
     }
 {% endif %}
+{% for extra_field_name, extra_field_value in vars.search_options.fields.items() %}
+    {{ extra_field_name }} = {{ extra_field_value|extra_code }}
+{% endfor %}
 
 {{ vars.search_options|extra_code }}
diff --git a/tests/test_datatype_prepare.py b/tests/test_datatype_prepare.py
@@ -76,6 +76,7 @@ def test_prepare_datatype():
                 "invenio_records_resources.services.SearchOptions{InvenioSearchOptions}"
             ],
             "imports": [],
+            "fields": {},
             "sort-options-field": "sort_options",
         },
         "config": {

diff --git a/tests/test_model_saver.py b/tests/test_model_saver.py
@@ -70,6 +70,7 @@ def test_model_saver():
                 "invenio_records_resources.services.SearchOptions{InvenioSearchOptions}"
             ],
             "imports": [],
+            "fields": {},
             "sort-options-field": "sort_options",
         },
         "config": {
@@ -439,6 +440,7 @@ def test_model_saver_invenio():
                 "invenio_records_resources.services.SearchOptions{InvenioSearchOptions}"
             ],
             "imports": [],
+            "fields": {},
             "sort-options-field": "sort_options",
         },
         "config": {