civics-cdf-validator 1.49.dev10__tar.gz → 1.49.dev11__tar.gz

{civics_cdf_validator-1.49.dev10/civics_cdf_validator.egg-info → civics_cdf_validator-1.49.dev11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: civics_cdf_validator
-Version: 1.49.dev10
+Version: 1.49.dev11
 Summary: Checks if an election feed follows best practices
 Home-page: https://github.com/google/civics_cdf_validator
 Author: Google Civics

{civics_cdf_validator-1.49.dev10 → civics_cdf_validator-1.49.dev11}/README.md

@@ -15,7 +15,6 @@ civics_cdf_validator relies on lxml which will be installed if it
 isn't already installed. You may need to install libxslt development libraries
 in order to build lxml.
 
-
 # USAGE
 
 ## Branch Definitions
@@ -23,7 +22,6 @@ in order to build lxml.
 * `staging` - Branch that contains next version of production code, typically available one month in advance of a production push.
 * `dev` - Branch that contains development code with latest changes changes to the validator. This branch is rolled into staging on a monthly basis.
 
-
 ## Supported feeds
 You can use `civics_cdf_validator` to check different types of feed:
 
@@ -33,6 +31,7 @@ You can use `civics_cdf_validator` to check different types of feed:
 * Committee
 * Election Dates
 * Metadata
+* Voter information
 
 ## List rules
 

{civics_cdf_validator-1.49.dev10 → civics_cdf_validator-1.49.dev11/civics_cdf_validator.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: civics_cdf_validator
-Version: 1.49.dev10
+Version: 1.49.dev11
 Summary: Checks if an election feed follows best practices
 Home-page: https://github.com/google/civics_cdf_validator
 Author: Google Civics

{civics_cdf_validator-1.49.dev10 → civics_cdf_validator-1.49.dev11}/rules.py

@@ -4490,6 +4490,118 @@ class UnsupportedOfficeHolderTenureSchema(base.BaseRule):
       )
 
 
+class ElectoralCommissionCollectionExists(base.BaseRule):
+  """ElectoralCommissionCollection should exist."""
+
+  def elements(self):
+    return ["ElectionReport"]
+
+  def check(self, element):
+    if element.find("ElectoralCommissionCollection") is None:
+      raise loggers.ElectionError.from_message(
+          "ElectoralCommissionCollection should exist."
+      )
+
+
+class VoterInformationCollectionExists(base.BaseRule):
+  """Warn if there is no VoterInformationCollection."""
+
+  def elements(self):
+    return ["ElectionReport"]
+
+  def check(self, element):
+    if element.find("VoterInformationCollection") is None:
+      raise loggers.ElectionWarning.from_message(
+          "VoterInformationCollection should exist."
+      )
+
+
+class NoExtraElectionElements(base.BaseRule):
+  """Elections for voter information feeds should not have certain elements.
+
+  BallotStyleCollection, CandidateCollection, ContestCollection, CountStatus
+  should all be excluded.
+  """
+
+  def elements(self):
+    return ["Election"]
+
+  def check(self, element):
+    if element.find("BallotStyleCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "BallotStyleCollection should not exist."
+      )
+
+    if element.find("CandidateCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "CandidateCollection should not exist."
+      )
+    if element.find("ContestCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "ContestCollection should not exist."
+      )
+
+    if element.find("CountStatus") is not None:
+      raise loggers.ElectionError.from_message("CountStatus should not exist.")
+
+
+class WarnOnElementsNotRecommendedForElection(base.BaseRule):
+  """Warn on ContactInformation on an Election for voter information feeds."""
+
+  def elements(self):
+    return ["Election"]
+
+  def check(self, element):
+    if element.find("ContactInformation") is not None:
+      raise loggers.ElectionWarning.from_message(
+          "ContactInformation is not recommended for Election, prefer using an"
+          " ElectionAdministration."
+      )
+
+
+class NoExtraElectionReportCollections(base.BaseRule):
+  """ElectionReports for voter information feeds should not have certain elements.
+
+  CommitteeCollection, GovernmentBodyCollection, OfficeCollection,
+  OfficeHolderTenureCollection, PartyCollection, PersonCollection should all be
+  excluded.
+  """
+
+  def elements(self):
+    return ["ElectionReport"]
+
+  def check(self, element):
+    if element.find("CommitteeCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "CommitteeCollection should not exist."
+      )
+
+    if element.find("GovernmentBodyCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "GovernmentBodyCollection should not exist."
+      )
+
+    if element.find("OfficeCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "OfficeCollection should not exist."
+      )
+
+    if element.find("OfficeHolderTenureCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "OfficeHolderTenureCollection should not exist."
+      )
+
+    if element.find("PartyCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "PartyCollection should not exist."
+      )
+
+    if element.find("PersonCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "PersonCollection should not exist."
+      )
+
+
 class RuleSet(enum.Enum):
   """Names for sets of rules used to validate a particular feed type."""
 
@@ -4499,6 +4611,7 @@ class RuleSet(enum.Enum):
   ELECTION_DATES = 4
   ELECTION_RESULTS = 5
   METADATA = 6
+  VOTER_INFORMATION = 7
 
 
 # To add new rules, create a new class, inherit the base rule,
@@ -4660,6 +4773,16 @@ METADATA_RULES = (
     # go/keep-sorted end
 )
 
+VOTER_INFORMATION_RULES = COMMON_RULES + (
+    # go/keep-sorted start
+    ElectoralCommissionCollectionExists,
+    NoExtraElectionElements,
+    NoExtraElectionReportCollections,
+    VoterInformationCollectionExists,
+    WarnOnElementsNotRecommendedForElection,
+    # go/keep-sorted end
+)
+
 ALL_RULES = frozenset(
     COMMON_RULES
     + ELECTION_RULES
@@ -4667,5 +4790,6 @@ ALL_RULES = frozenset(
     + OFFICEHOLDER_RULES
     + COMMITTEE_RULES
     + ELECTION_DATES_RULES
+    + VOTER_INFORMATION_RULES
     + METADATA_RULES
 )

{civics_cdf_validator-1.49.dev10 → civics_cdf_validator-1.49.dev11}/validator.py

@@ -260,6 +260,8 @@ def filter_all_rules_using_user_arg(rules_allowlist, rule_set, rules_blocklist):
       rule_names = [x.__name__ for x in rules.ELECTION_RESULTS_RULES]
     elif rule_set == rules.RuleSet.METADATA:
       rule_names = [x.__name__ for x in rules.METADATA_RULES]
+    elif rule_set == rules.RuleSet.VOTER_INFORMATION:
+      rule_names = [x.__name__ for x in rules.VOTER_INFORMATION_RULES]
     else:
       raise AssertionError("Invalid rule_set: " + rule_set)
     if rules_blocklist:

{civics_cdf_validator-1.49.dev10 → civics_cdf_validator-1.49.dev11}/version.py

@@ -5,4 +5,4 @@ No dependencies should be added to this module.
 See https://packaging.python.org/guides/single-sourcing-package-version/
 """
 
-__version__ = '1.49.dev10'
+__version__ = '1.49.dev11'