Merge pull request #2192 from teovin/volume-json-updates

[ENG-595] Enhance volume metadata json files
harvard-lil · Feb 5, 2024 · a65d5c7 · a65d5c7
2 parents 9521fce + c75988f
commit a65d5c7
Show file tree

Hide file tree

Showing 9 changed files with 31 additions and 8 deletions.
diff --git a/capstone/scripts/export_cap_static.py b/capstone/scripts/export_cap_static.py
@@ -61,6 +61,8 @@ def finalize_reporters_dir(dest_dir: Path) -> None:
         # write reporter-level VolumesMetadata.json
         print("Writing VolumesMetadata.json")
         volumes_metadata = [json.loads(f.read_text()) for f in natsorted(reporter_dir.glob("*/VolumeMetadata.json"))]
+        for volume in volumes_metadata:
+            volume["reporter_slug"] = reporter_dir.name
         write_json(reporter_dir / "VolumesMetadata.json", volumes_metadata)
         all_volumes.extend(volumes_metadata)
 
@@ -267,6 +269,7 @@ def volume_to_dict(volume: VolumeMetadata) -> dict:
     volume_data["spine_end_year"] = volume.spine_end_year
     volume_data["publication_city"] = volume.publication_city
     volume_data["second_part_of_id"] = volume.second_part_of_id
+    volume_data["redacted"] = volume.redacted
 
     # add information about volume's nominative_reporter
     if volume.nominative_reporter_id:

diff --git a/capstone/test_data/cap_static/redacted/VolumesMetadata.json b/capstone/test_data/cap_static/redacted/VolumesMetadata.json
@@ -25,7 +25,9 @@
     "spine_end_year": null,
     "publication_city": null,
     "second_part_of_id": null,
-    "nominative_reporter": null
+    "redacted": true,
+    "nominative_reporter": null,
+    "reporter_slug": "us"
   },
   {
     "volume_number": "2",
@@ -53,6 +55,8 @@
     "spine_end_year": null,
     "publication_city": null,
     "second_part_of_id": null,
-    "nominative_reporter": null
+    "redacted": true,
+    "nominative_reporter": null,
+    "reporter_slug": "us"
   }
 ]
diff --git a/capstone/test_data/cap_static/redacted/us/1/VolumeMetadata.json b/capstone/test_data/cap_static/redacted/us/1/VolumeMetadata.json
@@ -24,5 +24,6 @@
   "spine_end_year": null,
   "publication_city": null,
   "second_part_of_id": null,
+  "redacted": true,
   "nominative_reporter": null
 }
diff --git a/capstone/test_data/cap_static/redacted/us/2/VolumeMetadata.json b/capstone/test_data/cap_static/redacted/us/2/VolumeMetadata.json
@@ -24,5 +24,6 @@
   "spine_end_year": null,
   "publication_city": null,
   "second_part_of_id": null,
+  "redacted": true,
   "nominative_reporter": null
 }
diff --git a/capstone/test_data/cap_static/redacted/us/VolumesMetadata.json b/capstone/test_data/cap_static/redacted/us/VolumesMetadata.json
@@ -25,7 +25,9 @@
     "spine_end_year": null,
     "publication_city": null,
     "second_part_of_id": null,
-    "nominative_reporter": null
+    "redacted": true,
+    "nominative_reporter": null,
+    "reporter_slug": "us"
   },
   {
     "volume_number": "2",
@@ -53,6 +55,8 @@
     "spine_end_year": null,
     "publication_city": null,
     "second_part_of_id": null,
-    "nominative_reporter": null
+    "redacted": true,
+    "nominative_reporter": null,
+    "reporter_slug": "us"
   }
 ]
diff --git a/capstone/test_data/cap_static/unredacted/VolumesMetadata.json b/capstone/test_data/cap_static/unredacted/VolumesMetadata.json
@@ -25,7 +25,9 @@
     "spine_end_year": null,
     "publication_city": null,
     "second_part_of_id": null,
-    "nominative_reporter": null
+    "redacted": false,
+    "nominative_reporter": null,
+    "reporter_slug": "us"
   },
   {
     "volume_number": "2",
@@ -53,6 +55,8 @@
     "spine_end_year": null,
     "publication_city": null,
     "second_part_of_id": null,
-    "nominative_reporter": null
+    "redacted": false,
+    "nominative_reporter": null,
+    "reporter_slug": "us"
   }
 ]
diff --git a/capstone/test_data/cap_static/unredacted/us/1/VolumeMetadata.json b/capstone/test_data/cap_static/unredacted/us/1/VolumeMetadata.json
@@ -24,5 +24,6 @@
   "spine_end_year": null,
   "publication_city": null,
   "second_part_of_id": null,
+  "redacted": false,
   "nominative_reporter": null
 }
diff --git a/capstone/test_data/cap_static/unredacted/us/2/VolumeMetadata.json b/capstone/test_data/cap_static/unredacted/us/2/VolumeMetadata.json
@@ -24,5 +24,6 @@
   "spine_end_year": null,
   "publication_city": null,
   "second_part_of_id": null,
+  "redacted": false,
   "nominative_reporter": null
 }
diff --git a/capstone/test_data/cap_static/unredacted/us/VolumesMetadata.json b/capstone/test_data/cap_static/unredacted/us/VolumesMetadata.json
@@ -25,7 +25,9 @@
     "spine_end_year": null,
     "publication_city": null,
     "second_part_of_id": null,
-    "nominative_reporter": null
+    "redacted": false,
+    "nominative_reporter": null,
+    "reporter_slug": "us"
   },
   {
     "volume_number": "2",
@@ -53,6 +55,8 @@
     "spine_end_year": null,
     "publication_city": null,
     "second_part_of_id": null,
-    "nominative_reporter": null
+    "redacted": false,
+    "nominative_reporter": null,
+    "reporter_slug": "us"
   }
 ]