99f11e46-43d8-4a7d-85f2-c73f2e53acf7

Committed 28 Mar 2024 02:08PM UTC coverage: 67.169% (-0.1%) from 67.282%

Build # 99f11e46-43d8-4a7d-85f2-c73f2e53acf7

Build Type

Pull #2269

circleci

Committed by

symroe

Commit Message

Refactor review-required page to use BallotSOPN

Pull Request Pull Request #2269: Redesign SOPN models

Run Details

1712 of 2908 branches covered (58.87%)

Branch coverage included in aggregate %.

215 of 236 new or added lines in 17 files covered. (91.1%)

50 existing lines in 9 files now uncovered.

6895 of 9906 relevant lines covered (69.6%)

0.7 hits per line

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

90.2

/ynr/apps/bulk_adding/models.py

from django.conf import settings
from django.db import models
from django.db.models import JSONField
from model_utils.models import TimeStampedModel

TRUSTED_TO_BULK_ADD_GROUP_NAME = "Trusted to bulk add"


class RawPeople(TimeStampedModel):
    """
    Store a JSON representation of a ballot.

    Used as a form of cache for populating the form that adds or de-duplicates
    candidates.

    These models can be created in a few ways:

    1. People typing in information from a PDF
    2. A CSV that is given to us by a council

    In other words, some source where a human has asserted that the ballot
    contains these nominations.

    `data` is a JSON encoded list of dicts, where each item dict contains `name`
    `party_id` and optional `description_id` keys.

    The life time of this model is from the point of input to the point where
    the import is validated and each item in the list is turned in to a
    candidacy.

    """

    SOURCE_COUNCIL_CSV = "council_csv"
    SOURCE_BULK_ADD_FORM = "bulk_add_form"
    SOURCE_PARSED_PDF = "parsed_pdf"

    SOURCE_TYPES = (
        (SOURCE_BULK_ADD_FORM, "Bulk Add form"),
        (SOURCE_COUNCIL_CSV, "Council CSV"),
        (SOURCE_PARSED_PDF, "Parsed from a PDF"),
    )

    # Sources that we trust enough to just review, not ask a user
    # to edit (edit option always there)
    TRUSTED_SOURCES = (SOURCE_COUNCIL_CSV, SOURCE_BULK_ADD_FORM)

    ballot = models.OneToOneField("candidates.Ballot", on_delete=models.CASCADE)
    data = JSONField(default=dict)
    textract_data = JSONField(default=dict)
    source = models.CharField(max_length=512)
    source_type = models.CharField(
        choices=SOURCE_TYPES, default=SOURCE_BULK_ADD_FORM, max_length=255
    )

    def __str__(self):
        return "{} ({})".format(self.ballot.ballot_paper_id, self.source)

    def as_form_kwargs(self, parser=settings.DEFAULT_PARSING_BACKEND):
        """
        Returns a list of dicts designed for populating the BulkAddFormSet's
        initial values

        """
        data_attr = self.textract_data
        if (
            parser != settings.SOPN_PARSING_BACKENDS.TEXTRACT
            or self.source_type != self.SOURCE_PARSED_PDF
        ):
            data_attr = self.data

        if not data_attr:
            if parser == settings.SOPN_PARSING_BACKENDS.TEXTRACT and self.data:
                data_attr = self.data
            else:
                return {}
        initial = []

        for candidacy in data_attr:
            party_id = candidacy["party_id"]
            description_id = candidacy.get("description_id")
            if description_id:
                party_id = f"{party_id}__{description_id}"

            initial.append(
                {
                    "name": candidacy["name"],
                    "party": [party_id, party_id],
                    "source": self.source,
                    "previous_party_affiliations": candidacy.get(
                        "previous_party_affiliations", []
                    ),
                }
            )
        return {"initial": initial}

    @property
    def is_trusted(self):
        return self.source_type in self.TRUSTED_SOURCES

    @property
    def is_parsed_from_pdf(self):
        return self.source_type == self.SOURCE_PARSED_PDF

1	from django.conf import settings	1✔
2	from django.db import models	1✔
3	from django.db.models import JSONField	1✔
4	from model_utils.models import TimeStampedModel	1✔
5
6	TRUSTED_TO_BULK_ADD_GROUP_NAME = "Trusted to bulk add"	1✔
7
8
9	class RawPeople(TimeStampedModel):	1✔
10	"""
11	Store a JSON representation of a ballot.
12
13	Used as a form of cache for populating the form that adds or de-duplicates
14	candidates.
15
16	These models can be created in a few ways:
17
18	1. People typing in information from a PDF
19	2. A CSV that is given to us by a council
20
21	In other words, some source where a human has asserted that the ballot
22	contains these nominations.
23
24	`data` is a JSON encoded list of dicts, where each item dict contains `name`
25	`party_id` and optional `description_id` keys.
26
27	The life time of this model is from the point of input to the point where
28	the import is validated and each item in the list is turned in to a
29	candidacy.
30
31	"""
32
33	SOURCE_COUNCIL_CSV = "council_csv"	1✔
34	SOURCE_BULK_ADD_FORM = "bulk_add_form"	1✔
35	SOURCE_PARSED_PDF = "parsed_pdf"	1✔
36
37	SOURCE_TYPES = (	1✔
38	(SOURCE_BULK_ADD_FORM, "Bulk Add form"),
39	(SOURCE_COUNCIL_CSV, "Council CSV"),
40	(SOURCE_PARSED_PDF, "Parsed from a PDF"),
41	)
42
43	# Sources that we trust enough to just review, not ask a user
44	# to edit (edit option always there)
45	TRUSTED_SOURCES = (SOURCE_COUNCIL_CSV, SOURCE_BULK_ADD_FORM)	1✔
46
47	ballot = models.OneToOneField("candidates.Ballot", on_delete=models.CASCADE)	1✔
48	data = JSONField(default=dict)	1✔
49	textract_data = JSONField(default=dict)	1✔
50	source = models.CharField(max_length=512)	1✔
51	source_type = models.CharField(	1✔
52	choices=SOURCE_TYPES, default=SOURCE_BULK_ADD_FORM, max_length=255
53	)
54
55	def __str__(self):	1✔
UNCOV 56	return "{} ({})".format(self.ballot.ballot_paper_id, self.source)	×
57
58	def as_form_kwargs(self, parser=settings.DEFAULT_PARSING_BACKEND):	1✔
59	"""
60	Returns a list of dicts designed for populating the BulkAddFormSet's
61	initial values
62
63	"""
64	data_attr = self.textract_data	1✔
65	if (	1✔
66	parser != settings.SOPN_PARSING_BACKENDS.TEXTRACT
67	or self.source_type != self.SOURCE_PARSED_PDF
68	):
69	data_attr = self.data	1✔
70
71	if not data_attr:	1✔
72	if parser == settings.SOPN_PARSING_BACKENDS.TEXTRACT and self.data:	1!
73	data_attr = self.data	1✔
74	else:
NEW 75	return {}	×
76	initial = []	1✔
77
78	for candidacy in data_attr:	1✔
79	party_id = candidacy["party_id"]	1✔
80	description_id = candidacy.get("description_id")	1✔
81	if description_id:	1!
UNCOV 82	party_id = f"{party_id}__{description_id}"	×
83
84	initial.append(	1✔
85	{
86	"name": candidacy["name"],
87	"party": [party_id, party_id],
88	"source": self.source,
89	"previous_party_affiliations": candidacy.get(
90	"previous_party_affiliations", []
91	),
92	}
93	)
94	return {"initial": initial}	1✔
95
96	@property	1✔
97	def is_trusted(self):	1✔
98	return self.source_type in self.TRUSTED_SOURCES	1✔
99
100	@property	1✔
101	def is_parsed_from_pdf(self):	1✔
102	return self.source_type == self.SOURCE_PARSED_PDF	1✔

DemocracyClub / yournextrepresentative / 99f11e46-43d8-4a7d-85f2-c73f2e53acf7

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