invenio-vocabularies 3.1.0__tar.gz → 3.3.0__tar.gz

{invenio-vocabularies-3.1.0 → invenio-vocabularies-3.3.0}/CHANGES.rst

@@ -8,6 +8,17 @@
 Changes
 =======
 
+Version 3.3.0 (released 2024-04-16)
+
+- assets: add overridable awards and funding
+
+Version 3.2.0 (released 2024-03-22)
+
+- funding: add country and ror to funder search results
+- init: move record_once to finalize_app (removes deprecation on `before_first_request`)
+- installation: upgrade invenio-app
+
+
 Version 3.1.0 (released 2024-03-05)
 
 - custom_fields: added subject field

{invenio-vocabularies-3.1.0 → invenio-vocabularies-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invenio-vocabularies
-Version: 3.1.0
+Version: 3.3.0
 Summary: "Invenio module for managing vocabularies."
 Home-page: https://github.com/inveniosoftware/invenio-vocabularies
 Author: CERN
@@ -50,6 +50,17 @@ Description: ..
         Changes
         =======
         
+        Version 3.3.0 (released 2024-04-16)
+        
+        - assets: add overridable awards and funding
+        
+        Version 3.2.0 (released 2024-03-22)
+        
+        - funding: add country and ror to funder search results
+        - init: move record_once to finalize_app (removes deprecation on `before_first_request`)
+        - installation: upgrade invenio-app
+        
+        
         Version 3.1.0 (released 2024-03-05)
         
         - custom_fields: added subject field

{invenio-vocabularies-3.1.0 → invenio-vocabularies-3.3.0}/invenio_vocabularies/__init__.py

@@ -10,6 +10,6 @@
 
 from .ext import InvenioVocabularies
 
-__version__ = "3.1.0"
+__version__ = "3.3.0"
 
 __all__ = ("__version__", "InvenioVocabularies")

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

@@ -0,0 +1,151 @@
+// This file is part of InvenioVocabularies
+// Copyright (C) 2021-2023 CERN.
+// Copyright (C) 2021 Northwestern University.
+//
+// Invenio is free software; you can redistribute it and/or modify it
+// under the terms of the MIT License; see LICENSE file for more details.
+
+import PropTypes from "prop-types";
+import React from "react";
+import { Form, Header } from "semantic-ui-react";
+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;
+    let funderCountry = null;
+
+    if (funderItem.name) {
+      funderName = funderItem.name;
+    }
+
+    if (funderItem.id) {
+      funderPID = funderItem.id;
+    }
+
+    if (funderItem.country) {
+      funderCountry = funderItem.country;
+    }
+
+    if (!funderName && !funderPID) {
+      return {};
+    }
+
+    return {
+      text: [funderName, funderCountry, funderPID].filter((val) => val).join(", "),
+      value: funderItem.id,
+      key: funderItem.id,
+      ...(funderName && { name: funderName }),
+      ...(funderPID && { pid: funderPID }),
+    };
+  }
+
+  function serializeFunderFromDropdown(funderDropObject) {
+    return {
+      id: funderDropObject.key,
+      ...(funderDropObject.name && { name: funderDropObject.name }),
+      ...(funderDropObject.pid && { pid: funderDropObject.pid }),
+    };
+  }
+
+  return (
+    <Form>
+      <Overridable
+        id="InvenioVocabularies.CustomAwardForm.RemoteSelectField.Container"
+        fieldPath="selectedFunding.funder.id"
+      >
+        <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
+                );
+              }
+            }
+          }}
+        />
+      </Overridable>
+      <Overridable id="InvenioVocabularies.CustomAwardForm.AwardInformationHeader.Container">
+        <Header as="h3" size="small">
+          {i18next.t("Award information")} ({i18next.t("optional")})
+        </Header>
+      </Overridable>
+      <Form.Group widths="equal">
+        <Overridable
+          id="InvenioVocabularies.CustomAwardForm.AwardNumberTextField.Container"
+          fieldPath="selectedFunding.award.number"
+        >
+          <TextField
+            label={i18next.t("Number")}
+            placeholder={i18next.t("Award number")}
+            fieldPath="selectedFunding.award.number"
+          />
+        </Overridable>
+        <Overridable
+          id="InvenioVocabularies.CustomAwardForm.AwardTitleTextField.Container"
+          fieldPath="selectedFunding.award.title"
+        >
+          <TextField
+            label={i18next.t("Title")}
+            placeholder={i18next.t("Award 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 URL")}
+            fieldPath="selectedFunding.award.url"
+          />
+        </Overridable>
+      </Form.Group>
+    </Form>
+  );
+}
+
+CustomAwardForm.propTypes = {
+  deserializeFunder: PropTypes.func.isRequired,
+  selectedFunding: PropTypes.object,
+};
+
+CustomAwardForm.defaultProps = {
+  selectedFunding: undefined,
+};
+
+export default CustomAwardForm;

{invenio-vocabularies-3.1.0 → invenio-vocabularies-3.3.0}/invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/src/contrib/forms/Funding/FundingField.js

@@ -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 award")}
+              </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-3.1.0 → invenio-vocabularies-3.3.0}/invenio_vocabularies/ext.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (C) 2020-2022 CERN.
+# Copyright (C) 2023 Graz University of Technology.
 #
 # 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
@@ -123,3 +124,41 @@ class InvenioVocabularies(object):
             service=self.service,
             config=app.config["VOCABULARIES_RESOURCE_CONFIG"],
         )
+
+
+def finalize_app(app):
+    """Finalize app.
+
+    NOTE: replace former @record_once decorator
+    """
+    init(app)
+
+
+def api_finalize_app(app):
+    """Api Finalize app.
+
+    NOTE: replace former @record_once decorator
+    """
+    init(app)
+
+
+def init(app):
+    """Init app."""
+    # Register services - cannot be done in extension because
+    # Invenio-Records-Resources might not have been initialized.
+    sregistry = app.extensions["invenio-records-resources"].registry
+    ext = app.extensions["invenio-vocabularies"]
+    sregistry.register(ext.affiliations_service, service_id="affiliations")
+    sregistry.register(ext.awards_service, service_id="awards")
+    sregistry.register(ext.funders_service, service_id="funders")
+    sregistry.register(ext.names_service, service_id="names")
+    sregistry.register(ext.subjects_service, service_id="subjects")
+    sregistry.register(ext.service, service_id="vocabularies")
+    # Register indexers
+    iregistry = app.extensions["invenio-indexer"].registry
+    iregistry.register(ext.affiliations_service.indexer, indexer_id="affiliations")
+    iregistry.register(ext.awards_service.indexer, indexer_id="awards")
+    iregistry.register(ext.funders_service.indexer, indexer_id="funders")
+    iregistry.register(ext.names_service.indexer, indexer_id="names")
+    iregistry.register(ext.subjects_service.indexer, indexer_id="subjects")
+    iregistry.register(ext.service.indexer, indexer_id="vocabularies")

{invenio-vocabularies-3.1.0 → invenio-vocabularies-3.3.0}/invenio_vocabularies/views.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (C) 2020-2022 CERN.
+# Copyright (C) 2023 Graz University of Technology.
 #
 # 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
@@ -13,30 +14,6 @@ from flask import Blueprint
 blueprint = Blueprint("invenio_vocabularies_ext", __name__)
 
 
-@blueprint.record_once
-def init(state):
-    """Init app."""
-    app = state.app
-    # Register services - cannot be done in extension because
-    # Invenio-Records-Resources might not have been initialized.
-    sregistry = app.extensions["invenio-records-resources"].registry
-    ext = app.extensions["invenio-vocabularies"]
-    sregistry.register(ext.affiliations_service, service_id="affiliations")
-    sregistry.register(ext.awards_service, service_id="awards")
-    sregistry.register(ext.funders_service, service_id="funders")
-    sregistry.register(ext.names_service, service_id="names")
-    sregistry.register(ext.subjects_service, service_id="subjects")
-    sregistry.register(ext.service, service_id="vocabularies")
-    # Register indexers
-    iregistry = app.extensions["invenio-indexer"].registry
-    iregistry.register(ext.affiliations_service.indexer, indexer_id="affiliations")
-    iregistry.register(ext.awards_service.indexer, indexer_id="awards")
-    iregistry.register(ext.funders_service.indexer, indexer_id="funders")
-    iregistry.register(ext.names_service.indexer, indexer_id="names")
-    iregistry.register(ext.subjects_service.indexer, indexer_id="subjects")
-    iregistry.register(ext.service.indexer, indexer_id="vocabularies")
-
-
 def create_blueprint_from_app(app):
     """Create app blueprint."""
     return app.extensions["invenio-vocabularies"].resource.as_blueprint()

{invenio-vocabularies-3.1.0 → invenio-vocabularies-3.3.0}/invenio_vocabularies.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invenio-vocabularies
-Version: 3.1.0
+Version: 3.3.0
 Summary: "Invenio module for managing vocabularies."
 Home-page: https://github.com/inveniosoftware/invenio-vocabularies
 Author: CERN
@@ -50,6 +50,17 @@ Description: ..
         Changes
         =======
         
+        Version 3.3.0 (released 2024-04-16)
+        
+        - assets: add overridable awards and funding
+        
+        Version 3.2.0 (released 2024-03-22)
+        
+        - funding: add country and ror to funder search results
+        - init: move record_once to finalize_app (removes deprecation on `before_first_request`)
+        - installation: upgrade invenio-app
+        
+        
         Version 3.1.0 (released 2024-03-05)
         
         - custom_fields: added subject field

{invenio-vocabularies-3.1.0 → invenio-vocabularies-3.3.0}/invenio_vocabularies.egg-info/entry_points.txt

@@ -16,12 +16,18 @@ invenio_vocabularies_funders = invenio_vocabularies.views:create_funders_bluepri
 invenio_vocabularies_names = invenio_vocabularies.views:create_names_blueprint_from_app
 invenio_vocabularies_subjects = invenio_vocabularies.views:create_subjects_blueprint_from_app
 
+[invenio_base.api_finalize_app]
+invenio_vocabularies = invenio_vocabularies.ext:api_finalize_app
+
 [invenio_base.apps]
 invenio_vocabularies = invenio_vocabularies:InvenioVocabularies
 
 [invenio_base.blueprints]
 invenio_vocabularies_ext = invenio_vocabularies.views:blueprint
 
+[invenio_base.finalize_app]
+invenio_vocabularies = invenio_vocabularies.ext:finalize_app
+
 [invenio_db.alembic]
 invenio_vocabularies = invenio_vocabularies:alembic
 

{invenio-vocabularies-3.1.0 → invenio-vocabularies-3.3.0}/invenio_vocabularies.egg-info/requires.txt

@@ -19,8 +19,8 @@ invenio-search[opensearch2]<3.0.0,>=2.1.0
 [sqlite]
 
 [tests]
-pytest-black>=0.3.0
-invenio-app<2.0.0,>=1.3.3
+pytest-black-ng>=0.4.0
+invenio-app<2.0.0,>=1.4.0
 invenio-db[mysql,postgresql]<2.0.0,>=1.0.14
 pytest-invenio<3.0.0,>=2.1.0
 Sphinx>=4.5

{invenio-vocabularies-3.1.0 → invenio-vocabularies-3.3.0}/setup.cfg

@@ -25,8 +25,8 @@ install_requires =
 
 [options.extras_require]
 tests = 
-	pytest-black>=0.3.0
-	invenio-app>=1.3.3,<2.0.0
+	pytest-black-ng>=0.4.0
+	invenio-app>=1.4.0,<2.0.0
 	invenio-db[postgresql,mysql]>=1.0.14,<2.0.0
 	pytest-invenio>=2.1.0,<3.0.0
 	Sphinx>=4.5
@@ -57,6 +57,10 @@ invenio_base.api_blueprints =
 	invenio_vocabularies_names = invenio_vocabularies.views:create_names_blueprint_from_app
 	invenio_vocabularies_subjects = invenio_vocabularies.views:create_subjects_blueprint_from_app
 	invenio_vocabularies_ext = invenio_vocabularies.views:blueprint
+invenio_base.api_finalize_app = 
+	invenio_vocabularies = invenio_vocabularies.ext:api_finalize_app
+invenio_base.finalize_app = 
+	invenio_vocabularies = invenio_vocabularies.ext:finalize_app
 invenio_db.alembic = 
 	invenio_vocabularies = invenio_vocabularies:alembic
 invenio_db.models = 

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

@@ -1,123 +0,0 @@
-// This file is part of InvenioVocabularies
-// Copyright (C) 2021-2023 CERN.
-// Copyright (C) 2021 Northwestern University.
-//
-// Invenio is free software; you can redistribute it and/or modify it
-// under the terms of the MIT License; see LICENSE file for more details.
-
-import PropTypes from "prop-types";
-import React from "react";
-import { Form, Header } from "semantic-ui-react";
-import { TextField, RemoteSelectField } from "react-invenio-forms";
-import { i18next } from "@translations/invenio_rdm_records/i18next";
-import _isEmpty from "lodash/isEmpty";
-
-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;
-    }
-
-    if (!funderName && !funderPID) {
-      return {};
-    }
-
-    return {
-      text: funderName || funderPID,
-      value: funderItem.id,
-      key: funderItem.id,
-      ...(funderName && { name: funderName }),
-      ...(funderPID && { pid: funderPID }),
-    };
-  }
-
-  function serializeFunderFromDropdown(funderDropObject) {
-    return {
-      id: funderDropObject.key,
-      ...(funderDropObject.name && { name: funderDropObject.name }),
-      ...(funderDropObject.pid && { pid: funderDropObject.pid }),
-    };
-  }
-
-  return (
-    <Form>
-      <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>
-      <Form.Group widths="equal">
-        <TextField
-          label={i18next.t("Number")}
-          placeholder={i18next.t("Award number")}
-          fieldPath="selectedFunding.award.number"
-        />
-        <TextField
-          label={i18next.t("Title")}
-          placeholder={i18next.t("Award Title")}
-          fieldPath="selectedFunding.award.title"
-        />
-        <TextField
-          label={i18next.t("URL")}
-          placeholder={i18next.t("Award URL")}
-          fieldPath="selectedFunding.award.url"
-        />
-      </Form.Group>
-    </Form>
-  );
-}
-
-CustomAwardForm.propTypes = {
-  deserializeFunder: PropTypes.func.isRequired,
-  selectedFunding: PropTypes.object,
-};
-
-CustomAwardForm.defaultProps = {
-  selectedFunding: undefined,
-};
-
-export default CustomAwardForm;