inveniosoftware / invenio-rdm-records / 592

pending completion

Build # 592

Build Type

Pull #228

travis-ci

Committed by

web-flow

Commit Message

<a href="https://github.com/inveniosoftware/invenio-rdm-records/commit/<a class=hub.com/inveniosoftware/invenio-rdm-records/commit/<a class="double-link" href="https://git"><a class=hub.com/inveniosoftware/invenio-rdm-records/commit/<a class="double-link" href="https://git"><a class=hub.com/inveniosoftware/invenio-rdm-records/commit/42476d6ffdd8e2401b2de8500dea8f584c123651">42476d6ff">&lt;a href=&quot;https://github.com/inveniosoftware/invenio-rdm-records/commit/</a><a class="double-link" href="https://github.com/inveniosoftware/invenio-rdm-records/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/inveniosoftware/invenio-rdm-records/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/inveniosoftware/invenio-rdm-records/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/inveniosoftware/invenio-rdm-records/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/inveniosoftware/invenio-rdm-records/commit/42476d6ffdd8e2401b2de8500dea8f584c123651">42476d6ff</a><a href="https://github.com/inveniosoftware/invenio-rdm-records/commit/42476d6ffdd8e2401b2de8500dea8f584c123651">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/inveniosoftware/invenio-rdm-records/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/inveniosoftware/invenio-rdm-records/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/inveniosoftware/invenio-rdm-records/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/inveniosoftware/invenio-rdm-records/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/inveniosoftware/invenio-rdm-records/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/inveniosoftware/invenio-rdm-records/commit/42476d6ffdd8e2401b2de8500dea8f584c123651&quot;&gt;42476d6ff&lt;/a&gt;&lt;a href=&quot;https://github.com/inveniosoftware/invenio-rdm-records/commit/42476d6ffdd8e2... (continued)

Pull Request Pull Request #228: serializers: adds icons to the access_right ui config

Run Details

20 of 20 new or added lines in 1 file covered. (100.0%)

773 of 886 relevant lines covered (87.25%)

15.66 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

97.83

/invenio_rdm_records/resources/serializers.py

# -*- coding: utf-8 -*-
#
# Copyright (C) 2020 CERN.
# Copyright (C) 2020 Northwestern University.
#
# 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.

"""Record response serializers."""

import json

from flask_resources.serializers import JSONSerializer

from invenio_rdm_records.vocabularies import Vocabularies


class UIJSONSerializer(JSONSerializer):
    """UI JSON serializer implementation."""

    def _serialize_access_right(self, obj):
        """Inject ui config for `access_right` field."""
        access_right_vocabulary = self._serialize_ui_options_from_vocabulary(
            "access_right")
        category_value = obj["access"]["access_right"]
        return dict(
            access_right=dict(
                category=category_value,
                icon=access_right_vocabulary[category_value]['icon']
            ))

    def _serialize_ui_options_from_vocabulary(
            self, vocabulary_name):
        """Creates a flattened dictionary with the vocabulary data.

        :params vocabulary_name: name of the vocabulary to be used
        """
        flattened_vocabulary = {}
        vocabulary = Vocabularies.get_vocabulary(
            vocabulary_name).dump_options()
        if type(vocabulary) is dict:
            flattened_vocabulary = {}
            for key in vocabulary.keys():
                for option in vocabulary[key]:
                    flattened_vocabulary[option['value']] = option

        else:
            for option in vocabulary:
                flattened_vocabulary[option['value']] = option
        return flattened_vocabulary

    def _add_bucket_labels(self, agg_obj, vocabulary):
        """Inject labels in the aggregation buckets.

        :params agg_obj: Current aggregation object.
        :params vocabulary: Dict with vocabulary data.
        """
        buckets = agg_obj['buckets']
        for bucket in buckets:
            bucket['label'] = str(vocabulary.get(bucket['key'])['text'])
            for key in bucket:
                if isinstance(bucket[key], dict) and 'buckets' in bucket[key]:
                    sub_bucket = bucket[key]
                    self._add_bucket_labels(sub_bucket, vocabulary)

    def _serialize_aggregations(self, obj_list):
        """Inject ui config in aggregations."""
        aggregations = obj_list.get("aggregations")
        if aggregations:
            for aggregation_key in aggregations:
                agg_vocabulary = self._serialize_ui_options_from_vocabulary(
                    aggregation_key)
                if not agg_vocabulary:
                    continue
                self._add_bucket_labels(
                    aggregations[aggregation_key], agg_vocabulary)

    def serialize_obj_ui(self, obj):
        """Dump ui config for object."""
        obj.setdefault('ui', {}).update(self._serialize_access_right(obj))

    def serialize_object(self, obj, response_ctx=None, *args, **kwargs):
        """Dump the object into a json string."""
        self.serialize_obj_ui(obj)
        return json.dumps(obj)

    def serialize_object_list(
            self, obj_list, response_ctx=None, *args, **kwargs):
        """Dump the object list into a json string."""
        self._serialize_aggregations(obj_list)
        for obj in obj_list["hits"]["hits"]:
            self.serialize_obj_ui(obj)
        return json.dumps(obj_list)

1	# -- coding: utf-8 --
2	#
3	# Copyright (C) 2020 CERN.
4	# Copyright (C) 2020 Northwestern University.
5	#
6	# Invenio-RDM-Records is free software; you can redistribute it and/or modify
7	# it under the terms of the MIT License; see LICENSE file for more details.
8
9	"""Record response serializers."""	18✔
10
11	import json	18✔
12
13	from flask_resources.serializers import JSONSerializer	18✔
14
15	from invenio_rdm_records.vocabularies import Vocabularies	18✔
16
17
18	class UIJSONSerializer(JSONSerializer):	18✔
19	"""UI JSON serializer implementation."""
20
21	def _serialize_access_right(self, obj):	18✔
22	"""Inject ui config for `access_right` field."""
23	access_right_vocabulary = self._serialize_ui_options_from_vocabulary(	18✔
24	"access_right")
25	category_value = obj["access"]["access_right"]	18✔
26	return dict(	18✔
27	access_right=dict(
28	category=category_value,
29	icon=access_right_vocabulary[category_value]['icon']
30	))
31
32	def _serialize_ui_options_from_vocabulary(	18✔
33	self, vocabulary_name):
34	"""Creates a flattened dictionary with the vocabulary data.
35
36	:params vocabulary_name: name of the vocabulary to be used
37	"""
38	flattened_vocabulary = {}	18✔
39	vocabulary = Vocabularies.get_vocabulary(	18✔
40	vocabulary_name).dump_options()
41	if type(vocabulary) is dict:	18✔
42	flattened_vocabulary = {}	18✔
43	for key in vocabulary.keys():	18✔
44	for option in vocabulary[key]:	18✔
45	flattened_vocabulary[option['value']] = option	18✔
46
47	else:
48	for option in vocabulary:	18✔
49	flattened_vocabulary[option['value']] = option	18✔
50	return flattened_vocabulary	18✔
51
52	def _add_bucket_labels(self, agg_obj, vocabulary):	18✔
53	"""Inject labels in the aggregation buckets.
54
55	:params agg_obj: Current aggregation object.
56	:params vocabulary: Dict with vocabulary data.
57	"""
58	buckets = agg_obj['buckets']	18✔
59	for bucket in buckets:	18✔
60	bucket['label'] = str(vocabulary.get(bucket['key'])['text'])	18✔
61	for key in bucket:	18✔
62	if isinstance(bucket[key], dict) and 'buckets' in bucket[key]:	18✔
63	sub_bucket = bucket[key]	18✔
64	self._add_bucket_labels(sub_bucket, vocabulary)	18✔
65
66	def _serialize_aggregations(self, obj_list):	18✔
67	"""Inject ui config in aggregations."""
68	aggregations = obj_list.get("aggregations")	18✔
69	if aggregations:	18✔
70	for aggregation_key in aggregations:	18✔
71	agg_vocabulary = self._serialize_ui_options_from_vocabulary(	18✔
72	aggregation_key)
73	if not agg_vocabulary:	18✔
74	continue	×
75	self._add_bucket_labels(	18✔
76	aggregations[aggregation_key], agg_vocabulary)
77
78	def serialize_obj_ui(self, obj):	18✔
79	"""Dump ui config for object."""
80	obj.setdefault('ui', {}).update(self._serialize_access_right(obj))	18✔
81
82	def serialize_object(self, obj, response_ctx=None, args, *kwargs):	18✔
83	"""Dump the object into a json string."""
84	self.serialize_obj_ui(obj)	18✔
85	return json.dumps(obj)	18✔
86
87	def serialize_object_list(	18✔
88	self, obj_list, response_ctx=None, args, *kwargs):
89	"""Dump the object list into a json string."""
90	self._serialize_aggregations(obj_list)	18✔
91	for obj in obj_list["hits"]["hits"]:	18✔
92	self.serialize_obj_ui(obj)	18✔
93	return json.dumps(obj_list)	18✔

inveniosoftware / invenio-rdm-records / 592

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous