oarepo-runtime 1.4.11__tar.gz → 1.4.13__tar.gz

{oarepo-runtime-1.4.11/oarepo_runtime.egg-info → oarepo-runtime-1.4.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oarepo-runtime
-Version: 1.4.11
+Version: 1.4.13
 Summary: A set of runtime extensions of Invenio repository
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -101,3 +101,42 @@ This module provides a marshmallow validator for date strings.
 
 Provides interface and definitions for loading 
 preconfigured permission sets to service config.
+
+## ICU sort and suggestions
+
+To use ICU sort and suggestion custom fields, provide the following configuration
+to `oarepo-model-builder` (or put this stuff to your custom superclasses).
+
+```yaml
+  record:
+    imports:
+      - import: invenio_records_resources.records.api.Record
+        alias: InvenioRecord
+      - import: oarepo_runtime.records.SystemFieldDumperExt
+      - import: oarepo_runtime.records.icu.ICUSortField
+      - import: oarepo_runtime.records.icu.ICUSuggestField
+    extra-code: |-2
+          # extra custom fields for testing ICU sorting and suggesting
+          sort = ICUSortField(source_field="metadata.title")
+          suggest = ICUSuggestField(source_field="metadata.title")
+  search-options:
+    base-classes:
+      - I18nSearchOptions
+    imports:
+      - import: oarepo_runtime.services.icu.I18nSearchOptions
+      - import: oarepo_runtime.services.icu.ICUSuggestParser
+      - import: oarepo_runtime.services.icu.ICUSortOptions
+    sort-options-field: extra_sort_options
+    extra-code: |-2
+          suggest_parser_cls = ICUSuggestParser("records2")
+          sort_options = ICUSortOptions("records2")
+
+  record-dumper:
+    extensions:
+      - SystemFieldDumperExt()
+```
+
+Run `invenio oarepo cf init` to initialize custom fields,
+`invenio oarepo index reindex` if you already have data 
+inside the repository and from this moment on, 
+`/records?sort=title` and `/records?suggest=abc` should work

{oarepo-runtime-1.4.11 → oarepo-runtime-1.4.13}/README.md

@@ -65,4 +65,43 @@ This module provides a marshmallow validator for date strings.
 ## Config
 
 Provides interface and definitions for loading 
-preconfigured permission sets to service config.
+preconfigured permission sets to service config.
+
+## ICU sort and suggestions
+
+To use ICU sort and suggestion custom fields, provide the following configuration
+to `oarepo-model-builder` (or put this stuff to your custom superclasses).
+
+```yaml
+  record:
+    imports:
+      - import: invenio_records_resources.records.api.Record
+        alias: InvenioRecord
+      - import: oarepo_runtime.records.SystemFieldDumperExt
+      - import: oarepo_runtime.records.icu.ICUSortField
+      - import: oarepo_runtime.records.icu.ICUSuggestField
+    extra-code: |-2
+          # extra custom fields for testing ICU sorting and suggesting
+          sort = ICUSortField(source_field="metadata.title")
+          suggest = ICUSuggestField(source_field="metadata.title")
+  search-options:
+    base-classes:
+      - I18nSearchOptions
+    imports:
+      - import: oarepo_runtime.services.icu.I18nSearchOptions
+      - import: oarepo_runtime.services.icu.ICUSuggestParser
+      - import: oarepo_runtime.services.icu.ICUSortOptions
+    sort-options-field: extra_sort_options
+    extra-code: |-2
+          suggest_parser_cls = ICUSuggestParser("records2")
+          sort_options = ICUSortOptions("records2")
+
+  record-dumper:
+    extensions:
+      - SystemFieldDumperExt()
+```
+
+Run `invenio oarepo cf init` to initialize custom fields,
+`invenio oarepo index reindex` if you already have data 
+inside the repository and from this moment on, 
+`/records?sort=title` and `/records?suggest=abc` should work

{oarepo-runtime-1.4.11 → oarepo-runtime-1.4.13}/oarepo_runtime/cf/__init__.py

@@ -1,15 +1,45 @@
+from typing import List
+
 from flask import current_app
 from invenio_records.systemfields import DictField, SystemField
+from invenio_records_resources.services.custom_fields import BaseCF
+
+from oarepo_runtime.records import MappingSystemFieldMixin
 
 
-class CustomFieldsMixin:
+class CustomFieldsMixin(MappingSystemFieldMixin):
     def __init__(self, config_key, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
         self.config_key = config_key
 
+    @property
+    def mapping(self):
+        custom_fields: List[BaseCF] = current_app.config[self.config_key]
+        return {cf.name: cf.mapping for cf in custom_fields}
+
+    @property
+    def mapping_settings(self):
+        return {}
+
+    def search_dump(self, data):
+        custom_fields = current_app.config.get(self.config_key, {})
+
+        for cf in custom_fields:
+            cf.dump(data, cf_key=self.key)
+        return data
+
+    def search_load(self, data):
+        custom_fields = current_app.config.get(self.config_key, {})
+
+        for cf in custom_fields:
+            cf.load(data, cf_key=self.key)
+        return data
+
 
 class CustomFields(CustomFieldsMixin, DictField):
-    pass
+    @property
+    def mapping(self):
+        return {self.key: {"type": "object", "properties": super().mapping}}
 
 
 class InlinedCustomFields(CustomFieldsMixin, SystemField):

{oarepo-runtime-1.4.11 → oarepo-runtime-1.4.13}/oarepo_runtime/cf/cli.py

@@ -12,15 +12,6 @@ def cf():
 
 
 @cf.command(name="init", help="Prepare custom fields in indices")
-@click.option(
-    "-f",
-    "--field-name",
-    "field_names",
-    type=str,
-    required=False,
-    multiple=True,
-    help="A custom field name to create. If not provided, all custom fields will be created.",
-)
 @with_appcontext
-def init(field_names):
-    prepare_cf_indices(field_names)
+def init():
+    prepare_cf_indices()

{oarepo-runtime-1.4.11 → oarepo-runtime-1.4.13}/oarepo_runtime/cf/mappings.py

@@ -2,23 +2,18 @@ import inspect
 from typing import Iterable, List
 
 import click
-from flask import current_app
+import deepmerge
 from invenio_records_resources.proxies import current_service_registry
-from invenio_records_resources.services.custom_fields import BaseCF
 from invenio_records_resources.services.custom_fields.mappings import (
     Mapping as InvenioMapping,
 )
-from invenio_records_resources.services.custom_fields.validate import (
-    validate_custom_fields,
-)
 from invenio_records_resources.services.records.config import RecordServiceConfig
 from invenio_records_resources.services.records.service import RecordService
 from invenio_search import current_search_client
 from invenio_search.engine import dsl, search
 from invenio_search.utils import build_alias_name
 
-from oarepo_runtime.cf import CustomFieldsMixin
-import deepmerge
+from oarepo_runtime.records import MappingSystemFieldMixin
 
 
 class Mapping(InvenioMapping):
@@ -69,34 +64,22 @@ class Mapping(InvenioMapping):
 
 # pieces taken from https://github.com/inveniosoftware/invenio-rdm-records/blob/master/invenio_rdm_records/cli.py
 # as cf initialization is not supported directly in plain invenio
-def prepare_cf_indices(field_names: List[str] = None):
+def prepare_cf_indices():
     service: RecordService
     for service in current_service_registry._services.values():
         config: RecordServiceConfig = service.config
-        prepare_cf_index(config, field_names)
+        prepare_cf_index(config)
 
 
-def prepare_cf_index(config: RecordServiceConfig, field_names: List[str] = None):
+def prepare_cf_index(config: RecordServiceConfig):
     record_class = getattr(config, "record_cls", None)
     if not record_class:
         return
 
-    # try to get custom fields from the record class
-    # validate them
-    for field_name, available_fields in get_custom_fields(record_class):
-        validate_custom_fields(
-            given_fields=field_names, available_fields=available_fields, namespaces=[]
-        )
-
+    for fld in get_mapping_fields(record_class):
         # get mapping
-        properties = Mapping.properties_for_fields(
-            field_names, available_fields, field_name=field_name
-        )
-        settings = Mapping.settings_for_fields(
-            field_names, available_fields, field_name=field_name
-        )
-        if not properties:
-            continue
+        mapping = fld.mapping
+        settings = fld.mapping_settings
 
         # upload mapping
         try:
@@ -106,12 +89,7 @@ def prepare_cf_index(config: RecordServiceConfig, field_names: List[str] = None)
                 ),
                 using=current_search_client,
             )
-            if settings:
-                record_index.close()
-                record_index.put_settings(body=settings)
-                record_index.open()
-            if properties:
-                record_index.put_mapping(body={"properties": properties})
+            update_index(record_index, settings, mapping)
 
             if hasattr(config, "draft_cls"):
                 draft_index = dsl.Index(
@@ -120,15 +98,24 @@ def prepare_cf_index(config: RecordServiceConfig, field_names: List[str] = None)
                     ),
                     using=current_search_client,
                 )
-                draft_index.put_mapping(body={"properties": properties})
+                update_index(draft_index, settings, mapping)
 
         except search.RequestError as e:
             click.secho("An error occurred while creating custom fields.", fg="red")
             click.secho(e.info["error"]["reason"], fg="red")
 
 
-def get_custom_fields(record_class) -> Iterable[List[BaseCF]]:
+def update_index(record_index, settings, mapping):
+    if settings:
+        record_index.close()
+        record_index.put_settings(body=settings)
+        record_index.open()
+    if mapping:
+        record_index.put_mapping(body={"properties": mapping})
+
+
+def get_mapping_fields(record_class) -> Iterable[MappingSystemFieldMixin]:
     for cfg_name, cfg_value in inspect.getmembers(
-        record_class, lambda x: isinstance(x, CustomFieldsMixin)
+        record_class, lambda x: isinstance(x, MappingSystemFieldMixin)
     ):
-        yield cfg_value._key, current_app.config[cfg_value.config_key]
+        yield cfg_value

{oarepo-runtime-1.4.11 → oarepo-runtime-1.4.13}/oarepo_runtime/cli/index.py

@@ -1,4 +1,3 @@
-import itertools
 import sys
 
 import click

oarepo-runtime-1.4.13/oarepo_runtime/records/__init__.py

@@ -0,0 +1,29 @@
+import inspect
+
+from invenio_records.dumpers import SearchDumperExt
+
+
+class MappingSystemFieldMixin:
+    @property
+    def mapping(self):
+        return {}
+
+    @property
+    def mapping_settings(self):
+        return {}
+
+
+class SystemFieldDumperExt(SearchDumperExt):
+    def dump(self, record, data):
+        """Dump custom fields."""
+        for cf in inspect.getmembers(
+            record, lambda x: isinstance(x, MappingSystemFieldMixin)
+        ):
+            cf[1].search_dump(data)
+
+    def load(self, data, record_cls):
+        """Load custom fields."""
+        for cf in inspect.getmembers(
+            record_cls, lambda x: isinstance(x, MappingSystemFieldMixin)
+        ):
+            cf[1].search_load(data)

oarepo-runtime-1.4.13/oarepo_runtime/records/icu.py

@@ -0,0 +1,132 @@
+from functools import cached_property
+from typing import Dict
+
+from flask import current_app
+from invenio_records.systemfields import SystemField
+
+from oarepo_runtime.records import MappingSystemFieldMixin
+from oarepo_runtime.relations.lookup import lookup_key
+
+
+class ICUField(SystemField):
+    """
+    A system field that acts as an opensearch "proxy" to another field.
+    It creates a top-level mapping field with the same name and copies
+    content of {another field}.language into {mapping field}.language.
+
+    The language accessor can be modified by overriding get_values method.
+    """
+
+    def __init__(self, *, source_field, key=None):
+        super().__init__(key)
+        self.source_field = source_field
+
+    @cached_property
+    def languages(self) -> Dict[str, Dict]:
+        icu_languages = current_app.config.get("OAREPO_ICU_LANGUAGES", {})
+        if icu_languages:
+            return icu_languages
+
+        primary_language = current_app.config.get("BABEL_DEFAULT_LOCALE", "en")
+        # list of tuples [lang, title], just take lang
+        babel_languages = [x[0] for x in current_app.config.get("I18N_LANGUAGES", [])]
+
+        return {primary_language: {}, **{k: {} for k in babel_languages}}
+
+    def get_values(self, data, language):
+        ret = []
+        for l in lookup_key(data, f"{self.source_field}"):
+            if isinstance(l.value, str):
+                ret.append(l.value)
+            elif isinstance(l.value, dict):
+                val = l.value.get(language)
+                if val:
+                    ret.append(val)
+        return ret
+
+    def search_dump(self, data):
+        ret = {}
+        for lang in self.languages:
+            ret[lang] = self.get_values(data, lang)
+        data[self.attr_name] = ret
+
+    def search_load(self, data):
+        data.pop(self.attr_name, None)
+
+    def __get__(self, instance, owner):
+        return self
+
+
+class ICUSortField(MappingSystemFieldMixin, ICUField):
+    """
+    A field that adds icu sorting field
+    """
+
+    def __init__(self, *, source_field, key=None):
+        super().__init__(source_field=source_field, key=key)
+
+    @property
+    def mapping(self):
+        return {
+            self.attr_name: {
+                "type": "object",
+                "properties": {
+                    lang: {
+                        "type": "icu_collation_keyword",
+                        "index": False,
+                        "language": lang,
+                        **setting.get("collation", {}),
+                    }
+                    for lang, setting in self.languages.items()
+                },
+            },
+        }
+
+
+class ICUSuggestField(MappingSystemFieldMixin, ICUField):
+    """
+    A field that adds icu-aware suggestion field
+    """
+
+    def __init__(self, source_field, key=None):
+        super().__init__(source_field=source_field, key=key)
+
+    @property
+    def mapping(self):
+        return {
+            self.attr_name: {
+                "type": "object",
+                "properties": {
+                    lang: setting.get(
+                        "suggest",
+                        {
+                            "type": "text",
+                            "fields": {
+                                "original": {
+                                    "type": "search_as_you_type",
+                                },
+                                "no_accent": {
+                                    "type": "search_as_you_type",
+                                    "analyzer": "accent_removal_analyzer",
+                                },
+                            },
+                        },
+                    )
+                    for lang, setting in self.languages.items()
+                },
+            },
+        }
+
+    @property
+    def mapping_settings(self):
+        return {
+            "analysis": {
+                "analyzer": {
+                    "accent_removal_analyzer": {
+                        "type": "custom",
+                        "tokenizer": "standard",
+                        "filter": ["lowercase", "asciifolding"],
+                    }
+                }
+            }
+        }

{oarepo-runtime-1.4.11 → oarepo-runtime-1.4.13}/oarepo_runtime/relations/errors.py

@@ -12,5 +12,7 @@ class MultipleInvalidRelationErrors(Exception):
     """
 
     def __init__(self, errors):
-        super().__init__("; ".join([f"{e[0]}: {type(e[1]).__name__}({e[1]})" for e in errors]))
+        super().__init__(
+            "; ".join([f"{e[0]}: {type(e[1]).__name__}({e[1]})" for e in errors])
+        )
         self.errors = errors

oarepo-runtime-1.4.13/oarepo_runtime/services/icu.py

@@ -0,0 +1,160 @@
+import dataclasses
+import inspect
+from typing import List
+
+# TODO: integrate this to invenio_records_resources.services.records and remove SearchOptions class
+from flask_babelex import lazy_gettext as _
+from invenio_records_resources.proxies import current_service_registry
+from invenio_records_resources.services.records import (
+    SearchOptions as InvenioSearchOptions,
+)
+from invenio_records_resources.services.records.queryparser import SuggestQueryParser
+
+from oarepo_runtime.records.icu import ICUSuggestField
+
+try:
+    from invenio_i18n import get_locale
+except ImportError:
+    from invenio_i18n.babel import get_locale
+
+
+class SearchOptions(InvenioSearchOptions):
+    sort_options = {
+        "title": dict(
+            title=_("By Title"),
+            fields=["metadata.title"],  # ES defaults to desc on `_score` field
+        ),
+        "bestmatch": dict(
+            title=_("Best match"),
+            fields=["_score"],  # ES defaults to desc on `_score` field
+        ),
+        "newest": dict(
+            title=_("Newest"),
+            fields=["-created"],
+        ),
+        "oldest": dict(
+            title=_("Oldest"),
+            fields=["created"],
+        ),
+    }
+
+
+@dataclasses.dataclass
+class SuggestField:
+    field: str
+    boost: int
+    use_ngrams: bool = True
+    boost_exact: float = 5
+    boost_2gram: float = 1
+    boost_3gram: float = 1
+    boost_prefix: float = 1
+
+
+class ICUSuggestParser:
+    def __init__(
+        self,
+        record_cls_or_service_name,
+        extra_fields: List[SuggestField] = None,
+        default_fields: List[SuggestField] = None,
+    ):
+        self.record_cls_or_service_name = record_cls_or_service_name
+        self.extra_fields = extra_fields or []
+        self.default_fields = default_fields or []
+
+    @property
+    def record_cls(self):
+        if not isinstance(self.record_cls_or_service_name, str):
+            return self.record_cls_or_service_name
+        return current_service_registry.get(
+            self.record_cls_or_service_name
+        ).config.record_cls
+
+    def __get__(self, instance, owner):
+        search_as_you_type_fields: List[SuggestField] = []
+        locale = get_locale()
+        if locale:
+            language = locale.language
+
+            for fld_name, fld in inspect.getmembers(
+                self.record_cls, lambda x: isinstance(x, ICUSuggestField)
+            ):
+                search_as_you_type_fields.append(
+                    SuggestField(f"{fld_name}.{language}.original", 2)
+                )
+                search_as_you_type_fields.append(
+                    SuggestField(f"{fld_name}.{language}.no_accent", 1)
+                )
+
+        if not search_as_you_type_fields:
+            search_as_you_type_fields.extend(self.default_fields)
+
+        search_as_you_type_fields.extend(self.extra_fields)
+
+        fields = []
+        for fld in search_as_you_type_fields:
+            fields.append(f"{fld.field}^{fld.boost * fld.boost_exact}")
+            if fld.use_ngrams:
+                fields.append(f"{fld.field}._2gram^{fld.boost * fld.boost_2gram}")
+                fields.append(f"{fld.field}._3gram^{fld.boost * fld.boost_3gram}")
+                fields.append(
+                    f"{fld.field}._index_prefix^{fld.boost * fld.boost_prefix}"
+                )
+
+        return SuggestQueryParser.factory(
+            fields=fields,
+        )
+
+
+@dataclasses.dataclass
+class SortField:
+    option_name: str = "title"
+    icu_sort_field: str = "sort"
+    title: str = "Title"
+
+
+class ICUSortOptions:
+    def __init__(self, record_cls_or_service_name, fields: List[SortField] = None):
+        self.record_cls_or_service_name = record_cls_or_service_name
+        self.fields = fields or [SortField()]
+
+    @property
+    def record_cls(self):
+        if not isinstance(self.record_cls_or_service_name, str):
+            return self.record_cls_or_service_name
+        return current_service_registry.get(
+            self.record_cls_or_service_name
+        ).config.record_cls
+
+    def __get__(self, instance, owner):
+        if not inspect.isclass(owner):
+            owner = type(owner)
+        super_options = {}
+        for mro in list(owner.mro())[1:]:
+            if hasattr(mro, "sort_options"):
+                super_options = mro.sort_options
+                break
+
+        ret = {
+            **super_options,
+            **getattr(owner, "extra_sort_options", {}),
+        }
+
+        # transform the sort options by the current language
+        locale = get_locale()
+        if not locale:
+            return ret
+
+        language = locale.language
+
+        for sort_field in self.fields:
+            icu_field = getattr(self.record_cls, sort_field.icu_sort_field)
+            ret[sort_field.option_name] = {
+                "title": sort_field.title,
+                "fields": [f"{icu_field.key}.{language}"],
+            }
+        return ret
+
+
+class I18nSearchOptions(SearchOptions):
+    extra_sort_options = {}
+    record_cls = None

{oarepo-runtime-1.4.11 → oarepo-runtime-1.4.13/oarepo_runtime.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oarepo-runtime
-Version: 1.4.11
+Version: 1.4.13
 Summary: A set of runtime extensions of Invenio repository
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -101,3 +101,42 @@ This module provides a marshmallow validator for date strings.
 
 Provides interface and definitions for loading 
 preconfigured permission sets to service config.
+
+## ICU sort and suggestions
+
+To use ICU sort and suggestion custom fields, provide the following configuration
+to `oarepo-model-builder` (or put this stuff to your custom superclasses).
+
+```yaml
+  record:
+    imports:
+      - import: invenio_records_resources.records.api.Record
+        alias: InvenioRecord
+      - import: oarepo_runtime.records.SystemFieldDumperExt
+      - import: oarepo_runtime.records.icu.ICUSortField
+      - import: oarepo_runtime.records.icu.ICUSuggestField
+    extra-code: |-2
+          # extra custom fields for testing ICU sorting and suggesting
+          sort = ICUSortField(source_field="metadata.title")
+          suggest = ICUSuggestField(source_field="metadata.title")
+  search-options:
+    base-classes:
+      - I18nSearchOptions
+    imports:
+      - import: oarepo_runtime.services.icu.I18nSearchOptions
+      - import: oarepo_runtime.services.icu.ICUSuggestParser
+      - import: oarepo_runtime.services.icu.ICUSortOptions
+    sort-options-field: extra_sort_options
+    extra-code: |-2
+          suggest_parser_cls = ICUSuggestParser("records2")
+          sort_options = ICUSortOptions("records2")
+
+  record-dumper:
+    extensions:
+      - SystemFieldDumperExt()
+```
+
+Run `invenio oarepo cf init` to initialize custom fields,
+`invenio oarepo index reindex` if you already have data 
+inside the repository and from this moment on, 
+`/records?sort=title` and `/records?suggest=abc` should work

{oarepo-runtime-1.4.11 → oarepo-runtime-1.4.13}/oarepo_runtime.egg-info/SOURCES.txt

@@ -19,7 +19,6 @@ oarepo_runtime.egg-info/requires.txt
 oarepo_runtime.egg-info/top_level.txt
 oarepo_runtime/cf/__init__.py
 oarepo_runtime/cf/cli.py
-oarepo_runtime/cf/icu.py
 oarepo_runtime/cf/mappings.py
 oarepo_runtime/cli/__init__.py
 oarepo_runtime/cli/assets.py
@@ -70,6 +69,8 @@ oarepo_runtime/i18n/dumper.py
 oarepo_runtime/i18n/schema.py
 oarepo_runtime/i18n/ui_schema.py
 oarepo_runtime/i18n/validation.py
+oarepo_runtime/records/__init__.py
+oarepo_runtime/records/icu.py
 oarepo_runtime/relations/__init__.py
 oarepo_runtime/relations/base.py
 oarepo_runtime/relations/components.py
@@ -82,7 +83,7 @@ oarepo_runtime/relations/uow.py
 oarepo_runtime/resolvers/__init__.py
 oarepo_runtime/resolvers/proxies.py
 oarepo_runtime/services/__init__.py
-oarepo_runtime/services/search.py
+oarepo_runtime/services/icu.py
 oarepo_runtime/tasks/__init__.py
 oarepo_runtime/tasks/datastreams.py
 oarepo_runtime/translations/messages.pot

{oarepo-runtime-1.4.11 → oarepo-runtime-1.4.13}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = oarepo-runtime
-version = 1.4.11
+version = 1.4.13
 description = A set of runtime extensions of Invenio repository
 authors = Alzbeta Pokorna
 readme = README.md

oarepo-runtime-1.4.11/oarepo_runtime/cf/icu.py

@@ -1,92 +0,0 @@
-from invenio_records_resources.services.custom_fields import BaseCF
-
-from oarepo_runtime.relations.lookup import lookup_key
-
-
-class ICUSortCF(BaseCF):
-    def __init__(
-        self, name, language, source_field, country=None, variant=None, field_args=None
-    ):
-        super().__init__(name=name, field_args=field_args)
-        self.language = language
-        self.country = country
-        self.variant = variant
-        self.source_field = source_field
-
-    @property
-    def mapping(self):
-        ret = {
-            "type": "icu_collation_keyword",
-            "index": False,
-            "language": self.language,
-        }
-        if self.country:
-            ret["country"] = self.country
-
-        if self.variant:
-            ret["variant"] = self.variant
-
-        return ret
-
-    @property
-    def field(self):
-        return None
-
-    def dump(self, record, cf_key="custom_fields"):
-        ret = []
-        for l in lookup_key(record, self.source_field):
-            ret.append(l.value)
-        record.setdefault(cf_key, {})[self.name] = ret
-
-    def load(self, record, cf_key="custom_fields"):
-        record.pop(cf_key, None)
-
-
-class ICUSuggestCF(BaseCF):
-    def __init__(self, name, language, source_field, field_args=None):
-        super().__init__(name=name, field_args=field_args)
-        self.language = language
-        self.source_field = source_field
-
-    @property
-    def mapping(self):
-        ret = {
-            "type": "text",
-            "fields": {
-                "original": {
-                    "type": "search_as_you_type",
-                },
-                "no_accent": {
-                    "type": "search_as_you_type",
-                    "analyzer": "accent_removal_analyzer",
-                },
-            },
-        }
-        return ret
-
-    @property
-    def mapping_settings(self):
-        return {
-            "analysis": {
-                "analyzer": {
-                    "accent_removal_analyzer": {
-                        "type": "custom",
-                        "tokenizer": "standard",
-                        "filter": ["lowercase", "asciifolding"],
-                    }
-                }
-            }
-        }
-
-    @property
-    def field(self):
-        return None
-
-    def dump(self, record, cf_key="custom_fields"):
-        ret = []
-        for l in lookup_key(record, self.source_field):
-            ret.append(l.value)
-        record.setdefault(cf_key, {})[self.name] = ret
-
-    def load(self, record, cf_key="custom_fields"):
-        record.pop(cf_key, None)

oarepo-runtime-1.4.11/oarepo_runtime/services/search.py

@@ -1,108 +0,0 @@
-import dataclasses
-from typing import Tuple, List
-
-from invenio_records_resources.services.records import (
-    SearchOptions as InvenioSearchOptions,
-)
-
-# TODO: integrate this to invenio_records_resources.services.records
-from flask_babelex import lazy_gettext as _
-from invenio_records_resources.services.records.queryparser import SuggestQueryParser
-from sqlalchemy.util import classproperty
-from flask import current_app
-
-try:
-    from invenio_i18n import get_locale
-except ImportError:
-    from invenio_i18n.babel import get_locale
-
-
-class SearchOptions(InvenioSearchOptions):
-    sort_options = {
-        "title": dict(
-            title=_("By Title"),
-            fields=["metadata.title"],  # ES defaults to desc on `_score` field
-        ),
-        "bestmatch": dict(
-            title=_("Best match"),
-            fields=["_score"],  # ES defaults to desc on `_score` field
-        ),
-        "newest": dict(
-            title=_("Newest"),
-            fields=["-created"],
-        ),
-        "oldest": dict(
-            title=_("Oldest"),
-            fields=["created"],
-        ),
-    }
-
-
-@dataclasses.dataclass
-class SuggestField:
-    field: str
-    boost: int
-    use_ngrams: bool = True
-    boost_exact: float = 5
-    boost_2gram: float = 1
-    boost_3gram: float = 1
-    boost_prefix: float = 1
-
-
-class I18nSearchOptions(SearchOptions):
-    SORT_CUSTOM_FIELD_NAME = None
-    SUGGEST_CUSTOM_FIELD_NAME = None
-    SUGGEST_SEARCH_AS_YOU_TYPE_FIELDS: Tuple[SuggestField] = (
-        SuggestField("metadata.title", 1, use_ngrams=False),
-        SuggestField("id", 1, use_ngrams=False),
-    )
-    extra_sort_options = {}
-
-    @classproperty
-    def sort_options(clz):
-        ret = {**super().sort_options, **clz.extra_sort_options}
-        if not clz.SORT_CUSTOM_FIELD_NAME:
-            return ret
-
-        # transform the sort options by the current language
-        locale = get_locale()
-        if not locale:
-            return ret
-        language = locale.language
-        for cf in current_app.config[clz.SORT_CUSTOM_FIELD_NAME]:
-            if cf.name == language:
-                ret["title"]["fields"] = [f"sort.{cf.name}"]
-                break
-        return ret
-
-    @classproperty
-    def suggest_parser_cls(clz):
-        search_as_you_type_fields: List[SuggestField] = []
-        locale = get_locale()
-
-        if clz.SUGGEST_CUSTOM_FIELD_NAME and locale:
-            language = locale.language
-            for cf in current_app.config[clz.SUGGEST_CUSTOM_FIELD_NAME]:
-                if cf.name == language:
-                    search_as_you_type_fields.append(
-                        SuggestField(f"suggest.{language}.original", 2)
-                    )
-                    search_as_you_type_fields.append(
-                        SuggestField(f"suggest.{language}.no_accent", 1)
-                    )
-        if not search_as_you_type_fields:
-            search_as_you_type_fields = clz.SUGGEST_SEARCH_AS_YOU_TYPE_FIELDS  # noqa
-
-        fields = []
-        for fld in search_as_you_type_fields:
-            fields.append(f"{fld.field}^{fld.boost * fld.boost_exact}")
-            if fld.use_ngrams:
-                fields.append(f"{fld.field}._2gram^{fld.boost * fld.boost_2gram}")
-                fields.append(f"{fld.field}._3gram^{fld.boost * fld.boost_3gram}")
-                fields.append(
-                    f"{fld.field}._index_prefix^{fld.boost * fld.boost_prefix}"
-                )
-
-        return SuggestQueryParser.factory(
-            fields=fields,
-        )