oarepo-runtime 1.5.11__tar.gz → 1.5.13__tar.gz

{oarepo-runtime-1.5.11/oarepo_runtime.egg-info → oarepo-runtime-1.5.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oarepo-runtime
-Version: 1.5.11
+Version: 1.5.13
 Summary: A set of runtime extensions of Invenio repository
 Description-Content-Type: text/markdown
 License-File: LICENSE

{oarepo-runtime-1.5.11 → oarepo-runtime-1.5.13}/oarepo_runtime/records/systemfields/__init__.py

@@ -1,5 +1,7 @@
 from .icu import ICUField, ICUSortField, ICUSuggestField
 from .mapping import MappingSystemFieldMixin, SystemFieldDumperExt
+from .selectors import FirstItemSelector, PathSelector, Selector
+from .synthetic import SyntheticSystemField
 
 __all__ = (
     "ICUField",
@@ -7,4 +9,8 @@ __all__ = (
     "ICUSortField",
     "MappingSystemFieldMixin",
     "SystemFieldDumperExt",
+    "SyntheticSystemField",
+    "PathSelector",
+    "Selector",
+    "FirstItemSelector",
 )

{oarepo-runtime-1.5.11 → oarepo-runtime-1.5.13}/oarepo_runtime/records/systemfields/mapping.py

@@ -19,12 +19,10 @@ class MappingSystemFieldMixin:
     @classmethod
     def search_dump(cls, data, record):
         """Dump custom field."""
-        pass
 
     @classmethod
     def search_load(cls, data, record_cls):
         """Load custom field."""
-        pass
 
 
 class SystemFieldDumperExt(SearchDumperExt):

oarepo-runtime-1.5.13/oarepo_runtime/records/systemfields/selectors.py

@@ -0,0 +1,38 @@
+from typing import List
+
+
+class Selector:
+    def select(self, record):
+        return []
+
+
+class PathSelector:
+    def __init__(self, *paths):
+        self.paths = [x.split(".") for x in paths]
+
+    def select(self, record):
+        ret = []
+        for path in self.paths:
+            for rec in getter(record, path):
+                ret.append(rec)
+        return ret
+
+
+class FirstItemSelector(PathSelector):
+    def select(self, record):
+        for rec in super().select(record):
+            return [rec]
+
+
+def getter(data, path: List):
+    if len(path) == 0:
+        if isinstance(data, list):
+            yield from data
+        else:
+            yield data
+    elif isinstance(data, dict):
+        if path[0] in data:
+            yield from getter(data[path[0]], path[1:])
+    elif isinstance(data, list):
+        for item in data:
+            yield from getter(item, path)

oarepo-runtime-1.5.13/oarepo_runtime/records/systemfields/synthetic.py

@@ -0,0 +1,111 @@
+from invenio_records.systemfields import SystemField
+
+from .mapping import MappingSystemFieldMixin
+
+
+class SyntheticSystemField(MappingSystemFieldMixin, SystemField):
+    """
+        A class that provides a synthetic system field, that is a system field that
+        generates its content from what is already present inside the record.
+
+        The field is not stored in the record, but is generated on the fly when
+        the record is being indexed.
+
+        Usage:
+        1. Check if any of the provided selectors (oarepo_runtime.records.systemfields.selectors)
+           are usable for your use case. If not, create a subclass of Selector class.
+        2. Put this class onto the record. If you use oarepo-model-builder, add it to the model
+           like:
+           ```yaml
+    record:
+      record:
+        imports:
+          - oarepo_runtime.records.systemfields.SyntheticSystemField
+          - oarepo_vocabularies.records.selectors.LevelSelector
+        fields:
+          faculty = SyntheticSystemField(selector=LevelSelector("metadata.thesis.degreeGrantors", level=1))
+          department = SyntheticSystemField(selector=LevelSelector("metadata.thesis.degreeGrantors", level=2))
+          defenseYear = |
+            SyntheticSystemField(selector=PathSelector("metadata.thesis.dateDefended"),
+                transformer=lambda x: x[:4]
+            )
+           ```
+
+        4. Add the extra fields to the mapping and facets. If using oarepo-model-builder, add it to the
+           model like the following piece of code and compile the model:
+           ```yaml
+    record:
+      properties:
+        faculty:
+          type: vocabulary
+          vocabulary-type: institutions
+          facets:
+            facet-groups:
+            - default
+          label.cs: Fakulta
+          label.en: Faculty
+
+
+        department:
+          type: vocabulary
+          vocabulary-type: institutions
+          facets:
+            facet-groups:
+            - default
+          label.cs: Ústav
+          label.en: Department
+
+        defenseYear:
+          type: integer
+          facets:
+            facet-groups:
+            - default
+          label.cs: Rok obhajoby
+          label.en: Defense year
+           ```
+    """
+
+    def __init__(self, selector=None, filter=None, map=None, key=None, **kwargs):
+        self.selector = selector
+        self.map = map
+        self.filter = filter
+        super().__init__(key=key, **kwargs)
+
+    def search_dump(self, data, record):
+        dt = self._value(data)
+        if dt:
+            key = self.key.split(".")
+            d = data
+            for k in key[:-1]:
+                d = d.setdefault(k, {})
+            d[key[-1]] = dt
+
+    def search_load(self, data, record_cls):
+        def remove_key(d, key):
+            if len(key) == 1:
+                d.pop(key[0], None)
+            else:
+                if not isinstance(d, dict) or key[0] not in d:
+                    return
+                remove_key(d[key[0]], key[1:])
+                if not d[key[0]]:
+                    d.pop(key[0])
+        remove_key(data, self.key.split("."))
+
+    def __get__(self, record, owner=None):
+        if record is None:
+            return self
+        return self._value(record)
+
+    def _value(self, data):
+        if self.selector:
+            value = list(self.selector.select(data))
+            if self.filter:
+                value = [x for x in value if self.filter(x)]
+            if self.map:
+                value = [self.map(x) for x in value]
+                value = [x for x in value if x is not None]
+            return value
+        raise ValueError(
+            "Please either provide a selector or subclass this class and implement a _value method"
+        )

{oarepo-runtime-1.5.11 → oarepo-runtime-1.5.13}/oarepo_runtime/services/config/service.py

@@ -54,8 +54,7 @@ class PermissionsPresetsConfigMixin:
         """
         registered_preset_classes = current_app.config["OAREPO_PERMISSIONS_PRESETS"]
         preset_classes = [
-            registered_preset_classes[x]
-            for x in cls._get_permissions_presets()
+            registered_preset_classes[x] for x in cls._get_permissions_presets()
         ]
         if hasattr(cls, "base_permission_policy_cls"):
             preset_classes.insert(0, cls.base_permission_policy_cls)
@@ -72,7 +71,9 @@ class PermissionsPresetsConfigMixin:
         config_key = cls._get_presents_config_key()
         if config_key in current_app.config:
             return current_app.config[config_key]
-        return cls.PERMISSIONS_PRESETS  # noqa (omitted here because of the order of mixins)
+        return (
+            cls.PERMISSIONS_PRESETS
+        )  # noqa (omitted here because of the order of mixins)
 
     @classmethod
     def _get_presents_config_key(cls):
@@ -93,5 +94,5 @@ class PermissionsPresetsConfigMixin:
         name = cls.__name__
         if name.endswith("Config"):
             name = name[:-6]
-        name = re.sub(r'(?<!^)(?=[A-Z])', '_', name).upper()
+        name = re.sub(r"(?<!^)(?=[A-Z])", "_", name).upper()
         return f"{name}_PERMISSIONS_PRESETS"

{oarepo-runtime-1.5.11 → oarepo-runtime-1.5.13}/oarepo_runtime/services/results.py

@@ -1,4 +1,3 @@
-
 from invenio_records_resources.services.records.results import (
     RecordItem as BaseRecordItem,
 )

{oarepo-runtime-1.5.11 → oarepo-runtime-1.5.13}/oarepo_runtime/utils/functools.py

@@ -24,9 +24,9 @@ class class_property:
             self.__name__ = info.__name__
             self.__module__ = info.__module__
 
-    def __get__(self, obj, type=None):      # NOSONAR - this is a descriptor
+    def __get__(self, obj, type=None):  # NOSONAR - this is a descriptor
         if obj and type is None:
-            type = obj.__class__            # NOSONAR - this is a descriptor
+            type = obj.__class__  # NOSONAR - this is a descriptor
         return self.__get.__get__(obj, type)()
 
     def __set__(self, obj, value):

{oarepo-runtime-1.5.11 → oarepo-runtime-1.5.13/oarepo_runtime.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oarepo-runtime
-Version: 1.5.11
+Version: 1.5.13
 Summary: A set of runtime extensions of Invenio repository
 Description-Content-Type: text/markdown
 License-File: LICENSE

{oarepo-runtime-1.5.11 → oarepo-runtime-1.5.13}/oarepo_runtime.egg-info/SOURCES.txt

@@ -71,6 +71,7 @@ oarepo_runtime/records/systemfields/has_draftcheck.py
 oarepo_runtime/records/systemfields/icu.py
 oarepo_runtime/records/systemfields/mapping.py
 oarepo_runtime/records/systemfields/record_status.py
+oarepo_runtime/records/systemfields/selectors.py
 oarepo_runtime/records/systemfields/synthetic.py
 oarepo_runtime/resources/__init__.py
 oarepo_runtime/resources/file_resource.py

{oarepo-runtime-1.5.11 → oarepo-runtime-1.5.13}/setup.cfg

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

oarepo-runtime-1.5.11/oarepo_runtime/records/systemfields/synthetic.py

@@ -1,79 +0,0 @@
-from invenio_records.systemfields import SystemField
-
-from .mapping import MappingSystemFieldMixin
-
-
-class SyntheticSystemField(MappingSystemFieldMixin, SystemField):
-    """
-        A class that provides a synthetic system field, that is a system field that
-        generates its content from what is already present inside the record.
-
-        The field is not stored in the record, but is generated on the fly when
-        the record is being indexed.
-
-        Usage:
-
-        1. Create a new class that inherits from SyntheticSystemField
-        2. Implement the _value method that returns the value of the field from a data (
-           either a dictionary or an instance of the record class)
-        3. Put the class onto the record. If you use oarepo-model-builder, add it to the model
-           like:
-           ```yaml
-    record:
-      record:
-        extra-code: |-2
-              # extra custom fields for facets
-              faculty = {{common.theses.synthetic_fields.FacultySystemField}}()
-              department = {{common.theses.synthetic_fields.DepartmentSystemField}}()
-              defenseYear = {{common.theses.synthetic_fields.DefenseYearSystemField}}()
-           ```
-
-        4. Add the extra fields to the mapping and facets. If using oarepo-model-builder, add it to the
-           model like the following piece of code and compile the model:
-           ```yaml
-    record:
-      properties:
-        faculty:
-          type: vocabulary
-          vocabulary-type: institutions
-          facets:
-            facet-groups:
-            - default
-          label.cs: Fakulta
-          label.en: Faculty
-
-
-        department:
-          type: vocabulary
-          vocabulary-type: institutions
-          facets:
-            facet-groups:
-            - default
-          label.cs: Ústav
-          label.en: Department
-
-        defenseYear:
-          type: integer
-          facets:
-            facet-groups:
-            - default
-          label.cs: Rok obhajoby
-          label.en: Defense year
-           ```
-    """
-
-    def search_dump(self, data, record):
-        dt = self._value(data)
-        if dt:
-            data[self.key] = dt
-
-    def search_load(self, data, record_cls):
-        data.pop(self.key, None)
-
-    def __get__(self, record, owner=None):
-        if record is None:
-            return self
-        return self._value(record)
-
-    def _value(self, data):
-        raise NotImplementedError("You must implement the _value method")