invenio-vocabularies 1.2.0__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-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
@@ -10,6 +10,6 @@
 
 from .ext import InvenioVocabularies
 
-__version__ = "1.2.0"
+__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/alembic/4a9a4fd235f8_create_vocabulary_schemes.py

@@ -20,10 +20,10 @@ def upgrade():
     """Upgrade database."""
     op.create_table(
         "vocabularies_schemes",
-        sa.Column("id", sa.String(), nullable=False),
-        sa.Column("parent_id", sa.String(), nullable=False),
-        sa.Column("name", sa.String(), nullable=True),
-        sa.Column("uri", sa.String(), nullable=True),
+        sa.Column("id", sa.String(255), nullable=False),
+        sa.Column("parent_id", sa.String(255), nullable=False),
+        sa.Column("name", sa.String(255), nullable=True),
+        sa.Column("uri", sa.String(255), nullable=True),
         sa.PrimaryKeyConstraint(
             "id", "parent_id", name=op.f("pk_vocabularies_schemes")
         ),

invenio_vocabularies/alembic/4f365fced43f_create_vocabularies_tables.py

@@ -78,8 +78,8 @@ def upgrade():
     )
     op.create_table(
         "vocabularies_types",
-        sa.Column("id", sa.String(), nullable=False),
-        sa.Column("pid_type", sa.String(), nullable=True),
+        sa.Column("id", sa.String(255), nullable=False),
+        sa.Column("pid_type", sa.String(255), nullable=True),
         sa.PrimaryKeyConstraint("id", name=op.f("pk_vocabularies_types")),
         sa.UniqueConstraint("pid_type", name=op.f("uq_vocabularies_types_pid_type")),
     )

invenio_vocabularies/alembic/55a700f897b6_add_names_and_afiliations_pid_column.py

@@ -0,0 +1,96 @@
+#
+# This file is part of Invenio.
+# Copyright (C) 2023 CERN.
+#
+# 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.
+
+"""Add "pid" column to names and affiliations tables."""
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "55a700f897b6"
+down_revision = "e1146238edd3"
+branch_labels = ()
+depends_on = "999c62899c20"
+
+
+pids_table = sa.sql.table(
+    "pidstore_pid",
+    sa.sql.column("pid_type"),
+    sa.sql.column("pid_value"),
+    sa.sql.column("object_uuid"),
+    sa.sql.column("object_type"),
+)
+names_table = sa.sql.table(
+    "name_metadata",
+    sa.sql.column("id"),
+    sa.sql.column("pid"),
+)
+affiliations_table = sa.sql.table(
+    "affiliation_metadata",
+    sa.sql.column("id"),
+    sa.sql.column("pid"),
+)
+
+
+def upgrade():
+    """Upgrade database."""
+    op.add_column(
+        "name_metadata",
+        sa.Column("pid", sa.String(255), nullable=True),
+    )
+    # populate from PIDStore
+    op.execute(
+        names_table.update()
+        .where(
+            names_table.c.id == pids_table.c.object_uuid,
+            pids_table.c.object_type == "rec",
+            pids_table.c.pid_type == "names",
+        )
+        .values(pid=pids_table.c.pid_value)
+    )
+    op.create_unique_constraint(
+        op.f("uq_name_metadata_pid"),
+        "name_metadata",
+        ["pid"],
+    )
+
+    op.add_column(
+        "affiliation_metadata",
+        sa.Column("pid", sa.String(255), nullable=True),
+    )
+    # populate from PIDStore
+    op.execute(
+        affiliations_table.update()
+        .where(
+            affiliations_table.c.id == pids_table.c.object_uuid,
+            pids_table.c.object_type == "rec",
+            pids_table.c.pid_type == "aff",
+        )
+        .values(pid=pids_table.c.pid_value)
+    )
+
+    op.create_unique_constraint(
+        op.f("uq_affiliation_metadata_pid"),
+        "affiliation_metadata",
+        ["pid"],
+    )
+
+
+def downgrade():
+    """Downgrade database."""
+    op.drop_constraint(
+        op.f("uq_name_metadata_pid"),
+        "name_metadata",
+        type_="unique",
+    )
+    op.drop_constraint(
+        op.f("uq_affiliation_metadata_pid"),
+        "affiliation_metadata",
+        type_="unique",
+    )
+    op.drop_column("name_metadata", "pid")
+    op.drop_column("affiliation_metadata", "pid")

invenio_vocabularies/alembic/676dd587542d_create_funders_vocabulary_table.py

@@ -45,7 +45,7 @@ def upgrade():
             nullable=True,
         ),
         sa.Column("version_id", sa.Integer(), nullable=False),
-        sa.Column("pid", sa.String(), nullable=True),
+        sa.Column("pid", sa.String(255), nullable=True),
         sa.PrimaryKeyConstraint("id", name=op.f("pk_funder_metadata")),
         sa.UniqueConstraint("pid", name=op.f("uq_funder_metadata_pid")),
     )

invenio_vocabularies/alembic/e1146238edd3_create_awards_table.py

@@ -45,7 +45,7 @@ def upgrade():
             nullable=True,
         ),
         sa.Column("version_id", sa.Integer(), nullable=False),
-        sa.Column("pid", sa.String(), nullable=True),
+        sa.Column("pid", sa.String(255), nullable=True),
         sa.PrimaryKeyConstraint("id", name=op.f("pk_award_metadata")),
         sa.UniqueConstraint("pid", name=op.f("uq_award_metadata_pid")),
     )

invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/.eslintrc.yml

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio.
+# Copyright (C) 2023 CERN.
+#
+# 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.
+
+extends:
+  - '@inveniosoftware/eslint-config-invenio'
+  - '@inveniosoftware/eslint-config-invenio/prettier'

invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/.prettierrc

@@ -0,0 +1 @@
+"@inveniosoftware/eslint-config-invenio/prettier-config.js"

invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/index.js

@@ -0,0 +1,7 @@
+// This file is part of InvenioVocabularies
+// Copyright (C) 2023 CERN.
+//
+// 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.
+
+export * from "./src";

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

@@ -0,0 +1,25 @@
+{
+  "@comment": [
+    "This package.json is needed to run the JS tests, locally and CI."
+  ],
+  "scripts": {
+    "test": "react-scripts test"
+  },
+  "devDependencies": {
+    "@testing-library/jest-dom": "^4.2.0",
+    "@testing-library/react": "^9.5.0",
+    "@testing-library/user-event": "^7.2.0",
+    "axios": "^1.7.7",
+    "coveralls": "^3.0.0",
+    "enzyme": "^3.10.0",
+    "enzyme-adapter-react-16": "^1.15.0",
+    "expect": "^26.0.0",
+    "lodash": "^4.17.0",
+    "luxon": "^1.23.0",
+    "react": "^16.13.0",
+    "react-dom": "^16.13.0",
+    "react-scripts": "^5.0.1",
+    "semantic-ui-react": "^2.1.0",
+    "react-overridable": "^0.0.3"
+  }
+}

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

@@ -0,0 +1,95 @@
+// 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 React from "react";
+import PropTypes from "prop-types";
+import _get from "lodash/get";
+import { Item, Header, Radio, Label, Icon } from "semantic-ui-react";
+import { withState } from "react-searchkit";
+import { FastField } from "formik";
+
+export const AwardResults = withState(
+  ({
+    currentResultsState: results,
+    deserializeAward,
+    deserializeFunder,
+    computeFundingContents,
+  }) => {
+    return (
+      <FastField name="selectedFunding">
+        {({ form: { values, setFieldValue } }) => {
+          return (
+            <Item.Group>
+              {results.data.hits.map((award) => {
+                let funder = award?.funder;
+                const deserializedAward = deserializeAward(award);
+                const deserializedFunder = deserializeFunder(funder);
+                const funding = {
+                  award: deserializedAward,
+                  funder: deserializedFunder,
+                };
+                let { headerContent, descriptionContent, awardOrFunder } =
+                  computeFundingContents(funding);
+
+                return (
+                  <Item
+                    key={deserializedAward.id}
+                    onClick={() => setFieldValue("selectedFunding", funding)}
+                    className="license-item"
+                  >
+                    <Radio
+                      checked={
+                        _get(values, "selectedFunding.award.id") === funding.award.id
+                      }
+                      onChange={() => setFieldValue("selectedFunding", funding)}
+                    />
+                    <Item.Content className="license-item-content">
+                      <Header size="small">
+                        {headerContent}
+                        {awardOrFunder === "award"
+                          ? award.number && (
+                              <Label basic size="mini">
+                                {award.number}
+                              </Label>
+                            )
+                          : ""}
+                        {awardOrFunder === "award"
+                          ? award.url && (
+                              <a
+                                href={`${award.url}`}
+                                target="_blank"
+                                rel="noopener noreferrer"
+                              >
+                                <Icon
+                                  link
+                                  name="external alternate"
+                                  className="spaced-left"
+                                />
+                              </a>
+                            )
+                          : ""}
+                      </Header>
+                      <Item.Description className="license-item-description">
+                        {descriptionContent}
+                      </Item.Description>
+                    </Item.Content>
+                  </Item>
+                );
+              })}
+            </Item.Group>
+          );
+        }}
+      </FastField>
+    );
+  }
+);
+
+AwardResults.propTypes = {
+  deserializeAward: PropTypes.func.isRequired,
+  deserializeFunder: PropTypes.func.isRequired,
+  computeFundingContents: PropTypes.func.isRequired,
+};

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

@@ -0,0 +1,139 @@
+// This file is part of InvenioVocabularies
+// Copyright (C) 2021-2024 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) {
+    const funderName = funderItem?.name;
+    const funderPID = funderItem?.id;
+    const funderCountry = funderItem?.country_name ?? 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("Additional 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/Grant 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/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>
+  );
+}
+
+CustomAwardForm.propTypes = {
+  deserializeFunder: PropTypes.func.isRequired,
+  selectedFunding: PropTypes.object,
+};
+
+CustomAwardForm.defaultProps = {
+  selectedFunding: undefined,
+};
+
+export default CustomAwardForm;

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

@@ -0,0 +1,87 @@
+// 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 React from "react";
+
+import { Dropdown } from "semantic-ui-react";
+import { withState } from "react-searchkit";
+import { i18next } from "@translations/invenio_rdm_records/i18next";
+
+export const FunderDropdown = withState(
+  ({ currentResultsState: awardsList, updateQueryState, currentQueryState }) => {
+    const [fundersFromFacets] = useFundersFromFacets(awardsList);
+
+    /**
+     * Trigger on funder selection.
+     * Updated the query state to filter by the selected funder.
+     *
+     * @param {*} event
+     * @param {*} data
+     */
+    function onFunderSelect(event, data) {
+      let newFilter = [];
+
+      if (data && data.value !== "") {
+        newFilter = ["funders", data.value];
+      }
+      updateQueryState({ ...currentQueryState, filters: newFilter, page: 1 });
+    }
+
+    /**
+     * Custom hook, triggered when the awards list changes.
+     * It retrieves funders from new award's facets.
+     *
+     * @param {object} awards
+     *
+     * @returns {object[]} an array of objects, each representing a facetted funder.
+     */
+    function useFundersFromFacets(awards) {
+      const [result, setResult] = React.useState([]);
+      React.useEffect(() => {
+        /**
+         * Retrieves funders from awards facets and sets the result in state 'result'.
+         */
+        function getFundersFromAwardsFacet() {
+          if (awards.loading) {
+            setResult([]);
+            return;
+          }
+
+          const funders = awards.data.aggregations?.funders?.buckets.map((agg) => {
+            return {
+              key: agg.key,
+              value: agg.key,
+              text: agg.label,
+            };
+          });
+          setResult(funders);
+        }
+
+        getFundersFromAwardsFacet();
+      }, [awards]);
+
+      return [result];
+    }
+
+    return (
+      <Dropdown
+        placeholder={i18next.t("Funder")}
+        search
+        selection
+        clearable
+        scrolling
+        multiple={false}
+        options={fundersFromFacets || []}
+        allowAdditions={false}
+        onChange={onFunderSelect}
+        fluid
+        selectOnBlur={false}
+        selectOnNavigation={false}
+      />
+    );
+  }
+);