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

invenio_vocabularies/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2020-2023 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
@@ -10,6 +10,6 @@
 
 from .ext import InvenioVocabularies
 
-__version__ = "2.3.1"
+__version__ = "6.3.1"
 
 __all__ = ("__version__", "InvenioVocabularies")

invenio_vocabularies/administration/__init__.py

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2024 CERN.
+# Copyright (C) 2024 Uni 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
+# details.
+
+"""Invenio administration views module for vocabularies."""

invenio_vocabularies/administration/views/__init__.py

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020-2024 CERN.
+# Copyright (C) 2024 Uni 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
+# details.
+
+"""Invenio administration views module for Vocabularies."""

invenio_vocabularies/administration/views/vocabularies.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020-2024 CERN.
+# Copyright (C) 2024 Uni 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
+# details.
+
+"""Vocabularies admin interface."""
+
+from invenio_administration.views.base import (
+    AdminResourceEditView,
+    AdminResourceListView,
+)
+
+
+class VocabulariesListView(AdminResourceListView):
+    """Configuration for vocabularies list view."""
+
+    api_endpoint = "/vocabularies/"
+    name = "vocabulary-types"
+    menu_label = "Vocabulary Types"
+    resource_config = "vocabulary_admin_resource"
+    search_request_headers = {"Accept": "application/json"}
+    title = "Vocabulary Types"
+    category = "Site management"
+
+    pid_path = "id"
+    icon = "exchange"
+    template = "invenio_administration/search.html"
+
+    display_search = True
+    display_delete = False
+    display_edit = False
+    display_create = False
+
+    item_field_list = {
+        "id": {"text": "Name", "order": 1},
+        "count": {"text": "Number of entries", "order": 2},
+    }
+
+    search_config_name = "VOCABULARIES_TYPES_SEARCH"
+    search_facets_config_name = "VOCABULARIES_TYPES_FACETS"
+    search_sort_config_name = "VOCABULARIES_TYPES_SORT_OPTIONS"

invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/package.json

@@ -9,11 +9,10 @@
     "@testing-library/jest-dom": "^4.2.0",
     "@testing-library/react": "^9.5.0",
     "@testing-library/user-event": "^7.2.0",
-    "axios": "^0.21.0",
+    "axios": "^1.7.7",
     "coveralls": "^3.0.0",
     "enzyme": "^3.10.0",
     "enzyme-adapter-react-16": "^1.15.0",
-    "enzyme-to-json": "^3.4.0",
     "expect": "^26.0.0",
     "lodash": "^4.17.0",
     "luxon": "^1.23.0",
@@ -22,10 +21,5 @@
     "react-scripts": "^5.0.1",
     "semantic-ui-react": "^2.1.0",
     "react-overridable": "^0.0.3"
-  },
-  "jest": {
-    "snapshotSerializers": [
-      "enzyme-to-json/serializer"
-    ]
   }
 }

invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/src/contrib/forms/Funding/CustomAwardForm.js

@@ -1,5 +1,5 @@
 // This file is part of InvenioVocabularies
-// Copyright (C) 2021-2023 CERN.
+// Copyright (C) 2021-2024 CERN.
 // Copyright (C) 2021 Northwestern University.
 //
 // Invenio is free software; you can redistribute it and/or modify it
@@ -12,25 +12,20 @@ import { TextField, RemoteSelectField } from "react-invenio-forms";
 import { i18next } from "@translations/invenio_rdm_records/i18next";
 import _isEmpty from "lodash/isEmpty";
 
+import Overridable from "react-overridable";
+
 function CustomAwardForm({ deserializeFunder, selectedFunding }) {
   function deserializeFunderToDropdown(funderItem) {
-    let funderName = null;
-    let funderPID = null;
-
-    if (funderItem.name) {
-      funderName = funderItem.name;
-    }
-
-    if (funderItem.pid) {
-      funderPID = funderItem.pid;
-    }
+    const funderName = funderItem?.name;
+    const funderPID = funderItem?.id;
+    const funderCountry = funderItem?.country_name ?? funderItem?.country;
 
     if (!funderName && !funderPID) {
       return {};
     }
 
     return {
-      text: funderName || funderPID,
+      text: [funderName, funderCountry, funderPID].filter((val) => val).join(", "),
       value: funderItem.id,
       key: funderItem.id,
       ...(funderName && { name: funderName }),
@@ -48,64 +43,85 @@ function CustomAwardForm({ deserializeFunder, selectedFunding }) {
 
   return (
     <Form>
-      <RemoteSelectField
+      <Overridable
+        id="InvenioVocabularies.CustomAwardForm.RemoteSelectField.Container"
         fieldPath="selectedFunding.funder.id"
-        suggestionAPIUrl="/api/funders"
-        suggestionAPIHeaders={{
-          Accept: "application/vnd.inveniordm.v1+json",
-        }}
-        placeholder={i18next.t("Search for a funder by name")}
-        serializeSuggestions={(funders) => {
-          return funders.map((funder) =>
-            deserializeFunderToDropdown(deserializeFunder(funder))
-          );
-        }}
-        searchInput={{
-          autoFocus: _isEmpty(selectedFunding),
-        }}
-        label={i18next.t("Funder")}
-        noQueryMessage={i18next.t("Search for funder...")}
-        clearable
-        allowAdditions={false}
-        multiple={false}
-        selectOnBlur={false}
-        selectOnNavigation={false}
-        required
-        search={(options) => options}
-        isFocused
-        onValueChange={({ formikProps }, selectedFundersArray) => {
-          if (selectedFundersArray.length === 1) {
-            const selectedFunder = selectedFundersArray[0];
-            if (selectedFunder) {
-              const deserializedFunder = serializeFunderFromDropdown(selectedFunder);
-              formikProps.form.setFieldValue(
-                "selectedFunding.funder",
-                deserializedFunder
-              );
+      >
+        <RemoteSelectField
+          fieldPath="selectedFunding.funder.id"
+          suggestionAPIUrl="/api/funders"
+          suggestionAPIHeaders={{
+            Accept: "application/vnd.inveniordm.v1+json",
+          }}
+          placeholder={i18next.t("Search for a funder by name")}
+          serializeSuggestions={(funders) => {
+            return funders.map((funder) =>
+              deserializeFunderToDropdown(deserializeFunder(funder))
+            );
+          }}
+          searchInput={{
+            autoFocus: _isEmpty(selectedFunding),
+          }}
+          label={i18next.t("Funder")}
+          noQueryMessage={i18next.t("Search for funder...")}
+          clearable
+          allowAdditions={false}
+          multiple={false}
+          selectOnBlur={false}
+          selectOnNavigation={false}
+          required
+          search={(options) => options}
+          isFocused
+          onValueChange={({ formikProps }, selectedFundersArray) => {
+            if (selectedFundersArray.length === 1) {
+              const selectedFunder = selectedFundersArray[0];
+              if (selectedFunder) {
+                const deserializedFunder = serializeFunderFromDropdown(selectedFunder);
+                formikProps.form.setFieldValue(
+                  "selectedFunding.funder",
+                  deserializedFunder
+                );
+              }
             }
-          }
-        }}
-      />
-
-      <Header as="h3" size="small">
-        {i18next.t("Award information")} ({i18next.t("optional")})
-      </Header>
+          }}
+        />
+      </Overridable>
+      <Overridable id="InvenioVocabularies.CustomAwardForm.AwardInformationHeader.Container">
+        <Header as="h3" size="small">
+          {i18next.t("Additional information")} ({i18next.t("optional")})
+        </Header>
+      </Overridable>
       <Form.Group widths="equal">
-        <TextField
-          label={i18next.t("Number")}
-          placeholder={i18next.t("Award number")}
+        <Overridable
+          id="InvenioVocabularies.CustomAwardForm.AwardNumberTextField.Container"
           fieldPath="selectedFunding.award.number"
-        />
-        <TextField
-          label={i18next.t("Title")}
-          placeholder={i18next.t("Award Title")}
+        >
+          <TextField
+            label={i18next.t("Number")}
+            placeholder={i18next.t("Award/Grant number")}
+            fieldPath="selectedFunding.award.number"
+          />
+        </Overridable>
+        <Overridable
+          id="InvenioVocabularies.CustomAwardForm.AwardTitleTextField.Container"
           fieldPath="selectedFunding.award.title"
-        />
-        <TextField
-          label={i18next.t("URL")}
-          placeholder={i18next.t("Award URL")}
+        >
+          <TextField
+            label={i18next.t("Title")}
+            placeholder={i18next.t("Award/Grant Title")}
+            fieldPath="selectedFunding.award.title"
+          />
+        </Overridable>
+        <Overridable
+          id="InvenioVocabularies.CustomAwardForm.AwardUrlTextField.Container"
           fieldPath="selectedFunding.award.url"
-        />
+        >
+          <TextField
+            label={i18next.t("URL")}
+            placeholder={i18next.t("Award/Grant URL")}
+            fieldPath="selectedFunding.award.url"
+          />
+        </Overridable>
       </Form.Group>
     </Form>
   );

invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/src/contrib/forms/Funding/FundingField.js

@@ -1,5 +1,5 @@
 // This file is part of InvenioVocabularies
-// Copyright (C) 2021-2023 CERN.
+// Copyright (C) 2021-2024 CERN.
 // Copyright (C) 2021 Northwestern University.
 //
 // Invenio is free software; you can redistribute it and/or modify it
@@ -18,6 +18,8 @@ import FundingModal from "./FundingModal";
 
 import { i18next } from "@translations/invenio_rdm_records/i18next";
 
+import Overridable from "react-overridable";
+
 function FundingFieldForm(props) {
   const {
     label,
@@ -108,46 +110,52 @@ function FundingFieldForm(props) {
             );
           })}
         </List>
-        <FundingModal
-          searchConfig={searchConfig}
-          trigger={
-            <Button
-              type="button"
-              key="custom"
-              icon
-              labelPosition="left"
-              className="mb-5"
-            >
-              <Icon name="add" />
-              {i18next.t("Add award")}
-            </Button>
-          }
-          onAwardChange={(selectedFunding) => {
-            formikArrayPush(selectedFunding);
-          }}
-          mode="standard"
-          action="add"
-          deserializeAward={deserializeAward}
-          deserializeFunder={deserializeFunder}
-          computeFundingContents={computeFundingContents}
-        />
-        <FundingModal
-          searchConfig={searchConfig}
-          trigger={
-            <Button type="button" key="custom" icon labelPosition="left">
-              <Icon name="add" />
-              {i18next.t("Add custom")}
-            </Button>
-          }
-          onAwardChange={(selectedFunding) => {
-            formikArrayPush(selectedFunding);
-          }}
-          mode="custom"
-          action="add"
-          deserializeAward={deserializeAward}
-          deserializeFunder={deserializeFunder}
-          computeFundingContents={computeFundingContents}
-        />
+
+        <Overridable id="InvenioVocabularies.FundingField.AddAwardFundingModal.Container">
+          <FundingModal
+            searchConfig={searchConfig}
+            trigger={
+              <Button
+                type="button"
+                key="custom"
+                icon
+                labelPosition="left"
+                className="mb-5"
+              >
+                <Icon name="add" />
+                {i18next.t("Add")}
+              </Button>
+            }
+            onAwardChange={(selectedFunding) => {
+              formikArrayPush(selectedFunding);
+            }}
+            mode="standard"
+            action="add"
+            deserializeAward={deserializeAward}
+            deserializeFunder={deserializeFunder}
+            computeFundingContents={computeFundingContents}
+          />
+        </Overridable>
+
+        <Overridable id="InvenioVocabularies.FundingField.AddCustomFundingModal.Container">
+          <FundingModal
+            searchConfig={searchConfig}
+            trigger={
+              <Button type="button" key="custom" icon labelPosition="left">
+                <Icon name="add" />
+                {i18next.t("Add custom")}
+              </Button>
+            }
+            onAwardChange={(selectedFunding) => {
+              formikArrayPush(selectedFunding);
+            }}
+            mode="custom"
+            action="add"
+            deserializeAward={deserializeAward}
+            deserializeFunder={deserializeFunder}
+            computeFundingContents={computeFundingContents}
+          />
+        </Overridable>
       </Form.Field>
     </DndProvider>
   );

invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/src/contrib/forms/Funding/FundingModal.js

@@ -1,5 +1,5 @@
 // This file is part of InvenioVocabularies
-// Copyright (C) 2021-2023 CERN.
+// Copyright (C) 2021-2024 CERN.
 // Copyright (C) 2021 Northwestern University.
 //
 // Invenio is free software; you can redistribute it and/or modify it
@@ -157,8 +157,8 @@ function FundingModal({
         >
           <Modal.Header as="h2" className="pt-10 pb-10">
             {mode === "standard"
-              ? i18next.t("Add standard award")
-              : i18next.t("Add custom award")}
+              ? i18next.t("Add standard award/grant")
+              : i18next.t("Add custom funding")}
           </Modal.Header>
           <Modal.Content>
             {mode === ModalTypes.STANDARD && (
@@ -172,7 +172,7 @@ function FundingModal({
                   <Grid.Row>
                     <Grid.Column width={11} floated="left" verticalAlign="middle">
                       <SearchBar
-                        placeholder={i18next.t("Search for awards")}
+                        placeholder={i18next.t("Search for awards/grants")}
                         autofocus
                         actionProps={{
                           icon: "search",
@@ -234,9 +234,7 @@ function FundingModal({
               primary
               icon="checkmark"
               content={
-                action === ModalActions.ADD
-                  ? i18next.t("Add award")
-                  : i18next.t("Change award")
+                action === ModalActions.ADD ? i18next.t("Add") : i18next.t("Change")
               }
             />
           </Modal.Actions>

invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/src/contrib/forms/Funding/NoAwardResults.js

@@ -1,5 +1,5 @@
 // This file is part of InvenioVocabularies
-// Copyright (C) 2021-2023 CERN.
+// Copyright (C) 2021-2024 CERN.
 // Copyright (C) 2021 Northwestern University.
 //
 // Invenio is free software; you can redistribute it and/or modify it
@@ -16,7 +16,7 @@ export function NoAwardResults({ switchToCustom }) {
       basic
       content={
         <p>
-          {i18next.t("Did not find your award? ")}
+          {i18next.t("Did not find your award/grant? ")}
           <a
             href="/"
             onClick={(e) => {
@@ -24,7 +24,7 @@ export function NoAwardResults({ switchToCustom }) {
               switchToCustom();
             }}
           >
-            {i18next.t("Add a custom award.")}
+            {i18next.t("Add a custom award/grant.")}
           </a>
         </p>
       }

invenio_vocabularies/cli.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2020-2021 CERN.
+# Copyright (C) 2020-2024 CERN.
 # Copyright (C) 2021 Graz University of Technology.
 #
 # Invenio-Vocabularies is free software; you can redistribute it and/or
@@ -9,46 +9,13 @@
 
 """Commands to create and manage vocabularies."""
 
-from copy import deepcopy
-
 import click
-import yaml
 from flask.cli import with_appcontext
 from invenio_access.permissions import system_identity
 from invenio_pidstore.errors import PIDDeletedError, PIDDoesNotExistError
-from invenio_records_resources.proxies import current_service_registry
 
-from .contrib.awards.datastreams import DATASTREAM_CONFIG as awards_ds_config
-from .contrib.funders.datastreams import DATASTREAM_CONFIG as funders_ds_config
-from .contrib.names.datastreams import DATASTREAM_CONFIG as names_ds_config
 from .datastreams import DataStreamFactory
-
-
-def get_config_for_ds(vocabulary, filepath=None, origin=None):
-    """Calculates the configuration for a Data Stream."""
-    config = None
-    if vocabulary == "names":  # FIXME: turn into a proper factory
-        config = deepcopy(names_ds_config)
-    elif vocabulary == "funders":
-        config = deepcopy(funders_ds_config)
-    elif vocabulary == "awards":
-        config = deepcopy(awards_ds_config)
-
-    if config:
-        if filepath:
-            with open(filepath) as f:
-                config = yaml.safe_load(f).get(vocabulary)
-        if origin:
-            config["readers"][0].setdefault("args", {})
-            config["readers"][0]["args"]["origin"] = origin
-
-    return config
-
-
-def get_service_for_vocabulary(vocabulary):
-    """Calculates the configuration for a Data Stream."""
-    if vocabulary == "names":  # FIXME: turn into a proper factory
-        return current_service_registry.get("names")
+from .factories import get_vocabulary_config
 
 
 @click.group()
@@ -111,7 +78,9 @@ def import_vocab(vocabulary, filepath=None, origin=None, num_samples=None):
         click.secho("One of --filepath or --origin must be present.", fg="red")
         exit(1)
 
-    config = get_config_for_ds(vocabulary, filepath, origin)
+    vc = get_vocabulary_config(vocabulary)
+    config = vc.get_config(filepath, origin)
+
     success, errored, filtered = _process_vocab(config, num_samples)
 
     _output_process(vocabulary, "imported", success, errored, filtered)
@@ -127,11 +96,19 @@ def update(vocabulary, filepath=None, origin=None):
     if not filepath and not origin:
         click.secho("One of --filepath or --origin must be present.", fg="red")
         exit(1)
-
-    config = get_config_for_ds(vocabulary, filepath, origin)
+    vc = get_vocabulary_config(vocabulary)
+    config = vc.get_config(filepath, origin)
 
     for w_conf in config["writers"]:
-        w_conf["args"]["update"] = True
+        if w_conf["type"] == "async":
+            w_conf_update = w_conf["args"]["writer"]
+        else:
+            w_conf_update = w_conf
+
+        if "args" in w_conf_update:
+            w_conf_update["args"]["update"] = True
+        else:
+            w_conf_update["args"] = {"update": True}
 
     success, errored, filtered = _process_vocab(config)
 
@@ -153,7 +130,8 @@ def convert(vocabulary, filepath=None, origin=None, target=None, num_samples=Non
         )
         exit(1)
 
-    config = get_config_for_ds(vocabulary, filepath, origin)
+    vc = get_vocabulary_config(vocabulary)
+    config = vc.get_config(filepath, origin)
     if not filepath:
         config["writers"] = [{"type": "yaml", "args": {"filepath": target}}]
 
@@ -169,18 +147,27 @@ def convert(vocabulary, filepath=None, origin=None, target=None, num_samples=Non
     type=click.STRING,
     help="Identifier of the vocabulary item to delete.",
 )
-@click.option("--all", is_flag=True, default=False, help="Not supported yet.")
+@click.option("--all", is_flag=True, default=False)
 @with_appcontext
 def delete(vocabulary, identifier, all):
     """Delete all items or a specific one of the vocabulary."""
-    if not id and not all:
+    if not identifier and not all:
         click.secho("An identifier or the --all flag must be present.", fg="red")
         exit(1)
 
-    service = get_service_for_vocabulary(vocabulary)
+    vc = get_vocabulary_config(vocabulary)
+    service = vc.get_service()
     if identifier:
         try:
-            if service.delete(identifier, system_identity):
+            if service.delete(system_identity, identifier):
                 click.secho(f"{identifier} deleted from {vocabulary}.", fg="green")
         except (PIDDeletedError, PIDDoesNotExistError):
             click.secho(f"PID {identifier} not found.")
+    elif all:
+        items = service.scan(system_identity)
+        for item in items.hits:
+            try:
+                if service.delete(system_identity, item["id"]):
+                    click.secho(f"{item['id']} deleted from {vocabulary}.", fg="green")
+            except (PIDDeletedError, PIDDoesNotExistError):
+                click.secho(f"PID {item['id']} not found.")