Merge pull request #116 from nationalarchives/feature/grc-subdivisions

Add Jurisdiction info to Courts

Author: timcowlishaw

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog 1.0.0].
 
+## [Unreleased]
+
+- Add jurisdiction metadata to courts to support GRC subdivisions
+
 ## [Release 1.3.5]
 
 - Fix an issue with EWFC B's name taking priority for the 'ewfc' param

src/ds_caselaw_utils/courts.py

@@ -8,6 +8,13 @@
 from ruamel.yaml import YAML
 
 
+class Jurisdiction:
+    def __init__(self, data):
+        self.code = data.get("code")
+        self.name = data.get("name")
+        self.prefix = data.get("prefix")
+
+
 class Court:
     def __init__(self, data):
         self.code = data.get("code")
@@ -19,11 +26,71 @@ def __init__(self, data):
         self.param_aliases = [data.get("param")] + (data.get("extra_params") or [])
         self.start_year = data.get("start_year")
         self.end_year = data.get("end_year") or date.today().year
+        self.jurisdictions = [
+            Jurisdiction(jurisdiction_data)
+            for jurisdiction_data in data.get("jurisdictions", [])
+        ]
+
+    def get_jurisdiction(self, code):
+        return [j for j in self.jurisdictions if j.code == code][0]
+
+    def expand_jurisdictions(self):
+        return [self] + [
+            CourtWithJurisdiction(self, jurisdiction)
+            for jurisdiction in self.jurisdictions
+        ]
 
     def __repr__(self):
         return self.name
 
 
+class CourtWithJurisdiction(Court):
+    def __init__(self, court, jurisdiction):
+        self.court = court
+        self.jurisdiction = jurisdiction
+        self.jurisdictions = []
+
+    @property
+    def code(self):
+        return "/".join((self.court.code, self.jurisdiction.code))
+
+    @property
+    def name(self):
+        return "%s – %s" % (self.court.name, self.jurisdiction.name)
+
+    @property
+    def grouped_name(self):
+        return self.court.grouped_name
+
+    @property
+    def link(self):
+        return self.court.link
+
+    @property
+    def ncn(self):
+        return self.court.ncn
+
+    @property
+    def canonical_param(self):
+        return self.court.canonical_param
+
+    @property
+    def param_aliases(self):
+        return self.court.param_aliases
+
+    @property
+    def start_year(self):
+        return self.court.start_year
+
+    @property
+    def end_year(self):
+        return self.court.end_year
+
+    @property
+    def jurisdiction_prefix(self):
+        return self.jurisdiction.prefix
+
+
 class CourtGroup:
     def __init__(self, name, courts):
         self.name = name
@@ -55,16 +122,37 @@ def get_by_param(self, param):
         except KeyError:
             raise CourtNotFoundException()
 
-    def get_by_code(self, code):
+    def get_court_by_code(self, code):
         try:
             return self._byCode[code]
         except KeyError:
             raise CourtNotFoundException()
 
-    def get_all(self):
-        return [
+    def get_court_with_jurisdiction_by_code(self, court_code, jursidiction_code):
+        court = self.get_court_by_code(court_code)
+        jurisdiction = court.get_jurisdiction(jursidiction_code)
+        if jurisdiction is not None:
+            return CourtWithJurisdiction(court, jurisdiction)
+        else:
+            raise CourtNotFoundException()
+
+    def get_by_code(self, code):
+        if "/" in code:
+            (court_code, jurisdiction_code) = code.split("/")
+            return self.get_court_with_jurisdiction_by_code(
+                court_code, jurisdiction_code
+            )
+        else:
+            return self.get_court_by_code(code)
+
+    def get_all(self, with_jurisdictions=False):
+        courts = [
             Court(court) for category in self._data for court in category.get("courts")
         ]
+        if with_jurisdictions:
+            return [c for court in courts for c in court.expand_jurisdictions()]
+        else:
+            return courts
 
     def get_selectable(self):
         courts = []

src/ds_caselaw_utils/data/court_names.yaml

@@ -447,6 +447,52 @@
       end_year: 2022
       selectable: true
       listable: true
+      jurisdictions:
+        - code: Charity
+          prefix: CA
+          name: Charity
+        - code: CommunityRightToBid
+          prefix: CR
+          name: Community Right to Bid
+        - code: NetworkInformationSystems
+          prefix: NIS
+          name: Electronic Communications, Postal Services, and Network Information Systems
+        - code: Environment
+          prefix: NV
+          name: Environment
+        - code: EstateAgents
+          prefix: EEA
+          name: Estate Agents
+        - code: ExamBoards
+          prefix: EB
+          name: Exam Boards
+        - code: FoodSafety
+          prefix: FD
+          name: Food Safety
+        - code: Gambling
+          prefix: GA
+          name: Gambling
+        - code: ImmigrationServices
+          prefix: IMS
+          name: Immigration Services
+        - code: IndividualElectoralRegulation
+          prefix: IR
+          name: Individual Electoral Regulation
+        - code: InformationRights
+          prefix: EA
+          name: Information Rights
+        - code: Pensions
+          prefix: PEN
+          name: Pensions
+        - code: StandardsAndLicensing
+          prefix: PR
+          name: Standards & Licensing
+        - code: Transport
+          prefix: D
+          name: Transport
+        - code: WelfareOfAnimals
+          prefix: WA
+          name: Welfare of Animals
     - code: UKFTT-TC
       grouped_name: Tax Chamber
       name: First-tier Tribunal (Tax Chamber)

src/ds_caselaw_utils/data/schema/courts.schema.json

@@ -61,6 +61,23 @@
             },
             "selectable": {
               "type": "boolean"
+            },
+            "jurisdictions": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "prefix": {
+                    "type": "string"
+                  },
+                  "name": {
+                    "type": "string"
+                  },
+                  "code": {
+                    "type": "string"
+                  }
+                }
+              }
             }
           },
           "required": ["code", "name", "link", "listable", "selectable"],