invenio-vocabularies 2.3.1__py2.py3-none-any.whl → 6.3.1__py2.py3-none-any.whl

invenio_vocabularies/services/schema.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2020-2022 CERN.
+# Copyright (C) 2020-2024 CERN.
 #
 # Invenio-Vocabularies is free software; you can redistribute it and/or
 # modify it under the terms of the MIT License; see LICENSE file for more
@@ -35,6 +35,9 @@ class BaseVocabularyRelationSchema(Schema):
 
     id = SanitizedUnicode(required=True)
 
+    # Nested field type for administration UI form generation
+    administration_schema_type = "vocabulary"
+
 
 class VocabularyRelationSchema(BaseVocabularyRelationSchema):
     """Vocabulary relation schema."""
@@ -63,6 +66,9 @@ class ContribVocabularyRelationSchema(Schema):
     ftf_name = None  # free text field name
     parent_field_name = None
 
+    # Nested field type for administration UI form generation
+    administration_schema_type = "vocabulary"
+
     @validates_schema
     def validate_relation_schema(self, data, **kwargs):
         """Validates that either id either the free text field are present."""
@@ -90,13 +96,16 @@ class BaseVocabularySchema(BaseRecordSchema):
     title = i18n_strings
     description = i18n_strings
     icon = fields.Str(allow_none=False)
+    tags = fields.List(SanitizedUnicode())
+
+    # Nested field type for administration UI form generation
+    administration_schema_type = "vocabulary"
 
 
 class VocabularySchema(BaseVocabularySchema):
     """Service schema for vocabulary records."""
 
     props = fields.Dict(allow_none=False, keys=fields.Str(), values=fields.Str())
-    tags = fields.List(SanitizedUnicode())
     type = fields.Str(attribute="type.id", required=True)
 
 

invenio_vocabularies/services/service.py

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2020-2021 CERN.
+# Copyright (C) 2024 CERN.
 # Copyright (C) 2021 Northwestern University.
+# Copyright (C) 2024 University of Münster.
 #
 # Invenio-Vocabularies is free software; you can redistribute it and/or
 # modify it under the terms of the MIT License; see LICENSE file for more
@@ -9,108 +10,59 @@
 
 """Vocabulary service."""
 
+import sqlalchemy as sa
 from invenio_cache import current_cache
-from invenio_db import db
-from invenio_i18n import lazy_gettext as _
-from invenio_records_resources.services import (
-    Link,
-    LinksTemplate,
-    RecordService,
-    RecordServiceConfig,
-    SearchOptions,
-    pagination_links,
-)
-from invenio_records_resources.services.records.components import DataComponent
-from invenio_records_resources.services.records.params import (
-    FilterParam,
-    SuggestQueryParser,
-)
+from invenio_records_resources.services import LinksTemplate, RecordService
+from invenio_records_resources.services.base.utils import map_search_params
 from invenio_records_resources.services.records.schema import ServiceSchemaWrapper
 from invenio_records_resources.services.uow import unit_of_work
 from invenio_search.engine import dsl
 
-from ..records.api import Vocabulary
 from ..records.models import VocabularyType
-from .components import PIDComponent, VocabularyTypeComponent
-from .permissions import PermissionPolicy
-from .schema import TaskSchema, VocabularySchema
 from .tasks import process_datastream
 
 
-class VocabularySearchOptions(SearchOptions):
-    """Search options."""
-
-    params_interpreters_cls = [
-        FilterParam.factory(param="tags", field="tags"),
-    ] + SearchOptions.params_interpreters_cls
-
-    suggest_parser_cls = SuggestQueryParser.factory(
-        fields=[
-            "id.text^100",
-            "id.text._2gram",
-            "id.text._3gram",
-            "title.en^5",
-            "title.en._2gram",
-            "title.en._3gram",
-        ],
-    )
-
-    sort_default = "bestmatch"
-
-    sort_default_no_query = "title"
-
-    sort_options = {
-        "bestmatch": dict(
-            title=_("Best match"),
-            fields=["_score"],  # ES defaults to desc on `_score` field
-        ),
-        "title": dict(
-            title=_("Title"),
-            fields=["title_sort"],
-        ),
-        "newest": dict(
-            title=_("Newest"),
-            fields=["-created"],
-        ),
-        "oldest": dict(
-            title=_("Oldest"),
-            fields=["created"],
-        ),
-    }
-
-
-class VocabulariesServiceConfig(RecordServiceConfig):
-    """Vocabulary service configuration."""
-
-    service_id = "vocabularies"
-    indexer_queue_name = "vocabularies"
-    permission_policy_cls = PermissionPolicy
-    record_cls = Vocabulary
-    schema = VocabularySchema
-    task_schema = TaskSchema
-
-    search = VocabularySearchOptions
-
-    components = [
-        # Order of components are important!
-        VocabularyTypeComponent,
-        DataComponent,
-        PIDComponent,
-    ]
-
-    links_item = {
-        "self": Link(
-            "{+api}/vocabularies/{type}/{id}",
-            vars=lambda record, vars: vars.update(
-                {
-                    "id": record.pid.pid_value,
-                    "type": record.type.id,
-                }
-            ),
-        ),
-    }
+class VocabularyTypeService(RecordService):
+    """Vocabulary type service."""
+
+    def rebuild_index(self, identity, uow=None):
+        """Raise error since services are not backed by search indices."""
+        raise NotImplementedError()
+
+    def search(self, identity, params=None):
+        """Search for vocabulary types entries."""
+        self.require_permission(identity, "list_vocabularies")
+
+        search_params = map_search_params(self.config.search, params)
+
+        query_param = search_params["q"]
+
+        filters = []
+        if query_param:
+            filters.extend([VocabularyType.id.ilike(f"%{query_param}%")])
+
+        vocabulary_types = (
+            VocabularyType.query.filter(sa.or_(*filters))
+            .order_by(
+                search_params["sort_direction"](
+                    sa.text(",".join(search_params["sort"]))
+                )
+            )
+            .paginate(
+                page=search_params["page"],
+                per_page=search_params["size"],
+                error_out=False,
+            )
+        )
 
-    links_search = pagination_links("{+api}/vocabularies/{type}{?args*}")
+        return self.config.result_list_cls(
+            self,
+            identity,
+            vocabulary_types,
+            search_params,
+            links_tpl=LinksTemplate(self.config.links_search, context={"args": params}),
+            links_item_tpl=self.links_item_tpl,
+        )
 
 
 class VocabulariesService(RecordService):
@@ -145,7 +97,7 @@ class VocabulariesService(RecordService):
             params,
             search_preference,
             extra_filter=dsl.Q("term", type__id=vocabulary_type.id),
-            **kwargs
+            **kwargs,
         ).execute()
 
         return self.result_list(

invenio_vocabularies/services/tasks.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2022 CERN.
+# Copyright (C) 2022-2024 CERN.
 #
 # Invenio-Vocabularies is free software; you can redistribute it and/or modify
 # it under the terms of the MIT License; see LICENSE file for more details.

invenio_vocabularies/templates/semantic-ui/invenio_vocabularies/subjects.html

@@ -0,0 +1,23 @@
+{#
+  Copyright (C) 2024 CERN.
+
+  Invenio RDM Records is free software; you can redistribute it and/or modify
+  it under the terms of the MIT License; see LICENSE file for more details.
+#}
+
+{%- set subjects = field_value -%}
+{% if subjects %}
+  <ul class="ui horizontal list no-bullets subjects">
+    {%- for subject in subjects %}
+    <li class="item">
+      {%- set q = 'metadata.subjects.subject:"' + subject.subject + '"' %}
+      <a href="{{ url_for('invenio_search_ui.search', q=q) }}"
+          class="subject"
+          title="{{ _('Search results for ') + subject.subject }}"
+      >
+        {{ subject.subject }}
+      </a>
+    </li>
+    {%- endfor %}
+  </ul>
+{% endif %}

invenio_vocabularies/templates/semantic-ui/invenio_vocabularies/vocabularies-list.html

@@ -0,0 +1,12 @@
+{#
+    Copyright (C) 2024 Uni Münster.
+
+    Invenio App RDM is free software; you can redistribute it and/or modify it
+    under the terms of the MIT License; see LICENSE file for more details.
+  #}
+  {% extends "invenio_administration/search.html" %}
+
+  {% block javascript %}
+  {{ super() }}
+  {{ webpack['invenio-vocabularies-search.js'] }}
+{% endblock %}

invenio_vocabularies/templates/semantic-ui/invenio_vocabularies/vocabulary-details.html

@@ -0,0 +1,71 @@
+{#
+    Copyright (C) 2024 CERN.
+  
+    Invenio App RDM is free software; you can redistribute it and/or modify it
+    under the terms of the MIT License; see LICENSE file for more details.
+  #}
+  
+  {%- from "invenio_administration/macros.html" import go_back %}
+  
+  {% extends "invenio_administration/search.html" %}
+  
+  {% block admin_main_column %}
+    <main id="admin-main-content"
+          class="ten wide mobile twelve wide tablet thirteen wide computer fourteen wide widescreen column">
+  
+      <div class="ui container fluid pl-10 pr-10 pt-10 pb-10">
+        {{ go_back() }}
+      <div class="ui grid">
+        <div class="column six wide">
+          <h1 class="ui header">{{ title or name }}</h1>
+        </div>
+        <div class="column ten wide right aligned">
+          <a class="ui icon labeled button"
+              href="{{ edit_endpoint }}">
+            <i aria-hidden="true"
+                class="cog icon"></i>{{ _("Settings") }}
+          </a>
+          <a class="ui icon labeled button"
+              href="{{ create_ui_endpoint }}">
+            <i aria-hidden="true"
+                class="calendar icon"></i>{{ _("Schedule") }}
+          </a>
+          <a class="ui icon labeled button"
+              href="{{ run_endpoint }}">
+            <i aria-hidden="true"
+                class="play icon"></i>{{ _("Run now") }}
+          </a>
+        </div>
+      </div>
+        {% block admin_page_content %}
+          <div class="ui divider" aria-hidden="true"></div>
+  
+          {%- block search_app %}
+            <div
+              id="invenio-search-config"
+              data-title='{{ title | tojson }}'
+              data-resource-name='{{ resource_name | tojson }}'
+              data-invenio-search-config='{{ search_config() | tojson }}'
+              data-fields='{{ fields | tojson }}'
+              data-display-search='{{ display_search | tojson }}'
+              data-display-read='{{ display_read | tojson }}'
+              data-display-edit='{{ display_edit | tojson }}'
+              data-display-delete='{{ display_delete | tojson }}'
+              data-resource-schema='{{ resource_schema | tojson }}'
+              data-actions='{{ actions | tojson }}'
+              data-api-endpoint='{{ api_endpoint }}'
+              data-pid-path='{{ pid_path | tojson }}'
+              data-create-endpoint='{{ create_ui_endpoint }}'
+              data-list-endpoint='{{ list_ui_endpoint }}'
+            >
+            </div>
+          {%- endblock search_app %}
+        {% endblock admin_page_content %}
+      </div>
+    </main>
+  {% endblock %}
+  
+  {% block javascript %}
+    {{ super() }}
+    {{ webpack['invenio-jobs-details.js'] }}
+  {% endblock %}

invenio_vocabularies/translations/messages.pot

@@ -1,138 +1,185 @@
 # Translations template for invenio-vocabularies.
-# Copyright (C) 2022 CERN
+# Copyright (C) 2024 CERN
 # This file is distributed under the same license as the
 # invenio-vocabularies project.
-# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
 #
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: invenio-vocabularies 0.13.2\n"
+"Project-Id-Version: invenio-vocabularies 4.3.0\n"
 "Report-Msgid-Bugs-To: info@inveniosoftware.org\n"
-"POT-Creation-Date: 2022-10-12 12:27+0000\n"
+"POT-Creation-Date: 2024-08-06 08:57+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"Generated-By: Babel 2.10.3\n"
+"Generated-By: Babel 2.15.0\n"
 
-#: invenio_vocabularies/config.py:37
+#: invenio_vocabularies/config.py:38
 msgid "GRID"
 msgstr ""
 
-#: invenio_vocabularies/config.py:38 invenio_vocabularies/config.py:97
+#: invenio_vocabularies/config.py:39 invenio_vocabularies/config.py:103
 msgid "GND"
 msgstr ""
 
-#: invenio_vocabularies/config.py:39 invenio_vocabularies/config.py:96
+#: invenio_vocabularies/config.py:40 invenio_vocabularies/config.py:102
 msgid "ISNI"
 msgstr ""
 
-#: invenio_vocabularies/config.py:40
+#: invenio_vocabularies/config.py:41
 msgid "ROR"
 msgstr ""
 
-#: invenio_vocabularies/config.py:51 invenio_vocabularies/config.py:60
+#: invenio_vocabularies/config.py:52 invenio_vocabularies/config.py:61
 msgid "DOI"
 msgstr ""
 
-#: invenio_vocabularies/config.py:59
+#: invenio_vocabularies/config.py:60
 msgid "URL"
 msgstr ""
 
-#: invenio_vocabularies/config.py:95
+#: invenio_vocabularies/config.py:101
 msgid "ORCID"
 msgstr ""
 
-#: invenio_vocabularies/contrib/affiliations/config.py:44
-#: invenio_vocabularies/contrib/funders/config.py:45
-#: invenio_vocabularies/contrib/names/config.py:45
-#: invenio_vocabularies/contrib/subjects/config.py:38
-#: invenio_vocabularies/services/service.py:64
-msgid "Best match"
-msgstr ""
-
-#: invenio_vocabularies/contrib/affiliations/config.py:48
+#: invenio_vocabularies/config.py:143
+#: invenio_vocabularies/contrib/affiliations/config.py:42
 #: invenio_vocabularies/contrib/funders/config.py:49
 #: invenio_vocabularies/contrib/names/config.py:49
 #: invenio_vocabularies/contrib/subjects/config.py:42
 msgid "Name"
 msgstr ""
 
-#: invenio_vocabularies/contrib/affiliations/config.py:52
+#: invenio_vocabularies/config.py:147
+msgid "Number of entries"
+msgstr ""
+
+#: invenio_vocabularies/contrib/affiliations/config.py:38
+#: invenio_vocabularies/contrib/funders/config.py:45
+#: invenio_vocabularies/contrib/names/config.py:45
+#: invenio_vocabularies/contrib/subjects/config.py:38
+#: invenio_vocabularies/services/config.py:73
+msgid "Best match"
+msgstr ""
+
+#: invenio_vocabularies/contrib/affiliations/config.py:46
 #: invenio_vocabularies/contrib/funders/config.py:53
 #: invenio_vocabularies/contrib/names/config.py:53
 #: invenio_vocabularies/contrib/subjects/config.py:46
-#: invenio_vocabularies/services/service.py:72
+#: invenio_vocabularies/services/config.py:81
 msgid "Newest"
 msgstr ""
 
-#: invenio_vocabularies/contrib/affiliations/config.py:56
+#: invenio_vocabularies/contrib/affiliations/config.py:50
 #: invenio_vocabularies/contrib/funders/config.py:57
 #: invenio_vocabularies/contrib/names/config.py:57
 #: invenio_vocabularies/contrib/subjects/config.py:50
-#: invenio_vocabularies/services/service.py:76
+#: invenio_vocabularies/services/config.py:85
 msgid "Oldest"
 msgstr ""
 
-#: invenio_vocabularies/contrib/awards/config.py:51
-msgid "Funders"
+#: invenio_vocabularies/contrib/affiliations/schema.py:41
+#: invenio_vocabularies/contrib/funders/schema.py:36
+#: invenio_vocabularies/contrib/funders/schema.py:44
+msgid "Name cannot be blank."
 msgstr ""
 
-#: invenio_vocabularies/contrib/awards/datastreams.py:47
-msgid "Unknown OpenAIRE funder prefix {openaire_funder_prefix}"
+#: invenio_vocabularies/contrib/affiliations/schema.py:47
+#: invenio_vocabularies/contrib/awards/schema.py:50
+#: invenio_vocabularies/contrib/funders/schema.py:60
+msgid "PID cannot be blank."
 msgstr ""
 
-#: invenio_vocabularies/contrib/awards/schema.py:46
-msgid "Number cannot be blank."
+#: invenio_vocabularies/contrib/awards/config.py:49
+msgid "Funders"
 msgstr ""
 
-#: invenio_vocabularies/contrib/awards/schema.py:53
-#: invenio_vocabularies/contrib/funders/schema.py:57
-msgid "PID cannot be blank."
+#: invenio_vocabularies/contrib/awards/datastreams.py:118
+msgid "Unknown OpenAIRE funder prefix {openaire_funder_prefix}"
 msgstr ""
 
-#: invenio_vocabularies/contrib/awards/schema.py:61
-#: invenio_vocabularies/contrib/funders/schema.py:65
-msgid "Missing PID."
+#: invenio_vocabularies/contrib/awards/datastreams.py:159
+msgid "Missing title attribute for award {award_id}"
+msgstr ""
+
+#: invenio_vocabularies/contrib/awards/schema.py:41
+msgid "Number cannot be blank."
 msgstr ""
 
-#: invenio_vocabularies/contrib/awards/schema.py:103
+#: invenio_vocabularies/contrib/awards/schema.py:80
 msgid "An existing id or number/title must be present."
 msgstr ""
 
-#: invenio_vocabularies/contrib/awards/schema.py:120
+#: invenio_vocabularies/contrib/awards/schema.py:97
 msgid "At least award or funder should be present."
 msgstr ""
 
-#: invenio_vocabularies/contrib/funders/datastreams.py:44
+#: invenio_vocabularies/contrib/common/ror/datastreams.py:123
 msgid "Id not found in ROR entry."
 msgstr ""
 
-#: invenio_vocabularies/contrib/funders/datastreams.py:48
-msgid "Name not found in ROR entry."
+#: invenio_vocabularies/contrib/common/ror/datastreams.py:153
+msgid "Name with type ror_display not found in ROR entry."
 msgstr ""
 
-#: invenio_vocabularies/contrib/funders/schema.py:35
-#: invenio_vocabularies/contrib/funders/schema.py:43
-msgid "Name cannot be blank."
+#: invenio_vocabularies/contrib/funders/schema.py:73
+#: invenio_vocabularies/services/schema.py:120
+msgid "Missing PID."
 msgstr ""
 
 #: invenio_vocabularies/contrib/names/schema.py:53
 msgid "A name or the family name together with the given name must be present."
 msgstr ""
 
+#: invenio_vocabularies/contrib/names/schema.py:68
+msgid "Duplicated affiliations."
+msgstr ""
+
 #: invenio_vocabularies/services/components.py:29
 msgid "The vocabulary type does not exists."
 msgstr ""
 
-#: invenio_vocabularies/services/schema.py:77
+#: invenio_vocabularies/services/config.py:77
+msgid "Title"
+msgstr ""
+
+#: invenio_vocabularies/services/config.py:96
+msgid "ID"
+msgstr ""
+
+#: invenio_vocabularies/services/config.py:106
+msgid "Ascending"
+msgstr ""
+
+#: invenio_vocabularies/services/config.py:107
+msgid "Descending"
+msgstr ""
+
+#: invenio_vocabularies/services/schema.py:85
 msgid "An existing id or a free text {ftf_name} must be present."
 msgstr ""
 
-#: invenio_vocabularies/services/service.py:68
-msgid "Title"
+#: invenio_vocabularies/services/custom_fields/subject.py:50
+msgid "Subjects"
+msgstr ""
+
+#: invenio_vocabularies/templates/semantic-ui/invenio_vocabularies/subjects.html:16
+msgid "Search results for "
+msgstr ""
+
+#: invenio_vocabularies/templates/semantic-ui/invenio_vocabularies/vocabulary-details.html:26
+msgid "Settings"
+msgstr ""
+
+#: invenio_vocabularies/templates/semantic-ui/invenio_vocabularies/vocabulary-details.html:31
+msgid "Schedule"
+msgstr ""
+
+#: invenio_vocabularies/templates/semantic-ui/invenio_vocabularies/vocabulary-details.html:36
+msgid "Run now"
 msgstr ""