Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow UISerializer to serialize Polygon locations in addition to Points #1924

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+31 −1
Open

Allow UISerializer to serialize Polygon locations in addition to Points #1924

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
895f263
Allow UISerializer to serialize Polygon locations in addition to Points.
spilth Dec 17, 2024
a010b52
Merge branch 'master' into ui-serializer-polygon-support
spilth Jan 7, 2025
c83c51c
Consolidate test cases and fixtures
spilth Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion invenio_rdm_records/resources/serializers/ui/schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,18 @@ def mask_removed_by(obj):
return return_value


def get_coordinates(obj):
"""Coordinates determined by geometry type."""
geometry_type = obj.get("type", None)

if geometry_type == "Point":
return obj.get("coordinates", [])
elif geometry_type == "Polygon":
return obj.get("coordinates", [[[]]])
else:
return None


class RelatedIdentifiersSchema(Schema):
"""Localization of language titles."""

Expand Down Expand Up @@ -168,7 +180,7 @@ class GeometrySchema(Schema):
"""Schema for geometry in the UI."""

type = fields.Str()
coordinates = fields.List(fields.Float())
coordinates = fields.Function(get_coordinates)


class IdentifierSchema(Schema):
Expand Down
253 changes: 249 additions & 4 deletions tests/resources/serializers/test_ui_serializer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def _add_affiliation_name(creatibutors):


@pytest.fixture(scope="function")
def full_to_dict_record(full_record_to_dict):
def full_to_dict_record_point(full_record_to_dict):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a fan of having two versions of this, one with points and one with polygons. I know there are some organizational issues around the test data, so others might have better ideas. But I think including both polygon and point in the full_dict_record, and then checking once that they serialize correctly would be simpler but still have the same effect in validating that polygon is working correctly.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think including both polygon and point in the full_dict_record, and then checking once that they serialize correctly would be simpler but still have the same effect in validating that polygon is working correctly.

Great idea! I will work on that change.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tmorrell I've consolidated the test cases and fixtures.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! I'll plan on merging in the next few days unless there is feedback from others.

"""Full record dereferenced data, as is expected by the UI serializer."""
# TODO: Converge this and full record over time
to_dict_record = deepcopy(full_record_to_dict)
Expand Down Expand Up @@ -109,7 +109,89 @@ def full_to_dict_record(full_record_to_dict):
return to_dict_record


def test_ui_serializer(app, full_to_dict_record):
@pytest.fixture(scope="function")
def full_to_dict_record_polygon(full_record_to_dict):
"""Full record dereferenced data, as is expected by the UI serializer."""
# TODO: Converge this and full record over time
to_dict_record = deepcopy(full_record_to_dict)

to_dict_record["metadata"]["languages"] = [
{"id": "dan", "title": {"en": "Danish"}},
{"id": "eng", "title": {"en": "English"}},
]

to_dict_record["metadata"]["resource_type"] = {
"id": "publication-article",
"title": {"en": "Journal article"},
}

to_dict_record["metadata"]["subjects"] = [
{"id": "A-D000007", "title": {"en": "Abdominal Injuries"}},
{"id": "A-D000008", "title": {"en": "Abdominal Neoplasms"}},
]

to_dict_record["metadata"]["related_identifiers"] = [
{
"identifier": "10.1234/foo.bar",
"resource_type": {"id": "dataset", "title": {"en": "Dataset"}},
"relation_type": {"id": "iscitedby", "title": {"en": "Is cited by"}},
"scheme": "doi",
}
]

to_dict_record["metadata"]["funding"] = [
{
"funder": {
"id": "00k4n6c32",
"name": "EC",
"title": {"en": "European Commission", "fr": "Commission Européenne"},
"country": "BE",
},
"award": {
"id": "00k4n6c32",
"identifiers": [
{
"identifier": "000000012156142X",
"scheme": "isni",
},
{
"identifier": "00k4n6c32",
"scheme": "ror",
},
],
"name": "European Commission",
"title": {
"en": "European Commission",
"fr": "Commission européenne",
},
"country": "BE",
},
}
]

to_dict_record["metadata"]["locations"] = {
"features": [
{
"geometry": {
"type": "Polygon",
"coordinates": [[[0, 0], [1, 0], [1, 1], [0, 1], [0, 0]]],
},
"identifiers": [{"scheme": "geonames", "identifier": "2661235"}],
"place": "CERN",
"description": "Invenio birth place.",
},
]
}

_add_affiliation_name(to_dict_record["metadata"]["creators"])
_add_affiliation_name(to_dict_record["metadata"]["contributors"])

to_dict_record["access"]["status"] = "embargoed"

return to_dict_record


def test_ui_serializer_point(app, full_to_dict_record_point):
expected_data = {
"access_status": {
"description_l10n": "The files will be made publicly available on "
Expand Down Expand Up @@ -260,10 +342,173 @@ def test_ui_serializer(app, full_to_dict_record):
},
}

serialized_record = UIJSONSerializer().dump_obj(full_to_dict_record)
serialized_record = UIJSONSerializer().dump_obj(full_to_dict_record_point)
assert serialized_record["ui"] == expected_data

serialized_records = UIJSONSerializer().serialize_object_list(
{"hits": {"hits": [full_to_dict_record_point]}}
)
assert json.loads(serialized_records)["hits"]["hits"][0]["ui"] == expected_data


def test_ui_serializer_polygon(app, full_to_dict_record_polygon):
expected_data = {
"access_status": {
"description_l10n": "The files will be made publicly available on "
"January 1, 2131.",
"icon": "outline clock",
"id": "embargoed",
"title_l10n": "Embargoed",
"embargo_date_l10n": "January 1, 2131",
"message_class": "warning",
},
"contributors": {
"affiliations": [[1, "CERN", "cern"], [2, "TU Wien", None]],
"contributors": [
{
"affiliations": [[1, "CERN"], [2, "TU Wien"]],
"person_or_org": {
"family_name": "Nielsen",
"given_name": "Lars Holm",
"identifiers": [
{"identifier": "0000-0001-8135-3489", "scheme": "orcid"}
],
"name": "Nielsen, Lars Holm",
"type": "personal",
},
"role": {"id": "other", "title": "other"},
},
{
"person_or_org": {
"family_name": "Dirk",
"given_name": "Dirkin",
"name": "Dirk, Dirkin",
"type": "personal",
},
"role": {"id": "other", "title": "Other"},
},
],
},
"creators": {
"affiliations": [[1, "CERN", "cern"], [2, "free-text", None]],
"creators": [
{
"affiliations": [[1, "CERN"], [2, "free-text"]],
"person_or_org": {
"family_name": "Nielsen",
"given_name": "Lars Holm",
"identifiers": [
{"identifier": "0000-0001-8135-3489", "scheme": "orcid"}
],
"name": "Nielsen, Lars Holm",
"type": "personal",
},
},
{
"person_or_org": {
"family_name": "Tom",
"given_name": "Blabin",
"name": "Tom, Blabin",
"type": "personal",
}
},
],
},
"publication_date_l10n_long": "January 2018\u2009–\u2009September 2020",
"publication_date_l10n_medium": "Jan 2018\u2009–\u2009Sep 2020",
"resource_type": {"id": "publication-article", "title_l10n": "Journal article"},
"additional_titles": [
{
"lang": {"id": "eng", "title_l10n": "English"},
"title": "a research data management platform",
"type": {"id": "subtitle", "title_l10n": "Subtitle"},
}
],
"additional_descriptions": [
{
"description": "Bla bla bla",
"lang": {"id": "eng", "title_l10n": "English"},
"type": {"id": "methods", "title_l10n": "Methods"},
}
],
"is_draft": False,
"languages": [
{"id": "dan", "title_l10n": "Danish"},
{"id": "eng", "title_l10n": "English"},
],
"dates": [
{
"date": "1939/1945",
"description": "A date",
"type": {"id": "other", "title_l10n": "Other"},
}
],
"rights": [
{
"description_l10n": "A description",
"link": "https://customlicense.org/licenses/by/4.0/",
"title_l10n": "A custom license",
},
{
"description_l10n": "The Creative Commons Attribution license allows re-distribution and re-use of a licensed work on the condition that the creator is appropriately credited.",
"id": "cc-by-4.0",
"props": {
"scheme": "spdx",
"url": "https://creativecommons.org/licenses/by/4.0/legalcode",
},
"title_l10n": "Creative Commons Attribution 4.0 International",
},
],
"related_identifiers": [
{
"identifier": "10.1234/foo.bar",
"relation_type": {"id": "iscitedby", "title_l10n": "Is cited by"},
"resource_type": {"id": "dataset", "title_l10n": "Dataset"},
"scheme": "doi",
}
],
"custom_fields": {},
"description_stripped": "A description \nwith HTML tags",
"version": "v1.0",
"created_date_l10n_long": "November 14, 2023",
"updated_date_l10n_long": "November 14, 2023",
"funding": [
{
"award": {
"id": "00k4n6c32",
"identifiers": [
{"identifier": "000000012156142X", "scheme": "isni"},
{"identifier": "00k4n6c32", "scheme": "ror"},
],
"title_l10n": "European Commission",
},
"funder": {
"country": "BE",
"id": "00k4n6c32",
"name": "EC",
"title_l10n": "European Commission",
},
}
],
"locations": {
"features": [
{
"geometry": {
"type": "Polygon",
"coordinates": [[[0, 0], [1, 0], [1, 1], [0, 1], [0, 0]]],
},
"identifiers": [{"scheme": "geonames", "identifier": "2661235"}],
"place": "CERN",
"description": "Invenio birth place.",
},
]
},
}

serialized_record = UIJSONSerializer().dump_obj(full_to_dict_record_polygon)
assert serialized_record["ui"] == expected_data

serialized_records = UIJSONSerializer().serialize_object_list(
{"hits": {"hits": [full_to_dict_record]}}
{"hits": {"hits": [full_to_dict_record_polygon]}}
)
assert json.loads(serialized_records)["hits"]["hits"][0]["ui"] == expected_data