a11757ca-33f7-44a2-a500-a7b58b9d99e5

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

Build # a11757ca-33f7-44a2-a500-a7b58b9d99e5

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 %.

190 of 206 new or added lines in 16 files covered. (92.23%)

27 existing lines in 5 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

70.93

/ynr/apps/official_documents/models.py

import os
from pathlib import Path

from django.core.validators import FileExtensionValidator
from django.db import models
from django.urls import reverse
from django.utils import timezone
from django_extensions.db.models import TimeStampedModel
from sopn_parsing.models import AWSTextractParsedSOPN

DOCUMENT_UPLOADERS_GROUP_NAME = "Document Uploaders"


def document_file_name(instance, filename):
    return os.path.join(
        "official_documents", str(instance.ballot.ballot_paper_id), filename
    )


class OfficialDocument(TimeStampedModel):
    NOMINATION_PAPER = "Nomination paper"

    DOCUMENT_TYPES = (
        (NOMINATION_PAPER, "Nomination paper", "Nomination papers"),
    )

    document_type = models.CharField(
        blank=False,
        choices=[(d[0], d[1]) for d in DOCUMENT_TYPES],
        max_length=100,
    )
    uploaded_file = models.FileField(
        upload_to=document_file_name,
        max_length=800,
        validators=[FileExtensionValidator(allowed_extensions=["pdf", "docx"])],
    )
    ballot = models.ForeignKey(
        "candidates.Ballot", null=False, on_delete=models.CASCADE
    )
    source_url = models.URLField(
        help_text="The URL of this document", max_length=1000
    )
    relevant_pages = models.CharField(
        "The pages containing information about this ballot",
        max_length=50,
        default="",
    )

    class Meta:
        get_latest_by = "modified"

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

    def get_absolute_url(self):
        return reverse(
            "ballot_paper_sopn",
            kwargs={"ballot_id": self.ballot.ballot_paper_id},
        )

    @property
    def locked(self):
        """
        Is this post election locked?
        """
        return self.ballot.candidates_locked

    @property
    def lock_suggested(self):
        """
        Is there a suggested lock for this document?
        """
        return self.ballot.suggestedpostlock_set.exists()

    def get_pages(self):
        if self.relevant_pages and self.relevant_pages != "all":
            pages = self.relevant_pages.split(",")
            return sorted(int(p) for p in pages)
        return None

    @property
    def get_aws_parsed_sopn(self):
        """given an instance of an official document, return the associated aws parsed sopn"""
        return AWSTextractParsedSOPN.objects.get(sopn=self)

    @property
    def first_page_number(self):
        if self.get_pages():
            return self.get_pages()[0]
        return None

    @property
    def last_page_number(self):
        if self.get_pages():
            return self.get_pages()[-1]
        return None


def election_sopn_file_name(instance: "ElectionSOPN", filename):
    return (
        Path("official_documents")
        / instance.election.slug
        / timezone.now().isoformat()
        / filename
    )


class ElectionSOPN(TimeStampedModel):
    """
    Stores SOPNs that contain candidate information for each ballot in an election.

    We don't use this directly, rather we use this as a donor document for populating BallotSOPN instances.

    """

    election = models.OneToOneField(
        "elections.Election", on_delete=models.CASCADE, blank=True
    )

    uploaded_file = models.FileField(
        upload_to=election_sopn_file_name,
        max_length=1200,
        validators=[FileExtensionValidator(allowed_extensions=["pdf"])],
    )

    source_url = models.URLField(
        help_text="The URL of this document", max_length=1200
    )

    class Meta:
        get_latest_by = "modified"

    def __str__(self):
        return "{} ({})".format(self.election.slug, self.source_url)


def ballot_sopn_file_name(instance: "BaseBallotSOPN", filename):
    return (
        Path("official_documents")
        / instance.ballot.ballot_paper_id
        / "sopn"
        / timezone.now().isoformat()
        / filename
    )


class BaseBallotSOPN(TimeStampedModel):
    """
    An abstract class used by BallotSOPN and BallotSOPNHistory. Used to keep both models in sync.

    """

    ballot = models.OneToOneField(
        "candidates.Ballot", on_delete=models.CASCADE, related_name="sopn"
    )

    # Don't add `ballot` here as we want different related names for each model
    uploaded_file = models.FileField(
        upload_to=ballot_sopn_file_name,
        max_length=1200,
        validators=[FileExtensionValidator(allowed_extensions=["pdf"])],
    )

    source_url = models.URLField(
        help_text="The URL of this document", max_length=1200
    )

    relevant_pages = models.CharField(
        max_length=20,
        help_text="The pages in the ElectionSOPN that relate to this Ballot",
        default="all",
    )

    class Meta:
        get_latest_by = "modified"
        abstract = True

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


class BallotSOPN(BaseBallotSOPN):
    ...

    def get_absolute_url(self):
        return reverse(
            "ballot_paper_sopn",
            kwargs={"ballot_id": self.ballot.ballot_paper_id},
        )


class BallotSOPNHistory(BaseBallotSOPN):
    ballot = models.ForeignKey(
        "candidates.Ballot",
        on_delete=models.CASCADE,
        related_name="sopn_history",
    )

1	import os	1✔
2	from pathlib import Path	1✔
3
4	from django.core.validators import FileExtensionValidator	1✔
5	from django.db import models	1✔
6	from django.urls import reverse	1✔
7	from django.utils import timezone	1✔
8	from django_extensions.db.models import TimeStampedModel	1✔
9	from sopn_parsing.models import AWSTextractParsedSOPN	1✔
10
11	DOCUMENT_UPLOADERS_GROUP_NAME = "Document Uploaders"	1✔
12
13
14	def document_file_name(instance, filename):	1✔
UNCOV 15	return os.path.join(	×
16	"official_documents", str(instance.ballot.ballot_paper_id), filename
17	)
18
19
20	class OfficialDocument(TimeStampedModel):	1✔
21	NOMINATION_PAPER = "Nomination paper"	1✔
22
23	DOCUMENT_TYPES = (	1✔
24	(NOMINATION_PAPER, "Nomination paper", "Nomination papers"),
25	)
26
27	document_type = models.CharField(	1✔
28	blank=False,
29	choices=[(d[0], d[1]) for d in DOCUMENT_TYPES],
30	max_length=100,
31	)
32	uploaded_file = models.FileField(	1✔
33	upload_to=document_file_name,
34	max_length=800,
35	validators=[FileExtensionValidator(allowed_extensions=["pdf", "docx"])],
36	)
37	ballot = models.ForeignKey(	1✔
38	"candidates.Ballot", null=False, on_delete=models.CASCADE
39	)
40	source_url = models.URLField(	1✔
41	help_text="The URL of this document", max_length=1000
42	)
43	relevant_pages = models.CharField(	1✔
44	"The pages containing information about this ballot",
45	max_length=50,
46	default="",
47	)
48
49	class Meta:	1✔
50	get_latest_by = "modified"	1✔
51
52	def __str__(self):	1✔
UNCOV 53	return "{} ({})".format(self.ballot.ballot_paper_id, self.source_url)	×
54
55	def get_absolute_url(self):	1✔
UNCOV 56	return reverse(	×
57	"ballot_paper_sopn",
58	kwargs={"ballot_id": self.ballot.ballot_paper_id},
59	)
60
61	@property	1✔
62	def locked(self):	1✔
63	"""
64	Is this post election locked?
65	"""
UNCOV 66	return self.ballot.candidates_locked	×
67
68	@property	1✔
69	def lock_suggested(self):	1✔
70	"""
71	Is there a suggested lock for this document?
72	"""
UNCOV 73	return self.ballot.suggestedpostlock_set.exists()	×
74
75	def get_pages(self):	1✔
UNCOV 76	if self.relevant_pages and self.relevant_pages != "all":	×
UNCOV 77	pages = self.relevant_pages.split(",")	×
UNCOV 78	return sorted(int(p) for p in pages)	×
UNCOV 79	return None	×
80
81	@property	1✔
82	def get_aws_parsed_sopn(self):	1✔
83	"""given an instance of an official document, return the associated aws parsed sopn"""
84	return AWSTextractParsedSOPN.objects.get(sopn=self)	×
85
86	@property	1✔
87	def first_page_number(self):	1✔
UNCOV 88	if self.get_pages():	×
UNCOV 89	return self.get_pages()[0]	×
UNCOV 90	return None	×
91
92	@property	1✔
93	def last_page_number(self):	1✔
UNCOV 94	if self.get_pages():	×
UNCOV 95	return self.get_pages()[-1]	×
UNCOV 96	return None	×
97
98
99	def election_sopn_file_name(instance: "ElectionSOPN", filename):	1✔
100	return (	1✔
101	Path("official_documents")
102	/ instance.election.slug
103	/ timezone.now().isoformat()
104	/ filename
105	)
106
107
108	class ElectionSOPN(TimeStampedModel):	1✔
109	"""
110	Stores SOPNs that contain candidate information for each ballot in an election.
111
112	We don't use this directly, rather we use this as a donor document for populating BallotSOPN instances.
113
114	"""
115
116	election = models.OneToOneField(	1✔
117	"elections.Election", on_delete=models.CASCADE, blank=True
118	)
119
120	uploaded_file = models.FileField(	1✔
121	upload_to=election_sopn_file_name,
122	max_length=1200,
123	validators=[FileExtensionValidator(allowed_extensions=["pdf"])],
124	)
125
126	source_url = models.URLField(	1✔
127	help_text="The URL of this document", max_length=1200
128	)
129
130	class Meta:	1✔
131	get_latest_by = "modified"	1✔
132
133	def __str__(self):	1✔
NEW 134	return "{} ({})".format(self.election.slug, self.source_url)	×
135
136
137	def ballot_sopn_file_name(instance: "BaseBallotSOPN", filename):	1✔
138	return (	1✔
139	Path("official_documents")
140	/ instance.ballot.ballot_paper_id
141	/ "sopn"
142	/ timezone.now().isoformat()
143	/ filename
144	)
145
146
147	class BaseBallotSOPN(TimeStampedModel):	1✔
148	"""
149	An abstract class used by BallotSOPN and BallotSOPNHistory. Used to keep both models in sync.
150
151	"""
152
153	ballot = models.OneToOneField(	1✔
154	"candidates.Ballot", on_delete=models.CASCADE, related_name="sopn"
155	)
156
157	# Don't add `ballot` here as we want different related names for each model
158	uploaded_file = models.FileField(	1✔
159	upload_to=ballot_sopn_file_name,
160	max_length=1200,
161	validators=[FileExtensionValidator(allowed_extensions=["pdf"])],
162	)
163
164	source_url = models.URLField(	1✔
165	help_text="The URL of this document", max_length=1200
166	)
167
168	relevant_pages = models.CharField(	1✔
169	max_length=20,
170	help_text="The pages in the ElectionSOPN that relate to this Ballot",
171	default="all",
172	)
173
174	class Meta:	1✔
175	get_latest_by = "modified"	1✔
176	abstract = True	1✔
177
178	def __str__(self):	1✔
179	return "{} ({})".format(self.ballot.ballot_paper_id, self.source_url)	1✔
180
181
182	class BallotSOPN(BaseBallotSOPN):	1✔
183	...
184
185	def get_absolute_url(self):	1✔
186	return reverse(	1✔
187	"ballot_paper_sopn",
188	kwargs={"ballot_id": self.ballot.ballot_paper_id},
189	)
190
191
192	class BallotSOPNHistory(BaseBallotSOPN):	1✔
193	ballot = models.ForeignKey(	1✔
194	"candidates.Ballot",
195	on_delete=models.CASCADE,
196	related_name="sopn_history",
197	)

DemocracyClub / yournextrepresentative / a11757ca-33f7-44a2-a500-a7b58b9d99e5

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