@dra2020/district-analytics 8.0.1 → 8.1.0

package/dist/district-analytics.js

@@ -686,6 +686,41 @@ class Districts {
     }
 }
 exports.Districts = Districts;
+// CLASSES, ETC. FOR FEATURE & COUNTY DATA
+// Types of datasets by feature
+/* 08-13-2020 - Moved to types.ts
+export const enum Dataset
+{
+  SHAPES = "SHAPES",
+  CENSUS = "CENSUS",
+  VAP = "VAP",
+  ELECTION = "ELECTION"
+}
+*/
+/* 08-13-2020 - Moved to types.ts
+export type DatasetKeys = {
+  SHAPES: string;    // A shapefile
+  CENSUS: string;    // A total population Census dataset
+  VAP: string;       // A voting age (or citizen voting age) dataset
+  ELECTION: string;  // An election dataset
+}
+*/
+// Identifiers of fields for each feature in the datasets
+/* 08-13-2020 - Moved to types.ts
+export const enum FeatureField
+{
+  TotalPop = "Tot",
+  WhitePop = "Wh",
+  BlackPop = "BlC",
+  HispanicPop = "His",
+  AsianPop = "AsnC",
+  PacificPop = "PacC",
+  NativePop = "NatC",
+  DemVotes = "D",
+  RepVotes = "R",
+  TotalVotes = "Tot"
+}
+*/
 // Wrap data by feature, to abstract the specifics of the internal structure
 class Features {
     constructor(s, data, keys) {
@@ -2038,14 +2073,31 @@ function parseGeoID(geoID) {
     return parts;
 }
 exports.parseGeoID = parseGeoID;
-function isWaterOnly(geoID) {
-    let waterOnlySignature = 'ZZZZZZ';
+// 08-13-2020 - Enhanced completeness checking.
+function isWaterOnly(geoID, s) {
+    const waterOnlySignature = 'ZZZZZZ';
     if (geoID.indexOf(waterOnlySignature) >= 0)
         return true;
+    if (s) {
+        // If called with a session, get the feature ...
+        const featureID = s.features.featureID(geoID);
+        const f = s.features.featureByIndex(featureID);
+        // ... and also check the 'ALAND' property
+        const bNoLand = ((f.properties['ALAND10'] !== undefined) && (f.properties['ALAND10'] == 0)) ? true : false;
+        return bNoLand;
+    }
     else
         return false;
 }
 exports.isWaterOnly = isWaterOnly;
+function isUninhabited(geoID, s) {
+    const featureID = s.features.featureID(geoID);
+    const f = s.features.featureByIndex(featureID);
+    const totalPop = s.features.fieldForFeature(f, "CENSUS" /* CENSUS */, "Tot" /* TotalPop */);
+    const bUninhabited = (totalPop > 0) ? false : true;
+    return bUninhabited;
+}
+exports.isUninhabited = isUninhabited;
 // NORMALIZING RESULTS
 function normalize(rawScore, testScale) {
     let rangeMin = testScale.scale[0];
@@ -2255,10 +2307,26 @@ function doIsComplete(s, bLog = false) {
     // Check the dummy district that holds any unassigned features.
     let unassignedFeatures = [];
     let bAllAssigned = (!bNotEmptyByDistrict[S.NOT_ASSIGNED]);
+    let bAllNonWaterOnlyAssigned = bAllAssigned ? true : false;
     if (!bAllAssigned) {
         let unassignedDistrict = s.plan.geoIDsForDistrictID(S.NOT_ASSIGNED);
         unassignedFeatures = Array.from(unassignedDistrict);
         // unassignedFeatures = unassignedFeatures.slice(0, S.NUMBER_OF_ITEMS_TO_REPORT);
+        // 08-13-2020 - Enhanced completeness checking.
+        // Are any of the unassigned features not water-only -or- inhabited?
+        // Check the official congressional maps for CT, KY, IL, and MI.
+        bAllNonWaterOnlyAssigned = !unassignedFeatures.some(function (geoID) {
+            if (U.isWaterOnly(geoID, s)) {
+                console.log("Unassigned water-only feature ignored in completeness check: ", geoID);
+                return false;
+            }
+            if (U.isUninhabited(geoID, s)) {
+                console.log("Uninhabited feature ignored in completeness check: ", geoID);
+                return false;
+            }
+            // Not water-only and inhabited
+            return true;
+        });
     }
     // Do all real districts have at least one feature assigned to them?
     let emptyDistricts = [];
@@ -2282,7 +2350,14 @@ function doIsComplete(s, bLog = false) {
     //   Note, this can happen if a district is created, and then all features
     //   are removed from it (in DRA).
     // Populate the test entry
-    test['score'] = bAllAssigned && bNoneEmpty;
+    // 08-13-2020 - Revised completeness check:
+    // A plan is complete if:
+    // * All inhabited, not water-only districts are assigned to districts. 
+    // * No districts are empty, i.e., each has one or more geos assigned to them.
+    //   Note: We're not checking (in _data.ts) whether those geos are water-only
+    //   or have any population, but that's a real edge case.
+    test['score'] = bAllNonWaterOnlyAssigned && bNoneEmpty;
+    // test['score'] = bAllAssigned && bNoneEmpty;
     if (!bAllAssigned) {
         test['details']['unassignedFeatures'] = unassignedFeatures;
     }