oarepo-runtime 1.5.7__tar.gz → 1.5.10__tar.gz

{oarepo-runtime-1.5.7/oarepo_runtime.egg-info → oarepo-runtime-1.5.10}/PKG-INFO

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

{oarepo-runtime-1.5.7 → oarepo-runtime-1.5.10}/oarepo_runtime/records/systemfields/featured_file.py

@@ -6,22 +6,33 @@ from oarepo_runtime.datastreams.utils import get_file_service_for_record_service
 from oarepo_runtime.records.systemfields.mapping import MappingSystemFieldMixin
 
 
-class FeaturedFileFieldResult(MappingSystemFieldMixin):
+class FeaturedFileFieldResult:
     def __init__(self, record=None):
         super().__init__()
         self.record = record
 
-    def search_dump(self, data):
+
+class FeaturedFileField(MappingSystemFieldMixin, SystemField):
+    def __init__(self, source_field):
+        super(FeaturedFileField, self).__init__(source_field)
+
+    def __get__(self, instance, owner):
+        if instance is None:
+            return self
+        result = FeaturedFileFieldResult(record=instance)
+        return result
+
+    def search_dump(self, data, record):
         for service in current_service_registry._services:
             if getattr(
                 current_service_registry._services[service], "record_cls"
-            ) == type(self.record):
+            ) == type(record):
                 file_service = get_file_service_for_record_service(
                     record_service=current_service_registry._services[service],
-                    record=self.record,
+                    record=record,
                 )
 
-                files = file_service.list_files(system_identity, self.record["id"])
+                files = file_service.list_files(system_identity, record["id"])
                 file_list = list(files.entries)
 
                 for file in file_list:
@@ -30,16 +41,5 @@ class FeaturedFileFieldResult(MappingSystemFieldMixin):
                         and "featured" in file["metadata"]
                         and file["metadata"]["featured"]
                     ):
-                        self.record["metadata"].update({"featured": file})
-                        self.record.commit()
-
-
-class FeaturedFileField(SystemField):
-    def __init__(self, source_field):
-        super(FeaturedFileField, self).__init__()
-
-    def __get__(self, instance, owner):
-        if instance is None:
-            return None
-        result = FeaturedFileFieldResult(record=instance)
-        return result
+                        record["metadata"].update({"featured": file})
+                        record.commit()

{oarepo-runtime-1.5.7 → oarepo-runtime-1.5.10}/oarepo_runtime/records/systemfields/icu.py

@@ -8,7 +8,7 @@ from oarepo_runtime.records.relations.lookup import lookup_key
 from oarepo_runtime.records.systemfields.mapping import MappingSystemFieldMixin
 
 
-class ICUField(SystemField):
+class ICUField(MappingSystemFieldMixin, 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
@@ -44,20 +44,20 @@ class ICUField(SystemField):
                     ret.append(val)
         return ret
 
-    def search_dump(self, data):
+    def search_dump(self, data, record):
         ret = {}
         for lang in self.languages:
             ret[lang] = self.get_values(data, lang)
         data[self.attr_name] = ret
 
-    def search_load(self, data):
+    def search_load(self, data, record_cls):
         data.pop(self.attr_name, None)
 
     def __get__(self, instance, owner):
         return self
 
 
-class ICUSortField(MappingSystemFieldMixin, ICUField):
+class ICUSortField(ICUField):
     """
     A field that adds icu sorting field
     """
@@ -83,7 +83,7 @@ class ICUSortField(MappingSystemFieldMixin, ICUField):
         }
 
 
-class ICUSuggestField(MappingSystemFieldMixin, ICUField):
+class ICUSuggestField(ICUField):
     """
     A field that adds icu-aware suggestion field
     """
@@ -132,7 +132,7 @@ class ICUSuggestField(MappingSystemFieldMixin, ICUField):
         }
 
 
-class ICUSearchField(MappingSystemFieldMixin, ICUField):
+class ICUSearchField(ICUField):
     """
     A field that adds stemming-aware search field
     """

{oarepo-runtime-1.5.7 → oarepo-runtime-1.5.10}/oarepo_runtime/records/systemfields/mapping.py

@@ -16,18 +16,28 @@ class MappingSystemFieldMixin:
     def dynamic_templates(self):
         return []
 
+    @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):
     def dump(self, record, data):
         """Dump custom fields."""
         for cf in inspect.getmembers(
-            record, lambda x: isinstance(x, MappingSystemFieldMixin)
+            type(record), lambda x: isinstance(x, MappingSystemFieldMixin)
         ):
-            cf[1].search_dump(data)
+            cf[1].search_dump(data, record=record)
 
     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)
+            cf[1].search_load(data, record_cls=record_cls)

{oarepo-runtime-1.5.7 → oarepo-runtime-1.5.10}/oarepo_runtime/records/systemfields/record_status.py

@@ -3,17 +3,11 @@ from invenio_records.systemfields import SystemField
 from .mapping import MappingSystemFieldMixin
 
 
-class RecordStatusResult(MappingSystemFieldMixin):
+class RecordStatusResult:
     def __init__(self, record, attr_name):
         self.record = record
         self.attr_name = attr_name
 
-    def search_dump(self, data):
-        if getattr(self.record, "is_draft"):
-            data[self.attr_name] = "draft"
-        else:
-            data[self.attr_name] = "published"
-
 
 class RecordStatusSystemField(MappingSystemFieldMixin, SystemField):
     @property
@@ -24,9 +18,15 @@ class RecordStatusSystemField(MappingSystemFieldMixin, SystemField):
             },
         }
 
-    def search_load(self, data):
+    def search_load(self, data, record_cls):
         data.pop(self.attr_name, None)
 
+    def search_dump(self, data, record):
+        if getattr(record, "is_draft"):
+            data[self.attr_name] = "draft"
+        else:
+            data[self.attr_name] = "published"
+
     def __get__(self, record, owner=None):
         """Accessing the attribute."""
         # Class access

{oarepo-runtime-1.5.7 → oarepo-runtime-1.5.10}/oarepo_runtime/records/systemfields/synthetic.py

@@ -62,13 +62,13 @@ class SyntheticSystemField(MappingSystemFieldMixin, SystemField):
            ```
     """
 
-    def search_dump(self, data):
+    def search_dump(self, data, record):
         dt = self._value(data)
         if dt:
             data[self.key] = dt
 
-    def search_load(self, data):
-        data.pop(self.key)
+    def search_load(self, data, record_cls):
+        data.pop(self.key, None)
 
     def __get__(self, record, owner=None):
         if record is None:

oarepo-runtime-1.5.10/oarepo_runtime/services/config/service.py

@@ -0,0 +1,90 @@
+import inspect
+import re
+from functools import cached_property
+from typing import List, Type
+
+from flask import current_app
+from invenio_records_permissions import BasePermissionPolicy
+
+
+class PermissionsPresetsConfigMixin:
+    components = tuple()
+    PERMISSIONS_PRESETS_CONFIG_KEY = None
+    # PERMISSIONS_PRESETS = []         # noqa (omitted here because of the order of mixins)
+
+    @cached_property
+    def permission_policy_cls(self):
+        """
+        Returns a class that contains all permissions from the presets.
+        """
+        presets = self._get_preset_classes()
+
+        permissions = {}
+        for preset_class in presets:
+            for permission_name, permission_needs in self._get_permissions_from_preset(
+                preset_class
+            ):
+                target = permissions.setdefault(permission_name, [])
+                for need in permission_needs:
+                    if need not in target:
+                        target.append(need)
+
+        return type(f"{type(self).__name__}Permissions", tuple(presets), permissions)
+
+    @staticmethod
+    def _get_permissions_from_preset(preset_class):
+        for permission_name, permission_needs in inspect.getmembers(preset_class):
+            if not permission_name.startswith("can_"):
+                continue
+            if not isinstance(permission_needs, (list, tuple)):
+                continue
+            yield permission_name, permission_needs
+
+    def _get_preset_classes(self) -> List[Type[BasePermissionPolicy]]:
+        """
+        Returns a list of permission presets classes to be used for this service.
+
+        The list is read from the configuration, if it exists, otherwise it returns
+        the default value from the class attribute PERMISSIONS_PRESETS.
+        """
+        registered_preset_classes = current_app.config["OAREPO_PERMISSIONS_PRESETS"]
+        preset_classes = [
+            registered_preset_classes[x]
+            for x in self._get_permissions_presets()
+        ]
+        if hasattr(self, "base_permission_policy_cls"):
+            preset_classes.insert(0, self.base_permission_policy_cls)
+        return preset_classes
+
+    def _get_permissions_presets(self):
+        """
+        Returns a list of names of permissions presets to be used for this service.
+
+        The list is read from the configuration, if it exists, otherwise it returns
+        the default value from the class attribute PERMISSIONS_PRESETS.
+        """
+        config_key = self._get_presents_config_key()
+        if config_key in current_app.config:
+            return current_app.config[config_key]
+        return self.PERMISSIONS_PRESETS  # noqa (omitted here because of the order of mixins)
+
+    def _get_presents_config_key(self):
+        """
+        Returns the name of the configuration key that contains the list of
+        permissions presets to be used for this service.
+
+        The key is read from the class attribute PERMISSIONS_PRESETS_CONFIG_KEY.
+        If it is not set, the key is generated from the name of the service
+        configuration class (MyServiceConfig becomes MY_SERVICE_PERMISSIONS_PRESETS).
+        """
+        if self.PERMISSIONS_PRESETS_CONFIG_KEY:
+            return self.PERMISSIONS_PRESETS_CONFIG_KEY
+
+        # use the base class of the service config file (e.g. MyServiceConfig),
+        # remove the "Config" part and convert it to snake uppercase.
+        # add "_PERMISSIONS_PRESETS" at the end.
+        name = type(self).__name__
+        if name.endswith("Config"):
+            name = name[:-6]
+        name = re.sub(r'(?<!^)(?=[A-Z])', '_', name).upper()
+        return f"{name}_PERMISSIONS_PRESETS"

{oarepo-runtime-1.5.7 → oarepo-runtime-1.5.10}/oarepo_runtime/services/custom_fields/__init__.py

@@ -21,14 +21,14 @@ class CustomFieldsMixin(MappingSystemFieldMixin):
     def mapping_settings(self):
         return {}
 
-    def search_dump(self, data):
+    def search_dump(self, data, record):
         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):
+    def search_load(self, data, record_cls):
         custom_fields = current_app.config.get(self.config_key, {})
 
         for cf in custom_fields:

{oarepo-runtime-1.5.7 → oarepo-runtime-1.5.10/oarepo_runtime.egg-info}/PKG-INFO

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

{oarepo-runtime-1.5.7 → oarepo-runtime-1.5.10}/setup.cfg

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

oarepo-runtime-1.5.7/oarepo_runtime/services/config/service.py

@@ -1,43 +0,0 @@
-import inspect
-from functools import cached_property
-
-from flask import current_app
-
-
-class PermissionsPresetsConfigMixin:
-    components = tuple()
-
-    @cached_property
-    def permission_policy_cls(self):
-        presets = self._get_preset_classes()
-
-        permissions = {}
-        for preset_class in presets:
-            for permission_name, permission_needs in self._get_permissions_from_preset(
-                preset_class
-            ):
-                target = permissions.setdefault(permission_name, [])
-                for need in permission_needs:
-                    if need not in target:
-                        target.append(need)
-
-        return type(f"{type(self).__name__}Permissions", tuple(presets), permissions)
-
-    @staticmethod
-    def _get_permissions_from_preset(preset_class):
-        for permission_name, permission_needs in inspect.getmembers(preset_class):
-            if not permission_name.startswith("can_"):
-                continue
-            if not isinstance(permission_needs, (list, tuple)):
-                continue
-            yield permission_name, permission_needs
-
-    def _get_preset_classes(self):
-        registered_preset_classes = current_app.config["OAREPO_PERMISSIONS_PRESETS"]
-        preset_classes = [
-            registered_preset_classes[x]
-            for x in self.PERMISSIONS_PRESETS  # noqa (omitted here because of the order of mixins)
-        ]
-        if hasattr(self, "base_permission_policy_cls"):
-            preset_classes.insert(0, self.base_permission_policy_cls)
-        return preset_classes