Feat/307 activity pulp paper

bc_obps/reporting/json_schemas/2024/pulp_and_paper_production/activity.json

@@ -0,0 +1,28 @@
+{
+  "name": "Pulp and paper production",
+  "type": "object",
+  "properties": {
+    "carbonates": {
+      "type": "array",
+      "title": "Carbonates",
+      "items": {
+        "title": "Carbonates",
+        "type": "object",
+        "properties": {
+          "carbonateName": {
+            "type": "string",
+            "title": "Carbonate Name"
+          },
+          "annualAmount": {
+            "type": "number",
+            "title": "Annual Amount (t)"
+          },
+          "purityOfCarbonate": {
+            "type": "number",
+            "title": "Purity Of Carbonate (Weight Fraction)"
+          }
+        }
+      }
+    }
+  }
+}

bc_obps/reporting/json_schemas/2024/pulp_and_paper_production/pulp_and_paper_production.json

@@ -0,0 +1,30 @@
+{
+  "type": "object",
+  "title": "Emissions",
+  "properties": {
+    "emissions": {
+      "type": "array",
+      "title": "Emissions",
+      "items": {
+        "title": "Emission",
+        "type": "object",
+        "properties": {
+          "gasType": {
+            "type": "string",
+            "title": "Gas Type",
+            "enum": []
+          },
+          "emission": {
+            "title": "Emission",
+            "type": "number"
+          },
+          "equivalentEmission": {
+            "title": "Equivalent Emission",
+            "type": "number",
+            "readOnly": true
+          }
+        }
+      }
+    }
+  }
+}

bc_obps/reporting/tests/models/program_configuration_tests/test_pulp_and_paper_production_2024.py

@@ -0,0 +1,68 @@
+from django.test import TestCase
+from django.db.models import Count
+from registration.models.activity import Activity
+from reporting.models.configuration import Configuration
+from reporting.models.configuration_element import ConfigurationElement
+
+
+class PulpAndPaperProduction2024TestCase(TestCase):
+    def testDataExists(self):
+        activity = Activity.objects.get(name='Pulp and paper production')
+        config = Configuration.objects.get(slug='2024')
+
+        config_elements = ConfigurationElement.objects.filter(
+            valid_from__lte=config, valid_to__gte=config, activity=activity
+        )
+
+        # For each gas, the list of methodologies and their associated field's count
+        gas_config = {
+            'CO2': {
+                'Solids-HHV': 6,
+                'Solids-CC': 4,
+                'Make-up Chemical Use Methodology': 2,
+                'Alternative Parameter Methodology': 1,
+                'Replacement Methodology': 1,
+            },
+            'CH4': {
+                'Solids-HHV': 3,
+                'Alternative Parameter Methodology': 1,
+                'Replacement Methodology': 1,
+            },
+            'N2O': {
+                'Solids-HHV': 3,
+                'Alternative Parameter Methodology': 1,
+                'Replacement Methodology': 1,
+            },
+        }
+
+        config = {
+            'Pulping and chemical recovery': gas_config,
+        }
+
+        self.assertQuerysetEqual(
+            config_elements.values_list('source_type__name', flat=True).distinct(),
+            config.keys(),
+            ordered=False,
+            msg=f'{activity} contains config for the proper source types',
+        )
+
+        for source_type_name, gas_config in config.items():
+            self.assertQuerysetEqual(
+                config_elements.filter(source_type__name=source_type_name)
+                .values_list('gas_type__chemical_formula', flat=True)
+                .distinct(),
+                gas_config.keys(),
+                ordered=False,
+                msg=f'{source_type_name} contains config for the proper gas types',
+            )
+            for gas_name, methods in gas_config.items():
+                self.assertQuerysetEqual(
+                    config_elements.filter(source_type__name=source_type_name, gas_type__chemical_formula=gas_name)
+                    .annotate(field_count=Count('reporting_fields'))
+                    .values_list('methodology__name', 'field_count'),
+                    list(methods.items()),
+                    ordered=False,
+                    msg=f'{source_type_name}:{gas_name} contains config for the proper methods and field counts',
+                )
+
+        assert len(config_elements) == 11

bc_obps/reporting/tests/models/test_methodology.py

@@ -30,6 +30,9 @@ def test_methodology_initial_data(self):
                 'Mass of Output Carbonates',
                 'Alternative Parameter Methodology',
                 'Feedstock Material Balance',
+                'Solids-HHV',
+                'Solids-CC',
+                'Make-up Chemical Use Methodology',
             ]
         )
         existing_methodologies = sorted(list(Methodology.objects.values_list('name', flat=True)))

bciers/apps/reporting/src/app/bceidbusiness/industry_user/reports/[version_id]/facilities/[facility_id]/activities/pulp_and_paper_production/page.tsx

@@ -0,0 +1,24 @@
+import { actionHandler } from "@bciers/actions";
+import PulpAndPaperProduction from "@reporting/src/app/components/activities/pulpAndPaperProduction";
+import { Suspense } from "react";
+
+export default async function Page() {
+  const reportDate = "2024-04-01"; // This should be passed in once we have a path to this page from starting a report
+  const activityData = await actionHandler(
+    `reporting/initial-activity-data?activity_name=Pulp and paper production&report_date=${reportDate}`,
+    "GET",
+    "",
+  );
+  const activityDataObject = JSON.parse(activityData);
+
+  return (
+    <>
+      <Suspense fallback="Loading Schema">
+        <PulpAndPaperProduction
+          activityData={activityDataObject}
+          reportDate={reportDate}
+        />
+      </Suspense>
+    </>
+  );
+}

bciers/apps/reporting/src/app/bceidbusiness/industry_user_admin/reports/[version_id]/facilities/[facility_id]/activities/pulp_and_paper_production/page.tsx

@@ -0,0 +1,25 @@
+import { actionHandler } from "@bciers/actions";
+import safeJsonParse from "libs/utils/safeJsonParse";
+import PulpAndPaperProduction from "@reporting/src/app/components/activities/pulpAndPaperProduction";
+import { Suspense } from "react";
+
+export default async function Page() {
+  const reportDate = "2024-04-01"; // This should be passed in once we have a path to this page from starting a report
+  const activityData = await actionHandler(
+    `reporting/initial-activity-data?activity_name=Pulp and paper production&report_date=${reportDate}`,
+    "GET",
+    "",
+  );
+  const activityDataObject = safeJsonParse(activityData);
+
+  return (
+    <>
+      <Suspense fallback="Loading Schema">
+        <PulpAndPaperProduction
+          activityData={activityDataObject}
+          reportDate={reportDate}
+        />
+      </Suspense>
+    </>
+  );
+}

bciers/apps/reporting/src/app/components/activities/pulpAndPaperProduction.tsx

@@ -0,0 +1,32 @@
+"use client";
+import ActivityForm from "./ActivityForm";
+import uiSchema from "./uiSchemas/pulpAndPaperUiSchema";
+
+interface Props {
+  activityData: {
+    activityId: number;
+    sourceTypeMap: { [key: number]: string };
+  };
+  reportDate: string;
+}
+
+// 🧩 Main component
+export default function PulpAndPaperProduction({
+  activityData,
+  reportDate,
+}: Readonly<Props>) {
+  const defaultEmptySourceTypeState = {
+    emissions: [{}],
+  };
+
+  return (
+    <div>
+      <ActivityForm
+        activityData={activityData}
+        reportDate={reportDate}
+        uiSchema={uiSchema}
+        defaultEmptySourceTypeState={defaultEmptySourceTypeState}
+      />
+    </div>
+  );
+}

bciers/apps/reporting/src/app/components/activities/uiSchemas/pulpAndPaperUiSchema.ts

@@ -0,0 +1,50 @@
+import FieldTemplate from "@bciers/components/form/fields/FieldTemplate";
+import SourceTypeBoxTemplate from "@bciers/components/form/fields/SourceTypeBoxTemplate";
+import NestedArrayFieldTemplate from "@bciers/components/form/fields/NestedArrayFieldTemplate";
+import { InlineFieldTemplate } from "@bciers/components/form/fields";
+
+const uiSchema = {
+  "ui:FieldTemplate": FieldTemplate,
+  "ui:classNames": "form-heading-label",
+  "ui:title": "Pulp and paper production",
+  carbonates: {
+    "ui:ArrayFieldTemplate": NestedArrayFieldTemplate,
+    "ui:FieldTemplate": SourceTypeBoxTemplate,
+    "ui:options": {
+      arrayAddLabel: "Add Carbonate",
+      label: true,
+      title: "Carbonate",
+      padding: "p-2",
+    },
+    items: {
+      "ui:order": ["carbonateName", "annualAmount", "purityOfCarbonate"],
+    },
+  },
+  sourceTypes: {
+    "ui:FieldTemplate": FieldTemplate,
+    "ui:options": {
+      label: false,
+    },
+    pulpingAndChemicalRecovery: {
+      "ui:FieldTemplate": SourceTypeBoxTemplate,
+      emissions: {
+        "ui:title": "Pulping and Chemical Recovery",
+        "ui:ArrayFieldTemplate": NestedArrayFieldTemplate,
+        "ui:FieldTemplate": FieldTemplate,
+        "ui:options": {
+          arrayAddLabel: "Add Emission",
+          label: false,
+          title: "Emission",
+          padding: "p-2",
+        },
+        items: {
+          equivalentEmission: {
+            "ui:FieldTemplate": InlineFieldTemplate,
+          },
+        },
+      },
+    },
+  },
+};
+
+export default uiSchema;

bciers/libs/components/src/form/fields/SourceTypeBoxTemplate.tsx

@@ -9,8 +9,8 @@ import {
   IconButton,
   Paper,
 } from "@mui/material";
-import ArrowDropDownIcon from "@mui/icons-material/ArrowDropDown";
-import ArrowDropUpIcon from "@mui/icons-material/ArrowDropUp";
+import ExpandLessIcon from "@mui/icons-material/ExpandLess";
+import ExpandMoreIcon from "@mui/icons-material/ExpandMore";
 import { useState } from "react";
 
 function SourceTypeBoxTemplate({
@@ -26,7 +26,7 @@ function SourceTypeBoxTemplate({
     <>
       <Paper className={classNames} sx={{ marginBottom: "10px" }}>
         <Card style={{ textAlign: "left" }}>
-          <Grid container spacing={1}>
+          <Grid container spacing={1} sx={{ justifyContent: "space-between" }}>
             <Grid item xs={10}>
               <CardHeader
                 sx={{ color: "blue" }}
@@ -35,9 +35,11 @@ function SourceTypeBoxTemplate({
               />
             </Grid>
             <Grid item xs={1}>
-              <CardActions>
+              <CardActions
+                sx={{ justifyContent: "flex-end", marginRight: "30px" }}
+              >
                 <IconButton onClick={() => setExpand(!expand)}>
-                  {expand ? <ArrowDropUpIcon /> : <ArrowDropDownIcon />}
+                  {expand ? <ExpandLessIcon /> : <ExpandMoreIcon />}
                 </IconButton>
               </CardActions>
             </Grid>